English Version

Zurück zur Übersicht

XML Sitemap Generator: Installation

Voraussetzungen

• OXID eShop ^7.0, PHP 8.2 oder neuer
• PHP-Extensions ext-dom, ext-libxml und ext-pdo
• Zugriff auf das Composer-Repository, in dem das Paket mmd/oxid7-sitemap bereitliegt

Installation per Composer

Das Paket liegt in einem privaten Repository, das über Packeton verwaltet wird. Die Zugangsdaten erhältst Du nach dem Lizenzkauf.

1. Private Repository hinzufügen (in der composer.json des Shops):

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

2. Modul installieren:

composer require mmd/oxid7-sitemap

Das Composer-Plugin von OXID legt das Modul unter source/modules/mmd/sitemap ab. Wenn Composer nach Zugangsdaten fragt, trägst Du die Daten aus dem Lizenzkauf ein.

3. Modul aktivieren:

vendor/bin/oe-console oe:module:activate mmd_sitemap
vendor/bin/oe-console oe:cache:clear

Die Modul-ID lautet mmd_sitemap. Die Aktivierung kannst Du alternativ im OXID-Admin unter Erweiterungen > Module vornehmen.

Was bei der Aktivierung passiert

• Das Modul legt die Tabelle mmd_sitemap_static_urls an, falls sie noch nicht existiert (CREATE TABLE IF NOT EXISTS)
• Es legt das Verzeichnis source/export/sitemap an, falls es fehlt. Dieses Verzeichnis nutzt das Modul mit den Standardeinstellungen nicht: die Sitemap-Dateien landen in source/export/
• Beim Deaktivieren bleiben erzeugte Sitemap-Dateien und die Tabelle mit den statischen URLs erhalten

Das Modul bringt keine Datenbank-Migrationen mit. Die Tabelle entsteht ausschließlich bei der Aktivierung. Fehlt sie nach einem Update, deaktiviere und aktiviere das Modul einmal.

Erste Generierung

vendor/bin/oe-console mmd:sitemap:generate

Oder im OXID-Admin unter Sitemap > Übersicht auf Sitemap generieren klicken. Danach liegt sitemap.xml mit den Standardeinstellungen unter source/export/ und ist über <Shop-URL>/export/sitemap.xml erreichbar. Alle Optionen stehen auf der Seite Console Commands.

Update

composer update mmd/oxid7-sitemap
vendor/bin/oe-console oe:module:apply-configuration
vendor/bin/oe-console oe:cache:clear

oe:module:apply-configuration übernimmt neue oder geänderte Modul-Einstellungen aus der Modul-Konfiguration. Erzeugte Sitemaps ändern sich dadurch nicht, bis Du sie neu generierst.

Cronjob für die Neuerzeugung

Das Modul bringt keinen eigenen Scheduler mit. Wer die Sitemaps regelmäßig erneuern möchte, ruft den Konsolenbefehl per Cron auf:

# Täglich um 3 Uhr
0 3 * * * cd /var/www/oxideshop && vendor/bin/oe-console mmd:sitemap:generate --clear

Passe den Pfad zum Shop-Root an Deine Umgebung an. Mit --clear werden vor der Generierung alle Dateien sitemap*.xml im Ausgabeverzeichnis gelöscht, siehe Console Commands.