归档文档

15.4

Fess 安装指南

• 简介
  • 关于本文档
  • 目标读者
  • 阅读前须知
  • 文档结构
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 如何提交意见和建议
• 系统要求
  • 硬件要求
    • 最低要求
    • 推荐配置
  • 软件要求
    • 操作系统
    • 必需软件
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • 网络要求
    • 所需端口
    • 防火墙设置
  • 浏览器要求
  • 安装前检查清单
  • 下一步
• 选择安装方法
  • 确认前提条件
  • 安装方法对比
  • 各安装方法的特点
    • Docker 版
    • Linux 包版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • 安装的基本流程
  • 必需组件
    • Fess 本体
    • OpenSearch
    • Java (Docker 版除外)
  • 下一步
  • 常见问题
    • Q: OpenSearch 是必需的吗？
    • Q: 可以从旧版本升级吗？
    • Q: 可以使用多个服务器构成吗？
  • 下载
  • 版本信息
• 在 Linux 上安装（详细步骤）
  • 前提条件
  • 选择安装方法
  • 使用 TAR.GZ 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 使用 RPM 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 使用 DEB 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 安装后的确认
  • 下一步
  • 常见问题
    • Q: OpenSearch 的其他版本也能工作吗？
    • Q: 多个 Fess 实例可以共享同一个 OpenSearch 吗？
    • Q: 如何将 OpenSearch 配置为集群？
• 在 Windows 上安装（详细步骤）
  • 前提条件
  • 确认 Java 安装
  • 设置环境变量
  • 步骤 1: 安装 OpenSearch
    • 下载 OpenSearch
    • 安装 OpenSearch 插件
    • 配置 OpenSearch
  • 步骤 2: 安装 Fess
    • 下载 Fess
    • 配置 Fess
    • 确认安装
  • 步骤 3: 启动
  • 注册为 Windows 服务（可选）
    • 使用 NSSM 的示例
  • 防火墙设置
  • 故障排除
    • 端口号冲突
    • 路径长度限制
    • Java 未被识别
  • 下一步
  • 常见问题
    • Q: 推荐在 Windows Server 上运行吗？
    • Q: 64 位版和 32 位版有什么区别？
    • Q: 路径包含日文时的处理方法？
• 使用 Docker 安装（详细）
  • 前提条件
  • 确认 Docker 安装
  • 关于 Docker 镜像
  • 步骤 1: 获取 Docker Compose 文件
    • 方法 1: 单独下载文件
    • 方法 2: 使用 Git 克隆仓库
  • 步骤 2: 确认 Docker Compose 文件
    • compose.yaml 的内容
    • compose-opensearch3.yaml 的内容
    • 自定义配置（可选）
  • 步骤 3: 启动 Docker 容器
    • 基本启动
    • 确认启动
  • 步骤 4: 在浏览器中访问
  • 数据持久化
  • 停止 Docker 容器
  • 高级配置
    • 自定义环境变量
    • 如何应用配置文件
      • 方法 1：挂载配置文件
      • 方法 2：通过系统属性进行配置
    • 连接到外部 OpenSearch
    • Docker 网络配置
  • 使用 Docker Compose 的生产运维
  • 故障排除
    • 容器无法启动
    • 内存不足错误
    • 数据初始化
  • 下一步
  • 常见问题
    • Q: Docker 镜像有多大？
    • Q: 可以在 Kubernetes 上运行吗？
    • Q: 如何更新容器？
    • Q: 可以配置多节点吗？
• 启动、停止、初始设置
  • 启动方法
    • TAR.GZ 版的情况
      • 启动 OpenSearch
      • 启动 Fess
    • ZIP 版的情况（Windows）
      • 启动 OpenSearch
      • 启动 Fess
    • RPM/DEB 版的情况 (chkconfig)
    • RPM/DEB 版的情况 (systemd)
    • Docker 版的情况
  • 确认启动
    • 健康检查
    • 确认日志
  • 在浏览器中访问
    • 搜索页面
    • 管理页面
  • 初始设置
    • 步骤 1: 更改管理员密码
    • 步骤 2: 创建爬取配置
    • 步骤 3: 执行爬取
    • 步骤 4: 确认搜索
  • 其他推荐设置
    • 邮件服务器设置
    • 时区设置
    • 调整日志级别
  • 停止方法
    • TAR.GZ/ZIP 版的情况
      • 停止 Fess
    • RPM/DEB 版的情况 (chkconfig)
    • RPM/DEB 版的情况 (systemd)
    • Docker 版的情况
  • 重启方法
    • TAR.GZ/ZIP 版的情况
    • RPM/DEB 版的情况
    • Docker 版的情况
  • 故障排除
    • 无法启动的情况
  • 下一步
• 安全配置
  • 必需的安全配置
    • 更改管理员密码
    • 启用 OpenSearch 安全插件
    • 启用 HTTPS
  • 推荐的安全配置
    • 防火墙设置
    • 访问控制设置
    • 基于角色的访问控制 (RBAC)
    • 启用审计日志
    • 定期安全更新
  • 数据保护
    • 备份加密
  • 安全最佳实践
    • 最小权限原则
    • 网络隔离
    • 定期安全审计
    • 安全头配置
  • 安全检查清单
    • 基本设置
    • 网络安全
    • 访问控制
    • 监控和日志
    • 备份和恢复
    • 更新和补丁管理
  • 安全事件响应
  • 参考信息
• 升级步骤
  • 支持版本
  • 升级前的准备
    • 确认版本兼容性
    • 计划停机时间
  • 步骤 1: 数据备份
    • 备份配置数据
    • 备份索引数据
      • 方法 1: 使用快照功能（推荐）
      • 方法 2: 整体备份目录
    • Docker 版的备份
  • 步骤 2: 停止当前版本
  • 步骤 3: 安装新版本
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • 步骤 4: 升级 OpenSearch（如需要）
  • 步骤 5: 启动新版本
  • 步骤 6: 运行确认
  • 步骤 7: 重建索引（推荐）
  • 回滚步骤
    • 步骤 1: 停止新版本
    • 步骤 2: 恢复旧版本
    • 步骤 3: 恢复数据
    • 步骤 4: 启动和确认服务
  • 常见问题
    • Q: 可以无停机时间升级吗？
    • Q: 需要升级 OpenSearch 吗？
    • Q: 需要重建索引吗？
    • Q: 升级后搜索结果不显示
  • 下一步
• 卸载步骤
  • 卸载前的准备
    • 获取备份
    • 停止服务
  • TAR.GZ/ZIP 版的卸载
    • 步骤 1: 删除 Fess
    • 步骤 2: 删除 OpenSearch
    • 步骤 3: 删除数据目录（可选）
    • 步骤 4: 删除日志目录（可选）
  • RPM 版的卸载
    • 步骤 1: 卸载 Fess
    • 步骤 2: 卸载 OpenSearch
    • 步骤 3: 禁用和删除服务
    • 步骤 4: 删除数据目录
    • 步骤 5: 删除配置文件
    • 步骤 6: 删除日志文件
    • 步骤 7: 删除用户和组（可选）
  • DEB 版的卸载
    • 步骤 1: 卸载 Fess
    • 步骤 2: 卸载 OpenSearch
    • 步骤 3: 禁用服务
    • 步骤 4: 删除数据目录
    • 步骤 5: 删除配置文件（如未使用 dpkg -P）
    • 步骤 6: 删除日志文件
    • 步骤 7: 删除用户和组（可选）
  • Docker 版的卸载
    • 步骤 1: 删除容器和网络
    • 步骤 2: 删除卷
    • 步骤 3: 删除镜像（可选）
    • 步骤 4: 删除网络（可选）
    • 步骤 5: 删除 Compose 文件
  • 确认卸载
    • 确认进程
    • 确认端口
    • 确认文件
    • 确认包
  • 部分卸载
    • 仅删除 Fess 保留 OpenSearch
    • 仅删除 OpenSearch 保留 Fess
  • 故障排除
    • 无法删除包
    • 无法删除目录
  • 重新安装的准备
  • 下一步
