Skip to content

README.md

Latest commit

 

History

History
193 lines (119 loc) · 8.58 KB

README.md

File metadata and controls

193 lines (119 loc) · 8.58 KB
Raw

Fess : Serveur de recherche pour entreprises

Java CI with Maven License GitHub Release

Vue d'ensemble

Fess est un serveur de recherche très puissant et facilement déployable pour les entreprises. Vous pouvez rapidement installer et exécuter Fess sur toute plateforme où vous pouvez exécuter l'environnement d'exécution Java. Fess est fourni sous la licence Apache License 2.0.

Fess est basé sur OpenSearch, mais aucune connaissance ni expérience d'OpenSearch n'est nécessaire. Fess fournit une interface d'administration facile à utiliser pour configurer le système via votre navigateur. Fess comprend également un Crawler, capable d'explorer les documents sur un serveur web, un système de fichiers, ou un Data Store (comme un fichier CSV ou une base de données). De nombreux formats de fichiers sont pris en charge, y compris (mais sans s'y limiter) : Microsoft Office, PDF, et zip.

Fess Site Search est une alternative gratuite à Google Site Search. Pour plus de détails, consultez la documentation FSS JS Generator.

Site Web

fess.codelibs.org

Problèmes/Questions

discuss.codelibs.org

Démarrage rapide

Il existe 2 manières d'essayer Fess. La première est de le télécharger et l'installer vous-même. La seconde est d'utiliser Docker.

Télécharger et Installer/Exécuter

Fess 15.6 est désormais disponible et peut être téléchargé sur la page de Releases. Les téléchargements sont disponibles en 3 formats : deb, rpm, zip.

Les commandes suivantes montrent comment utiliser le téléchargement zip :

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

Pour plus de détails, consultez le guide d'installation.

Docker

Nous fournissons des images Docker sur ghcr.io. Nous fournissons également un fichier Docker Compose (YAML) dans ce dépôt.

Interface Web

Search UI

Admin UI

Vous pouvez enregistrer des cibles à explorer dans l'interface d'administration sur les pages de configuration des crawlers (Web, Fichiers, Data Store), puis démarrer manuellement le Crawler sur la page du Planificateur.

Migration depuis un autre fournisseur de recherche

Veuillez consulter MIGRATION.md.

Data Store

Actuellement, Fess prend en charge le parcours des emplacements de stockage et API suivants :

Thèmes

Ingest

Scripts

Informations de Développement

Récupérer le Code Source

  1. Clonez le dépôt Fess :

    $ cd ~/workspace
$ git clone https://github.com/codelibs/fess.git

  2. Importez le dépôt cloné en tant que projet Maven sur Eclipse ou un autre IDE.

Configuration pour les Plugins OpenSearch

Exécutez antrun:run pour télécharger les plugins dans le répertoire plugins :

$ mvn antrun:run

Exécuter Fess

Exécutez ou déboguez org.codelibs.fess.FessBoot dans votre IDE, puis accédez à http://localhost:8080/

Créer un Package

Exécutez la commande package et le fichier de release sera créé dans target/releases.

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

Générer le Code Source

$ mvn dbflute:download # (commande unique)
$ mvn dbflute:freegen
$ mvn license:format

Tests d'Intégration

Les tests d'intégration nécessitent un serveur Fess en cours d'exécution avec OpenSearch. Suivez ces étapes :

1. Compiler Fess

$ mvn antrun:run  # Télécharger les plugins OpenSearch (si ce n'est pas déjà fait)
$ mvn package     # Compiler le paquet

2. Démarrer le Serveur Fess

$ unzip target/releases/fess-*.zip
$ ./fess-*/bin/fess &

Attendez que Fess soit prêt (cela peut prendre jusqu'à 60 secondes) :

$ curl -s "http://localhost:8080/api/v1/health"

Vous devriez voir une réponse JSON lorsque Fess est prêt.

3. Cloner les Données de Test

Requis pour SearchApiTests :

$ git clone https://github.com/codelibs/fess-testdata.git /tmp/fess-testdata

4. Exécuter les Tests d'Intégration

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

Pour exécuter un seul cas de test :

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

Traduire dans Votre Langue

Fess est un logiciel internationalisé.

Si vous souhaitez ajouter des libellés/messages pour votre langue, veuillez traduire le fichier de propriétés et le renommer en fess_*_[lang].properties.

Pour l'analyseur de recherche/index, si doc.json contient lang_[lang] pour votre langue, veuillez modifier l'analyseur pour votre langue. Pour plus de détails sur les analyseurs, consultez la documentation OpenSearch.

Nous accueillons les pull requests pour votre langue.

Traductions

Alimenté par