Installation sur Windows (Procédure détaillée)

Cette page décrit la procédure d’installation de Fess sur un environnement Windows. Elle documente la méthode d’installation à l’aide du package ZIP.

Avertissement

Pour les environnements de production, nous ne recommandons pas l’utilisation d’OpenSearch intégré. Veuillez obligatoirement configurer un serveur OpenSearch externe.

Prérequis

La configuration requise décrite dans Configuration requise doit être satisfaite
Java 21 doit être installé
OpenSearch 3.7.0 doit être disponible (ou nouvelle installation)
La variable d’environnement Windows JAVA_HOME doit être configurée de manière appropriée

Vérification de l’installation de Java

Ouvrez l’invite de commandes ou PowerShell et vérifiez la version de Java avec la commande suivante.

Invite de commandes

PowerShell

Vérifiez que Java 21 ou ultérieur est affiché.

Configuration des variables d’environnement

Configuration de la variable d’environnement JAVA_HOME

Configurez le répertoire d’installation de Java comme JAVA_HOME.

Exemple
```
JAVA_HOME=C:\Program Files\Eclipse Adoptium\jdk-21.0.1.12-hotspot
```
Ajout à la variable d’environnement PATH

Ajoutez %JAVA_HOME%\bin à la variable d’environnement PATH.

Astuce

Méthode de configuration des variables d’environnement :

Ouvrir les « Paramètres » depuis le menu « Démarrer »
Cliquer sur « Système » → « Informations système » → « Paramètres système avancés »
Cliquer sur le bouton « Variables d’environnement »
Configurer dans « Variables système » ou « Variables utilisateur »

Étape 1 : Installation d’OpenSearch

Téléchargement d’OpenSearch

Téléchargez le package ZIP pour Windows depuis Download OpenSearch.
Décompressez le fichier ZIP téléchargé dans un répertoire arbitraire.

Exemple
```
C:\opensearch-3.7.0
```
Note

Nous recommandons de choisir un répertoire dont le chemin ne contient pas de caractères japonais ou d’espaces.

Installation des plugins OpenSearch

Ouvrez l’invite de commandes avec des privilèges d’administrateur et exécutez les commandes suivantes.

C:\> cd C:\opensearch-3.7.0
C:\opensearch-3.7.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:3.7.0
C:\opensearch-3.7.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:3.7.0
C:\opensearch-3.7.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:3.7.0
C:\opensearch-3.7.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:3.7.0

Important

Les versions des plugins doivent correspondre à la version d’OpenSearch. Dans l’exemple ci-dessus, toutes sont spécifiées en 3.7.0.

Configuration d’OpenSearch

Ouvrez config\opensearch.yml avec un éditeur de texte et ajoutez les paramètres suivants.

# Chemin pour la synchronisation de configuration (spécifier en chemin absolu)
configsync.config_path: C:/opensearch-3.7.0/data/config/

# Désactivation du plugin de sécurité (environnement de développement uniquement)
plugins.security.disabled: true

Avertissement

Note importante sur la sécurité

plugins.security.disabled: true ne doit être utilisé que dans les environnements de développement ou de test. Pour les environnements de production, veuillez activer le plugin de sécurité d’OpenSearch et configurer une authentification et une autorisation appropriées. Pour plus de détails, consultez Configuration de la sécurité.

Note

Sous Windows, utilisez / plutôt que \ comme séparateur de chemin. Écrivez C:/opensearch-3.7.0/data/config/ plutôt que C:\opensearch-3.7.0\data\config\.

Astuce

Autres paramètres recommandés

Astuce

La taille du tas mémoire d’OpenSearch se configure via -Xms / -Xmx dans config\jvm.options. Il est recommandé de spécifier la même valeur pour -Xms et -Xmx, inférieure à la moitié de la mémoire physique disponible et inférieure à 32 Go.

Étape 2 : Installation de Fess

Téléchargement de Fess

Téléchargez le package ZIP pour Windows depuis le site de téléchargement.
Décompressez le fichier ZIP téléchargé dans un répertoire arbitraire.

Exemple
```
C:\fess-15.7.0
```
Note

Nous recommandons de choisir un répertoire dont le chemin ne contient pas de caractères japonais ou d’espaces.

Configuration de Fess

Ouvrez bin\fess.in.bat avec un éditeur de texte. Vers la fin de ce fichier, les paramètres de connexion à un cluster OpenSearch externe sont préparés à l’avance sous forme de lignes commentées.

Avant modification (état par défaut)

REM External opensearch cluster
REM set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.search_engine.http_address=http://localhost:9200
REM set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=%SEARCH_ENGINE_HOME%/config/

Supprimez le préfixe REM `` en début des 2 dernières lignes pour décommenter, puis modifiez la valeur de ``fess.dictionary.path avec le chemin de synchronisation de configuration d’OpenSearch.

Après modification

REM External opensearch cluster
set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.search_engine.http_address=http://localhost:9200
set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=C:/opensearch-3.7.0/data/config/

Note