• 故障排除
  • 安装时的问题
    • Java 未被识别
    • 插件安装失败
  • 启动时的问题
    • Fess 无法启动
    • OpenSearch 无法启动
    • 端口号冲突
  • 连接问题
    • Fess 无法连接到 OpenSearch
    • 无法从浏览器访问 Fess
  • 性能问题
    • 搜索速度慢
    • 爬取速度慢
  • 数据问题
    • 不显示搜索结果
    • 索引损坏
  • Docker 特有的问题
    • 容器无法启动
    • 容器启动但无法访问 Fess
  • Windows 特有的问题
    • 路径问题
    • 无法注册为服务
  • 其他问题
    • 更改日志级别
    • 重置数据库
  • 支持信息
    • 社区支持
    • 商业支持
  • 收集调试信息

Fess 用户指南

• 简介
  • 目标读者
  • 阅读前须知
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的参考
  • 评论和建议的提交方式
• AND 检索
  • 使用方法
• OR 检索
  • 使用方法
• NOT 检索
  • 使用方法
• 标签指定检索
  • 标签指定检索(分类检索)
    • 使用方法
• 搜索字段指定检索
  • 字段指定检索
    • 可用字段
    • 使用方法
• 排序检索
  • 排序对象字段
  • 使用方法
• 通配符检索
  • 使用方法
  • 使用条件
• 范围指定检索
  • 使用方法
• 提升检索
  • 提升检索(加权检索)
    • 使用方法
• 模糊检索
  • 模糊检索(Fuzzy检索)
    • 使用方法
• 位置信息检索
  • 使用方法
• 非显示检索条件
  • 使用方法
• 角色检索
  • 检索方法
  • 密码更改
  • 退出登录
• 特殊字符
  • 使用方法
• 高级检索
  • 使用方法
  • 项目列表
    • 包含所有单词
    • 包括词序的完全匹配
    • 包含任一单词
    • 不包含的单词
    • 显示数量
    • 排序
    • 优先语言
    • 标签
    • 更新日期
    • 文件格式
    • 检索对象
    • 网站或域名

Fess API指南

• 简介
  • 目标读者
  • 阅读本文档前
  • API使用前提条件
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的声明
  • 提交意见和建议的方式
• API概述
  • Fess 提供的API
  • 基础URL
  • 身份验证
  • HTTP方法
  • 响应格式
  • 错误处理
  • API类型
• 搜索API
  • 获取搜索结果
    • 请求
    • 请求参数
    • 响应
  • 搜索所有文档
    • 请求参数
  • 错误响应
• 标签API
  • 获取标签
    • 请求
    • 请求参数
    • 响应
  • 使用示例
  • 错误响应
• 热门词API
  • 获取热门词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 建议API
  • 获取建议词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 健康检查API
  • 获取状态
    • 请求
    • 请求参数
    • 响应
  • 错误响应

Fess 管理员指南

• 简介
  • 目标读者
  • 阅读前须知
  • 在线访问
  • 技术支持联系方式
    • 商业支持
• 仪表板
  • 概述
  • 确认已索引的文档数
• 配置向导
  • 概述
    • 简易设置
    • 爬取配置
    • 配置项
      • 名称
      • 爬取路径
      • 最大访问数
      • 深度
    • 爬虫
• 常规
  • 概述
  • 配置内容
    • 系统
      • JSON响应
      • 需要登录
      • 显示登录链接
      • 折叠重复结果
      • 缩略图显示
      • 默认标签值
      • 默认排序值
      • 虚拟主机
      • 热门词响应
      • CSV文件编码
      • 添加搜索参数
      • 通知邮件
    • 爬虫
      • 检查最后更新时间
      • 并发爬虫配置
      • 删除旧文档
      • 排除的错误类型
      • 故障数阈值
    • 日志记录
      • 搜索日志
      • 用户日志
      • 收藏日志
      • 删除旧搜索日志
      • 删除旧作业日志
      • 删除旧用户日志
      • 要删除日志的机器人名称
      • 日志级别
    • 建议
      • 搜索词建议
      • 文档建议
      • 删除旧建议信息
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • 密码
      • User DN
      • 账户过滤器
      • 组过滤器
      • memberOf属性
    • 公告显示
      • 登录页面
      • 搜索首页
    • 存储
      • 类型
      • 存储桶
      • 端点
      • 访问密钥
      • 私密密钥
      • 区域
      • 项目ID
      • 凭据路径
    • LDAP配置示例
• 调度器
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 目标
      • 计划
      • 执行方法
      • 脚本
      • 日志记录
      • 爬虫作业
      • 状态
      • 显示顺序
    • 删除配置
  • 手动爬取方法
• 页面设计
  • 概述
  • 配置方法
    • 显示方法
    • 文件管理器
    • 页面文件显示
    • 上传文件
      • 文件上传
      • 文件名(可选)
• 词典
  • 概述
  • 列表
  • Kuromoji
  • 同义词
  • 映射
  • Protwords
  • 停用词
  • Stemmer覆盖
• Kuromoji词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 标记
      • 分割
      • 读音
      • 词性
  • 下载
  • 上传
• 同义词词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• 映射词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• Protwords词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 单词信息
  • 下载
  • 上传
• 停用词词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• Stemmer覆盖词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• 访问令牌
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 权限
      • 参数名称
      • 有效期
    • 删除配置
• 插件
  • 概述
  • 管理方法
    • 显示方法
    • 安装
• 存储
  • 概述
  • 管理方法
    • 对象存储服务器配置
      • 通用设置
      • S3 设置
      • GCS 设置
      • MinIO（S3 兼容）设置
    • 显示方法
    • 下载
    • 删除
    • 上传
    • 创建文件夹
• 网页爬取
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • URL
      • 爬取对象URL
      • 从爬取对象中排除的URL
      • 搜索对象URL
      • 从搜索对象中排除的URL
      • 配置参数
      • 深度
      • 最大访问数
      • 用户代理
      • 线程数
      • 间隔
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • 爬取 fess.codelibs.org
    • 爬取需要网页认证的站点
      • Redmine
      • XWiki
• 文件抓取
  • 概述
  • 管理方式
    • 显示方式
    • 创建配置
    • 配置项
      • 名称
      • 路径
      • 包含在抓取中的路径
      • 排除在抓取外的路径
      • 包含在搜索中的路径
      • 排除在搜索外的路径
      • 配置参数
      • 深度
      • 最大访问数
      • 线程数
      • 间隔
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • 抓取本地文件
    • 抓取Windows共享文件夹
    • 抓取 Amazon S3 存储桶
    • 抓取 Google Cloud Storage 存储桶
• 数据存储爬取
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 处理器名称
      • 参数
      • 脚本
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • DatabaseDataStore
      • 参数
      • 脚本
      • 驱动程序
    • CsvDataStore
      • 参数
      • 脚本
    • EsDataStore
      • 参数
      • 脚本
    • CsvListDataStore
      • 参数
      • 脚本
• 标签
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 值
      • 目标路径
      • 排除路径
      • 权限
      • 虚拟主机
      • 显示顺序
    • 删除配置
• 关键词匹配
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 查询
      • 大小
      • 提升值
      • 虚拟主机
    • 删除配置
• 文档提升
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 条件
      • 提升值表达式
      • 排序顺序
    • 删除配置
• 相关内容
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 内容
      • 虚拟主机
    • 删除配置
• 相关查询
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 查询
      • 虚拟主机
    • 删除配置
• 路径映射
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 正则表达式
      • 替换
      • 处理类型
      • 显示顺序
      • 用户代理
    • 删除配置
  • 示例
    • 通过Web服务器访问文件服务器
    • 仅在显示时转换URL
    • 服务器迁移时的链接转换
  • 注意事项
    • 关于提取的URL转换
    • 关于正则表达式
    • 关于排序顺序
