关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强：钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

简介

Keep 中的多项功能需要可以从互联网访问的外部 URL。这对于安装提供者时的 Webhook 集成等功能尤为重要。Keep 在此过程中使用其 API URL 作为 webhook 连接器来建立自己。

当触发告警时，相应的提供者会尝试激活 webhook，传递告警 payload。因此，webhook 必须可以通过互联网访问，此过程才能有效运行。

使用 NGROK 实现外部可访问性

Keep 支持使用 NGROK 创建可访问的外部 URL。通过使用环境变量 USE_NGROK=true 启动 Keep，Keep 将自动启动 NGROK 隧道，并使用此 URL 进行 webhook 安装。

::: note 虽然 USE_NGROK 对于开发或测试很方便，但需要注意每次重启 Keep 都会生成一个新的 NGROK URL。URL 的这种变化意味着使用旧 URL 配置的提供者将无法再与 Keep 通信。

对于生产环境，建议：

• 使用永久可从互联网访问的 URL 暴露 Keep。
• 设置静态 NGROK 隧道。

然后通过设置 KEEP_API_URL 环境变量来配置 Keep 使用此稳定 URL。 :::