Inicio, Detención y Configuración Inicial

Esta página describe los procedimientos de inicio, detención y configuración inicial del servidor Fess.

Importante

Antes de iniciar Fess, asegúrese de iniciar OpenSearch. Si OpenSearch no está en ejecución, Fess no funcionará correctamente.

Métodos de Inicio

Los procedimientos de inicio varían según el método de instalación.

En Caso de Versión ZIP

Inicio de OpenSearch

$ cd /path/to/opensearch-3.9.0
$ ./bin/opensearch

Para iniciar en segundo plano:

$ ./bin/opensearch -d

Nota

bin/fess-setup install opensearch coloca OpenSearch en opensearch/opensearch-3.9.0 dentro del directorio de Fess.

Importante

Inicie OpenSearch con un usuario normal. Se niega a ejecutarse como root y termina con can not run opensearch as root. Aun así, el inicio rechazado deja archivos como config/opensearch.keystore con root como propietario, y el siguiente inicio con un usuario normal falla con AccessDeniedException. Devuelva el directorio de OpenSearch a ese usuario antes de volver a iniciarlo, por ejemplo:

$ sudo chown -R <user> /path/to/opensearch-3.9.0

Inicio de Fess

$ cd /path/to/fess-15.9.0
$ ./bin/fess

Para iniciar en segundo plano:

$ ./bin/fess -d

Nota

El inicio puede tardar varios minutos. Puede verificar el estado de inicio en los archivos de registro del directorio logs/: fess.log contiene los mensajes de Fess y server_0.log los del Tomcat integrado (incluido el mensaje de finalización del inicio).

En Caso de Versión ZIP (Windows)

Inicio de OpenSearch

1. Abra el directorio de instalación de OpenSearch

2. Haga doble clic en opensearch.bat dentro de la carpeta bin

O desde el Símbolo del sistema:

C:\> cd C:\opensearch-3.9.0
C:\opensearch-3.9.0> bin\opensearch.bat

Inicio de Fess

1. Abra el directorio de instalación de Fess

2. Haga doble clic en fess.bat dentro de la carpeta bin

O desde el Símbolo del sistema:

C:\> cd C:\fess-15.9.0
C:\fess-15.9.0> bin\fess.bat

En Caso de Versión RPM/DEB (chkconfig)

Inicio de OpenSearch:

$ sudo service opensearch start

Inicio de Fess:

$ sudo service fess start

Verificación del estado de inicio:

$ sudo service fess status

En Caso de Versión RPM/DEB (systemd)

Inicio de OpenSearch:

$ sudo systemctl start opensearch.service

Inicio de Fess:

$ sudo systemctl start fess.service

Verificación del estado de inicio:

$ sudo systemctl status fess.service

Habilitar inicio automático del servicio:

$ sudo systemctl enable opensearch.service
$ sudo systemctl enable fess.service

En Caso de Versión Docker

Nota

compose.yaml y compose-opensearch3.yaml no se incluyen con Fess. Son proporcionados por el proyecto docker-fess (https://github.com/codelibs/docker-fess); obtenga el repositorio y ejecute los siguientes comandos dentro del directorio compose.

Iniciar usando Docker Compose:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml up -d

Verificación del estado de inicio:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml ps

Verificación de registros:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f fess01

Verificación del Inicio

Verifique que Fess se haya iniciado normalmente.

Verificación de Salud

Acceda a la siguiente URL desde un navegador o usando el comando curl:

http://localhost:8080/

Si se ha iniciado normalmente, se mostrará la pantalla de búsqueda de Fess.

Verificación desde la línea de comandos:

$ curl -I http://localhost:8080/

Si devuelve HTTP/1.1 200 OK, se ha iniciado normalmente.

Verificación de Registros

Verifique el registro de inicio para confirmar que no hay errores.

Para versiones ZIP:

$ tail -f /path/to/fess-15.9.0/logs/fess.log

Para versiones RPM/DEB:

$ sudo tail -f /var/log/fess/fess.log

O usando journalctl:

$ sudo journalctl -u fess.service -f

Para versión Docker:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f fess01

Truco

Cuando el inicio se completa correctamente, se escribe un mensaje de finalización de inicio como el siguiente en server_0.log, dentro del directorio de registros (logs/ en la versión ZIP, /var/log/fess/ en la versión RPM/DEB). No aparece en la consola ni en fess.log:

...Booting the Tomcat: port=8080 contextPath=
...
Boot successful: url -> http://localhost:8080

Acceso desde el Navegador

Acceda a la interfaz Web visitando las siguientes URL.

Pantalla de Búsqueda

URL: http://localhost:8080/

Se mostrará la pantalla de búsqueda de Fess. En el estado inicial, como no se ha realizado ninguna configuración de rastreo, no se mostrarán resultados de búsqueda.

La pantalla de búsqueda es bootstrap, el tema estático incluido con Fess. Para cambiar su aspecto, instale otro tema desde «Sistema» > «Tema» en la pantalla de administración o con bin/fess-setup install theme <name> (consulte Comando fess-setup), o copie el tema incluido y modifique la copia (consulte Personalización del Tema Incluido).

Pantalla de Administración

URL: http://localhost:8080/admin

Cuenta de administrador predeterminada:

• Nombre de usuario: admin

• Contraseña: admin

Advertencia

Nota Importante sobre Seguridad

Asegúrese de cambiar la contraseña predeterminada. Especialmente en entornos de producción, se recomienda encarecidamente cambiar la contraseña inmediatamente después del primer inicio de sesión.

Configuración Inicial

Después de iniciar sesión en la pantalla de administración, realice la siguiente configuración inicial.

Paso 1: Cambio de Contraseña de Administrador

1. Inicie sesión en la pantalla de administración (http://localhost:8080/admin)

2. Haga clic en «Usuario» → «Usuario» en el menú izquierdo

3. Haga clic en el usuario admin

4. Ingrese una nueva contraseña en el campo «Contraseña»

5. Vuelva a ingresar la misma contraseña en el campo «Contraseña (confirmar)»

6. Haga clic en el botón «Actualizar»

Importante

Se recomienda que la contraseña cumpla con las siguientes condiciones:

• 8 caracteres o más (la longitud mínima requerida está definida por password.min.length)

• Combinar letras mayúsculas, minúsculas, números y símbolos

• Difícil de adivinar

De forma predeterminada, solo se exige la longitud mínima (8 caracteres); no se impone ninguna combinación de tipos de caracteres. Los requisitos de tipos de caracteres pueden habilitarse con configuraciones como password.require.uppercase.

Paso 2: Creación de Configuración de Rastreo

Cree una configuración para rastrear sitios o sistemas de archivos que desee buscar.

1. Haga clic en «Rastreador» → «Web» en el menú izquierdo

2. Haga clic en el botón «Crear nuevo»

3. Ingrese la información necesaria:

   • Nombre: Nombre de la configuración de rastreo (ejemplo: Sitio web de la empresa)

   • URL: URL del objetivo de rastreo (ejemplo: https://www.example.com/). Para especificar varias URL, introduzca una URL por línea

   • Número máximo de accesos: Número máximo de documentos a rastrear (opcional)

   • Intervalo: Tiempo de espera entre accesos (milisegundos; valor predeterminado: 10000)

   Nota

   Los demás elementos (como el agente de usuario, el número de hilos y la profundidad) utilizan sus valores predeterminados cuando se dejan en blanco.

4. Haga clic en el botón «Crear»

Paso 3: Ejecución del Rastreo

1. Haga clic en «Sistema» → «Programador» en el menú izquierdo

2. Abra el trabajo «Default Crawler» y haga clic en el botón «Iniciar ahora»

3. Espere hasta que se complete el rastreo (puede verificar el progreso en el panel de control)

Paso 4: Verificación de la Búsqueda

1. Acceda a la pantalla de búsqueda (http://localhost:8080/)

2. Ingrese una palabra clave de búsqueda

3. Verifique que se muestren los resultados de búsqueda

Nota

El rastreo puede tardar tiempo. Para sitios grandes, puede tardar desde varias horas hasta varios días.

Otras Configuraciones Recomendadas

Si va a operar en un entorno de producción, considere también las siguientes configuraciones.

Configuración Principal mediante Variables de Entorno

La configuración del número de puerto, el tamaño del montón JVM y la URL de conexión a OpenSearch puede modificarse mediante variables de entorno. Edite bin/fess.in.sh para la edición ZIP, /etc/sysconfig/fess para la edición RPM y /etc/default/fess para la edición DEB. Es necesario reiniciar Fess tras realizar cambios.

Variable de entorno	Valor predeterminado	Descripción
FESS_PORT	8080	Puerto HTTP en el que Fess escucha.
FESS_HEAP_SIZE	(sin definir)	Tamaño del montón JVM. Establece el mismo valor para el mínimo y el máximo. Cuando no está definido, se utiliza un mínimo de 256m y un máximo de 2g (la edición ZIP para Windows utiliza un máximo de 1g); la edición RPM/DEB utiliza 512m.
SEARCH_ENGINE_HTTP_URL	http://localhost:9200	URL del OpenSearch al que conectarse. En la versión ZIP, bin/fess.in.sh establece este valor de forma predeterminada. Exporte la variable, o edite bin/fess.in.sh, cuando OpenSearch se ejecute en un puerto o host diferente. La edición RPM/DEB lo establece en el archivo de entorno del paquete.
FESS_LOG_LEVEL	warn	Nivel de registro de Fess.
FESS_HEAP_NEWSIZE	(sin definir)	Tamaño de la generación joven del montón JVM (-Xmn), por ejemplo 256m. Si no está definido, la JVM lo decide.
FESS_TEMP_PATH	temp en el directorio de Fess (edición RPM/DEB: /var/tmp/fess)	Directorio de archivos temporales, incluido el directorio de trabajo del Tomcat integrado. El usuario que ejecuta Fess debe poder escribir en él.
FESS_CONF_PATH	(sin definir) (edición RPM/DEB: /etc/fess)	Directorio que contiene los archivos de configuración. bin/fess lo coloca al principio del classpath y se lo pasa a Fess como -Dfess.conf.path. De los archivos como tomcat_config.properties de lib/classes, tiene prioridad el de este directorio. Sin embargo, en la edición ZIP la aplicación web lee primero los archivos de app/WEB-INF/classes, por lo que un fess_config.properties colocado en este directorio no sobrescribe los valores del fess_config.properties de app/WEB-INF/classes (los procesos hijos, como el rastreador, leen este directorio antes que WEB-INF/classes). En la edición ZIP, edite el archivo de app/WEB-INF/classes para modificar fess_config.properties. La edición RPM/DEB no incluye fess_config.properties en app/WEB-INF/classes y utiliza únicamente el de /etc/fess.
FESS_USE_IPV4	(sin definir)	Con cualquier valor no vacío, la JVM utiliza solo la pila IPv4 (-Djava.net.preferIPv4Stack=true).
FESS_USE_GC_LOGGING	(sin definir)	Con cualquier valor no vacío, la JVM escribe su registro del recolector de basura en gc-fess.log dentro del directorio de registros (hasta 5 archivos de 64 MB).

Nota

Las variables de entorno que lee el archivo bin\fess.in.bat de la edición ZIP para Windows son, de las de la tabla, FESS_HEAP_SIZE, FESS_HEAP_NEWSIZE, FESS_USE_IPV4 y FESS_USE_GC_LOGGING, además de las siguientes variables que no figuran en la tabla.

• FESS_MIN_MEM, FESS_MAX_MEM: especifican por separado el tamaño mínimo y máximo del montón (se ignoran si se define FESS_HEAP_SIZE).

• FESS_DIRECT_SIZE: límite de la memoria directa (-XX:MaxDirectMemorySize).

• FESS_DICTIONARY_PATH: directorio config\dictionary de OpenSearch.

• FESS_PROXY_HOST, FESS_PROXY_PORT, FESS_NON_PROXY_HOSTS: configuración del proxy.

• FESS_JAVA_OPTS: fess.in.bat añade estas opciones de la JVM después de los valores ya configurados.

• PLAYWRIGHT_NODEJS_PATH: ejecutable de Node.js que utiliza el plugin de Playwright.

• JAVA_HOME: obligatoria.

FESS_PORT, FESS_LOG_LEVEL, FESS_TEMP_PATH, FESS_CONF_PATH y SEARCH_ENGINE_HTTP_URL no se leen. Estos valores se escriben directamente en el archivo, por lo que para modificarlos edite bin\fess.in.bat directamente.

Configuración del Servidor de Correo

Para recibir notificaciones de fallos y mensajes similares por correo electrónico, configure el servidor SMTP y la dirección del destinatario de notificaciones.

1. En fess_env_web.properties y fess_env_crawler.properties, especifique el host y el puerto del servidor SMTP en mail.smtp.server.main.host.and.port (predeterminado: localhost:25). Los archivos se encuentran en app/WEB-INF/classes/ en el paquete ZIP y en /etc/fess/ en los paquetes RPM/DEB. El proceso web de Fess lee el primero, y el rastreador, que envía el correo de finalización del rastreo, lee el segundo; fess_env.properties no se utiliza. Es necesario reiniciar Fess tras el cambio.

2. En la interfaz de administración, haga clic en «Sistema» → «General» en el menú izquierdo.

3. Ingrese la dirección de correo del destinatario en el campo «Correo de notificación».

4. Haga clic en el botón «Actualizar».

5. Puede verificar que el correo se envía correctamente con el botón «Enviar correo de prueba».

Configuración de Zona Horaria

Fess utiliza la zona horaria del servidor (SO / JVM). No existe ninguna configuración para cambiar la zona horaria en la interfaz de administración. Para cambiarla, modifique la configuración de zona horaria del SO, o añada la opción JVM -Duser.timezone=Asia/Tokyo a FESS_JAVA_OPTS en bin/fess.in.sh (en Windows, bin\fess.in.bat).

Ajuste del Nivel de Registro

En producción, puede ajustar el nivel de registro para reducir el uso de disco.

El nivel de registro global de Fess puede modificarse con la variable de entorno FESS_LOG_LEVEL (predeterminado: warn). Para controlar los registradores individuales con mayor detalle, edite el archivo de configuración app/WEB-INF/classes/log4j2.xml. El rastreo, las sugerencias y la generación de miniaturas se ejecutan como procesos independientes, por lo que configure sus niveles de registro individualmente en app/WEB-INF/env/{crawler,suggest,thumbnail}/resources/log4j2.xml.

Para más detalles, consulte Guía del Administrador de Fess.

Métodos de Detención

En Caso de Versión ZIP

Detención de Fess

Elimine el proceso:

$ ps aux | grep fess
$ kill <PID>

O puede detenerlo con Ctrl+C desde la consola (si está ejecutándose en primer plano).

Detención de OpenSearch:

$ ps aux | grep opensearch
$ kill <PID>

En Caso de Versión RPM/DEB (chkconfig)

Detención de Fess:

$ sudo service fess stop

Detención de OpenSearch:

$ sudo service opensearch stop

En Caso de Versión RPM/DEB (systemd)

Detención de Fess:

$ sudo systemctl stop fess.service

Detención de OpenSearch:

$ sudo systemctl stop opensearch.service

En Caso de Versión Docker

Detención de contenedores:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml stop

Detención y eliminación de contenedores:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml down

Advertencia

Agregue la opción -v al comando down si también desea eliminar los volúmenes. En este caso, tenga cuidado ya que se eliminarán todos los datos.

Métodos de Reinicio

En Caso de Versión ZIP

Detenga y luego inicie.

En Caso de Versión RPM/DEB

Con chkconfig:

$ sudo service fess restart

Con systemd:

$ sudo systemctl restart fess.service

En Caso de Versión Docker

$ docker compose -f compose.yaml -f compose-opensearch3.yaml restart

Solución de Problemas

Si no Inicia

1. Verificar que OpenSearch esté en ejecución

   $ curl http://localhost:9200/
   

   Si OpenSearch no está en ejecución, primero inicie OpenSearch.

2. Verificar conflictos de números de puerto

   $ sudo ss -tuln | grep 8080
   

   Si net-tools está instalado, sudo netstat -tuln | grep 8080 muestra la misma información.

   Si el puerto 8080 ya está en uso, cambie el número de puerto:

   • Edición ZIP: cambie FESS_PORT en bin/fess.in.sh

   • Edición ZIP (Windows): edite -Dfess.port=8080 directamente en bin\fess.in.bat

   • Edición RPM: cambie FESS_PORT en /etc/sysconfig/fess

   • Edición DEB: cambie FESS_PORT en /etc/default/fess

3. Verificar registros

   Verifique los mensajes de error para identificar el problema.

4. Verificar versión de Java

   $ java -version
   

   Verifique que esté instalado Java 21 o posterior.

Para solución de problemas detallada, consulte Solución de Problemas.

Próximos Pasos

Una vez que Fess se haya iniciado normalmente, consulte la siguiente documentación para comenzar la operación:

• Guía del Administrador de Fess - Detalles sobre configuración de rastreo, configuración de búsqueda y configuración del sistema

• Configuración de Seguridad - Configuración de seguridad para entornos de producción

• Solución de Problemas - Problemas comunes y soluciones

• Procedimientos de Actualización - Procedimientos de actualización de versión

• Procedimientos de Desinstalación - Procedimientos de desinstalación