文档

安装

搜索

管理

API

设置

简介
- 目标读者
- 阅读本文档前
- 前提条件
- 在线访问
- 技术支持联系方式
  - 商业支持
- 第三方网站参考
- 反馈意见和建议
端口与网络配置
- 概述
- 使用端口配置
- 代理服务器配置
- HTTP 通信配置
- 虚拟主机配置
  - 概述
  - 基本配置
- 反向代理集成
- 防火墙配置
  - 开放必要端口
  - 安全组配置(云环境)
- 故障排除
- 参考信息
内存配置
- 概述
- Fess Web 应用程序的内存配置
- 爬虫的内存配置
- OpenSearch 的内存配置
- 建议/缩略图处理的内存配置
  - 建议生成进程
  - 缩略图生成进程
- 内存监控与调优
- 故障排除
- 参考信息
注册为 Windows 服务
- 注册为 Windows 服务
爬虫基本配置
- 概述
- 爬虫的基本概念
  - 什么是爬虫
  - 爬虫类型
- 创建爬取配置
- 执行爬取
- 基本配置项
- 文件大小配置
  - 获取文件大小上限
  - 索引文件大小上限
- 单词长度限制
  - 概述
  - 配置方法
- 代理服务器配置
- robots.txt 配置
  - 概述
  - 配置方法
- User-Agent 配置
  - Web爬虫的情况
  - 文件爬虫等的情况
- 编码配置
  - 爬取数据编码
  - 文件名编码
- 爬取故障排除
- 最佳实践
  - 爬取配置推荐事项
  - 计划配置推荐事项
- 参考信息
爬虫高级配置
- 概述
- 全局配置
- 文档处理配置
- 协议配置
- robots.txt 配置
- 错误处理配置
- 系统监控配置
  - 热线程配置
    - 配置示例
- 元数据配置
- HTML 爬虫配置
- 文件爬虫配置
- 缓存配置
  - 文档缓存
    - 配置示例
- JVM 选项
- 性能调优
- 故障排除
- 最佳实践
- S3/GCS 爬虫配置
  - S3 爬虫
    - 配置示例
  - GCS 爬虫
    - 配置示例
- 参考信息
缩略图配置
- 概述
- 支持的文件格式
- 所需的外部工具
- HTML 文件缩略图
- 配置
  - 配置文件
  - 主要配置项（fess_config.properties）
- generate-thumbnail 脚本
- 缩略图存储位置
  - 默认路径
  - 目录结构
- 禁用缩略图任务
- 故障排除
- 平台支持
数据存储连接器指南
- 数据存储连接器概述
- Box连接器
- Dropbox连接器
- Google Workspace连接器
- Microsoft 365连接器
- Atlassian连接器
- Slack连接器
- Git连接器
- Elasticsearch/OpenSearch连接器
- Salesforce连接器
- 数据库连接器
- CSV连接器
- JSON连接器
搜索功能
- 概述
- 搜索结果数量显示
  - 默认行为
  - 显示准确命中数量
- 搜索选项
- 搜索结果排序
- 分面搜索
- 搜索结果高亮显示
- 建议功能
- 搜索日志
- 性能调优
- 故障排除
搜索相关配置
- 模糊搜索
- 搜索超时值
- 搜索最大字符数
- 搜索超时日志输出
- 命中数量显示
- 搜索结果最大偏移量
- OR搜索再搜索阈值
- 位置信息搜索字段名
- 请求参数语言指定
- 搜索默认语言
- 语言代码映射
- 前方一致搜索指定
- 高亮字符串
- 高亮片段
- 高亮生成方法
- 高亮目标标签
- 传递给OpenSearch高亮器的值
- 高亮高级设置
- 添加到响应的字段名
- 添加字段名
- 相似文档折叠（collapse）
- 搜索偏好
- 关联度（提升值）的配置
- 查询类型配置
- 前缀搜索与模糊搜索的详细配置
- 分面配置
- 以GSA兼容XML格式获取搜索结果的配置
位置信息搜索
- 概述
- 用例
- 配置方法
  - 索引生成时的配置
  - 搜索时的配置
- 搜索示例
- 字段名自定义
  - 更改默认字段名
- 实现示例
  - Web 应用程序实现
  - Google 地图集成
- 性能优化
  - 确认索引设置
  - 搜索范围和响应的优化
- 故障排除
- 参考信息
批量获取搜索结果
- 概述
- 用例
- 配置方法
- 使用方法
- 响应格式
- 数据处理示例
- 性能与最佳实践
  - 高效使用方法
  - 内存使用量优化
- 安全注意事项
  - 访问限制
  - 速率限制
- 故障排除
- 参考信息
搜索表单集成
- 搜索表单配置方法
  - 搜索表单
  - 建议功能
Rank Fusion 配置
- 概述
- 什么是 Rank Fusion
- 支持的算法
  - RRF (Reciprocal Rank Fusion)
- 配置
  - fess_config.properties
  - JVM 系统属性
- 与混合搜索的集成
- 使用示例
  - 基本混合搜索
- 性能注意事项
  - 内存使用
  - 处理时间
- 故障排除
- 参考信息
基于角色的搜索配置
- 关于基于角色的搜索
- 基于角色的搜索配置
虚拟主机
- 关于虚拟主机
  - 系统配置
  - 爬取配置
LDAP集成指南
- 概述
- 支持的LDAP服务器
- 前提条件
- 设置方法概述
- 连接与认证设置
- LDAP管理功能与行为设置
- Active Directory设置
- OpenLDAP设置
- 安全设置
  - LDAPS（SSL/TLS）
  - 密码保护
