2. FAQ

Wie kann ich herausfinden wie alt mein Goobi viewer ist?

Im Quelltext der Seite befindet sich ganz am Anfang verschiedene meta-Tags, die Auskunft über das Alter und die Codebasis der eingesetzten Version geben:

<meta name="generator" content="Goobi viewer" />
<meta name="version" content="21.01" />
<meta name="build date" content="2021-01-10 05:44" />
<meta name="git-revision" content="dd0bea0" />

"Goobi viewer" ist der Produktname, "21.01" die Versionsnummer. "2021-01-10 05:44" entspricht dem Datum, wann die Applikation kompiliert wurde. "dd0bea0" sind die ersten sieben Zeichen des Git-Commit-Hashs der für die Kompilierung verwendet wurde.

Das Datum ist ein guter, erster Indikator. Nach dem Git-Commit-Hash kann zum Beispiel auf GitHub gesucht werden um herauszufinden auf welchem Stand die Applikation genau ist.

Wie kann ich meinen gesamten Datenbestand neu indexieren?

Für die Neuindexierung des gesamten Datenbestandes muss der Inhalt des indexed_mets Ordners in den hotfolder kopiert werden:

cp /opt/digiverso/viewer/indexed_mets/*.xml /opt/digiverso/viewer/hotfolder/

Vor dem Kopieren muss darauf geachtet werden, dass der Hotfolder leer ist damit keine potentiell korrigierten Werke mit einer älteren Version aus dem indexed_mets Ordner überschrieben werden.

Welche Webbrowser werden vom Goobi viewer unterstützt?

Der Goobi viewer unterstützt alle sogenannten "Evergreen Browser". Das sind die aktuellen Versionen von Google Chrome, Firefox, Safari und Microsoft Edge.

Ältere Versionen, insbesondere der Internet Explorer 11 werden seit Mitte Juli 2018 nicht mehr offiziell unterstützt.

Welchen Datenbanken werden vom Goobi viewer unterstützt?

Der Goobi viewer unterstützt für den produktiven Einsatz die Datenbanken MySQL oder MariaDB und für die Goobi to go Umgebung auch H2.

Oracle Database, Microsoft SQL Server und PostgreSQL Datenbanken sind zur Zeit nicht möglich.

Das Dateisystem mit den Goobi viewer Daten ist voll, kann ich davon was löschen?

Wenn das Dateisystem auf denen die Daten des Goobi viewers liegen voll ist, in der Regel /opt/digiverso/, dann können folgende Ordner ohne Probleme geleert werden:

  • updated_mets/

  • deleted_mets/

  • error_mets/

Für die Bedeutung der Verzeichnisse siehe Kapitel 3.2.

Weiter können die folgenden Ordner geprüft werden:

  • abbyy/ Die Dateien in diesem Ordner werden seit Oktober 2017 vom Goobi viewer Indexer automatisch zu ALTO konvertiert. Der Goobi viewer selbst verwendet nur noch das ALTO. Wenn die Daten über Goobi workflow eingespielt wurden liegen diese dort vor und können im Goobi viewer gelöscht werden.

  • pdf/ Die in diesem Ordner vorgehaltenen PDF Dokumente werden bei einem PDF-Download aus dem Goobi viewer ausgeliefert. Gibt es hier keine Dateien, dann wird (sofern konfiguriert) aus Bild und optionaler ALTO Datei ein PDF mit optional hinterlegtem Text generiert und ausgeliefert. Das Ergebnis ist also das Gleiche, nur die Zeit für die Auslieferung kann unter Umständen länger dauern. Für die so generierten PDF-Dateien gibt es aber einen Cache unter cache/pdf.data, so dass PDF Dokumente die einmal generiert wurden, dort bis zu einer Cache-Größe von 100GB vorgehalten werden.

Wie kann ich den Goobi viewer kompilieren?

Das Theme wird kompiliert und der Core ist als Abhängigkeit eingebunden. Deswegen sind im folgenden die notwendigen Schritte beschrieben, wie das Reference-Theme neu ausgecheckt wird und eine viewer.war kompiliert wird:

  • Falls noch nicht geschehen muss maven installiert werden:

sudo apt install maven
  • Anschließend das Theme auschecken:

mkdir -p /opt/digiverso/viewer/themes
cd /opt/digiverso/viewer/themes
git clone https://github.com/intranda/goobi-viewer-theme-reference.git
  • Nun die Applikation kompilieren:

cd /opt/digiverso/viewer/themes(goobi-viewer-theme-reference/goobi-viewer-theme-reference/
mvn package

Am Ende befindet sich der kompilierte Goobi viewer im Ordner target/viewer.war.

Wie ist die Arbeit mit Git und Branches?

Es gibt einen master Branch der immer stabil und installierbar ist.

Daneben existiert ein sogenannter develop Branch, der neue Funktionen enthält aber noch nicht komplett stabil sein kann.

Von dem Develop Branch gehen feature_ Branches ab, in denen neue Funktionalität entwickelt wird. Sobald diese fertig sind werden sie in den Develop Branch gemergt und von Zeit zu Zeit fließen die Entwicklungen aus dem Develop in den stabilen Master Branch zurück.

Wie funktioniert die Versionierung im Goobi viewer?

Der Goobi viewer und seine Komponenten haben eine Versionsnummer die sich aus potentiell drei Stellen zusammensetzt, zum Beispiel 21.01.3

Die erste Stelle der Versionsnummer gibt das Jahr an in dem die Version veröffentlicht wurde. Im Jahr 2021 ist das zum Beispiel die 21.

Die zweite Stelle gibt den Monat an, in dem die Version veröffentlicht wurde. Monate werden immer mit zwei Stellen angegeben und im Zweifelsfall mit einer führenden Null aufgefüllt. Im Januar also zum Beispiel die 01.

Die dritte Stelle ist optional und beschreibt das Patchlevel. Sie wird nur angegeben wenn es auch ein Bugfix Release gibt. In dem Beispiel oben ist es die 3.

Neben den stabilen Versionen gibt es auch noch Entwicklungsversionen. Diese haben immer die Versionsnummer des Folgemonats ohne Patchlevel und enden auf -SNAPSHOT. Ausgehend von dem Beispiel oben wäre die nächste Entwicklungsversion die 21.02-SNAPSHOT.

Wie kann ich verwaiste Anchor-Dokumente ohne Bände löschen?

Sollte es einmal durch fehlerhafte Importe vorkommen, dass der Solr Index leere Anchor-Dokumente (das heißt mehrbändige Werke ohne Bände) enthält, können diese auf einen Schlag aus dem Index entfernt werden. Dazu gibt es folgenden Befehl:

cd /opt/digiverso/indexer
java -jar solrIndexer.jar solr_indexerconfig.xml -cleanupGrievingAnchors

Wie kann ich den kompletten Solr Suchindex leeren?

Manchmal kann es während der Entwicklung notwendig sein, den gesamten Solr Suchindex zu leeren. Dafür müssen alle Werke ohne Rückstände aus dem Goobi viewer gelöscht werden. Zum Abschluss steht dann eine Optimierung des Solr-Index an. Auf der Linux Kommandozeile kann diese Aufgabe wie folgt gelöst werden:

cd /opt/digiverso/viewer/indexed_mets/
for i in *.xml; do echo touch ../hotfolder/${i/.xml/.purge}; done
curl "http://localhost:8080/solr/update?optimize=true&waitFlush=false"

Wie kann ich das Access Denied Bild ändern?

Sofern im Goobi viewer die Bildanzeige durch eine Zugriffslizenz verhindert ist, wird ein Stellvertreterbild angezeigt.

Der Pfad zu diesem Bild ist in der messages Datei über den folgenden Key konfiguriert:

noImage_accessDenied

Der Standardeintrag ist wie folgt:

noImage_accessDenied=<img src\=“/viewer/resources/images/access_denied.png” />

Der Key kann in den lokalen messages Dateien überschrieben werden. Dadurch können individuelle Bilder oder Texte angezeigt werden die pro Sprache unterschiedlich sind.

Wie kann ich den Cache für ein Werk leeren?

Der Goobi viewer unterhält separate Caches für die normale Bildanzeige, Thumbnails und PDF-Dateien. Alle Caches basieren auf Ehcache.

Grundsätzlich ist die Anzahl der im jeweiligen Cache maximal enthaltenen Elemente beschränkt, und bei neu hinzugekommenen Bildern werden die ältesten gecacheten Bilder verdrängt. Manchmal kann es jedoch notwendig sein, für einzelne Werke gezielt den Cache zu leeren (wenn sich beispielsweise dessen Bilder geändert haben, jedoch weiterhin die alten Bilder aus dem Cache angezeigt werden).

Hierfür steht im Goobi viewer ein Servlet zur Verfügung, das diese Funktion zur Verfügung stellt. Um ein Werk aus dem Cache zu löschen, muss die folgende URL mit entsprechenden Parametern aufgerufen werden:

https://viewer.example.org/viewer/cache?action=emptyCache&identifier=PPN123&fromContent=true&fromThumbs=true&fromPdfs=false

Parameter

Beschreibung

action

Immer emptyCache

identifier

Der Identifier des Werkes, dessen Bilder aus dem Cache entfernt werden sollen.

fromContent

Falls true, werden die entsprechenden Bilder aus dem Cache für die normale Bildanzeige entfernt. Standardwert ist false.

fromThumbs

Falls true, werden die entsprechenden Bilder aus dem Cache für Thumbnails entfernt. Standardwert ist false.

fromPdfs

Falls true, werden die entsprechenden PDF Dateien aus dem Cache entfernt. Standardwert ist false.

Nach dem Aufruf gibt der Server die Meldung <x> cache elements belonging to 'PPN123' deleted zurück. Dabei steht in <x> die Anzahl der tatsächlich gelöschten Bilder aus dem Cache (Bilder und Thumbnails zusammengenommen). Sind keine Bilder für dieses Werk zum Zeitpunkt des Aufrufs enthalten, ist die Anzahl 0.