Fess 配置指南

Fess 配置的综合指南。各章节按目的进行分类整理。

简介

配置简介

• 目标读者
• 阅读本文档前
• 前提条件
• 在线访问
• 技术支持联系方式
• 第三方网站参考
• 反馈意见和建议

基础配置

端口与网络配置

• 概述
• 使用端口配置
• 代理服务器配置
• HTTP 通信配置
• 虚拟主机配置
• 反向代理集成
• 防火墙配置
• 故障排除
• 参考信息

内存配置

• 概述
• Fess Web 应用程序的内存配置
• 爬虫的内存配置
• OpenSearch 的内存配置
• 建议/缩略图处理的内存配置
• 内存监控与调优
• 故障排除
• 参考信息

注册为 Windows 服务

• 注册为 Windows 服务

爬虫配置

爬虫配置：Web、文件服务器与数据库爬取

• 概述
• 爬虫的基本概念
• 创建爬取配置
• 执行爬取
• 基本配置项
• 文件大小配置
• 单词长度限制
• 代理服务器配置
• robots.txt 配置
• User-Agent 配置
• 编码配置
• 爬取故障排除
• 最佳实践
• 参考信息

爬虫高级配置

• 概述
• 全局配置
• 文档处理配置
• 协议配置
• robots.txt 配置
• 错误处理配置
• 系统监控配置
• 元数据配置
• HTML 爬虫配置
• 文件爬虫配置
• 缓存配置
• JVM 选项
• 性能调优
• 故障排除
• 最佳实践
• S3/GCS 爬虫配置
• 动态内容爬取 (Playwright)
• 参考信息

缩略图配置

• 概述
• 支持的文件格式
• 所需的外部工具
• HTML 文件缩略图
• 配置
• generate-thumbnail 脚本
• 缩略图存储位置
• 禁用缩略图任务
• 故障排除
• 平台支持

数据存储连接器

数据存储连接器指南

• 数据存储连接器概述
• Box连接器
• Dropbox连接器
• Google Workspace连接器
• Microsoft 365连接器
• Atlassian连接器
• Slack连接器
• Git连接器
• Elasticsearch/OpenSearch连接器
• Salesforce连接器
• 数据库连接器（数据库搜索）
• CSV连接器
• JSON连接器

搜索功能配置

搜索功能

• 概述
• 搜索结果数量显示
• 搜索选项
• 搜索结果排序
• 分面搜索
• 搜索结果高亮显示
• 建议功能
• 搜索日志
• 性能调优
• 故障排除

搜索相关配置

• 模糊搜索
• 搜索超时值
• 搜索最大字符数
• 搜索超时日志输出
• 命中数量显示
• 搜索结果最大偏移量
• OR搜索再搜索阈值
• 位置信息搜索字段名
• 请求参数语言指定
• 搜索默认语言
• 语言代码映射
• 前方一致搜索指定
• 高亮字符串
• 高亮片段
• 高亮生成方法
• 高亮目标标签
• 传递给OpenSearch高亮器的值
• 高亮高级设置
• 添加到响应的字段名
• 添加字段名
• 相似文档折叠（collapse）
• 搜索偏好
• 关联度（提升值）的配置
• 查询类型配置
• 前缀搜索与模糊搜索的详细配置
• 分面配置
• 以GSA兼容XML格式获取搜索结果的配置

位置信息搜索

• 概述
• 用例
• 配置方法
• 搜索示例
• 字段名自定义
• 实现示例
• 性能优化
• 故障排除
• 参考信息

批量获取搜索结果

• 概述
• 用例
• 配置方法
• 使用方法
• 响应格式
• 数据处理示例
• 性能与最佳实践
• 安全注意事项
• 故障排除
• 参考信息

搜索表单集成

• 搜索表单配置方法

混合搜索与 Rank Fusion（语义 + 关键词）

• 概述
• 什么是 Rank Fusion
• 支持的算法
• 配置
• 与混合搜索的集成
• 融合结果的确认
• 对命中数量的影响
• 使用示例
• 性能注意事项
• 搜索器故障时的行为
• 故障排除
• 参考信息

语义搜索（内容分块 + 向量搜索）

• 概述
• 前提条件
• 配置参考
• 配置步骤（以 opensearch 提供商为例）
• 语义搜索的工作方式
• 与 AI 搜索模式的集成
• 从 15.7 及更早版本迁移
• 注意事项
• 参考信息

安全配置

基于角色的搜索配置

• 关于基于角色的搜索
• 基于角色的搜索配置

虚拟主机

• 关于虚拟主机

LDAP集成指南

• 概述
• 支持的LDAP服务器
• 前提条件
• 设置方法概述
• 连接与认证设置
• LDAP管理功能与行为设置
• Active Directory设置
• OpenLDAP设置
• 安全设置
• 故障转移
• 故障排除
• 参考信息

