Einrichtung für das Hosting mehrerer Bäume

Standardmäßig erlaubt Gramps Web nur den Zugriff auf eine einzelne Familienstammbaum-Datenbank („Baum“), die in der Konfigurationsdatei angegeben ist.

Mit der Version 0.7.0 des Gramps Web API-Backends ist es jedoch auch möglich, mehrere Bäume aus einer einzigen Installation bereitzustellen. Jeder Benutzer ist jedoch (derzeit) an einen einzelnen Baum gebunden, sodass dieses Setup nicht für das Teilen von Bäumen zwischen Benutzern geeignet ist, sondern für das Hosting mehrerer isolierter Gramps Web-Instanzen.

Multi-Baum-Unterstützung aktivieren

Um die Multi-Baum-Unterstützung zu aktivieren, muss die TREE-Konfigurationsoption auf einen einzelnen Stern * gesetzt werden, z. B. in einer Konfigurationsdatei:

TREE = "*"

Dies macht alle Bäume im Gramps-Datenbankverzeichnis des Servers zugänglich (vorausgesetzt, die Benutzer haben ausreichende Berechtigungen). Die ID des Baums ist der Name des Unterverzeichnisses. Sie können vorhandene Bäume (Namen und IDs) mit dem Befehl auflisten

python -m gramps_webapi --config /app/config/config.cfg tree list

Darüber hinaus sollten Sie die MEDIA_PREFIX_TREE-Konfigurationsoption auf True setzen, um sicherzustellen, dass Mediendateien in separaten Unterordnern gespeichert werden. Andernfalls können Benutzer auf Mediendateien zugreifen, die zu einem Baum gehören, für den sie keine Berechtigung haben!

Ein Benutzerkonto zu einem bestimmten Baum hinzufügen

Um einen Benutzer zu einem bestimmten Baum hinzuzufügen, fügen Sie einfach die --tree TREEID-Befehlszeilenoption zum Befehl zum Hinzufügen eines Benutzers hinzu. Sie können auch eine POST-Anfrage an den Endpunkt /users/ mit der tree-Eigenschaft im JSON-Payload senden.

Benutzernamen müssen über alle Bäume hinweg eindeutig sein. E-Mail-Adressen müssen nicht eindeutig sein (seit Gramps Web API 3.22), sodass dieselbe Person beispielsweise Konten in mehreren Bäumen mit einer einzigen E-Mail-Adresse haben kann.

Einen neuen Baum erstellen

Um einen neuen Baum zu erstellen, wird empfohlen, eine POST-Anfrage an den Endpunkt /trees/ zu senden, anstatt die Gramps-CLI zu verwenden. Dies verwendet eine UUIDv4 als Baum-ID, was zusätzliche Sicherheit bietet, da der Name nicht erraten werden kann. Neu erstellte Bäume verwenden das in der NEW_DB_BACKEND-Konfigurationsoption festgelegte Datenbank-Backend: SQLite (der Standard) oder SharedPostgreSQL. Siehe Verwendung einer PostgreSQL-Datenbank für Details.

Autorisieren

Um sich zu autorisieren (ein Token abzurufen), sind nur Benutzername und Passwort erforderlich, wie im Einzelbaum-Modus, da die Baum-ID für jeden Benutzer bekannt ist und es daher nicht notwendig ist, sie anzugeben.

Vorhandene Mediendateien migrieren

Wenn Sie eine vorhandene Gramps Web-Instanz auf die Multi-Baum-Unterstützung migrieren und lokale Mediendateien verwenden möchten, können Sie diese einfach in einen Unterordner des ursprünglichen Standorts mit der Baum-ID als Namen verschieben.

Wenn Sie Mediendateien verwenden, die auf S3 gehostet werden, können Sie das im scripts-Verzeichnis des gramps-web-api-Repositories bereitgestellte Skript verwenden:

python scripts/s3_rename.py BUCKET_NAME TREE_ID

Dies setzt voraus, dass die relevanten Zugriffsschlüssel bereits als Umgebungsvariablen festgelegt sind.

Vorhandene Benutzerdatenbank migrieren

Wenn Sie die Multi-Baum-Unterstützung aktivieren und vorhandene Benutzer wiederverwenden möchten, müssen Sie sie einem bestimmten Baum zuweisen. Sie können den folgenden Befehl verwenden, der dafür bereitgestellt wird,

python -m gramps_webapi --config /app/config/config.cfg user fill-tree TREE_ID

Das Frontend anpassen

Die Registrierungsseite, die von der Anmeldeseite aus zugänglich ist, funktioniert in einem Multi-Baum-Setup nicht, da ein Baum für die Registrierung angegeben werden muss. Es ist daher ratsam, hideRegisterLink auf true in der Frontend-Konfiguration zu setzen.