SyncCto

Mit syncCto kann der Benutzer im Backend mehrere Contao-Installationen miteinander synchronisieren.

Was ist syncCto?

syncCto bietet die Möglichkeit mehrere Contao-Installationen auf Basis einer Grund-Installation zu synchronisieren. Alle Aktionen können bequem im Backend durchgeführt werden. Durch die Integration in das Contao Rechtesystem können auch Redakteure eine Auswahl vorher definierter Datenbank-Tabellen und Dateien synchronisieren.

Ein integrierter Backup-Manager sichert ausgewählte Datenbank-Tabellen, wahlweise die gesamte Contao-Installation oder nur die persönlichen Daten. Angelegte Backups können durch den Backup-Manager auch wieder importiert werden.

Durch die Verwendung von syncCto können Redakteure schnell und einfach in einem Preview-System arbeiten und bei Vollendung der Arbeit den aktuellen und freigegebenen Stand zum Live-System synchronisieren.

Server und Client bei syncCto

Zu unterscheiden ist zwischen Server und Client. Die Server-Installation ist die Installation die auf den Client übertragen werden soll. Der Client ist die Contao Installation, zu der synchronisiert werden soll, also meistens die Installation, die auf dem Live-Server liegt.
Anders gesagt, Entwicklungssystem: syncCto Server ; Livesystem: syncCto Client. Es gibt komplexere Beispiele, dazu folgt mehr in den weiteren Abschnitten.

Konfiguration

Systemcheck

Für eine reibungslose und fehlerfreie Synchronisation ist es wichtig als erstes alle Installationen zu kontrollieren. Dafür steht der neue Menüpunkt Systemcheck zur Verfügung, denn dort werden alle für syncCto wichtigen Funktionen und Ressourcen des Servers aufgelistet. Sind alle Zellen grün, ist der erste Schritt getan. Sollte dies nicht der Fall sein, kann syncCto womöglich nicht erfolgreich funktionieren.

Einstellungen

Bevor man die erste Installation synchronisieren kann, muss zwingend bei allen Installationen auf denen syncCto installiert ist, der Menüpunkt Einstellungen (Contao Einstellungen) aufgerufen und gespeichert werden. Bei diesem Vorgang wird der ctoCommunication API Key generiert. Den ctoCommunication API Key aus den Einstellungen der Clientinstallation benötigt man später bei der Erstellung des zuvor erwähnten Clients.

Zu beachten: Der von syncCto verwendete ctoCommunication API Key ist nicht der Contao-Installations-Schlüssel.

Clients verwalten

Um im Server einen neuen Client anzulegen, klickt man im Menüpunkt Clients einfach auf den Button "Neuer Client".

• ctoCommunication API Key: Dieser Schlüssel sichert die Kommunikation zwischen den Contao-Installationen ab.
• Titel: z.B. der Kundenname und der Name des Servers
• Beschreibung: Eine aussagekräftige Beschreibung des Servers
• Domain: Die Domain des Clients, ohne Unterverzeichnis
• Serverpfad: Falls sich die Installation in einem Unterverzeichnis befindet
• Portnummer: Standardmäßig ist es der Port 80
• Verschlüsselungs-Engine: Es stehen drei Möglichkeiten zur Verfügung, in der Regel genügt "Blowfish"
• HTTP-Authentifizierung aktivieren: Falls der Client mit einer .htaccess abgesichert ist, kann man hier den Benutzernamen und das Passwort eingeben und die gesicherte Installation synchronisieren

Synchronisation

Um den Client mit dem Server zu synchronisieren, klickt man beim entsprechenden Client auf den rechten Button "Client synchronisieren". Im nächsten Fenster wählt man die Synchronisationsart aus.

• Contao-Installation: Die gesamte Contao-Installation, Dateien und Ordner in den tl_files müssen seperat ausgewählt werden
• Persönliche Daten: Nur ausgewählte Dateien und Ordner im tl_files Ordner. Core-Dateien werden nicht berücksichtigt

