Instalación en Windows (Procedimientos Detallados)

Esta página describe los procedimientos de instalación de Fess en entornos Windows. Describe el método de instalación utilizando el paquete ZIP.

Advertencia

No se recomienda ejecutar con OpenSearch integrado en entornos de producción. Asegúrese de construir un servidor OpenSearch externo.

Requisitos Previos

  • Cumplir con los requisitos del sistema descritos en Requisitos del Sistema

  • Java 21 instalado

  • OpenSearch 3.7.0 disponible (o nueva instalación)

  • Variable de entorno JAVA_HOME de Windows configurada apropiadamente

Verificación de la Instalación de Java

Abra el Símbolo del sistema o PowerShell y verifique la versión de Java con el siguiente comando.

En caso de Símbolo del sistema:

C:\> java -version

En caso de PowerShell:

PS C:\> java -version

Verifique que se muestre Java 21 o posterior.

Configuración de Variables de Entorno

  1. Configuración de la variable de entorno JAVA_HOME

    Configure el directorio donde está instalado Java como JAVA_HOME.

    Ejemplo:

    JAVA_HOME=C:\Program Files\Eclipse Adoptium\jdk-21.0.1.12-hotspot
    
  2. Agregar a la variable de entorno PATH

    Agregue %JAVA_HOME%\bin a la variable de entorno PATH.

Truco

Método para configurar variables de entorno:

  1. Abra «Configuración» desde el menú «Inicio»

  2. Haga clic en «Sistema» → «Acerca de» → «Configuración avanzada del sistema»

  3. Haga clic en el botón «Variables de entorno»

  4. Configure en «Variables de entorno del sistema» o «Variables de entorno del usuario»

Paso 1: Instalación de OpenSearch

Descarga de OpenSearch

  1. Descargue el paquete ZIP para Windows desde Download OpenSearch.

  2. Extraiga el archivo ZIP descargado en cualquier directorio.

    Ejemplo:

    C:\opensearch-3.7.0
    

    Nota

    Se recomienda seleccionar un directorio que no contenga caracteres japoneses o espacios en la ruta.

Instalación de Plugins de OpenSearch

Abra el Símbolo del sistema con privilegios de administrador y ejecute los siguientes comandos.

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

Importante

Las versiones de los plugins deben coincidir con la versión de OpenSearch. En el ejemplo anterior, se especifica 3.7.0 para todos.

Configuración de OpenSearch

Abra config\opensearch.yml con un editor de texto y agregue la siguiente configuración.

# Ruta para sincronización de configuración (especificar ruta absoluta)
configsync.config_path: C:/opensearch-3.7.0/data/config/

# Desactivación del plugin de seguridad (solo entorno de desarrollo)
plugins.security.disabled: true

Advertencia

Nota Importante sobre Seguridad

plugins.security.disabled: true debe usarse solo en entornos de desarrollo o prueba. En entornos de producción, habilite el plugin de seguridad de OpenSearch y configure apropiadamente la autenticación y autorización. Para más detalles, consulte Configuración de Seguridad.

Nota

En Windows, use / en lugar de \ como separador de ruta. Escriba C:/opensearch-3.7.0/data/config/ en lugar de C:\opensearch-3.7.0\data\config\.

Truco

Otras configuraciones recomendadas:

cluster.name: fess-cluster
node.name: fess-node-1
network.host: 0.0.0.0
discovery.type: single-node

Truco

El tamaño del heap de OpenSearch se configura con -Xms / -Xmx en config\jvm.options. Se recomienda establecer el mismo valor para -Xms y -Xmx, usando como referencia la mitad o menos de la memoria física disponible, sin superar 32 GB.

Paso 2: Instalación de Fess

Descarga de Fess

  1. Descargue el paquete ZIP para Windows desde el sitio de descargas.

  2. Extraiga el archivo ZIP descargado en cualquier directorio.

    Ejemplo:

    C:\fess-15.7.0
    

    Nota

    Se recomienda seleccionar un directorio que no contenga caracteres japoneses o espacios en la ruta.

Configuración de Fess

Abra bin\fess.in.bat con un editor de texto. Cerca del final de este archivo encontrará una sección de configuración para conectarse a un clúster OpenSearch externo, que ya está preparada en forma de comentario.

Estado antes del cambio (estado predeterminado):

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/

Elimine el REM `` del inicio de las dos líneas inferiores para descommentarlas, y cambie el valor de ``fess.dictionary.path a la ruta de sincronización de configuración de OpenSearch.

Estado después del cambio:

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/

Nota

  • En fess.dictionary.path, establezca la misma ruta que la indicada en configsync.config_path dentro de opensearch.yml de OpenSearch.

  • Si está ejecutando OpenSearch en otro host, cambie el nombre de host o la dirección IP en fess.search_engine.http_address al valor apropiado.

  • Use / como separador de ruta.

  • En lugar de agregar nuevas líneas set FESS_JAVA_OPTS=..., descomente y edite las líneas de comentario existentes. Especificar la misma opción de forma duplicada puede causar comportamientos no deseados.

Truco

