diff --git a/de/15.10/admin/badword-guide.rst b/de/15.10/admin/badword-guide.rst index 04a996b6a..84e8ca140 100644 --- a/de/15.10/admin/badword-guide.rst +++ b/de/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ Schlechtes Wort Registrieren Sie unerwünschte Wörter. Wörter, die hier registriert sind, werden nicht in den Vorschlägen angezeigt. +.. note:: + Ein registriertes unerwünschtes Wort wird nicht sofort auf die Vorschläge angewendet. Es wird aus den vorhandenen Vorschlagskandidaten entfernt, wenn der Job „Suggest Indexer" läuft, der den Vorschlagsindex neu aufbaut (standardmäßig täglich um 12:00 Uhr). Um es sofort anzuwenden, klicken Sie unter [System > Scheduler] auf „Suggest Indexer" und dann auf die Schaltfläche „Jetzt starten". Dasselbe gilt für Wörter, die per CSV-Upload registriert wurden. + Konfiguration löschen --------------------- diff --git a/de/15.10/admin/elevateword-guide.rst b/de/15.10/admin/elevateword-guide.rst index 89e3426a4..0380a27ee 100644 --- a/de/15.10/admin/elevateword-guide.rst +++ b/de/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ Berechtigung Legen Sie Rolleninformationen für das Wort fest. Nur Benutzer mit der festgelegten Rolle können das Wort in den Vorschlägen sehen. +Für Benutzerebene geben Sie {user}Benutzername an, für Rollenebene {role}Rollenname und für Gruppenebene {group}Gruppenname. Label ::::: @@ -56,6 +57,9 @@ Boost-Wert Legen Sie einen Boost-Wert für das Wort fest. +.. note:: + Registrierte, bearbeitete oder gelöschte zusätzliche Wörter (auch per CSV-Upload) werden nicht sofort auf die Vorschläge angewendet. Sie werden übernommen, wenn der Job „Suggest Indexer" läuft, der den Vorschlagsindex neu aufbaut (standardmäßig täglich um 12:00 Uhr). Um sie sofort zu übernehmen, klicken Sie unter [System > Scheduler] auf „Suggest Indexer" und dann auf die Schaltfläche „Jetzt starten". + Konfiguration löschen --------------------- @@ -78,8 +82,8 @@ Ab Zeile 2 werden die zusätzlichen Wörter aufgeführt. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" Upload ====== @@ -96,8 +100,11 @@ Ab Zeile 2 beschreiben Sie die zusätzlichen Wörter. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + Geben Sie in der Spalte „Permissions" jeden Wert mit ``{role}``, ``{user}`` oder ``{group}`` an, etwa ``{role}role1`` (mehrere Werte durch Kommas trennen). Ein Wert ohne Präfix wie ``role1`` wird nicht als Rolle behandelt, und das Wort wird Benutzern mit dieser Rolle nicht vorgeschlagen. .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/de/15.10/admin/fileconfig-guide.rst b/de/15.10/admin/fileconfig-guide.rst index d4b859de2..14b0baa46 100644 --- a/de/15.10/admin/fileconfig-guide.rst +++ b/de/15.10/admin/fileconfig-guide.rst @@ -55,6 +55,9 @@ Zu crawlender Pfad Pfade, die mit dem regulären Ausdruck (Java-Format) übereinstimmen, der in diesem Element angegeben ist, werden vom |Fess| Crawler gecrawlt. +.. note:: + Das Muster wird auf den gesamten Pfad jedes vom Crawler besuchten Pfads angewendet, einschließlich des Startpfads und der Unterverzeichnisse. Geben Sie nur Dateiendungen wie ``.*\.(md|rst|adoc)$`` an, passen der Startpfad und die Unterverzeichnisse nicht zum Muster, der Crawler erreicht die Dateien nicht und es wird nichts gecrawlt. Um die Dokumente nach Dateiendung einzugrenzen, geben Sie dasselbe Muster stattdessen unter „Zu durchsuchender Pfad" an (die Verzeichnisse werden weiterhin durchlaufen, und nur die passenden Dateien werden durchsucht). Verwenden Sie „Zu crawlender Pfad" nur mit Mustern, die auch zum Startpfad und zu den Unterverzeichnissen passen. + Vom Crawlen ausgeschlossener Pfad :::::::::::::::::::::::::::::::::: diff --git a/de/15.10/config/admin-index-export.rst b/de/15.10/config/admin-index-export.rst index 5a308a499..1ba422fb3 100644 --- a/de/15.10/config/admin-index-export.rst +++ b/de/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ Konfigurationsbeispiel: index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + Der Standardwert ``/var/lib/fess/export`` ist das Verzeichnis der RPM/DEB-Pakete. Er ist nicht beschreibbar, wenn die ZIP-Version als normaler Benutzer ausgeführt wird. Ändern Sie daher ``index.export.path`` in ein Verzeichnis, in das der Benutzer, unter dem |Fess| läuft, schreiben kann. Kann das Verzeichnis nicht erstellt oder nicht beschrieben werden, schlägt der Job mit dem Fehler ``Cannot write to the index export directory: index.export.path=...`` fehl. + Job aktivieren ============== @@ -193,7 +196,7 @@ Best Practices Speicherüberlegungen -------------------- -- Geben Sie für ``index.export.path`` ein Verzeichnis an, in das der Benutzer, unter dem |Fess| läuft, schreiben kann (der Standardwert ``/var/lib/fess/export`` ist ein Verzeichnis der RPM/DEB-Version und ist nicht beschreibbar, wenn die ZIP-Version als normaler Benutzer ausgeführt wird. Ist das Verzeichnis nicht beschreibbar, werden keine Exportdateien erstellt und in ``fess.log`` wird pro Dokument eine Warnung ausgegeben) +- Geben Sie für ``index.export.path`` ein Verzeichnis an, in das der Benutzer, unter dem |Fess| läuft, schreiben kann (der Standardwert ``/var/lib/fess/export`` ist ein Verzeichnis der RPM/DEB-Version und ist nicht beschreibbar, wenn die ZIP-Version als normaler Benutzer ausgeführt wird. Ist das Verzeichnis nicht beschreibbar, schlägt der Job mit dem Fehler ``Cannot write to the index export directory`` fehl und es werden keine Exportdateien erstellt) - Stellen Sie ausreichend Speicherplatz im Export-Verzeichnis sicher - Erwägen Sie dedizierten Speicher für große Dokumentenmengen - Implementieren Sie bei regelmäßigen Exporten eine periodische Bereinigung alter Exporte diff --git a/de/15.10/config/setup-memory.rst b/de/15.10/config/setup-memory.rst index a8df6f235..47fa024d5 100644 --- a/de/15.10/config/setup-memory.rst +++ b/de/15.10/config/setup-memory.rst @@ -269,8 +269,8 @@ Best Practices Konsultieren Sie die offizielle OpenSearch-Dokumentation für optimale umgebungsspezifische Einstellungen. -Speicherkonfiguration für Vorschlag- und Thumbnail-Verarbeitung -====================================== +Speicherkonfiguration für Vorschlag-, Chunk- und Thumbnail-Verarbeitung +======================================================================= Vorschlags-Generierungsprozess ---------------------- @@ -285,6 +285,22 @@ Standardmäßig werden folgende Einstellungen verwendet: - Maximaler Heap: 256 MB - Maximaler Metaspace: 128 MB +Content-Chunk-Generierungsprozess +--------------------------------- + +Die Speicherkonfiguration für die Content-Chunk-Verarbeitung (Vektorerzeugung für die semantische Suche) wird über ``jvm.chunk.options`` konfiguriert. + +Wie beim Crawler enthält diese Einstellung alle Standardoptionen. Ändern Sie daher nur die Zeile ``-Xmx1g`` und behalten Sie die übrigen bei. + +Standardmäßig werden folgende Einstellungen verwendet: + +- Initialer Heap: 128 MB +- Maximaler Heap: 1 GB +- Maximaler Metaspace: 128 MB + +.. note:: + Bei großen Korpora muss der maximale Heap erhöht werden. Einzelheiten finden Sie unter :doc:`search-semantic`. + Thumbnail-Generierungsprozess ---------------------- diff --git a/de/15.10/config/setup-port-network.rst b/de/15.10/config/setup-port-network.rst index ff7115906..b1ac7ffa9 100644 --- a/de/15.10/config/setup-port-network.rst +++ b/de/15.10/config/setup-port-network.rst @@ -391,6 +391,9 @@ Konfigurationsbeispiel für SSL/TLS-Terminierung am Reverse-Proxy (Nginx): } } +.. note:: + Die Weitergabe des Headers ``X-Forwarded-Proto`` ändert nicht das Schema, mit dem |Fess| absolute URLs bildet (zum Beispiel im OpenSearch-Beschreibungsdokument und im SAML-Ziel). Das Schema wird durch die Connector-Einstellungen bestimmt. Setzen Sie ``tomcat.secure=true``, ``tomcat.scheme=https`` und ``tomcat.proxyPort=443`` in ``tomcat_config.properties`` (standardmäßig auskommentiert), lassen Sie den Reverse-Proxy den ursprünglichen ``Host``-Header unverändert weitergeben und starten Sie |Fess| neu. + Firewall-Konfiguration ==================== @@ -457,7 +460,7 @@ Fehlfunktion beim Zugriff über Reverse-Proxy ---------------------------------------------------- 1. Überprüfen Sie, ob der Header ``X-Forwarded-Host`` korrekt konfiguriert ist. -2. Überprüfen Sie, ob der Header ``X-Forwarded-Proto`` korrekt konfiguriert ist. +2. Überprüfen Sie, ob der Header ``X-Forwarded-Proto`` korrekt konfiguriert ist. Dieser Header allein ändert das Schema der absoluten URLs, die |Fess| bildet, nicht; zusätzlich sind ``tomcat.secure``, ``tomcat.scheme`` und ``tomcat.proxyPort`` erforderlich (siehe den Hinweis im Abschnitt SSL/TLS-Terminierung oben). 3. Überprüfen Sie, ob der Kontextpfad korrekt konfiguriert ist. 4. Überprüfen Sie Fehler im Reverse-Proxy-Protokoll. diff --git a/en/15.10/admin/badword-guide.rst b/en/15.10/admin/badword-guide.rst index f4ac7f8ff..dd7c932eb 100644 --- a/en/15.10/admin/badword-guide.rst +++ b/en/15.10/admin/badword-guide.rst @@ -34,6 +34,9 @@ Bad Word Word to exclude it from Suggest. +.. note:: + A registered bad word is not applied to Suggest immediately. It is removed from the existing suggest candidates when the "Suggest Indexer" job, which rebuilds the suggest index, runs (by default it runs every day at 12:00). To apply it right away, click "Suggest Indexer" in [System > Scheduler] and click the Start Now button. The same applies to words registered by uploading a CSV file. + Delete Configuration -------------------- diff --git a/en/15.10/admin/elevateword-guide.rst b/en/15.10/admin/elevateword-guide.rst index c7736a0ec..371704e19 100644 --- a/en/15.10/admin/elevateword-guide.rst +++ b/en/15.10/admin/elevateword-guide.rst @@ -45,6 +45,7 @@ Permissions Roles to restrict suggesting. If roles are specified, suggest word is displayed in users which has roles. +User-level: {user}username, Role-level: {role}rolename, Group-level: {group}groupname. Label ::::: @@ -58,6 +59,9 @@ Boost Boost value. Higher value is displayed at the top. +.. note:: + Words that you register, edit or delete (including by uploading a CSV file) are not applied to Suggest immediately. They are applied when the "Suggest Indexer" job, which rebuilds the suggest index, runs (by default it runs every day at 12:00). To apply them right away, click "Suggest Indexer" in [System > Scheduler] and click the Start Now button. + Delete Configuration -------------------- @@ -84,6 +88,14 @@ CSV File The content of downloaded/uploaded CSV file is 5 column. +:: + + "SuggestWord","Reading","Permissions","Labels","Boost" + "fess","ふぇす","{role}role1","label1","100" + +.. note:: + In the Permissions column, specify each value with one of ``{role}``, ``{user}`` and ``{group}``, such as ``{role}role1`` (separate multiple values with commas). A value without a prefix, such as ``role1``, is not treated as a role, and the word is not suggested to users who have that role. + .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/en/15.10/admin/fileconfig-guide.rst b/en/15.10/admin/fileconfig-guide.rst index 117cb75ad..5e51ae8ae 100644 --- a/en/15.10/admin/fileconfig-guide.rst +++ b/en/15.10/admin/fileconfig-guide.rst @@ -55,6 +55,9 @@ Included Paths for Crawling Paths matching this regular expression (Java format) will be crawled by the |Fess| crawler. +.. note:: + The pattern is matched against the whole of every path the crawler visits, including the start path and subdirectories. If you specify only file extensions such as ``.*\.(md|rst|adoc)$``, the start path and the subdirectories do not match, the crawler cannot reach the files, and nothing is crawled. To limit the documents by extension, specify the same pattern in "Included Paths for Indexing" instead (the directories are still traversed and only the matching files become search targets). Use "Included Paths for Crawling" only with patterns that also match the start path and the subdirectories. + Excluded Paths for Crawling :::::::::::::::::::::::::::: diff --git a/en/15.10/config/admin-index-export.rst b/en/15.10/config/admin-index-export.rst index a73c31bdf..714544f90 100644 --- a/en/15.10/config/admin-index-export.rst +++ b/en/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ Example configuration: index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + The default ``/var/lib/fess/export`` is the directory of the RPM/DEB packages. It is not writable when the ZIP distribution is run as a regular user, so change ``index.export.path`` to a directory that the user running |Fess| can write to. If the directory cannot be created or written to, the job fails with the error ``Cannot write to the index export directory: index.export.path=...``. + Enabling the Job ================ @@ -193,7 +196,7 @@ Best Practices Storage Considerations ---------------------- -- Set ``index.export.path`` to a directory that the user running |Fess| can write to (the default ``/var/lib/fess/export`` is the RPM/DEB directory and is not writable when the ZIP distribution is run as a regular user; if it is not writable, no export files are created and a warning is written to ``fess.log`` for each document) +- Set ``index.export.path`` to a directory that the user running |Fess| can write to (the default ``/var/lib/fess/export`` is the RPM/DEB directory and is not writable when the ZIP distribution is run as a regular user; if it is not writable, the job fails with the error ``Cannot write to the index export directory`` and no export files are created) - Ensure sufficient disk space in the export directory - Consider using dedicated storage for large document sets - Implement regular cleanup of old exports if running periodic exports diff --git a/en/15.10/config/setup-memory.rst b/en/15.10/config/setup-memory.rst index 3e39db544..67339e371 100644 --- a/en/15.10/config/setup-memory.rst +++ b/en/15.10/config/setup-memory.rst @@ -268,8 +268,8 @@ Best Practices Refer to the official OpenSearch documentation for optimal settings based on your environment. -Suggest and Thumbnail Processing Memory Configuration -====================================================== +Suggest, Chunk and Thumbnail Processing Memory Configuration +============================================================ Suggest Generation Process --------------------------- @@ -284,6 +284,22 @@ The following settings are used by default: - Maximum heap: 256MB - Maximum Metaspace: 128MB +Content Chunk Generation Process +-------------------------------- + +Memory configuration for content chunk (vector generation for semantic search) processing is set in ``jvm.chunk.options``. + +Like the crawler's, this setting holds all the default options, so change only the ``-Xmx1g`` line and keep the others. + +The following settings are used by default: + +- Initial heap: 128MB +- Maximum heap: 1GB +- Maximum Metaspace: 128MB + +.. note:: + For large corpora, increase the maximum heap. See :doc:`search-semantic` for details. + Thumbnail Generation Process ----------------------------- diff --git a/en/15.10/config/setup-port-network.rst b/en/15.10/config/setup-port-network.rst index 8c8555b3a..674072a88 100644 --- a/en/15.10/config/setup-port-network.rst +++ b/en/15.10/config/setup-port-network.rst @@ -386,6 +386,9 @@ Configuration example for SSL/TLS termination at the reverse proxy (Nginx): } } +.. note:: + Passing the ``X-Forwarded-Proto`` header does not change the scheme that |Fess| uses to build absolute URLs (for example, in the OpenSearch description document and the SAML destination). The scheme is determined by the connector settings. Set ``tomcat.secure=true``, ``tomcat.scheme=https`` and ``tomcat.proxyPort=443`` in ``tomcat_config.properties`` (they are commented out by default), make the reverse proxy pass the original ``Host`` header unchanged, and restart |Fess|. + Firewall Configuration ====================== @@ -453,7 +456,7 @@ Not Working Properly When Accessed via Reverse Proxy ----------------------------------------------------- 1. Verify that the ``X-Forwarded-Host`` header is configured correctly. -2. Verify that the ``X-Forwarded-Proto`` header is configured correctly. +2. Verify that the ``X-Forwarded-Proto`` header is configured correctly. This header alone does not change the scheme of the absolute URLs that |Fess| builds; ``tomcat.secure``, ``tomcat.scheme`` and ``tomcat.proxyPort`` are also required (see the note in the SSL/TLS termination section above). 3. Verify that the context path is configured correctly. 4. Check reverse proxy logs for errors. diff --git a/es/15.10/admin/badword-guide.rst b/es/15.10/admin/badword-guide.rst index 137a2d914..8e942b027 100644 --- a/es/15.10/admin/badword-guide.rst +++ b/es/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ Palabra no deseada Registre palabras prohibidas. Las palabras registradas aquí no se mostrarán en las sugerencias. +.. note:: + Una palabra no deseada registrada no se aplica de inmediato a las sugerencias. Se elimina de los candidatos de sugerencia existentes cuando se ejecuta el trabajo "Suggest Indexer", que reconstruye el índice de sugerencias (por defecto se ejecuta todos los días a las 12:00). Para aplicarla de inmediato, haga clic en "Suggest Indexer" en [Sistema > Programador] y luego haga clic en el botón "Iniciar ahora". Lo mismo se aplica a las palabras registradas mediante la carga de un archivo CSV. + Eliminar configuración ---------------------- diff --git a/es/15.10/admin/elevateword-guide.rst b/es/15.10/admin/elevateword-guide.rst index a66bc7701..cbe893a13 100644 --- a/es/15.10/admin/elevateword-guide.rst +++ b/es/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ Permisos Configure la información de rol para la palabra. La sugerencia solo se mostrará a los usuarios que tengan el rol configurado. +La especificación por usuario es {user}nombre_usuario, la especificación por rol es {role}nombre_rol, y la especificación por grupo es {group}nombre_grupo. Etiqueta :::::::: @@ -56,6 +57,9 @@ Valor de impulso Configure el valor de impulso para la palabra. +.. note:: + Las palabras que registre, edite o elimine (incluida la carga de un archivo CSV) no se aplican de inmediato a las sugerencias. Se aplican cuando se ejecuta el trabajo "Suggest Indexer", que reconstruye el índice de sugerencias (por defecto se ejecuta todos los días a las 12:00). Para aplicarlas de inmediato, haga clic en "Suggest Indexer" en [Sistema > Programador] y luego haga clic en el botón "Iniciar ahora". + Eliminar configuración ---------------------- @@ -78,8 +82,8 @@ Desde la segunda línea en adelante se describen las palabras adicionales. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" Carga ===== @@ -96,8 +100,11 @@ Desde la segunda línea en adelante se describen las palabras adicionales. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + En la columna Permissions, especifique cada valor con ``{role}``, ``{user}`` o ``{group}``, como ``{role}role1`` (separe varios valores con comas). Un valor sin prefijo, como ``role1``, no se trata como un rol y la palabra no se sugiere a los usuarios que tienen ese rol. .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/es/15.10/admin/fileconfig-guide.rst b/es/15.10/admin/fileconfig-guide.rst index 368a410ff..79a66fefe 100644 --- a/es/15.10/admin/fileconfig-guide.rst +++ b/es/15.10/admin/fileconfig-guide.rst @@ -55,6 +55,9 @@ Rutas a rastrear Las rutas que coincidan con la expresión regular (formato Java) especificada en este elemento serán objeto del rastreador de |Fess|. +.. note:: + El patrón se aplica a la ruta completa de cada ruta que visita el rastreador, incluidas la ruta de inicio y los subdirectorios. Si especifica solo extensiones de archivo como ``.*\.(md|rst|adoc)$``, la ruta de inicio y los subdirectorios no coinciden con el patrón, el rastreador no llega a los archivos y no se rastrea nada. Para limitar los documentos por extensión, especifique el mismo patrón en "Rutas a buscar" (los directorios se siguen recorriendo y solo los archivos que coinciden son objeto de búsqueda). Use "Rutas a rastrear" únicamente con patrones que también coincidan con la ruta de inicio y los subdirectorios. + Rutas excluidas del rastreo :::::::::::::::::::::::::::: diff --git a/es/15.10/config/admin-index-export.rst b/es/15.10/config/admin-index-export.rst index aa8729c96..104262d31 100644 --- a/es/15.10/config/admin-index-export.rst +++ b/es/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ Ejemplo de configuración: index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + El valor predeterminado ``/var/lib/fess/export`` es el directorio de los paquetes RPM/DEB. Si ejecuta la versión ZIP con un usuario normal, no podrá escribir en él, por lo que debe cambiar ``index.export.path`` a un directorio en el que pueda escribir el usuario que ejecuta |Fess|. Si el directorio no se puede crear o no se puede escribir en él, el trabajo falla con el error ``Cannot write to the index export directory: index.export.path=...``. + Habilitar el Trabajo ==================== @@ -193,7 +196,7 @@ Mejores Prácticas Consideraciones de Almacenamiento ---------------------------------- -- Especifique en ``index.export.path`` un directorio en el que pueda escribir el usuario que ejecuta |Fess| (el valor predeterminado ``/var/lib/fess/export`` es un directorio de las versiones RPM/DEB; si ejecuta la versión ZIP con un usuario normal, no podrá escribir en él. Si no se puede escribir, no se crean los archivos de exportación y se registra en ``fess.log`` una advertencia por cada documento) +- Especifique en ``index.export.path`` un directorio en el que pueda escribir el usuario que ejecuta |Fess| (el valor predeterminado ``/var/lib/fess/export`` es un directorio de las versiones RPM/DEB; si ejecuta la versión ZIP con un usuario normal, no podrá escribir en él. Si no se puede escribir, el trabajo falla con el error ``Cannot write to the index export directory`` y no se crean los archivos de exportación) - Asegure suficiente espacio en disco en el directorio de exportación - Considere usar almacenamiento dedicado para grandes conjuntos de documentos - Implemente una limpieza periódica de exportaciones antiguas si ejecuta exportaciones regulares diff --git a/es/15.10/config/setup-memory.rst b/es/15.10/config/setup-memory.rst index 6dadb7938..48bad7ded 100644 --- a/es/15.10/config/setup-memory.rst +++ b/es/15.10/config/setup-memory.rst @@ -267,8 +267,8 @@ Mejores Prácticas Consulte la documentación oficial de OpenSearch y realice la configuración óptima según su entorno. -Configuración de Memoria para Procesamiento de Sugerencias y Miniaturas -======================================================================== +Configuración de Memoria para Procesamiento de Sugerencias, Chunks y Miniaturas +=============================================================================== Proceso de Generación de Sugerencias ------------------------------------- @@ -283,6 +283,22 @@ Por defecto se utiliza la siguiente configuración: - Heap máximo: 256MB - Metaspace máximo: 128MB +Proceso de Generación de Chunks de Contenido +-------------------------------------------- + +La configuración de memoria para el procesamiento de chunks de contenido (generación de vectores para la búsqueda semántica) se configura en ``jvm.chunk.options``. + +Al igual que en el rastreador, este ajuste contiene todas las opciones predeterminadas, así que cambie solo la línea ``-Xmx1g`` y conserve las demás. + +Por defecto se utiliza la siguiente configuración: + +- Heap inicial: 128MB +- Heap máximo: 1GB +- Metaspace máximo: 128MB + +.. note:: + Con corpus grandes es necesario aumentar el heap máximo. Consulte :doc:`search-semantic` para más detalles. + Proceso de Generación de Miniaturas ------------------------------------ diff --git a/es/15.10/config/setup-port-network.rst b/es/15.10/config/setup-port-network.rst index fac1c67f8..d48761045 100644 --- a/es/15.10/config/setup-port-network.rst +++ b/es/15.10/config/setup-port-network.rst @@ -380,6 +380,9 @@ Ejemplo de configuración para terminación SSL/TLS en el proxy inverso (Nginx): } } +.. note:: + Pasar el encabezado ``X-Forwarded-Proto`` no cambia el esquema que |Fess| usa para construir URL absolutas (por ejemplo, en el documento de descripción de OpenSearch y en el destino de SAML). El esquema lo determina la configuración del conector. Configure ``tomcat.secure=true``, ``tomcat.scheme=https`` y ``tomcat.proxyPort=443`` en ``tomcat_config.properties`` (están comentadas de forma predeterminada), haga que el proxy inverso pase sin cambios el encabezado ``Host`` original y reinicie |Fess|. + Configuración de Firewall ========================== @@ -447,7 +450,7 @@ No Funciona Correctamente al Acceder Vía Proxy Inverso ------------------------------------------------------- 1. Verifique que el encabezado ``X-Forwarded-Host`` esté configurado correctamente. -2. Verifique que el encabezado ``X-Forwarded-Proto`` esté configurado correctamente. +2. Verifique que el encabezado ``X-Forwarded-Proto`` esté configurado correctamente. Este encabezado por sí solo no cambia el esquema de las URL absolutas que construye |Fess|; también se necesitan ``tomcat.secure``, ``tomcat.scheme`` y ``tomcat.proxyPort`` (consulte la nota de la sección de terminación SSL/TLS anterior). 3. Verifique que la ruta de contexto esté configurada correctamente. 4. Verifique errores en los logs del proxy inverso. diff --git a/fr/15.10/admin/badword-guide.rst b/fr/15.10/admin/badword-guide.rst index cd132db11..e9d5886de 100644 --- a/fr/15.10/admin/badword-guide.rst +++ b/fr/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ Candidat de suggestion Enregistre les mots NG. Les mots enregistrés ici ne seront plus affichés dans les suggestions. +.. note:: + Un mot exclu enregistré n'est pas appliqué immédiatement aux suggestions. Il est retiré des candidats de suggestion existants lorsque la tâche « Suggest Indexer », qui reconstruit l'index de suggestions, s'exécute (par défaut tous les jours à 12:00). Pour l'appliquer tout de suite, cliquez sur « Suggest Indexer » dans [Système > Planificateur], puis sur le bouton « Démarrer maintenant ». Il en va de même pour les mots enregistrés par téléversement d'un fichier CSV. + Suppression de configuration ---------------------------- diff --git a/fr/15.10/admin/elevateword-guide.rst b/fr/15.10/admin/elevateword-guide.rst index 6ce364ec1..8dba3ef59 100644 --- a/fr/15.10/admin/elevateword-guide.rst +++ b/fr/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ Permission Configure les informations de rôle pour le mot. La suggestion n'est affichée que pour les utilisateurs ayant le rôle configuré. +La spécification par utilisateur est {user}nom_utilisateur, par rôle {role}nom_rôle, par groupe {group}nom_groupe. Étiquette ::::::::: @@ -56,6 +57,9 @@ Valeur de boost Configure la valeur de boost pour le mot. +.. note:: + Les mots que vous enregistrez, modifiez ou supprimez (y compris par téléversement d'un fichier CSV) ne sont pas appliqués immédiatement aux suggestions. Ils sont pris en compte lorsque la tâche « Suggest Indexer », qui reconstruit l'index de suggestions, s'exécute (par défaut tous les jours à 12:00). Pour les appliquer tout de suite, cliquez sur « Suggest Indexer » dans [Système > Planificateur], puis sur le bouton « Démarrer maintenant ». + Suppression de configuration ---------------------------- @@ -78,8 +82,8 @@ Les mots ajoutés sont listés à partir de la deuxième ligne. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" Téléversement ============= @@ -96,8 +100,11 @@ Décrivez les mots ajoutés à partir de la deuxième ligne. :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + Dans la colonne Permissions, indiquez chaque valeur avec ``{role}``, ``{user}`` ou ``{group}``, par exemple ``{role}role1`` (séparez plusieurs valeurs par des virgules). Une valeur sans préfixe, comme ``role1``, n'est pas traitée comme un rôle et le mot n'est pas suggéré aux utilisateurs qui ont ce rôle. .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/fr/15.10/admin/fileconfig-guide.rst b/fr/15.10/admin/fileconfig-guide.rst index aeaf68876..17bc4db5e 100644 --- a/fr/15.10/admin/fileconfig-guide.rst +++ b/fr/15.10/admin/fileconfig-guide.rst @@ -55,6 +55,9 @@ Chemins à crawler Les chemins correspondant à l'expression régulière (format Java) spécifiée dans cet élément seront ciblés par le crawler |Fess|. +.. note:: + Le motif est appliqué au chemin complet de chaque chemin visité par le crawler, y compris le chemin de départ et les sous-répertoires. Si vous ne spécifiez que des extensions de fichier comme ``.*\.(md|rst|adoc)$``, le chemin de départ et les sous-répertoires ne correspondent pas au motif, le crawler n'atteint pas les fichiers et rien n'est crawlé. Pour limiter les documents par extension, spécifiez le même motif dans « Chemins à indexer » (les répertoires sont toujours parcourus et seuls les fichiers correspondants sont ciblés pour la recherche). N'utilisez « Chemins à crawler » qu'avec des motifs qui correspondent aussi au chemin de départ et aux sous-répertoires. + Chemins exclus du crawl ::::::::::::::::::::::: diff --git a/fr/15.10/config/admin-index-export.rst b/fr/15.10/config/admin-index-export.rst index 8307511d3..4b6525ebd 100644 --- a/fr/15.10/config/admin-index-export.rst +++ b/fr/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ Exemple de configuration : index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + La valeur par défaut ``/var/lib/fess/export`` est le répertoire des paquets RPM/DEB. Il n'est pas accessible en écriture si la version ZIP est exécutée par un utilisateur ordinaire : remplacez ``index.export.path`` par un répertoire dans lequel l'utilisateur qui exécute |Fess| peut écrire. Si le répertoire ne peut pas être créé ou n'est pas accessible en écriture, la tâche échoue avec l'erreur ``Cannot write to the index export directory: index.export.path=...``. + Activation du travail ===================== @@ -193,7 +196,7 @@ Bonnes pratiques Considérations de stockage -------------------------- -- Indiquez dans ``index.export.path`` un répertoire dans lequel l'utilisateur qui exécute |Fess| peut écrire (le répertoire par défaut ``/var/lib/fess/export`` est celui des versions RPM/DEB ; il n'est pas accessible en écriture si la version ZIP est exécutée par un utilisateur ordinaire. Dans ce cas, les fichiers d'exportation ne sont pas créés et un avertissement par document est écrit dans ``fess.log``) +- Indiquez dans ``index.export.path`` un répertoire dans lequel l'utilisateur qui exécute |Fess| peut écrire (le répertoire par défaut ``/var/lib/fess/export`` est celui des versions RPM/DEB ; il n'est pas accessible en écriture si la version ZIP est exécutée par un utilisateur ordinaire. Dans ce cas, la tâche échoue avec l'erreur ``Cannot write to the index export directory`` et les fichiers d'exportation ne sont pas créés) - Assurez-vous d'avoir suffisamment d'espace disque dans le répertoire d'exportation - Envisagez d'utiliser un stockage dédié pour les grands ensembles de documents - Implémentez un nettoyage régulier des anciennes exportations si vous effectuez des exportations périodiques diff --git a/fr/15.10/config/setup-memory.rst b/fr/15.10/config/setup-memory.rst index a9eeeb38a..7ab1d4d5d 100644 --- a/fr/15.10/config/setup-memory.rst +++ b/fr/15.10/config/setup-memory.rst @@ -266,8 +266,8 @@ Bonnes pratiques Consultez la documentation officielle OpenSearch pour optimiser la configuration selon votre environnement. -Configuration de la mémoire pour les processus de suggestion et de miniature -====================================== +Configuration de la mémoire pour les processus de suggestion, de chunk et de miniature +====================================================================================== Processus de génération de suggestions ---------------------- @@ -282,6 +282,22 @@ Par défaut, les paramètres suivants sont utilisés : - Heap maximal : 256 Mo - Metaspace maximal : 128 Mo +Processus de génération de chunks de contenu +-------------------------------------------- + +Les paramètres de mémoire pour le traitement des chunks de contenu (génération de vecteurs pour la recherche sémantique) sont configurés avec ``jvm.chunk.options``. + +Comme pour le crawler, ce paramètre contient toutes les options par défaut : ne modifiez que la ligne ``-Xmx1g`` et conservez les autres. + +Par défaut, les paramètres suivants sont utilisés : + +- Heap initial : 128 Mo +- Heap maximal : 1 Go +- Metaspace maximal : 128 Mo + +.. note:: + Pour les corpus volumineux, il faut augmenter le heap maximal. Voir :doc:`search-semantic` pour plus de détails. + Processus de génération de miniatures ---------------------- diff --git a/fr/15.10/config/setup-port-network.rst b/fr/15.10/config/setup-port-network.rst index 1e0bc9fa6..8c0f1a9e1 100644 --- a/fr/15.10/config/setup-port-network.rst +++ b/fr/15.10/config/setup-port-network.rst @@ -389,6 +389,9 @@ Exemple de configuration pour la terminaison SSL/TLS sur le reverse proxy (Nginx } } +.. note:: + Transmettre l'en-tête ``X-Forwarded-Proto`` ne change pas le schéma que |Fess| utilise pour construire les URL absolues (par exemple, dans le document de description OpenSearch et la destination SAML). Le schéma est déterminé par la configuration du connecteur. Définissez ``tomcat.secure=true``, ``tomcat.scheme=https`` et ``tomcat.proxyPort=443`` dans ``tomcat_config.properties`` (ils sont commentés par défaut), faites transmettre l'en-tête ``Host`` d'origine sans modification par le proxy inverse, puis redémarrez |Fess|. + Configuration du pare-feu ==================== @@ -456,7 +459,7 @@ Fonctionnement anormal lors de l'accès via reverse proxy ---------------------------------------------------- 1. Vérifiez si l'en-tête ``X-Forwarded-Host`` est correctement configuré. -2. Vérifiez si l'en-tête ``X-Forwarded-Proto`` est correctement configuré. +2. Vérifiez si l'en-tête ``X-Forwarded-Proto`` est correctement configuré. Cet en-tête seul ne change pas le schéma des URL absolues construites par |Fess| ; ``tomcat.secure``, ``tomcat.scheme`` et ``tomcat.proxyPort`` sont également nécessaires (voir la note de la section sur la terminaison SSL/TLS ci-dessus). 3. Vérifiez si le chemin de contexte est correctement configuré. 4. Vérifiez les erreurs dans les journaux du reverse proxy. diff --git a/ja/15.10/admin/badword-guide.rst b/ja/15.10/admin/badword-guide.rst index 446fb4b54..356aa0534 100644 --- a/ja/15.10/admin/badword-guide.rst +++ b/ja/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ NGワードを登録します。 ここで登録したワードはサジェストに表示されなくなります。 +.. note:: + 登録した除外ワードは、すぐにはサジェストに反映されません。サジェストのインデックスを作り直す「Suggest Indexer」ジョブが実行されたときに、登録済みのサジェスト候補から取り除かれます（既定では毎日 12:00 に実行されます）。すぐに反映するには、 [システム > スケジューラ] で「Suggest Indexer」をクリックし、「今すぐ開始」ボタンをクリックします。CSV ファイルをアップロードして登録した場合も同様です。 + 設定の削除 -------- diff --git a/ja/15.10/admin/elevateword-guide.rst b/ja/15.10/admin/elevateword-guide.rst index afc36c2dc..cfd5a9c87 100644 --- a/ja/15.10/admin/elevateword-guide.rst +++ b/ja/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ ワードにロール情報を設定します。 設定したロールを持っているユーザーしかサジェストに表示されません。 +ユーザー単位の指定は{user}ユーザー名、ロール単位の指定は{role}ロール名、グループ単位の指定は{group}グループ名で指定します。 ラベル ::::: @@ -56,6 +57,9 @@ ワードにブースト値を設定します。 +.. note:: + 登録・編集・削除した追加ワード（CSV のアップロードを含む）は、すぐにはサジェストに反映されません。サジェストのインデックスを作り直す「Suggest Indexer」ジョブが実行されたときに反映されます（既定では毎日 12:00 に実行されます）。すぐに反映するには、 [システム > スケジューラ] で「Suggest Indexer」をクリックし、「今すぐ開始」ボタンをクリックします。 + 設定の削除 -------- @@ -78,8 +82,8 @@ CSVの内容 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" アップロード ========= @@ -96,8 +100,11 @@ CSVの内容 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + パーミッション列には ``{role}role1`` のように ``{role}`` 、 ``{user}`` 、 ``{group}`` のいずれかを付けて指定します（複数指定するときはカンマ区切り）。 ``role1`` のように接頭辞のない値を指定すると、ロールとして扱われず、そのロールを持つユーザーにはサジェストされません。 .. |image0| image:: ../../../resources/images/ja/15.10/admin/elevateword-1.png diff --git a/ja/15.10/admin/fileconfig-guide.rst b/ja/15.10/admin/fileconfig-guide.rst index b98cf4531..2be030c31 100644 --- a/ja/15.10/admin/fileconfig-guide.rst +++ b/ja/15.10/admin/fileconfig-guide.rst @@ -53,6 +53,9 @@ この項目で指定した正規表現(Javaフォーマット)にマッチするパスは |Fess| クローラーの対象となります。 +.. note:: + このパターンは、クロールが訪れるすべてのパス（開始パスやサブディレクトリを含む）に対して、パス全体との一致で適用されます。 ``.*\.(md|rst|adoc)$`` のように拡張子だけを指定すると、開始パスやサブディレクトリがパターンに一致せず、ファイルにたどり着けないため何もクロールされません。拡張子で絞り込むときは、同じパターンを「検索対象とするパス」に指定してください（ディレクトリはたどられ、一致したファイルだけが検索対象になります）。「クロール対象とするパス」には、開始パスやサブディレクトリにも一致するパターンを指定します。 + クロール対象から除外するパス ::::::::::::::::::::: diff --git a/ja/15.10/config/admin-index-export.rst b/ja/15.10/config/admin-index-export.rst index 0a490a45a..77807e012 100644 --- a/ja/15.10/config/admin-index-export.rst +++ b/ja/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + 既定の ``/var/lib/fess/export`` は RPM/DEB パッケージのディレクトリです。ZIP 版を一般ユーザーで実行する場合は書き込めないため、 ``index.export.path`` を |Fess| を実行するユーザーが書き込めるディレクトリに変更してください。ディレクトリを作成できない、または書き込めない場合、ジョブは ``Cannot write to the index export directory: index.export.path=...`` のエラーで失敗します。 + ジョブの有効化 ============== @@ -193,7 +196,7 @@ JSON フォーマットの場合、各ファイルは除外されていない全 ストレージの考慮事項 -------------------- -- ``index.export.path`` には、|Fess| を実行するユーザーが書き込めるディレクトリを指定する（既定の ``/var/lib/fess/export`` は RPM/DEB 版のディレクトリで、ZIP 版を一般ユーザーで実行する場合は書き込めません。書き込めない場合は、エクスポートファイルが作成されず、ドキュメントごとの警告が ``fess.log`` に出力されます） +- ``index.export.path`` には、|Fess| を実行するユーザーが書き込めるディレクトリを指定する（既定の ``/var/lib/fess/export`` は RPM/DEB 版のディレクトリで、ZIP 版を一般ユーザーで実行する場合は書き込めません。書き込めない場合は、ジョブが ``Cannot write to the index export directory`` のエラーで失敗し、エクスポートファイルは作成されません） - エクスポートディレクトリに十分なディスク容量を確保 - 大量のドキュメントセットには専用ストレージの使用を検討 - 定期エクスポートを実行する場合は古いエクスポートの定期的なクリーンアップを実装 diff --git a/ja/15.10/config/setup-memory.rst b/ja/15.10/config/setup-memory.rst index 673d304d7..9c2cf3138 100644 --- a/ja/15.10/config/setup-memory.rst +++ b/ja/15.10/config/setup-memory.rst @@ -268,8 +268,8 @@ Windows環境 OpenSearch の公式ドキュメントを参照し、環境に応じた最適な設定を行ってください。 -サジェスト・サムネイル処理のメモリ設定 -====================================== +サジェスト・チャンク・サムネイル処理のメモリ設定 +================================================ サジェスト生成プロセス ---------------------- @@ -284,6 +284,22 @@ Windows環境 - 最大ヒープ: 256MB - Metaspace最大: 128MB +コンテンツチャンク生成プロセス +------------------------------ + +コンテンツチャンク（セマンティック検索用のベクトル生成）処理のメモリ設定は、``jvm.chunk.options`` で設定します。 + +既定のオプションをすべて含む設定値なので、クローラーと同様に ``-Xmx1g`` の行だけを書き換えてください。 + +デフォルトでは以下の設定が使用されます: + +- 初期ヒープ: 128MB +- 最大ヒープ: 1GB +- Metaspace最大: 128MB + +.. note:: + 大規模なコーパスでは最大ヒープを引き上げる必要があります。詳しくは :doc:`search-semantic` を参照してください。 + サムネイル生成プロセス ---------------------- diff --git a/ja/15.10/config/setup-port-network.rst b/ja/15.10/config/setup-port-network.rst index 3bbbfa7c1..49e157b32 100644 --- a/ja/15.10/config/setup-port-network.rst +++ b/ja/15.10/config/setup-port-network.rst @@ -384,6 +384,9 @@ SSL/TLS終端 } } +.. note:: + ``X-Forwarded-Proto`` ヘッダーを渡しても、|Fess| が絶対URL(OpenSearch記述ドキュメントやSAMLの宛先URLなど)を組み立てるときのスキームは変わりません。スキームはコネクタの設定で決まります。 ``tomcat_config.properties`` で ``tomcat.secure=true``、``tomcat.scheme=https``、``tomcat.proxyPort=443`` を設定し(既定ではコメントアウトされています)、リバースプロキシが元の ``Host`` ヘッダーをそのまま渡すようにして、|Fess| を再起動してください。 + ファイアウォール設定 ==================== @@ -451,7 +454,7 @@ OpenSearchに接続できない ---------------------------------------------------- 1. ``X-Forwarded-Host`` ヘッダーが正しく設定されているか確認してください。 -2. ``X-Forwarded-Proto`` ヘッダーが正しく設定されているか確認してください。 +2. ``X-Forwarded-Proto`` ヘッダーが正しく設定されているか確認してください。また、このヘッダーだけでは |Fess| が組み立てる絶対URLのスキームは変わりません。 ``tomcat.secure``、``tomcat.scheme``、``tomcat.proxyPort`` の設定が必要です(上記のSSL/TLS終端の注記を参照)。 3. コンテキストパスが正しく設定されているか確認してください。 4. リバースプロキシのログでエラーを確認してください。 diff --git a/ko/15.10/admin/badword-guide.rst b/ko/15.10/admin/badword-guide.rst index 464f894e1..efe6fea58 100644 --- a/ko/15.10/admin/badword-guide.rst +++ b/ko/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ 금지 단어를 등록합니다. 여기서 등록한 단어는 추천에 표시되지 않습니다. +.. note:: + 등록한 제외 단어는 추천에 즉시 반영되지 않습니다. 추천 인덱스를 다시 만드는 "Suggest Indexer" 작업이 실행될 때 기존 추천 후보에서 제거됩니다(기본적으로 매일 12:00에 실행됩니다). 바로 반영하려면 [시스템 > 스케줄러] 에서 "Suggest Indexer" 를 클릭하고 "지금 시작" 버튼을 클릭합니다. CSV 파일을 업로드하여 등록한 경우도 같습니다. + 설정 삭제 -------- diff --git a/ko/15.10/admin/elevateword-guide.rst b/ko/15.10/admin/elevateword-guide.rst index f88fa7ace..57f6a48f2 100644 --- a/ko/15.10/admin/elevateword-guide.rst +++ b/ko/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ 단어에 역할 정보를 설정합니다. 설정한 역할을 가진 사용자만 추천에 표시됩니다. +사용자 단위 지정은 {user}사용자명, 역할 단위 지정은 {role}역할명, 그룹 단위 지정은 {group}그룹명으로 지정합니다. 라벨 ::::: @@ -56,6 +57,9 @@ 단어에 부스트 값을 설정합니다. +.. note:: + 등록, 편집, 삭제한 추가 단어(CSV 업로드 포함)는 추천에 즉시 반영되지 않습니다. 추천 인덱스를 다시 만드는 "Suggest Indexer" 작업이 실행될 때 반영됩니다(기본적으로 매일 12:00에 실행됩니다). 바로 반영하려면 [시스템 > 스케줄러] 에서 "Suggest Indexer" 를 클릭하고 "지금 시작" 버튼을 클릭합니다. + 설정 삭제 -------- @@ -78,8 +82,8 @@ CSV 내용 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" 업로드 ========= @@ -96,8 +100,11 @@ CSV 내용 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + Permissions 열에는 ``{role}role1`` 처럼 ``{role}``, ``{user}``, ``{group}`` 중 하나를 붙여서 지정합니다(여러 개는 쉼표로 구분). ``role1`` 처럼 접두사가 없는 값은 역할로 취급되지 않으며, 해당 역할을 가진 사용자에게 추천되지 않습니다. .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/ko/15.10/admin/fileconfig-guide.rst b/ko/15.10/admin/fileconfig-guide.rst index 241b4eb23..e896ccb3b 100644 --- a/ko/15.10/admin/fileconfig-guide.rst +++ b/ko/15.10/admin/fileconfig-guide.rst @@ -60,6 +60,9 @@ 이 항목에 지정한 정규 표현식(Java 형식)과 일치하는 경로는 |Fess| 크롤러의 대상이 됩니다. +.. note:: + 이 패턴은 크롤러가 방문하는 모든 경로(시작 경로와 하위 디렉토리 포함)의 경로 전체에 대해 적용됩니다. ``.*\.(md|rst|adoc)$`` 처럼 확장자만 지정하면 시작 경로와 하위 디렉토리가 패턴과 일치하지 않아 파일에 도달하지 못하므로 아무것도 크롤링되지 않습니다. 확장자로 좁히려면 같은 패턴을 "검색 대상 경로" 에 지정하십시오(디렉토리는 계속 탐색되며 일치하는 파일만 검색 대상이 됩니다). "크롤링 대상 경로" 에는 시작 경로와 하위 디렉토리에도 일치하는 패턴을 지정합니다. + 크롤링 대상에서 제외할 경로 ::::::::::::::::::::: diff --git a/ko/15.10/config/admin-index-export.rst b/ko/15.10/config/admin-index-export.rst index bb90e4bb0..d9bc491eb 100644 --- a/ko/15.10/config/admin-index-export.rst +++ b/ko/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + 기본값 ``/var/lib/fess/export`` 는 RPM/DEB 패키지의 디렉토리입니다. ZIP 버전을 일반 사용자로 실행하는 경우 쓸 수 없으므로, ``index.export.path`` 를 |Fess| 를 실행하는 사용자가 쓸 수 있는 디렉토리로 변경하십시오. 디렉토리를 생성할 수 없거나 쓸 수 없는 경우 작업이 ``Cannot write to the index export directory: index.export.path=...`` 오류로 실패합니다. + 작업 활성화 =========== @@ -193,7 +196,7 @@ JSON 형식의 경우 각 파일은 제외되지 않은 모든 필드를 포함 스토리지 고려 사항 ------------------ -- ``index.export.path`` 에는 |Fess| 를 실행하는 사용자가 쓸 수 있는 디렉토리를 지정(기본값인 ``/var/lib/fess/export`` 는 RPM/DEB 버전의 디렉토리이며, ZIP 버전을 일반 사용자로 실행하는 경우 쓸 수 없습니다. 쓸 수 없는 경우 내보내기 파일이 생성되지 않으며, 문서별 경고가 ``fess.log`` 에 출력됩니다) +- ``index.export.path`` 에는 |Fess| 를 실행하는 사용자가 쓸 수 있는 디렉토리를 지정(기본값인 ``/var/lib/fess/export`` 는 RPM/DEB 버전의 디렉토리이며, ZIP 버전을 일반 사용자로 실행하는 경우 쓸 수 없습니다. 쓸 수 없는 경우 작업이 ``Cannot write to the index export directory`` 오류로 실패하며 내보내기 파일이 생성되지 않습니다) - 내보내기 디렉토리에 충분한 디스크 공간 확보 - 대규모 문서 세트에는 전용 스토리지 사용 고려 - 정기 내보내기를 실행하는 경우 이전 내보내기의 정기적인 정리 구현 diff --git a/ko/15.10/config/setup-memory.rst b/ko/15.10/config/setup-memory.rst index 9ce0981e4..02b7460db 100644 --- a/ko/15.10/config/setup-memory.rst +++ b/ko/15.10/config/setup-memory.rst @@ -262,8 +262,8 @@ Windows 환경 OpenSearch의 공식 문서를 참조하여 환경에 맞는 최적 설정을 수행하십시오. -제안 및 썸네일 처리의 메모리 설정 -====================================== +제안, 청크 및 썸네일 처리의 메모리 설정 +======================================= 제안 생성 프로세스 ---------------------- @@ -278,6 +278,22 @@ Windows 환경 - 최대 힙: 256MB - Metaspace 최대: 128MB +콘텐츠 청크 생성 프로세스 +------------------------- + +콘텐츠 청크(시맨틱 검색용 벡터 생성) 처리의 메모리 설정은 ``jvm.chunk.options`` 에서 설정합니다. + +크롤러와 마찬가지로 이 설정값에는 모든 기본 옵션이 들어 있으므로, ``-Xmx1g`` 줄만 변경하고 나머지는 그대로 두십시오. + +기본적으로 다음 설정이 사용됩니다: + +- 초기 힙: 128MB +- 최대 힙: 1GB +- Metaspace 최대: 128MB + +.. note:: + 대규모 코퍼스에서는 최대 힙을 늘려야 합니다. 자세한 내용은 :doc:`search-semantic` 을 참조하십시오. + 썸네일 생성 프로세스 ---------------------- diff --git a/ko/15.10/config/setup-port-network.rst b/ko/15.10/config/setup-port-network.rst index 3035244d6..794f15237 100644 --- a/ko/15.10/config/setup-port-network.rst +++ b/ko/15.10/config/setup-port-network.rst @@ -389,6 +389,9 @@ SSL/TLS 종단 } } +.. note:: + ``X-Forwarded-Proto`` 헤더를 전달해도 |Fess| 가 절대 URL(예: OpenSearch 설명 문서, SAML 대상 URL)을 만들 때 사용하는 스킴은 바뀌지 않습니다. 스킴은 커넥터 설정으로 결정됩니다. ``tomcat_config.properties`` 에 ``tomcat.secure=true``, ``tomcat.scheme=https``, ``tomcat.proxyPort=443`` 을 설정하고(기본값은 주석 처리되어 있습니다), 리버스 프록시가 원래의 ``Host`` 헤더를 그대로 전달하도록 한 후 |Fess| 를 재시작하십시오. + 방화벽 설정 ==================== @@ -456,7 +459,7 @@ OpenSearch에 연결할 수 없음 ---------------------------------------------------- 1. ``X-Forwarded-Host`` 헤더가 올바르게 설정되어 있는지 확인하십시오. -2. ``X-Forwarded-Proto`` 헤더가 올바르게 설정되어 있는지 확인하십시오. +2. ``X-Forwarded-Proto`` 헤더가 올바르게 설정되어 있는지 확인하십시오.또한 이 헤더만으로는 |Fess| 가 만드는 절대 URL의 스킴이 바뀌지 않으며, ``tomcat.secure``, ``tomcat.scheme``, ``tomcat.proxyPort`` 설정이 필요합니다(위 SSL/TLS 종단 절의 참고 사항 참조). 3. 컨텍스트 경로가 올바르게 설정되어 있는지 확인하십시오. 4. 리버스 프록시의 로그에서 오류를 확인하십시오. diff --git a/zh-cn/15.10/admin/badword-guide.rst b/zh-cn/15.10/admin/badword-guide.rst index 685a18296..2bcee0ae0 100644 --- a/zh-cn/15.10/admin/badword-guide.rst +++ b/zh-cn/15.10/admin/badword-guide.rst @@ -37,6 +37,9 @@ 注册禁用词汇。 在此注册的词汇将不会显示在建议中。 +.. note:: + 已注册的排除词汇不会立即反映到建议中。当重建建议索引的“Suggest Indexer”作业运行时（默认每天 12:00 运行），才会将其从已有的建议候选词中移除。要立即生效，请在 [系统 > 调度器] 中单击“Suggest Indexer”，然后单击“立即开始”按钮。通过上传 CSV 文件注册的词汇也是如此。 + 删除配置 -------- diff --git a/zh-cn/15.10/admin/elevateword-guide.rst b/zh-cn/15.10/admin/elevateword-guide.rst index 5d1cbe2e3..91030f580 100644 --- a/zh-cn/15.10/admin/elevateword-guide.rst +++ b/zh-cn/15.10/admin/elevateword-guide.rst @@ -44,6 +44,7 @@ 为词汇设置角色信息。 只有具有配置角色的用户才能在建议中看到该词汇。 +按用户指定为{user}用户名，按角色指定为{role}角色名，按组指定为{group}组名。 标签 ::::: @@ -56,6 +57,9 @@ 为词汇设置提升值。 +.. note:: + 注册、编辑或删除的追加词汇（包括通过上传 CSV）不会立即反映到建议中。当重建建议索引的“Suggest Indexer”作业运行时（默认每天 12:00 运行）才会生效。要立即生效，请在 [系统 > 调度器] 中单击“Suggest Indexer”，然后单击“立即开始”按钮。 + 删除配置 -------- @@ -78,8 +82,8 @@ CSV内容 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" 上传 ========= @@ -96,8 +100,11 @@ CSV内容 :: -"SuggestWord","Reading","Role","Label","Boost" -"fess","ふぇす","role1","label1","100" +"SuggestWord","Reading","Permissions","Labels","Boost" +"fess","ふぇす","{role}role1","label1","100" + +.. note:: + 在 Permissions 列中，请使用 ``{role}``、``{user}``、``{group}`` 之一作为前缀，例如 ``{role}role1``（多个值以逗号分隔）。像 ``role1`` 这样没有前缀的值不会被视为角色，该词汇也不会建议给拥有该角色的用户。 .. |image0| image:: ../../../resources/images/en/15.10/admin/elevateword-1.png diff --git a/zh-cn/15.10/admin/fileconfig-guide.rst b/zh-cn/15.10/admin/fileconfig-guide.rst index 10506f4bd..c26752704 100644 --- a/zh-cn/15.10/admin/fileconfig-guide.rst +++ b/zh-cn/15.10/admin/fileconfig-guide.rst @@ -55,6 +55,9 @@ 与此项中指定的正则表达式（Java格式）匹配的路径将成为 |Fess| 爬虫的抓取对象。 +.. note:: + 该模式会对爬虫访问的所有路径（包括起始路径和子目录）的完整路径进行匹配。如果只指定 ``.*\.(md|rst|adoc)$`` 这样的扩展名，起始路径和子目录就不会匹配该模式，爬虫无法到达文件，因此不会抓取任何内容。要按扩展名筛选时，请将相同的模式指定到“包含在搜索中的路径”（目录仍会被遍历，只有匹配的文件会成为搜索对象）。“包含在抓取中的路径”只能指定同时匹配起始路径和子目录的模式。 + 排除在抓取外的路径 ::::::::::::::::::::: diff --git a/zh-cn/15.10/config/admin-index-export.rst b/zh-cn/15.10/config/admin-index-export.rst index e2ad14ccc..3f4d62834 100644 --- a/zh-cn/15.10/config/admin-index-export.rst +++ b/zh-cn/15.10/config/admin-index-export.rst @@ -64,6 +64,9 @@ index.export.exclude.fields=cache,boost,role index.export.scroll.size=200 +.. note:: + 默认值 ``/var/lib/fess/export`` 是 RPM/DEB 软件包的目录。以普通用户运行 ZIP 版时无法写入该目录，请将 ``index.export.path`` 改为运行 |Fess| 的用户可以写入的目录。如果无法创建或写入该目录，作业会以 ``Cannot write to the index export directory: index.export.path=...`` 错误失败。 + 启用作业 ======== @@ -193,7 +196,7 @@ cron 表达式示例： 存储注意事项 ------------ -- ``index.export.path`` 请指定运行 |Fess| 的用户可以写入的目录（默认的 ``/var/lib/fess/export`` 是 RPM/DEB 版的目录，以普通用户运行 ZIP 版时无法写入。无法写入时不会创建导出文件，并且每个文档都会在 ``fess.log`` 中输出警告） +- ``index.export.path`` 请指定运行 |Fess| 的用户可以写入的目录（默认的 ``/var/lib/fess/export`` 是 RPM/DEB 版的目录，以普通用户运行 ZIP 版时无法写入。无法写入时，作业会以 ``Cannot write to the index export directory`` 错误失败，并且不会创建导出文件） - 确保导出目录有足够的磁盘空间 - 对于大型文档集，考虑使用专用存储 - 如果运行定期导出，需定期清理旧的导出文件 diff --git a/zh-cn/15.10/config/setup-memory.rst b/zh-cn/15.10/config/setup-memory.rst index 94cf4b463..c40679a96 100644 --- a/zh-cn/15.10/config/setup-memory.rst +++ b/zh-cn/15.10/config/setup-memory.rst @@ -266,8 +266,8 @@ Windows 环境 请参考 OpenSearch 官方文档,根据环境进行最优配置。 -建议/缩略图处理的内存配置 -====================================== +建议/分块/缩略图处理的内存配置 +============================== 建议生成进程 ---------------------- @@ -282,6 +282,22 @@ Windows 环境 - 最大堆: 256MB - Metaspace最大: 128MB +内容分块生成进程 +---------------- + +内容分块（用于语义搜索的向量生成）处理的内存配置通过 ``jvm.chunk.options`` 设置。 + +与爬取进程一样，该设置值包含全部默认选项，因此请只修改 ``-Xmx1g`` 所在的行，其余保持不变。 + +默认使用以下配置: + +- 初始堆: 128MB +- 最大堆: 1GB +- Metaspace最大: 128MB + +.. note:: + 对于大规模语料库，需要增大最大堆。详情请参见 :doc:`search-semantic`。 + 缩略图生成进程 ---------------------- diff --git a/zh-cn/15.10/config/setup-port-network.rst b/zh-cn/15.10/config/setup-port-network.rst index b2c232d80..b4da86178 100644 --- a/zh-cn/15.10/config/setup-port-network.rst +++ b/zh-cn/15.10/config/setup-port-network.rst @@ -381,6 +381,9 @@ SSL/TLS 终止 } } +.. note:: + 传递 ``X-Forwarded-Proto`` 头不会改变 |Fess| 构建绝对 URL(例如 OpenSearch 描述文档和 SAML 目标 URL)时使用的协议。协议由连接器设置决定。请在 ``tomcat_config.properties`` 中设置 ``tomcat.secure=true``、``tomcat.scheme=https`` 和 ``tomcat.proxyPort=443``(默认处于注释状态),让反向代理原样传递原始的 ``Host`` 头,然后重启 |Fess|。 + 防火墙配置 ==================== @@ -448,7 +451,7 @@ SSL/TLS 终止 ---------------------------------------------------- 1. 请确认 ``X-Forwarded-Host`` 头是否配置正确。 -2. 请确认 ``X-Forwarded-Proto`` 头是否配置正确。 +2. 请确认 ``X-Forwarded-Proto`` 头是否配置正确。此外,仅靠该头不会改变 |Fess| 构建的绝对 URL 的协议,还需要设置 ``tomcat.secure``、``tomcat.scheme`` 和 ``tomcat.proxyPort``(参见上面 SSL/TLS 终止一节中的说明)。 3. 请确认上下文路径是否配置正确。 4. 请在反向代理日志中确认错误信息。