多租户配置

• 概述
• 虚拟主机功能
• 虚拟主机头部配置
• 管理界面配置
• 访问控制
• UI定制
• 通过API访问
• DNS设置
• 数据隔离
• 最佳实践
• 限制事项
• 参考信息

SSO配置

SAML认证SSO配置

• 概述
• 前提条件
• 基本配置
• IdP侧配置
• 用户属性映射
• 安全配置
• AuthnRequest有效期
• 配置示例
• 故障排除
• 参考

使用OpenID Connect进行SSO配置

• 概述
• 前提条件
• 基本配置
• OP侧配置
• 配置示例
• 故障排除
• 参考信息

Microsoft Entra ID SSO配置

• 概述
• 前提条件
• 基本配置
• Entra ID侧配置
• 组和角色映射
• 配置示例
• 故障排除
• 参考

Windows集成认证SSO配置

• 概述
• 前提条件
• Active Directory端配置
• 基本配置
• LDAP配置
• 浏览器设置
• 配置示例
• 故障排除
• 参考信息

LLM/AI搜索模式配置

AI 搜索（RAG）与 LLM 集成概述

• 概述
• 支持的提供商
• 插件安装
• 架构
• 基本配置
• 通用配置
• 会话管理
• 并发控制
• 评估配置
• 按提示类型配置
• 后续步骤

Ollama配置（本地 LLM / RAG）

• 概述
• 前提条件
• 插件安装
• 基本配置
• 配置项
• 按提示词类型配置
• Ollama模型选项
• 思考模型支持
• 网络配置
• 通过HTTP代理使用
• 模型选择指南
• 故障排除
• 参考信息

OpenAI配置（AI 搜索 / RAG）

• 概述
• 前提条件
• 插件安装
• 基本配置
• 配置项
• 提示词类型别配置
• 重试行为
• 流式输出和使用量信息
• 日志输出和异常检测
• 推理模型支持
• 通过 JVM 选项配置
• 通过 HTTP 代理使用
• 使用Azure OpenAI
• 模型选择指南
• 并发请求控制
• 故障排除
• 安全注意事项
• 参考信息

Google Gemini配置（AI 搜索 / RAG）

• 概述
• 前提条件
• 插件安装
• 基本配置
• 配置项
• 认证方式
• 重试行为
• 提示词类型别配置
• 思考模型支持
• 通过 JVM 选项配置
• 通过 HTTP 代理使用
• 通过Vertex AI使用
• 模型选择指南
• 并发请求控制
• 故障排除
• 安全注意事项
• 参考信息

AI搜索模式功能配置

• 概述
• 检索流水线
• AI搜索模式的工作原理
• 基本配置
• 配置路径快速参考
• 核心配置一览
• 生成参数
• 上下文配置
• 系统提示词
• 会话管理
• 并发控制
• 对话历史模式
• 查询再生成
• Markdown渲染
• API使用
• Web界面
• 故障排除
• 参考信息

脚本

脚本概述

• 概述
• 支持的脚本语言
• 脚本使用场景
• 基本语法
• 执行上下文与可用对象
• 安全性
• 性能
• 调试
• 参考信息

Groovy脚本指南

• 概述
• 基本语法
• 数据存储脚本
• 可用对象
• 计划任务脚本
• 使用Java类
• 访问Fess组件
• 错误处理
• 调试与日志输出
• 最佳实践
• 参考信息

性能与运维

速率限制配置

• 概述
• HTTP请求的速率限制
• AI搜索模式的速率限制
• 爬虫的速率限制
• 速率限制的全部配置项
• 高级速率限制设置
• 排除设置
• 监控与告警
• 故障排除
• 参考信息

负载控制配置

• 概述
• HTTP请求负载控制配置
• 工作原理
• 配置示例
• 与速率限制的区别
• 自适应负载控制
• 故障排除
• 参考信息

系统管理

日志配置

• 概述
• 日志文件类型
• 日志级别配置
• 爬虫日志配置
• 日志轮转
• 日志监控
• 日志格式
• 性能影响
• 故障排除
• 参考信息

日志通知

• 概述
• 工作原理
• 设置
• 配置属性
• 通知消息格式
• 运维指南
• 故障排除
• 参考信息

索引管理

• 概述
• 索引构成
• 索引备份与恢复
• 配置文件备份
• 数据迁移
• 故障排除
• 相关主题
• 参考信息

索引导出功能

• 概述
• 工作原理
• 配置属性
• 启用作业
• 自定义查询过滤
• 导出文件结构
• 最佳实践
• 故障排除
• 相关主题

Analyzer 的设置

• 关于 Analyzer
• Analyzer 的定义文件
• Analyzer 的注册
• 通过词典进行调整
• 注意事项

搜索日志可视化配置

• 关于搜索日志可视化
• OpenSearch Dashboards 数据可视化配置