diff --git a/README.md b/README.md index c07b29d16..fc6eddca7 100644 --- a/README.md +++ b/README.md @@ -91,16 +91,6 @@ Currently, Fess supports crawling the following [storage locations and APIs](htt - [Groovy](https://github.com/codelibs/fess-script-groovy) - [OGNL](https://github.com/codelibs/fess-script-ognl) -## Localization - -### Japanese - - - [Website](https://fess.codelibs.org/ja/) - -### Korean - - - [Forum](https://github.com/nocode2k/fess-kr-forum) - ## Development Information ### Get Source Code @@ -160,6 +150,16 @@ For search/index analyzer, if [doc.json](https://github.com/codelibs/fess/blob/m We welcome pull requests for your language. +### Translations + +- [日本語 (Japanese)](docs/ja/README.md) +- [简体中文 (Simplified Chinese)](docs/zh-CN/README.md) +- [Español (Spanish)](docs/es/README.md) +- [Português (Brazilian Portuguese)](docs/pt-BR/README.md) +- [Français (French)](docs/fr/README.md) +- [Deutsch (German)](docs/de/README.md) +- [한국어 (Korean)](docs/ko/README.md) + ## Powered By * [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): DI Container diff --git a/docs/de/README.md b/docs/de/README.md new file mode 100644 index 000000000..a1c79502e --- /dev/null +++ b/docs/de/README.md @@ -0,0 +1,159 @@ +# Fess: Enterprise-Suchserver +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## Übersicht + +Fess ist ein sehr leistungsstarker und einfach zu implementierender Enterprise-Suchserver. Sie können Fess schnell auf jeder Plattform installieren und ausführen, auf der die Java-Laufzeitumgebung (JRE) läuft. Fess wird unter der [Apache-Lizenz 2.0](LICENSE) bereitgestellt. + +Fess basiert auf [OpenSearch](https://github.com/opensearch-project/OpenSearch), aber es ist kein Wissen oder Erfahrung mit OpenSearch erforderlich. Fess bietet eine einfach zu bedienende Administrations-GUI zur Konfiguration des Systems über Ihren Browser. +Fess enthält auch einen Crawler, der Dokumente auf einem [Webserver](https://fess.codelibs.org/14.17/admin/webconfig-guide.html), [Dateisystem](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html) oder [Datenspeicher](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html) (wie CSV oder Datenbank) durchsuchen kann. Viele Dateiformate werden unterstützt, einschließlich (aber nicht beschränkt auf): Microsoft Office, PDF und zip. + +*[Fess Site Search](https://github.com/codelibs/fess-site-search)* ist eine kostenlose Alternative zur [Google Site Search](https://enterprise.google.com/search/products/gss.html). Weitere Details finden Sie in der [Dokumentation des FSS JS Generators](https://fss-generator.codelibs.org/docs/manual). + +## Website + +[fess.codelibs.org](https://fess.codelibs.org/) + +## Probleme/Fragen + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## Erste Schritte + +Es gibt zwei Möglichkeiten, Fess auszuprobieren. Die erste besteht darin, es selbst herunterzuladen und zu installieren. Die zweite besteht darin, [Docker](https://www.docker.com/products/docker-engine) zu verwenden. + +### Herunterladen und Installieren/Ausführen + +Fess 14.17 ist jetzt verfügbar und kann auf der [Release-Seite](https://github.com/codelibs/fess/releases "download") heruntergeladen werden. Downloads gibt es in drei Formaten: deb, rpm, zip. + +Die folgenden Befehle zeigen, wie der Zip-Download verwendet wird: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +Weitere Informationen finden Sie im [Installationshandbuch](https://fess.codelibs.org/14.17/install/index.html). + +### Docker + +Wir bieten Docker-Images auf [ghcr.io](https://github.com/orgs/codelibs/packages) an. Wir stellen auch eine Docker Compose (YAML)-Datei in [diesem Repository](https://github.com/codelibs/docker-fess/tree/master/compose) bereit. + +### Browser-Benutzeroberfläche + +- Suchoberfläche: http://localhost:8080/ + +![Suchoberfläche](https://fess.codelibs.org/_images/fess_search_result1.png) + +- Administrationsoberfläche: http://localhost:8080/admin/ (Standard-Benutzername/Passwort ist admin/admin) + +![Administrationsoberfläche](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +Sie können in der Administrationsoberfläche (Web, Datei, Datenspeicher) Crawling-Ziele in den Crawler-Konfigurationsseiten registrieren und den Crawler manuell auf der [Scheduler-Seite](https://fess.codelibs.org/14.17/admin/scheduler-guide.html) starten. + +## Migration von einem anderen Suchanbieter + +Bitte lesen Sie [MIGRATION.md](MIGRATION.md). + +## Datenspeicher + +Derzeit unterstützt Fess das Crawlen der folgenden [Speicherorte und APIs](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html): + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Datenbank](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## Themen + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## Ingest + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## Skript + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## Entwicklungsinformationen + +### Quellcode abrufen + +1. Klonen Sie das Fess-Repository: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. Importieren Sie das geklonte Repository als ein [Maven](https://maven.apache.org/) Projekt in [Eclipse](https://www.eclipse.org/eclipseide/) oder einer anderen IDE. + +### Einrichten von OpenSearch-Plugins + +Führen Sie antrun:run aus, um Plugins in das Plugins-Verzeichnis herunterzuladen: + + $ mvn antrun:run + +### Fess ausführen + +Führen Sie `org.codelibs.fess.FessBoot` in Ihrer IDE aus oder debuggen Sie es und greifen Sie dann auf http://localhost:8080/ zu. + +### Paket erstellen + +Führen Sie das `package`-Ziel aus, und dann wird die Release-Datei im Verzeichnis target/releases erstellt. + + $ mvn package + $ mvn rpm:rpm # .rpm-Paket + $ mvn jdeb:jdeb # .deb-Paket + +### Quellcode generieren + + $ mvn dbflute:download # (einmaliger Befehl) + $ mvn dbflute:freegen + $ mvn license:format + +### Integrationstests + +Starten Sie den Fess-Server und führen Sie den folgenden Befehl aus: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +Um einen einzelnen Testfall auszuführen, können Sie verwenden: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### In Ihre Sprache übersetzen + +Fess ist eine internationalisierte Software. + +Wenn Sie Labels/Nachrichten für Ihre Sprache hinzufügen möchten, übersetzen Sie bitte die Eigenschaftendatei und benennen Sie sie in fess\_\*\_[lang].properties um. + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +Für den Such-/Index-Analyser: Wenn [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) lang\_[lang] für Ihre Sprache enthält, passen Sie bitte den Analyser für Ihre Sprache an. Weitere Informationen zu Analysatoren finden Sie in der [OpenSearch-Dokumentation](https://opensearch.org/docs/latest/analyzers/search-analyzers/). + +Wir begrüßen Pull-Requests für Ihre Sprache. + +## Unterstützt von + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): DI-Container +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): Web-Framework +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): Job-Scheduler +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Web-Crawler +* [OpenSearch](https://opensearch.org/ "OpenSearch"): Suchmaschine diff --git a/docs/es/README.md b/docs/es/README.md new file mode 100644 index 000000000..836a5cd01 --- /dev/null +++ b/docs/es/README.md @@ -0,0 +1,159 @@ +# Fess: Servidor de Búsqueda Empresarial +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## Resumen + +Fess es un servidor de búsqueda empresarial muy potente y fácil de desplegar. Puedes instalar y ejecutar Fess rápidamente en cualquier plataforma que sea capaz de ejecutar el entorno de ejecución de Java (Java Runtime Environment). Fess se distribuye bajo la [Licencia Apache 2.0](LICENSE). + +Fess está basado en [OpenSearch](https://github.com/opensearch-project/OpenSearch), pero no se requiere conocimiento o experiencia en OpenSearch. Fess proporciona una GUI de administración fácil de usar para configurar el sistema a través de tu navegador. +Fess también incluye un rastreador (crawler), que puede rastrear documentos en un [servidor web](https://fess.codelibs.org/14.17/admin/webconfig-guide.html), [sistema de archivos](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html), o [almacenamiento de datos](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html) (como un archivo CSV o base de datos). Se admiten muchos formatos de archivos, incluidos (pero no limitados a): Microsoft Office, PDF y zip. + +*[Fess Site Search](https://github.com/codelibs/fess-site-search)* es una alternativa gratuita a [Google Site Search](https://enterprise.google.com/search/products/gss.html). Para más detalles, consulta la [documentación de FSS JS Generator](https://fss-generator.codelibs.org/docs/manual). + +## Sitio web + +[fess.codelibs.org](https://fess.codelibs.org/) + +## Problemas/Preguntas + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## Cómo Empezar + +Hay dos maneras de probar Fess. La primera es descargar e instalarlo tú mismo. La segunda es usar [Docker](https://www.docker.com/products/docker-engine). + +### Descargar e Instalar/Ejecutar + +Fess 14.17 ya está disponible y se puede descargar en la [página de lanzamientos](https://github.com/codelibs/fess/releases "download"). Las descargas están disponibles en 3 formatos: deb, rpm y zip. + +Los siguientes comandos muestran cómo usar la descarga en formato zip: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +Para más detalles, consulta la [Guía de Instalación](https://fess.codelibs.org/14.17/install/index.html). + +### Docker + +Proporcionamos imágenes de Docker en [ghcr.io](https://github.com/orgs/codelibs/packages). También proporcionamos un archivo Docker Compose (YAML) en [este repositorio](https://github.com/codelibs/docker-fess/tree/master/compose). + +### Interfaz de Usuario en el Navegador + +- Interfaz de búsqueda: http://localhost:8080/ + +![Interfaz de Búsqueda](https://fess.codelibs.org/_images/fess_search_result1.png) + +- Interfaz de administración: http://localhost:8080/admin/ (el nombre de usuario/contraseña por defecto es admin/admin) + +![Interfaz de Administración](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +Puedes registrar los objetivos de rastreo en la interfaz de administración en las páginas de configuración del rastreador (Web, Archivo, Almacenamiento de Datos), y luego iniciar el rastreador manualmente en la [página del Programador](https://fess.codelibs.org/14.17/admin/scheduler-guide.html). + +## Migración desde otro proveedor de búsqueda + +Consulta [MIGRATION.md](MIGRATION.md). + +## Almacenamiento de Datos + +Actualmente, Fess admite el rastreo de las siguientes [ubicaciones de almacenamiento y APIs](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html): + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Database](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## Tema + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## Ingesta + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## Script + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## Información de Desarrollo + +### Obtener el Código Fuente + +1. Clona el repositorio de Fess: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. Importa el repositorio clonado como un proyecto [Maven](https://maven.apache.org/) en [Eclipse](https://www.eclipse.org/eclipseide/) u otro IDE. + +### Configuración de Plugins para OpenSearch + +Ejecuta antrun:run para descargar los plugins en el directorio de plugins: + + $ mvn antrun:run + +### Ejecutar Fess + +Ejecuta o depura `org.codelibs.fess.FessBoot` en tu IDE, y luego accede a http://localhost:8080/ + +### Construir el Paquete + +Ejecuta el objetivo `package` y luego se creará el archivo de lanzamiento en target/releases. + + $ mvn package + $ mvn rpm:rpm # Paquete .rpm + $ mvn jdeb:jdeb # Paquete .deb + +### Generar Código Fuente + + $ mvn dbflute:download # (comando ejecutado una sola vez) + $ mvn dbflute:freegen + $ mvn license:format + +### Pruebas de Integración + +Inicia el servidor Fess y ejecuta el siguiente comando: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +Para ejecutar un único caso de prueba, puedes usar: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### Traducir a Tu Idioma + +Fess es un software internacionalizado. + +Si deseas agregar etiquetas/mensajes para tu idioma, por favor traduce el archivo de propiedades y renómbralo a fess\_\*\_[lang].properties. + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +Para el analizador de búsqueda/índices, si [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) contiene lang\_[lang] para tu idioma, por favor modifica el analizador para tu idioma. Para más detalles sobre los analizadores, consulta la [documentación de OpenSearch](https://opensearch.org/docs/latest/analyzers/search-analyzers/). + +Damos la bienvenida a pull requests para tu idioma. + +## Impulsado por + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): Contenedor DI +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): Framework Web +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): Programador de Tareas +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Rastreador Web +* [OpenSearch](https://opensearch.org/ "OpenSearch"): Motor de Búsqueda diff --git a/README.fr.md b/docs/fr/README.md similarity index 100% rename from README.fr.md rename to docs/fr/README.md diff --git a/docs/ja/README.md b/docs/ja/README.md new file mode 100644 index 000000000..e5297f907 --- /dev/null +++ b/docs/ja/README.md @@ -0,0 +1,158 @@ +# Fess: エンタープライズ検索サーバー +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## 概要 + +Fessは非常に強力で、簡単に導入できるエンタープライズ検索サーバーです。FessはJavaランタイム環境が動作する任意のプラットフォーム上で簡単にインストールして実行できます。Fessは[Apache License 2.0](LICENSE)の下で提供されています。 + +Fessは[OpenSearch](https://github.com/opensearch-project/OpenSearch)をベースにしていますが、OpenSearchに関する知識や経験は**不要**です。Fessは、ブラウザを介してシステムを簡単に設定できる管理者向けのGUIを提供しています。Fessにはクローラも含まれており、[Webサーバー](https://fess.codelibs.org/14.17/admin/webconfig-guide.html)、[ファイルシステム](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html)、または[データストア](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html)(CSVやデータベースなど)のドキュメントをクロールできます。Microsoft Office、PDF、zipなど、多くのファイル形式に対応しています。 + +*[Fess Site Search](https://github.com/codelibs/fess-site-search)*は、[Google Site Search](https://enterprise.google.com/search/products/gss.html)の無料代替です。詳細については、[FSS JS Generatorのドキュメント](https://fss-generator.codelibs.org/docs/manual)を参照してください。 + +## 公式サイト + +[fess.codelibs.org](https://fess.codelibs.org/) + +## 問題や質問 + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## はじめに + +Fessを試す方法は2つあります。1つは自分でダウンロードしてインストールする方法、もう1つは[Docker](https://www.docker.com/products/docker-engine)を使用する方法です。 + +### ダウンロードおよびインストール/実行 + +Fess 14.17が利用可能で、[リリースページ](https://github.com/codelibs/fess/releases "download")からダウンロードできます。ダウンロードには、deb、rpm、zipの3つの形式があります。 + +以下のコマンドは、zipファイルを使用する例です: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +詳細については、[インストールガイド](https://fess.codelibs.org/14.17/install/index.html)を参照してください。 + +### Docker + +[ghcr.io](https://github.com/orgs/codelibs/packages)にDockerイメージを提供しています。また、このリポジトリにはDocker Compose(YAML)ファイルも用意されています。[こちらのリポジトリ](https://github.com/codelibs/docker-fess/tree/master/compose)で確認できます。 + +### ブラウザUI + +- 検索UI: http://localhost:8080/ + +![Search UI](https://fess.codelibs.org/_images/fess_search_result1.png) + +- 管理者UI: http://localhost:8080/admin/ (デフォルトのユーザー名/パスワードはadmin/adminです) + +![Admin UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +管理者UIでは、(Web、ファイル、データストア)クローラの設定ページでクロール対象を登録し、[スケジューラページ](https://fess.codelibs.org/14.17/admin/scheduler-guide.html)から手動でクローラを開始できます。 + +## 他の検索プロバイダーからの移行 + +[MIGRATION.md](MIGRATION.md)を参照してください。 + +## データストア + +現在、Fessは以下の[ストレージロケーションとAPI](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html)のクロールをサポートしています: + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Database](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## テーマ + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## Ingest + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## スクリプト + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## 開発情報 + +### ソースコードの取得 + +1. Fessのリポジトリをクローンします: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. クローンしたリポジトリを、[Maven](https://maven.apache.org/)プロジェクトとして[Eclipse](https://www.eclipse.org/eclipseide/)や他のIDEにインポートします。 + +### OpenSearchプラグインのセットアップ + +antrun:runを実行して、プラグインをpluginsディレクトリにダウンロードします: + + $ mvn antrun:run + +### Fessの実行 + +IDE上で`org.codelibs.fess.FessBoot`を実行またはデバッグし、http://localhost:8080/ にアクセスします。 + +### パッケージのビルド + +`package`ゴールを実行すると、releaseファイルがtarget/releasesディレクトリに作成されます。 + + $ mvn package + $ mvn rpm:rpm # .rpmパッケージ + $ mvn jdeb:jdeb # .debパッケージ + +### ソースコードの生成 + + $ mvn dbflute:download # (一度だけ実行) + $ mvn dbflute:freegen + $ mvn license:format + +### 統合テスト + +Fessサーバーを起動し、以下のコマンドを実行します: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +単一のテストケースを実行するには、以下のコマンドを使用できます: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### あなたの言語への翻訳 + +Fessは国際化対応ソフトウェアです。 + +ラベルやメッセージをあなたの言語に追加したい場合、プロパティファイルを翻訳してから`fess\_\*\_[lang].properties`という名前に変更してください。 + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +検索/インデックスアナライザーの設定については、[doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json)に言語別の`lang\_[lang]`が含まれているか確認し、その言語に合わせてアナライザーを修正してください。アナライザーに関する詳細は、[OpenSearchのドキュメント](https://opensearch.org/docs/latest/analyzers/search-analyzers/)を参照してください。 + +私たちは、あなたの言語でのプルリクエストを歓迎します。 + +## Powered By + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): DIコンテナ +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): Webフレームワーク +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): ジョブスケジューラ +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Webクローラ +* [OpenSearch](https://opensearch.org/ "OpenSearch"): 検索エンジン diff --git a/docs/ko/README.md b/docs/ko/README.md new file mode 100644 index 000000000..cdfaa0b53 --- /dev/null +++ b/docs/ko/README.md @@ -0,0 +1,158 @@ +# Fess: 엔터프라이즈 검색 서버 +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## 개요 + +Fess는 매우 강력하고 쉽게 배포 가능한 엔터프라이즈 검색 서버입니다. 자바 런타임 환경(Java Runtime Environment)을 실행할 수 있는 모든 플랫폼에서 Fess를 빠르게 설치하고 실행할 수 있습니다. Fess는 [Apache License 2.0](LICENSE)에 따라 제공됩니다. + +Fess는 [OpenSearch](https://github.com/opensearch-project/OpenSearch)를 기반으로 하지만, OpenSearch에 대한 지식이나 경험은 필요하지 않습니다. Fess는 브라우저를 통해 시스템을 구성할 수 있는 사용하기 쉬운 관리 GUI를 제공합니다. 또한 Fess는 [웹 서버](https://fess.codelibs.org/14.17/admin/webconfig-guide.html), [파일 시스템](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html), 또는 [데이터 저장소](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html)에서 문서를 크롤링할 수 있는 크롤러도 포함하고 있습니다(CSV 또는 데이터베이스와 같은). Microsoft Office, PDF, zip을 포함한 다양한 파일 형식을 지원합니다. + +*[Fess 사이트 검색](https://github.com/codelibs/fess-site-search)*은 [Google 사이트 검색](https://enterprise.google.com/search/products/gss.html)의 무료 대안입니다. 자세한 내용은 [FSS JS 생성기 문서](https://fss-generator.codelibs.org/docs/manual)를 참조하십시오. + +## 웹사이트 + +[fess.codelibs.org](https://fess.codelibs.org/) + +## 문제/질문 + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## 시작하기 + +Fess를 사용해보는 방법은 두 가지가 있습니다. 첫 번째는 직접 다운로드하여 설치하는 방법이며, 두 번째는 [Docker](https://www.docker.com/products/docker-engine)를 사용하는 방법입니다. + +### 다운로드 및 설치/실행 + +Fess 14.17이 현재 사용 가능하며, [릴리스 페이지](https://github.com/codelibs/fess/releases "download")에서 다운로드할 수 있습니다. 다운로드는 deb, rpm, zip의 세 가지 형식으로 제공됩니다. + +다음 명령은 zip 다운로드 사용 방법을 보여줍니다: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +자세한 내용은 [설치 가이드](https://fess.codelibs.org/14.17/install/index.html)를 참조하십시오. + +### Docker + +우리는 [ghcr.io](https://github.com/orgs/codelibs/packages)에서 Docker 이미지를 제공합니다. 또한 [이 리포지토리](https://github.com/codelibs/docker-fess/tree/master/compose)에 Docker Compose (YAML) 파일도 제공합니다. + +### 브라우저 UI + +- 검색 UI: http://localhost:8080/ + +![검색 UI](https://fess.codelibs.org/_images/fess_search_result1.png) + +- 관리자 UI: http://localhost:8080/admin/ (기본 사용자 이름/비밀번호는 admin/admin입니다) + +![관리자 UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +관리자 UI에서는 (웹, 파일, 데이터 저장소) 크롤러 구성 페이지에서 크롤링 대상을 등록한 다음, [스케줄러 페이지](https://fess.codelibs.org/14.17/admin/scheduler-guide.html)에서 크롤러를 수동으로 시작할 수 있습니다. + +## 다른 검색 제공자에서의 마이그레이션 + +[MIGRATION.md](MIGRATION.md)를 참조하십시오. + +## 데이터 저장소 + +현재 Fess는 다음 [저장소 위치 및 API](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html)를 크롤링할 수 있습니다: + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Database](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## 테마 + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## 인게스트 + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## 스크립트 + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## 개발 정보 + +### 소스 코드 얻기 + +1. Fess 리포지토리를 클론합니다: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. 클론한 리포지토리를 [Maven](https://maven.apache.org/) 프로젝트로 [Eclipse](https://www.eclipse.org/eclipseide/) 또는 다른 IDE에서 가져옵니다. + +### OpenSearch 플러그인 설정 + +antrun:run을 실행하여 플러그인을 플러그인 디렉토리에 다운로드합니다: + + $ mvn antrun:run + +### Fess 실행 + +IDE에서 `org.codelibs.fess.FessBoot`을 실행하거나 디버그하고 http://localhost:8080/에 접속합니다. + +### 패키지 빌드 + +`package` 목표를 실행하면 릴리스 파일이 target/releases 디렉토리에 생성됩니다. + + $ mvn package + $ mvn rpm:rpm # .rpm 패키지 + $ mvn jdeb:jdeb # .deb 패키지 + +### 소스 코드 생성 + + $ mvn dbflute:download # (한 번만 실행) + $ mvn dbflute:freegen + $ mvn license:format + +### 통합 테스트 + +Fess 서버를 시작하고 다음 명령을 실행합니다: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +단일 테스트 케이스를 실행하려면 다음을 사용할 수 있습니다: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### 언어 번역 + +Fess는 국제화된 소프트웨어입니다. + +귀하의 언어로 라벨/메시지를 추가하려면 속성 파일을 번역한 후 fess\_\*\_[lang].properties로 이름을 바꾸십시오. + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +검색/인덱스 분석기와 관련해서, [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json)이 귀하의 언어에 대한 lang\_[lang]을 포함하는 경우, 해당 언어에 맞게 분석기를 수정하십시오. 분석기에 대한 자세한 내용은 [OpenSearch 문서](https://opensearch.org/docs/latest/analyzers/search-analyzers/)를 참조하십시오. + +귀하의 언어로 된 풀 리퀘스트를 환영합니다. + +## 제공된 기술 + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): DI 컨테이너 +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): 웹 프레임워크 +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): 작업 스케줄러 +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): 웹 크롤러 +* [OpenSearch](https://opensearch.org/ "OpenSearch"): 검색 엔진 diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md new file mode 100644 index 000000000..4499b8c1c --- /dev/null +++ b/docs/pt-BR/README.md @@ -0,0 +1,159 @@ +# Fess: Servidor de Busca Empresarial +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## Visão Geral + +Fess é um servidor de busca empresarial muito poderoso e fácil de implantar. Você pode instalar e executar o Fess rapidamente em qualquer plataforma que suporte o Java Runtime Environment. O Fess é fornecido sob a [Licença Apache 2.0](LICENSE). + +O Fess é baseado no [OpenSearch](https://github.com/opensearch-project/OpenSearch), mas não é necessário ter conhecimento ou experiência com OpenSearch. O Fess fornece uma interface de administração fácil de usar, que permite configurar o sistema através do seu navegador. +O Fess também inclui um rastreador (Crawler), que pode rastrear documentos em um [servidor web](https://fess.codelibs.org/14.17/admin/webconfig-guide.html), [sistema de arquivos](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html) ou [Data Store](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html) (como CSV ou banco de dados). Muitos formatos de arquivos são suportados, incluindo (mas não limitado a): Microsoft Office, PDF e zip. + +*[Fess Site Search](https://github.com/codelibs/fess-site-search)* é uma alternativa gratuita ao [Google Site Search](https://enterprise.google.com/search/products/gss.html). Para mais detalhes, veja a [documentação do FSS JS Generator](https://fss-generator.codelibs.org/docs/manual). + +## Site + +[fess.codelibs.org](https://fess.codelibs.org/) + +## Problemas/Perguntas + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## Como Começar + +Existem duas maneiras de testar o Fess. A primeira é baixar e instalar você mesmo. A segunda é usar [Docker](https://www.docker.com/products/docker-engine). + +### Baixar e Instalar/Executar + +O Fess 14.17 já está disponível e pode ser baixado na [página de lançamentos](https://github.com/codelibs/fess/releases "download"). As opções de download incluem: deb, rpm, zip. + +Os comandos a seguir mostram como usar o download em formato zip: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +Para mais detalhes, veja o [Guia de Instalação](https://fess.codelibs.org/14.17/install/index.html). + +### Docker + +Nós fornecemos imagens Docker em [ghcr.io](https://github.com/orgs/codelibs/packages). Também fornecemos um arquivo Docker Compose (YAML) neste [repositório](https://github.com/codelibs/docker-fess/tree/master/compose). + +### Interface do Navegador + +- Interface de Busca: http://localhost:8080/ + +![Interface de Busca](https://fess.codelibs.org/_images/fess_search_result1.png) + +- Interface de Administração: http://localhost:8080/admin/ (o nome de usuário/senha padrão é admin/admin) + +![Interface de Administração](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +Você pode registrar alvos de rastreamento na interface de administração nas páginas de configuração do rastreador (Web, Arquivo, Data Store), e iniciar manualmente o rastreador na [página do Agendador](https://fess.codelibs.org/14.17/admin/scheduler-guide.html). + +## Migração de Outro Provedor de Busca + +Consulte [MIGRATION.md](MIGRATION.md). + +## Data Store + +Atualmente, o Fess suporta o rastreamento dos seguintes [locais de armazenamento e APIs](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html): + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Database](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## Temas + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## Ingestão + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## Scripts + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## Informações de Desenvolvimento + +### Obter Código Fonte + +1. Clone o repositório do Fess: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. Importe o repositório clonado como um projeto [Maven](https://maven.apache.org/) no [Eclipse](https://www.eclipse.org/eclipseide/) ou em outro IDE. + +### Configuração de Plugins para OpenSearch + +Execute antrun:run para baixar os plugins no diretório de plugins: + + $ mvn antrun:run + +### Executar o Fess + +Execute ou depure `org.codelibs.fess.FessBoot` no seu IDE, e depois acesse http://localhost:8080/ + +### Criar Pacote + +Execute o objetivo `package` e o arquivo de lançamento será criado em target/releases. + + $ mvn package + $ mvn rpm:rpm # pacote .rpm + $ mvn jdeb:jdeb # pacote .deb + +### Gerar Código Fonte + + $ mvn dbflute:download # (comando executado uma vez) + $ mvn dbflute:freegen + $ mvn license:format + +### Testes de Integração + +Inicie o servidor Fess e execute o seguinte comando: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +Para executar um único caso de teste, você pode usar: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### Traduzir para o Seu Idioma + +Fess é um software internacionalizado. + +Se você quiser adicionar rótulos/mensagens para o seu idioma, por favor, traduza o arquivo de propriedades e renomeie-o para fess\_\*\_[lang].properties. + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +Para o analisador de busca/índice, se [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) contiver lang\_[lang] para o seu idioma, por favor, modifique o analisador para o seu idioma. Para mais detalhes sobre Analisadores, veja a [documentação do OpenSearch](https://opensearch.org/docs/latest/analyzers/search-analyzers/). + +Aceitamos pull requests para o seu idioma. + +## Desenvolvido por + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): Contêiner DI +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): Framework Web +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): Agendador de Tarefas +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Rastreador Web +* [OpenSearch](https://opensearch.org/ "OpenSearch"): Motor de Busca diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md new file mode 100644 index 000000000..34860f1d7 --- /dev/null +++ b/docs/zh-CN/README.md @@ -0,0 +1,158 @@ +# Fess: 企业搜索服务器 +[![Java CI with Maven](https://github.com/codelibs/fess/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/fess/actions/workflows/maven.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.codelibs.fess/fess) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) + +## 概述 + +Fess 是一个功能强大且易于部署的企业搜索服务器。您可以在任何可以运行 Java 运行时环境的平台上快速安装和运行 Fess。Fess 根据 [Apache 许可证 2.0](LICENSE) 提供。 + +Fess 基于 [OpenSearch](https://github.com/opensearch-project/OpenSearch),但不需要 OpenSearch 的知识或经验。Fess 提供了一个易于使用的管理 GUI,您可以通过浏览器配置系统。Fess 还包含一个爬虫,能够抓取 [Web 服务器](https://fess.codelibs.org/14.17/admin/webconfig-guide.html)、[文件系统](https://fess.codelibs.org/14.17/admin/fileconfig-guide.html)或[数据存储](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html)(如 CSV 或数据库)中的文档。Fess 支持多种文件格式,包括但不限于:Microsoft Office、PDF 和 zip。 + +*[Fess 网站搜索](https://github.com/codelibs/fess-site-search)* 是 [Google 网站搜索](https://enterprise.google.com/search/products/gss.html)的免费替代品。更多详情请参阅 [FSS JS 生成器文档](https://fss-generator.codelibs.org/docs/manual)。 + +## 官网 + +[fess.codelibs.org](https://fess.codelibs.org/) + +## 问题/疑问 + +[discuss.codelibs.org](https://discuss.codelibs.org/c/FessEN/) + +## 入门 + +您可以通过两种方式尝试 Fess。第一种是自行下载并安装,第二种是使用 [Docker](https://www.docker.com/products/docker-engine)。 + +### 下载并安装/运行 + +Fess 14.17 现已发布,可在 [发布页面](https://github.com/codelibs/fess/releases "download") 下载。提供三种下载形式:deb、rpm、zip。 + +以下命令展示了如何使用 zip 下载: + + $ unzip fess-14.17.x.zip + $ cd fess-14.17.x + $ ./bin/fess + +更多详情请参阅 [安装指南](https://fess.codelibs.org/14.17/install/index.html)。 + +### Docker + +我们在 [ghcr.io](https://github.com/orgs/codelibs/packages) 上提供了 Docker 镜像。我们还在[此存储库](https://github.com/codelibs/docker-fess/tree/master/compose)中提供了 Docker Compose (YAML) 文件。 + +### 浏览器 UI + +- 搜索 UI: http://localhost:8080/ + +![Search UI](https://fess.codelibs.org/_images/fess_search_result1.png) + +- 管理 UI: http://localhost:8080/admin/ (默认用户名/密码为 admin/admin) + +![Admin UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png) + +您可以在管理 UI 的 (Web、文件、数据存储) 爬虫配置页面中注册爬取目标,然后在 [调度器页面](https://fess.codelibs.org/14.17/admin/scheduler-guide.html)手动启动爬虫。 + +## 从其他搜索提供商迁移 + +请参阅 [MIGRATION.md](MIGRATION.md)。 + +## 数据存储 + +当前,Fess 支持抓取以下[存储位置和 API](https://fess.codelibs.org/14.17/admin/dataconfig-guide.html): + + - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) + - [Box](https://github.com/codelibs/fess-ds-box) + - [CSV](https://github.com/codelibs/fess-ds-csv) + - [Database](https://github.com/codelibs/fess-ds-db) + - [Dropbox](https://github.com/codelibs/fess-ds-dropbox) + - [Elasticsearch](https://github.com/codelibs/fess-ds-elasticsearch) + - [Git](https://github.com/codelibs/fess-ds-git) + - [Gitbucket](https://github.com/codelibs/fess-ds-gitbucket) + - [G Suite](https://github.com/codelibs/fess-ds-gsuite) + - [JSON](https://github.com/codelibs/fess-ds-json) + - [Office 365](https://github.com/codelibs/fess-ds-office365) + - [S3](https://github.com/codelibs/fess-ds-s3) + - [Salesforce](https://github.com/codelibs/fess-ds-salesforce) + - [SharePoint](https://github.com/codelibs/fess-ds-sharepoint) + - [Slack](https://github.com/codelibs/fess-ds-slack) + +## 主题 + + - [Simple](https://github.com/codelibs/fess-theme-simple) + - [Classic](https://github.com/codelibs/fess-theme-classic) + +## 数据处理 + + - [Logger](https://github.com/codelibs/fess-ingest-logger) + - [NDJSON](https://github.com/codelibs/fess-ingest-ndjson) + +## 脚本 + + - [Groovy](https://github.com/codelibs/fess-script-groovy) + - [OGNL](https://github.com/codelibs/fess-script-ognl) + +## 开发信息 + +### 获取源代码 + +1. 克隆 Fess 的存储库: + ``` + $ cd ~/workspace + $ git clone https://github.com/codelibs/fess.git + ``` + +2. 将克隆的存储库作为 [Maven](https://maven.apache.org/) 项目导入 [Eclipse](https://www.eclipse.org/eclipseide/) 或其他 IDE。 + +### 设置 OpenSearch 插件 + +运行 antrun:run 将插件下载到插件目录: + + $ mvn antrun:run + +### 运行 Fess + +在您的 IDE 上运行或调试 `org.codelibs.fess.FessBoot`,然后访问 http://localhost:8080/ + +### 构建包 + +运行 `package` 目标,然后在 target/releases 中创建发布文件。 + + $ mvn package + $ mvn rpm:rpm # .rpm 包 + $ mvn jdeb:jdeb # .deb 包 + +### 生成源代码 + + $ mvn dbflute:download # (仅运行一次) + $ mvn dbflute:freegen + $ mvn license:format + +### 集成测试 + +启动 Fess 服务器并运行以下命令: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" + +要运行单个测试用例,您可以使用: + + $ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.search_engine.url="http://localhost:9201" -Dtest=SearchApiTests + +### 翻译为您的语言 + +Fess 是国际化软件。 + +如果您想为您的语言添加标签/消息,请翻译属性文件,然后将其重命名为 fess\_\*\_[lang].properties。 + +* [fess_label_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_label_en.properties) +* [fess_message_en.properties](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_message_en.properties) + +对于搜索/索引分析器,如果 [doc.json](https://github.com/codelibs/fess/blob/master/src/main/resources/fess_indices/fess/doc.json) 包含您语言的 lang\_[lang],请为您的语言修改分析器。有关分析器的更多详细信息,请参阅 [OpenSearch 文档](https://opensearch.org/docs/latest/analyzers/search-analyzers/)。 + +我们欢迎您的语言的 Pull Request。 + +## 技术支持 + +* [Lasta Di](https://github.com/lastaflute/lasta-di "Lasta Di"): DI 容器 +* [LastaFlute](https://github.com/lastaflute/lastaflute "LastaFlute"): Web 框架 +* [Lasta Job](https://github.com/lastaflute/lasta-job "Lasta Job"): 任务调度器 +* [Fess Crawler](https://github.com/codelibs/fess-crawler "Fess Crawler"): Web 爬虫 +* [OpenSearch](https://opensearch.org/ "OpenSearch"): 搜索引擎