In der StageWare® Dokumentation findest du eine Erklärung jedes einzelnen Konfigurationsfeldes und jeder einzelnen Funktion.


Inhaltsverzeichnis


Video-Tutorial und Anleitungen

Über diese Dokumentation hinaus, gibt es auch noch zahlreiche Anleitungen und Video-Tutorials.


  • Umfassendes Video-Tutorial
  • Testumgebung erstellen
  • Backup erstellen und wiederherstellen
  • Guide für Shopware Updates


All diese Anleitungen sind Bestandteil der StageWare® Utilities, die du als StageWare®-Nutzer kostenfrei anfordern kannst.


Häufige Fehler und Fragen

Falls du Probleme oder Fragen hast, schaue zunächst einmal kurz in den Artikel Häufige Fragen und Fehler.

Hier wirst du sehr wahrscheinlich sofort eine Lösung für dein Anliegen finden.

Ansonsten stehen wir dir unter support@tc-innovations.de jederzeit zur Verfügung.


Installation von StageWare® über das Shopware Backend

  1. StageWare® über den Plugin Manager installieren und aktivieren
    Wie jedes andere Shopware Plugin, wird StageWare® einfach über den Plugin Manager installiert. Bitte achte darauf, dass du das Plugin nach der Installation auch aktivierst.
  2. Einmalige Grundkonfiguration
    Die Grundkonfiguration erfolgt in den Plugin-Einstellungen. Diese findest du über Einstellungen > Plugin Manager > Installiert > StageWare® (rechts Stift-Symbol anklicken). Sieh dir nun die Auswahlmöglichkeiten bei Server-Pfad für „mysql/mysqldump“ an. Sollte hier dein Hoster aufgelistet sein, wähle ihn unbedingt aus.
  3. Testumgebung konfigurieren
    Öffne den StageWare® Manager über Einstellungen > StageWare® Manager in deinem Shopware Backend. Klicke nun in den Tab „PROFILE“ und wähle dann das Profil „Staging 1“. Lege nun auf deinem Server eine neue Datenbank an und trage die Datenbank-Zugangsdaten rechts bei „Datenbank-Einstellungen“ ein.
  4. Testumgebung anlegen
    Wähle innerhalb der StageWare® Verwaltung nun den Tab „TESTUMEBUNGEN“. Klicke dann bei „Testumgebung für Profil Staging 1“ im Bereich Aktionen > 1-Klick-Aktionen auf „Einrichten“. Eine eventuell bereits eingerichtete Testumgebung wird dabei überschrieben. Bitte beachte, dass das Einrichten je nach größte deines Shops einige Minuten dauern kann.
  5. Fertig! Testumgebung öffnen und nutzen
    Super, du hast es geschafft! Nun kannst du über Aktionen > Testumgebung aufrufen bequem das Frontend oder Backend deiner Testumgebung öffnen und damit arbeiten. Übrigens kannst du deine Testumgebung hier auch jederzeit wieder zurücksetzen, indem du die Testumgebung neu einrichtest.


Voraussetzungen einer Testumgebung

Um die Voraussetzungen zum Anlegen einer Testumgebung zu prüfen, sollten du im StageWare® Manager in den Tab Systemprüfung wechseln. Hier siehst du neben einer Auflistung der serverseitigen Mindestanforderungen die aktuellen Werte.


Empfohlene Mindestanforderungen im Überblick

  • PHP Version: 7.0 oder höher
  • PHP memory_limit: 256M
  • PHP max_execution_time: 60
  • Speicherplatz: 20 GB bei Managed oder selbst verwalteteten Servern bzw. 50% bei Shared Hosting frei
  • PHP log_errors: aktiv
  • PHP error_log: Sollte konfiguriert sein


Erklärung der einzelnen Anforderungen

PHP Version

Die eingesetzte PHP-Version ist maßgeblich für die Verfügbarkeit gewisser Funktionen und vor allem die Performance deines Shops und unser Plugins. Aus Performance-Gründen solltest du mindestens PHP 7.0 einsetzen. Sollte es zu Unklarheiten über oder zu Problemen bei der PHP-Version kommen, so sind sowohl dein Webhoster als auch dein technischer Dienstleister für deine Shop-Installation die richtigen Ansprechpartner. Kontaktiere am besten beide, bevor du eine Entscheidung triffst.


PHP memory_limit

Das PHP memory_limit ist der maximal nutzbare Arbeitsspeicher, der jedem einzelnen Scriptaufruf zur Verfügung gestellt wird. Das Kopieren und Anlegen einer Testumgebung ist ein relativ anspruchsvoller Vorgang, aber wir haben StageWare® so weit optimiert, dass 256MB memory_limit in der Regel ausreichend sind. Sollte es dennoch zu Engpässen oder Problemen bei diesem Wert kommen, so ist dein Webhoster oder technischer Dienstleister der richtige Ansprechpartner. Bitte ihn darum, das PHP memory_limit zu erhöhen.


PHP max_execution_time

