迁移

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

入门

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 信任库以通过 TLS 进行通信。
为 mTLS 配置受信任的证书
了解如何配置双向 TLS 以验证连接到 Keycloak 的客户端。
启用和禁用功能
了解如何配置 Keycloak 以使用可选功能
配置提供程序
了解如何配置提供程序
配置日志记录
了解如何配置日志记录
FIPS 140-2 支持
如何为 FIPS 合规性配置 Keycloak 服务器
配置管理界面
了解如何为端点（如指标和健康检查）配置 Keycloak 的管理界面。
启用 Keycloak 健康检查
了解如何启用和使用 Keycloak 健康检查
启用 Keycloak 指标
了解如何从服务器启用和公开指标
启用跟踪
了解如何在 Keycloak 中启用分布式跟踪
导入和导出领域
关于如何导入和导出领域的概述
使用保管库
了解如何在 Keycloak 中使用和配置保管库
所有配置
Keycloak 的所有构建选项和配置的完整列表
所有提供程序配置
所有可用提供程序配置选项的完整列表

操作员

Keycloak 操作员安装
如何在 Kubernetes 和 OpenShift 上安装 Keycloak 操作员
基本 Keycloak 部署
如何使用操作员安装 Keycloak
Keycloak 领域导入
如何使用操作员执行自动化的 Keycloak 领域导入
高级配置
如何调整 Keycloak CR 的高级方面
使用自定义 Keycloak 镜像
如何自定义和优化 Keycloak 容器

保护应用程序

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

高可用性

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