• Web 认证
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 主机名
      • 端口
      • 领域
      • 方案
      • 用户名
      • 密码
      • 参数
      • Web 配置
    • 删除配置
• 文件认证
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 主机名
      • 端口
      • 协议
      • 用户名
      • 密码
      • 参数
      • 文件爬取设置
    • 删除设置
• 请求头
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
      • 值
      • Web 设置
    • 删除设置
• 重复主机
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 正规名
      • 重复名
    • 删除设置
• 用户
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 用户名
      • 角色
      • 组
    • 删除设置
• 角色
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
    • 删除设置
• 组
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
    • 删除方法
• 建议词
  • 概述
  • 管理方法
    • 显示方法
      • 词汇类型
      • 词汇数量
• 追加词汇
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项目
      • 单词
      • 读音
      • 权限
      • 标签
      • 提升值
    • 删除配置
  • 下载
    • CSV内容
  • 上传
    • CSV内容
• 排除词汇
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项目
      • 建议候选词
    • 删除配置
  • 下载
    • CSV内容
  • 上传
    • CSV内容
• 系统信息
  • 概述
  • 管理方法
    • 显示方法
    • 显示项目
      • 环境变量属性
      • 系统属性
      • 应用程序属性
      • 缺陷报告属性
• 搜索日志
  • 概述
  • 管理方法
  • 列表
  • 详情
• 任务日志
  • 概述
  • 管理方法
    • 显示方法
    • 任务日志详情
      • 名称
      • 状态
      • 对象
      • 开始时间
      • 结束时间
      • 执行方式
      • 脚本
      • 结果
• 爬虫信息
  • 概述
  • 管理方法
  • 列表
  • 详情
    • 项目列表
      • 会话ID
      • 爬虫开始时间
      • 爬虫开始时间（Web/文件）
      • 爬虫开始时间（数据存储）
      • 爬虫结束时间（Web/文件）
      • 爬虫执行时间（数据存储）
      • 索引执行时间（数据存储）
      • 索引大小（数据存储）
      • 爬虫结束时间（数据存储）
      • 爬虫状态
      • 爬虫结束时间
      • 爬虫执行时间
• 日志文件
  • 概述
  • 配置方法
    • 显示方法
    • 下载
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 故障URL
  • 概述
  • 管理方法
    • 显示方法
  • 故障URL详情
    • 详情内容
      • URL
      • 线程名
      • 类型
      • 日志
      • 错误次数
      • 最后访问时间
• 搜索
  • 概述
  • 管理方法
    • 显示方法
    • 搜索列表
    • 批量删除
• 备份
  • 概述
    • 下载
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • 上传
• 维护
  • 概述
  • 操作方法
    • 重新索引
    • 配置项
      • 更新别名
      • 初始化词典
      • 分片数
      • 最大副本数
    • 重新加载文档索引
    • Crawler索引
    • 诊断
• 查询请求
  • 概述
  • 操作方法
    • 发送请求
    • 配置项
      • 请求文件

Fess 配置指南

• 简介
  • 目标读者
  • 阅读本文档前
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 第三方网站参考
  • 反馈意见和建议
• 端口与网络配置
  • 概述
  • 使用端口配置
    • 默认端口
    • Fess Web 应用程序端口变更
      • Linux 环境配置
      • 环境变量配置
      • RPM/DEB 软件包配置
      • Windows 环境配置
      • 注册为 Windows 服务时
    • 上下文路径配置
  • 代理服务器配置
    • 概述
    • 爬虫代理服务器配置
      • 基本配置
      • 需要认证的代理服务器配置
      • 从代理服务器排除特定主机
    • 系统全局 HTTP 代理配置
      • 通过环境变量配置代理
  • HTTP 通信配置
    • 文件上传限制
    • 连接超时配置
    • OpenSearch 连接目标变更
      • 连接多个节点
    • SSL/TLS 连接配置
  • 虚拟主机配置
    • 概述
    • 基本配置
  • 反向代理集成
    • Nginx 配置示例
    • Apache 配置示例
    • SSL/TLS 终止
  • 防火墙配置
    • 开放必要端口
    • 安全组配置(云环境)
  • 故障排除
    • 变更端口后无法访问
    • 无法通过代理服务器爬取
    • 无法连接到 OpenSearch
    • 通过反向代理访问时无法正常工作
  • 参考信息
• 内存配置
  • 概述
  • Fess Web 应用程序的内存配置
    • 需要配置的情况
    • 环境变量配置
    • RPM/DEB 软件包配置
    • 推荐内存大小
  • 爬虫的内存配置
    • 需要配置的情况
    • 配置方法
    • 推荐配置
    • 详细 JVM 选项
  • OpenSearch 的内存配置
    • 重要注意事项
    • 配置方法
      • Linux 环境
      • Windows 环境
    • 推荐内存大小
    • 最佳实践
  • 建议/缩略图处理的内存配置
    • 建议生成进程
    • 缩略图生成进程
  • 内存监控与调优
    • 内存使用情况确认
      • Fess 的内存使用情况
      • OpenSearch 的内存使用情况
    • 内存不足的征兆
    • 调优步骤
    • 内存泄漏对策
  • 故障排除
    • 发生 OutOfMemoryError
    • GC 停止时间过长
    • 配置内存后性能仍未改善
  • 参考信息
• 注册为 Windows 服务
  • 注册为 Windows 服务
    • 准备工作
    • 将 OpenSearch 注册为服务
    • 配置
    • 注册方法
    • 服务配置
• 爬虫基本配置
  • 概述
  • 爬虫的基本概念
    • 什么是爬虫
    • 爬虫类型
  • 创建爬取配置
    • 添加基本爬取配置
    • Web爬虫配置示例
      • 公司内网网站爬取
      • 公开网站爬取
    • 文件爬虫配置示例
      • 本地文件系统
      • SMB/CIFS(Windows文件共享)
    • 认证信息配置
  • 执行爬取
    • 手动执行
    • 计划执行
    • 确认爬取状态
  • 基本配置项
    • 爬取目标限制
      • URL模式限制
      • 深度限制
      • 最大访问数
    • 并行爬取数(线程数)
    • 爬取间隔
  • 文件大小配置
    • 获取文件大小上限
    • 索引文件大小上限
  • 单词长度限制
    • 概述
    • 配置方法
  • 代理服务器配置
    • 概述
    • 配置方法
    • 系统全局代理配置
  • robots.txt 配置
    • 概述
    • 配置方法
  • User-Agent 配置
    • 管理页面配置
    • 系统全局配置
  • 编码配置
    • 爬取数据编码
    • 文件名编码
  • 爬取故障排除
    • 爬取未启动
    • 爬取中途停止
    • 特定页面未被爬取
    • 爬取缓慢
  • 最佳实践
    • 爬取配置推荐事项
    • 计划配置推荐事项
  • 参考信息
• 爬虫高级配置
  • 概述
  • 全局配置
    • 配置文件位置
    • 默认脚本
    • HTTP 线程池
  • 文档处理配置
    • 基本配置
      • 配置示例
    • 单词处理配置
      • 配置示例
    • 字符处理配置
      • 配置示例
  • 协议配置
    • 支持的协议
      • 配置示例
    • 环境变量参数
  • robots.txt 配置
  • 错误处理配置
  • 系统监控配置
    • 热线程配置
      • 配置示例
  • 元数据配置
  • HTML 爬虫配置
    • XPath 配置
      • 配置示例
      • 自定义 XPath 示例
    • HTML 标签处理
      • 配置示例
    • URL 模式过滤器
      • 配置示例
  • 文件爬虫配置
    • 基本配置
      • 配置示例
    • 内容处理
      • 配置示例
    • 文件 URL 模式过滤器
      • 配置示例
  • 缓存配置
    • 文档缓存
      • 配置示例
  • JVM 选项
    • 默认配置
    • 主要选项说明
    • 自定义配置示例
  • 性能调优
    • 爬取速度优化
    • 内存使用量优化
    • 索引质量提升
  • 故障排除
    • 内存不足
    • 爬取缓慢
    • 无法提取特定内容
    • 发生乱码
  • 最佳实践
  • S3/GCS 爬虫配置
    • S3 爬虫
      • 配置示例
    • GCS 爬虫
      • 配置示例
  • 参考信息
