快速构建指南

概述

Fess 是一款开源全文检索服务器，可对网站和文件服务器进行爬取（巡回），并对收集的内容进行跨文档搜索。

本说明面向希望快速体验 Fess 的用户，描述使用 Fess 的最小步骤。

使用哪种方式？

Docker（推荐） ZIP 包
事前准备 Docker 和 Docker Compose Java 21（OpenSearch 通过 fess-setup 命令安装）
启动便捷性 ◎ 仅需几条命令 △ 安装 Java 后，执行几条设置命令
适合人群 想先试试的用户 无法使用 Docker 环境的用户

使用 Docker 快速开始（推荐）

所需时间目标：首次 5〜10 分钟左右（包含 Docker 镜像下载时间）

Docker 提供了最快、最可靠的 Fess 运行方式。所有依赖都已打包，无需额外安装。

1. 下载配置文件

mkdir fess-docker && cd fess-docker
curl -OL https://raw.githubusercontent.com/codelibs/docker-fess/main/compose/compose.yaml
curl -OL https://raw.githubusercontent.com/codelibs/docker-fess/main/compose/compose-opensearch3.yaml

2. 启动容器

docker compose -f compose.yaml -f compose-opensearch3.yaml up -d

3. 验证启动

等待几分钟让服务初始化完成，然后在浏览器中打开：

Warning

安全提醒： 请在首次登录后立即更改默认管理员密码。

4. 停止

docker compose -f compose.yaml -f compose-opensearch3.yaml down

关于高级 Docker 配置（自定义设置、外部 OpenSearch、Kubernetes）， 请参阅 Docker 安装指南。

使用 ZIP 包启动

所需时间目标：首次 20〜30 分钟左右（包含 Java 安装和 OpenSearch 下载时间）

如果您不使用 Docker，可以通过 ZIP 包直接运行 Fess。 Fess 不内置搜索引擎，ZIP 包中附带的 fess-setup 命令会下载 OpenSearch， 并安装 Fess 所需的插件。

这里的步骤是用于试用的启动方法，关于面向运营的构建步骤，请参考使用 Docker 的 安装步骤 等。 （此处启动的 Fess 是用于简单的功能确认，不推荐在此环境下进行运营）

前期准备

启动前请先安装 Java 21。推荐使用 Eclipse Temurin 的 Java 21。 无需事先安装 OpenSearch：步骤 2 会进行安装。

Note

OpenSearch 仅为 Linux 和 Windows 提供官方构建。在 macOS 上， fess-setup install opensearch 会以错误退出；请使用 Docker（方法 1），或参阅 在 Linux 上安装（详细步骤） 了解使用 Homebrew 安装 OpenSearch 的方法。

步骤 1：下载并解压

从 GitHub 发布站点 下载最新的 Fess ZIP 包， 解压后进入该目录。

$ unzip fess-x.y.z.zip
$ cd fess-x.y.z

步骤 2：安装 OpenSearch

请以普通用户而非 root 身份执行 fess-setup：OpenSearch 无法以 root 身份启动。

# Linux
$ bin/fess-setup install opensearch

# Windows
> bin\fess-setup.bat install opensearch

该命令会将此 Fess 所支持版本的 OpenSearch 下载到 Fess 目录下的 opensearch/， 安装 Fess 所需的四个插件，并将 Fess 需要的设置添加到 config/opensearch.yml 中。 bin/fess 会自动找到该 OpenSearch，因此只要 OpenSearch 运行在同一主机上， 就无需编辑任何配置文件。

Warning

该命令会设置 plugins.security.disabled: true，因此 OpenSearch 无需认证即可接受请求。 默认情况下它仅监听回环地址；请勿将其暴露到网络中。 有关生产环境的设置，请参阅 安全配置。

有关所有命令（安装 Node.js 和插件、check），请参阅 fess-setup 命令。

步骤 3：启动 OpenSearch 和 Fess

请先启动 OpenSearch，再启动 Fess：

# Linux
$ opensearch/opensearch-3.9.0/bin/opensearch -d
$ bin/fess

:: Windows（请分别在各自的命令提示符中执行）
opensearch\opensearch-3.9.0\bin\opensearch.bat
bin\fess.bat

访问管理界面

访问 http://localhost:8080/admin。 默认管理员账户的用户名/密码为 admin/admin。

如需确认安装情况，请执行 bin/fess-setup check（在 Windows 上为 bin\fess-setup.bat check）。 它会报告 OpenSearch 是否可以连接，以及是否已安装 Fess 所需的插件。

Warning

请务必更改默认密码。 在生产环境中，强烈建议在首次登录后立即更改密码。

停止 Fess（ZIP 版）

使用 Ctrl-C 或 kill 命令等停止 fess 进程。 然后以同样的方式停止 OpenSearch（使用 kill 终止其进程，如果它在前台运行，则使用 Ctrl+C）。

爬取配置与搜索

1. 创建爬取配置

登录后，点击左侧菜单的「爬虫」>「网页」。 点击「新建」按钮，创建网页爬取的配置信息。

请输入以下信息：

  • 名称: 爬取配置的名称（例：公司网站）

  • URL: 爬取目标的 URL（例：https://www.example.com/）

  • 最大访问数: 爬取页面数的上限（初次建议设置 10 左右的小值）

  • 间隔: 爬取间隔（毫秒）（推荐默认值 10000 毫秒）

Warning

最大访问数设置过大可能会对目标网站造成过度负担。 验证功能时，请务必从小值（10～100左右）开始。 爬取您不管理的网站时，请遵循 robots.txt 的设置。

2. 执行爬取

点击左侧菜单的「系统」>「调度器」。 点击「Default Crawler」作业的「立即启动」按钮，即可立即开始爬取。

如需定时执行，选择「Default Crawler」并设置定时计划。 如果开始时间为上午 10:35，则设置为 35 10 * * ?（格式为「分 时 日 月 星期」）。 更新后，将在该时间之后开始爬取。

可以在「爬取信息」中确认是否已开始。 爬取完成后，会话信息中会显示 WebIndexSize 的信息。

3. 搜索

爬取完成后，访问 http://localhost:8080/ 并进行搜索，即可显示搜索结果。

了解更多

请参考以下文档等。