Webtrees Handbuch/Anleitung für Webmaster

aus GenWiki, dem genealogischen Lexikon zum Mitmachen.

Anleitung für Webmaster

Auswahl eines Hosting-Anbieters

Hosting auf einem eigenen Server

Bitte ergänzen... Hier kann man webtrees selbst installieren und gestalten. Installation auf einem Server im Internet und auf einem lokalen Server beschreiben!

Hosting-Anbieter für webtrees

Es gibt zwei Hosting-Anbieter, die sich auf webtrees spezialisert haben. Sie bieten eine fertige und speziell auf die Anforderungen von webtrees ausgerichtete Installation auf Servern in der EU an und kümmern sich um die grundlegende Betriebssicherheit.

Ein Webtrees-Hosting-Paket ist ideal für diejenigen, die webtrees nutzen möchten, sich aber nicht mit der Einrichtung und dem Betrieb der Anwendung herumschlagen möchten. Sie erhalten als Nutzer ein komplett installiertes und vorkonfiguriertes System und müssen sich nur um ihre eigenen Daten kümmern. Alles andere erledigt der Dienstleister im Hintergrund. Er kümmert sich in der Rolle als Webmaster um die Technik, administriert das System und sorgt dafür, dass webtrees und die notwendigen Systemkomponenten immer auf dem neuesten Stand sind.

Voraussetzungen

Derzeit unterstützt webtrees bei der Zeichenkodierung in der Datenbank nur UTF8_MB3, aber nicht UTF8_MB4. Dadurch ist es nicht möglich Texte oder andere Datenfelder zu speichern, die etwa Emoji enthalten.

Installation

Ersteinrichtung

config.ini.php

Test der Installation

Nachdem die Erstinstallation abgeschlossen ist, sollte in einem ersten Test die einwandfreie Funktion der Website geprüft werden.

Noch ergänzen: wie testet man am besten?

Installation von Erweiterungsmodulen

Nach dem erfolgreichen Test können nun noch Erweiterungsmodule installiert werden (siehe dazu den Abschnitt "Erweiterungsmodule"). Dies sollte schrittweise erfolgen, damit bei eventuell auftretenden Problemen das verursachende Erweiterungsmodul leichter identifiziert werden kann.

Als Webmaster können Sie auf dem Server im Ordner "/modules_v4" installierte Erweiterungsmodule durch eine Umbenennung auf einfache Art deaktivieren. Dazu müssen Sie in den Ordnernamen einen "." (Punkt) einfügen, etwa indem Sie an den Ordnernamen ein ".disable" anhängen. Also indem Sie etwa den Ordner "jc-theme-justlight" in "jc-theme-justlight.disable" umbenennen. Solche Ordner sind dann für webtrees komplett unsichtbar. Durch das Entfernen des angehängten Namensbestandteils zu einem späteren Zeitpunkt, wird das Erweiterungsmodul wieder für webtrees sichtbar. Diese Funktion reicht somit tiefer als das Aktivieren oder Deaktivieren von Erweiterungsmodulen im Menü "Module" durch einen Administrator und ist immer dann zu empfehlen, wenn vermutet wird, dass ein Erweiterungsmodul Fehler verursacht.

Upgrade

Eine Aktualisierung von webtrees geht schnell und einfach. Falls der Kern von webtrees auf einen neuen Versionsstand gebracht werden soll, dann stehen zwei verschiedene Wege zur Verfügung: das automatische und das manuelle Verfahren. Für die Aktualisierug eines Erweiterungsmoduls steht nur das manuelle Verfahren zur Verfügung.

Upgrade von webtrees

Das Vorliegen einer neuen Version wird dem Administrator in einer Hinweiszeile angezeigt. Es wird dringend empfohlen, die Installation zu aktualisieren, sobald eine neue Version von webtrees zur Verfügung steht. Selbst kleinere Upgrades enthalten in der Regel eine erhebliche Anzahl von beseitigten Fehlern sowie Verbesserungen in der Benutzungsoberfläche oder Programmerweiterungen. Gefundene und behobene Sicherheitslücken fürhren immer zu einer neuen Version, die dann schnellstmöglich eingespielt werden sollte. Falls nicht sowieso regelmäßig Datensicherungen erstellt werden, sollte vor einem Update immer eine Sicherung durchgeführt werden.

