jenkinsciinfra/keycloak-theme

keycloak-theme 镜像文档

镜像概述和主要用途

keycloak-theme是一个包含Jenkins项目Keycloak主题的Docker镜像。Keycloak是一款开源的身份和访问管理解决方案，提供用户认证、授权、单点登录等功能。该镜像旨在为Keycloak提供Jenkins风格的用户界面主题，用于定制Keycloak的登录页面、控制台等用户界面，使其视觉风格与Jenkins CI/CD环境保持一致，增强用户体验的统一性。

核心功能和特性

核心功能

• 提供预打包的Jenkins风格Keycloak主题文件，包括登录页面、账户管理页面、管理控制台等界面的样式定制。

主要特性

• 风格一致性：主题设计与Jenkins视觉风格（如配色方案、布局结构）保持一致，实现CI/CD环境中的品牌统一。
• 即插即用：预打包主题文件，无需手动创建或修改CSS/JS资源，简化主题部署流程。
• 兼容性：适配Keycloak的标准主题加载机制，可与主流Keycloak版本兼容（具体版本需参考镜像标签说明）。

使用场景和适用范围

适用场景

• 企业或团队使用Keycloak作为身份认证服务，同时部署了Jenkins作为CI/CD工具，需要统一两者用户界面风格。
• CI/CD环境中，管理员希望用户在使用Keycloak进行登录或权限管理时，获得与Jenkins一致的视觉体验，降低用户学习成本。
• 需要在多系统集成场景中保持统一品牌形象，提升用户对系统的辨识度和信任度。

适用范围

• 已部署Keycloak的身份认证系统。
• 使用Jenkins作为主要CI/CD工具的开发或运维团队。
• 对用户界面一致性和品牌形象有要求的企业级应用环境。

使用方法和配置说明

前提条件

• 已安装Docker环境。
• 已部署Keycloak服务（推荐使用官方Keycloak Docker镜像）。

获取镜像

从Docker仓库拉取该镜像（具体仓库地址需参考实际发布渠道）：

bash
docker pull [镜像仓库地址]/keycloak-theme:latest

集成到Keycloak部署

方法1：直接挂载主题文件到Keycloak容器

1. 运行keycloak-theme镜像，将主题文件复制到本地目录：

   bash
   docker run --rm -v $(pwd)/jenkins-theme:/theme [镜像仓库地址]/keycloak-theme:latest cp -r /opt/keycloak/themes/jenkins /theme/
   

2. 启动Keycloak容器时，挂载本地主题目录到Keycloak的主题目录：

   bash
   docker run -d \
     -p 8080:8080 \
     -v $(pwd)/jenkins-theme/jenkins:/opt/keycloak/themes/jenkins \
     -e KEYCLOAK_ADMIN=admin \
     -e KEYCLOAK_ADMIN_PASSWORD=admin \
     quay.io/keycloak/keycloak:latest start-dev
   

方法2：作为多阶段构建基础镜像（适用于自定义Keycloak镜像）

在Dockerfile中使用keycloak-theme作为基础镜像，将主题文件复制到自定义Keycloak镜像中：

dockerfile
FROM [镜像仓库地址]/keycloak-theme:latest AS theme-source
FROM quay.io/keycloak/keycloak:latest

# 复制Jenkins主题到Keycloak主题目录
COPY --from=theme-source /opt/keycloak/themes/jenkins /opt/keycloak/themes/jenkins

# 其他自定义配置...

在Keycloak中启用主题

1. 访问Keycloak管理控制台（默认地址：http://localhost:8080/admin），使用管理员账户登录。
2. 导航至“Realm Settings”（领域设置）> “Themes”（主题）。
3. 在“Login Theme”、“Account Theme”等下拉菜单中选择“jenkins”主题。
4. 点击“Save”保存配置，刷新页面即可应用Jenkins风格主题。

注意事项

• 确保Keycloak版本与主题兼容性（具体版本支持信息请参考镜像文档或发布说明）。
• 若Keycloak配置了自定义主题路径，需调整挂载路径以匹配实际配置。
• 主题更新时，需重新拉取最新版本的keycloak-theme镜像并重复集成步骤。