richardjkendall/keycloak-with-spis

自定义Keycloak镜像（含两个SPIs）

镜像概述

本镜像基于Keycloak构建，是一个添加了两个必要SPIs（Service Provider Interfaces）的自定义版本。Keycloak是开源的身份和访问管理解决方案，提供用户认证、授权、单点登录等功能，而通过集成自定义SPIs，可进一步扩展其功能以满足特定业务需求。

核心功能与特性

基础功能

• 完整继承Keycloak的核心能力，包括用户管理、角色权限控制、OAuth 2.0/OpenID Connect支持、单点登录（SSO）等
• 支持多租户架构，可配置多个独立的Realm
• 提供管理控制台，方便配置和监控

扩展功能（通过SPIs实现）

• 集成两个自定义SPIs，具体功能可根据实际需求定制（如自定义用户存储、认证流程、授权策略等）
• SPI接口符合Keycloak规范，确保与Keycloak核心功能兼容

使用场景

• 需要在Keycloak基础上扩展自定义功能的企业或开发者
• 需实现特定身份验证逻辑（如与内部系统集成的用户认证）的场景
• 需自定义授权策略（如基于业务规则的权限控制）的应用系统

使用方法

基本运行

通过以下命令启动容器：

bash
docker run -d -p 8080:8080 --name custom-keycloak [镜像名称]:[标签]

配置环境变量

可通过环境变量配置Keycloak核心参数，常用参数如下：

• KEYCLOAK_ADMIN: 管理员用户名（默认：admin）
• KEYCLOAK_ADMIN_PASSWORD: 管理员密码
• DB_VENDOR: 数据库类型（如postgres、mysql，默认使用内置H2数据库）
• DB_ADDR: 数据库地址
• DB_PORT: 数据库端口
• DB_DATABASE: 数据库名称
• DB_USER: 数据库用户名
• DB_PASSWORD: 数据库密码

示例（使用PostgreSQL数据库）：

bash
docker run -d -p 8080:8080 \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=password \
  -e DB_VENDOR=postgres \
  -e DB_ADDR=postgres-host \
  -e DB_PORT=5432 \
  -e DB_DATABASE=keycloak \
  -e DB_USER=keycloakuser \
  -e DB_PASSWORD=keycloakpass \
  --name custom-keycloak [镜像名称]:[标签]

挂载配置文件

如需自定义SPIs的配置或Keycloak的高级配置，可通过挂载配置文件实现：

bash
docker run -d -p 8080:8080 \
  -v /path/to/custom-spi-config:/opt/keycloak/conf/spi-config \
  --name custom-keycloak [镜像名称]:[标签]

访问管理控制台

容器启动后，通过浏览器访问 http://localhost:8080/admin，使用配置的管理员账号登录，即可进行Realm配置、用户管理及SPIs相关功能的启用与配置。

注意事项

• 生产环境中建议使用外部数据库（如PostgreSQL、MySQL）替代内置H2数据库
• 自定义SPIs的具体配置需参考对应SPI的文档
• 镜像标签应使用具体版本号，避免使用latest标签以确保环境一致性