Skip to content

Latest commit

 

History

History
159 lines (98 loc) · 7.62 KB

README.md

File metadata and controls

159 lines (98 loc) · 7.62 KB

Fess: Enterprise-Suchserver

Java CI with Maven Maven Central License

Übersicht

Fess ist ein sehr leistungsstarker und einfach zu implementierender Enterprise-Suchserver. Sie können Fess schnell auf jeder Plattform installieren und ausführen, auf der die Java-Laufzeitumgebung (JRE) läuft. Fess wird unter der Apache-Lizenz 2.0 bereitgestellt.

Fess basiert auf OpenSearch, aber es ist kein Wissen oder Erfahrung mit OpenSearch erforderlich. Fess bietet eine einfach zu bedienende Administrations-GUI zur Konfiguration des Systems über Ihren Browser. Fess enthält auch einen Crawler, der Dokumente auf einem Webserver, Dateisystem oder Datenspeicher (wie CSV oder Datenbank) durchsuchen kann. Viele Dateiformate werden unterstützt, einschließlich (aber nicht beschränkt auf): Microsoft Office, PDF und zip.

Fess Site Search ist eine kostenlose Alternative zur Google Site Search. Weitere Details finden Sie in der Dokumentation des FSS JS Generators.

Website

fess.codelibs.org

Probleme/Fragen

discuss.codelibs.org

Erste Schritte

Es gibt zwei Möglichkeiten, Fess auszuprobieren. Die erste besteht darin, es selbst herunterzuladen und zu installieren. Die zweite besteht darin, Docker zu verwenden.

Herunterladen und Installieren/Ausführen

Fess 14.17 ist jetzt verfügbar und kann auf der Release-Seite heruntergeladen werden. Downloads gibt es in drei Formaten: deb, rpm, zip.

Die folgenden Befehle zeigen, wie der Zip-Download verwendet wird:

$ unzip fess-14.17.x.zip
$ cd fess-14.17.x
$ ./bin/fess

Weitere Informationen finden Sie im Installationshandbuch.

Docker

Wir bieten Docker-Images auf ghcr.io an. Wir stellen auch eine Docker Compose (YAML)-Datei in diesem Repository bereit.

Browser-Benutzeroberfläche

Suchoberfläche

Administrationsoberfläche

Sie können in der Administrationsoberfläche (Web, Datei, Datenspeicher) Crawling-Ziele in den Crawler-Konfigurationsseiten registrieren und den Crawler manuell auf der Scheduler-Seite starten.

Migration von einem anderen Suchanbieter

Bitte lesen Sie MIGRATION.md.

Datenspeicher

Derzeit unterstützt Fess das Crawlen der folgenden Speicherorte und APIs:

Themen

Ingest

Skript

Entwicklungsinformationen

Quellcode abrufen

  1. Klonen Sie das Fess-Repository:

    $ cd ~/workspace
    $ git clone https://github.com/codelibs/fess.git
    
  2. Importieren Sie das geklonte Repository als ein Maven Projekt in Eclipse oder einer anderen IDE.

Einrichten von OpenSearch-Plugins

Führen Sie antrun:run aus, um Plugins in das Plugins-Verzeichnis herunterzuladen:

$ mvn antrun:run

Fess ausführen

Führen Sie org.codelibs.fess.FessBoot in Ihrer IDE aus oder debuggen Sie es und greifen Sie dann auf http://localhost:8080/ zu.

Paket erstellen

Führen Sie das package-Ziel aus, und dann wird die Release-Datei im Verzeichnis target/releases erstellt.

$ mvn package
$ mvn rpm:rpm   # .rpm-Paket
$ mvn jdeb:jdeb # .deb-Paket

Quellcode generieren

$ mvn dbflute:download # (einmaliger Befehl)
$ mvn dbflute:freegen
$ mvn license:format

Integrationstests

Starten Sie den Fess-Server und führen Sie den folgenden Befehl aus:

$ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201"

Um einen einzelnen Testfall auszuführen, können Sie verwenden:

$ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests

In Ihre Sprache übersetzen

Fess ist eine internationalisierte Software.

Wenn Sie Labels/Nachrichten für Ihre Sprache hinzufügen möchten, übersetzen Sie bitte die Eigenschaftendatei und benennen Sie sie in fess_*_[lang].properties um.

Für den Such-/Index-Analyser: Wenn doc.json lang_[lang] für Ihre Sprache enthält, passen Sie bitte den Analyser für Ihre Sprache an. Weitere Informationen zu Analysatoren finden Sie in der OpenSearch-Dokumentation.

Wir begrüßen Pull-Requests für Ihre Sprache.

Unterstützt von