Installation
- Plugin Manager über Einstellungen > System > Plugins aufrufen
- Das Plugin hochladen, installieren und aktivieren
Staging-System anlegen
Einstellungen → Erweiterungen → Staging-System
Einstellungen
- Interner Name: Interne Bezeichnung des Staging-Systems.
- Pfadtyp: Legt fest, wo das Staging-System erstellt wird. Je nach verfügbarer Funktion kann das Staging-System in einem Unterverzeichnis, auf einem benutzerdefinierten Pfad desselben Servers oder auf einem externen Server erstellt werden.
Staging in einem Unterverzeichnis- Verzeichnis: Name des Verzeichnisses, in dem das Staging-System erstellt wird. Der Verzeichnisname wird ohne führenden oder abschließenden Schrägstrich angegeben, beispielsweise staging. Das Staging-System ist anschließend standardmäßig über die bestehende Shop-URL mit angehängtem Verzeichnis erreichbar, beispielsweise meinshop.de/staging.
Staging auf einem benutzerdefinierten PfadMit dieser Option können die Dateien des Staging-Systems an einer anderen Stelle im Dateisystem desselben Servers abgelegt werden.
- Verzeichnis: Name des Staging-Verzeichnisses, beispielsweise staging.
- Benutzerdefinierter Pfad: Absoluter Serverpfad, unter dem das Staging-Verzeichnis angelegt werden soll, beispielsweise /var/www/. Der angegebene Verzeichnisname wird automatisch an diesen Pfad angehängt.
- Pfad testen: Prüft, ob der angegebene Pfad für das Staging-System verwendet werden kann
Der benutzerdefinierte Pfad legt den Speicherort der Dateien fest. Die öffentliche Erreichbarkeit des Staging-Systems muss zusätzlich über die Staging-URL und gegebenenfalls die Webserver-Konfiguration eingerichtet werden.
Staging auf einem externen ServerMit der Zusatzfunktion „Staging auf einem externen Server“ kann das vollständige Staging-System per SSH/SFTP auf einem separaten Server eingerichtet werden.
- Remote-SSH-Host: Hostname oder IP-Adresse des Servers, auf dem das Staging-System erstellt werden soll.
- Remote-SSH-Port: SSH-Port des externen Servers. Standardmäßig wird üblicherweise Port 22 verwendet.
- Remote-SSH-Benutzer: Benutzername für die SSH-/SFTP-Verbindung zum externen Server.
- Remote-SSH-Passwort: Passwort des angegebenen SSH-Benutzers.
- Test-Verbindung: Prüft, ob mit den hinterlegten SSH-Zugangsdaten eine Verbindung zum externen Server hergestellt werden kann.
- Remote-Pfad: Absoluter Dateisystempfad auf dem externen Server, unter dem das Staging-System installiert werden soll, beispielsweise /var/www/staging.
Der übergeordnete Pfad muss auf dem externen Server bereits vorhanden sein. Das letzte benötigte Verzeichnis kann durch das Plugin angelegt werden. Der Document-Root der verwendeten Domain muss entsprechend auf das öffentliche Verzeichnis der Shopware-Installation zeigen. Werden im Shop oder in Erweiterungen absolute Dateipfade verwendet, beispielsweise für Importe oder Exporte, müssen diese gegebenenfalls an den neuen Serverpfad angepasst werden.
Staging-URL konfigurieren
In diesem Bereich wird festgelegt, unter welcher URL das Staging-System erreichbar ist.
- Automatisch generierte URL: Verwendet die bestehende Shop-URL und ergänzt das konfigurierte Staging-Verzeichnis. Bei einem Verzeichnis staging kann daraus beispielsweise meinshop.de/staging entstehen.
- Eigene Domain / Subdomain: Ermöglicht die Verwendung einer separaten Domain oder Subdomain für das Staging-System, beispielsweise staging.meinshop.de.
- APP-URL: Vollständige URL des Staging-Systems bei Verwendung einer eigenen Domain oder Subdomain. Diese wird als APP_URL des Staging-Systems hinterlegt.
DNS-Einträge sowie die Webserver- beziehungsweise vHost-Konfiguration für eine eigene Domain oder Subdomain müssen außerhalb des Plugins eingerichtet werden. Bei einem Staging-System auf einem externen Server ist eine eigene APP-URL erforderlich.
Staging-Domains bearbeiten
Verwendet der Shop mehrere Verkaufskanäle oder Domains, können für diese separate Staging-Domains definiert werden.
- Staging-Domain: Legt für die jeweilige bestehende Verkaufskanal-Domain die URL fest, unter der sie im Staging-System erreichbar sein soll.
Dadurch können beispielsweise mehrere Storefronts jeweils über eigene Staging-Subdomains aufgerufen werden. Jede Staging-Domain muss eindeutig sein und kann nicht gleichzeitig mehreren Verkaufskanal-Domains zugeordnet werden.
Datenbank konfigurieren
Für das Staging-System wird eine eigene Datenbank benötigt. Beim Erstellen werden die benötigten Daten aus der bestehenden Shop-Datenbank übernommen und für das Staging-System angepasst.
- Datenbank-Host: Host des Datenbankservers. Befindet sich die Datenbank auf demselben Server, kann beispielsweise 127.0.0.1 verwendet werden.
- Datenbank-Port: Port des Datenbankservers. Für MySQL beziehungsweise MariaDB wird standardmäßig Port 3306 verwendet.
- Name der Datenbank: Name der Datenbank, die für das Staging-System verwendet werden soll.
- Datenbank-Benutzer: Benutzername für den Zugriff auf die Staging-Datenbank.
- Datenbank-Passwort: Passwort des angegebenen Datenbank-Benutzers.
- Test-Verbindung: Prüft, ob mit den eingetragenen Zugangsdaten erfolgreich eine Verbindung zur Staging-Datenbank hergestellt werden kann.
Allgemeine Einstellungen
- Shopbetreiber E-Mail-Adresse: E-Mail-Adresse, die im neu erstellten Staging-System als Shopbetreiber-E-Mail-Adresse in den Shopware-Stammdaten hinterlegt wird.
- Internes Kommentar: Optionales Kommentarfeld für interne Informationen zur Staging-Konfiguration, beispielsweise zum Einsatzzweck oder zu Besonderheiten der Umgebung.
E-Mail-Versand und Zugriff absichern
E-Mail-Versand
- Mailversand beim Staging System deaktivieren: Deaktiviert den E-Mail-Versand innerhalb des Staging-Systems. Dadurch wird verhindert, dass während Tests versehentlich Bestellbestätigungen, Registrierungs-E-Mails oder andere Nachrichten an reale Empfänger versendet werden.
Suchmaschinen- Setze den Meta-Namen „robots“ auf „noindex,nofollow“: Ergänzt die Seiten des Staging-Systems um die entsprechende Robots-Anweisung und weist Suchmaschinen an, die Seiten nicht zu indexieren und enthaltenen Links nicht zu folgen.
- Erstelle eine robots.txt und verbiete alle Bots: Erstellt eine robots.txt, über die Suchmaschinen-Crawler vom Crawlen des Staging-Systems ausgeschlossen werden.
Passwortschutz- Passwortschutz aktivieren: Aktiviert einen zusätzlichen Zugriffsschutz für das Staging-System.
- Benutzername: Benutzername, der für den Zugriff auf das geschützte Staging-System verwendet wird.
- Passwort: Passwort für den Zugriff auf das Staging-System.
Wartungsmodus- Wartungsmodus: Aktiviert nach der Erstellung den Shopware-Wartungsmodus für das Staging-System. Dadurch ist das Storefront nur für entsprechend freigegebene IP-Adressen erreichbar.
Datenübernahme konfigurieren
- Bestellungen kopieren: Legt fest, ob bestehende Bestellungen aus dem Livesystem in das Staging-System übernommen werden. Ist die Option deaktiviert, werden unter anderem Bestellungen, Bestellpositionen, Lieferungen und Transaktionen nicht mit bestehenden Daten befüllt.
- Kunden kopieren: Legt fest, ob bestehende Kundendaten aus dem Livesystem übernommen werden. Ist die Option deaktiviert, werden unter anderem Kunden, Kundenadressen und weitere kundenspezifische Daten nicht mit bestehenden Datensätzen befüllt.
- Nicht benötigte Tabelleninhalte nicht kopieren: Schließt Daten aus Tabellen aus, die für ein typisches Staging-System nicht benötigt werden. Dazu können beispielsweise Warenkörbe, Logs, Queue-Daten, Versionsdaten und weitere temporäre Daten gehören. Dadurch kann die zu übertragende Datenmenge reduziert und die Erstellung beschleunigt werden.
- Shopware Migration Datenbank Tabellen nicht kopieren: Wird angezeigt, wenn der Shopware Migration Assistant installiert ist. Die teilweise sehr umfangreichen Migrationstabellen werden dabei nicht mit bestehenden Daten befüllt.
Erstellung konfigurieren
- Staging-System in Nachrichtenwarteschlange erstellen: Erstellt das Staging-System über die Shopware-Nachrichtenwarteschlange. Die einzelnen Verarbeitungsschritte werden dabei nacheinander über die Queue ausgeführt.
- Staging System in den DEV-Modus setzen: Aktiviert für die neue Umgebung den Shopware- beziehungsweise Symfony-Entwicklungsmodus. Dieser eignet sich insbesondere für Entwicklung und Fehlersuche.
- Symfony Toolbar deaktivieren: Deaktiviert die Symfony Web Debug Toolbar trotz aktiviertem DEV-Modus. Da die Toolbar technische und sensible Systeminformationen anzeigen kann, empfiehlt sich die Deaktivierung insbesondere bei öffentlich erreichbaren Staging-Systemen.
Verzeichnisse vom Staging ausschließen
- Ausgenommene Verzeichnisse: Pfade zu Dateien oder Verzeichnissen, die von der Übertragung ausgeschlossen werden. Die Pfade werden relativ zum Shopware-Root-Verzeichnis angegeben, beispielsweise public/media.
Zusätzliche Admin-Benutzer anlegen
Im Bereich „Zusätzliche Admin Benutzer für Staging System“ können Benutzer definiert werden, die bei jeder Neuerstellung des Staging-Systems automatisch in der Shopware-Administration angelegt werden.
- Vorname: Vorname des Administrationsbenutzers.
- Nachname: Nachname des Administrationsbenutzers.
- E-Mail-Adresse: E-Mail-Adresse des Administrationsbenutzers. Die Adresse muss eindeutig sein.
- Benutzername: Benutzername für die Anmeldung in der Administration des Staging-Systems.
- Passwort: Passwort für die Anmeldung des Benutzers.
- Administrator: Legt fest, ob der Benutzer vollständige Administratorrechte erhält.
- Sprache der Benutzeroberfläche: Legt fest, in welcher Sprache die Shopware-Administration für den Benutzer angezeigt wird.
- Zeitzone: Legt die Zeitzone des Administrationsbenutzers fest.
- Job-Titel: Optionaler Job-Titel des Benutzers.
- Rollen: Ermöglicht die Zuweisung bestehender Shopware-Rollen, wenn der Benutzer keine vollständigen Administratorrechte erhalten soll.
Staging-System erstellen
Nachdem alle benötigten Einstellungen vorgenommen wurden, muss die Konfiguration zunächst gespeichert werden. Anschließend kann das Staging-System über „Staging-System erstellen“ angelegt werden. Während der Erstellung führt das Plugin abhängig von der gewählten Konfiguration unter anderem folgende Schritte durch:
- Verbindung zur Staging-Datenbank prüfen
- Staging-Datenbank vorbereiten
- Dateien des bestehenden Shops kopieren
- Datenbank des Livesystems exportieren
- Daten in die Staging-Datenbank importieren
- Shop- und Systemkonfiguration an die Staging-Umgebung anpassen
- Staging-Domains und APP-URL konfigurieren
- E-Mail-, Suchmaschinen- und Zugriffseinstellungen anwenden
- Zusätzliche Admin-Benutzer anlegen
- Bei einem externen Staging-System die Dateien per SSH/SFTP auf den Zielserver übertragen
Erstellungsprozess prüfen- Details zum Erstellungsprozess: Zeigt die einzelnen Verarbeitungsschritte der Staging-Erstellung und gegebenenfalls aufgetretene Fehler an.
- Admin öffnen: Öffnet nach erfolgreicher Erstellung die Administration des Staging-Systems.
- Storefront öffnen: Öffnet das Storefront des Staging-Systems.
Staging-System entfernen
- Staging-Datenbank leeren: Entfernt die vorhandenen Tabellen und Inhalte aus der konfigurierten Staging-Datenbank. Das Staging-System ist anschließend nicht mehr funktionsfähig, bis es erneut erstellt wird.
- Staging-Dateisystem löschen: Löscht die Dateien aus dem konfigurierten Staging-Verzeichnis. Bei einem externen Staging-System wird das entsprechende Verzeichnis auf dem externen Server entfernt.
Plugin-Konfiguration
Erweiterungen → Meine Erweiterungen → Staging-System → Konfigurieren
In der allgemeinen Plugin-Konfiguration werden Statusinformationen zur aktuell verwendeten Shop-Installation angezeigt.
- Wenn aktiv, dann ist „meta name=robots content=noindex,nofollow“ gesetzt: Zeigt an, ob die aktuelle Installation durch das Plugin mit „noindex,nofollow“ gekennzeichnet wurde. Das Feld dient ausschließlich als Statusanzeige und kann nicht manuell verändert werden.
- Wenn aktiv, dann ist es ein Staging System: Zeigt an, ob die aktuelle Shop-Installation vom Plugin als Staging-System gekennzeichnet wurde. Auch dieses Feld dient ausschließlich als Statusanzeige.
Staging auf einem externen Server
Das Plugin bietet optional die Zusatzfunktion „Staging auf einem externen Server“. Damit kann das Staging-System vollständig auf einem separaten Server eingerichtet werden, anstatt es auf demselben Server wie das Livesystem anzulegen. Die Zusatzfunktion kann direkt über die Administration erworben werden. Dafür muss der Shop unter Erweiterungen → Meine Erweiterungen → Shopware-Account mit einem Shopware-Account verbunden sein. Nach der Aktivierung steht beim Pfadtyp zusätzlich die Option zur Erstellung auf einem externen Server zur Verfügung.