bin/fess-setup (unter Windows bin\fess-setup.bat) liegt dem ZIP-Paket von Fess bei. Es installiert, was Fess benötigt, aber nicht mitliefert: OpenSearch mit den von Fess benötigten Plugins, Node.js für die Playwright-Plugins, Fess-Plugins und statische Themes. Außerdem prüft es eine Installation.
Führen Sie es im Fess-Verzeichnis aus. Ohne Argumente gibt es die Liste der Befehle aus.
Exit-Codes
| Code | Bedeutung |
|---|---|
0 | Der Befehl war erfolgreich. |
1 | Der Befehl ist fehlgeschlagen: zum Beispiel ist ein Download fehlgeschlagen, die angeforderte Version existiert nicht, OpenSearch veröffentlicht für diese Plattform keinen Build, oder |
2 | Die Befehlszeile ist fehlerhaft: ein unbekannter Befehl oder ein fehlendes Argument wie ein Plugin-Name. |
Installation von OpenSearch und Node.js
install opensearch
Lädt die von diesem Fess unterstützte OpenSearch-Version nach opensearch/ im Fess-Verzeichnis herunter, installiert die vier von Fess benötigten Plugins (opensearch-analysis-fess, opensearch-analysis-extension, opensearch-minhash und opensearch-configsync) und fügt der config/opensearch.yml dieser Installation die folgenden Einstellungen hinzu:
configsync.config_path, gesetzt auf das Verzeichnisconfig/dictionarydieses OpenSearchplugins.security.disabled: true
Außerdem entfernt der Befehl die mitgelieferten Plugins opensearch-security-analytics und opensearch-performance-analyzer, die Fess nicht verwendet; auch das OpenSearch im Docker-Image enthält sie nicht. Ein Plugin, das im Download nicht enthalten ist, wird übersprungen.
Eine Einstellung, die opensearch.yml bereits enthält, wird nicht erneut hinzugefügt, und plugins.security.disabled: true wird nicht hinzugefügt, wenn die Datei irgendeine plugins.security.*-Einstellung enthält. Existiert das OpenSearch-Verzeichnis bereits, wird der Download übersprungen; ein erneuter Aufruf für eine vorhandene Installation fügt daher nur die fehlenden Einstellungen hinzu.
Der Befehl gibt jede hinzugefügte Einstellung aus und anschließend, ob bin/fess.in.sh dieses OpenSearch selbst findet. Das ist der Fall, wenn es das einzige OpenSearch mit einem Verzeichnis config/dictionary unter opensearch/ im Fess-Verzeichnis ist: bin/fess.in.sh (unter Windows bin\fess.in.bat) setzt dann FESS_DICTIONARY_PATH auf dieses Verzeichnis, und für ein OpenSearch auf demselben Host ist nichts weiter zu konfigurieren. Andernfalls gibt der Befehl die Werte für SEARCH_ENGINE_HTTP_URL und FESS_DICTIONARY_PATH aus, die zu setzen sind, wie in Installation unter Linux (Detaillierte Anleitung) oder Installation unter Windows (Detaillierte Anleitung) beschrieben.
| Option | Beschreibung |
|---|---|
--dest <dir> | Das Verzeichnis, in das OpenSearch entpackt wird, anstelle von |
--version <version> | Die zu installierende OpenSearch-Version. Die Plugins werden in derselben Version installiert. |
--keep-bundled-plugins | Behält die mitgelieferten Plugins (opensearch-security-analytics und opensearch-performance-analyzer), statt sie zu entfernen, und lässt den Download unverändert. |
OpenSearch veröffentlicht offizielle Builds nur für Linux und Windows. Auf anderen Plattformen wie macOS beendet sich der Befehl vor jedem Download mit dem Exit-Code 1 und schlägt vor, OpenSearch mit Homebrew zu installieren und die Plugins mit install opensearch-plugins hinzuzufügen oder Docker zu verwenden.
Warnung
Mit plugins.security.disabled: true nimmt OpenSearch Anfragen ohne Authentifizierung an. OpenSearch lauscht nur auf der Loopback-Adresse, sofern network.host nicht gesetzt ist. Bevor es auf einer anderen Adresse lauscht, konfigurieren Sie stattdessen das Sicherheits-Plugin; siehe Sicherheitseinstellungen.
install opensearch-plugins
Installiert die vier von Fess benötigten Plugins in ein bereits vorhandenes OpenSearch, anstatt dessen bin/opensearch-plugin install viermal auszuführen. --opensearch-home ist das Installationsverzeichnis von OpenSearch und muss angegeben werden. --version legt die Plugin-Version fest, die mit der OpenSearch-Version übereinstimmen muss.
Dieser Befehl ändert opensearch.yml nicht. Fügen Sie configsync.config_path und die übrigen Einstellungen selbst hinzu, wie in Installation unter Linux (Detaillierte Anleitung) oder Installation unter Windows (Detaillierte Anleitung) beschrieben.
install nodejs
Lädt Node.js, das die Playwright-Plugins benötigen (fess-crawler-playwright für den Playwright-Crawler und fess-thumbnail-playwright für Thumbnails), nach nodejs/ im Fess-Verzeichnis herunter. bin/fess.in.sh (unter Windows bin\fess.in.bat) findet es dort und setzt PLAYWRIGHT_NODEJS_PATH. Liegt das mit --dest angegebene Verzeichnis außerhalb des Fess-Verzeichnisses, gibt der Befehl stattdessen die PLAYWRIGHT_NODEJS_PATH-Zeile aus, die in bin/fess.in.sh einzutragen ist. --version wählt eine andere Node.js-Version. Zum Playwright-Crawler siehe Erweiterte Crawler-Konfiguration.
Verwaltung von Plugins
Diese Befehle arbeiten mit dem Plugin-Verzeichnis app/WEB-INF/plugin der Fess-Installation. Starten Sie Fess neu, nachdem Sie Plugins installiert, aktualisiert oder entfernt haben. Plugins lassen sich auch über die Seite System > Plugin in der Administrationsoberfläche verwalten; siehe Plug-ins.
install plugin, list plugins, list installed, upgrade plugins, remove plugin und check akzeptieren --dest <dir>. Damit wird das Plugin-Verzeichnis angegeben, das anstelle von app/WEB-INF/plugin verwendet wird: das Verzeichnis, das die Plugin-JARs selbst enthält, nicht dessen übergeordnetes Verzeichnis. Ein relativer Pfad wird ab dem aktuellen Verzeichnis aufgelöst, nicht ab dem Fess-Verzeichnis. Bei install opensearch und install nodejs ist --dest dagegen das Verzeichnis, in das das Archiv entpackt wird.
install plugin, list plugins und upgrade plugins akzeptieren --repository <url>. Damit werden die Versionsliste, die JARs und ihre Prüfsummen aus diesem einen Maven-Repository bezogen, etwa einem internen Mirror, statt aus den standardmäßigen Release- und Snapshot-Repositories und von GitHub.
--repository akzeptiert auch eine URL, die mit file:/// beginnt. Legen Sie auf einem Server ohne Internetzugang eine Kopie des Maven-Repositorys ab und geben Sie dieses Verzeichnis an. Anzugeben ist das Verzeichnis, das die Verzeichnisse der einzelnen Plugins enthält (<name>/maven-metadata.xml usw.), also die Stelle, die https://maven.codelibs.org/release/org/codelibs/fess/ des Standard-Repositorys entspricht. Versionen werden wie bei einem HTTP-Repository aufgelöst und Prüfsummen ebenso geprüft.
Ein anderes Schema als http, https und file oder eine URL ohne Schema wird mit einer einzeiligen Fehlermeldung abgelehnt.
install plugin
Installiert ein oder mehrere Fess-Plugins, zum Beispiel fess-script-groovy oder fess-ds-git. Ein Name ohne Version installiert die neueste für dieses Fess gebaute Version. <name>:<version> legt die Version dieses Plugins fest, und --version gilt für alle Namen ohne eigene Version. Die zuvor installierte Version eines Plugins wird gelöscht, nachdem die neue installiert wurde.
Ein JAR wird aus dem GitHub-Release des Plugins bezogen oder aus dem Maven-Repository, wenn das Release keine solche Datei enthält, und wird gegen die SHA-1-Prüfsumme geprüft, die das Maven-Repository veröffentlicht. Ein Entwicklungs-Build von Fess installiert auch die Snapshot-Builds seiner eigenen Versionslinie und bevorzugt diese.
Beispiele finden Sie unter Plug-ins.
Installiert werden können nur die Plugin-Typen, die Fess lädt: Namen, die mit fess-ds-, fess-ingest-, fess-script-, fess-webapp-, fess-thumbnail-, fess-crawler-, fess-llm-, fess-storage- oder fess-sso- beginnen, also dieselben, die list plugins anzeigt. Jeder andere Name (fess-theme-* oder eine Bibliothek wie fess oder fess-crawler) wird vor jedem Download mit einer einzeiligen Fehlermeldung und Exit-Code 2 abgelehnt. Wird einer von mehreren Namen abgelehnt, wird keiner installiert. Ein statisches Theme installieren Sie mit install theme.
list plugins
Listet die für dieses Fess veröffentlichten Plugins auf und kennzeichnet die installierten mit (installed: <version>). Plugins, die installiert, aber nicht im Repository veröffentlicht sind, etwa ein lokal gebautes JAR, werden gesondert aufgeführt. Ein Entwicklungs-Build von Fess berücksichtigt zusätzlich das Snapshot-Repository.
list installed
Listet die installierten Plugins und ihre Versionen auf, ohne das Repository abzufragen.
upgrade plugins
Installiert jedes installierte Plugin in der Version neu, die zu diesem Fess passt. Ein Plugin, das bereits diese Version hat, bleibt unverändert. Die Plugins in app/WEB-INF/plugin sind für ein bestimmtes Fess-Release gebaut; führen Sie diesen Befehl daher nach einem Upgrade von Fess aus.
remove plugin
Löscht die installierten JARs der angegebenen Plugins. Ein Name, der nicht installiert ist, wird gemeldet und ändert den Exit-Code nicht.
Umgebungen ohne Internetzugang
install plugin, list plugins und upgrade plugins beziehen Plugins aus Repositorys im Internet. Auch die Installationsseite unter System > Plugin in der Administrationsoberfläche bezieht die Liste der installierbaren Plugins aus den Repositorys (plugin.repositories) und kann sie daher ohne Zugang nach außen nicht anzeigen.
Bringen Sie in einer solchen Umgebung die JARs der Plugins selbst mit:
Laden Sie in einer Umgebung mit Internetzugang das Fess-ZIP-Paket und die JARs der benötigten Plugins herunter. Ein JAR erhalten Sie unter
https://maven.codelibs.org/release/org/codelibs/fess/<name>/<version>/<name>-<version>.jar. Wählen Sie die Version für dieses Fess (15.9.x für Fess 15.9).Entpacken Sie in der Zielumgebung das ZIP und legen Sie die JARs in
app/WEB-INF/plugin/ab. Nach dem Start von Fess können Sie sie auch auf der Registerkarte „Lokal“ der Plugin-Installationsseite in der Administrationsoberfläche hochladen; siehe Plug-ins.Starten Sie Fess. Wenn Sie die JARs während des Betriebs abgelegt haben, starten Sie es neu.
Statt jedes JAR einzeln mitzubringen, können Sie auch den benötigten Teil des Maven-Repositorys (die Verzeichnisse org/codelibs/fess/<name>/) auf den Server kopieren und mit install plugin und --repository file:///... installieren. Auch dabei werden die Prüfsummen geprüft.
Themes verwalten
Diese Befehle arbeiten auf dem Theme-Verzeichnis app/themes der Fess-Installation. Starten Sie Fess nach dem Installieren oder Entfernen eines Themes neu, oder klicken Sie auf der Seite System > Theme auf [Neu laden]. Themes lassen sich auch dort hochladen; siehe Theme.
install theme, list themes und remove theme akzeptieren --dest <dir> auf dieselbe Weise und geben das Theme-Verzeichnis an, das anstelle von app/themes verwendet wird.
Die Version eines Themes benennt die Fess-Linie, für die es gebaut ist: 15.9.0 ist ein Theme für Fess 15.9. Ein Name ohne Version wird deshalb zu dem Theme aufgelöst, das für dieses Fess gebaut wurde – genau wie bei einem Plugin.
install theme
Installiert ein oder mehrere statische Themes, zum Beispiel docuforge oder voicebox. Ein Name ohne Version installiert die neueste für dieses Fess gebaute Version. <name>:<version> legt die Version dieses Themes fest, und --version gilt für jeden Namen, der keine eigene hat.
Das Archiv wird gegen die SHA-1-Prüfsumme geprüft, die das Maven-Repository veröffentlicht, und nach app/themes/<name> entpackt. Ein unter diesem Namen bereits installiertes Theme wird ebenso lange als Sicherung aufbewahrt wie eines, das über die Administrationsoberfläche ersetzt wurde (Standard 7 Tage, theme.upload.attic.retention.days).
Herunterladen, Entpacken und die Prüfung des Manifests geschehen alle, bevor etwas Installiertes angefasst wird: Ein bereits vorhandenes Theme übersteht eine fehlgeschlagene Installation unverändert. Ein Archiv, dessen theme.yml ein anderes Theme nennt, wird abgelehnt.
list themes
Listet die für dieses Fess veröffentlichten Themes auf und kennzeichnet die installierten mit (installed: <version>). Themes, die installiert sind, aber nicht im Repository gelistet werden, erscheinen getrennt.
Die Liste stammt aus dem Verzeichnisindex des Repositorys, der periodisch erzeugt wird. Lässt er sich nicht lesen, nennt der Befehl die versuchte URL und listet die installierten Themes trotzdem auf: Ein Theme lässt sich über seinen Namen installieren, ob der Index es führt oder nicht.
remove theme
Löscht die genannten Themes aus app/themes und bewahrt jedes für die Aufbewahrungsfrist als Sicherung auf. Ein nicht installierter Name wird gemeldet und ändert den Exit-Code nicht.
War ein entferntes Theme das Standard-Theme, fällt Fess auf das mitgelieferte bootstrap-Theme zurück, bis ein anderes gewählt wird.
Prüfen einer Installation
list
Zeigt die Komponenten, die install herunterlädt, opensearch und nodejs, jeweils mit ihrer Version.
check
Prüft die Installation und gibt je Prüfung eine Zeile aus, gekennzeichnet mit OK, WARN oder FAIL:
Die Suchmaschine: ob sie erreichbar ist, ihre Version (eine Warnung, wenn die Knoten unterschiedliche Versionen melden), ob die vier von Fess benötigten Plugins darin installiert sind und ob
configsyncantwortet.Fess: ob das Plugin-Verzeichnis existiert und beschreibbar ist, jedes installierte Plugin (ein Fehler für ein Plugin, das für ein anderes Fess-Release gebaut wurde, und für ein Plugin, das in zwei Versionen installiert ist) und ob Node.js in
nodejs/im Fess-Verzeichnis installiert ist.
Die URL der Suchmaschine ist --url, andernfalls die Umgebungsvariable SEARCH_ENGINE_HTTP_URL, andernfalls http://localhost:9200. bin/fess-setup liest bin/fess.in.sh nicht; geben Sie daher --url an, wenn OpenSearch woanders läuft. Ein fehlendes Node.js wird nur gemeldet, es sei denn, --playwright ist angegeben; dann gilt es als Fehler.
Der Befehl endet mit dem Exit-Code 0, wenn keine Prüfung fehlgeschlagen ist, auch wenn einige Prüfungen Warnungen ausgegeben haben, und andernfalls mit dem Exit-Code 1.