Pour fess.dictionary.path, spécifiez le même chemin que configsync.config_path défini dans le fichier opensearch.yml d’OpenSearch.
Si vous exécutez OpenSearch sur un autre hôte, modifiez le nom d’hôte ou l’adresse IP de fess.search_engine.http_address avec la valeur appropriée.
Utilisez / comme séparateur de chemin.
Ne pas ajouter de nouvelles lignes set FESS_JAVA_OPTS=... ; décommentez et éditez les lignes existantes. La spécification dupliquée d’une même option peut provoquer un comportement inattendu.

Astuce

Pour modifier la taille du tas mémoire de Fess, éditez FESS_MIN_MEM (valeur par défaut : 256m) et FESS_MAX_MEM (valeur par défaut : 1g) dans bin\fess.in.bat, ou définissez la variable d’environnement FESS_HEAP_SIZE.

Vérification de l’installation

Vérifiez que les fichiers de configuration ont été correctement modifiés.

Invite de commandes

Étape 3 : Démarrage

Pour la procédure de démarrage, consultez Démarrage, arrêt et configuration initiale.

Enregistrement en tant que service Windows (optionnel)

En enregistrant Fess en tant que service Windows, vous pouvez le configurer pour qu’il démarre automatiquement au démarrage du système.

Fess est livré avec bin\service.bat pour l’enregistrement en tant que service Windows. Ce script utilise Apache Commons Daemon (procrun), il n’est donc pas nécessaire de prévoir séparément un outil tiers tel que NSSM.

Note

Avant d’exécuter service.bat, vérifiez que la variable d’environnement JAVA_HOME est correctement configurée.

Enregistrement du service Fess

Ouvrez l’invite de commandes avec des privilèges d’administrateur et exécutez les commandes suivantes.

Enregistrement du service
```
C:\> cd C:\fess-15.7.0
C:\fess-15.7.0> bin\service.bat install
```
Par défaut, le service est enregistré avec l’identifiant fess-service-x64 pour les environnements 64 bits et fess-service-x86 pour les environnements 32 bits. Pour spécifier explicitement l’identifiant du service, passez-le en argument : bin\service.bat install <identifiant-du-service>.

Démarrage et arrêt du service

Consultation et modification de la configuration du service (GUI)
```
C:\fess-15.7.0> bin\service.bat manager
```
Suppression du service
```
C:\fess-15.7.0> bin\service.bat remove
```

Note

service.bat charge bin\fess.in.bat en interne, de sorte que les paramètres de connexion à OpenSearch externe définis dans la section « Configuration de Fess » sont également appliqués au service.
Le type de démarrage par défaut est « Manuel ». Pour que le service démarre automatiquement au lancement du système, définissez la variable d’environnement FESS_START_TYPE à auto avant l’enregistrement du service, ou modifiez le type de démarrage en « Automatique » via l’outil de gestion des services (services.msc) après l’enregistrement.
service.bat ne permet d’enregistrer que le service Fess. Pour enregistrer OpenSearch en tant que service, consultez la procédure fournie par OpenSearch.

Configuration du pare-feu

Ouvrez les ports nécessaires dans le Pare-feu Windows Defender.

Ouvrez « Panneau de configuration » → « Pare-feu Windows Defender » → « Paramètres avancés »
Créez une nouvelle règle dans « Règles de trafic entrant »
- Type de règle : Port
- Protocole et port : TCP, 8080
- Action : Autoriser la connexion
- Nom : Fess Web Interface

Ou exécutez dans PowerShell

Dépannage

Conflit de numéros de port

Si les ports 8080 ou 9200 sont déjà utilisés, vous pouvez le vérifier avec la commande suivante

Modifiez le numéro de port utilisé ou arrêtez le processus en conflit.

Limitation de la longueur des chemins

Sous Windows, il existe une limitation de la longueur des chemins. Nous recommandons d’installer dans un chemin aussi court que possible.

Exemple

Java n’est pas reconnu

Si une erreur s’affiche avec la commande java -version :

Vérifiez que la variable d’environnement JAVA_HOME est correctement configurée
Vérifiez que %JAVA_HOME%\bin est inclus dans la variable d’environnement PATH
Redémarrez l’invite de commandes pour appliquer les paramètres

Étapes suivantes

Une fois l’installation terminée, consultez les documents suivants :

Démarrage, arrêt et configuration initiale - Démarrage de Fess et configuration initiale
Configuration de la sécurité - Configuration de la sécurité pour les environnements de production
Dépannage - Dépannage

Questions fréquemment posées

Q : L’exploitation sur Windows Server est-elle recommandée ?

R : Oui, l’exploitation sur Windows Server est possible. Lors de l’exploitation sur Windows Server, enregistrez-le en tant que service Windows et configurez une surveillance appropriée.

Q : Quelle est la différence entre les versions 64 bits et 32 bits ?

R : Fess et OpenSearch ne prennent en charge que la version 64 bits. Ils ne fonctionnent pas sur Windows 32 bits.

Q : Comment gérer les chemins contenant des caractères japonais ?

R : Dans la mesure du possible, veuillez installer dans un chemin ne contenant pas de caractères japonais ou d’espaces. Si vous devez absolument utiliser un chemin japonais, vous devez échapper correctement le chemin dans les fichiers de configuration.