Installationsanleitung
Installationsmethode
Fess bietet Distributionen als ZIP-Archive, RPM/DEB-Pakete und Docker-Images an. Mit Docker können Sie Fess auf Windows, Mac und anderen Systemen einfach einrichten.
Wenn Sie eine Produktionsumgebung aufbauen, lesen Sie bitte unbedingt Fess Installationsanleitung.
Warnung
Wichtige Hinweise für die Produktionsumgebung
In Produktionsumgebungen oder bei Lasttests wird der Betrieb mit eingebettetem OpenSearch nicht empfohlen. Richten Sie unbedingt einen externen OpenSearch-Server ein.
Installation von Docker Desktop
Diese Anleitung erklärt die Verwendung unter Windows. Wenn Docker Desktop nicht installiert ist, folgen Sie bitte den folgenden Schritten zur Installation.
Es gibt Unterschiede in den herunterzuladenden Dateien und Verfahren je nach Betriebssystem, daher müssen Sie entsprechend Ihrer Umgebung vorgehen. Weitere Details finden Sie in der Docker-Dokumentation.
Download
Laden Sie das Installationsprogramm für Ihr Betriebssystem von Docker Desktop herunter.
Ausführen des Installationsprogramms
Doppelklicken Sie auf das heruntergeladene Installationsprogramm, um die Installation zu starten.
Vergewissern Sie sich, dass „Install required Windows components for WSL 2“ oder „Install required Enable Hyper-V Windows Features“ ausgewählt ist, und klicken Sie auf OK.
Wenn die Installation abgeschlossen ist, klicken Sie auf die Schaltfläche „close“, um das Fenster zu schließen.
Starten von Docker Desktop
Klicken Sie im Windows-Menü auf „Docker Desktop“, um es zu starten.
Nach dem Start von Docker Desktop werden die Nutzungsbedingungen angezeigt. Aktivieren Sie „I accept the terms“ und klicken Sie auf „Accept“.
Es erscheint eine Aufforderung zum Start des Tutorials, aber hier klicken wir auf „Skip tutorial“, um es zu überspringen. Wenn Sie auf „Skip tutorial“ klicken, wird das Dashboard angezeigt.
Konfiguration
Damit OpenSearch als Docker-Container ausgeführt werden kann, passen Sie den Wert von „vm.max_map_count“ auf der Betriebssystemseite an. Die Konfigurationsmethode variiert je nach verwendeter Umgebung. Informationen zu den jeweiligen Konfigurationsmethoden finden Sie unter „Set vm.max_map_count to at least 262144“.
Einrichten von Fess
Erstellen der Startdatei
Erstellen Sie einen geeigneten Ordner und laden Sie compose.yaml und compose-opensearch3.yaml herunter.
Sie können sie auch mit dem curl-Befehl wie folgt abrufen:
curl -o compose.yaml https://raw.githubusercontent.com/codelibs/docker-fess/master/compose/compose.yaml
curl -o compose-opensearch3.yaml https://raw.githubusercontent.com/codelibs/docker-fess/master/compose/compose-opensearch3.yaml
Starten von Fess
Starten Sie Fess mit dem docker compose-Befehl.
Öffnen Sie die Eingabeaufforderung, navigieren Sie zu dem Ordner, in dem sich die Datei compose.yaml befindet, und führen Sie den folgenden Befehl aus:
docker compose -f compose.yaml -f compose-opensearch3.yaml up -d
Bemerkung
Der Start kann einige Minuten dauern. Sie können die Logs mit folgendem Befehl überprüfen:
docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f
Mit Ctrl+C können Sie die Protokollanzeige beenden.
Funktionsüberprüfung
Sie können den Start überprüfen, indem Sie auf http://localhost:8080/ zugreifen.
Die Verwaltungs-UI ist unter http://localhost:8080/admin/ verfügbar. Der Standard-Benutzername/das Passwort für das Administratorkonto ist admin/admin.
Warnung
Wichtiger Sicherheitshinweis
Ändern Sie unbedingt das Standardpasswort. Besonders in Produktionsumgebungen wird dringend empfohlen, das Passwort sofort nach der ersten Anmeldung zu ändern.
Das Administratorkonto wird vom Anwendungsserver verwaltet. Die Verwaltungs-UI von Fess betrachtet Benutzer als Administratoren, die vom Anwendungsserver mit der fess-Rolle authentifiziert wurden.
Sonstiges
Stoppen von Fess
Um Fess zu stoppen, führen Sie den folgenden Befehl im Ordner aus, in dem Sie Fess gestartet haben:
docker compose -f compose.yaml -f compose-opensearch3.yaml stop
Um Container zu stoppen und zu entfernen:
docker compose -f compose.yaml -f compose-opensearch3.yaml down
Warnung
Um auch Volumes mit dem down-Befehl zu entfernen, fügen Sie die Option -v hinzu. In diesem Fall werden alle Daten gelöscht, seien Sie also vorsichtig:
docker compose -f compose.yaml -f compose-opensearch3.yaml down -v
Ändern des Administrator-Passworts
Sie können es im Benutzerbearbeitungsbildschirm der Verwaltungs-UI ändern.