Benutzer-Werkzeuge

Webseiten-Werkzeuge


cookbook:staging

Dies ist eine alte Version des Dokuments!


Staging mit syncData2

Unter Staging versteht man unter anderem das Testen einer Website auf einem nichtöffentlichen Server. Bezogen auf BlackCat CMS könnte das beispielsweise bedeuten, daß die Inhalte zunächst in einer lokalen Umgebung - beispielsweise auf Basis einer Portable-Installation - erstellt und gepflegt werden, bevor sie auf den öffentlichen Webserver übertragen werden.

Das manuelle Übertragen von Inhalten ist jedoch mühselig und fehleranfällig. Glücklicherweise steht jedoch das Werkzeug syncData2 der phpManufaktur zur Verfügung, um dies zu vereinfachen.

Allgemeines zu syncData2

Das Werkzeug syncData2 ist grundsätzlich unabhängig vom CMS, benötigt aber einige Informationen darüber. Unterstützt werden neben BlackCat CMS auch Website Baker und LEPTON, da sich diese in der Grundstruktur ähnlich sind.

Installation

Die Installation von syncData2 erfolgt in ein Unterverzeichnis syncdata innerhalb des CMS, parallel zu den Verzeichnissen wie 'media', 'framework' oder 'modules'.

syncData2 ist kein CMS-Modul! Die Installation kann also nicht über das BlackCat Backend erfolgen!

Nach dem Entpacken des ZIPs in dieses Verzeichnis wird mit

  http://<CAT_URL>/syncdata/setup

die Installation aufgerufen. Sobald diese abgeschlossen ist, wird ein automatisch generierter Schlüssel angezeigt, den man sich notieren und sicher aufbewahren sollte, denn dieser Schlüssel wird für den Im- und Export von Daten benötigt.

Wir empfehlen den zusätzlichen Schutz des syncdata-Verzeichnisses auf dem öffentlichen Server mit Hilfe eines Verzeichnisschutzes per .htaccess, sofern verfügbar.

Sollte BlackCat CMS in einem Unterverzeichnis installiert sein, muß vor der ersten Benutzung von syncData2 die Datei

  <CAT_PATH>/syncdata/.htaccess

angepaßt werden. Diese beinhaltet eine Zeile

  RewriteBase /syncdata

Diese Zeile muß entsprechend angepaßt werden. Beispiel: Wird BlackCat CMS über die URL

  http://<Domain>/bc 

aufgerufen und befindet sich syncData2 somit unter

  http://<Domain>/bc/syncdata, 

ist der Pfad folgendermaßen anzupassen:

  RewriteBase /bc/syncdata

Konfiguration

syncData2 verfügt über vielfältige Konfigurationsmöglichkeiten; unter anderem ist einstellbar, welche Datenbanktabellen und Verzeichnisse von der Sicherung bzw. dem Import ausgenommen werden sollen. Alle Einstellungen befinden sich in der Datei

  <CAT_PATH>/syncdata/config/syncdata.json

JSON ist eine aus JavaScript stammendes kompaktes Datenformat in einer einfach lesbaren Textform zum Zweck des Datenaustauschs zwischen Anwendungen.

Die Datei ist in mehrere Bereiche untergliedert:

CMS
Einstellungen des CMS
„email“
Einstellungen für den Mailversand
„monolog“
Einstellungen für das interne Logging
„general“
Allgemeine Einstellungen
„backup“
Einstellungen für den Export
„restore“
Einstellungen für den Import

Die größten Bereiche sind „backup“ und „restore“; hier kann definiert werden, welche Datenbanktabellen, Verzeichnisse und Dateien ignoriert werden sollen. Das ist wichtig, weil man beispielsweise das temp-Verzeichnis üblicherweise nicht mit sichern und wiederherstellen möchte. Daher ist dies standardmäßig ausgenommen, ebenso wie die Verzeichnisse kit2 (kitFramework und Erweiterungen) und syncdata.

Das Verzeichnis syncdata muß immer ausgeklammert werden, da sonst natürlich auch die Konfigurationsdateien beim Staging überschrieben werden würden.

Die nachfolgenden Bereiche existieren sowohl in backup als auch in restore und funktionieren grundsätzlich gleich:

„settings“
Allgemeine Einstellungen; replace_table_prefix, add_if_not_exists und replace_cms_url sollten üblicherweise immer auf true gesetzt sein
„files“
Hier können beliebig viele Dateien eingetragen werden, die ignoriert werden sollen. Wichtig: Diese Einstellung gilt für alle Verzeichnisse!
„directories“
Eine Liste von Verzeichnissen (=Verzeichnisnamen), die ignoriert werden sollen. Auch diese Einstellung gilt global, also auch für alle Unterverzeichnisse!
„tables“
Eine Liste von Tabellennamen, die ausgenommen werden sollen. Wichtig: Die Tabellennamen ohne das Präfix angeben!

Erstes Backup

Die Erstellung einer Komplettsicherung ist denkbar einfach. Hierzu wird syncData2 mit dem Parameter „backup“ und dem Sicherungsschlüssel, der während der Installation erzeugt wurde, aufgerufen.

  http://<CAT_URL>/syncdata/backup?key=<Schlüssel>

Die Sicherung kann je nach Umfang der Installation recht lange dauern, also Geduld! Das Ergebnis liegt nach Abschluß des Backups im Verzeichnis

   /syncdata/data/backup
cookbook/staging.1423138417.txt.gz · Zuletzt geändert: 2015/02/05 00:00 (Externe Bearbeitung)