• 缩略图配置
  • 概述
  • 支持的文件格式
    • 图片文件
    • 文档文件
    • HTML 内容
  • 所需的外部工具
    • 基本工具（必需）
    • SVG 支持
    • PDF 支持
    • MS Office 支持
    • PostScript 支持
  • HTML 文件缩略图
  • 配置
    • 配置文件
    • 主要配置项（fess_config.properties）
  • generate-thumbnail 脚本
    • 概述
    • 用法
    • 参数
    • 支持的类型
    • 示例
  • 缩略图存储位置
    • 默认路径
    • 目录结构
  • 禁用缩略图任务
  • 故障排除
    • 缩略图未生成
    • GIF/TIFF 文件出错
    • SVG 缩略图未生成
    • 权限错误
  • 平台支持
• 搜索功能
  • 概述
  • 搜索结果数量显示
    • 默认行为
    • 显示准确命中数量
  • 搜索选项
    • 基本搜索
    • OR 搜索
    • NOT 搜索
    • 短语搜索
    • 字段指定搜索
    • 通配符搜索
    • 模糊搜索
  • 搜索结果排序
  • 分面搜索
  • 搜索结果高亮显示
  • 建议功能
  • 搜索日志
  • 性能调优
    • 搜索超时配置
    • 搜索查询最大字符数
    • 使用缓存
  • 故障排除
    • 搜索结果未显示
    • 搜索速度慢
    • 显示不相关结果
• 搜索相关配置
  • 模糊搜索
  • 搜索超时值
  • 搜索最大字符数
  • 搜索超时日志输出
  • 命中数量显示
  • 位置信息搜索索引名
  • 请求参数语言指定
  • 前方一致搜索指定
  • 高亮字符串
  • 高亮片段
  • 高亮生成方法
  • 高亮对象标签
  • 传递给 OpenSearch 高亮器的值
  • 添加到响应的字段名
  • 添加字段名
  • 以 GSA 兼容 XML 格式获取搜索结果的配置
• 位置信息搜索
  • 概述
  • 用例
  • 配置方法
    • 索引生成时的配置
      • 位置信息字段定义
      • 位置信息注册格式
      • 数据存储爬取的配置示例
      • 脚本添加位置信息
    • 搜索时的配置
      • 请求参数
      • 距离单位
  • 搜索示例
    • 基本搜索
    • 当前位置周边搜索
    • 按距离排序
    • API 使用
  • 字段名自定义
    • 更改默认字段名
  • 实现示例
    • Web 应用程序实现
    • Google 地图集成
  • 性能优化
    • 索引配置优化
    • 搜索范围限制
  • 故障排除
    • 位置信息搜索无法工作
    • 搜索结果未返回
    • 位置信息未正确显示
  • 参考信息
• 批量获取搜索结果
  • 概述
  • 用例
  • 配置方法
    • 启用滚动搜索
    • 响应字段配置
    • 滚动超时配置
  • 使用方法
    • 基本使用方法
    • 请求参数
    • 指定搜索查询
    • 指定获取条数
    • 按标签过滤
    • 需要认证时
  • 响应格式
    • NDJSON 格式
    • 响应字段
  • 数据处理示例
    • Python 处理示例
    • 保存到文件
    • 转换为 CSV
    • 数据分析
  • 性能和最佳实践
    • 高效使用方法
    • 内存使用量优化
  • 安全注意事项
    • 访问限制
    • 速率限制
  • 故障排除
    • 无法使用滚动搜索
    • 发生超时错误
    • 内存不足错误
    • 响应为空
  • 参考信息
• 搜索表单集成
  • 搜索表单配置方法
    • 搜索表单
    • 建议功能
• 基于角色的搜索配置
  • 关于基于角色的搜索
  • 基于角色的搜索配置
    • Fess 管理页面配置
    • 登录
    • 登出
• 虚拟主机
  • 关于虚拟主机
    • 系统配置
    • 爬取配置
• SAML认证SSO配置
  • 概述
    • SAML认证的工作原理
  • 前提条件
  • 基本配置
    • 启用SSO
    • SP（服务提供者）配置
      • 单独URL配置
    • IdP（身份提供者）配置
    • 获取SP元数据
  • IdP侧配置
    • 从IdP获取的信息
  • 用户属性映射
    • 组属性配置
    • 角色属性配置
  • 安全配置
    • 签名设置
    • 加密设置
    • 其他安全设置
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
  • 故障排除
    • 常见问题和解决方案
      • 认证后无法返回Fess
      • 签名验证错误
      • 用户组/角色未生效
    • 调试设置
  • 参考
• OpenID Connect SSO配置
  • 概述
    • OpenID Connect认证的工作原理
  • 前提条件
  • 基本配置
    • 启用SSO
    • 提供者配置
    • 客户端配置
    • 重定向URL配置
  • OP侧配置
    • 从OP获取的信息
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
  • 故障排除
    • 常见问题和解决方案
      • 认证后无法返回Fess
      • 发生认证错误
      • 无法获取用户信息
    • 调试设置
  • 参考
• Microsoft Entra ID SSO配置
  • 概述
    • Entra ID认证的工作原理
  • 前提条件
  • 基本配置
    • 启用SSO
    • 必需设置
    • 可选设置
  • Entra ID侧配置
    • 在Azure Portal中注册应用
    • 创建客户端密钥
    • 配置API权限
    • 需要获取的信息
  • 组和角色映射
    • 嵌套组
    • 默认组设置
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
    • 旧版配置（向后兼容）
  • 故障排除
    • 常见问题和解决方案
      • 认证后无法返回Fess
      • 发生认证错误
      • 无法获取组信息
    • 调试设置
  • 参考
• Windows集成认证SSO配置
  • 概述
    • Windows集成认证的工作原理
  • 前提条件
  • Active Directory端配置
    • 注册服务主体名称（SPN）
  • 基本配置
    • 启用SSO
    • Kerberos配置文件
    • 登录配置文件
    • 必需设置
    • 可选设置
  • LDAP配置
  • 浏览器设置
    • Internet Explorer / Microsoft Edge
    • Google Chrome
    • Mozilla Firefox
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
  • 故障排除
    • 常见问题和解决方案
      • 出现认证对话框
      • 发生认证错误
      • 无法获取组信息
    • 调试设置
  • 参考
• 日志配置
  • 概述
  • 日志文件类型
    • 主要日志文件
    • 日志文件位置
    • 故障排除时的日志确认
  • 日志级别配置
    • 什么是日志级别
    • 推荐日志级别
    • 从管理页面变更
    • 通过配置文件变更
      • 配置文件位置
      • 基本配置示例
      • 通过环境变量配置
  • 爬虫日志配置
    • 管理页面配置
      • 仅更改特定URL模式的日志级别
      • 更改整个爬虫进程的日志级别
  • 日志轮转
    • 概述
    • Log4j2 自动轮转
      • 默认配置
      • 每日轮转配置
      • 压缩配置
    • logrotate 轮转
  • 日志监控
    • 需要监控的日志模式
      • 重要错误模式
      • 应警告的模式
    • 实时监控
    • 监控工具示例
    • 告警配置
  • 日志格式
    • 默认格式
    • 自定义格式示例
      • JSON格式输出日志
      • 包含更详细信息
  • 性能影响
    • 最佳实践
    • 性能测量
  • 故障排除
    • 日志未输出
    • 日志文件过大
    • 找不到特定日志
    • 日志出现乱码
  • 参考信息