Die PHP max_execution_time begrenzt die maximale Ausführungszeit für ein Script. Der angegebene Wert versteht sich in Sekunden. Das Kopieren und Anlegen einer Testumgebung ist ein relativ anspruchsvoller Vorgang und dauert oft entsprechend lange. Wir haben für die Arbeitsschritte in StageWare® eine Stapelverarbeitung implementiert, sodass 60 Sekunden max_execution in der Regel ausreichend sind. Sollte es dennoch zu Engpässen oder Problemen bei diesem Wert kommen, so ist dein Webhoster oder technischer Dienstleister der richtige Ansprechpartner. Bitte ihn darum, die PHP max_execution_time zu erhöhen.


Speicherplatz

Um eine Testumgebung oder ein Backup anzulegen, ist freier Speicherplatz auf deinem Server notwendig. Der verbrauchte Speicherplatz darf niemals das Limit erreichen, weil dann die Funktionsfähigkeit deines Live-Shops nicht mehr garantiert werden kann. Achte dauer darauf, dass immer ausreichend freier Speicherplatz zur Verfügung steht. Sprich mit deinem Hoster, falls du mehr Speicherplatz benötigst.

Achtung: Nicht auf allen Systemen kann der Speicherplatz von StageWare® richtig ermittelt werden. Dies ist oft bei Shared Hosting Paketen der Fall. Hier siehst du den gesamten Speicherplatz des Servers, aber nicht das, was dir davon maximal zur Verfügung steht. Prüfe daher dann auch den Speicherverbrauch in der Verwaltungsoberfläche deines Hosters.


PHP log_errors (optional)

Diese Funktion muss aktiv sein, damit PHP-Fehlermeldungen überhaupt geloggt werden. Wir empfehlen dringend, dass diese Funktion aktiviert werden soll. Nur so können auftretende Fehler erkannt, nachvollzogen und schnell gelöst werden. Am besten kontaktierst du deinen Hoster und bittest um die Aktivierung des PHP Errorlogs (Pfad in error_log festlegen und log_errors aktivieren).


PHP error_log (optional)

Dieser Wert definiert den Pfad, wo die Errorlog-Datei gespeichert ist. Wir empfehlen dringend, dass der Errorlog definiert werden soll. Nur so können auftretende Fehler erkannt, nachvollzogen und schnell gelöst werden. Am besten kontaktierst du deinen Hoster und bittest um die Aktivierung des PHP Errorlogs (Pfad in error_log festlegen und log_errors aktivieren).


Arbeiten mit StageWare®

Um StageWare® zu nutzen, musst du den StageWare® Manager öffnen. Diesen findest du in deinem Shopware Backend unter dem Menü-Punkt Einstellungen.


Profile

Profile beinhalten alle Einstellungen, die für die Erstellung von Testumgebungen oder Backups notwendig sind.

Du kannst beliebig viele Profile anlegen.


Live-Profil

Eine Besonderheit ist das Live-Profil. Dieses entspricht deinem Live-Shop und kann nicht verändert werden.


Profile anlegen

Rechts oben kannst du auf "Neu" klicken, um ein neues Profil anzulegen. Hierbei kann ein bestehendes kopiert werden, damit du nicht alle Einstellungen neu setzen musst. Bei einer Kopie werden der Name sowieso der Pfad automatisch angepasst, können von dir aber jederzeit wieder verändert werden.


Profile bearbeiten

Um ein Profil zu bearbeiten, musst du es einfach anklicken, die gewünschten Änderungen vornehmen und dann unten rechts auf Speichern klicken.


Profil-Einstellungen

Nachfolgend werden die einzelnen Profil-Einstellungen erklärt.


Name

Der Name des Profils dient dir zu Erkennung und Unterscheidung deiner verschiedenen Testumgebungen. Er sollte einmalig sein und deine Testumgebung eindeutig beschreiben. Der Name wird übrigens (automatisch reduziert auf erlaubte Zeichen), auch in Dateinamen von Backups verwendet.


Einrichten aus Profil

Jedes Profil hat ein Quell-Profil, aus dem die Daten für die spätere Testumgebung heraus kopiert werden. Dies wird in den meisten Fällen das Live-Profil sein. Du kannst aber jederzeit Testumgebungen von anderen Testumgebungen erstellen.


Ordner

Dies ist der Ordnername, in dem die jeweilige Testumgebung innerhalb des Shopware-Ordners angelegt wird. Es es ist möglich mehrere Testumgebungen in einem gemeinsamen Unterordner zu gruppieren. Nachfolgend findest du einige Beispiele.

Direkt im Shopware-Odner: /staging1

Gruppiert in Unterordner:/testumgebungen/staging1


Ausschlüsse

Hiermit können komplette Ordner oder einzelne Dateien ausgeschlossen werden. Du kannst in den Plugin-Einstellungen konfigurieren, welche Ausschlüsse (Quelle, Ziel oder beide) bei der Einrichtung einer Testumgebung ignoriert werden sollen.

