归档文档

15.6

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: 在浏览器中访问
  • 启用 AI 搜索模式（LLM 插件）
  • 数据持久化
  • 停止 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检索)
    • 使用方法
• 位置信息检索
  • 使用方法
• 非显示检索条件
  • 使用方法
• 角色检索
  • 检索方法
  • 密码更改
  • 退出登录
• 特殊字符
  • 使用方法
• 高级检索
  • 使用方法
  • 项目列表
    • 包含所有单词
    • 包括词序的完全匹配
    • 包含任一单词
    • 不包含的单词
    • 显示数量
    • 排序
    • 优先语言
    • 标签
    • 更新日期
    • 文件格式
    • 检索对象
    • 网站或域名
• AI搜索模式
  • 概述
  • AI搜索模式的特点
    • 对话形式搜索
    • 理解上下文的回答
    • 标明出处
    • 继续对话
  • 聊天搜索的使用方法
    • 开始聊天
    • 输入问题
    • 确认回答
    • 继续对话
    • 开始新对话
  • 有效提问的技巧
    • 具体提问
    • 包含背景信息
    • 分步提问
  • 常见问题
    • Q: 聊天功能不显示
    • Q: 回答显示需要时间
    • Q: 回答的出处看起来有误
    • Q: 好像忘记了之前的对话
    • Q: 特定问题无法获得回答
    • Q: 可以用中文以外的语言提问吗？
  • 注意事项
    • 关于AI回答
    • 关于隐私
  • 参考信息

Fess API指南

• 简介
  • 目标读者
  • 阅读本文档前
  • API使用前提条件
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的声明
  • 提交意见和建议的方式
• API 快速入门
  • 5 分钟快速上手
    • 前提条件
    • 尝试搜索 API
    • 尝试建议 API
    • 尝试标签 API
    • 尝试健康检查 API
  • 使用 Postman
    • 集合设置
    • 环境变量
  • 各编程语言的代码示例
    • Python
    • JavaScript (Node.js)
    • JavaScript (浏览器)
    • Java
  • API 版本兼容性
  • 故障排除
    • API 无法正常工作
  • 下一步
• API概述
  • Fess 提供的API
  • 基础URL
  • 身份验证
  • HTTP方法
  • 响应格式
  • 错误处理
  • API类型
• 搜索API
  • 获取搜索结果
    • 请求
    • 请求参数
    • 响应
  • 搜索所有文档
    • 请求参数
  • 错误响应
• 标签API
  • 获取标签
    • 请求
    • 请求参数
    • 响应
  • 使用示例
  • 错误响应
• 热门词API
  • 获取热门词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 建议API
  • 获取建议词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 健康检查API
  • 获取状态
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• Chat API
  • 概述
  • 前提条件
  • 非流式API
    • 端点
    • 请求参数
    • 响应
    • HTTP状态码
    • 使用示例
      • cURL
      • JavaScript
      • Python
  • 流式API
    • 端点
    • 请求参数
    • 响应格式
    • SSE事件
    • 使用示例
      • cURL
      • JavaScript（EventSource）
      • Python
  • 错误处理
  • 速率限制
  • 安全性
  • 参考信息
• Admin API 参考手册
  • Admin API 概述
    • 概述
    • 基础URL
    • 认证
      • 获取访问令牌
      • 使用令牌
        • cURL示例
      • 所需权限
    • 通用模式
      • 获取列表（GET/PUT /settings）
        • 请求
        • 响应
      • 获取单个设置（GET /setting/{id}）
        • 请求
        • 响应
      • 新建（POST /setting）
        • 请求
        • 响应
      • 更新（PUT /setting）
        • 请求
        • 响应
      • 删除（DELETE /setting/{id}）
        • 请求
        • 响应
    • 响应格式
      • 成功响应
      • 错误响应
      • HTTP状态码
    • 可用API
      • 爬虫设置
      • 索引管理
      • 调度器
      • 用户和权限管理
      • 搜索调优
      • 系统
      • 词典
    • 使用示例
      • 创建Web爬虫设置
      • 启动计划任务
      • 获取用户列表
    • 参考信息
  • WebConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取Web爬虫设置列表
      • 请求
        • 参数
      • 响应
    • 获取Web爬虫设置
      • 请求
      • 响应
    • 创建Web爬虫设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新Web爬虫设置
      • 请求
        • 请求体
      • 响应
    • 删除Web爬虫设置
      • 请求
      • 响应
    • URL模式示例
      • includedUrls / excludedUrls
    • 使用示例
      • 企业网站爬虫设置
      • 文档网站爬虫设置
    • 参考信息
  • FileConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取文件爬虫设置列表
      • 请求
        • 参数
      • 响应
    • 获取文件爬虫设置
      • 请求
      • 响应
    • 创建文件爬虫设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新文件爬虫设置
      • 请求
        • 请求体
      • 响应
    • 删除文件爬虫设置
      • 请求
      • 响应
    • 路径格式
    • 使用示例
      • SMB共享爬虫设置
    • 参考信息
  • DataConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取数据存储设置列表
      • 请求
        • 参数
      • 响应
    • 获取数据存储设置
      • 请求
      • 响应
    • 创建数据存储设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新数据存储设置
      • 请求
        • 请求体
      • 响应
    • 删除数据存储设置
      • 请求
      • 响应
    • 处理器类型
    • 使用示例
      • 数据库爬虫设置
    • 参考信息
  • Documents API
    • 概述
    • 基础URL
    • 端点列表
    • 通过查询删除文档
      • 请求
        • 参数
      • 响应
        • 使用示例
    • 通过ID删除文档
      • 请求
        • 参数
      • 响应
        • 使用示例
    • 查询语法
      • 基本查询
      • 日期范围查询
      • 复合查询
    • 注意事项
      • 删除操作注意
      • 推荐做法
    • 使用示例
      • 准备重新爬取整个网站
      • 清理旧文档
    • 参考信息
  • CrawlingInfo API
    • 概述
    • 基础URL
    • 端点列表
    • 获取爬虫信息列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取爬虫会话详情
      • 请求
      • 响应
    • 删除爬虫会话
      • 请求
      • 响应
    • 使用示例
      • 获取爬虫信息列表
      • 获取正在运行的爬虫会话
      • 获取特定会话详情
      • 删除旧会话
      • 监控进度
    • 参考信息
  • FailureUrl API
    • 概述
    • 基础URL
    • 端点列表
    • 获取失败URL列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 删除失败URL
      • 请求
      • 响应
    • 删除所有失败URL
      • 请求
        • 参数
      • 响应
    • 错误类型
    • 使用示例
      • 获取失败URL列表
      • 按错误次数过滤
      • 获取特定配置的失败URL
      • 删除失败URL
      • 删除所有失败URL
      • 按错误类型统计
    • 参考信息
  • Backup API
    • 概述
    • 基础URL
    • 端点列表
    • 导出配置数据
      • 请求
        • 参数
        • 导出目标类型
      • 响应
        • ZIP文件内容
    • 导入配置数据
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 导出所有设置
      • 导出特定设置
      • 导入设置
      • 覆盖现有设置导入
      • 仅导入特定设置
      • 自动化备份
    • 注意事项
    • 参考信息
  • Scheduler API
    • 概述
    • 基础URL
    • 端点列表
    • 获取计划任务列表
      • 请求
        • 参数
      • 响应
    • 获取计划任务
      • 请求
      • 响应
    • 创建计划任务
      • 请求
        • 请求体
        • 字段说明
      • 响应
        • Cron表达式示例
    • 更新计划任务
      • 请求
        • 请求体
      • 响应
    • 删除计划任务
      • 请求
      • 响应
    • 启动任务
      • 请求
      • 响应
      • 注意事项
    • 停止任务
      • 请求
      • 响应
    • 使用示例
      • 创建并执行爬虫任务
      • 检查任务状态
    • 参考信息
  • JobLog API
    • 概述
    • 基础URL
    • 端点列表
    • 获取任务日志列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取任务日志详情
      • 请求
      • 响应
    • 删除任务日志
      • 请求
      • 响应
    • 删除所有任务日志
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取任务日志列表
      • 仅获取失败的任务
      • 获取特定期间的任务日志
      • 获取任务日志详情
      • 删除旧任务日志
      • 仅删除失败的任务日志
      • 检测执行时间长的任务
      • 计算任务成功率
    • 参考信息
  • User API
    • 概述
    • 基础URL
    • 端点列表
    • 获取用户列表
      • 请求
        • 参数
      • 响应
    • 获取用户
      • 请求
      • 响应
    • 创建用户
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新用户
      • 请求
        • 请求体
      • 响应
    • 删除用户
      • 请求
      • 响应
    • 使用示例
      • 创建新用户
      • 更改用户角色
    • 参考信息
  • Role API
    • 概述
    • 基础URL
    • 端点列表
    • 获取角色列表
      • 请求
        • 参数
      • 响应
    • 获取角色
      • 请求
      • 响应
    • 创建角色
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新角色
      • 请求
        • 请求体
      • 响应
    • 删除角色
      • 请求
      • 响应
    • 使用示例
      • 创建新角色
      • 获取角色列表
    • 参考信息
  • Group API
    • 概述
    • 基础URL
    • 端点列表
    • 获取组列表
      • 请求
        • 参数
      • 响应
    • 获取组
      • 请求
      • 响应
    • 创建组
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新组
      • 请求
        • 请求体
      • 响应
    • 删除组
      • 请求
      • 响应
    • 使用示例
      • 创建新组
      • 获取组列表
    • 参考信息
  • AccessToken API
    • 概述
    • 基础URL
    • 端点列表
    • 获取访问令牌列表
      • 请求
        • 参数
      • 响应
    • 获取访问令牌
      • 请求
      • 响应
    • 创建访问令牌
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新访问令牌
      • 请求
        • 请求体
      • 响应
    • 删除访问令牌
      • 请求
      • 响应
    • 使用示例
      • 创建API令牌
      • 使用令牌调用API
    • 参考信息
  • LabelType API
    • 概述
    • 基础URL
    • 端点列表
    • 获取标签类型列表
      • 请求
        • 参数
      • 响应
    • 获取标签类型
      • 请求
      • 响应
    • 创建标签类型
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新标签类型
      • 请求
        • 请求体
      • 响应
    • 删除标签类型
      • 请求
      • 响应
    • 使用示例
      • 创建文档标签
      • 使用标签搜索
    • 参考信息
  • KeyMatch API
    • 概述
    • 基础URL
    • 端点列表
    • 获取关键词匹配列表
      • 请求
        • 参数
      • 响应
    • 获取关键词匹配
      • 请求
      • 响应
    • 创建关键词匹配
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新关键词匹配
      • 请求
        • 请求体
      • 响应
    • 删除关键词匹配
      • 请求
      • 响应
    • 使用示例
      • 创建产品页面关键词匹配
      • 创建支持页面关键词匹配
    • 参考信息
  • BoostDoc API
    • 概述
    • 基础URL
    • 端点列表
    • 获取文档提升列表
      • 请求
        • 参数
      • 响应
    • 获取文档提升
      • 请求
      • 响应
    • 创建文档提升
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新文档提升
      • 请求
        • 请求体
      • 响应
    • 删除文档提升
      • 请求
      • 响应
    • 提升表达式示例
    • 使用示例
      • 文档网站提升
      • 新内容提升
    • 参考信息
  • ElevateWord API
    • 概述
    • 基础URL
    • 端点列表
    • 获取提升词列表
      • 请求
        • 参数
      • 响应
    • 获取提升词
      • 请求
      • 响应
    • 创建提升词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新提升词
      • 请求
        • 请求体
      • 响应
    • 删除提升词
      • 请求
      • 响应
    • 使用示例
      • 产品名称提升
      • 针对特定标签提升
    • 参考信息
  • BadWord API
    • 概述
    • 基础URL
    • 端点列表
    • 获取屏蔽词列表
      • 请求
        • 参数
      • 响应
    • 获取屏蔽词
      • 请求
      • 响应
    • 创建屏蔽词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新屏蔽词
      • 请求
        • 请求体
      • 响应
    • 删除屏蔽词
      • 请求
      • 响应
    • 使用示例
      • 排除垃圾关键词
      • 针对特定角色的屏蔽词
    • 参考信息
  • RelatedContent API
    • 概述
    • 基础URL
    • 端点列表
    • 获取相关内容列表
      • 请求
        • 参数
      • 响应
    • 获取相关内容
      • 请求
      • 响应
    • 创建相关内容
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新相关内容
      • 请求
        • 请求体
      • 响应
    • 删除相关内容
      • 请求
      • 响应
    • 使用示例
      • 产品信息相关内容
      • 支持信息相关内容
    • 参考信息
  • RelatedQuery API
    • 概述
    • 基础URL
    • 端点列表
    • 获取相关查询列表
      • 请求
        • 参数
      • 响应
    • 获取相关查询
      • 请求
      • 响应
    • 创建相关查询
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新相关查询
      • 请求
        • 请求体
      • 响应
    • 删除相关查询
      • 请求
      • 响应
    • 使用示例
      • 产品相关查询
      • 帮助相关查询
    • 参考信息
  • Suggest API
    • 概述
    • 基础URL
    • 端点列表
    • 获取建议词列表
      • 请求
        • 参数
      • 响应
    • 获取建议词
      • 请求
      • 响应
    • 创建建议词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新建议词
      • 请求
        • 请求体
      • 响应
    • 删除建议词
      • 请求
      • 响应
    • 删除所有建议词
      • 请求
      • 响应
    • 使用示例
      • 添加热门关键词
      • 批量删除建议
    • 参考信息
  • General API
    • 概述
    • 基础URL
    • 端点列表
    • 获取常规设置
      • 请求
      • 响应
    • 更新常规设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 更新爬虫设置
      • 更新搜索设置
      • 更新建议设置
    • 参考信息
  • SystemInfo API
    • 概述
    • 基础URL
    • 端点列表
    • 获取系统信息
      • 请求
      • 响应
        • 响应字段
    • 使用示例
      • 获取系统信息
      • 检查版本
      • 检查内存使用情况
    • 参考信息
  • Stats API
    • 概述
    • 基础URL
    • 端点列表
    • 获取统计信息
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 使用示例
      • 获取所有统计信息
      • 指定期间的统计获取
      • 获取搜索查询统计
      • 获取热门查询TOP10
    • 参考信息
  • Log API
    • 概述
    • 基础URL
    • 端点列表
    • 获取搜索日志
      • 请求
        • 参数
      • 响应
    • 获取点击日志
      • 请求
        • 参数
      • 响应
    • 获取收藏日志
      • 请求
        • 参数
      • 响应
    • 删除搜索日志
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取最近的搜索日志
      • 获取特定期间的搜索日志
      • 获取特定查询的搜索日志
      • 获取点击日志
      • 删除旧搜索日志
    • 参考信息
  • Storage API
    • 概述
    • 基础URL
    • 端点列表
    • 获取存储信息
      • 请求
      • 响应
        • 响应字段
    • 优化索引
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 刷新索引
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 获取存储信息
      • 优化所有索引
      • 优化特定索引
      • 删除已删除文档
      • 刷新索引
    • 参考信息
  • Plugin API
    • 概述
    • 基础URL
    • 端点列表
    • 获取插件列表
      • 请求
      • 响应
        • 响应字段
    • 安装插件
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 删除插件
      • 请求
      • 响应
    • 使用示例
      • 获取插件列表
      • 安装插件
      • 删除插件
    • 注意事项
    • 参考信息
  • Dict API
    • 概述
    • 基础URL
    • 端点列表
    • 获取词典列表
      • 请求
      • 响应
    • 获取词典内容
      • 请求
      • 响应
    • 更新词典内容
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 上传词典文件
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 词典类型
    • 词典格式示例
      • 同义词词典
      • 映射词典
      • 保护词词典
    • 使用示例
      • 获取词典列表
      • 获取同义词词典内容
      • 更新同义词词典
      • 上传词典文件
    • 注意事项
    • 参考信息
  • SearchLog API
    • 概述
    • 基础URL
    • 端点列表
    • 获取搜索日志列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取搜索日志详情
      • 请求
      • 响应
    • 删除搜索日志
      • 请求
      • 响应
    • 批量删除搜索日志
      • 请求
        • 参数
      • 响应
    • 获取搜索统计
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取搜索日志列表
      • 指定期间获取
      • 获取特定用户的搜索日志
      • 获取特定关键词的搜索日志
      • 获取搜索统计
      • 删除旧搜索日志
      • 提取热门搜索关键词
      • 分析搜索质量
      • 日均搜索量趋势
    • 参考信息

