如何将您的 Outline 知识库连接到 ReplyRabbit
兼容 Outline
将你的 Outline wiki(自托管或 getoutline.com 云)连接到 ReplyRabbit,以便 AI 草稿可以利用你团队的知识库。Outline 页面默认保持内部:用于帮助撰写回复,但除非你明确将页面标记为客户可见,否则永远不会向客户显示或链接。
这是 Team 套餐功能。对于核心 ReplyRabbit 设置,请使用 如何设置 ReplyRabbit。对于一般问题,请参阅 ReplyRabbit 常见问题.
何时使用 ReplyRabbit 的大纲功能
当您的团队将知识保存在 Outline 而不是 FreeScout 知识库模块中时,使用此功能。如果您使用 FreeScout 模块,请参阅 如何连接您的 FreeScout 知识库。Outline 与 ReplyRabbit 配合良好,因为:
- 你通过 Outline 权限控制页面访问,ReplyRabbit 只读取你的服务用户可以访问的内容。
- 页面默认不会出现在客户回复中,因此您的内部运行手册和供应商信息绝不会泄露到草稿中。
- 每天一次同步加上手动“立即同步”,无需实时 webhook 即可让 ReplyRabbit 保持最新。
如果你的 Outline 位于 SSO 代理后面(Cloudflare Access、Authentik、oauth2-proxy),你可能需要调整代理设置或使用 Outline 的内部地址。
设置路径
创建服务用户
在你的身份提供商(你的 SSO 系统)中,创建一个专用用户账户,例如replyrabbit@yourcompany.com。此账户成为 ReplyRabbit 在 Outline 内部的"眼睛"。登录一次 Outline
让该服务用户通过您正常的 SSO 流程登录 Outline。该账户必须存在于 Outline 中,然后才能创建 API 密钥。在 Outline 中授予访问权限
仅与该服务用户共享你希望 ReplyRabbit 使用的 Outline 集合或页面。像授予 Onyx 或内部 wiki 等任何工具的访问权限一样共享它们。不要将该用户设为管理员;拥有特定集合访问权限的普通成员就足够了。创建 API 密钥
以该服务用户身份登录 Outline。打开设置,然后 API 与访问 在 Account 下,然后点击 新 API 密钥. Older self-hosted versions call this page "API" or "API and Apps".The screenshots below show Outline's English interface; labels may be translated in your Outline workspace. 命名密钥
个人 API 密钥位于您自己的账户设置下,而不是工作区设置下。 ReplyRabbit,输入read在 范围,并设置 过期时间 到“无过期时间”。Outline 的默认值是 30 天,密钥过期时同步会停止。点击 创建 并复制密钥。
读取范围涵盖 ReplyRabbit 所需的一切并阻止任何写入。 打开 ReplyRabbit 设置
在 FreeScout 中,转到邮箱设置并在 ReplyRabbit 下找到“文档来源”。添加 Outline 源
点击“添加 Outline 来源”。粘贴您的 Outline URL(例如,https://wiki.company.com或你的 getoutline.com 工作区 URL)以及你刚刚复制的 API 密钥。选择要同步的内容
粘贴 URL 和密钥后,点击 "Test connection"。它会显示该密钥属于哪个 Outline 用户,因此您可以检查它是服务用户而不是个人密钥。然后选择 "Everything this key can read"(推荐,与 Outline 自身的权限匹配)或 "Only specific collections or pages",并在树中勾选它们,或粘贴集合或页面链接。同步并测试
保存您的设置。保存新来源,或更改其地址、密钥或范围,会立即开始同步。之后每天同步,来源上的“立即同步”可随时运行一次。然后测试草稿以确认 ReplyRabbit 可以使用该内容。
隐私和安全
Outline 页面默认是内部的。 页面文本存储在 FreeScout 中,并发送到您的 AI 提供商和嵌入提供商(通常与您用于草稿的提供商相同)。除非您为所有选定页面都可安全共享的来源打开“客户可以看到这些页面”,否则页面绝不会在客户回复中被逐字引用或链接。
仅在以下情况下开启“客户可以看到这些页面”:
- 每个选定的页面都能打开并正确显示,无需登录。
- 内容适合客户(不包含内部运营细节、供应商信息或员工指示)。
只分享所需内容。 如果你与 ReplyRabbit 共享整个 Outline 工作区,服务用户能读取的所有内容都会对 AI 可用并存储在 FreeScout 中。请改为共享特定集合或页面,就像你限制任何其他工具的访问一样。
处理内部网络地址
如果你的 Outline 运行在私有 IP 地址或内部主机名上(例如 outline.internal.company.com),在添加来源时开启"Outline 位于我们的内部网络"。这允许 ReplyRabbit:
- 访问私有 IP 地址(10.x.x.x、192.168.x.x、172.16.x.x 到 172.31.x.x)
- 通过您的网络 DNS 解析内部主机名
- 仅在私有地址上使用 HTTP(未加密)
即使开启此选项,公共地址仍需要 HTTPS。如果你的 Outline 使用带有自己内部 CA 证书的 HTTPS,你的 FreeScout 服务器的信任存储必须包含该 CA 证书。
处理 SSO 代理
Outline 自己的登录: 如果你的团队通过 Google、Microsoft、Slack、OIDC 或 Outline 自己管理的电子邮件链接登录 Outline,则无需额外设置。API 密钥绕过登录流程。
Outline 前的 SSO 代理: 如果 Cloudflare Access、Authentik 或 oauth2-proxy 之类的东西位于 Outline 前面并拦截请求,ReplyRabbit 无法访问 API。你会看到错误消息“Outline 前面的某个东西要求登录。”
通过选择以下方法之一来修复此问题:
- 绕过代理用于
/api/仅。 配置您的代理,让 FreeScout 服务器可以访问/api/*直接绕过登录检查。大多数代理支持基于路径或基于 IP 的绕过规则。请查看代理的文档以了解该设置。 - 使用 Outline 的内部地址。 如果你的 Outline 有跳过代理的私有 IP 或内部主机名,请在 ReplyRabbit 中使用它。对于私有地址,你需要开启“Outline 在我们的内部网络上”。
如果你无法绕过代理,请联系管理员为 ReplyRabbit 的服务器启用这些选项之一。
故障排除
"Outline 正在限制请求频率。将在下次计划运行时重试。" Outline 要求 ReplyRabbit 放慢速度。同步已经按 Outline 的要求等待并重试,而 Outline 仍然繁忙,因此它将在下一次每日同步时再次尝试。在此期间,已索引的页面仍然可用。要更快重试,请在几分钟后再次点击“立即同步”。
"此 Outline 版本过旧。请将 Outline 更新到 0.87 或更高版本,然后重新测试连接。" 你自托管的 Outline 缺少 ReplyRabbit 需要的 API 方法。将其升级到 0.87 或更高版本,然后再次点击 "Test connection"。
"此来源已关闭。请开启"使用此来源",保存并同步。" Outline 来源已关闭。勾选“使用此来源”,保存设置,然后点击“立即同步”。
"Outline 拒绝了该 API 密钥。" API 密钥无效或已被撤销。在 Outline 设置 > API 中使用以下内容生成新密钥 read 范围。
"无法访问 Outline。请检查 URL 并重试。" URL 错误,或 ReplyRabbit 无法访问服务器。请确认:
- URL 正确(例如,
https://wiki.company.com,而不是主页或特定页面)。 - 如果 Outline 位于私有 IP 或内部主机名上,请开启“Outline 在我们的内部网络上”。
- 如果 Outline 位于 SSO 代理后面,请检查上面的“处理 SSO 代理”部分。
- 如果你最近升级了服务器的 PHP 版本,请参阅 修复 FreeScout 中的 "deprecated since 8.5" 错误.
"请先输入 Outline API 密钥。" 在测试或同步之前,将 API 密钥粘贴到字段中。
"Outline 知识源是团队版功能。" 你当前的计划不包含 Outline 集成。升级到 Team 计划以使用此功能。
最低 Outline 版本
自托管 Outline 需要 0.87 或更高版本(在 1.0 到 1.10 上测试)。旧版本缺少 ReplyRabbit 用于读取页面树的部分 API。测试连接会检查缺失的页面树 API。如果报告旧版本,请先更新 Outline。
getoutline.com 上的云版本始终是最新的并受支持。
稍后切换来源
迁移到公共文档站点: 如果你以后想切换到公共网站(而不是保持 Outline 内部),请添加网站文档来源,并在准备好时禁用或移除 Outline 来源。两者可以在迁移期间并行运行。移除 Outline 来源会从草稿中隐藏其页面并从 ReplyRabbit 的存储中删除它们。
从 Team 降级: 如果你从 Team 套餐降级,你的 Outline 来源和 API 设置会保留在数据库中,但同步的页面会被删除,无法用于草稿检索。你的来源配置会保留,因此当你升级回 Team 时,可以再次同步它们而无需重新输入 URL 和 API 密钥。