- 故障转移
- 故障排除
- 参考信息
多租户配置
- 概述
- 虚拟主机功能
  - 工作原理
- 虚拟主机头部配置
- 管理界面配置
  - 爬取设置
- 访问控制
  - 虚拟主机与角色的组合
  - 基于角色的搜索
- UI定制
- 通过API访问
  - API请求
- DNS设置
  - 指向同一服务器的子域名
  - 反向代理设置
- 数据隔离
  - 索引级别隔离
- 最佳实践
- 限制事项
- 参考信息
SAML认证SSO配置
- 概述
  - SAML认证的工作原理
- 前提条件
- 基本配置
- IdP侧配置
  - 从IdP获取的信息
- 用户属性映射
  - 组属性配置
  - 角色属性配置
- 安全配置
- 配置示例
  - 最小配置（用于测试）
  - 推荐配置（用于生产）
- 故障排除
  - 常见问题和解决方案
  - 调试设置
- 参考
使用OpenID Connect进行SSO配置
- 概述
  - OpenID Connect认证的工作原理
- 前提条件
- 基本配置
- OP侧配置
  - 从OP获取的信息
- 配置示例
  - 最小配置（用于验证环境）
  - 推荐配置（用于生产环境）
- 故障排除
  - 常见问题和解决方案
  - 调试设置
- 参考信息
Microsoft Entra ID SSO配置
- 概述
  - Entra ID认证的工作原理
- 前提条件
- 基本配置
- Entra ID侧配置
- 组和角色映射
  - 嵌套组
  - 默认组设置
- 配置示例
- 故障排除
  - 常见问题和解决方案
  - 调试设置
- 参考
Windows集成认证SSO配置
- 概述
  - Windows集成认证的工作原理
- 前提条件
- Active Directory端配置
  - 注册服务主体名称（SPN）
- 基本配置
- LDAP配置
- 浏览器设置
- 配置示例
  - 最小配置（用于测试）
  - 推荐配置（用于生产）
- 故障排除
  - 常见问题和解决方案
  - 调试设置
- 参考信息
LLM 集成概述
- 概述
- 支持的提供商
- 插件安装
- 架构
- 基本配置
  - 管理界面的通用设置 / system.properties
  - fess_config.properties
- 通用配置
- 会话管理
- 并发控制
- 评估配置
- 按提示类型配置
  - 提示类型一览
  - 配置模式
- 后续步骤
Ollama配置
- 概述
  - 主要特点
  - 支持的模型
- 前提条件
  - 安装Ollama
  - 下载模型
- 插件安装
- 基本配置
  - 最小配置
  - 推荐配置（生产环境）
- 配置项
  - 详细配置
  - 并发控制
- 按提示词类型配置
- Ollama模型选项
- 思考模型支持
  - 思考级别（thinking level）
- 网络配置
  - 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使用
- Web界面
- 故障排除
- 参考信息
脚本概述
- 概述
- 支持的脚本语言
- 脚本使用场景
- 基本语法
- 执行上下文与可用对象
- 安全性
- 性能
- 调试
- 参考信息
Groovy脚本指南
- 概述
- 基本语法
- 数据存储脚本
- 可用对象
- 计划任务脚本
- 使用Java类
- 访问Fess组件
- 错误处理
- 调试与日志输出
  - 日志输出
  - 调试输出
- 最佳实践
- 参考信息
速率限制配置
- 概述
- HTTP请求的速率限制
  - 设置
  - 行为
- AI搜索模式的速率限制
- 爬虫的速率限制
  - Web爬取设置
  - 遵守robots.txt
- 速率限制的全部配置项
- 高级速率限制设置
  - 自定义速率限制
- 排除设置
- 监控与告警
  - 日志输出
- 故障排除
- 参考信息
负载控制配置
- 概述
- HTTP请求负载控制配置
- 工作原理
  - 监控机制
  - 请求控制
- 配置示例
  - 仅限制Web请求
  - 同时限制Web和API
- 与速率限制的区别
- 自适应负载控制
  - 配置
  - 行为
- 故障排除
- 参考信息
日志配置
- 概述
- 日志文件类型
- 日志级别配置
- 爬虫日志配置
  - 调度器配置
- 日志轮转
- 日志监控
- 日志格式
  - 默认格式
  - 自定义格式示例
    - JSON格式输出日志
    - 包含更详细信息
- 性能影响
  - 最佳实践
  - 性能测量
- 故障排除
- 参考信息
日志通知
- 概述
- 工作原理
- 设置
  - 启用
    - 从管理页面启用
    - 通过系统属性启用
  - 通知目标设置
- 配置属性
- 通知消息格式
  - 邮件通知
  - Slack / Google Chat 通知
- 运维指南
  - 推荐设置
  - OpenSearch 索引
- 故障排除
- 参考信息
索引管理
- 概述
- 索引构成
- 索引备份与恢复
- 配置文件备份
  - 备份对象文件
  - 配置文件备份示例
- 数据迁移
  - 迁移到其他环境的步骤
  - 版本升级注意事项
- 故障排除
- 相关主题
- 参考信息
索引导出功能
- 概述
- 工作原理
- 配置属性
- 启用作业
- 自定义查询过滤
- 导出文件结构
- 最佳实践
- 故障排除
- 相关主题
Analyzer 的设置
- 关于 Analyzer
- Analyzer 的定义文件
- Analyzer 的注册
- 通过词典进行调整
- 注意事项
搜索日志可视化配置
- 关于搜索日志可视化
  - 可以可视化的信息
- OpenSearch Dashboards 数据可视化配置