Fess 管理员指南

• 简介
  • 目标读者
  • 阅读前须知
  • 在线访问
  • 技术支持联系方式
    • 商业支持
• 仪表板
  • 概述
  • 确认已索引的文档数
• 配置向导
  • 概述
    • 简易设置
    • 爬取配置
    • 配置项
      • 名称
      • 爬取路径
      • 最大访问数
      • 深度
    • 爬虫
• 常规
  • 概述
  • 配置内容
    • 系统
      • JSON响应
      • 需要登录
      • 显示登录链接
      • 折叠重复结果
      • 显示缩略图
      • 系统属性
      • 默认标签值
      • 默认排序值
      • 虚拟主机
      • 热门词响应
      • CSV文件编码
      • 添加搜索参数
      • 搜索文件代理
      • 使用浏览器区域设置
      • SSO类型
    • 爬虫
      • 检查上次修改时间
      • 同时爬虫设置
      • 用户代理
      • 删除以前的文档
      • 要忽略的错误类型
      • 失败次数阈值
    • 日志记录
      • 搜索日志
      • 用户日志
      • 收藏日志
      • 删除以前的搜索日志
      • 删除以前的作业日志
      • 删除以前的用户日志
      • 要删除日志的机器人名称
      • 日志级别
    • 建议
      • 按搜索词建议
      • 按文档建议
      • 删除以前的建议信息
    • LDAP
      • LDAP URL
      • 基本DN
      • 绑定DN
      • 密码
      • 用户DN
      • 帐户过滤器
      • 组过滤器
      • memberOf属性
      • 安全认证
      • 初始上下文工厂
    • OpenID Connect
      • 客户端ID
      • 客户端密钥
      • 认证服务器URL
      • 令牌服务器URL
      • 重定向URL
      • 范围
      • 基础URL
      • 默认组
      • 默认角色
    • SAML
      • IdP实体ID
      • IdP SSO URL
      • IdP SLO URL
      • IdP X.509证书
      • SP基础URL
      • SP实体ID
      • SP ACS URL
      • SP SLO URL
      • SP NameID格式
      • 组属性名
      • 角色属性名
      • 默认组
      • 默认角色
    • SPNEGO
      • Krb5配置
      • 登录配置
      • 登录客户端模块
      • 登录服务器模块
      • 预认证用户名
      • 预认证密码
      • 允许Basic认证
      • 允许非安全Basic认证
      • NTLM提示
      • 允许本地主机
      • 允许委托
      • 排除目录
      • 日志记录级别
    • Entra ID
      • 租户（ID或域）
      • 认证机构
      • 客户端ID
      • 客户端密钥
      • 回复URL
      • 状态TTL
      • 权限字段
      • 默认组
      • 默认角色
      • 使用域服务
    • 公告显示
      • 登录页面
      • 搜索首页
      • 高级搜索页面
    • 通知
      • 通知邮件
      • Slack Webhook URLs
      • Google Chat Webhook URLs
      • 日志通知
      • 日志通知级别
    • 存储
      • 类型
      • 存储桶
      • 端点
      • 访问密钥
      • 密钥
      • 区域
      • 项目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
    • 上传
• 维护
  • 概述
  • 操作方法
    • 重新索引
    • 配置项
      • 更新别名
      • 重置字典
      • 分片数
      • 最大副本数
    • 重建配置索引
      • 目标索引
      • 加载默认数据
    • 重新加载文档索引
    • 爬虫索引
    • 诊断
• 查询请求
  • 概述
  • 操作方法
    • 发送请求
    • 配置项
      • 请求文件

Fess 配置指南

• 简介
  • 目标读者
  • 阅读本文档前
  • 前提条件
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 第三方网站参考
  • 反馈意见和建议
• 端口与网络配置
  • 概述
  • 使用端口配置
    • 默认端口
    • Fess Web 应用程序端口变更
      • Linux 环境配置
      • 环境变量配置
      • RPM/DEB 软件包配置
      • Windows 环境配置
      • 注册为 Windows 服务时
    • 上下文路径配置
  • 代理服务器配置
    • 概述
    • 爬虫代理服务器配置
      • 基本配置
      • 需要认证的代理服务器配置
      • 从代理服务器排除特定主机
    • 爬虫默认代理配置
      • 通过环境变量配置代理
  • 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 模式过滤器
      • 配置示例
    • MIME 类型检测覆盖
      • 配置示例
  • 缓存配置
    • 文档缓存
      • 配置示例
  • JVM 选项
    • 默认配置
    • 主要选项说明
    • 自定义配置示例
  • 性能调优
    • 爬取速度优化
    • 内存使用量优化
    • 索引质量提升
  • 故障排除
    • 内存不足
    • 爬取缓慢
    • 无法提取特定内容
    • 发生乱码
  • 最佳实践
  • S3/GCS 爬虫配置
    • S3 爬虫
      • 配置示例
    • GCS 爬虫
      • 配置示例
  • 参考信息
