TIP
Keep 云：✅
Keep 企业本地部署：✅
Keep 开源：⛔️
TIP
Keep 以"托管"方式支持 Keycloak，Keep 自动配置所有资源（realm、客户端等）。Keep 也可以与外部管理的 Keycloak 配合使用。要了解如何操作，请在 Slack 上联系团队。
Keep 与 Keycloak 集成，为多租户应用程序提供强大而灵活的认证系统，支持单一登录 (SSO) 和 SAML。
何时使用
- 本地部署： 在本地部署 Keep 并需要强大的认证系统时。
- 开源： 如果您更喜欢使用开源软件满足认证需求。
- 企业协议： 当您需要支持 SAML 和 OpenID Connect 等企业级协议时。
- 完全定制： 当您需要高度可定制的认证解决方案时。
- RBAC： 当您需要基于角色的访问控制来管理用户权限时。
- 用户和组管理： 当您需要高级用户和组管理功能时。
设置说明
要使用 Keycloak 认证启动 Keep，请设置以下环境变量：
前端环境变量
| 环境变量 | 描述 | 必填 | 默认值 |
|---|---|---|---|
| AUTH_TYPE | 设置为 'KEYCLOAK' 以启用 Keycloak 认证 | 是 | - |
| KEYCLOAK_ID | 您的 Keycloak 客户端 ID（例如 keep） | 是 | - |
| KEYCLOAK_ISSUER | 您的 Keycloak 发行者 URL 的完整 URL，例如 http://localhost:8181/auth/realms/keep | 是 | - |
| KEYCLOAK_SECRET | 您的 Keycloak 客户端密钥 | 是 | keep-keycloak-secret |
后端环境变量
| 环境变量 | 描述 | 必填 | 默认值 |
|---|---|---|---|
| AUTH_TYPE | 设置为 'KEYCLOAK' 以启用 Keycloak 认证 | 是 | - |
| KEYCLOAK_URL | 您的 Keycloak 服务器的完整 URL | 是 | http://localhost:8181/auth/ |
| KEYCLOAK_REALM | 您的 Keycloak realm | 是 | keep |
| KEYCLOAK_CLIENT_ID | 您的 Keycloak 客户端 ID | 是 | keep |
| KEYCLOAK_CLIENT_SECRET | 您的 Keycloak 客户端密钥 | 是 | keep-keycloak-secret |
| KEYCLOAK_ADMIN_USER | Keycloak 的管理员用户名 | 是 | keep_admin |
| KEYCLOAK_ADMIN_PASSWORD | Keycloak 的管理员密码 | 是 | keep_admin |
| KEYCLOAK_AUDIENCE | Keycloak 的受众 | 是 | realm-management |
配置示例
为了更好地了解如何将 Keep 与 Keycloak 结合使用，您可以：
- 请参阅 Keycloak 目录以获取配置、realm.json 等
- 请参阅 Keep + Keycloak docker-compose 示例