Méthode d’installation
Fess fournit des distributions sous forme d’archives ZIP, de packages RPM/DEB et d’images Docker. En utilisant Docker, vous pouvez facilement configurer Fess sur Windows, Mac, etc.
Note
Cette page explique la configuration sur Windows avec Docker. Les utilisateurs de Linux ou macOS peuvent suivre des étapes similaires, mais l’installation de Docker Desktop varie selon la plateforme. Pour plus de détails, veuillez consulter la documentation de Docker.
Si vous construisez un environnement de production, veuillez absolument consulter Guide d’Installation de Fess. Pour les exigences système, consultez Configuration requise.
Avertissement
Notes importantes pour l’environnement de production
Pour les environnements de production ou les tests de charge, l’utilisation d’OpenSearch intégré n’est pas recommandée. Veuillez obligatoirement construire un serveur OpenSearch externe.
Vue d’ensemble de la configuration
Suivez ces étapes dans l’ordre :
Installer Docker Desktop
Configurer le système d’exploitation (ajuster vm.max_map_count)
Télécharger les fichiers de démarrage Fess
Démarrer Fess et vérifier le fonctionnement
Installation de Docker Desktop
Si Docker Desktop n’est pas installé, veuillez l’installer en suivant la procédure ci-dessous.
Téléchargement
Téléchargez le programme d’installation pour le système d’exploitation correspondant sur Docker Desktop.
Exécution du programme d’installation
Double-cliquez sur le programme d’installation téléchargé pour démarrer l’installation.
Vérifiez que «Install required Windows components for WSL 2» ou «Install required Enable Hyper-V Windows Features» est sélectionné, puis cliquez sur le bouton OK.
Une fois l’installation terminée, cliquez sur le bouton «close» pour fermer l’écran.
Démarrage de Docker Desktop
Cliquez sur «Docker Desktop» dans le menu Windows pour le démarrer.
Après le démarrage de Docker Desktop, les conditions d’utilisation s’affichent. Cochez «I accept the terms» et cliquez sur le bouton «Accept».
Un message vous invite à commencer le tutoriel, mais cliquez ici sur «Skip tutorial» pour le passer. Après avoir cliqué sur «Skip tutorial», le tableau de bord s’affiche.
Configuration
Pour permettre à OpenSearch de s’exécuter en tant que conteneur Docker, ajustez la valeur de «vm.max_map_count» du côté du système d’exploitation. La méthode de configuration varie selon l’environnement utilisé. Pour chaque méthode de configuration, veuillez consulter «Set vm.max_map_count to at least 262144».
Configuration de Fess
Création du fichier de démarrage
Créez un dossier approprié et téléchargez compose.yaml et compose-opensearch3.yaml.
Note
compose-opensearch3.yaml est un fichier de configuration supplémentaire pour utiliser OpenSearch 3.x. Il est utilisé en combinaison avec compose.yaml.
Vous pouvez également les obtenir avec la commande curl comme suit :
Démarrage de Fess
Démarrez Fess avec la commande docker compose.
Ouvrez l’invite de commandes, déplacez-vous vers le dossier contenant le fichier compose.yaml et exécutez la commande suivante :
Note
Le démarrage peut prendre plusieurs minutes. Vous pouvez vérifier les journaux avec la commande suivante :
Appuyez sur Ctrl+C pour quitter l’affichage des journaux.
Vérification du fonctionnement
Note
Une fois le démarrage terminé, accédez aux URL suivantes dans votre navigateur pour vérifier :
Recherche : http://localhost:8080/
Interface d’administration : http://localhost:8080/admin/
Le nom d’utilisateur/mot de passe par défaut du compte administrateur est admin/admin.
Avertissement
Note importante concernant la sécurité
Veuillez obligatoirement modifier le mot de passe par défaut. En particulier en environnement de production, il est fortement recommandé de changer le mot de passe immédiatement après la première connexion.
Le compte administrateur est géré par le serveur d’applications. L’interface d’administration de Fess considère comme administrateur un utilisateur authentifié avec le rôle fess sur le serveur d’applications.
Autres
Arrêt de Fess
Pour arrêter Fess, exécutez la commande suivante dans le dossier où Fess a été démarré :
Pour arrêter et supprimer les conteneurs :
Avertissement
Si vous souhaitez également supprimer les volumes avec la commande down, ajoutez l’option -v. Dans ce cas, toutes les données seront supprimées, soyez donc prudent.
Modification du mot de passe administrateur
Vous pouvez modifier le mot de passe dans l’écran d’édition des utilisateurs de l’interface d’administration.
Accédez à http://localhost:8080/admin/ et connectez-vous.
Sélectionnez «Utilisateur» dans le menu en haut à droite.
Ouvrez la page d’édition de l’utilisateur admin et modifiez le mot de passe.
Prochaines étapes
Une fois Fess configuré, consultez la documentation suivante pour aller plus loin :
Démarrage, arrêt et configuration initiale — Démarrage, arrêt et configuration détaillée
Guide de l’administrateur Fess — Guide administrateur (paramètres de crawl, gestion des utilisateurs, etc.)
Guide utilisateur Fess — Guide utilisateur (comment effectuer des recherches)
En cas de problème, consultez Dépannage.