• 缩略图配置
  • 概述
  • 支持的文件格式
    • 图片文件
    • 文档文件
    • HTML 内容
  • 所需的外部工具
    • 基本工具（必需）
    • SVG 支持
    • PDF 支持
    • MS Office 支持
    • PostScript 支持
  • HTML 文件缩略图
  • 配置
    • 配置文件
    • 主要配置项（fess_config.properties）
  • generate-thumbnail 脚本
    • 概述
    • 用法
    • 参数
    • 支持的类型
    • 示例
  • 缩略图存储位置
    • 默认路径
    • 目录结构
  • 禁用缩略图任务
  • 故障排除
    • 缩略图未生成
    • GIF/TIFF 文件出错
    • SVG 缩略图未生成
    • 权限错误
  • 平台支持
• 数据存储连接器指南
  • 数据存储连接器概述
    • 概述
    • 可用的连接器
      • 云存储
      • 协作工具
      • 开发运维工具
      • 数据库和文件
    • 连接器安装
      • 插件安装
        • 从管理界面安装
    • 数据存储设置基础
      • 通用设置项
      • 参数设置
      • 脚本设置
    • 认证设置
    • 通用参数
    • 故障排除
      • 连接器不显示
      • 认证错误
      • 无法获取数据
      • 调试设置
    • 参考信息
  • Box连接器
    • 概述
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Box认证设置
      • JWT认证设置步骤
        • 1. 在Box Developer Console创建应用程序
        • 2. 应用程序设置
        • 3. 在企业中批准
        • 4. 获取认证信息
        • 私钥格式
    • 使用示例
      • 抓取企业整个Box存储
    • 故障排除
      • 认证错误
      • 私钥格式错误
      • 无法获取文件
    • 参考信息
  • Dropbox连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • Dropbox文件的情况
        • Dropbox Paper的情况
    • Dropbox认证设置
      • 访问令牌获取步骤
        • 1. 在Dropbox App Console创建应用
        • 2. 权限设置
        • 3. 生成访问令牌
        • 4. 设置令牌
    • 个人账户设置
      • 个人账户的使用
    • 使用示例
      • 抓取整个Dropbox文件
      • 抓取Dropbox Paper文档
      • 带权限抓取
      • 仅抓取特定文件类型
    • 故障排除
      • 认证错误
      • 无法获取文件
      • API速率限制错误
      • 无法获取Paper文档
      • 大量文件时
    • 权限和访问控制
      • 反映Dropbox共享权限
    • 参考信息
  • Google Workspace连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Google Cloud Platform设置
      • 1. 创建项目
      • 2. 启用Google Drive API
      • 3. 创建服务账号
      • 4. 创建服务账号密钥
      • 5. 启用域全域委派
      • 6. 在Google Workspace管理控制台授权
    • 认证信息设置
      • 从JSON文件获取信息
        • 私钥格式
    • 使用示例
      • Google Drive全体爬取
      • 带权限爬取
      • 只爬取特定文件类型
    • 故障排除
      • 认证错误
      • 域全域委派错误
      • 无法获取文件
      • API配额错误
      • 私钥格式错误
      • 共享云端硬盘爬取
      • 有大量文件的情况
    • 权限和访问控制
      • 反映Google Drive的共享权限
    • 参考信息
  • Microsoft 365连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置（通用）
        • 通用参数列表
    • Azure AD应用程序注册
      • 1. 在Azure Portal注册应用程序
      • 2. 创建客户端密钥
      • 3. 添加API权限
    • 各数据存储所需权限
      • OneDriveDataStore
      • OneNoteDataStore
      • TeamsDataStore
      • SharePointDocLibDataStore
      • SharePointListDataStore / SharePointPageDataStore
    • 脚本设置
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 各数据存储的附加参数
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 使用示例
      • OneDrive全云端硬盘爬取
      • 爬取特定团队的Teams消息
      • 爬取SharePoint列表
    • 故障排除
      • 认证错误
      • API速率限制错误
      • 无法获取数据
      • 确认SharePoint站点ID的方法
      • 大量数据爬取
    • 参考信息
  • Atlassian连接器
    • 概述
    • 支持的产品
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • Jira的情况
        • Confluence的情况
    • OAuth 2.0认证设置
      • Cloud版的情况（推荐）
    • OAuth 1.0a认证设置
      • Server版的情况
    • Basic认证设置
      • Server版的简单设置
    • JQL高级搜索
      • 用JQL筛选Jira问题
    • 使用示例
      • Jira Cloud抓取
      • Confluence Server抓取
    • 故障排除
      • 认证错误
      • 连接错误
      • 无法获取数据
      • OAuth 2.0令牌更新
    • 参考信息
  • Slack连接器
    • 概述
    • 支持的内容
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Slack App设置
      • 1. 创建Slack App
      • 2. OAuth & Permissions设置
      • 3. 安装应用
      • 4. 添加到频道
    • 使用示例
      • 爬取特定频道
      • 爬取所有频道
      • 包含私有频道爬取
      • 包含文件爬取
      • 包含详细消息信息
    • 故障排除
      • 认证错误
      • 找不到频道
      • 无法获取消息
      • 权限不足错误
      • 无法爬取文件
      • API速率限制
      • 有大量消息的情况
    • 脚本应用示例
      • 消息加工
    • 参考信息
  • Git连接器
    • 概述
    • 支持的仓库
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Git仓库认证
      • GitHub Personal Access Token
        • 1. 在GitHub生成Personal Access Token
        • 2. 在URI中包含认证信息
      • GitLab Private Token
        • 1. 在GitLab生成Access Token
        • 2. 在URI中包含认证信息
      • SSH认证
    • 提取器设置
      • 按MIME类型的提取器
        • 默认提取器
        • 只爬取文本文件
        • 爬取所有文件
        • 只爬取特定文件类型
    • 增量爬取
      • 只爬取上次提交以来的变更
      • 已删除文件的处理
    • 使用示例
      • GitHub公共仓库
      • GitHub私有仓库
      • GitLab（自托管）
      • 只爬取文档（Markdown文件）
      • 只爬取特定目录
    • 故障排除
      • 认证错误
      • 找不到仓库
      • 无法获取文件
      • MIME类型错误
      • 大型仓库
      • 分支指定
    • URL生成
      • base_url设置模式
      • 在脚本中生成URL
    • 参考信息
  • Elasticsearch/OpenSearch连接器
    • 概述
    • 支持版本
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • 查询设置
      • 获取所有文档
      • 特定条件过滤
    • 只获取特定字段
      • 使用fields参数限制获取字段
    • 使用示例
      • 基本索引爬取
      • 从带认证的集群爬取
      • 从多个索引爬取
      • OpenSearch集群爬取
      • 限制字段爬取
      • 多主机负载均衡
    • 故障排除
      • 连接错误
      • 认证错误
      • 找不到索引
      • 查询错误
      • 滚动超时
      • 大量数据爬取
      • 内存不足
    • SSL/TLS连接
      • 自签名证书的情况
      • 客户端证书认证
    • 高级查询示例
      • 包含聚合的查询
      • 脚本字段
    • 参考信息
  • Salesforce连接器
    • 概述
    • 支持的对象
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Salesforce Connected App设置
      • 1. 创建Connected App
      • 2. OAuth Token认证设置（推荐）
      • 3. OAuth Password认证设置
      • 4. 授权Connected App
    • 自定义对象设置
      • 爬取自定义对象
        • 字段映射规则
    • 使用示例
      • 爬取标准对象
      • 爬取自定义对象
      • 爬取沙盒环境
    • 故障排除
      • 认证错误
      • 无法获取对象
      • 自定义对象名称
      • 确认字段名
      • API速率限制
      • 有大量数据的情况
      • 私钥格式错误
    • 参考信息
  • 数据库连接器
    • 概述
    • 支持的数据库
    • 前提条件
      • JDBC驱动程序安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
    • SQL查询设计
      • 高效查询
      • 增量抓取
      • URL生成
    • 多字节字符支持
      • MySQL
      • PostgreSQL
    • 安全性
      • 数据库认证信息保护
      • 最小权限原则
    • 使用示例
      • 产品目录搜索
      • 知识库文章
    • 故障排除
      • 找不到JDBC驱动程序
      • 连接错误
      • 查询错误
    • 参考信息
  • CSV连接器
    • 概述
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • CSV格式详情
      • 标准CSV（RFC 4180兼容）
      • 更改分隔符
      • 自定义引号
      • 编码
    • 使用示例
      • 产品目录CSV
      • 员工名册CSV
      • 无标题行的CSV
      • 多CSV文件整合
      • 制表符分隔（TSV）文件
    • 故障排除
      • 找不到文件
      • 出现乱码
      • 列无法正确识别
      • 标题行处理
      • 无法获取数据
      • 大型CSV文件
      • 包含换行符的字段
    • 脚本的高级使用示例
      • 数据加工
      • 条件索引
      • 多列合并
      • 日期格式化
    • 参考信息
  • JSON连接器
    • 概述
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • JSON格式详情
      • JSON文件格式
    • 使用示例
      • 产品目录
      • 多JSON文件整合
    • 故障排除
      • 找不到文件
      • JSON解析错误
      • 无法获取数据
      • 大型JSON文件
    • 脚本的高级使用示例
      • 条件处理
      • 数组合并
      • 设置默认值
      • 日期格式化
      • 数值处理
    • 参考信息
• 搜索功能
  • 概述
  • 搜索结果数量显示
    • 默认行为
    • 显示准确命中数量
  • 搜索选项
    • 基本搜索
    • OR 搜索
    • NOT 搜索
    • 短语搜索
    • 字段指定搜索
    • 通配符搜索
    • 模糊搜索
  • 搜索结果排序
  • 分面搜索
  • 搜索结果高亮显示
  • 建议功能
  • 搜索日志
  • 性能调优
    • 搜索超时配置
    • 搜索查询最大字符数
    • 使用缓存
  • 故障排除
    • 搜索结果未显示
    • 搜索速度慢
    • 显示不相关结果