Standardmäßig ist die Option Persönliche Daten ausgewählt.
Danach kann man die DB-Tabellen auswählen. Man muss in diesem Schritt wissen welche Tabellen welche Daten enthält. Zum Schluss wählt man bei Bedarf noch Dateien und Ordner im tl_files aus und klickt für den Start der Synchronisation auf den Button "Client synchronisieren".

Backups

Backups können im Backend unter dem Menüpunkt Backups angelegt und wiederhergestellt werden. Alle Backups werden im automatisch angelegten Ordner "syncCto_backups" in den tl_files abgelegt. Datenbanken finden sich im Ordner "database" und Dateien im Ordner "files". Wenn man Backups wieder einspielen möchte, klickt man im Menüpunkt auf Backups und wählt die Art der Wiederherstellung. Im nächsten Schritt wählt man die entsprechende Datei aus und klickt auf "Wiederherstellen". Die Dateien oder die Datenbank auf dem Server werden danach mit den Daten aus dem Backup überschrieben.

Backups automatisiert löschen

Ab der Version 1.1.0 liegen der Extension zwei neue Cronjobs bei. Die Cronjobs löschen in Verbindung mit der Extension Cron automatisiert die Backups aus dem jeweiligen Ordner. Bei der Konfiguration der Cronjobs muss man den Link zum PHP-Script eingeben und den Intervall einstellen.

Zur Verfügung stehen folgende zwei PHP-Skripte:

• SyncCtoDeleteDbBackups.php Löscht alle Datenbank-Backups
• SyncCtoDeleteFileBackups.php Löscht alle Datei-Backups

Konfiguration der Cronjobs

Die Backups werden mit dieser Einstellung alle 7 Tage um genau 0:00 gelöscht. Möchte man den Zeitraum erhöhen, muss man */7 einfach gegen die Zahl austauschen. */14 löscht die Backups beispielsweise alle 14 Tage.

Konfiguration zum Ausführen der Cronjobs

Nach Fertigstellung könnten die Cronjobs folgendermaßen aussehen:

Übersicht Cronjobs

Anwendungsfall 1

Auf dem Webserver laufen zwei Contao-Installationen.

• Die Adresse der 1. Webseite heißt http://192.168.0.100/server/
• Die Adresse der 2. Webseite heißt http://192.168.0.100/client/

Der Server, bei syncCto, beschreibt immer die Installation die alle Informationen hat, die man auf eine andere Installation übertragen will. Dieses Ziel wird bei syncCto als Client beschrieben. Server und Client laufen also auf der gleichen Maschine auf den gleichen Webserver.

Anwendungsfall 2

Es gibt 2 Seiten die auf zwei verschiedenen Maschinen laufen. Beide Maschinen sind verbunden; egal ob nun im lokalen Netzwerk oder über das Internet. Dabei ist es wichtig das der Server den Client erreichen kann. Der Server kann lokal zuhause auf dem internen Webserver laufen. Der Client allerdings muss von außen erreichbar sein.

• Server läuft lokal zuhause die Adresse ist http://192.168.0.100/server
• Der Client liegt im Internet und hat die Adresse http://www.example.com

So wird im Server für den Client einfach die Adresse http://www.example.com eingetragen.

Mögliche Problemfälle

Der SMH ist keine Lösung da die Daten via HTTP versendet werden. Ein ordentlich konfigurierter Server ist daher Pflicht.

Um möglichen Problemfällen auf die Spur zu kommen kann man den Debugmodus in den Einstellungen aktivieren. Dabei wird die Dauer der Synchronisation und die Speicherauslastung während der Synchronisation ausgegeben. Zusätzlich werden Debugdateien im Tempordner von Contao abgelegt. Diese sind bei Problemen immer im Forum anzuhängen.

Weiterführende Links

• Tutorial zu syncCto2