Fatchip GmbH Wiki

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== OXID Plugin - Google-XML-Sitemap für OXID 6======

Das Plugin bei FATCHIP: https://www.fatchip.de/Plugins/OXID-eShop/OXID-Plugin-Google-XML-Sitemap.html \\
Das Plugin auf Github: https://github.com/FATCHIP-GmbH/plugin-oxid6-xmlsitemap (private)

===== Voraussetzungen =====

  * OXID CE/PE/EE ab Version 6.0.x
  * OXID OE Tags Modul (wenn Sie die Tag-Sitemap in OXID 6 ausgeben möchten)
  * Aktive OXID-SEO-Funktionalität muss in Verwendung sein
  * FTP-Zugang zu Ihrem Shopsystem
  * SSH-Zugriff auf die Shopinstallation.

===== Installation =====

**Sollten Sie bereits die Vorgängerversion des Moduls einsetzen (bis Version FatchipSitemapXml_v3.9.2), muss diese zuerst komplett deinstalliert werden! Vergessen Sie nicht, auch den //sitemaps//-Ordner inkl. Inhalt im //source//- Ordner zu löschen.**

==== Composer ====
Öffnen Sie die Datei **composer.json** im Stammverzeichnis Ihres Shops und fügen Sie das Repository hinzu oder vervollständigen Sie die vorhandene Konfiguration: \\
<code yaml>
"repositories": [{
  "type": "composer",
  "url": "https://packages.fatchip.de/packages"
}]
</code>

Nach erfolgter Ergänzung der Datei //composer.json// können Sie da Plugin installieren.\\ Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis, in dem sich der Source- und Vendorornder befinden.\\ 
Führen Sie folgenden Befehl aus, um das Plugin zu installieren
    composer require fatchip-gmbh/plugin-oxid6-xmlsitemap
Beachten Sie, dass der genaue Aufruf des Composers für Ihre konkrete OXID-Installation abweichen kann. \\

Sie werden nun nach einem Benutzer und einem Passwort gefragt. Geben Sie die Zugangsdaten ein, welche Ihnen per E-Mail übersandt wurden.\\
\\
Nach korrekter Eingabe der Zugangsdaten wird das Plugin installiert.

==== Manuell ====

=== Inhalt aus dem Ordner „fc“ kopieren ===
In dem Pluginpaket befindet sich der Ordner //fc//.\\
Kopieren Sie diesen Ordner nach //{shoproot}/source/modules// (bei FTP - binären Übertragungsmodus nutzen).

{{public:faq:xml:210120_xml6_copy_fc.png?nolink&800|}}

Sollte der Ordner //fc// auf Ihrem Server schon existieren, können Sie den Ordner //fcXmlSitemap//, welcher sich im Modulpaket im Ordner //fc// befindet, direkt in den Serverordner //fc// laden.

{{:public:faq:xml:200828_xml_ox6_ftp.png?nolink&800|}}
 
=== composer.json aktualisieren ===
Öffnen Sie die Datei **composer.json** im Stammverzeichnis Ihres Shops und fügen Sie diese Autoload-Konfiguration hinzu oder vervollständigen Sie die vorhandene Konfiguration: \\ <code javascript>
  "autoload": {
    "psr-4": {
      "FC\\XmlSitemap\\": "./source/modules/fc/fcXmlSitemap"
    }
  },
</code> Nach erfolgter Ergänzung der Datei //composer.json// müssen die Änderungen dem OXID-System mitgeteilt werden.\\ Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis, in dem sich der Source- und Vendorornder befinden.\\ 
Führen Sie folgenden Befehl aus, um die Autoloader-Dateien neu zu generieren
    vendor/bin/composer dump-autoload
Beachten Sie, dass der genaue Aufruf des Composers für Ihre konkrete OXID-Installation abweichen kann. \\ \\ Nach erfolgreicher Aktion wird folgende Meldung angezeigt:\\ //Generating autoload files//\\ //Generated autoload files//