• 搜索相关配置
  • 模糊搜索
  • 搜索超时值
  • 搜索最大字符数
  • 搜索超时日志输出
  • 命中数量显示
  • 位置信息搜索字段名
  • 请求参数语言指定
  • 前方一致搜索指定
  • 高亮字符串
  • 高亮片段
  • 高亮生成方法
  • 高亮对象标签
  • 传递给 OpenSearch 高亮器的值
  • 高级高亮设置
  • 添加到响应的字段名
  • 添加字段名
  • 以 GSA 兼容 XML 格式获取搜索结果的配置
• 位置信息搜索
  • 概述
  • 用例
  • 配置方法
    • 索引生成时的配置
      • 位置信息字段定义
      • 位置信息注册格式
      • 数据存储爬取的配置示例
      • 脚本添加位置信息
    • 搜索时的配置
      • 请求参数
      • 距离单位
  • 搜索示例
    • 基本搜索
    • 当前位置周边搜索
    • API 使用
  • 字段名自定义
    • 更改默认字段名
  • 实现示例
    • Web 应用程序实现
    • Google 地图集成
  • 性能优化
    • 索引配置优化
    • 搜索范围限制
  • 故障排除
    • 位置信息搜索无法工作
    • 搜索结果未返回
    • 位置信息未正确显示
  • 参考信息
• 批量获取搜索结果
  • 概述
  • 用例
  • 配置方法
    • 启用滚动搜索
    • 响应字段配置
  • 使用方法
    • 基本使用方法
    • 请求参数
    • 指定搜索查询
    • 指定获取条数
    • 按标签过滤
    • 关于认证
  • 响应格式
    • NDJSON 格式
    • 响应字段
  • 数据处理示例
    • Python 处理示例
    • 保存到文件
    • 转换为 CSV
    • 数据分析
  • 性能和最佳实践
    • 高效使用方法
    • 内存使用量优化
  • 安全注意事项
    • 访问限制
    • 速率限制
  • 故障排除
    • 无法使用滚动搜索
    • 发生超时错误
    • 内存不足错误
    • 响应为空
  • 参考信息
• 搜索表单集成
  • 搜索表单配置方法
    • 搜索表单
    • 建议功能
• Rank Fusion 配置
  • 概述
  • 什么是 Rank Fusion
  • 支持的算法
    • RRF (Reciprocal Rank Fusion)
  • 配置
    • fess_config.properties
    • JVM 系统属性
  • 与混合搜索的集成
  • 使用示例
    • 基本混合搜索
  • 性能注意事项
    • 内存使用
    • 处理时间
  • 故障排除
    • 搜索结果与预期不符
    • 搜索缓慢
    • 内存不足
  • 参考信息
• 基于角色的搜索配置
  • 关于基于角色的搜索
  • 基于角色的搜索配置
    • Fess 管理页面配置
    • 登录
    • 登出
• 虚拟主机
  • 关于虚拟主机
    • 系统配置
    • 爬取配置
• LDAP集成指南
  • 概述
  • 支持的LDAP服务器
  • 前提条件
  • 基本设置
    • LDAP连接设置
    • 用户搜索设置
    • LDAP管理基础DN设置
    • 组搜索设置
  • Active Directory设置
    • 基本设置
    • Active Directory特定设置
  • OpenLDAP设置
  • 安全设置
    • LDAPS（SSL/TLS）
    • 密码保护
  • 角色映射
    • 自动映射
    • 自定义映射
  • 用户信息同步
    • 自动同步
    • 同步的属性
  • 连接池
  • 故障转移
  • 故障排除
    • 连接错误
    • 认证错误
    • 无法获取组
    • 调试设置
  • 参考信息
• 多租户配置
  • 概述
  • 虚拟主机功能
    • 工作原理
  • 虚拟主机头部配置
    • 配置格式
    • 虚拟主机键的限制
  • 管理界面配置
    • 爬取设置
  • 访问控制
    • 虚拟主机与角色的组合
    • 基于角色的搜索
  • UI定制
    • 主题应用
    • 自定义CSS
    • 标签设置
  • API认证
    • 访问令牌
    • API请求
  • DNS设置
    • 指向同一服务器的子域名
    • 反向代理设置
  • 数据隔离
    • 索引级别隔离
  • 最佳实践
  • 限制事项
  • 参考信息
• 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
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
  • 故障排除
    • 常见问题和解决方案
      • 出现认证对话框
      • 发生认证错误
      • 无法获取组信息
    • 调试设置
  • 参考
• LLM集成概述
  • 概述
  • 支持的提供商
  • 插件安装
  • 架构
  • 基本配置
    • 管理界面的通用设置 / system.properties
    • fess_config.properties
  • 通用配置
    • 上下文配置
    • 系统提示词
    • 可用性检查
  • 会话管理
  • 并发控制
  • 评估配置
  • 提示词类型别配置
    • 提示词类型一览
    • 配置模式
  • 后续步骤
• Ollama配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 安装Ollama
      • Linux/macOS
      • Windows
      • Docker
    • 下载模型
  • 插件安装
  • 基本配置
    • 最小配置
    • 推荐配置（生产环境）
  • 配置项
    • 并发控制
  • 提示词类型别配置
  • Ollama模型选项
  • 思考模型支持
  • 网络配置
    • Docker配置
    • 远程Ollama服务器
  • 通过 HTTP 代理使用
  • 模型选择指南
    • GPU支持
  • 故障排除
    • 连接错误
    • 模型未找到
    • 超时
    • 调试设置
  • 参考信息
• OpenAI配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 获取API密钥
  • 插件安装
  • 基本配置
    • 最小配置
    • 推荐配置（生产环境）
  • 配置项
  • 提示词类型别配置
    • 配置模式
    • 提示词类型
    • 默认值
    • 配置示例
  • 重试行为
  • 流式输出和使用量信息
  • 日志输出和异常检测
    • URL日志中的认证信息屏蔽
  • 推理模型支持
    • 推理模型的附加参数
    • 配置示例
  • 通过 JVM 选项配置
    • Docker环境
    • systemd环境
  • 通过 HTTP 代理使用
  • 使用Azure OpenAI
  • 模型选择指南
    • 成本估算
  • 并发请求控制
    • OpenAI Tier限制
  • 故障排除
    • 认证错误
    • 速率限制错误
    • 配额超限
    • 超时
    • 调试设置
  • 安全注意事项
  • 参考信息
• Google Gemini配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 获取API密钥
  • 插件安装
  • 基本配置
    • fess_config.properties配置
    • LLM提供商配置
      • 最小配置
      • 推荐配置（生产环境）
  • 配置项
  • 认证方式
  • 重试行为
  • 提示词类型别配置
    • 配置格式
    • 可用的提示词类型
    • 提示词类型别默认值
    • 配置示例
  • 思考模型支持
    • 按模型世代的映射
  • 通过 JVM 选项配置
    • Docker环境
    • systemd环境
  • 通过 HTTP 代理使用
  • 通过Vertex AI使用
  • 模型选择指南
    • 上下文窗口
    • 成本估算
  • 并发请求控制
    • 免费额度限制（参考）
  • 故障排除
    • 认证错误
    • 速率限制错误
    • 区域限制
    • 超时
    • 调试设置
  • 安全注意事项
  • 参考信息
• AI搜索模式功能配置
  • 概述
  • AI搜索模式的工作原理
  • 基本配置
    • 核心配置 (fess_config.properties)
    • 提供商配置 (system.properties / 管理界面)
  • 配置路径快速参考
  • 核心配置一览
  • 生成参数
  • 上下文配置
    • 核心配置
    • 提供商专属配置
    • 内容字段
  • 系统提示词
    • 自定义提示词
  • 会话管理
    • 会话行为
  • 并发控制
    • 并发控制的注意事项
  • 对话历史模式
  • 查询再生成
  • Markdown渲染
  • API使用
    • 非流式API
    • 流式API
  • Web界面
    • 开始聊天
    • 使用聊天
    • 继续对话
  • 故障排除
    • 搜索界面未显示AI模式按钮
    • AI搜索模式无法启用
    • 回答质量低
    • 响应慢
    • 会话无法保持
    • 调试设置
    • 搜索日志与访问类型
  • 参考信息
• 脚本概述
  • 概述
  • 支持的脚本语言
  • 脚本使用场景
    • 数据存储设置
    • 路径映射
    • 计划任务
  • 基本语法
    • 变量访问
    • 字符串操作
    • 条件分支
    • 日期操作
  • 可用对象
  • 安全性
  • 性能
  • 调试
  • 参考信息
• Groovy脚本指南
  • 概述
  • 基本语法
    • 变量声明
    • 字符串操作
    • 集合操作
    • 条件分支
    • 循环处理
  • 数据存储脚本
    • 基本映射
    • URL生成
    • 内容加工
    • 日期处理
  • 可用对象
  • 计划任务脚本
    • 执行爬取任务
    • 条件爬取
    • 顺序执行多个任务
  • 使用Java类
    • 日期与时间
    • 文件操作
    • HTTP通信
  • 访问Fess组件
    • 系统帮助器
    • 获取配置值
    • 执行搜索
  • 错误处理
  • 调试与日志输出
    • 日志输出
    • 调试输出
  • 最佳实践
  • 参考信息
• 速率限制配置
  • 概述
  • HTTP请求的速率限制
    • 设置
    • 行为
  • AI搜索模式的速率限制
  • 爬虫的速率限制
    • Web爬取设置
    • 遵守robots.txt
  • 速率限制的全部配置项
  • 高级速率限制设置
    • 自定义速率限制
  • 排除设置
  • 监控与告警
    • 日志输出
  • 故障排除
    • 正常请求被阻止
    • 速率限制不生效
    • 性能影响
  • 参考信息
• 负载控制配置
  • 概述
  • HTTP请求负载控制配置
  • 工作原理
    • 监控机制
    • 请求控制
  • 配置示例
    • 仅限制Web请求
    • 同时限制Web和API
  • 与速率限制的区别
  • 自适应负载控制
    • 配置
    • 行为
  • 故障排除
    • 负载控制未生效
    • 正常请求被拒绝
    • 爬取速度慢
  • 参考信息
• 日志配置
  • 概述
  • 日志文件类型
    • 主要日志文件
    • 日志文件位置
    • 故障排除时的日志确认
  • 日志级别配置
    • 什么是日志级别
    • 推荐日志级别
    • 从管理页面变更
    • 通过配置文件变更
      • 配置文件位置
      • 基本配置示例
      • 通过环境变量配置
  • 爬虫日志配置
    • 调度器配置
  • 日志轮转
    • 概述
    • Log4j2 自动轮转
      • 默认配置
      • 每日轮转配置
      • 压缩配置
    • logrotate 轮转
  • 日志监控
    • 需要监控的日志模式
      • 重要错误模式
      • 应警告的模式
    • 实时监控
    • 监控工具示例
    • 告警配置
  • 日志格式
    • 默认格式
    • 自定义格式示例
      • JSON格式输出日志
      • 包含更详细信息
  • 性能影响
    • 最佳实践
    • 性能测量
  • 故障排除
    • 日志未输出
    • 日志文件过大
    • 找不到特定日志
    • 日志出现乱码
  • 参考信息
