Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion de/15.9/config/setup-windows-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
75 changes: 55 additions & 20 deletions de/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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::

Expand All @@ -89,45 +91,77 @@ 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 <https://adoptium.net/temurin>`__ Java 21.
OpenSearch muss nicht vorab installiert werden: Schritt 2 installiert es.

**1. Java 21 installieren**

Wir empfehlen `Eclipse Temurin <https://adoptium.net/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 <setup>`.
.. 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 <https://github.com/codelibs/fess/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 <https://github.com/codelibs/fess/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:

- 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,
Expand All @@ -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).

----

Expand Down
17 changes: 9 additions & 8 deletions de/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.docker.com/get-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
---------------
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion en/15.9/config/setup-windows-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
75 changes: 55 additions & 20 deletions en/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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::

Expand All @@ -89,45 +91,77 @@ 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 <https://adoptium.net/temurin>`__ Java 21.
OpenSearch does not need to be installed in advance: Step 2 installs it.

**1. Install Java 21**

We recommend `Eclipse Temurin <https://adoptium.net/temurin>`__ Java 21.

**2. Install and Start OpenSearch**

OpenSearch is required to store Fess data.
Please refer to :doc:`Installation Guide <setup>` 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 <https://github.com/codelibs/fess/releases>`__
Step 1: Download and Extract
----------------------------

2. Extract and enter the directory:
Download the latest ZIP package from `GitHub Releases <https://github.com/codelibs/fess/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:

- 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
Expand All @@ -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).

----

Expand Down
17 changes: 9 additions & 8 deletions en/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.docker.com/get-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
--------------
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion es/15.9/config/setup-windows-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading
Loading