Hinweis auf eine neue Version

Versionen von webtrees

Die Versionsnummern von webtrees in der Form x.y.z, also etwa 2.1.0, folgen folgendem Schema

• die erste Zahl "x" kennzeichnet eine Hauptversion, die nicht miteinander kompatible Versionen unterscheidet.

Die Datenbankstruktur von webtrees in der Version 1 und die internen Schnittstellen der Module von webtrees passen nicht zur Version 2 von webtrees. Erweiterungsmodule für webtrees 1 funktionieren also nicht mit der Version 2 und umgekehrt. Ein Upgrade bei einem Wechsel der Hauptversion ist nur manuell möglich. Hierzu gibt es eine spezielle Anleitung und es müssen umfangreiche Vorbereitungen für das Upgrade getroffen werden.

• die zweite Zahl "y" kennzeichnet eine neue Version, die grundsätzlich neue Funktionen und geänderte interne Schnittstellen mit sich bringt.

Erweiterungsmodule können kompatibel sein, sind es aber wahrscheinlich eher nicht. Vor dem Einspielen eines Updates sollte also geprüft werden, ob alle im Einsatz befindlichen Erweiterugsmodule in einer kompatiblen Version vorliegen. Der Wechsel von Version 2.0 zur Version 2.1 etwa betrifft so viele interne Schnittstellen, dass die meisten Erweiterungsmodule angepasst werden müssen. Bei einem Wechsel der webtrees-Version kann es auch vorkommen, dass andere Versionen von PHP unterstützt werden, so dass der Webmaster gleichzeitig auch einen Wechsel der PHP-Version vornehmen kann oder muss.

• die dritte Zahl "z" kennzeichnet eine Unterversion, die etwa gefundene Fehler behebt oder kleinere Anpassungen mit sich bringt.

Im Normalfall werden die meisten Erweiterungsmodule von diesen Änderungen nicht betroffen sein und können deshalb weiter verwendet werden.

Eine Übersicht über alle bislang vorliegenden Versionen von webtrees ist im Kapitel "Allgemeine Erläuterung des Programms" aufgeführt.

Automatisches Upgrade

Protokoll des Aktualisierungsablaufs

webtrees hat die Fähigkeit, sich automatisch zu aktualisieren. Alle 24 Stunden sucht webtrees nach einer aktualisierten Version. Sollte ein Upgrade verfügbar ist, dann erscheint eine Hinweiszeile mit einem Link, sofern man als Administrator angemeldet ist. Durch einen Klick auf den Link kann der Administrator den Upgrade-Assistenten für das automatische Update nutzen.

Automatische Upgrades sind von Berechtigungen und Ressourcen auf dem Server abhängig. Die verwendeten PHP-Skripte benötigen die Berechtigung

• Dateien vom webtrees-GitHub-Server über eine gesicherte Kommunikation auf den webtrees-Server zu kopieren.
• Dateien auf dem Server zu überschreiben. Wenn der Webserver Skripte als anonymer Benutzer ausführt, dann wird er keine Berechtigung haben, Dateien zu aktualisieren. Wenn Sie also aufgefordert werden, die Berechtigungen des Ordners /data auf 777 zu ändern, können Sie das automatische Upgrade nicht verwenden; sie müssen in diesem Fall dann ein manuelles Upgrade durchführen oder die Voraussetzugen für das automatische Upgrade schaffen.

Der Server muss ausreichend leistungsfähig sein, um das Upgrade abzuschließen, ohne CPU- und Speichergrenzen zu überschreiten. Der Server muss ungefähr 130 MB freien Speicherplatz haben, um die neue Version zu speichern und zu entpacken. Das Upgrade dauert normalerweise zwischen 15 und 60 Sekunden. Wenn nach fünf Minuten keine Antwort erfolgt ist, dann wurde wahrscheinlich ein CPU-Zeitlimit erreicht und das Upgrade ist fehlgeschlagen.

Noch beschreiben: was muss der Webmaster genau tun, damit sein Server die benötigten Fähigkeiten hat

Der automatische Upgrade-Prozess erfolgt in den folgenden Schritten

Warnung bei installierten Erweiterungsmodulen