Para cambiar el tamaño del heap de Fess, edite FESS_MIN_MEM (predeterminado: 256m) y FESS_MAX_MEM (predeterminado: 1g) en bin\fess.in.bat, o establezca la variable de entorno FESS_HEAP_SIZE.

Verificación de la Instalación

Verifique que los archivos de configuración se hayan editado correctamente.

En el Símbolo del sistema:

C:\> findstr "fess.search_engine.http_address" C:\fess-15.7.0\bin\fess.in.bat
C:\> findstr "fess.dictionary.path" C:\fess-15.7.0\bin\fess.in.bat

Paso 3: Inicio

Para los procedimientos de inicio, consulte Inicio, Detención y Configuración Inicial.

Registro como Servicio de Windows (Opcional)

Al registrar Fess como servicio de Windows, se puede configurar para que se inicie automáticamente al arrancar el sistema.

Fess incluye el script bin\service.bat para registrar el servicio de Windows. Este script utiliza Apache Commons Daemon (procrun), por lo que no es necesario preparar herramientas de terceros como NSSM por separado.

Nota

Antes de ejecutar service.bat, asegúrese de que la variable de entorno JAVA_HOME esté configurada correctamente.

Registro del Servicio de Fess

Abra el Símbolo del sistema con privilegios de administrador y ejecute los siguientes comandos.

  1. Registro del servicio:

    C:\> cd C:\fess-15.7.0
    C:\fess-15.7.0> bin\service.bat install
    

    De forma predeterminada, el servicio se registra con el ID fess-service-x64 en entornos de 64 bits, o fess-service-x86 en entornos de 32 bits. Para especificar el ID del servicio explícitamente, indíquelo como argumento: bin\service.bat install <ID-de-servicio>.

  2. Inicio y detención del servicio:

    C:\fess-15.7.0> bin\service.bat start
    C:\fess-15.7.0> bin\service.bat stop
    
  3. Verificación y modificación de la configuración del servicio (GUI):

    C:\fess-15.7.0> bin\service.bat manager
    
  4. Eliminación del servicio:

    C:\fess-15.7.0> bin\service.bat remove
    

Nota

  • Como service.bat carga internamente bin\fess.in.bat, la configuración de conexión a OpenSearch externo realizada en «Configuración de Fess» también se aplica al servicio.

  • El tipo de inicio predeterminado es «Manual». Para que se inicie automáticamente al arrancar el sistema, establezca la variable de entorno FESS_START_TYPE en auto antes de registrar el servicio, o cambie el tipo de inicio a «Automático» en la herramienta de administración de servicios (services.msc) después del registro.

  • Con service.bat solo se puede registrar el servicio de Fess. Para registrar OpenSearch como servicio, consulte los procedimientos proporcionados por OpenSearch.

Configuración del Cortafuegos

Abra los puertos necesarios en el Firewall de Windows Defender.

  1. Abra «Panel de control» → «Firewall de Windows Defender» → «Configuración avanzada»

  2. Cree una nueva regla en «Reglas de entrada»

    • Tipo de regla: Puerto

    • Protocolo y puerto: TCP, 8080

    • Acción: Permitir conexión

    • Nombre: Fess Web Interface

O ejecute en PowerShell:

PS C:\> New-NetFirewallRule -DisplayName "Fess Web Interface" -Direction Inbound -Protocol TCP -LocalPort 8080 -Action Allow

Solución de Problemas

Conflicto de Números de Puerto

Si los puertos 8080 o 9200 ya están en uso, puede verificarlo con el siguiente comando:

C:\> netstat -ano | findstr :8080
C:\> netstat -ano | findstr :9200

Cambie el número de puerto en uso o detenga el proceso que está en conflicto.

Limitación de Longitud de Ruta

En Windows, existe una limitación en la longitud de la ruta. Se recomienda instalar en una ruta lo más corta posible.

Ejemplo:

C:\opensearch  (recomendado)
C:\Program Files\opensearch-3.7.0  (no recomendado - ruta larga)

Java no Reconocido

Si aparece un error al ejecutar el comando java -version:

  1. Verifique que la variable de entorno JAVA_HOME esté configurada correctamente

  2. Verifique que %JAVA_HOME%\bin esté incluido en la variable de entorno PATH

  3. Reinicie el Símbolo del sistema para reflejar la configuración

Próximos Pasos

Después de completar la instalación, consulte la siguiente documentación:

Preguntas Frecuentes

P: ¿Se recomienda la operación en Windows Server?

R: Sí, la operación en Windows Server es posible. Al operar en Windows Server, regístrelo como servicio de Windows y configure el monitoreo apropiado.

P: ¿Cuál es la diferencia entre las versiones de 64 bits y 32 bits?

R: Fess y OpenSearch solo admiten la versión de 64 bits. No funcionan en Windows de 32 bits.

P: ¿Qué hacer si la ruta contiene japonés?

R: En la medida de lo posible, instale en una ruta que no contenga caracteres japoneses o espacios. Si es absolutamente necesario usar una ruta con japonés, es necesario escapar apropiadamente la ruta en el archivo de configuración.