• 索引管理
  • 概述
  • 索引构成
  • 索引备份和恢复
    • 快照仓库配置
    • 创建快照(备份)
      • 备份所有索引
      • 备份特定索引
      • 定期自动备份
    • 确认快照
    • 从快照恢复
      • 恢复所有索引
      • 恢复特定索引
      • 更改索引名恢复
    • 删除快照
  • 配置文件备份
    • 备份对象文件
    • 配置文件备份示例
  • 数据迁移
    • 迁移到其他环境的步骤
    • 版本升级注意事项
  • 故障排除
    • 快照创建失败
    • 恢复失败
    • 恢复后无法搜索
  • 参考信息
• Analyzer 配置
  • 关于 Analyzer
• 搜索日志可视化配置
  • 关于搜索日志可视化
    • 可视化的信息
  • OpenSearch Dashboards 数据可视化配置
    • OpenSearch Dashboards 安装
    • 编辑配置文件
    • 启动 OpenSearch Dashboards
    • 配置索引模式
    • 创建可视化和仪表板
      • 创建基本可视化
      • 创建仪表板
    • 时区配置
    • 确认日志数据
    • 主要搜索日志字段
    • 故障排除
      • 数据未显示
      • 发生连接错误

JavaDocs

XRef

I/F Doc

15.3

Fess 安装指南

• 简介
  • 关于本文档
  • 目标读者
  • 阅读前须知
  • 文档结构
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 如何提交意见和建议
• 系统要求
  • 硬件要求
    • 最低要求
    • 推荐配置
  • 软件要求
    • 操作系统
    • 必需软件
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • 网络要求
    • 所需端口
    • 防火墙设置
  • 浏览器要求
  • 安装前检查清单
  • 下一步
• 选择安装方法
  • 确认前提条件
  • 安装方法对比
  • 各安装方法的特点
    • Docker 版
    • Linux 包版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • 安装的基本流程
  • 必需组件
    • Fess 本体
    • OpenSearch
    • Java (Docker 版除外)
  • 下一步
  • 常见问题
    • Q: OpenSearch 是必需的吗？
    • Q: 可以从旧版本升级吗？
    • Q: 可以使用多个服务器构成吗？
  • 下载
  • 版本信息
• 在 Linux 上安装（详细步骤）
  • 前提条件
  • 选择安装方法
  • 使用 TAR.GZ 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 使用 RPM 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 使用 DEB 版安装
    • 步骤 1: 安装 OpenSearch
    • 步骤 2: 安装 Fess
    • 步骤 3: 启动
  • 安装后的确认
  • 下一步
  • 常见问题
    • Q: OpenSearch 的其他版本也能工作吗？
    • Q: 多个 Fess 实例可以共享同一个 OpenSearch 吗？
    • Q: 如何将 OpenSearch 配置为集群？
• 在 Windows 上安装（详细步骤）
  • 前提条件
  • 确认 Java 安装
  • 设置环境变量
  • 步骤 1: 安装 OpenSearch
    • 下载 OpenSearch
    • 安装 OpenSearch 插件
    • 配置 OpenSearch
  • 步骤 2: 安装 Fess
    • 下载 Fess
    • 配置 Fess
    • 确认安装
  • 步骤 3: 启动
  • 注册为 Windows 服务（可选）
    • 使用 NSSM 的示例
  • 防火墙设置
  • 故障排除
    • 端口号冲突
    • 路径长度限制
    • Java 未被识别
  • 下一步
  • 常见问题
    • Q: 推荐在 Windows Server 上运行吗？
    • Q: 64 位版和 32 位版有什么区别？
    • Q: 路径包含日文时的处理方法？
• 使用 Docker 安装（详细）
  • 前提条件
  • 确认 Docker 安装
  • 关于 Docker 镜像
  • 步骤 1: 获取 Docker Compose 文件
    • 方法 1: 单独下载文件
    • 方法 2: 使用 Git 克隆仓库
  • 步骤 2: 确认 Docker Compose 文件
    • compose.yaml 的内容
    • compose-opensearch3.yaml 的内容
    • 自定义配置（可选）
  • 步骤 3: 启动 Docker 容器
    • 基本启动
    • 确认启动
  • 步骤 4: 在浏览器中访问
  • 数据持久化
  • 停止 Docker 容器
  • 高级配置
    • 自定义环境变量
    • 如何应用配置文件
      • 方法 1：挂载配置文件
      • 方法 2：通过系统属性进行配置
    • 连接到外部 OpenSearch
    • Docker 网络配置
  • 使用 Docker Compose 的生产运维
  • 故障排除
    • 容器无法启动
    • 内存不足错误
    • 数据初始化
  • 下一步
  • 常见问题
    • Q: Docker 镜像有多大？
    • Q: 可以在 Kubernetes 上运行吗？
    • Q: 如何更新容器？
    • Q: 可以配置多节点吗？
• 启动、停止、初始设置
  • 启动方法
    • TAR.GZ 版的情况
      • 启动 OpenSearch
      • 启动 Fess
    • ZIP 版的情况（Windows）
      • 启动 OpenSearch
      • 启动 Fess
    • RPM/DEB 版的情况 (chkconfig)
    • RPM/DEB 版的情况 (systemd)
    • Docker 版的情况
  • 确认启动
    • 健康检查
    • 确认日志
  • 在浏览器中访问
    • 搜索页面
    • 管理页面
  • 初始设置
    • 步骤 1: 更改管理员密码
    • 步骤 2: 创建爬取配置
    • 步骤 3: 执行爬取
    • 步骤 4: 确认搜索
  • 其他推荐设置
    • 邮件服务器设置
    • 时区设置
    • 调整日志级别
  • 停止方法
    • TAR.GZ/ZIP 版的情况
      • 停止 Fess
    • RPM/DEB 版的情况 (chkconfig)
    • RPM/DEB 版的情况 (systemd)
    • Docker 版的情况
  • 重启方法
    • TAR.GZ/ZIP 版的情况
    • RPM/DEB 版的情况
    • Docker 版的情况
  • 故障排除
    • 无法启动的情况
  • 下一步
• 安全配置
  • 必需的安全配置
    • 更改管理员密码
    • 启用 OpenSearch 安全插件
    • 启用 HTTPS
  • 推荐的安全配置
    • 防火墙设置
    • 访问控制设置
    • 基于角色的访问控制 (RBAC)
    • 启用审计日志
    • 定期安全更新
  • 数据保护
    • 备份加密
  • 安全最佳实践
    • 最小权限原则
    • 网络隔离
    • 定期安全审计
    • 安全头配置
  • 安全检查清单
    • 基本设置
    • 网络安全
    • 访问控制
    • 监控和日志
    • 备份和恢复
    • 更新和补丁管理
  • 安全事件响应
  • 参考信息
• 升级步骤
  • 支持版本
  • 升级前的准备
    • 确认版本兼容性
    • 计划停机时间
  • 步骤 1: 数据备份
    • 备份配置数据
    • 备份索引数据
      • 方法 1: 使用快照功能（推荐）
      • 方法 2: 整体备份目录
    • Docker 版的备份
  • 步骤 2: 停止当前版本
  • 步骤 3: 安装新版本
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • 步骤 4: 升级 OpenSearch（如需要）
  • 步骤 5: 启动新版本
  • 步骤 6: 运行确认
  • 步骤 7: 重建索引（推荐）
  • 回滚步骤
    • 步骤 1: 停止新版本
    • 步骤 2: 恢复旧版本
    • 步骤 3: 恢复数据
    • 步骤 4: 启动和确认服务
  • 常见问题
    • Q: 可以无停机时间升级吗？
    • Q: 需要升级 OpenSearch 吗？
    • Q: 需要重建索引吗？
    • Q: 升级后搜索结果不显示
  • 下一步
• 卸载步骤
  • 卸载前的准备
    • 获取备份
    • 停止服务
  • TAR.GZ/ZIP 版的卸载
    • 步骤 1: 删除 Fess
    • 步骤 2: 删除 OpenSearch
    • 步骤 3: 删除数据目录（可选）
    • 步骤 4: 删除日志目录（可选）
  • RPM 版的卸载
    • 步骤 1: 卸载 Fess
    • 步骤 2: 卸载 OpenSearch
    • 步骤 3: 禁用和删除服务
    • 步骤 4: 删除数据目录
    • 步骤 5: 删除配置文件
    • 步骤 6: 删除日志文件
    • 步骤 7: 删除用户和组（可选）
  • DEB 版的卸载
    • 步骤 1: 卸载 Fess
    • 步骤 2: 卸载 OpenSearch
    • 步骤 3: 禁用服务
    • 步骤 4: 删除数据目录
    • 步骤 5: 删除配置文件（如未使用 dpkg -P）
    • 步骤 6: 删除日志文件
    • 步骤 7: 删除用户和组（可选）
  • Docker 版的卸载
    • 步骤 1: 删除容器和网络
    • 步骤 2: 删除卷
    • 步骤 3: 删除镜像（可选）
    • 步骤 4: 删除网络（可选）
    • 步骤 5: 删除 Compose 文件
  • 确认卸载
    • 确认进程
    • 确认端口
    • 确认文件
    • 确认包
  • 部分卸载
    • 仅删除 Fess 保留 OpenSearch
    • 仅删除 OpenSearch 保留 Fess
  • 故障排除
    • 无法删除包
    • 无法删除目录
  • 重新安装的准备
  • 下一步
• 故障排除
  • 安装时的问题
    • Java 未被识别
    • 插件安装失败
  • 启动时的问题
    • Fess 无法启动
    • OpenSearch 无法启动
    • 端口号冲突
  • 连接问题
    • Fess 无法连接到 OpenSearch
    • 无法从浏览器访问 Fess
  • 性能问题
    • 搜索速度慢
    • 爬取速度慢
  • 数据问题
    • 不显示搜索结果
    • 索引损坏
  • Docker 特有的问题
    • 容器无法启动
    • 容器启动但无法访问 Fess
  • Windows 特有的问题
    • 路径问题
    • 无法注册为服务
  • 其他问题
    • 更改日志级别
    • 重置数据库
  • 支持信息
    • 社区支持
    • 商业支持
  • 收集调试信息

Fess 用户指南

• 简介
  • 目标读者
  • 阅读前须知
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的参考
  • 评论和建议的提交方式
• AND 检索
  • 使用方法
• OR 检索
  • 使用方法
• NOT 检索
  • 使用方法
• 标签指定检索
  • 标签指定检索(分类检索)
    • 使用方法
• 搜索字段指定检索
  • 字段指定检索
    • 可用字段
    • 使用方法
• 排序检索
  • 排序对象字段
  • 使用方法
• 通配符检索
  • 使用方法
  • 使用条件
• 范围指定检索
  • 使用方法
• 提升检索
  • 提升检索(加权检索)
    • 使用方法
• 模糊检索
  • 模糊检索(Fuzzy检索)
    • 使用方法
• 位置信息检索
  • 使用方法
• 非显示检索条件
  • 使用方法
• 角色检索
  • 检索方法
  • 密码更改
  • 退出登录
• 特殊字符
  • 使用方法
• 高级检索
  • 使用方法
  • 项目列表
    • 包含所有单词
    • 包括词序的完全匹配
    • 包含任一单词
    • 不包含的单词
    • 显示数量
    • 排序
    • 优先语言
    • 标签
    • 更新日期
    • 文件格式
    • 检索对象
    • 网站或域名

Fess API指南

• 简介
  • 目标读者
  • 阅读本文档前
  • API使用前提条件
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的声明
  • 提交意见和建议的方式
• API概述
  • Fess 提供的API
  • 基础URL
  • 身份验证
  • HTTP方法
  • 响应格式
  • 错误处理
  • API类型
• 搜索API
  • 获取搜索结果
    • 请求
    • 请求参数
    • 响应
  • 搜索所有文档
    • 请求参数
  • 错误响应
• 标签API
  • 获取标签
    • 请求
    • 请求参数
    • 响应
  • 使用示例
  • 错误响应
• 热门词API
  • 获取热门词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 建议API
  • 获取建议词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 健康检查API
  • 获取状态
    • 请求
    • 请求参数
    • 响应
  • 错误响应

Fess 管理员指南

• 简介
  • 目标读者
  • 阅读前须知
  • 在线访问
  • 技术支持联系方式
    • 商业支持
• 仪表板
  • 概述
  • 确认已索引的文档数
• 配置向导
  • 概述
    • 简易设置
    • 爬取配置
    • 配置项
      • 名称
      • 爬取路径
      • 最大访问数
      • 深度
    • 爬虫
• 常规
  • 概述
  • 配置内容
    • 系统
      • JSON响应
      • 需要登录
      • 显示登录链接
      • 折叠重复结果
      • 缩略图显示
      • 默认标签值
      • 默认排序值
      • 虚拟主机
      • 热门词响应
      • CSV文件编码
      • 添加搜索参数
      • 通知邮件
    • 爬虫
      • 检查最后更新时间
      • 并发爬虫配置
      • 删除旧文档
      • 排除的错误类型
      • 故障数阈值
    • 日志记录
      • 搜索日志
      • 用户日志
      • 收藏日志
      • 删除旧搜索日志
      • 删除旧作业日志
      • 删除旧用户日志
      • 要删除日志的机器人名称
      • 日志级别
    • 建议
      • 搜索词建议
      • 文档建议
      • 删除旧建议信息
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • 密码
      • User DN
      • 账户过滤器
      • 组过滤器
      • memberOf属性
    • 公告显示
      • 登录页面
      • 搜索首页
    • 存储
      • 端点
      • 访问密钥
      • 私密密钥
      • 存储桶
    • LDAP配置示例
• 调度器
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 目标
      • 计划
      • 执行方法
      • 脚本
      • 日志记录
      • 爬虫作业
      • 状态
      • 显示顺序
    • 删除配置
  • 手动爬取方法
• 页面设计
  • 概述
  • 配置方法
    • 显示方法
    • 文件管理器
    • 页面文件显示
    • 上传文件
      • 文件上传
      • 文件名(可选)
• 词典
  • 概述
  • 列表
  • Kuromoji
  • 同义词
  • 映射
  • Protwords
  • 停用词
  • Stemmer覆盖
• Kuromoji词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 标记
      • 分割
      • 读音
      • 词性
  • 下载
  • 上传
• 同义词词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• 映射词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• Protwords词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 单词信息
  • 下载
  • 上传
• 停用词词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• Stemmer覆盖词典
  • 概述
  • 管理方法
    • 显示方法
    • 配置方法
    • 配置项
      • 转换前
      • 转换后
  • 下载
  • 上传
• 访问令牌
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 权限
      • 参数名称
      • 有效期
    • 删除配置
• 插件
  • 概述
  • 管理方法
    • 显示方法
    • 安装
• 存储
  • 概述
  • 管理方法
    • 对象存储服务器配置
    • 显示方法
      • 名称
      • 大小
      • 最后更新时间
    • 下载
    • 删除
    • 上传
    • 创建文件夹
• 网页爬取
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • URL
      • 爬取对象URL
      • 从爬取对象中排除的URL
      • 搜索对象URL
      • 从搜索对象中排除的URL
      • 配置参数
      • 深度
      • 最大访问数
      • 用户代理
      • 线程数
      • 间隔
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • 爬取 fess.codelibs.org
    • 爬取需要网页认证的站点
      • Redmine
      • XWiki
• 文件抓取
  • 概述
  • 管理方式
    • 显示方式
    • 创建配置
    • 配置项
      • 名称
      • 路径
      • 包含在抓取中的路径
      • 排除在抓取外的路径
      • 包含在搜索中的路径
      • 排除在搜索外的路径
      • 配置参数
      • 深度
      • 最大访问数
      • 线程数
      • 间隔
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • 抓取本地文件
    • 抓取Windows共享文件夹
• 数据存储爬取
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 处理器名称
      • 参数
      • 脚本
      • 权重值
      • 权限
      • 虚拟主机
      • 状态
      • 说明
    • 删除配置
    • DatabaseDataStore
      • 参数
      • 脚本
      • 驱动程序
    • CsvDataStore
      • 参数
      • 脚本
    • EsDataStore
      • 参数
      • 脚本
    • CsvListDataStore
      • 参数
      • 脚本
• 标签
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 名称
      • 值
      • 目标路径
      • 排除路径
      • 权限
      • 虚拟主机
      • 显示顺序
    • 删除配置
• 关键词匹配
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 查询
      • 大小
      • 提升值
      • 虚拟主机
    • 删除配置
• 文档提升
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 条件
      • 提升值表达式
      • 排序顺序
    • 删除配置
• 相关内容
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 内容
      • 虚拟主机
    • 删除配置
• 相关查询
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 搜索词
      • 查询
      • 虚拟主机
    • 删除配置
• 路径映射
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 正则表达式
      • 替换
      • 处理类型
      • 显示顺序
    • 删除配置
• Web 认证
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项
      • 主机名
      • 端口
      • 领域
      • 方案
      • 用户名
      • 密码
      • 参数
      • Web 配置
    • 删除配置
• 文件认证
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 主机名
      • 端口
      • 协议
      • 用户名
      • 密码
      • 参数
      • 文件爬取设置
    • 删除设置
• 请求头
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
      • 值
      • Web 设置
    • 删除设置
• 重复主机
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 正规名
      • 重复名
    • 删除设置
• 用户
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 用户名
      • 角色
      • 组
    • 删除设置
• 角色
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
    • 删除设置
• 组
  • 概述
  • 管理方法
    • 显示方法
    • 创建设置
    • 配置项
      • 名称
    • 删除方法
• 建议词
  • 概述
  • 管理方法
    • 显示方法
      • 词汇类型
      • 词汇数量
• 追加词汇
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项目
      • 单词
      • 读音
      • 权限
      • 标签
      • 提升值
    • 删除配置
  • 下载
    • CSV内容
  • 上传
    • CSV内容
• 排除词汇
  • 概述
  • 管理方法
    • 显示方法
    • 创建配置
    • 配置项目
      • 建议候选词
    • 删除配置
  • 下载
    • CSV内容
  • 上传
    • CSV内容
• 系统信息
  • 概述
  • 管理方法
    • 显示方法
    • 显示项目
      • 环境变量属性
      • 系统属性
      • 应用程序属性
      • 缺陷报告属性
• 搜索日志
  • 概述
  • 管理方法
  • 列表
  • 详情
• 任务日志
  • 概述
  • 管理方法
    • 显示方法
    • 任务日志详情
      • 名称
      • 状态
      • 对象
      • 开始时间
      • 结束时间
      • 执行方式
      • 脚本
      • 结果
• 爬虫信息
  • 概述
  • 管理方法
  • 列表
  • 详情
    • 项目列表
      • 会话ID
      • 爬虫开始时间
      • 爬虫开始时间（Web/文件）
      • 爬虫开始时间（数据存储）
      • 爬虫结束时间（Web/文件）
      • 爬虫执行时间（数据存储）
      • 索引执行时间（数据存储）
      • 索引大小（数据存储）
      • 爬虫结束时间（数据存储）
      • 爬虫状态
      • 爬虫结束时间
      • 爬虫执行时间
• 日志文件
  • 概述
  • 配置方法
    • 显示方法
    • 下载
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 故障URL
  • 概述
  • 管理方法
    • 显示方法
  • 故障URL详情
    • 详情内容
      • URL
      • 线程名
      • 类型
      • 日志
      • 错误次数
      • 最后访问时间
• 搜索
  • 概述
  • 管理方法
    • 显示方法
    • 搜索列表
    • 批量删除
• 备份
  • 概述
    • 下载
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • 上传
• 维护
  • 概述
  • 操作方法
    • 重新索引
    • 配置项
      • 更新别名
      • 初始化词典
      • 分片数
      • 最大副本数
    • 重新加载文档索引
    • Crawler索引
    • 诊断
• 查询请求
  • 概述
  • 操作方法
    • 发送请求
    • 配置项
      • 请求文件

Fess 配置指南

• 简介
  • 目标读者
  • 阅读本文档前
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 第三方网站参考
  • 反馈意见和建议
• 端口与网络配置
  • 概述
  • 使用端口配置
    • 默认端口
    • Fess Web 应用程序端口变更
      • Linux 环境配置
      • 环境变量配置
      • RPM/DEB 软件包配置
      • Windows 环境配置
      • 注册为 Windows 服务时
    • 上下文路径配置
  • 代理服务器配置
    • 概述
    • 爬虫代理服务器配置
      • 基本配置
      • 需要认证的代理服务器配置
      • 从代理服务器排除特定主机
    • 系统全局 HTTP 代理配置
  • HTTP 通信配置
    • 文件上传限制
    • 连接超时配置
    • OpenSearch 连接目标变更
      • 连接多个节点
    • SSL/TLS 连接配置
  • 虚拟主机配置
    • 概述
    • 基本配置
  • 反向代理集成
    • Nginx 配置示例
    • Apache 配置示例
    • SSL/TLS 终止
  • 防火墙配置
    • 开放必要端口
    • 安全组配置(云环境)
  • 故障排除
    • 变更端口后无法访问
    • 无法通过代理服务器爬取
    • 无法连接到 OpenSearch
    • 通过反向代理访问时无法正常工作
  • 参考信息
• 内存配置
  • 概述
  • Fess Web 应用程序的内存配置
    • 需要配置的情况
    • 环境变量配置
    • RPM/DEB 软件包配置
    • 推荐内存大小
  • 爬虫的内存配置
    • 需要配置的情况
    • 配置方法
    • 推荐配置
    • 详细 JVM 选项
  • OpenSearch 的内存配置
    • 重要注意事项
    • 配置方法
      • Linux 环境
      • Windows 环境
    • 推荐内存大小
    • 最佳实践
  • 建议/缩略图处理的内存配置
    • 建议生成进程
    • 缩略图生成进程
  • 内存监控与调优
    • 内存使用情况确认
      • Fess 的内存使用情况
      • OpenSearch 的内存使用情况
    • 内存不足的征兆
    • 调优步骤
    • 内存泄漏对策
  • 故障排除
    • 发生 OutOfMemoryError
    • GC 停止时间过长
    • 配置内存后性能仍未改善
  • 参考信息
• 注册为 Windows 服务
  • 注册为 Windows 服务
    • 准备工作
    • 将 OpenSearch 注册为服务
    • 配置
    • 注册方法
    • 服务配置
• 爬虫基本配置
  • 概述
  • 爬虫的基本概念
    • 什么是爬虫
    • 爬虫类型
  • 创建爬取配置
    • 添加基本爬取配置
    • Web爬虫配置示例
      • 公司内网网站爬取
      • 公开网站爬取
    • 文件爬虫配置示例
      • 本地文件系统
      • SMB/CIFS(Windows文件共享)
    • 认证信息配置
  • 执行爬取
    • 手动执行
    • 计划执行
    • 确认爬取状态
  • 基本配置项
    • 爬取目标限制
      • URL模式限制
      • 深度限制
      • 最大访问数
    • 并行爬取数(线程数)
    • 爬取间隔
  • 文件大小配置
    • 获取文件大小上限
    • 索引文件大小上限
  • 单词长度限制
    • 概述
    • 配置方法
  • 代理服务器配置
    • 概述
    • 配置方法
    • 系统全局代理配置
  • robots.txt 配置
    • 概述
    • 配置方法
  • User-Agent 配置
    • 管理页面配置
    • 系统全局配置
  • 编码配置
    • 爬取数据编码
    • 文件名编码
  • 爬取故障排除
    • 爬取未启动
    • 爬取中途停止
    • 特定页面未被爬取
    • 爬取缓慢
  • 最佳实践
    • 爬取配置推荐事项
    • 计划配置推荐事项
  • 参考信息
• 爬虫高级配置
  • 概述
  • 全局配置
    • 配置文件位置
    • 默认脚本
    • HTTP 线程池
  • 文档处理配置
    • 基本配置
      • 配置示例
    • 单词处理配置
      • 配置示例
    • 字符处理配置
      • 配置示例
  • 协议配置
    • 支持的协议
      • 配置示例
    • 环境变量参数
  • robots.txt 配置
  • 错误处理配置
  • 系统监控配置
    • 热线程配置
      • 配置示例
  • 元数据配置
  • HTML 爬虫配置
    • XPath 配置
      • 配置示例
      • 自定义 XPath 示例
    • HTML 标签处理
      • 配置示例
    • URL 模式过滤器
      • 配置示例
  • 文件爬虫配置
    • 基本配置
      • 配置示例
    • 内容处理
      • 配置示例
    • 文件 URL 模式过滤器
      • 配置示例
  • 缓存配置
    • 文档缓存
      • 配置示例
  • JVM 选项
    • 默认配置
    • 主要选项说明
    • 自定义配置示例
  • 性能调优
    • 爬取速度优化
    • 内存使用量优化
    • 索引质量提升
  • 故障排除
    • 内存不足
    • 爬取缓慢
    • 无法提取特定内容
    • 发生乱码
  • 最佳实践
  • 参考信息
• 缩略图配置
  • 缩略图显示
  • HTML 文件缩略图
  • MS Office 文件缩略图
    • 软件包安装
    • 生成脚本
  • PDF 文件缩略图
  • 禁用缩略图任务
• 搜索功能
  • 概述
  • 搜索结果数量显示
    • 默认行为
    • 显示准确命中数量
  • 搜索选项
    • 基本搜索
    • OR 搜索
    • NOT 搜索
    • 短语搜索
    • 字段指定搜索
    • 通配符搜索
    • 模糊搜索
  • 搜索结果排序
  • 分面搜索
  • 搜索结果高亮显示
  • 建议功能
  • 搜索日志
  • 性能调优
    • 搜索超时配置
    • 搜索查询最大字符数
    • 使用缓存
  • 故障排除
    • 搜索结果未显示
    • 搜索速度慢
    • 显示不相关结果
• 搜索相关配置
  • 模糊搜索
  • 搜索超时值
  • 搜索最大字符数
  • 搜索超时日志输出
  • 命中数量显示
  • 位置信息搜索索引名
  • 请求参数语言指定
  • 前方一致搜索指定
  • 高亮字符串
  • 高亮片段
  • 高亮生成方法
  • 高亮对象标签
  • 传递给 OpenSearch 高亮器的值
  • 添加到响应的字段名
  • 添加字段名
  • 以 GSA 兼容 XML 格式获取搜索结果的配置
• 位置信息搜索
  • 概述
  • 用例
  • 配置方法
    • 索引生成时的配置
      • 位置信息字段定义
      • 位置信息注册格式
      • 数据存储爬取的配置示例
      • 脚本添加位置信息
    • 搜索时的配置
      • 请求参数
      • 距离单位
  • 搜索示例
    • 基本搜索
    • 当前位置周边搜索
    • 按距离排序
    • API 使用
  • 字段名自定义
    • 更改默认字段名
  • 实现示例
    • Web 应用程序实现
    • Google 地图集成
  • 性能优化
    • 索引配置优化
    • 搜索范围限制
  • 故障排除
    • 位置信息搜索无法工作
    • 搜索结果未返回
    • 位置信息未正确显示
  • 参考信息
• 批量获取搜索结果
  • 概述
  • 用例
  • 配置方法
    • 启用滚动搜索
    • 响应字段配置
    • 滚动超时配置
  • 使用方法
    • 基本使用方法
    • 请求参数
    • 指定搜索查询
    • 指定获取条数
    • 按标签过滤
    • 需要认证时
  • 响应格式
    • NDJSON 格式
    • 响应字段
  • 数据处理示例
    • Python 处理示例
    • 保存到文件
    • 转换为 CSV
    • 数据分析
  • 性能和最佳实践
    • 高效使用方法
    • 内存使用量优化
  • 安全注意事项
    • 访问限制
    • 速率限制
  • 故障排除
    • 无法使用滚动搜索
    • 发生超时错误
    • 内存不足错误
    • 响应为空
  • 参考信息
• 搜索表单集成
  • 搜索表单配置方法
    • 搜索表单
    • 建议功能
• 基于角色的搜索配置
  • 关于基于角色的搜索
  • 基于角色的搜索配置
    • Fess 管理页面配置
    • 登录
    • 登出
• 虚拟主机
  • 关于虚拟主机
    • 系统配置
    • 爬取配置
• 日志配置
  • 概述
  • 日志文件类型
    • 主要日志文件
    • 日志文件位置
    • 故障排除时的日志确认
  • 日志级别配置
    • 什么是日志级别
    • 推荐日志级别
    • 从管理页面变更
    • 通过配置文件变更
      • 配置文件位置
      • 基本配置示例
      • 通过环境变量配置
  • 爬虫日志配置
    • 管理页面配置
      • 仅更改特定URL模式的日志级别
      • 更改整个爬虫进程的日志级别
  • 日志轮转
    • 概述
    • Log4j2 自动轮转
      • 默认配置
      • 每日轮转配置
      • 压缩配置
    • logrotate 轮转
  • 日志监控
    • 需要监控的日志模式
      • 重要错误模式
      • 应警告的模式
    • 实时监控
    • 监控工具示例
    • 告警配置
  • 日志格式
    • 默认格式
    • 自定义格式示例
      • JSON格式输出日志
      • 包含更详细信息
  • 性能影响
    • 最佳实践
    • 性能测量
  • 故障排除
    • 日志未输出
    • 日志文件过大
    • 找不到特定日志
    • 日志出现乱码
  • 参考信息
• 索引管理
  • 概述
  • 索引构成
  • 索引备份和恢复
    • 快照仓库配置
    • 创建快照(备份)
      • 备份所有索引
      • 备份特定索引
      • 定期自动备份
    • 确认快照
    • 从快照恢复
      • 恢复所有索引
      • 恢复特定索引
      • 更改索引名恢复
    • 删除快照
  • 配置文件备份
    • 备份对象文件
    • 配置文件备份示例
  • 数据迁移
    • 迁移到其他环境的步骤
    • 版本升级注意事项
  • 故障排除
    • 快照创建失败
    • 恢复失败
    • 恢复后无法搜索
  • 参考信息
• Analyzer 配置
  • 关于 Analyzer
• 搜索日志可视化配置
  • 关于搜索日志可视化
    • 可视化的信息
  • OpenSearch Dashboards 数据可视化配置
    • OpenSearch Dashboards 安装
    • 编辑配置文件
    • 启动 OpenSearch Dashboards
    • 配置索引模式
    • 创建可视化和仪表板
      • 创建基本可视化
      • 创建仪表板
    • 时区配置
    • 确认日志数据
    • 主要搜索日志字段
    • 故障排除
      • 数据未显示
      • 发生连接错误

JavaDocs

XRef

I/F Doc