**In OXID-Versionen ab 6.2 (ältere Versionen können den Schritt überspringen)** muss die Modulkonfiguration eingelesen werden.\\
Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis, in dem sich der Source- und Vendorornder befinden. Führen Sie die folgenden Befehle aus:\\
<code>vendor/bin/oe-console oe:module:install-configuration source/modules/fc/fcXmlSitemap
vendor/bin/oe-console oe:module:apply-configuration </code>
Bei erfolgreichem Einlesen/Import erscheint die Nachricht\\
**Module configuration has been installed**

=== FATCHIP OXID 6 XML Sitemap aktivieren ===
Aktivieren Sie das Plugin im OXID Administrationsbereich unter //Erweiterungen -> Module -> FATCHIP OXID 6 XML Sitemap//. 

{{:public:faq:xml:200828_xml_ox6_activation.png?nolink&800|}}

===== Konfiguration =====
Erweiterungen -> Module -> FATCHIP OXID 6 XML Sitemap -> Einstell.

{{:public:faq:xml:200828_xml_ox6_einstellungen.png?nolink&600|}}

^ Supportkey ^^
^ Konfiguration ^ Beschreibung ^
|Supportkey|Den Supportkey finden Sie in der E-Mail mit Ihrem Plugin. Ohne Nennung dieses Keys kann Ihnen die FATCHIP GmbH keinen Support leisten.|

