Deutsche Version

Back to overview

XML Sitemap Generator: Installation

Live Demo: Try this and other plugins live — no installation, no risk: demo.markus-michalski.net

Requirements

Installation

Via Shopware Store (Recommended)

1. Purchase the plugin in the Shopware Store
2. In Shopware Admin under Extensions > My Extensions install and activate the plugin
3. Clear the cache

Via Composer

1. Add the private repository

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://packeton.markus-michalski.net"
        }
    ]
}

You receive the repository credentials after purchasing the license. Composer asks for them on the first request.

2. Install the plugin

composer require mmd/sw67-sitemap

3. Activate the plugin

bin/console plugin:refresh
bin/console plugin:install --activate MmdSitemap
bin/console cache:clear

Via ZIP upload

1. Upload the ZIP file in Shopware Admin under Extensions > My Extensions
2. Install and activate the plugin
3. Clear the cache

Shopware Store or Composer make later updates easier than the ZIP upload.

After installation

1. Open Extensions > My Extensions > Advanced XML Sitemap and review the settings, see Configuration.
2. Assign a separate Sales Channel Slug per Sales Channel if you run more than one.
3. Select a Sales Channel at the top of the plugin configuration and click Generate Sitemap, or run bin/console mmd:sitemap:generate, see Generation and console command.
4. Add the sitemap URL to your robots.txt, see Configuration.

Scheduled task

The plugin registers the scheduled task mmd.sitemap.generation. It generates the sitemaps automatically as long as Enable automatic generation is switched on (default). For the task to actually run, your Shopware installation needs the standard scheduled-task mechanism, that is a running scheduled-task:run and a messenger worker (messenger:consume). If the task is missing after activation, bin/console scheduled-task:register helps.

You set the interval in the plugin configuration. Alternatively you can generate the sitemaps with a cron job, see Generation and console command.

Update

composer update mmd/sw67-sitemap
bin/console plugin:update MmdSitemap
bin/console cache:clear

With the ZIP upload you upload the new ZIP file in the Admin and update the plugin there. After an update, regenerate the sitemaps or wait for the next scheduled run.

Uninstallation

When you uninstall the plugin in the Admin, it removes the scheduled task and all settings (MmdSitemap.config.*), unless you keep the user data. Sitemap files that were already generated under public/ are not deleted by the plugin, remove them yourself if needed.