• 日志通知
  • 概述
  • 工作原理
  • 设置
    • 启用
      • 从管理页面启用
      • 通过系统属性启用
    • 通知目标设置
      • 邮件通知
      • Slack 通知
      • Google Chat 通知
  • 配置属性
  • 通知消息格式
    • 邮件通知
    • Slack / Google Chat 通知
  • 运维指南
    • 推荐设置
    • OpenSearch 索引
  • 故障排除
    • 通知未发送
    • 通知过多
    • 通知内容被截断
  • 参考信息
• 索引管理
  • 概述
  • 索引构成
  • 索引备份和恢复
    • 快照仓库配置
    • 创建快照(备份)
      • 备份所有索引
      • 备份特定索引
      • 定期自动备份
    • 确认快照
    • 从快照恢复
      • 恢复所有索引
      • 恢复特定索引
      • 更改索引名恢复
    • 删除快照
  • 配置文件备份
    • 备份对象文件
    • 配置文件备份示例
  • 数据迁移
    • 迁移到其他环境的步骤
    • 版本升级注意事项
  • 故障排除
    • 快照创建失败
    • 恢复失败
    • 恢复后无法搜索
  • 参考信息
• 索引导出功能
  • 概述
  • 工作原理
  • 配置属性
  • 启用作业
  • 自定义查询过滤
  • 导出文件结构
  • 最佳实践
    • 存储注意事项
    • 性能提示
    • 安全建议
  • 故障排除
    • 导出作业未运行
    • 导出目录为空
    • 导出中途失败
    • 文件无法访问
  • 相关主题
• Analyzer 配置
  • 关于 Analyzer
• 搜索日志可视化配置
  • 关于搜索日志可视化
    • 可视化的信息
  • OpenSearch Dashboards 数据可视化配置
    • OpenSearch Dashboards 安装
    • 编辑配置文件
    • 启动 OpenSearch Dashboards
    • 配置索引模式
    • 创建可视化和仪表板
      • 创建基本可视化
      • 创建仪表板
    • 时区配置
    • 确认日志数据
    • 主要搜索日志字段
    • 故障排除
      • 数据未显示
      • 发生连接错误

JavaDocs

XRef

I/F Doc

15.5

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检索)
    • 使用方法
• 位置信息检索
  • 使用方法
• 非显示检索条件
  • 使用方法
• 角色检索
  • 检索方法
  • 密码更改
  • 退出登录
• 特殊字符
  • 使用方法
• 高级检索
  • 使用方法
  • 项目列表
    • 包含所有单词
    • 包括词序的完全匹配
    • 包含任一单词
    • 不包含的单词
    • 显示数量
    • 排序
    • 优先语言
    • 标签
    • 更新日期
    • 文件格式
    • 检索对象
    • 网站或域名
• AI搜索模式
  • 概述
  • AI搜索模式的特点
    • 对话形式搜索
    • 理解上下文的回答
    • 标明出处
    • 继续对话
  • 聊天搜索的使用方法
    • 开始聊天
    • 输入问题
    • 确认回答
    • 继续对话
    • 开始新对话
  • 有效提问的技巧
    • 具体提问
    • 包含背景信息
    • 分步提问
  • 常见问题
    • Q: 聊天功能不显示
    • Q: 回答显示需要时间
    • Q: 回答的出处看起来有误
    • Q: 好像忘记了之前的对话
    • Q: 特定问题无法获得回答
    • Q: 可以用中文以外的语言提问吗？
  • 注意事项
    • 关于AI回答
    • 关于隐私
  • 参考信息

Fess API指南

• 简介
  • 目标读者
  • 阅读本文档前
  • API使用前提条件
  • 在线访问
  • 技术支持联系方式
    • 商业支持
  • 关于第三方网站的声明
  • 提交意见和建议的方式
• API 快速入门
  • 5 分钟快速上手
    • 前提条件
    • 尝试搜索 API
    • 尝试建议 API
    • 尝试标签 API
    • 尝试健康检查 API
  • 使用 Postman
    • 集合设置
    • 环境变量
  • 各编程语言的代码示例
    • Python
    • JavaScript (Node.js)
    • JavaScript (浏览器)
    • Java
  • API 版本兼容性
  • 故障排除
    • API 无法正常工作
  • 下一步
• API概述
  • Fess 提供的API
  • 基础URL
  • 身份验证
  • HTTP方法
  • 响应格式
  • 错误处理
  • API类型
• 搜索API
  • 获取搜索结果
    • 请求
    • 请求参数
    • 响应
  • 搜索所有文档
    • 请求参数
  • 错误响应
• 标签API
  • 获取标签
    • 请求
    • 请求参数
    • 响应
  • 使用示例
  • 错误响应
• 热门词API
  • 获取热门词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 建议API
  • 获取建议词列表
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• 健康检查API
  • 获取状态
    • 请求
    • 请求参数
    • 响应
  • 错误响应
• Chat API
  • 概述
  • 前提条件
  • 非流式API
    • 端点
    • 请求参数
    • 响应
    • HTTP状态码
    • 使用示例
      • cURL
      • JavaScript
      • Python
  • 流式API
    • 端点
    • 请求参数
    • 响应格式
    • SSE事件
    • 使用示例
      • cURL
      • JavaScript（EventSource）
      • Python
  • 错误处理
  • 速率限制
  • 安全性
  • 参考信息