1. Falls Erweiterungsmodule installiert sind, erfolgt ggf. eine Warnung, dass diese [[Webtrees Handbuch/Anleitung für Webmaster/Erweiterungsmodule|Erweiterungsmodule|| eventuell mit der neuen Version von webtrees nicht kompatibel sein könnten (siehe nebenstehende Abbildung). Hier sollte man also den Prozess ggf. abbrechen, wenn man erst die Kompatibilität prüfen möchte. Hilfreich sind dazu ein Blick ins webtrees-Forum und auf die GitHub-Seiten der installierten Erweiterungsmodule. Ein Upgrade auf einem webtrees-Testserver kann die Sicherheit bringen, dass sich die installierten Erweiterungsmodule mit der neuen webtrees-Version vertragen werden; erst danach sollte dann das Upgrade im Produktivsystem eingespielt werden.
2. Danach wird ein Verzeichnis "/data/tmp/upgrade" angelegt, in das temporär die neuen Dateien geladen werden.
3. Nun wird geprüft, ob es noch Änderungen von Daten in den Stammbäumen gibt, die noch nicht vom Moderator freigegeben wurden (siehe Abschnitt "Freigeben von Änderungen durch einen Moderator").
4. Es werden alle Stammbäume automatisch exportiert, d.h. es wird für jeden Stammbaum im Verzeichnis "/data" eine aktuelle GEDCOM-Datei angelegt (der Dateiname enthält das Datum des Exports).
5. Vom webtrees-GitHub-Server wird die neue webtrees-Version als zip-Datei in das im Schritt 2 angelegte Verzeichnis kopiert.
6. Die zip-Datei wird in das temporäre Verzeichnis entpackt und die entpackten Dateien werden dann an die Zielstelle kopiert.
7. Zum Abschluss öffnet sich das Verwaltungsmenü. Hier kann vom Administrator kontrolliert werden, ob die neue Version korrekt angezeigt wird.

Bricht der Prozess in Schritt 3 ab, wenn noch unbestätigte Änderungen vorliegen?

Manuelles Upgrade

Beim manuellen Upgrade lädt der Webmaster eine neue, freigegebene Version von webtrees auf einen lokalen Rechner herunter und entpackt diese Version dort. Falls Erweiterungsmodule installiert sind, sollte überprüft werden, ob diese mit der neuen Version von webtrees kompatibel sind. Eventuell stehen für diese Module auch Upgrades zur Verfügung.

Dann werden alle Ordner und Dateien mit einem ftp-Programm in das webtrees-Verzeichnis auf dem Webserver kopiert. Während die neuen Dateien hochgeladen werden, würde ein Besucher der Website auf eine Mischung aus alten und neuen Dateien stoßen. Dies könnte ein unvorhersehbares Verhalten oder Fehler verursachen. Um dies zu verhindern, muss vor dem Kopieren die Datei "/data/offline.txt.disable" in "/data/offline.txt" umbenannt werden. Solange diese Datei existiert, werden die Besucher der Website eine Meldung sehen: "Die Webseite befindet sich im Wartungsmodus. Sie sollten es in einigen Minuten erneut versuchen.". Wenn die Datei "offline.txt" leer ist, dann wird diese Standardnachricht angezeigt; alternativ kann man eine besondere Nachricht in diese Datei schreiben, so dass die Besucher dann stattdessen diese Meldung erhalten. Nach dem Kopieren der Dateien auf den Server muss die Datei wieder in "/data/offline.txt.disable" umbenannt werden. Auch wenn der Administrator in der Systemsteuerung ein anderes Verzeichnis für den Datenordner gewählt haben sollte, der Speicherort für diese Datei ist immer im Verzeichnis "/data".

Beim Wechsel von einer Unterversion zu einer anderen, kann man üblicherweise den Inhalt der Dateien auf dem Server einfach überschreiben. Beim Wechsel zu einer neuen Version oder gar einer Hauptversion empfiehlt es sich alle Dateien im webtrees-Verzeichnis auf dem Server zuvor zu löschen. Davon ausgenommen ist die Datei .htaccess im Stammverzeichnis von webtrees und die Dateien im Unterverzeichnis "/data".

Wie verläuft ein Upgrade, wenn man Composer einsetzt?

Upgrade in Abhängigkeit von der Ausgangsversion

Wenn Sie derzeit eine der unten aufgeführten Versionen von webtrees verwenden, gibt es beim Upgrade zusätzliche Dinge zu beachten.

• webtrees bis 2.0.23: beim Update auf die Version 2.1 ändern sich in Vorbereitung auf den GEDCOM-Standard 7.0 einige Datenfelder
• webtrees 2.0.8: Diese Version enthält einen Fehler im Auto-Upgrade-Code; diese Version wurde schnell zurückgezogen, aber einige Benutzer haben sie installiert. Um den automatischen Upgrade-Assistenten wieder verwenden zu können, müssen zwei Dateien bearbeitet werden
  • Bearbeiten Sie zunächst app/Factories/FilesystemFactory.php und ändern Sie Zeile 40 von „/../../..“ in „/../…“. Dies behebt den Fehler.
  • Bearbeiten Sie zweitens app/Webtrees.php und ändern Sie Zeile 101 von „2.0.8“ in „2.0.7“. Dadurch wird das automatische Upgrade wieder aktiviert.
• webtrees 1.7.10 – 1.7.19: Es sind vor einem manuellen Upgrade auf die Version 2 diverse Änderungen an den Einstellungen, der Serverkonfiguration und eventuell auch Anpassungen in den genealogischen Daten notwendig. Daher sollte Sie unbedingt diese Anleitung vor dem Upgrade beachten.
• webtrees 1.4.0 – 1.7.9: Es muss vor einem Umstieg auf die Version 2 erst ein Upgrade auf die Version 1.7.19 erfolgen.
• webtrees 1.0.0 – 1.3.2: Zuerst muss die „Medien-Firewall“ deaktiviert werden (siehe Anleitung in englischer Sprache); dann muss ein manuelles Upgrade auf die Version 1.7.19 durchgeführt werden.
• phpGedView: In webtrees 1.7.19 ist ein spezieller Migrationsassistent für das Vorgänger-Programm phpGedView integriert. Sie sollten daher diese Version als neue Instanz neben phpGedView installieren und dann den Migrationsassistenten nutzen. Beachten Sie, dass Sie keine funktionierende phpGedView-Installation benötigen. Sie benötigen nur die Datenbank und den Ordner index. Nähere Hinweise finden Sie in der englischsprachigen Dokumentation.

Upgrade eines Erweiterungsmoduls

Wenn eines der Erweiterungsmodule in einer neuen Version vorliegt, erhält der Administrator beim Aufruf der Verwaltungsseite eine entsprechende Nachricht.

Noch beschreiben: wie findet man heraus welches Erweiterungsmodul die Meldung erzeugt hat und wo man die aktuellere Version findet

Dann lädt man als Webmaster das neue Release des Erweiterungsmoduls auf den lokalen Rechner herunter und entpackt den Inhalt. Eventuell muss man den gefundenen Ordnernamen noch entsprechend der Anleitung zu diesem Modul umbenennen, etwa von einer angehängten Versionsnummer befreien. Danach lädt man den Ordner mit einem ftp-Programm ins Verzeichnis modules_v4 der webtrees-Installation und überschreibt den dortigen Inhalt (man kann auch den alten Ordner mit dem Erweiterungsmodul auf dem Server zuvor löschen).

Zum Abschluss muss im Browser das Fenster mit webtrees erneut geladen, d.h. aufgefrischt werden, damit die Änderung sichtbar wird.

Pretty URLs

Datensicherheit und Datenschutz

Sichere Kommunikationsverbindung

https ...

Logfile-Überwachung

Zugriffsschutz

Dateirechte

.htaccess

robots.txt

Datenschutzerklärung und Impressum

Das folgende sind nur erste Stichpunkte zu den relevanten Positionen ...

• Standard-Erklärung versus eigenes Modul
• Google-Diagramme führen zur Weitergabe von IP-Adressen an Google in USA
• Tracking-Funktionen in webtrees
• Einbindung von webseiten im html-Blöcken auf der Startseite
• Einbindung von Funktionen im CCS/Javascript-Modul

Suchmaschienenoptimierung

Die Auffindbarkeit von webtrees-Seiten durch Suchmaschinen kann erwünscht oder unerwünscht sein.

Wenn man nicht möchte, dass die Seiten gefunden werden, dann muss man die im Abschnitt "robots.txt" beschriebene Funktion nutzen und die Einstellungen in der webtrees-Verwaltung wie im Abschnitt "Datenschutz" verwenden, um Informationen für Besucher unsichtbar zu machen. Suchmaschinen greifen mit den selben Rechten auf webrees-Seiten zu wie Besucher.

Auf der anderen Seite kann es sinnvoll sein, dass einige der Informationen, die man in den Stammbäumen hinterlegt hat, durch Suchmaschinen indiziert werden. So können andere Familien- oder Ahnenforscher oder entfernte Familienmitglieder auf diese Informationen aufmerksam werden, wenn sie etwa nach einem Familiennamen im Internet suchen. Dadurch kann man dann mit diesen in Kontakt kommen und so die eigene Forschung entsprechend erweitern.

Noch beschreiben Was beeinflusst die Rangfolge bei den Suchtreffern? Wie unterstützt webtrees dies?

sitemap.xml

Die Funktion und der Aufbau von sitemap.xml muss noch beschrieben werden ...

Ergänzen von Hinweisen zu den Seiten von Suchmaschinen wo man die sitemap.xml einreichen kann

Backup der genealogischen Daten und der Datenbank

Da ein jedes IT-System durch technische Probleme, durch Fehlkonfigurationen oder durch Cyber-Attacken gestört werden kann, ist es unbedingt erforderlich ein Backup-Konzept zu erstellen. Die webtrees-Anwendung selbst kann jederzeit wieder frisch installiert werden, aber die genealogischen Daten und die in der Datenbank hinterlegten Einstellungen müssen regelmäßig gesichert werden.

Eventuell legt der Hosting-Anbieter bereits automatisch regelmäßige Backups an. Wenn dies nicht der Fall sein sollte, dann muss der Webmaster sich selbst darum kümmern.

Backup der genealogischen Daten

Um die genealogischen Daten zu sichern, sollten alle in webtrees angelegten Stammbäume regelmäßig durch den Webmaster als GEDCOM-Datei exportiert werden. Diese GEDCOM-Dateien sollten mit einem Datum im Dateinamen versehen werden und nicht nur auf dem Server gespeichert werden, sondern auch auf einem anderen sicheren Datenträger archiviert werden. Dieser Datenträger sollte nicht online sein, d.h. er sollte nicht permanent aus dem Internet zugänglich sein.

Die Mediendateien, die etwa im webtrees-Verzeichnis "data/media" gespeichert sind, müssen ebenfalls regelmäßig mit Hilfe eines ftp-Programms gesichert werden. Die Vorschaubilder (thumbnails) brauchen nicht gesichert zu werden, da sie bei Bedarf jederzeit automatisch wieder neu erzeugt werden.

Auch die Einstellungen in "data/config.ini" müssen gesichert werden.

Backup der webtrees Datenbank

Jeder Hosting-Anbieter bietet einen Zugang zu der von webtrees genutzten Datenbank, etwa durch das Werkzeug "phpMyAdmin".

Der folgende Ablauf muss noch verifiziert und ggf. genauer beschrieben werden ...

Wählen Sie für die Datensicherung im Hauptfenster von phpMyAdmin im oberen Menü „Exportieren“ und dann „Los“. Wählen Sie nach einigen Sekunden aus, wohin Sie exportieren möchten, und klicken Sie auf die Schaltfläche „Speichern“, um die Sicherung auf Ihren Computer herunterzuladen.

Wenn Sie eine gesicherte Datenbank wieder installieren möchten, dann nutzen Sie dafür ebenfalls phpMyAdmin. Wählen Sie im Hauptfenster im oberen Menü „Importieren“ und dann „Los“, damit die vorhandenen Tabellen durch die gesicherten ersetzt werden.

Neuinstallation von Webtrees-Dateien

Löschen Sie alle Ordner im webtrees-Verzeichnis bis auf den Ordner "data". Löschen Sie im Hauptverzeichnis alle Dateien bis auf die Datei ".htaccess". Nun laden Sie wie bei der Erstinstallation die aktuellste Version von webtrees auf ihren lokalen PC und dann mit einem ftp-Programm auf ihren Server ins Verzeichnis webtrees.