Installation für den Produktivbetrieb
Zur Installation des Plugins für den produktiven Einsatz auf einem Webserver gehen Sie folgendermaßen vor:
Installation der XML-Datenbank BaseX
Zunächst muss die XML-Datenbank BaseX von der BaseX-Webseite heruntergeladen werden. Der Download kann von hier erfolgen:
Am einfachsten erfolgt der Download von dort als ZIP Package
beispielsweise in der Version 9.4.4:
Die heruntergeladene zip-Datei kann anschließend entpackt werden. Üblicherweise erfolgt die Installation der Datenbank unter folgendem Pfad:
Aus einem Linux- oder Mac-Terminal würde das Herunterladen und Entpacken folgendermaßen erfolgen:
Nach dem Herunterladen und Entpacken muss die Jetty-Konfiguration angepasst werden, so dass die Applikation nur auf localhost
erreichbar ist. Dafür muss in der Konfigurationsdatei /opt/digiverso/basex/webapp/WEB-INF/jetty.xml
sichergestellt werden, dass der host
auf 127.0.0.1
und der port
auf 8984
steht:
Der Port zum stoppen von BaseX muss auch angepasst werden. Dafür muss unter /opt/digiverso/basex/.basex
folgendes stehen STOPPORT = 8985
.
Anschließend wird die Systemd Unit File
an diesen Pfad installiert:
Diese hat folgenden Aufbau:
Anschließend muss der Daemon neu geladen, die Unit-File aktiviert und die Datenbank neu gestartet werden:
Damit die Administrationsoberfläche von BaseX auch von extern erreichbar ist, kann dieses im Apache Webserver zum Beispiel mit dem folgenden Abschnitt konfiguriert werden:
Im Anschluß daran muss noch das Apache Modul proxy_http
aktiviert und der Apache neu gestartet werden, damit die Anpassungen wirksam werden:
Die XML Datenbank kann nach der Installation unter folgender URL erreicht werden:
Datenbank administrieren und EAD-Datei einspielen
Zum Einloggen müssen vorher Zugangsdaten festgelegt werden. Dies geht mit dem folgendem Befehl:
Nachdem BaseX heruntergeladen und gestartet wurde, können XML-Dateien als neue Datenbanken eingespielt werden. Dazu wird zunächst der Menüpunkt Database Administration
geöffnet, wo ein Login mit den vorher definierten Zugangsdaten erfolgen kann.
Nach dem ersten Anmelden sollte daher als erstes ein neues Passwort vergeben werden. Dazu muss der Menüeintrag Users geöffnet werden. Hier kann der Accountname angeklickt und das neue Passwort gesetzt werden.
Nach dem erfolgreichen Login erhält man einen Überblick über die installierten Datenbanken, Log-Dateien usw.
Unter dem Menüpunkt Databases
können neue Datenbanken für die EAD Dateien erzeugt werden. Das Archiv Management Plugin benötigt eine erstelle Datenbank.
Dort kann nun ein Name
für die neue Datenbank angegeben werden. Anschließend muss auf den Button Create
geklickt werden.
Nachdem die neue Datenbank erzeugt wurde, kann eine XML-Datei als Inhalt eingespielt werden. Klicken Sie hierzu auf den Button Add
.
Hier kann nun eine EAD-Datei als XML-Datei ausgewählt und ein Pfad vergeben werden, unter der dieser Datenbestand erreichbar sein soll. Anschließend muss ein Klick auf den Button Add
erfolgen.
Nachdem Einspielen der EAD-Datei steht der Inhalt für das Archivmanagement-Plugin von Goobi bereits zur Verfügung.
Im Administrationsbereich von BaseX können auch Dateien entfernt werden. Dazu müssen diese mittels der zugehörigen Checkbox markiert und dann mit einem Klick auf Delete
gelöscht werden. Das Aktualisieren einer EAD-Datei ist ausschließlich durch vorheriges Löschen und anschließendes neues Hinzufügen möglich.
Definition der Anfragen
Um BaseX für Abfrage aus Goobi einzurichten, muss der Datenbank bekannt gemacht werden, wie eine solche Anfrage aussieht, was mit dem Ergebnis der Abfrage geschehen soll und wie das Ergebnis der Abfrage auszusehen hat. Dafür bietet BaseX verschiedene Optionen an. Wir haben uns für RESTXQ
entschieden, da diese im Gegensatz zur REST Schnittstelle keine zusätzliche Authentifizierung benötigt.
Zur Konfiguration der Abfragen müssen im Pfad /opt/digiverso/basex/webapp/
mehrere neue Dateien erzeugt werden. Diese befinden sich innerhalb des Plugin-Repositories unterhalb des Pfades plugin/src/main/resources/(basex9|basex10)
und können von dort auch in den Ordner /opt/digiverso/basex/webapp/
kopiert werden. Alternativ können sie auch mit den folgenden Befehlen automatisch angelegt werden:
Für BaseX 9:
Für BaseX 10:
Inhalt der Datei listDatabases.xq
:
Inhalt der Datei openDatabase.xq
:
Inhalt der Datei importFile.xq
:
Je nachdem, wo die BaseX-Datenbank installiert wurde, müssen noch zwei Anpassungen für das Schreiben von EAD-Dateien im Dateisystem vorgenommen werden. Zunächst muss einmal ein Ordner erzeugt und mit entsprechenden Rechten versehen werden, damit darin EAD-Dateien gespeichert werden können. Dieser Ordner kann beispielsweise so lauten:
Um auf dieses angegebene Verzeichnis zugreifen zu können, muss es natürlich auf dem System auch tatsächlich existieren und daher ggf. noch angelegt werden und die Rechte angepasst werden:
Dieses Verzeichnis muss nun innerhalb von zwei Konfigurationsdateien richtig konfiguriert werden. Zunächst einmal erfolgt die Anpassung in Konfigurationsdatei plugin_intranda_administration_archive_management.xml
so, dass dort der Pfad definiert wird:
Außerdem muss auch die zuvor eingerichtete Datei importFile.xq
so anpasst werden, dass darin folgende Zeile auf den richtigen Pfad verweist:
Last updated