README.md

Fess: 企业搜索服务器

概述

Fess 是一个功能强大且易于部署的企业搜索服务器。您可以在任何可以运行 Java 运行时环境的平台上快速安装和运行 Fess。Fess 根据 Apache 许可证 2.0 提供。

Fess 基于 OpenSearch，但不需要 OpenSearch 的知识或经验。Fess 提供了一个易于使用的管理 GUI，您可以通过浏览器配置系统。Fess 还包含一个爬虫，能够抓取 Web 服务器、文件系统或数据存储（如 CSV 或数据库）中的文档。Fess 支持多种文件格式，包括但不限于：Microsoft Office、PDF 和 zip。

Fess 网站搜索 是 Google 网站搜索的免费替代品。更多详情请参阅 FSS JS 生成器文档。

官网

fess.codelibs.org

问题/疑问

discuss.codelibs.org

入门

您可以通过两种方式尝试 Fess。第一种是自行下载并安装，第二种是使用 Docker。

下载并安装/运行

Fess 14.17 现已发布，可在 发布页面 下载。提供三种下载形式：deb、rpm、zip。

以下命令展示了如何使用 zip 下载：

$ unzip fess-14.17.x.zip
$ cd fess-14.17.x
$ ./bin/fess

更多详情请参阅 安装指南。

Docker

我们在 ghcr.io 上提供了 Docker 镜像。我们还在此存储库中提供了 Docker Compose (YAML) 文件。

浏览器 UI

• 搜索 UI: http://localhost:8080/

• 管理 UI: http://localhost:8080/admin/ （默认用户名/密码为 admin/admin）

您可以在管理 UI 的 (Web、文件、数据存储) 爬虫配置页面中注册爬取目标，然后在 调度器页面手动启动爬虫。

从其他搜索提供商迁移

请参阅 MIGRATION.md。

数据存储

当前，Fess 支持抓取以下存储位置和 API：

• Confluence/Jira
• Box
• CSV
• Database
• Dropbox
• Elasticsearch
• Git
• Gitbucket
• G Suite
• JSON
• Office 365
• S3
• Salesforce
• SharePoint
• Slack

主题

• Simple
• Classic

数据处理

• Logger
• NDJSON

脚本

• Groovy
• OGNL

开发信息

获取源代码

1. 克隆 Fess 的存储库：

   $ cd ~/workspace
   $ git clone https://github.com/codelibs/fess.git
   

2. 将克隆的存储库作为 Maven 项目导入 Eclipse 或其他 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
• fess_message_en.properties

对于搜索/索引分析器，如果 doc.json 包含您语言的 lang_[lang]，请为您的语言修改分析器。有关分析器的更多详细信息，请参阅 OpenSearch 文档。

我们欢迎您的语言的 Pull Request。

技术支持

• Lasta Di: DI 容器
• LastaFlute: Web 框架
• Lasta Job: 任务调度器
• Fess Crawler: Web 爬虫
• OpenSearch: 搜索引擎