开始使用

OpenJDK
开始在裸机上使用 Keycloak
Docker
开始在 Docker 上使用 Keycloak
Podman
开始在 Podman 上使用 Keycloak
Kubernetes
开始在 Kubernetes 上使用 Keycloak
OpenShift
开始在 OpenShift 上使用 Keycloak
扩展
开始使用 Keycloak 扩展和调优

服务器

配置 Keycloak
了解如何配置和启动 Keycloak
为生产环境配置 Keycloak
了解如何使 Keycloak 准备好用于生产环境。
管理员引导和恢复
了解如何引导和恢复管理员帐户。
目录结构
了解安装根目录下目录的用途
在容器中运行 Keycloak
了解如何从容器镜像运行 Keycloak
配置 TLS
了解如何为传入和传出请求配置 Keycloak 的 https 证书。
配置主机名 (v2)
了解如何配置 Keycloak 公开的前端和后通道端点。
使用反向代理
了解如何将 Keycloak 与反向代理、API 网关或负载均衡器一起配置。
配置数据库
关于如何配置关系数据库的概述
配置分布式缓存
了解如何配置缓存层
配置传出的 HTTP 请求
如何配置用于传出 HTTP 请求的客户端。
配置受信任的证书
如何配置 Keycloak Truststore 以通过 TLS 进行通信。
为 mTLS 配置受信任的证书
了解如何配置相互 TLS 以验证连接到 Keycloak 的客户端。
启用和禁用功能
了解如何配置 Keycloak 以使用可选功能
配置提供程序
了解如何配置提供程序
配置日志记录
了解如何配置日志记录
FIPS 140-2 支持
如何配置 Keycloak 服务器以符合 FIPS 标准
配置管理界面
了解如何为指标和健康检查等端点配置 Keycloak 的管理界面。
导入和导出 Realm
关于如何导入和导出 realm 的概述
使用 vault
了解如何在 Keycloak 中使用和配置 vault
所有配置
Keycloak 的所有构建选项和配置的完整列表
所有提供程序配置
所有可用提供程序配置选项的完整列表
检查是否可以进行滚动更新
执行更新兼容性命令以检查 Keycloak 是否支持对部署中的更改进行滚动更新。

Operator

Keycloak Operator 安装
如何在 Kubernetes 和 OpenShift 上安装 Keycloak Operator
基本 Keycloak 部署
如何使用 Operator 安装 Keycloak
Keycloak Realm 导入
如何使用 operator 执行自动化的 Keycloak Realm 导入
高级配置
如何调整 Keycloak CR 的高级方面
通过滚动更新避免停机
在优化镜像中更改主题、提供程序或配置时避免停机。
使用自定义 Keycloak 镜像
如何自定义和优化 Keycloak 容器

可观测性

使用健康检查跟踪实例状态
通过调用其健康 REST 端点，检查实例是否已完成启动并准备好服务请求。
通过指标获得洞察
收集指标以获得关于 Keycloak 运行实例的状态和活动的洞察。
使用事件指标监控用户活动
事件指标为管理员提供 Keycloak 实例中不同用户活动的聚合视图。
使用服务级别指标监控性能
使用服务级别指标 (SLI) 和服务级别目标 (SLO) 跟踪用户感知的性能和可靠性。
使用指标进行故障排除
了解存在哪些指标以及如何使用它们来排除错误和性能问题。
使用追踪进行根本原因分析
在请求生命周期中使用 OpenTelemetry 追踪记录信息，以识别 Keycloak 和连接系统中的延迟和错误的根本原因。
在仪表板中可视化活动
安装 Keycloak Grafana 仪表板以可视化捕获部署状态和活动的指标。
使用 exemplars 分析异常值和错误
使用 exemplars 将指标连接到记录的追踪，以分析错误或延迟的根本原因。

保护应用程序安全

规划应用程序和服务安全
应用程序安全介绍和基本概念
使用 OpenID Connect 保护应用程序和服务安全
使用 OpenID Connect 和 Keycloak 保护应用程序和服务安全
Keycloak JavaScript 适配器
可用于保护 Web 应用程序的客户端 JavaScript 库。
Keycloak Node.js 适配器
用于保护服务器端 JavaScript 应用的 Node.js 适配器
mod_auth_openidc Apache HTTPD 模块
使用 Keycloak 配置 mod_auth_openidc Apache 模块
用于 WildFly 和 EAP 的 Keycloak SAML Galleon 功能包
使用 Keycloak SAML Galleon 功能包来保护 WildFly 和 EAP 中的应用程序
mod_auth_mellon Apache 模块
使用 Keycloak 配置 mod_auth_mellon Apache 模块
Docker 注册表
配置 Docker 注册表以使用 Keycloak
客户端注册服务
使用客户端注册服务
客户端注册 CLI
使用 CLI 自动化客户端注册
使用令牌交换
配置和使用 Keycloak 的令牌交换
Keycloak 管理客户端
使用 Keycloak 管理客户端访问 Keycloak Admin REST API
Keycloak 授权客户端
使用 Keycloak authz 客户端管理和检查权限
Keycloak 策略执行器
在 Java 应用程序中使用 Keycloak 策略执行器
升级 Keycloak 客户端库
如何升级 Keycloak 客户端库
Apache APISIX external
将 Keycloak 集成到 Apache APISIX 以进行身份验证
KrakenD external
使用 API 网关保护 API 安全
Quarkus external
使用 OpenID Connect 和 Keycloak 保护您的 Quarkus 应用程序
Traefik Hub external
使用 Keycloak 作为身份提供程序或作为 Traefik Hub API 管理的身份代理
WildFly external
使用 Keycloak 保护 WildFly 应用程序安全

高可用性

多站点部署
连接不同站点的多个 Keycloak 部署以提高整体可用性
多站点部署的概念
了解具有同步复制的多站点部署
多站点部署的构建块
构建块、替代方案和未考虑选项的概述
使站点离线
本文介绍如何使站点离线，使其不再处理客户端请求
使站点上线
本指南介绍如何使站点上线，以便它可以处理客户端请求。
同步站点
本文介绍将离线站点与在线站点同步所需的步骤
多站点部署的健康检查
验证多站点部署的健康状况

迁移

迁移到 Quarkus 发行版
从旧的 WildFly 发行版迁移到新的 Quarkus 发行版