• Admin API 参考手册
  • Admin API 概述
    • 概述
    • 基础URL
    • 认证
      • 获取访问令牌
      • 使用令牌
        • cURL示例
      • 所需权限
    • 通用模式
      • 获取列表（GET/PUT /settings）
        • 请求
        • 响应
      • 获取单个设置（GET /setting/{id}）
        • 请求
        • 响应
      • 新建（POST /setting）
        • 请求
        • 响应
      • 更新（PUT /setting）
        • 请求
        • 响应
      • 删除（DELETE /setting/{id}）
        • 请求
        • 响应
    • 响应格式
      • 成功响应
      • 错误响应
      • HTTP状态码
    • 可用API
      • 爬虫设置
      • 索引管理
      • 调度器
      • 用户和权限管理
      • 搜索调优
      • 系统
      • 词典
    • 使用示例
      • 创建Web爬虫设置
      • 启动计划任务
      • 获取用户列表
    • 参考信息
  • WebConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取Web爬虫设置列表
      • 请求
        • 参数
      • 响应
    • 获取Web爬虫设置
      • 请求
      • 响应
    • 创建Web爬虫设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新Web爬虫设置
      • 请求
        • 请求体
      • 响应
    • 删除Web爬虫设置
      • 请求
      • 响应
    • URL模式示例
      • includedUrls / excludedUrls
    • 使用示例
      • 企业网站爬虫设置
      • 文档网站爬虫设置
    • 参考信息
  • FileConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取文件爬虫设置列表
      • 请求
        • 参数
      • 响应
    • 获取文件爬虫设置
      • 请求
      • 响应
    • 创建文件爬虫设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新文件爬虫设置
      • 请求
        • 请求体
      • 响应
    • 删除文件爬虫设置
      • 请求
      • 响应
    • 路径格式
    • 使用示例
      • SMB共享爬虫设置
    • 参考信息
  • DataConfig API
    • 概述
    • 基础URL
    • 端点列表
    • 获取数据存储设置列表
      • 请求
        • 参数
      • 响应
    • 获取数据存储设置
      • 请求
      • 响应
    • 创建数据存储设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新数据存储设置
      • 请求
        • 请求体
      • 响应
    • 删除数据存储设置
      • 请求
      • 响应
    • 处理器类型
    • 使用示例
      • 数据库爬虫设置
    • 参考信息
  • Documents API
    • 概述
    • 基础URL
    • 端点列表
    • 通过查询删除文档
      • 请求
        • 参数
      • 响应
        • 使用示例
    • 通过ID删除文档
      • 请求
        • 参数
      • 响应
        • 使用示例
    • 查询语法
      • 基本查询
      • 日期范围查询
      • 复合查询
    • 注意事项
      • 删除操作注意
      • 推荐做法
    • 使用示例
      • 准备重新爬取整个网站
      • 清理旧文档
    • 参考信息
  • CrawlingInfo API
    • 概述
    • 基础URL
    • 端点列表
    • 获取爬虫信息列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取爬虫会话详情
      • 请求
      • 响应
    • 删除爬虫会话
      • 请求
      • 响应
    • 使用示例
      • 获取爬虫信息列表
      • 获取正在运行的爬虫会话
      • 获取特定会话详情
      • 删除旧会话
      • 监控进度
    • 参考信息
  • FailureUrl API
    • 概述
    • 基础URL
    • 端点列表
    • 获取失败URL列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 删除失败URL
      • 请求
      • 响应
    • 删除所有失败URL
      • 请求
        • 参数
      • 响应
    • 错误类型
    • 使用示例
      • 获取失败URL列表
      • 按错误次数过滤
      • 获取特定配置的失败URL
      • 删除失败URL
      • 删除所有失败URL
      • 按错误类型统计
    • 参考信息
  • Backup API
    • 概述
    • 基础URL
    • 端点列表
    • 导出配置数据
      • 请求
        • 参数
        • 导出目标类型
      • 响应
        • ZIP文件内容
    • 导入配置数据
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 导出所有设置
      • 导出特定设置
      • 导入设置
      • 覆盖现有设置导入
      • 仅导入特定设置
      • 自动化备份
    • 注意事项
    • 参考信息
  • Scheduler API
    • 概述
    • 基础URL
    • 端点列表
    • 获取计划任务列表
      • 请求
        • 参数
      • 响应
    • 获取计划任务
      • 请求
      • 响应
    • 创建计划任务
      • 请求
        • 请求体
        • 字段说明
      • 响应
        • Cron表达式示例
    • 更新计划任务
      • 请求
        • 请求体
      • 响应
    • 删除计划任务
      • 请求
      • 响应
    • 启动任务
      • 请求
      • 响应
      • 注意事项
    • 停止任务
      • 请求
      • 响应
    • 使用示例
      • 创建并执行爬虫任务
      • 检查任务状态
    • 参考信息
  • JobLog API
    • 概述
    • 基础URL
    • 端点列表
    • 获取任务日志列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取任务日志详情
      • 请求
      • 响应
    • 删除任务日志
      • 请求
      • 响应
    • 删除所有任务日志
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取任务日志列表
      • 仅获取失败的任务
      • 获取特定期间的任务日志
      • 获取任务日志详情
      • 删除旧任务日志
      • 仅删除失败的任务日志
      • 检测执行时间长的任务
      • 计算任务成功率
    • 参考信息
  • User API
    • 概述
    • 基础URL
    • 端点列表
    • 获取用户列表
      • 请求
        • 参数
      • 响应
    • 获取用户
      • 请求
      • 响应
    • 创建用户
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新用户
      • 请求
        • 请求体
      • 响应
    • 删除用户
      • 请求
      • 响应
    • 使用示例
      • 创建新用户
      • 更改用户角色
    • 参考信息
  • Role API
    • 概述
    • 基础URL
    • 端点列表
    • 获取角色列表
      • 请求
        • 参数
      • 响应
    • 获取角色
      • 请求
      • 响应
    • 创建角色
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新角色
      • 请求
        • 请求体
      • 响应
    • 删除角色
      • 请求
      • 响应
    • 使用示例
      • 创建新角色
      • 获取角色列表
    • 参考信息
  • Group API
    • 概述
    • 基础URL
    • 端点列表
    • 获取组列表
      • 请求
        • 参数
      • 响应
    • 获取组
      • 请求
      • 响应
    • 创建组
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新组
      • 请求
        • 请求体
      • 响应
    • 删除组
      • 请求
      • 响应
    • 使用示例
      • 创建新组
      • 获取组列表
    • 参考信息
  • AccessToken API
    • 概述
    • 基础URL
    • 端点列表
    • 获取访问令牌列表
      • 请求
        • 参数
      • 响应
    • 获取访问令牌
      • 请求
      • 响应
    • 创建访问令牌
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新访问令牌
      • 请求
        • 请求体
      • 响应
    • 删除访问令牌
      • 请求
      • 响应
    • 使用示例
      • 创建API令牌
      • 使用令牌调用API
    • 参考信息
  • LabelType API
    • 概述
    • 基础URL
    • 端点列表
    • 获取标签类型列表
      • 请求
        • 参数
      • 响应
    • 获取标签类型
      • 请求
      • 响应
    • 创建标签类型
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新标签类型
      • 请求
        • 请求体
      • 响应
    • 删除标签类型
      • 请求
      • 响应
    • 使用示例
      • 创建文档标签
      • 使用标签搜索
    • 参考信息
  • KeyMatch API
    • 概述
    • 基础URL
    • 端点列表
    • 获取关键词匹配列表
      • 请求
        • 参数
      • 响应
    • 获取关键词匹配
      • 请求
      • 响应
    • 创建关键词匹配
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新关键词匹配
      • 请求
        • 请求体
      • 响应
    • 删除关键词匹配
      • 请求
      • 响应
    • 使用示例
      • 创建产品页面关键词匹配
      • 创建支持页面关键词匹配
    • 参考信息
  • BoostDoc API
    • 概述
    • 基础URL
    • 端点列表
    • 获取文档提升列表
      • 请求
        • 参数
      • 响应
    • 获取文档提升
      • 请求
      • 响应
    • 创建文档提升
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新文档提升
      • 请求
        • 请求体
      • 响应
    • 删除文档提升
      • 请求
      • 响应
    • 提升表达式示例
    • 使用示例
      • 文档网站提升
      • 新内容提升
    • 参考信息
  • ElevateWord API
    • 概述
    • 基础URL
    • 端点列表
    • 获取提升词列表
      • 请求
        • 参数
      • 响应
    • 获取提升词
      • 请求
      • 响应
    • 创建提升词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新提升词
      • 请求
        • 请求体
      • 响应
    • 删除提升词
      • 请求
      • 响应
    • 使用示例
      • 产品名称提升
      • 针对特定标签提升
    • 参考信息
  • BadWord API
    • 概述
    • 基础URL
    • 端点列表
    • 获取屏蔽词列表
      • 请求
        • 参数
      • 响应
    • 获取屏蔽词
      • 请求
      • 响应
    • 创建屏蔽词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新屏蔽词
      • 请求
        • 请求体
      • 响应
    • 删除屏蔽词
      • 请求
      • 响应
    • 使用示例
      • 排除垃圾关键词
      • 针对特定角色的屏蔽词
    • 参考信息
  • RelatedContent API
    • 概述
    • 基础URL
    • 端点列表
    • 获取相关内容列表
      • 请求
        • 参数
      • 响应
    • 获取相关内容
      • 请求
      • 响应
    • 创建相关内容
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新相关内容
      • 请求
        • 请求体
      • 响应
    • 删除相关内容
      • 请求
      • 响应
    • 使用示例
      • 产品信息相关内容
      • 支持信息相关内容
    • 参考信息
  • RelatedQuery API
    • 概述
    • 基础URL
    • 端点列表
    • 获取相关查询列表
      • 请求
        • 参数
      • 响应
    • 获取相关查询
      • 请求
      • 响应
    • 创建相关查询
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新相关查询
      • 请求
        • 请求体
      • 响应
    • 删除相关查询
      • 请求
      • 响应
    • 使用示例
      • 产品相关查询
      • 帮助相关查询
    • 参考信息
  • Suggest API
    • 概述
    • 基础URL
    • 端点列表
    • 获取建议词列表
      • 请求
        • 参数
      • 响应
    • 获取建议词
      • 请求
      • 响应
    • 创建建议词
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 更新建议词
      • 请求
        • 请求体
      • 响应
    • 删除建议词
      • 请求
      • 响应
    • 删除所有建议词
      • 请求
      • 响应
    • 使用示例
      • 添加热门关键词
      • 批量删除建议
    • 参考信息
  • General API
    • 概述
    • 基础URL
    • 端点列表
    • 获取常规设置
      • 请求
      • 响应
    • 更新常规设置
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 更新爬虫设置
      • 更新搜索设置
      • 更新建议设置
    • 参考信息
  • SystemInfo API
    • 概述
    • 基础URL
    • 端点列表
    • 获取系统信息
      • 请求
      • 响应
        • 响应字段
    • 使用示例
      • 获取系统信息
      • 检查版本
      • 检查内存使用情况
    • 参考信息
  • Stats API
    • 概述
    • 基础URL
    • 端点列表
    • 获取统计信息
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 使用示例
      • 获取所有统计信息
      • 指定期间的统计获取
      • 获取搜索查询统计
      • 获取热门查询TOP10
    • 参考信息
  • Log API
    • 概述
    • 基础URL
    • 端点列表
    • 获取搜索日志
      • 请求
        • 参数
      • 响应
    • 获取点击日志
      • 请求
        • 参数
      • 响应
    • 获取收藏日志
      • 请求
        • 参数
      • 响应
    • 删除搜索日志
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取最近的搜索日志
      • 获取特定期间的搜索日志
      • 获取特定查询的搜索日志
      • 获取点击日志
      • 删除旧搜索日志
    • 参考信息
  • Storage API
    • 概述
    • 基础URL
    • 端点列表
    • 获取存储信息
      • 请求
      • 响应
        • 响应字段
    • 优化索引
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 刷新索引
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 使用示例
      • 获取存储信息
      • 优化所有索引
      • 优化特定索引
      • 删除已删除文档
      • 刷新索引
    • 参考信息
  • Plugin API
    • 概述
    • 基础URL
    • 端点列表
    • 获取插件列表
      • 请求
      • 响应
        • 响应字段
    • 安装插件
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 删除插件
      • 请求
      • 响应
    • 使用示例
      • 获取插件列表
      • 安装插件
      • 删除插件
    • 注意事项
    • 参考信息
  • Dict API
    • 概述
    • 基础URL
    • 端点列表
    • 获取词典列表
      • 请求
      • 响应
    • 获取词典内容
      • 请求
      • 响应
    • 更新词典内容
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 上传词典文件
      • 请求
        • 请求体
        • 字段说明
      • 响应
    • 词典类型
    • 词典格式示例
      • 同义词词典
      • 映射词典
      • 保护词词典
    • 使用示例
      • 获取词典列表
      • 获取同义词词典内容
      • 更新同义词词典
      • 上传词典文件
    • 注意事项
    • 参考信息
  • SearchLog API
    • 概述
    • 基础URL
    • 端点列表
    • 获取搜索日志列表
      • 请求
        • 参数
      • 响应
        • 响应字段
    • 获取搜索日志详情
      • 请求
      • 响应
    • 删除搜索日志
      • 请求
      • 响应
    • 批量删除搜索日志
      • 请求
        • 参数
      • 响应
    • 获取搜索统计
      • 请求
        • 参数
      • 响应
    • 使用示例
      • 获取搜索日志列表
      • 指定期间获取
      • 获取特定用户的搜索日志
      • 获取特定关键词的搜索日志
      • 获取搜索统计
      • 删除旧搜索日志
      • 提取热门搜索关键词
      • 分析搜索质量
      • 日均搜索量趋势
    • 参考信息

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 模式过滤器
      • 配置示例
    • MIME 类型检测覆盖
      • 配置示例
  • 缓存配置
    • 文档缓存
      • 配置示例
  • JVM 选项
    • 默认配置
    • 主要选项说明
    • 自定义配置示例
  • 性能调优
    • 爬取速度优化
    • 内存使用量优化
    • 索引质量提升
  • 故障排除
    • 内存不足
    • 爬取缓慢
    • 无法提取特定内容
    • 发生乱码
  • 最佳实践
  • S3/GCS 爬虫配置
    • S3 爬虫
      • 配置示例
    • GCS 爬虫
      • 配置示例
  • 参考信息
• 缩略图配置
  • 概述
  • 支持的文件格式
    • 图片文件
    • 文档文件
    • HTML 内容
  • 所需的外部工具
    • 基本工具（必需）
    • SVG 支持
    • PDF 支持
    • MS Office 支持
    • PostScript 支持
  • HTML 文件缩略图
  • 配置
    • 配置文件
    • 主要配置项（fess_config.properties）
  • generate-thumbnail 脚本
    • 概述
    • 用法
    • 参数
    • 支持的类型
    • 示例
  • 缩略图存储位置
    • 默认路径
    • 目录结构
  • 禁用缩略图任务
  • 故障排除
    • 缩略图未生成
    • GIF/TIFF 文件出错
    • SVG 缩略图未生成
    • 权限错误
  • 平台支持