^ Grundeinstellungen ^^
^ Konfiguration ^ Beschreibung ^
|Standort des Sitemap-Ordners|Geben Sie hier den Ordner an, in dem die Sitemaps generiert werden sollen. Der Standard ist "sitemaps". Bei Erzeugung der\\ Sitemaps wird geprüft, ob der hier erwähnte Ordner existiert. Falls nicht, wird er angelegt|
|Produktsitemap anzeigen|Sitemap für Produkte ausgeben|
|Bilder zur Produktsitemap ausgeben|Gibt in der Produktsitemap zusätzlich die vorhandenen Bilder aus.\\ \\ **Hinweis**: Damit diese Option funktioniert muss die Ausgabe der Produktsitemap aktiviert sein.|
|Kategoriesitemap anzeigen|Sitemap für Kategorien ausgeben|
|Herstellersitemap anzeigen|Sitemap für Hersteller ausgeben|
|Tag-Sitemap anzeigen|Sitemap für Tags (Stichworte) ausgeben\\ \\ **Hinweis**: Damit diese Option in OXID 6 Shops funktioniert, müssen Sie das Tags Modul (OE Tags) von OXID installieren -> [[https://github.com/OXIDprojects/tags-module]].|
|Statische Sitemap anzeigen| Sitemap für statische Seiten (z. B. Kontakt) ausgeben.\\ Der statischen Sitemap wird automatisch die Domain hinzugefügt.\\ Sie können in der statischen Sitemap auch CMS-Seiten ausgeben lassen (siehe Hinzufügen von CMS-Seiten zur statischen Sitemap).|


^ Weitere Einstellungen ^^
^ Konfiguration ^ Beschreibung ^
|Nur Hauptbild (Bild Nr. 1) ausgeben|In der Produktsitemap wird nur das Hauptbild angegeben.\\\\ **Hinweis**: Damit diese Option funktioniert, muss die Ausgabe der Produktsitemap, sowie "Bilder zur Produktsitemap ausgeben" Option, aktiviert sein.|
|Verweise auf Seiten in anderen Sprachen verwenden|Es werden die alternative Links für jede aktive Sprache im Shop ausgegeben|
|Anzahl maximaler Produkte pro Sitemap| Hier können Sie bestimmen, wie viele Produkte maximal in einer Sitemap ausgegeben werden sollen. Der Standartwert ist 10.000.\\\\ **Hinweis**: Eine Vorgabe von Google ist, dass eine Sitemap maximal 50.000 URLs beinhalten darf. In dieser Zahl sind auch die URLs der Bilder und Sprachen gemeint.\\ (10.000 Produkte + 1 Bild) * 5 Sprachen = 100.000 URLs.\\ Eine Reduzierung des Standartwertes könnte von Nöten sein.|

^ Logging ^^
^ Konfiguration ^ Beschreibung ^
|Vorgangsprotikollierung|Folgende Einstellmöglichkeiten für das Logging stehen zur Verfügung:\\ - Nur Fehler protokolliern (Standard)\\ - Fehler und Warnungen Protokollieren\\ - Sämtliche Vorgänge protokollieren (Große Logfiles)\\ - Sämtliche Vorgänge + Entwickler-Informationen protokollieren (Sehr große Logfiles)|




==== Hinzufügen von weiteren URLs zur statischen Sitemap ====
Sie haben die Möglichkeit über die Datei **additional.json** weitere URLs zur statischen Sitemap hinzuzufügen.\\
Sie finden diese Datei auf Ihrem Server unter **{PfadzumShop}/modules/fc/fcXmlSitemap/files/{ShopId}**\\
Nach der Installation des Plugins befindet sich auf dem Server die Datei für den Shop mit der ShopId 1. Sollten Sie eine Enterprise Edition nutzen, müssen Sie für die jeweiligen Subshops einen Ordner anlegen, dessen Bezeichnung der ShopId des Subshops entspricht und die Datei *additional.json* in den Ordner kopieren.\\

{{public:faq:xml:210422_xml_additional.png?nolink&400|}}

Achten Sie bitte darauf, dass die Json Syntax eingehalten wird\\

Um eine URL, welche innerhalb der Shopdomain aufrufbar ist, hinzuzufügen, muss nicht die ganze URL angegeben werden. Hier muss nur der Teil nach der SHOP-URL bekannt gemacht werden. 

<code json>
{"1":{"url":"\/another-section","full":"false"}}
</code>

Um eine URL außerhalb der Shopdomain hinzuzufügen, muss die komplette URL angegeben werden:
<code json>
{"1":{"url":"https://anydomain.com/section-x","full":"true"}}
</code>

Bitte erhöhen Sie für jeden Eintrag die ID:

<code json>
{
  "1":{"url":"\/another-section","full":"false"},
  "2":{"url":"https://anydomain.com/section-x","full":"true"},
  "3":{"url":"\/","full":"false"}
}
</code>
===== Sitemapgenrierung =====
Die aktivierten Sitemaps werden durch den Aufruf des folgenden PHP-Scripts generiert:\\
  init_sitemap.php


Sollten Sie eine **Enterprise Edition** verwenden, fügen Sie die Shop-ID hinter dem Aufruf an:
  init_sitemap.php 1
  init_sitemap.php 2

Das PHP-Script generiert die Sitemaps entsprechend der Einstellungen im Backend und legt diese in dem angegebenen Ordner ab.\\

=== manuelle Generierung ===
Die Generierung kann über den Browser erfolgen. Geben Sie folgende Zeile in Ihrem Browser ein:\\
  {URL des Shops}/modules/fc/fcXmlSitemap/init_sitemap.php
//Enterprise Edition//
  {URL des Shops}/modules/fc/fcXmlSitemap/init_sitemap.php?OXID_SHOPID=1
  {URL des Shops}/modules/fc/fcXmlSitemap/init_sitemap.php?OXID_SHOPID=2
  
Über die Konsole kann die Generierung auch manuell angestoßen werden.\\
Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis\\
  {Shoproot}/modules/fc/fcXmlSitemap/
Rufen Sie dort das PHP-Script wie folgt auf:
  php init_sitemap.php

//Enterprise Edition//
  php init_sitemap.php 1
  php init_sitemap.php 2

=== Generierung über einen Cronjob ===
Neben dem manuellen Erzeugen der Sitemaps, kann dies auch über einen Cronjob erfolgen. \\ Legen Sie hierzu in Ihrem System einen Cronjob mit einem von Ihnen gewählten Intervall an und rufen Sie das Generierungsscript wie folgt auf\\
  {Shoproot}/modules/fc/fcXmlSitemap/init_sitemap.php
 
//Enterprise Edition//
  {Shoproot}/modules/fc/fcXmlSitemap/init_sitemap.php 1
  {Shoproot}/modules/fc/fcXmlSitemap/init_sitemap.php 2
  
Nähere Informationen zur Einrichtung eines Cronjobs auf Linuxsystemen finden Sie [[https://wiki.ubuntuusers.de/Cron/|hier]].
Fatchip GmbH Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge
