From 7ca98fd5fb3378e589f9ac93ee6b79b3a8576add Mon Sep 17 00:00:00 2001 From: Shinsuke Sugaya Date: Fri, 16 Oct 2026 08:21:19 +0900 Subject: [PATCH] docs(15.9): describe the ZIP installation with fess-setup in the quick start Fess 15.9 no longer bundles OpenSearch, but the quick start guide still told ZIP users to install OpenSearch by hand, and setup.rst and the Windows service page still referred to an embedded OpenSearch. - quick-start.rst: the ZIP method now needs only Java 21. OpenSearch is installed with bin/fess-setup install opensearch, then OpenSearch and Fess are started in that order and checked with bin/fess-setup check. Notes the macOS limitation and that the command disables the OpenSearch security plugin. - setup.rst: drop the embedded OpenSearch warning and point the links at 15.9. - 15.9/config/setup-windows-service.rst: omitting fess.search_engine.http_address now stops Fess with an error instead of starting an embedded OpenSearch. Applied to all seven languages. --- de/15.9/config/setup-windows-service.rst | 2 +- de/quick-start.rst | 75 ++++++++++++----- de/setup.rst | 17 ++-- en/15.9/config/setup-windows-service.rst | 2 +- en/quick-start.rst | 75 ++++++++++++----- en/setup.rst | 17 ++-- es/15.9/config/setup-windows-service.rst | 2 +- es/quick-start.rst | 75 ++++++++++++----- es/setup.rst | 17 ++-- fr/15.9/config/setup-windows-service.rst | 2 +- fr/quick-start.rst | 89 ++++++++++++++------- fr/setup.rst | 17 ++-- ja/15.9/config/setup-windows-service.rst | 2 +- ja/quick-start.rst | 81 ++++++++++++++----- ja/setup.rst | 17 ++-- ko/15.9/config/setup-windows-service.rst | 2 +- ko/quick-start.rst | 78 ++++++++++++------ ko/setup.rst | 17 ++-- zh-cn/15.9/config/setup-windows-service.rst | 2 +- zh-cn/quick-start.rst | 77 +++++++++++++----- zh-cn/setup.rst | 17 ++-- 21 files changed, 465 insertions(+), 218 deletions(-) diff --git a/de/15.9/config/setup-windows-service.rst b/de/15.9/config/setup-windows-service.rst index 34e32c67d..d73b8761c 100644 --- a/de/15.9/config/setup-windows-service.rst +++ b/de/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ Fügen Sie die Verbindungseinstellungen für OpenSearch in ``c:\opt\fess\bin\fes set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - Geben Sie unter ``fess.search_engine.http_address`` die Verbindungsadresse des registrierten OpenSearch-Dienstes an. Ohne diese Einstellung kann |Fess| die Verbindungsadresse nicht ermitteln und startet die eingebettete OpenSearch-Version, die in Produktionsumgebungen nicht empfohlen wird. + - Geben Sie unter ``fess.search_engine.http_address`` die Verbindungsadresse des registrierten OpenSearch-Dienstes an. Ohne diese Einstellung kann |Fess| die Verbindungsadresse nicht ermitteln und startet nicht; es meldet, dass keine Adresse der Suchmaschine konfiguriert ist. - Wenn OpenSearch auf einem anderen Host läuft, ändern Sie den Hostnamen oder die IP-Adresse entsprechend. - Verwenden Sie ``/`` als Pfadtrennzeichen. diff --git a/de/quick-start.rst b/de/quick-start.rst index e81c58c78..28d994e43 100644 --- a/de/quick-start.rst +++ b/de/quick-start.rst @@ -21,10 +21,10 @@ Welche Methode sollten Sie verwenden? - ZIP-Paket * - Voraussetzungen - Docker und Docker Compose - - Java 21, OpenSearch + - Java 21 (OpenSearch wird mit dem Befehl ``fess-setup`` installiert) * - Einfachheit - ◎ Nur wenige Befehle - - △ Mehrere Software-Installationen erforderlich + - △ Java installieren, dann einige Setup-Befehle ausführen * - Am besten für - Diejenigen, die es zuerst ausprobieren möchten - Umgebungen, in denen Docker nicht verfügbar ist @@ -77,9 +77,11 @@ siehe die :doc:`Docker-Installationsanleitung <15.9/install/install-docker>`. Methode 2: ZIP-Paket ===================== -Geschätzte Zeit: **20–30 Minuten beim ersten Start** (einschließlich Java- und OpenSearch-Installation) +Geschätzte Zeit: **20–30 Minuten beim ersten Start** (einschließlich Java-Installation und OpenSearch-Download) Wenn Sie Docker nicht verwenden möchten, können Sie Fess direkt aus dem ZIP-Paket ausführen. +Fess bündelt keine Suchmaschine. Der im ZIP-Paket enthaltene Befehl ``fess-setup`` +lädt OpenSearch herunter und installiert die von Fess benötigten Plugins. .. note:: @@ -89,38 +91,67 @@ Wenn Sie Docker nicht verwenden möchten, können Sie Fess direkt aus dem ZIP-Pa Voraussetzungen --------------- -Bitte installieren Sie die folgende Software, bevor Sie Fess starten. +Installieren Sie vor dem Start Java 21. Wir empfehlen `Eclipse Temurin `__ Java 21. +OpenSearch muss nicht vorab installiert werden: Schritt 2 installiert es. -**1. Java 21 installieren** - -Wir empfehlen `Eclipse Temurin `__ Java 21. - -**2. OpenSearch installieren und starten** - -OpenSearch wird zum Speichern der Fess-Daten benötigt. -Bitte installieren und starten Sie es gemäß der :doc:`Installationsanleitung `. +.. note:: -Download und Installation -------------------------- + OpenSearch veröffentlicht offizielle Builds nur für Linux und Windows. Unter macOS + endet ``fess-setup install opensearch`` mit einem Fehler; verwenden Sie Docker (Methode 1) oder lesen Sie + :doc:`15.9/install/install-linux` zur Installation von OpenSearch mit Homebrew. -1. Laden Sie das neueste ZIP-Paket von `GitHub Releases `__ herunter +Schritt 1: Herunterladen und Entpacken +-------------------------------------- -2. Entpacken Sie es und wechseln Sie in das Verzeichnis: +Laden Sie das neueste ZIP-Paket von `GitHub Releases `__ herunter, +entpacken Sie es und wechseln Sie in das Verzeichnis: .. code-block:: bash unzip fess-x.y.z.zip cd fess-x.y.z -Fess starten ------------- +Schritt 2: OpenSearch installieren +---------------------------------- + +Führen Sie ``fess-setup`` als normaler Benutzer aus, nicht als ``root``: OpenSearch weigert sich, als ``root`` zu starten. .. code-block:: bash - # Linux/Mac - ./bin/fess + # Linux + bin/fess-setup install opensearch # Windows + bin\fess-setup.bat install opensearch + +Dies lädt die von dieser Fess-Version unterstützte OpenSearch-Version in das Verzeichnis ``opensearch/`` im Fess-Verzeichnis herunter, +installiert die vier von Fess benötigten Plugins und fügt die von Fess benötigten Einstellungen in die Datei +``config/opensearch.yml`` ein. ``bin/fess`` findet dieses OpenSearch selbstständig, sodass keine Konfigurationsdatei +bearbeitet werden muss, solange OpenSearch auf demselben Host läuft. + +.. warning:: + + Der Befehl setzt ``plugins.security.disabled: true``, sodass OpenSearch Anfragen ohne + Authentifizierung akzeptiert. Standardmäßig lauscht es nur auf der Loopback-Adresse; setzen Sie es keinem + Netzwerk aus. Einstellungen für die Produktion finden Sie unter :doc:`15.9/install/security`. + +Alle Befehle (Installation von Node.js und Plugins, ``check``) finden Sie unter :doc:`15.9/install/fess-setup`. + +Schritt 3: OpenSearch und Fess starten +-------------------------------------- + +Starten Sie zuerst OpenSearch, dann Fess: + +.. code-block:: bash + + # Linux + opensearch/opensearch-3.9.0/bin/opensearch -d + bin/fess + +.. code-block:: bat + + :: Windows (jeweils in einer eigenen Eingabeaufforderung ausführen) + opensearch\opensearch-3.9.0\bin\opensearch.bat bin\fess.bat Warten Sie etwa 30 Sekunden, bis Fess gestartet ist, und greifen Sie dann zu auf: @@ -128,6 +159,9 @@ Warten Sie etwa 30 Sekunden, bis Fess gestartet ist, und greifen Sie dann zu auf - http://localhost:8080/ (Suche) - http://localhost:8080/admin (Admin - Login: admin/admin) +Zur Überprüfung der Installation führen Sie ``bin/fess-setup check`` aus (unter Windows ``bin\fess-setup.bat check``). +Der Befehl meldet, ob OpenSearch erreichbar ist und die von Fess benötigten Plugins besitzt. + .. warning:: Bitte ändern Sie das Standard-Passwort. In Produktionsumgebungen wird empfohlen, @@ -137,6 +171,7 @@ Fess stoppen (ZIP) ------------------ Drücken Sie ``Strg+C`` im Terminal oder verwenden Sie ``kill``, um den Fess-Prozess zu beenden. +Beenden Sie anschließend OpenSearch auf dieselbe Weise (``kill`` für den Prozess oder ``Strg+C``, wenn es im Vordergrund läuft). ---- diff --git a/de/setup.rst b/de/setup.rst index 027601f74..f1dbc57a3 100644 --- a/de/setup.rst +++ b/de/setup.rst @@ -13,15 +13,16 @@ Mit Docker können Sie Fess auf Windows, Mac und anderen Systemen einfach einric Diese Seite erklärt das Setup unter **Windows mit Docker**. Benutzer von Linux oder macOS können ähnliche Schritte befolgen, aber die Docker Desktop-Installation unterscheidet sich je nach Plattform. Weitere Details finden Sie in der `Docker `_-Dokumentation. -Wenn Sie eine Produktionsumgebung aufbauen, lesen Sie bitte unbedingt :doc:`15.6/install/index`. -Die Systemanforderungen finden Sie unter :doc:`15.6/install/prerequisites`. +Wenn Sie eine Produktionsumgebung aufbauen, lesen Sie bitte unbedingt :doc:`15.9/install/index`. +Die Systemanforderungen finden Sie unter :doc:`15.9/install/prerequisites`. .. warning:: **Wichtige Hinweise für die Produktionsumgebung** - In Produktionsumgebungen oder bei Lasttests wird der Betrieb mit eingebettetem OpenSearch nicht empfohlen. - Richten Sie unbedingt einen externen OpenSearch-Server ein. + Diese Seite beschreibt ein Setup zum Ausprobieren von Fess. Richten Sie für Produktionsumgebungen + oder Lasttests einen dedizierten OpenSearch-Server ein und lesen Sie dazu :doc:`15.9/install/install-docker` oder + :doc:`15.9/install/index`. Setup-Übersicht --------------- @@ -184,11 +185,11 @@ Nächste Schritte Nach dem Einrichten von Fess können Sie mit folgender Dokumentation weiterarbeiten: -- :doc:`15.6/install/run` — Detaillierte Anleitung zum Starten, Stoppen und Konfigurieren -- :doc:`15.6/admin/index` — Administratorhandbuch (Crawl-Einstellungen, Benutzerverwaltung usw.) -- :doc:`15.6/user/index` — Benutzerhandbuch (Suche verwenden) +- :doc:`15.9/install/run` — Detaillierte Anleitung zum Starten, Stoppen und Konfigurieren +- :doc:`15.9/admin/index` — Administratorhandbuch (Crawl-Einstellungen, Benutzerverwaltung usw.) +- :doc:`15.9/user/index` — Benutzerhandbuch (Suche verwenden) -Bei Problemen lesen Sie bitte :doc:`15.6/install/troubleshooting`. +Bei Problemen lesen Sie bitte :doc:`15.9/install/troubleshooting`. .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png diff --git a/en/15.9/config/setup-windows-service.rst b/en/15.9/config/setup-windows-service.rst index 106eb5d76..3620f46ad 100644 --- a/en/15.9/config/setup-windows-service.rst +++ b/en/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ Add the settings required to connect to OpenSearch to ``c:\opt\fess\bin\fess.in. set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - ``fess.search_engine.http_address`` specifies the connection target for the registered OpenSearch service. If this setting is omitted, |Fess| cannot locate the connection target and will start the embedded OpenSearch, which is not recommended for production environments. + - ``fess.search_engine.http_address`` specifies the connection target for the registered OpenSearch service. If this setting is omitted, |Fess| cannot locate the connection target and does not start; it reports that no search engine address is configured. - If OpenSearch is running on a different host, change the hostname or IP address accordingly. - Use ``/`` as the path separator. diff --git a/en/quick-start.rst b/en/quick-start.rst index 9e9310e06..c410bbf74 100644 --- a/en/quick-start.rst +++ b/en/quick-start.rst @@ -21,10 +21,10 @@ Which Method Should You Use? - ZIP Package * - Prerequisites - Docker and Docker Compose - - Java 21, OpenSearch + - Java 21 (OpenSearch is installed with the ``fess-setup`` command) * - Ease of Setup - ◎ Just a few commands - - △ Multiple software installations required + - △ Install Java, then run a few setup commands * - Best For - Those who want to try it first - Those in environments where Docker is unavailable @@ -77,9 +77,11 @@ see the :doc:`Docker Installation Guide <15.9/install/install-docker>`. Method 2: ZIP Package ===================== -Estimated time: **20–30 minutes on first run** (including Java and OpenSearch installation) +Estimated time: **20–30 minutes on first run** (including Java installation and the OpenSearch download) If you prefer not to use Docker, you can run Fess directly from the ZIP package. +Fess does not bundle a search engine, so the ``fess-setup`` command included in the ZIP package +downloads OpenSearch and installs the plugins Fess requires. .. note:: @@ -89,38 +91,67 @@ If you prefer not to use Docker, you can run Fess directly from the ZIP package. Prerequisites ------------- -Before starting Fess, please install the following software. +Install Java 21 before starting. We recommend `Eclipse Temurin `__ Java 21. +OpenSearch does not need to be installed in advance: Step 2 installs it. -**1. Install Java 21** - -We recommend `Eclipse Temurin `__ Java 21. - -**2. Install and Start OpenSearch** - -OpenSearch is required to store Fess data. -Please refer to :doc:`Installation Guide ` to install and start it. +.. note:: -Download and Install --------------------- + OpenSearch publishes official builds for Linux and Windows only. On macOS, + ``fess-setup install opensearch`` exits with an error; use Docker (Method 1), or see + :doc:`15.9/install/install-linux` for installing OpenSearch with Homebrew. -1. Download the latest ZIP package from `GitHub Releases `__ +Step 1: Download and Extract +---------------------------- -2. Extract and enter the directory: +Download the latest ZIP package from `GitHub Releases `__, +extract it, and enter the directory: .. code-block:: bash unzip fess-x.y.z.zip cd fess-x.y.z -Start Fess ----------- +Step 2: Install OpenSearch +-------------------------- + +Run ``fess-setup`` as a regular user, not as ``root``: OpenSearch refuses to start as ``root``. .. code-block:: bash - # Linux/Mac - ./bin/fess + # Linux + bin/fess-setup install opensearch # Windows + bin\fess-setup.bat install opensearch + +This downloads the OpenSearch version this Fess supports into ``opensearch/`` in the Fess +directory, installs the four plugins Fess requires, and adds the settings Fess needs to its +``config/opensearch.yml``. ``bin/fess`` finds this OpenSearch on its own, so no configuration file +needs to be edited as long as OpenSearch runs on the same host. + +.. warning:: + + The command sets ``plugins.security.disabled: true``, so OpenSearch accepts requests without + authentication. It listens only on the loopback address by default; do not expose it to a + network. See :doc:`15.9/install/security` for production settings. + +For all commands (installing Node.js and plugins, ``check``), see :doc:`15.9/install/fess-setup`. + +Step 3: Start OpenSearch and Fess +--------------------------------- + +Start OpenSearch first, then Fess: + +.. code-block:: bash + + # Linux + opensearch/opensearch-3.9.0/bin/opensearch -d + bin/fess + +.. code-block:: bat + + :: Windows (run each in its own Command Prompt) + opensearch\opensearch-3.9.0\bin\opensearch.bat bin\fess.bat Wait about 30 seconds for Fess to start, then access: @@ -128,6 +159,9 @@ Wait about 30 seconds for Fess to start, then access: - http://localhost:8080/ (Search) - http://localhost:8080/admin (Admin - login: admin/admin) +To check the installation, run ``bin/fess-setup check`` (``bin\fess-setup.bat check`` on Windows). +It reports whether OpenSearch is reachable and has the plugins Fess requires. + .. warning:: Please change the default password. For production environments, it is strongly @@ -137,6 +171,7 @@ Stop Fess (ZIP) --------------- Press ``Ctrl+C`` in the terminal, or use ``kill`` to stop the fess process. +Then stop OpenSearch the same way (``kill`` its process, or ``Ctrl+C`` if it runs in the foreground). ---- diff --git a/en/setup.rst b/en/setup.rst index 964a1ba34..c82934cf5 100644 --- a/en/setup.rst +++ b/en/setup.rst @@ -13,15 +13,16 @@ Using Docker allows you to easily set up Fess on Windows, Mac, and other platfor This page explains setup on **Windows using Docker**. Users on Linux or macOS can follow similar steps, but the Docker Desktop installation differs by platform. For details, refer to the `Docker `_ documentation. -For production environments, be sure to refer to :doc:`15.6/install/index`. -For system requirements, see :doc:`15.6/install/prerequisites`. +For production environments, be sure to refer to :doc:`15.9/install/index`. +For system requirements, see :doc:`15.9/install/prerequisites`. .. warning:: **Important Notes for Production Environments** - Running with the embedded OpenSearch is not recommended for production environments or load testing. - Always set up an external OpenSearch server. + This page describes a setup for trying out Fess. For production environments or load testing, + set up a dedicated OpenSearch server by referring to :doc:`15.9/install/install-docker` or + :doc:`15.9/install/index`. Setup Overview -------------- @@ -184,11 +185,11 @@ Next Steps Now that Fess is set up, refer to the following documentation to get started: -- :doc:`15.6/install/run` — Detailed startup, stop, and configuration -- :doc:`15.6/admin/index` — Administrator guide (crawl settings, user management, etc.) -- :doc:`15.6/user/index` — User guide (how to search) +- :doc:`15.9/install/run` — Detailed startup, stop, and configuration +- :doc:`15.9/admin/index` — Administrator guide (crawl settings, user management, etc.) +- :doc:`15.9/user/index` — User guide (how to search) -If you encounter any issues, refer to :doc:`15.6/install/troubleshooting`. +If you encounter any issues, refer to :doc:`15.9/install/troubleshooting`. .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png diff --git a/es/15.9/config/setup-windows-service.rst b/es/15.9/config/setup-windows-service.rst index b3401a2ff..cbb937d46 100644 --- a/es/15.9/config/setup-windows-service.rst +++ b/es/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ Agregue la configuración de conexión a OpenSearch en ``c:\opt\fess\bin\fess.in set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - En ``fess.search_engine.http_address`` especifique el destino de conexión del servicio OpenSearch registrado. Si no se configura esta opción, |Fess| no podrá encontrar el destino de conexión e iniciará la versión embebida de OpenSearch, que no es recomendada para entornos de producción. + - En ``fess.search_engine.http_address`` especifique el destino de conexión del servicio OpenSearch registrado. Si no se configura esta opción, |Fess| no podrá encontrar el destino de conexión y no se iniciará; informará de que no hay ninguna dirección de motor de búsqueda configurada. - Si OpenSearch se ejecuta en un host diferente, cambie el nombre de host o la dirección IP según corresponda. - Utilice ``/`` como separador de ruta. diff --git a/es/quick-start.rst b/es/quick-start.rst index a6a1bb95b..0cd200a05 100644 --- a/es/quick-start.rst +++ b/es/quick-start.rst @@ -21,10 +21,10 @@ Esta guía está destinada a quienes desean probar Fess rápidamente, describien - Paquete ZIP * - Requisitos previos - Docker y Docker Compose - - Java 21, OpenSearch + - Java 21 (OpenSearch se instala con el comando ``fess-setup``) * - Facilidad de inicio - ◎ Solo unos pocos comandos - - △ Se requieren múltiples instalaciones de software + - △ Instalar Java y ejecutar unos pocos comandos de configuración * - Ideal para - Quienes quieren probarlo primero - Quienes no pueden usar Docker en su entorno @@ -77,9 +77,11 @@ consulte la :doc:`Guia de instalacion con Docker <15.9/install/install-docker>`. Metodo 2: Paquete ZIP ====================== -Tiempo estimado: **20–30 minutos en el primer inicio** (incluyendo la instalación de Java y OpenSearch) +Tiempo estimado: **20–30 minutos en el primer inicio** (incluyendo la instalación de Java y la descarga de OpenSearch) Si no desea usar Docker, puede ejecutar Fess directamente desde el paquete ZIP. +Fess no incluye un motor de búsqueda; el comando ``fess-setup`` incluido en el paquete ZIP +descarga OpenSearch e instala los plugins que Fess necesita. .. note:: @@ -89,38 +91,67 @@ Si no desea usar Docker, puede ejecutar Fess directamente desde el paquete ZIP. Preparacion Previa ------------------ -Por favor, instale el siguiente software antes de iniciar Fess. +Instale Java 21 antes de comenzar. Se recomienda `Eclipse Temurin `__ para Java 21. +No es necesario instalar OpenSearch de antemano: el Paso 2 lo instala. -**1. Instalar Java 21** - -Se recomienda `Eclipse Temurin `__ para Java 21. - -**2. Instalar e iniciar OpenSearch** - -OpenSearch es necesario para almacenar los datos de Fess. -Consulte la :doc:`guia de instalacion ` para instalar e iniciar OpenSearch. +.. note:: -Descarga e Instalacion ------------------------ + OpenSearch publica compilaciones oficiales solo para Linux y Windows. En macOS, + ``fess-setup install opensearch`` termina con un error; utilice Docker (Método 1) o consulte + :doc:`15.9/install/install-linux` para instalar OpenSearch con Homebrew. -1. Descargue el paquete ZIP mas reciente desde `GitHub Releases `__ +Paso 1: Descargar y extraer +--------------------------- -2. Extraiga e ingrese al directorio: +Descargue el paquete ZIP más reciente desde `GitHub Releases `__, +extráigalo e ingrese al directorio: .. code-block:: bash unzip fess-x.y.z.zip cd fess-x.y.z -Inicio de Fess --------------- +Paso 2: Instalar OpenSearch +--------------------------- + +Ejecute ``fess-setup`` como usuario normal, no como ``root``: OpenSearch se niega a iniciarse como ``root``. .. code-block:: bash - # Linux/Mac - ./bin/fess + # Linux + bin/fess-setup install opensearch # Windows + bin\fess-setup.bat install opensearch + +Esto descarga la versión de OpenSearch compatible con este Fess en ``opensearch/`` dentro del +directorio de Fess, instala los cuatro plugins que Fess necesita y agrega los ajustes que Fess requiere a su +``config/opensearch.yml``. ``bin/fess`` encuentra este OpenSearch por sí mismo, por lo que no es necesario +editar ningún archivo de configuración mientras OpenSearch se ejecute en el mismo host. + +.. warning:: + + El comando establece ``plugins.security.disabled: true``, por lo que OpenSearch acepta solicitudes sin + autenticación. De forma predeterminada solo escucha en la dirección de loopback; no lo exponga a + una red. Consulte :doc:`15.9/install/security` para la configuración de producción. + +Para ver todos los comandos (instalación de Node.js y plugins, ``check``), consulte :doc:`15.9/install/fess-setup`. + +Paso 3: Iniciar OpenSearch y Fess +--------------------------------- + +Inicie primero OpenSearch y después Fess: + +.. code-block:: bash + + # Linux + opensearch/opensearch-3.9.0/bin/opensearch -d + bin/fess + +.. code-block:: bat + + :: Windows (ejecute cada uno en su propio Símbolo del sistema) + opensearch\opensearch-3.9.0\bin\opensearch.bat bin\fess.bat Espere aproximadamente 30 segundos para que Fess se inicie, luego acceda a: @@ -128,6 +159,9 @@ Espere aproximadamente 30 segundos para que Fess se inicie, luego acceda a: - http://localhost:8080/ (Busqueda) - http://localhost:8080/admin (Administracion - usuario: admin/admin) +Para comprobar la instalación, ejecute ``bin/fess-setup check`` (``bin\fess-setup.bat check`` en Windows). +Informa de si OpenSearch es accesible y tiene los plugins que Fess necesita. + .. warning:: Asegurese de cambiar la contrasena predeterminada. @@ -137,6 +171,7 @@ Detencion de Fess (ZIP) ------------------------ Presione ``Ctrl+C`` en la terminal, o use ``kill`` para detener el proceso fess. +A continuación, detenga OpenSearch de la misma forma (``kill`` a su proceso, o ``Ctrl+C`` si se ejecuta en primer plano). ---- diff --git a/es/setup.rst b/es/setup.rst index 4826a1a01..a964f3a29 100644 --- a/es/setup.rst +++ b/es/setup.rst @@ -13,15 +13,16 @@ Al utilizar Docker, puede configurar fácilmente Fess en Windows, Mac, etc. Esta página explica la configuración en **Windows con Docker**. Los usuarios de Linux o macOS pueden seguir pasos similares, pero la instalación de Docker Desktop varía según la plataforma. Para más detalles, consulte la documentación de `Docker `_. -Al construir un entorno de operación, asegúrese de consultar :doc:`15.6/install/index`. -Para conocer los requisitos del sistema, consulte :doc:`15.6/install/prerequisites`. +Al construir un entorno de operación, asegúrese de consultar :doc:`15.9/install/index`. +Para conocer los requisitos del sistema, consulte :doc:`15.9/install/prerequisites`. .. warning:: **Notas importantes para el entorno de producción** - No se recomienda ejecutar con OpenSearch integrado en entornos de producción o pruebas de carga. - Asegúrese de construir un servidor OpenSearch externo. + Esta página describe una configuración para probar |Fess|. Para entornos de producción o pruebas de carga, + configure un servidor OpenSearch dedicado consultando :doc:`15.9/install/install-docker` o + :doc:`15.9/install/index`. Resumen de la Configuración ---------------------------- @@ -184,11 +185,11 @@ Próximos Pasos Una vez configurado Fess, consulte la siguiente documentación para continuar: -- :doc:`15.6/install/run` — Inicio, detención y configuración detallada -- :doc:`15.6/admin/index` — Guía del administrador (configuración de rastreo, gestión de usuarios, etc.) -- :doc:`15.6/user/index` — Guía del usuario (cómo buscar) +- :doc:`15.9/install/run` — Inicio, detención y configuración detallada +- :doc:`15.9/admin/index` — Guía del administrador (configuración de rastreo, gestión de usuarios, etc.) +- :doc:`15.9/user/index` — Guía del usuario (cómo buscar) -Si encuentra algún problema, consulte :doc:`15.6/install/troubleshooting`. +Si encuentra algún problema, consulte :doc:`15.9/install/troubleshooting`. .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png diff --git a/fr/15.9/config/setup-windows-service.rst b/fr/15.9/config/setup-windows-service.rst index 27412b8b4..0f96ab1c1 100644 --- a/fr/15.9/config/setup-windows-service.rst +++ b/fr/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ Ajoutez la configuration de connexion à OpenSearch dans ``c:\opt\fess\bin\fess. set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - ``fess.search_engine.http_address`` permet de spécifier la destination de connexion du service OpenSearch enregistré. Sans cette configuration, |Fess| ne peut pas trouver la destination de connexion et démarre une instance OpenSearch embarquée, déconseillée en environnement de production. + - ``fess.search_engine.http_address`` permet de spécifier la destination de connexion du service OpenSearch enregistré. Sans cette configuration, |Fess| ne peut pas trouver la destination de connexion et ne démarre pas ; il signale qu'aucune adresse de moteur de recherche n'est configurée. - Si vous exécutez OpenSearch sur un hôte différent, modifiez le nom d'hôte ou l'adresse IP en conséquence. - Utilisez ``/`` comme séparateur de chemin. diff --git a/fr/quick-start.rst b/fr/quick-start.rst index c942e5bcf..cf29f7ffe 100644 --- a/fr/quick-start.rst +++ b/fr/quick-start.rst @@ -22,10 +22,10 @@ Quelle methode utiliser ? - Package ZIP * - Prérequis - Docker et Docker Compose - - Java 21, OpenSearch + - Java 21 (OpenSearch est installé avec la commande ``fess-setup``) * - Facilité de démarrage - ◎ Seulement quelques commandes - - △ Plusieurs logiciels à installer + - △ Installer Java, puis exécuter quelques commandes de configuration * - Idéal pour - Ceux qui veulent d'abord essayer - Ceux dans des environnements où Docker n'est pas disponible @@ -77,55 +77,87 @@ Pour plus de détails sur le déploiement Docker, consultez le :doc:`Guide d'ins Démarrage avec le package ZIP ============================== -Temps estimé : **20 à 30 minutes au premier démarrage** (y compris l'installation de Java et OpenSearch) +Temps estimé : **20 à 30 minutes au premier démarrage** (y compris l'installation de Java et le téléchargement d'OpenSearch) La procédure décrite ici est une méthode de démarrage à des fins d'essai. Pour les procédures de construction en environnement de production, veuillez consulter la :doc:`procédure d'installation `. (Le Fess démarré avec cette procédure est destiné à une simple vérification de fonctionnement et l'utilisation de cet environnement en production n'est pas recommandée) +Fess n'inclut pas de moteur de recherche : la commande ``fess-setup`` fournie dans le package ZIP +télécharge OpenSearch et installe les plugins nécessaires à Fess. + Préparation préalable --------------------- -Veuillez installer les logiciels suivants avant de démarrer Fess. +Installez Java 21 avant de commencer. `Eclipse Temurin `__ est recommandé pour Java 21. +Il n'est pas nécessaire d'installer OpenSearch au préalable : l'étape 2 s'en charge. + +.. note:: -**1. Installer Java 21** + OpenSearch ne publie de versions officielles que pour Linux et Windows. Sur macOS, + ``fess-setup install opensearch`` se termine par une erreur ; utilisez Docker (méthode 1), ou consultez + :doc:`15.9/install/install-linux` pour installer OpenSearch avec Homebrew. -`Eclipse Temurin `__ est recommandé pour Java 21. +Étape 1 : Téléchargement et extraction +-------------------------------------- -**2. Installer et démarrer OpenSearch** +Téléchargez le package ZIP de la dernière version de Fess depuis le `site de version GitHub `__, +extrayez-le, puis placez-vous dans le répertoire : -OpenSearch est nécessaire pour stocker les données de Fess. -Veuillez vous référer à la :doc:`procédure d'installation ` pour l'installer et le démarrer. +.. code-block:: bash -Téléchargement --------------- + unzip fess-x.y.z.zip + cd fess-x.y.z -Téléchargez le package ZIP de la dernière version de Fess depuis le `site de version GitHub `__. +Étape 2 : Installation d'OpenSearch +----------------------------------- -Installation ------------- +Exécutez ``fess-setup`` en tant qu'utilisateur ordinaire, et non en tant que ``root`` : OpenSearch refuse de démarrer en tant que ``root``. -Extrayez le fichier fess-x.y.z.zip téléchargé. +.. code-block:: bash -:: + # Linux + bin/fess-setup install opensearch - $ unzip fess-x.y.z.zip - $ cd fess-x.y.z + # Windows + bin\fess-setup.bat install opensearch + +Cette commande télécharge la version d'OpenSearch prise en charge par ce Fess dans le répertoire ``opensearch/`` de Fess, +installe les quatre plugins nécessaires à Fess et ajoute à ``config/opensearch.yml`` les paramètres dont Fess a besoin. +``bin/fess`` trouve de lui-même cet OpenSearch : aucun fichier de configuration n'a besoin d'être modifié +tant qu'OpenSearch s'exécute sur le même hôte. + +.. warning:: + + La commande définit ``plugins.security.disabled: true`` ; OpenSearch accepte donc les requêtes sans + authentification. Par défaut, il n'écoute que sur l'adresse de bouclage (loopback) ; ne l'exposez pas + sur un réseau. Consultez :doc:`15.9/install/security` pour les paramètres de production. + +Pour l'ensemble des commandes (installation de Node.js et des plugins, ``check``), consultez :doc:`15.9/install/fess-setup`. + +Étape 3 : Démarrage d'OpenSearch et de Fess +------------------------------------------- + +Démarrez d'abord OpenSearch, puis Fess : + +.. code-block:: bash -Démarrage de Fess ------------------ + # Linux + opensearch/opensearch-3.9.0/bin/opensearch -d + bin/fess -Exécutez le script fess pour démarrer Fess. -(Sur Windows, veuillez exécuter fess.bat) +.. code-block:: bat -:: + :: Windows (exécutez chacune dans sa propre invite de commandes) + opensearch\opensearch-3.9.0\bin\opensearch.bat + bin\fess.bat - $ ./bin/fess +Attendez environ 30 secondes que Fess démarre, puis accédez à : -Accès à l'interface d'administration -------------------------------------- +- http://localhost:8080/ (Recherche) +- http://localhost:8080/admin (Administration - identifiants : admin/admin) -Accédez à \http://localhost:8080/admin. -Le nom d'utilisateur/mot de passe par défaut du compte administrateur est admin/admin. +Pour vérifier l'installation, exécutez ``bin/fess-setup check`` (``bin\fess-setup.bat check`` sous Windows). +La commande indique si OpenSearch est joignable et dispose des plugins nécessaires à Fess. .. warning:: @@ -136,6 +168,7 @@ Arrêt de Fess (ZIP) -------------------- Arrêtez le processus fess avec Ctrl-C ou la commande kill, etc. +Arrêtez ensuite OpenSearch de la même manière (``kill`` sur son processus, ou Ctrl-C s'il s'exécute au premier plan). ---- diff --git a/fr/setup.rst b/fr/setup.rst index 01c663d1c..4e40bbeb1 100644 --- a/fr/setup.rst +++ b/fr/setup.rst @@ -13,15 +13,16 @@ En utilisant Docker, vous pouvez facilement configurer Fess sur Windows, Mac, et 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 :doc:`15.6/install/index`. -Pour les exigences système, consultez :doc:`15.6/install/prerequisites`. +Si vous construisez un environnement de production, veuillez absolument consulter :doc:`15.9/install/index`. +Pour les exigences système, consultez :doc:`15.9/install/prerequisites`. .. warning:: **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. + Cette page décrit une configuration destinée à l'essai de Fess. Pour les environnements de production ou les tests de charge, + construisez un serveur OpenSearch dédié en vous référant à :doc:`15.9/install/install-docker` ou + :doc:`15.9/install/index`. Vue d'ensemble de la configuration ------------------------------------ @@ -184,11 +185,11 @@ Prochaines étapes Une fois Fess configuré, consultez la documentation suivante pour aller plus loin : -- :doc:`15.6/install/run` — Démarrage, arrêt et configuration détaillée -- :doc:`15.6/admin/index` — Guide administrateur (paramètres de crawl, gestion des utilisateurs, etc.) -- :doc:`15.6/user/index` — Guide utilisateur (comment effectuer des recherches) +- :doc:`15.9/install/run` — Démarrage, arrêt et configuration détaillée +- :doc:`15.9/admin/index` — Guide administrateur (paramètres de crawl, gestion des utilisateurs, etc.) +- :doc:`15.9/user/index` — Guide utilisateur (comment effectuer des recherches) -En cas de problème, consultez :doc:`15.6/install/troubleshooting`. +En cas de problème, consultez :doc:`15.9/install/troubleshooting`. .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png diff --git a/ja/15.9/config/setup-windows-service.rst b/ja/15.9/config/setup-windows-service.rst index f6dfe2961..a6330c227 100644 --- a/ja/15.9/config/setup-windows-service.rst +++ b/ja/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ OpenSearch へ接続するための設定を ``c:\opt\fess\bin\fess.in.bat`` に set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - ``fess.search_engine.http_address`` には、登録した OpenSearch サービスの接続先を指定します。この設定を行わない場合、|Fess| は接続先を見つけられず、本番環境では非推奨の埋め込み版 OpenSearch を起動します。 + - ``fess.search_engine.http_address`` には、登録した OpenSearch サービスの接続先を指定します。この設定を行わない場合、|Fess| は接続先を見つけられず、検索エンジンのアドレスが設定されていないことを報告して起動しません。 - OpenSearch を別のホストで実行している場合は、ホスト名または IP アドレスを適切に変更してください。 - パスの区切り文字には ``/`` を使用してください。 diff --git a/ja/quick-start.rst b/ja/quick-start.rst index 6212ec90d..d61440afa 100644 --- a/ja/quick-start.rst +++ b/ja/quick-start.rst @@ -23,10 +23,10 @@ Fess を利用するための最小限の手順を記述します。 - ZIP パッケージ * - 事前準備 - Docker と Docker Compose - - Java 21、OpenSearch + - Java 21（OpenSearch は ``fess-setup`` コマンドでインストールします） * - 起動の手軽さ - ◎ コマンド数行のみ - - △ 複数ソフトのインストールが必要 + - △ Java をインストールし、数個のセットアップコマンドを実行 * - こんな人に - まず試してみたい人 - Docker を使えない環境の人 @@ -76,9 +76,11 @@ Docker と Docker Compose がインストールされている場合、以下の ZIP パッケージを使った起動 ========================= -所要時間の目安：**初回 20〜30 分程度**\ （Java・OpenSearch のインストール時間を含む） +所要時間の目安：**初回 20〜30 分程度**\ （Java のインストールと OpenSearch のダウンロード時間を含む） Docker を使用しない場合は、以下の手順で ZIP パッケージから起動できます。 +Fess には検索エンジンが同梱されていないため、ZIP パッケージに含まれる ``fess-setup`` コマンドで +OpenSearch をダウンロードし、Fess に必要なプラグインをインストールします。 ここでの手順はお試し用の起動方法なので、運用向けの構築手順は、:doc:`インストール手順 ` などを参照してください。 （この手順で起動したFessは簡単な動作確認用としての利用を想定しており、この環境の運用は推奨していません） @@ -86,41 +88,75 @@ Docker を使用しない場合は、以下の手順で ZIP パッケージか 事前準備 -------- -Fessを起動する前に、以下のソフトウェアをインストールしておいてください。 +起動する前に Java 21 をインストールしてください。`Eclipse Temurin `__ の Java 21 を推奨します。 +OpenSearch を事前にインストールする必要はありません。ステップ 2 でインストールします。 -**1. Java 21 のインストール** +.. note:: -`Eclipse Temurin `__ の Java 21 を推奨します。 + OpenSearch の公式ビルドが提供されているのは Linux と Windows のみです。macOS では + ``fess-setup install opensearch`` はエラーで終了します。Docker（方法 1）を使用するか、 + Homebrew で OpenSearch をインストールする方法は :doc:`15.9/install/install-linux` を参照してください。 -**2. OpenSearch のインストールと起動** +ステップ 1: ダウンロードと展開 +------------------------------ -Fess のデータを保存するために OpenSearch が必要です。 -:doc:`インストール手順 ` を参照してインストールし、起動しておいてください。 +`GitHubのリリースサイト `__ から最新のFessのZIPパッケージをダウンロードし、 +展開してディレクトリに移動します。 -ダウンロード ------------- +:: -`GitHubのリリースサイト `__ から最新のFessのZIPパッケージをダウンロードします。 + $ unzip fess-x.y.z.zip + $ cd fess-x.y.z -インストール ------------- +ステップ 2: OpenSearch のインストール +------------------------------------- -ダウンロードした fess-x.y.z.zip を展開します。 +``fess-setup`` は ``root`` ではなく一般ユーザーで実行してください。OpenSearch は ``root`` では起動しません。 :: - $ unzip fess-x.y.z.zip - $ cd fess-x.y.z + # Linux + $ bin/fess-setup install opensearch + + # Windows + > bin\fess-setup.bat install opensearch + +このコマンドは、この Fess が対応するバージョンの OpenSearch を Fess ディレクトリ内の ``opensearch/`` にダウンロードし、 +Fess に必要な 4 つのプラグインをインストールして、Fess に必要な設定を ``config/opensearch.yml`` に追加します。 +``bin/fess`` はこの OpenSearch を自動的に見つけるため、OpenSearch を同じホストで実行する限り、設定ファイルを編集する必要はありません。 + +.. warning:: + + このコマンドは ``plugins.security.disabled: true`` を設定するため、OpenSearch は認証なしでリクエストを受け付けます。 + デフォルトではループバックアドレスのみで待ち受けます。ネットワークに公開しないでください。 + 本番環境向けの設定は :doc:`15.9/install/security` を参照してください。 -Fess の起動 ------------ +すべてのコマンド（Node.js やプラグインのインストール、``check`` など）については、:doc:`15.9/install/fess-setup` を参照してください。 -fess スクリプトを実行して Fess を起動します。 -（Windowsの場合は、fess.batを実行してください） +ステップ 3: OpenSearch と Fess の起動 +------------------------------------- + +先に OpenSearch を起動し、次に Fess を起動します。 :: - $ ./bin/fess + # Linux + $ opensearch/opensearch-3.9.0/bin/opensearch -d + $ bin/fess + +.. code-block:: bat + + :: Windows（それぞれ別のコマンドプロンプトで実行） + opensearch\opensearch-3.9.0\bin\opensearch.bat + bin\fess.bat + +Fess の起動まで 30 秒ほど待ってから、以下にアクセスします。 + +- http://localhost:8080/ （検索画面） +- http://localhost:8080/admin （管理画面 - ログイン: admin/admin） + +インストールを確認するには、``bin/fess-setup check`` を実行します（Windows では ``bin\fess-setup.bat check``）。 +OpenSearch に接続できるか、Fess に必要なプラグインが入っているかを報告します。 管理 UI にアクセス ------------------ @@ -137,6 +173,7 @@ Fess の停止（ZIP版） -------------------- Ctrl-C や kill コマンド等で fess のプロセスを停止します。 +続けて、OpenSearch も同様に停止します（プロセスを ``kill`` するか、フォアグラウンドで実行している場合は Ctrl-C）。 ---- diff --git a/ja/setup.rst b/ja/setup.rst index 008c7f04b..cb333cd36 100644 --- a/ja/setup.rst +++ b/ja/setup.rst @@ -14,15 +14,16 @@ Dockerを利用することで、WindowsやMacなどでも、Fessを簡単にセ Linux や macOS をご利用の方も同様の手順でセットアップできますが、Docker Desktop のインストール手順は異なります。 詳細は `Docker `_ のドキュメントを参照してください。 -本番環境を構築する場合は、必ず :doc:`15.6/install/index` を参照してください。 -また、システム要件については :doc:`15.6/install/prerequisites` を確認してください。 +本番環境を構築する場合は、必ず :doc:`15.9/install/index` を参照してください。 +また、システム要件については :doc:`15.9/install/prerequisites` を確認してください。 .. warning:: **本番環境での重要な注意事項** - 本番環境や負荷検証などでは、組み込み OpenSearch での稼働は推奨しません。 - 必ず外部の OpenSearch サーバーを構築してください。 + このページは Fess を試すためのセットアップ手順です。本番環境や負荷検証などでは、 + :doc:`15.9/install/install-docker` または :doc:`15.9/install/index` を参照して、 + 専用の OpenSearch サーバーを構築してください。 セットアップの流れ ------------------ @@ -185,11 +186,11 @@ Fessの停止は、Fessを起動したフォルダーで、以下のコマンド Fessのセットアップが完了したら、以下のドキュメントを参照してFessを活用してください。 -- :doc:`15.6/install/run` — Fessの起動・停止・設定の詳細 -- :doc:`15.6/admin/index` — 管理者向けガイド（クロール設定、ユーザー管理など） -- :doc:`15.6/user/index` — ユーザーガイド（検索の使い方） +- :doc:`15.9/install/run` — Fessの起動・停止・設定の詳細 +- :doc:`15.9/admin/index` — 管理者向けガイド（クロール設定、ユーザー管理など） +- :doc:`15.9/user/index` — ユーザーガイド（検索の使い方） -問題が発生した場合は、 :doc:`15.6/install/troubleshooting` を参照してください。 +問題が発生した場合は、 :doc:`15.9/install/troubleshooting` を参照してください。 .. |image0| image:: ../resources/images/ja/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/ja/install/dockerdesktop-2.png diff --git a/ko/15.9/config/setup-windows-service.rst b/ko/15.9/config/setup-windows-service.rst index 6b1dde19b..59f9c993a 100644 --- a/ko/15.9/config/setup-windows-service.rst +++ b/ko/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ OpenSearch에 연결하기 위한 설정을 ``c:\opt\fess\bin\fess.in.bat`` 에 set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - ``fess.search_engine.http_address`` 에는 등록한 OpenSearch 서비스의 연결 대상을 지정합니다. 이 설정을 하지 않으면 |Fess| 는 연결 대상을 찾지 못하고 프로덕션 환경에서는 권장하지 않는 내장 OpenSearch를 시작합니다. + - ``fess.search_engine.http_address`` 에는 등록한 OpenSearch 서비스의 연결 대상을 지정합니다. 이 설정을 하지 않으면 |Fess| 는 연결 대상을 찾지 못해 시작되지 않으며, 검색 엔진 주소가 설정되어 있지 않다는 내용을 보고합니다. - OpenSearch를 다른 호스트에서 실행하는 경우 호스트명 또는 IP 주소를 적절히 변경하십시오. - 경로 구분 문자는 ``/`` 를 사용하십시오. diff --git a/ko/quick-start.rst b/ko/quick-start.rst index cbc9cb32a..a7590d25b 100644 --- a/ko/quick-start.rst +++ b/ko/quick-start.rst @@ -21,10 +21,10 @@ Fess는 웹사이트와 파일 서버를 대상으로 크롤(순회)하고, 수 - ZIP 패키지 * - 사전 준비 - Docker와 Docker Compose - - Java 21, OpenSearch + - Java 21 (OpenSearch는 ``fess-setup`` 명령으로 설치) * - 시작의 간편함 - ◎ 명령 몇 줄만으로 가능 - - △ 여러 소프트웨어 설치 필요 + - △ Java 설치 후 몇 가지 설정 명령 실행 * - 이런 분에게 - 먼저 시도해보고 싶은 분 - Docker를 사용할 수 없는 환경의 분 @@ -77,9 +77,11 @@ Docker는 Fess를 가장 빠르고 안정적으로 실행하는 방법을 제공 ZIP 패키지로 시작 ================== -소요 시간 목표: **초회 20〜30분 정도** (Java·OpenSearch 설치 시간 포함) +소요 시간 목표: **초회 20〜30분 정도** (Java 설치 및 OpenSearch 다운로드 시간 포함) Docker를 사용하지 않는 경우 ZIP 패키지에서 직접 Fess를 실행할 수 있습니다. +Fess에는 검색 엔진이 포함되어 있지 않으므로, ZIP 패키지에 포함된 ``fess-setup`` 명령으로 +OpenSearch를 다운로드하고 Fess에 필요한 플러그인을 설치합니다. .. note:: @@ -87,43 +89,69 @@ Docker를 사용하지 않는 경우 ZIP 패키지에서 직접 Fess를 실행 (이 절차로 시작한 Fess는 간단한 동작 확인용으로서의 이용을 상정하고 있으며 이 환경의 운용은 권장하지 않습니다) 사전 준비 --------- +--------- -Fess를 시작하기 전에 다음 소프트웨어를 설치해두세요. +시작하기 전에 Java 21을 설치해두세요. Java 21은 `Eclipse Temurin `__ 을 권장합니다. +OpenSearch는 미리 설치할 필요가 없습니다. Step 2에서 설치합니다. -**1. Java 21 설치** +.. note:: -Java 21은 `Eclipse Temurin `__ 을 권장합니다. + OpenSearch는 Linux와 Windows용 공식 빌드만 공개하고 있습니다. macOS에서는 + ``fess-setup install opensearch`` 가 오류로 종료되므로 Docker(방법 1)를 이용하거나, + Homebrew로 OpenSearch를 설치하는 방법은 :doc:`15.9/install/install-linux` 를 참조하세요. -**2. OpenSearch 설치 및 시작** +Step 1: 다운로드 및 압축 해제 +----------------------------- -Fess의 데이터를 저장하기 위해 OpenSearch가 필요합니다. -:doc:`설치 절차 ` 를 참조하여 설치하고 시작해주세요. +`GitHub 릴리스 사이트 `__ 에서 최신 Fess의 ZIP 패키지를 다운로드하고 +압축을 해제한 후 해당 디렉터리로 이동합니다: -다운로드 --------- +.. code-block:: bash -`GitHub 릴리스 사이트 `__ 에서 최신 Fess의 ZIP 패키지를 다운로드합니다. + unzip fess-x.y.z.zip + cd fess-x.y.z -설치 --------- +Step 2: OpenSearch 설치 +----------------------- -다운로드한 fess-x.y.z.zip을 압축 해제합니다. +``fess-setup`` 은 ``root`` 가 아닌 일반 사용자로 실행하세요. OpenSearch는 ``root`` 로는 시작되지 않습니다. .. code-block:: bash - unzip fess-x.y.z.zip - cd fess-x.y.z + # Linux + bin/fess-setup install opensearch -Fess 시작 ---------- + # Windows + bin\fess-setup.bat install opensearch + +이 명령은 이 Fess가 지원하는 버전의 OpenSearch를 Fess 디렉터리 아래의 ``opensearch/`` 에 다운로드하고, +Fess에 필요한 플러그인 4개를 설치하며, Fess에 필요한 설정을 ``config/opensearch.yml`` 에 추가합니다. +``bin/fess`` 는 이 OpenSearch를 자동으로 찾으므로, OpenSearch가 같은 호스트에서 실행되는 한 +설정 파일을 편집할 필요가 없습니다. + +.. warning:: + + 이 명령은 ``plugins.security.disabled: true`` 를 설정하므로 OpenSearch는 인증 없이 요청을 받아들입니다. + 기본적으로 루프백 주소에서만 수신하지만 네트워크에 공개하지 마세요. + 프로덕션 환경의 설정은 :doc:`15.9/install/security` 를 참조하세요. + +모든 명령(Node.js 및 플러그인 설치, ``check``)에 대해서는 :doc:`15.9/install/fess-setup` 를 참조하세요. + +Step 3: OpenSearch와 Fess 시작 +------------------------------ + +먼저 OpenSearch를 시작한 후 Fess를 시작합니다: .. code-block:: bash - # Linux/Mac - ./bin/fess + # Linux + opensearch/opensearch-3.9.0/bin/opensearch -d + bin/fess - # Windows +.. code-block:: bat + + :: Windows (각각 별도의 명령 프롬프트에서 실행) + opensearch\opensearch-3.9.0\bin\opensearch.bat bin\fess.bat 약 30초 후 다음 주소에 접속할 수 있습니다: @@ -131,6 +159,9 @@ Fess 시작 - http://localhost:8080/ (검색) - http://localhost:8080/admin (관리 화면 - 로그인: admin/admin) +설치를 확인하려면 ``bin/fess-setup check`` (Windows에서는 ``bin\fess-setup.bat check``)를 실행하세요. +OpenSearch에 접속할 수 있는지, Fess에 필요한 플러그인이 있는지를 보고합니다. + .. warning:: 기본 비밀번호는 반드시 변경하세요. @@ -140,6 +171,7 @@ Fess 정지 (ZIP) --------------- Ctrl-C나 kill 명령 등으로 fess 프로세스를 정지합니다. +이어서 OpenSearch도 같은 방법으로 정지합니다 (프로세스를 ``kill`` 하거나, 포그라운드에서 실행 중이면 ``Ctrl+C``). ---- diff --git a/ko/setup.rst b/ko/setup.rst index b6a84042c..665b4cf87 100644 --- a/ko/setup.rst +++ b/ko/setup.rst @@ -13,15 +13,16 @@ Docker를 이용하면 Windows나 Mac 등에서도 Fess를 간단히 설정할 이 페이지는 **Windows에서 Docker를 사용한 설치 절차**\ 를 설명합니다. Linux나 macOS 사용자도 비슷한 절차로 설치할 수 있지만, Docker Desktop 설치 방법은 플랫폼에 따라 다릅니다. 자세한 내용은 `Docker `_ 문서를 참조하세요. -운용 환경을 구축하는 경우 반드시 :doc:`15.6/install/index` 를 참조하세요. -시스템 요구 사항은 :doc:`15.6/install/prerequisites` 를 확인하세요. +운용 환경을 구축하는 경우 반드시 :doc:`15.9/install/index` 를 참조하세요. +시스템 요구 사항은 :doc:`15.9/install/prerequisites` 를 확인하세요. .. warning:: **프로덕션 환경에서의 중요한 주의사항** - 프로덕션 환경이나 부하 검증 등에서는 내장 OpenSearch 가동은 권장하지 않습니다. - 반드시 외부 OpenSearch 서버를 구축하세요. + 이 페이지는 Fess를 시험해 보기 위한 설치 절차를 설명합니다. 프로덕션 환경이나 부하 검증 등에서는 + :doc:`15.9/install/install-docker` 또는 :doc:`15.9/install/index` 를 참조하여 + 전용 OpenSearch 서버를 구축하세요. 설정 개요 ---------- @@ -184,11 +185,11 @@ Fess 정지는 Fess를 시작한 폴더에서 다음 명령을 실행합니다: Fess 설정이 완료되었으면 다음 문서를 참조하여 Fess를 활용하세요: -- :doc:`15.6/install/run` — Fess 시작·정지·설정 상세 -- :doc:`15.6/admin/index` — 관리자 가이드 (크롤 설정, 사용자 관리 등) -- :doc:`15.6/user/index` — 사용자 가이드 (검색 사용법) +- :doc:`15.9/install/run` — Fess 시작·정지·설정 상세 +- :doc:`15.9/admin/index` — 관리자 가이드 (크롤 설정, 사용자 관리 등) +- :doc:`15.9/user/index` — 사용자 가이드 (검색 사용법) -문제가 발생한 경우 :doc:`15.6/install/troubleshooting` 을 참조하세요. +문제가 발생한 경우 :doc:`15.9/install/troubleshooting` 을 참조하세요. .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png diff --git a/zh-cn/15.9/config/setup-windows-service.rst b/zh-cn/15.9/config/setup-windows-service.rst index 566eb9f85..61b9ad879 100644 --- a/zh-cn/15.9/config/setup-windows-service.rst +++ b/zh-cn/15.9/config/setup-windows-service.rst @@ -43,7 +43,7 @@ set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=c:/opt/opensearch/config/dictionary/ .. note:: - - ``fess.search_engine.http_address`` 用于指定已注册的 OpenSearch 服务的连接地址。若不进行此配置，|Fess| 将无法找到连接目标，并会启动不推荐在生产环境中使用的内嵌版 OpenSearch。 + - ``fess.search_engine.http_address`` 用于指定已注册的 OpenSearch 服务的连接地址。若不进行此配置，|Fess| 将无法找到连接目标而不会启动，并报告未配置搜索引擎地址。 - 若 OpenSearch 运行在其他主机上，请将主机名或 IP 地址修改为适当的值。 - 路径分隔符请使用 ``/``\ 。 diff --git a/zh-cn/quick-start.rst b/zh-cn/quick-start.rst index ddc059167..7bc071f24 100644 --- a/zh-cn/quick-start.rst +++ b/zh-cn/quick-start.rst @@ -21,10 +21,10 @@ Fess 是一款开源全文检索服务器，可对网站和文件服务器进行 - ZIP 包 * - 事前准备 - Docker 和 Docker Compose - - Java 21、OpenSearch + - Java 21（OpenSearch 通过 ``fess-setup`` 命令安装） * - 启动便捷性 - ◎ 仅需几条命令 - - △ 需要安装多个软件 + - △ 安装 Java 后，执行几条设置命令 * - 适合人群 - 想先试试的用户 - 无法使用 Docker 环境的用户 @@ -75,9 +75,11 @@ Docker 提供了最快、最可靠的 Fess 运行方式。所有依赖都已打 使用 ZIP 包启动 ================ -所需时间目标：**首次 20〜30 分钟左右**\ （包含 Java·OpenSearch 安装时间） +所需时间目标：**首次 20〜30 分钟左右**\ （包含 Java 安装和 OpenSearch 下载时间） 如果您不使用 Docker，可以通过 ZIP 包直接运行 Fess。 +Fess 不内置搜索引擎，ZIP 包中附带的 ``fess-setup`` 命令会下载 OpenSearch， +并安装 Fess 所需的插件。 这里的步骤是用于试用的启动方法，关于面向运营的构建步骤，请参考使用 Docker 的 :doc:`安装步骤 ` 等。 （此处启动的 Fess 是用于简单的功能确认，不推荐在此环境下进行运营） @@ -85,41 +87,68 @@ Docker 提供了最快、最可靠的 Fess 运行方式。所有依赖都已打 前期准备 -------- -在启动 Fess 之前，请先安装以下软件。 +启动前请先安装 Java 21。推荐使用 `Eclipse Temurin `__ 的 Java 21。 +无需事先安装 OpenSearch：步骤 2 会进行安装。 -**1. 安装 Java 21** +.. note:: -推荐使用 `Eclipse Temurin `__ 的 Java 21。 + OpenSearch 仅为 Linux 和 Windows 提供官方构建。在 macOS 上， + ``fess-setup install opensearch`` 会以错误退出；请使用 Docker（方法 1），或参阅 + :doc:`15.9/install/install-linux` 了解使用 Homebrew 安装 OpenSearch 的方法。 -**2. 安装并启动 OpenSearch** +步骤 1：下载并解压 +------------------ -Fess 需要 OpenSearch 来存储数据。 -请参考 :doc:`安装步骤 ` 进行安装并启动。 +从 `GitHub 发布站点 `__ 下载最新的 Fess ZIP 包， +解压后进入该目录。 -下载 ----- +:: -从 `GitHub 发布站点 `__ 下载最新的 Fess ZIP 包。 + $ unzip fess-x.y.z.zip + $ cd fess-x.y.z -安装 ----- +步骤 2：安装 OpenSearch +----------------------- -解压下载的 fess-x.y.z.zip。 +请以普通用户而非 ``root`` 身份执行 ``fess-setup``：OpenSearch 无法以 ``root`` 身份启动。 :: - $ unzip fess-x.y.z.zip - $ cd fess-x.y.z + # Linux + $ bin/fess-setup install opensearch + + # Windows + > bin\fess-setup.bat install opensearch -启动 Fess ------------ +该命令会将此 Fess 所支持版本的 OpenSearch 下载到 Fess 目录下的 ``opensearch/``， +安装 Fess 所需的四个插件，并将 Fess 需要的设置添加到 ``config/opensearch.yml`` 中。 +``bin/fess`` 会自动找到该 OpenSearch，因此只要 OpenSearch 运行在同一主机上， +就无需编辑任何配置文件。 -执行 fess 脚本启动 Fess。 -（在 Windows 的情况下，请执行 fess.bat） +.. warning:: + + 该命令会设置 ``plugins.security.disabled: true``，因此 OpenSearch 无需认证即可接受请求。 + 默认情况下它仅监听回环地址；请勿将其暴露到网络中。 + 有关生产环境的设置，请参阅 :doc:`15.9/install/security`。 + +有关所有命令（安装 Node.js 和插件、``check``），请参阅 :doc:`15.9/install/fess-setup`。 + +步骤 3：启动 OpenSearch 和 Fess +------------------------------- + +请先启动 OpenSearch，再启动 Fess： :: - $ ./bin/fess + # Linux + $ opensearch/opensearch-3.9.0/bin/opensearch -d + $ bin/fess + +.. code-block:: bat + + :: Windows（请分别在各自的命令提示符中执行） + opensearch\opensearch-3.9.0\bin\opensearch.bat + bin\fess.bat 访问管理界面 ------------ @@ -127,6 +156,9 @@ Fess 需要 OpenSearch 来存储数据。 访问 \http://localhost:8080/admin。 默认管理员账户的用户名/密码为 admin/admin。 +如需确认安装情况，请执行 ``bin/fess-setup check``\ （在 Windows 上为 ``bin\fess-setup.bat check``）。 +它会报告 OpenSearch 是否可以连接，以及是否已安装 Fess 所需的插件。 + .. warning:: 请务必更改默认密码。 @@ -136,6 +168,7 @@ Fess 需要 OpenSearch 来存储数据。 -------------------- 使用 Ctrl-C 或 kill 命令等停止 fess 进程。 +然后以同样的方式停止 OpenSearch（使用 ``kill`` 终止其进程，如果它在前台运行，则使用 ``Ctrl+C``）。 ---- diff --git a/zh-cn/setup.rst b/zh-cn/setup.rst index 547bfb754..e727449e2 100644 --- a/zh-cn/setup.rst +++ b/zh-cn/setup.rst @@ -13,15 +13,16 @@ Fess 提供 ZIP 归档、RPM/DEB 包、Docker 镜像的分发包。 本页面说明在 **Windows 上使用 Docker 的安装步骤**\ 。Linux 或 macOS 用户也可以按照类似步骤进行安装，但 Docker Desktop 的安装方式因平台而异。 详情请参考 `Docker `_ 的文档。 -构建运营环境时，请务必参考 :doc:`15.6/install/index`。 -有关系统要求，请参阅 :doc:`15.6/install/prerequisites`。 +构建运营环境时，请务必参考 :doc:`15.9/install/index`。 +有关系统要求，请参阅 :doc:`15.9/install/prerequisites`。 .. warning:: **生产环境的重要注意事项** - 在生产环境或负载验证等情况下，不推荐使用内置的 OpenSearch 运行。 - 请务必构建外部的 OpenSearch 服务器。 + 本页面介绍的是用于试用 Fess 的安装步骤。在生产环境或负载验证等情况下， + 请参考 :doc:`15.9/install/install-docker` 或 + :doc:`15.9/install/index`，构建专用的 OpenSearch 服务器。 设置流程概述 ------------ @@ -184,11 +185,11 @@ Fess 提供 ZIP 归档、RPM/DEB 包、Docker 镜像的分发包。 Fess 设置完成后，请参考以下文档进一步使用 Fess： -- :doc:`15.6/install/run` — Fess 启动·停止·配置详情 -- :doc:`15.6/admin/index` — 管理员指南（爬虫设置、用户管理等） -- :doc:`15.6/user/index` — 用户指南（如何搜索） +- :doc:`15.9/install/run` — Fess 启动·停止·配置详情 +- :doc:`15.9/admin/index` — 管理员指南（爬虫设置、用户管理等） +- :doc:`15.9/user/index` — 用户指南（如何搜索） -如果遇到问题，请参考 :doc:`15.6/install/troubleshooting`。 +如果遇到问题，请参考 :doc:`15.9/install/troubleshooting`。 .. |image0| image:: ../resources/images/en/install/dockerdesktop-1.png .. |image1| image:: ../resources/images/en/install/dockerdesktop-2.png