• 数据存储连接器指南
  • 数据存储连接器概述
    • 概述
    • 可用的连接器
      • 云存储
      • 协作工具
      • 开发运维工具
      • 数据库和文件
    • 连接器安装
      • 插件安装
        • 从管理界面安装
        • 命令行安装
        • Docker环境
    • 数据存储设置基础
      • 通用设置项
      • 参数设置
      • 脚本设置
    • 认证设置
      • OAuth 2.0认证
      • API密钥认证
      • 服务账户认证
    • 性能调优
    • 故障排除
      • 连接器不显示
      • 认证错误
      • 无法获取数据
      • 调试设置
    • 参考信息
  • Box连接器
    • 概述
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Box认证设置
      • JWT认证设置步骤
        • 1. 在Box Developer Console创建应用程序
        • 2. 应用程序设置
        • 3. 在企业中批准
        • 4. 获取认证信息
        • 私钥格式
    • 使用示例
      • 抓取企业整个Box存储
    • 故障排除
      • 认证错误
      • 私钥格式错误
      • 无法获取文件
    • 参考信息
  • Dropbox连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • Dropbox文件的情况
        • Dropbox Paper的情况
    • Dropbox认证设置
      • 访问令牌获取步骤
        • 1. 在Dropbox App Console创建应用
        • 2. 权限设置
        • 3. 生成访问令牌
        • 4. 设置令牌
    • Basic计划设置
      • Dropbox Basic计划的限制
    • 使用示例
      • 抓取整个Dropbox文件
      • 抓取Dropbox Paper文档
    • 故障排除
      • 认证错误
      • 无法获取文件
      • API速率限制错误
    • 参考信息
  • Google Workspace连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Google Cloud Platform设置
      • 1. 创建项目
      • 2. 启用Google Drive API
      • 3. 创建服务账号
      • 4. 创建服务账号密钥
      • 5. 启用域全域委派
      • 6. 在Google Workspace管理控制台授权
    • 认证信息设置
      • 从JSON文件获取信息
        • 私钥格式
    • 使用示例
      • Google Drive全体爬取
      • 带权限爬取
      • 只爬取特定文件类型
    • 故障排除
      • 认证错误
      • 域全域委派错误
      • 无法获取文件
      • API配额错误
      • 私钥格式错误
      • 共享云端硬盘爬取
      • 有大量文件的情况
    • 权限和访问控制
      • 反映Google Drive的共享权限
    • 参考信息
  • Microsoft 365连接器
    • 概述
    • 支持的服务
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置（通用）
        • 通用参数列表
    • Azure AD应用程序注册
      • 1. 在Azure Portal注册应用程序
      • 2. 创建客户端密钥
      • 3. 添加API权限
    • 各数据存储所需权限
      • OneDriveDataStore
      • OneNoteDataStore
      • TeamsDataStore
      • SharePointDocLibDataStore
      • SharePointListDataStore / SharePointPageDataStore
    • 脚本设置
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 各数据存储的附加参数
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 使用示例
      • OneDrive全云端硬盘爬取
      • 爬取特定团队的Teams消息
      • 爬取SharePoint列表
    • 故障排除
      • 认证错误
      • API速率限制错误
      • 无法获取数据
      • 确认SharePoint站点ID的方法
      • 大量数据爬取
    • 参考信息
  • Atlassian连接器
    • 概述
    • 支持的产品
    • 前提条件
      • 插件安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • Jira的情况
        • Confluence的情况
    • OAuth 2.0认证设置
      • Cloud版的情况（推荐）
    • OAuth 1.0a认证设置
      • Server版的情况
    • Basic认证设置
      • Server版的简单设置
    • JQL高级搜索
      • 用JQL筛选Jira问题
    • 使用示例
      • Jira Cloud抓取
      • Confluence Server抓取
    • 故障排除
      • 认证错误
      • 连接错误
      • 无法获取数据
      • OAuth 2.0令牌更新
    • 参考信息
  • Slack连接器
    • 概述
    • 支持的内容
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Slack App设置
      • 1. 创建Slack App
      • 2. OAuth & Permissions设置
      • 3. 安装应用
      • 4. 添加到频道
    • 使用示例
      • 爬取特定频道
      • 爬取所有频道
      • 包含私有频道爬取
      • 包含文件爬取
      • 包含详细消息信息
    • 故障排除
      • 认证错误
      • 找不到频道
      • 无法获取消息
      • 权限不足错误
      • 无法爬取文件
      • API速率限制
      • 有大量消息的情况
    • 脚本的高级使用示例
      • 消息过滤
      • 消息加工
    • 参考信息
  • Git连接器
    • 概述
    • 支持的仓库
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Git仓库认证
      • GitHub Personal Access Token
        • 1. 在GitHub生成Personal Access Token
        • 2. 在URI中包含认证信息
      • GitLab Private Token
        • 1. 在GitLab生成Access Token
        • 2. 在URI中包含认证信息
      • SSH认证
    • 提取器设置
      • 按MIME类型的提取器
        • 默认提取器
        • 只爬取文本文件
        • 爬取所有文件
        • 只爬取特定文件类型
    • 增量爬取
      • 只爬取上次提交以来的变更
      • 已删除文件的处理
    • 使用示例
      • GitHub公共仓库
      • GitHub私有仓库
      • GitLab（自托管）
      • 只爬取文档（Markdown文件）
      • 只爬取特定目录
    • 故障排除
      • 认证错误
      • 找不到仓库
      • 无法获取文件
      • MIME类型错误
      • 大型仓库
      • 分支指定
    • URL生成
      • base_url设置模式
      • 在脚本中生成URL
    • 参考信息
  • Elasticsearch/OpenSearch连接器
    • 概述
    • 支持版本
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • 查询设置
      • 获取所有文档
      • 特定条件过滤
    • 只获取特定字段
      • 使用fields参数限制获取字段
    • 使用示例
      • 基本索引爬取
      • 从带认证的集群爬取
      • 从多个索引爬取
      • OpenSearch集群爬取
      • 限制字段爬取
      • 多主机负载均衡
    • 故障排除
      • 连接错误
      • 认证错误
      • 找不到索引
      • 查询错误
      • 滚动超时
      • 大量数据爬取
      • 内存不足
    • SSL/TLS连接
      • 自签名证书的情况
      • 客户端证书认证
    • 高级查询示例
      • 包含聚合的查询
      • 脚本字段
    • 参考信息
  • Salesforce连接器
    • 概述
    • 支持的对象
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • Salesforce Connected App设置
      • 1. 创建Connected App
      • 2. OAuth Token认证设置（推荐）
      • 3. OAuth Password认证设置
      • 4. 授权Connected App
    • 自定义对象设置
      • 爬取自定义对象
        • 字段映射规则
    • 使用示例
      • 爬取标准对象
      • 爬取自定义对象
      • 爬取沙盒环境
    • 故障排除
      • 认证错误
      • 无法获取对象
      • 自定义对象名称
      • 确认字段名
      • API速率限制
      • 有大量数据的情况
      • 私钥格式错误
    • 参考信息
  • 数据库连接器
    • 概述
    • 支持的数据库
    • 前提条件
      • JDBC驱动程序安装
    • 设置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
    • SQL查询设计
      • 高效查询
      • 增量抓取
      • URL生成
    • 多字节字符支持
      • MySQL
      • PostgreSQL
    • 连接池
    • 安全性
      • 数据库认证信息保护
      • 最小权限原则
    • 使用示例
      • 产品目录搜索
      • 知识库文章
    • 故障排除
      • 找不到JDBC驱动程序
      • 连接错误
      • 查询错误
    • 参考信息
  • CSV连接器
    • 概述
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • CSV格式详情
      • 标准CSV（RFC 4180兼容）
      • 更改分隔符
      • 自定义引号
      • 编码
    • 使用示例
      • 产品目录CSV
      • 员工名册CSV
      • 无标题行的CSV
      • 多CSV文件整合
      • 制表符分隔（TSV）文件
    • 故障排除
      • 找不到文件
      • 出现乱码
      • 列无法正确识别
      • 标题行处理
      • 无法获取数据
      • 大型CSV文件
      • 包含换行符的字段
    • 脚本的高级使用示例
      • 数据加工
      • 条件索引
      • 多列合并
      • 日期格式化
    • 参考信息
  • JSON连接器
    • 概述
    • 前提条件
      • 插件安装
    • 配置方法
      • 基本设置
      • 参数设置
        • 参数列表
      • 脚本设置
        • 可用字段
    • JSON格式详情
      • 简单数组
      • 嵌套结构
      • 复杂数组
    • 使用示例
      • 产品目录API
      • 博客文章API
      • 多JSON文件整合
    • 故障排除
      • 找不到文件
      • JSON解析错误
      • JSONPath错误
      • 认证错误
      • 无法获取数据
      • 数组处理
      • 大型JSON文件
      • API速率限制
    • 脚本的高级使用示例
      • 条件处理
      • 数组合并
      • 设置默认值
      • 日期格式化
      • 数值处理
    • 参考信息
• 搜索功能
  • 概述
  • 搜索结果数量显示
    • 默认行为
    • 显示准确命中数量
  • 搜索选项
    • 基本搜索
    • OR 搜索
    • NOT 搜索
    • 短语搜索
    • 字段指定搜索
    • 通配符搜索
    • 模糊搜索
  • 搜索结果排序
  • 分面搜索
  • 搜索结果高亮显示
  • 建议功能
  • 搜索日志
  • 性能调优
    • 搜索超时配置
    • 搜索查询最大字符数
    • 使用缓存
  • 故障排除
    • 搜索结果未显示
    • 搜索速度慢
    • 显示不相关结果
• 搜索相关配置
  • 模糊搜索
  • 搜索超时值
  • 搜索最大字符数
  • 搜索超时日志输出
  • 命中数量显示
  • 位置信息搜索索引名
  • 请求参数语言指定
  • 前方一致搜索指定
  • 高亮字符串
  • 高亮片段
  • 高亮生成方法
  • 高亮对象标签
  • 传递给 OpenSearch 高亮器的值
  • 添加到响应的字段名
  • 添加字段名
  • 以 GSA 兼容 XML 格式获取搜索结果的配置
• 位置信息搜索
  • 概述
  • 用例
  • 配置方法
    • 索引生成时的配置
      • 位置信息字段定义
      • 位置信息注册格式
      • 数据存储爬取的配置示例
      • 脚本添加位置信息
    • 搜索时的配置
      • 请求参数
      • 距离单位
  • 搜索示例
    • 基本搜索
    • 当前位置周边搜索
    • 按距离排序
    • API 使用
  • 字段名自定义
    • 更改默认字段名
  • 实现示例
    • Web 应用程序实现
    • Google 地图集成
  • 性能优化
    • 索引配置优化
    • 搜索范围限制
  • 故障排除
    • 位置信息搜索无法工作
    • 搜索结果未返回
    • 位置信息未正确显示
  • 参考信息