Ausschlüsse müssen als relativer Pfad angegeben werden und werden intelligent im jeweiligen Kontext verwendet. Es können beliebig viele Ausschlüsse per Zeilenumbruch, Komma (,) oder Semikolon (;) getrennt angegeben werden. Andere Testumgebungen, der Cache-Ordner und der stage_ware_data-Ordner werden immer automatisch ausgeschlossen.

Nachfolgend findest du einige Beispiele:

phpMyAdmin ausschließen: /phpmyadmin-1

Datei ausschließen: /ordner_name/file.txt


Datenbank-Einstellungen

Jede Testumgebung benötigt eine eigene, leere Datenbank. Diese kannst du in der Regel selber mit wenigen Klicks im Backend deines Servers anlegen.

Hinterlege hier alle abgefragten Datenbank-Einstellungen. Falls du nicht weißt, wie du eine Datenbank anlegst, ist dein Hoster der richtige Ansprechpartner.


Testumgebungen

Eine Testumgebung (oder auch Staging-System genannt) ist eine Kopie deines Live-Shops, die völlig autark und unabhängig vom Live-Shop läuft. Jede Testumgebung basiert auf einem Profil, in dem alle nötige Einstellungen (wie z.B. das Quell-System sowie das Ziel, wo die Testumgebung installiert werden soll) vorgenommen werden. Jegliche Änderungen in der Testumgebung wirken sich dadurch nicht auf deinen Live-Shop aus. Du kannst beliebig viele Testumgebungen anlegen und bestehende Testumgebungen beliebig oft neu einrichten. In der Regel wird eine Testumgebung aus einem Live-Shop erstellt, du kannst aber auch Testumgebungen aus anderen Testumgebungen heraus anlegen. 

Im Bereich Testumgebungen erhältst du einen Überblick über alle verfügbaren Testumgebungen, deren Status und Konfiguration. Vor allem aber, kannst du deine Testumgebungen hier steuern. 


Aktionen

Hier kannst du deine Testumgebung steuern, also diese einrichten und löschen. Du kannst zusätzlich die Konfiguration einsehen, mit der die Testumgebungen jeweils eingerichtet worden sind (Button Eingerichtete Konfiguration).


1-Klick-Aktion
Die Einrichtung führt alle notwendigen Schritte durch, damit eine lauffähige Testumgebung erstellt wird. Eventuell vorhandene Dateien in dem Zielpfad sowie Daten in der Datenbank werden vorher automatisch entfernt. Daher kannst du eine Testumgebung einfach überschreiben, ohne diese vorher löschen zu müssen. Solltest du die Testumgebung einfach nur löschen wollen, dann kannst du dies über den Button Löschen machen.


Testumgebung aufrufen

Hiermit kannst du einfach das Frontend oder das Backend deiner Testumgebung öffnen.


Quell-Profil

Hier siehst du einen kurzen Überblick der Einstellungen, die in deinem Quell-Profil hinterlegt sind. Falls du die Einstellungen dieses Profils ändern willst, wechsle bitte in den Bereich Profile.


Ziel-Profil

Hier siehst du einen kurzen Überblick der Einstellungen, die in deinem Ziel-Profil (also im Profil dieser Testumgebung) hinterlegt sind. Falls du die Einstellungen dieses Profils ändern willst, wechsle bitte in den Bereich Profile.


Ausschlüsse

Hier siehst du die Ausschlüsse, also die Ordner, die beim Einrichten der Dateien nicht mit in die Testumgebung übertragen werden. Je nach Einstellung in der Plugin-Konfiguration werden die Ausschlüsse des Quell- oder Ziel-Profils oder sogar beide berücksichtigt. Wenn du die Ausschlüsse ändern willst, wechsle bitte in den Bereich Profile. Einige Ausschlüsse (wie z.B. andere Testumgebungen oder Cache-Ordner) werden automatisch als ausgeschlossene Ordner definiert.


Backups

Hier erstellst du Backups deiner Systeme. Die Besonderheit ist, dass du neben vollständigen Backups auch gezielt nur Backups der Dateien oder der Datenbank erstellen kannst. Bei Erstellung werden die Ausschlüsse des zugehörigen Profils berücksichtigt und außerdem die bei der Einrichtung der Testumgebung modifizierten Daten (Shop-Pfad, Cronjobs, E-Mail Adresse, etc.) wieder in den ursprünglichen Zustand versetzt. Andere Testumgebungen, der Cache-Ordner und der stage_ware_data-Ordner werden immer automatisch ausgeschlossen.


Backups Erstellen

In der Übersicht siehst du alle Profile, den jeweiligen Backup-Pfad, mögliche Aktionen sowie Datum und Uhrzeit der letzten Backups.

Du kannst selber festlegen, ob du ein Vollständigen Backup oder nur eines mit Dateien oder der Datenbank anlegen kannst.


Download und Verwaltung

Hier siehst du eine Übersicht alle Profil und darin eine Liste aller verfügbaren Backups.

Diese kannst du hier Downloaden oder vom Server löschen.