blackbit_digital_commerce/pimcore-external-sitemaps

Add URLs from external sitemaps / sitemap index files to the Pimcore-generated sitemap.xml

1.0.0 2022-05-19 10:00 UTC

GPL-3.0-or-later

• Blackbit

README

This Pimcore plugin allows you to include external sitemaps into your sitemap.xml. It also supports including external sitemap index URLs whose referenced sitemap files get resolved.

Installation

Composer

To get the plugin code please write an email to [e-mail].

You then either get access to the bundle's Bitbucket repository or you get the plugin code as a zip file. Accessing the Bitbucket repository has the advantage that you will always see changes to the plugin in the pull requests and are able to update to a new version yourself - please visit this page if this sounds interesting to you - if it does, please send us the email address of your BitBucket account so we can allow access to the repository.

When we allow your account to access our repository, please add the repository to the composer.json in your Pimcore root folder (see Composer repositories):

"repositories": [
    {
        "type": "vcs",
        "url": "[e-mail]:blackbitwerbung/pimcore-plugins-external-sitemaps"
    }
],

Alternatively if you received the plugin code as zip file, please upload the zip file to your server (e.g. to the Pimcore root folder) and add the following to your composer.json:

"repositories": [
    {
        "type": "artifact",
        "url": "path/to/directory/with/zip-file/"
    }
]

Then you should be able to execute composer require blackbit/external-sitemaps (or composer update blackbit/external-sitemaps --no-dev for updates if you already have this bundle installed) from CLI.

At last you have to enable the plugin, either via browser UI in Pimcore admin or via CLI:

bin/console pimcore:bundle:enable BlackbitExternalSitemapsBundle

Plugin configuration

To define the external sitemap URLs, you have to override the symfony service Blackbit\ExternalSitemapsBundle\ExternalSitemapGenerator in config/services.yaml (Pimcore >= 10) or app/config/services.yml(Pimcore <= 6).

Blackbit\ExternalSitemapsBundle\ExternalSitemapGenerator:
    arguments:
        $externalUrls: [ 'https://example.org/sitemap.xml', 'https://example2.org/sitemapIndex.xml' ]

After configuration is complete all external sitemap URLs will be put into sitemap.externalUrls.xml in your default Pimcore sitemaps index /sitemap.xml file.