• 批量获取搜索结果
  • 概述
  • 用例
  • 配置方法
    • 启用滚动搜索
    • 响应字段配置
  • 使用方法
    • 基本使用方法
    • 请求参数
    • 指定搜索查询
    • 指定获取条数
    • 按标签过滤
    • 需要认证时
  • 响应格式
    • NDJSON 格式
    • 响应字段
  • 数据处理示例
    • Python 处理示例
    • 保存到文件
    • 转换为 CSV
    • 数据分析
  • 性能和最佳实践
    • 高效使用方法
    • 内存使用量优化
  • 安全注意事项
    • 访问限制
    • 速率限制
  • 故障排除
    • 无法使用滚动搜索
    • 发生超时错误
    • 内存不足错误
    • 响应为空
  • 参考信息
• 搜索表单集成
  • 搜索表单配置方法
    • 搜索表单
    • 建议功能
• Rank Fusion 配置
  • 概述
  • 什么是 Rank Fusion
  • 支持的算法
    • RRF (Reciprocal Rank Fusion)
  • 配置
    • fess_config.properties
  • 与混合搜索的集成
  • 使用示例
    • 基本混合搜索
  • 性能注意事项
    • 内存使用
    • 处理时间
  • 故障排除
    • 搜索结果与预期不符
    • 搜索缓慢
    • 内存不足
  • 参考信息
• 基于角色的搜索配置
  • 关于基于角色的搜索
  • 基于角色的搜索配置
    • Fess 管理页面配置
    • 登录
    • 登出
• 虚拟主机
  • 关于虚拟主机
    • 系统配置
    • 爬取配置
• LDAP集成指南
  • 概述
  • 支持的LDAP服务器
  • 前提条件
  • 基本设置
    • LDAP连接设置
    • 用户搜索设置
    • 组搜索设置
  • Active Directory设置
    • 基本设置
    • Active Directory特定设置
  • OpenLDAP设置
  • 安全设置
    • LDAPS（SSL/TLS）
    • 密码保护
  • 角色映射
    • 自动映射
    • 自定义映射
  • 用户信息同步
    • 自动同步
    • 同步的属性
  • 连接池
  • 故障转移
  • 故障排除
    • 连接错误
    • 认证错误
    • 无法获取组
    • 调试设置
  • 参考信息
• 多租户配置
  • 概述
  • 虚拟主机功能
    • 工作原理
  • 虚拟主机配置
    • 管理界面配置
    • 与爬取设置的联动
  • 访问控制
    • 虚拟主机与角色的组合
    • 基于角色的搜索
  • UI定制
    • 主题应用
    • 自定义CSS
    • 标签设置
  • API认证
    • 访问令牌
    • API请求
  • DNS设置
    • 指向同一服务器的子域名
    • 反向代理设置
  • 数据隔离
    • 索引级别隔离
  • 最佳实践
  • 限制事项
  • 参考信息
• 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
  • 配置示例
    • 最小配置（用于测试）
    • 推荐配置（用于生产）
  • 故障排除
    • 常见问题和解决方案
      • 出现认证对话框
      • 发生认证错误
      • 无法获取组信息
    • 调试设置
  • 参考
• LLM集成概述
  • 概述
  • 支持的提供商
  • 架构
  • 基本配置
    • 启用AI搜索模式
    • 选择LLM提供商
  • 通用配置
    • 生成参数
    • 上下文配置
    • 系统提示词
    • 可用性检查
  • 会话管理
  • 速率限制
  • 评估配置
  • 后续步骤
• Ollama配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 安装Ollama
      • Linux/macOS
      • Windows
      • Docker
    • 下载模型
  • 基本配置
    • 最小配置
    • 推荐配置（生产环境）
  • 配置项
  • 网络配置
    • Docker配置
    • 远程Ollama服务器
  • 模型选择指南
    • GPU支持
  • 故障排除
    • 连接错误
    • 模型未找到
    • 超时
    • 调试设置
  • 参考信息
• OpenAI配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 获取API密钥
  • 基本配置
    • 最小配置
    • 推荐配置（生产环境）
  • 配置项
  • 环境变量配置
    • Docker环境
      • docker-compose.yml
    • systemd环境
  • 使用Azure OpenAI
  • 模型选择指南
    • 成本估算
  • 速率限制
    • OpenAI Tier限制
  • 故障排除
    • 认证错误
    • 速率限制错误
    • 配额超限
    • 超时
    • 调试设置
  • 安全注意事项
  • 参考信息
• Google Gemini配置
  • 概述
    • 主要特点
    • 支持的模型
  • 前提条件
    • 获取API密钥
  • 基本配置
    • 最小配置
    • 推荐配置（生产环境）
  • 配置项
  • 环境变量配置
    • Docker环境
      • docker-compose.yml
    • systemd环境
  • 通过Vertex AI使用
  • 模型选择指南
    • 上下文窗口
    • 成本估算
  • 速率限制
    • 免费额度限制
  • 故障排除
    • 认证错误
    • 速率限制错误
    • 区域限制
    • 超时
    • 调试设置
  • 安全注意事项
  • 参考信息
• AI搜索模式功能配置
  • 概述
  • AI搜索模式的工作原理
  • 基本设置
  • 生成参数
    • temperature设置
  • 上下文设置
    • 内容字段
  • 系统提示词
    • 默认设置
    • 自定义示例
  • 会话管理
    • 会话行为
  • 速率限制
    • 速率限制注意事项
  • API使用
    • 非流式API
    • 流式API
  • Web界面
    • 开始聊天
    • 使用聊天
    • 继续对话
  • 故障排除
    • AI搜索模式无法启用
    • 回答质量低
    • 响应慢
    • 会话无法保持
    • 调试设置
  • 参考信息
• 脚本概述
  • 概述
  • 支持的脚本语言
  • 脚本使用场景
    • 数据存储设置
    • 路径映射
    • 计划任务
  • 基本语法
    • 变量访问
    • 字符串操作
    • 条件分支
    • 日期操作
  • 可用对象
  • 安全性
  • 性能
  • 调试
  • 参考信息
• Groovy脚本指南
  • 概述
  • 基本语法
    • 变量声明
    • 字符串操作
    • 集合操作
    • 条件分支
    • 循环处理
  • 数据存储脚本
    • 基本映射
    • URL生成
    • 内容加工
    • 日期处理
  • 计划任务脚本
    • 执行爬取任务
    • 条件爬取
    • 顺序执行多个任务
  • 使用Java类
    • 日期与时间
    • 文件操作
    • HTTP通信
  • 访问Fess组件
    • 系统帮助器
    • 获取配置值
    • 执行搜索
  • 错误处理
  • 调试与日志输出
    • 日志输出
    • 调试输出
  • 最佳实践
  • 参考信息
• 速率限制配置
  • 概述
  • HTTP请求的速率限制
    • 设置
    • 行为
  • AI搜索模式的速率限制
  • 爬虫的速率限制
    • Web爬取设置
    • 遵守robots.txt
  • 速率限制的全部配置项
  • 高级速率限制设置
    • 自定义速率限制
  • 排除设置
  • 监控与告警
    • 日志输出
  • 故障排除
    • 正常请求被阻止
    • 速率限制不生效
    • 性能影响
  • 参考信息
• 负载控制配置
  • 概述
  • HTTP请求负载控制配置
  • 工作原理
    • 监控机制
    • 请求控制
  • 配置示例
    • 仅限制Web请求
    • 同时限制Web和API
  • 与速率限制的区别
  • 自适应负载控制
    • 配置
    • 行为
  • 故障排除
    • 负载控制未生效
    • 正常请求被拒绝
    • 爬取速度慢
  • 参考信息
• 日志配置
  • 概述
  • 日志文件类型
    • 主要日志文件
    • 日志文件位置
    • 故障排除时的日志确认
  • 日志级别配置
    • 什么是日志级别
    • 推荐日志级别
    • 从管理页面变更
    • 通过配置文件变更
      • 配置文件位置
      • 基本配置示例
      • 通过环境变量配置
  • 爬虫日志配置
    • 管理页面配置
      • 仅更改特定URL模式的日志级别
  • 日志轮转
    • 概述
    • Log4j2 自动轮转
      • 默认配置
      • 每日轮转配置
      • 压缩配置
    • logrotate 轮转
  • 日志监控
    • 需要监控的日志模式
      • 重要错误模式
      • 应警告的模式
    • 实时监控
    • 监控工具示例
    • 告警配置
  • 日志格式
    • 默认格式
    • 自定义格式示例
      • JSON格式输出日志
      • 包含更详细信息
  • 性能影响
    • 最佳实践
    • 性能测量
  • 故障排除
    • 日志未输出
    • 日志文件过大
    • 找不到特定日志
    • 日志出现乱码
  • 参考信息
• 索引管理
  • 概述
  • 索引构成
  • 索引备份和恢复
    • 快照仓库配置
    • 创建快照(备份)
      • 备份所有索引
      • 备份特定索引
      • 定期自动备份
    • 确认快照
    • 从快照恢复
      • 恢复所有索引
      • 恢复特定索引
      • 更改索引名恢复
    • 删除快照
  • 配置文件备份
    • 备份对象文件
    • 配置文件备份示例
  • 数据迁移
    • 迁移到其他环境的步骤
    • 版本升级注意事项
  • 故障排除
    • 快照创建失败
    • 恢复失败
    • 恢复后无法搜索
  • 参考信息
• 索引导出功能
  • 概述
  • 工作原理
  • 配置属性
  • 启用作业
  • 自定义查询过滤
  • 导出文件结构
  • 最佳实践
    • 存储注意事项
    • 性能提示
    • 安全建议
  • 故障排除
    • 导出作业未运行
    • 导出目录为空
    • 导出中途失败
    • 文件无法访问
  • 相关主题
• Analyzer 配置
  • 关于 Analyzer
• 搜索日志可视化配置
  • 关于搜索日志可视化
    • 可视化的信息
  • OpenSearch Dashboards 数据可视化配置
    • OpenSearch Dashboards 安装
    • 编辑配置文件
    • 启动 OpenSearch Dashboards
    • 配置索引模式
    • 创建可视化和仪表板
      • 创建基本可视化
      • 创建仪表板
    • 时区配置
    • 确认日志数据
    • 主要搜索日志字段
    • 故障排除
      • 数据未显示
      • 发生连接错误

JavaDocs

XRef

I/F Doc

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