Menu

启动、停止、初始设置

本页面说明 Fess 服务器的启动、停止和初始设置步骤。

Important

启动 Fess 前,必须先启动 OpenSearch。 如果 OpenSearch 未启动,Fess 将无法正常工作。

启动方法

根据安装方法的不同,启动步骤也不同。

TAR.GZ 版的情况

启动 OpenSearch

$ cd /path/to/opensearch-3.3.2
$ ./bin/opensearch

在后台启动:

$ ./bin/opensearch -d

启动 Fess

$ cd /path/to/fess-15.3.2
$ ./bin/fess

在后台启动:

$ ./bin/fess -d

Note

启动可能需要几分钟。 可以在日志文件(logs/fess.log)中确认启动状态。

ZIP 版的情况(Windows)

启动 OpenSearch

  1. 打开 OpenSearch 的安装目录

  2. 双击 bin 文件夹中的 opensearch.bat

或者,从命令提示符:

C:\> cd C:\opensearch-3.3.2
C:\opensearch-3.3.2> bin\opensearch.bat

启动 Fess

  1. 打开 Fess 的安装目录

  2. 双击 bin 文件夹中的 fess.bat

或者,从命令提示符:

C:\> cd C:\fess-15.3.2
C:\fess-15.3.2> bin\fess.bat

RPM/DEB 版的情况 (chkconfig)

启动 OpenSearch:

$ sudo service opensearch start

启动 Fess:

$ sudo service fess start

确认启动状态:

$ sudo service fess status

RPM/DEB 版的情况 (systemd)

启动 OpenSearch:

$ sudo systemctl start opensearch.service

启动 Fess:

$ sudo systemctl start fess.service

确认启动状态:

$ sudo systemctl status fess.service

启用服务自动启动:

$ sudo systemctl enable opensearch.service
$ sudo systemctl enable fess.service

Docker 版的情况

使用 Docker Compose 启动:

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

确认启动状态:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml ps

确认日志:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f fess

确认启动

确认 Fess 是否正常启动。

健康检查

在浏览器或使用 curl 命令访问以下 URL:

http://localhost:8080/

如果正常启动,会显示 Fess 的搜索页面。

在命令行确认:

$ curl -I http://localhost:8080/

如果返回 HTTP/1.1 200 OK,则正常启动。

确认日志

确认启动日志,检查是否有错误。

TAR.GZ/ZIP 版:

$ tail -f /path/to/fess-15.3.2/logs/fess.log

RPM/DEB 版:

$ sudo tail -f /var/log/fess/fess.log

或使用 journalctl:

$ sudo journalctl -u fess.service -f

Docker 版:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f fess

Tip

如果正常启动,日志中会显示以下消息:

INFO  Boot - Fess is ready.

在浏览器中访问

访问以下 URL 确认 Web 界面。

搜索页面

URL: http://localhost:8080/

显示 Fess 的搜索页面。初始状态下,由于未进行爬取配置,不会显示搜索结果。

管理页面

URL: http://localhost:8080/admin

默认管理员账号:

  • 用户名: admin

  • 密码: admin

Warning

关于安全的重要注意事项

必须更改默认密码。 特别是在生产环境中,强烈建议在首次登录后立即更改密码。

初始设置

登录管理页面后,进行以下初始配置。

步骤 1: 更改管理员密码

  1. 登录管理页面(http://localhost:8080/admin

  2. 点击左侧菜单的「系统」→「用户」

  3. 点击 admin 用户

  4. 在「密码」字段输入新密码

  5. 点击「确认」按钮

  6. 点击「更新」按钮

Important

推荐密码满足以下条件:

  • 8个字符或以上

  • 组合使用大写字母、小写字母、数字、符号

  • 不易被猜测

步骤 2: 创建爬取配置

创建要爬取的网站或文件系统的配置。

  1. 点击左侧菜单的「爬虫」→「网页」

  2. 点击「新建」按钮

  3. 输入必要信息:

    • 名称: 爬取配置的名称(例:公司网站)

    • URL: 要爬取的 URL(例:https://www.example.com/

    • 最大访问数: 爬取页面数的上限

    • 间隔: 爬取间隔(毫秒)

  4. 点击「创建」按钮

步骤 3: 执行爬取

  1. 点击左侧菜单的「系统」→「调度器」

  2. 点击「Default Crawler」作业的「立即开始」按钮

  3. 等待爬取完成(可在仪表板查看进度)

步骤 4: 确认搜索

  1. 访问搜索页面(http://localhost:8080/

  2. 输入搜索关键词

  3. 确认显示搜索结果

Note

爬取可能需要较长时间。 对于大规模网站,可能需要数小时到数天。

其他推荐设置

在生产环境运行时,还需要考虑以下设置。

邮件服务器设置

为了通过邮件接收故障通知和报告,请设置邮件服务器。

  1. 点击左侧菜单的「系统」→「常规」

  2. 点击「邮件」选项卡

  3. 输入 SMTP 服务器信息

  4. 点击「更新」按钮

时区设置

  1. 点击左侧菜单的「系统」→「常规」

  2. 将「时区」设置为适当的值(例:Asia/Shanghai)

  3. 点击「更新」按钮

调整日志级别

在生产环境中,可以调整日志级别以控制磁盘使用量。

编辑配置文件(app/WEB-INF/classes/log4j2.xml)。

详情请参阅管理员指南。

停止方法

TAR.GZ/ZIP 版的情况

停止 Fess

终止进程:

$ ps aux | grep fess
$ kill <PID>

或者,在前台运行时可以使用 Ctrl+C 停止。

停止 OpenSearch:

$ ps aux | grep opensearch
$ kill <PID>

RPM/DEB 版的情况 (chkconfig)

停止 Fess:

$ sudo service fess stop

停止 OpenSearch:

$ sudo service opensearch stop

RPM/DEB 版的情况 (systemd)

停止 Fess:

$ sudo systemctl stop fess.service

停止 OpenSearch:

$ sudo systemctl stop opensearch.service

Docker 版的情况

停止容器:

$ docker compose -f compose.yaml -f compose-opensearch3.yaml stop

停止并删除容器:

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

Warning

如果使用 down 命令时同时删除卷,请添加 -v 选项。 这种情况下会删除所有数据,请注意。

重启方法

TAR.GZ/ZIP 版的情况

先停止后启动。

RPM/DEB 版的情况

chkconfig:

$ sudo service fess restart

systemd:

$ sudo systemctl restart fess.service

Docker 版的情况

$ docker compose -f compose.yaml -f compose-opensearch3.yaml restart

故障排除

无法启动的情况

  1. 确认 OpenSearch 是否启动

    $ curl http://localhost:9200/
    

    如果 OpenSearch 未启动,请先启动 OpenSearch。

  2. 确认端口号冲突

    $ sudo netstat -tuln | grep 8080
    

    如果端口 8080 已被使用,请在配置文件中更改端口号。

  3. 确认日志

    确认错误消息以找出问题。

  4. 确认 Java 版本

    $ java -version
    

    请确认已安装 Java 21 或更高版本。

详细的故障排除请参阅 故障排除

下一步

Fess 正常启动后,请参阅以下文档开始运维: