X4 BPMS Keycloak Server Docker镜像文档

1. 镜像概述

1.1 主要用途

本镜像为X4 BPMS（业务流程管理系统）提供专用的Keycloak Docker环境，用于实现X4 BPMS平台的身份认证与授权管理。X4 BPMS作为中央数字化平台，旨在通过低代码原则实现业务流程的数字化，连接人员、系统与设备，消除手动流程；而Keycloak作为开源身份认证服务器，为X4 BPMS提供用户身份验证、权限控制及访问管理能力，保障平台安全稳定运行。

2. 核心功能与特性

2.1 核心功能

• 身份认证：支持多种认证方式（如用户名密码、OAuth2、OpenID Connect等），为X4 BPMS用户提供安全的登录验证。
• 授权管理：基于角色的访问控制（RBAC），可定义细粒度权限策略，控制用户对X4 BPMS中业务流程、数据及功能模块的访问权限。
• 用户与角色管理：提供用户、角色、群组的创建与管理功能，支持批量操作及权限继承，适配X4 BPMS的多用户协作场景。
• 与X4 Server集成：作为X4 BPMS核心组件X4 Server的配套服务，无缝集成X4 ESB（企业服务总线）、X4 BPM（业务流程管理）及X4 Control Center（控制中心），保障整体架构的安全性。

2.2 特性

• 低代码适配：符合X4 BPMS的低代码原则，简化身份认证模块的配置与集成流程，无需深入编程知识即可完成基础权限设置。
• 轻量化部署：通过Docker容器化部署，简化环境配置，支持快速启动与扩展。
• 开源基础：基于Keycloak开源框架，具备成熟的社区支持与持续更新能力。

3. 使用场景与适用范围

3.1 适用场景

• X4 BPMS部署环境：在企业部署X4 BPMS时，需为平台用户（如管理员、业务人员、开发人员）提供身份认证与权限管理。
• 多用户协作流程：涉及多角色参与的业务流程（如审批流程、项目管理流程等），需通过角色权限控制数据与操作可见性。
• 企业级数字化平台：作为X4 BPMS与其他系统（如ERP、CRM）集成时的统一身份入口，实现跨系统单点登录（SSO）。

3.2 适用范围

• 企业内部业务流程数字化平台
• 基于X4 BPMS构建的低代码应用系统
• 需要严格权限控制的业务流程管理场景

4. 使用方法

4.1 基本部署命令

通过以下命令启动X4 BPMS Keycloak容器：

docker run -d -p 8085:8085 --name x4-keycloak \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=admin \
  softproject/keycloak

参数说明：

• -d：后台运行容器；
• -p 8085:8085：将容器内8085端口映射到主机8085端口（Keycloak默认HTTP端口）；
• --name x4-keycloak：指定容器名称为x4-keycloak；
• -e KEYCLOAK_ADMIN=admin：设置Keycloak管理员用户名（默认admin）；
• -e KEYCLOAK_ADMIN_PASSWORD=admin：设置管理员密码（默认admin，生产环境需修改为强密码）；
• softproject/keycloak：镜像名称。

4.2 查看容器日志

启动容器后，可通过以下命令实时查看日志：

docker run -d -p 8085:8085 --name x4-keycloak \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=admin \
  softproject/keycloak && docker logs x4-keycloak

4.3 与X4 Server集成

若需与X4 BPMS核心组件x4_server镜像配合使用，需参考官方文档：X4 Server Docker镜像文档。

5. 配置说明

5.1 环境变量

当前镜像支持的核心环境变量如下：

更多配置参数（如HTTPS启用、数据库连接等）可参考Keycloak官方文档。

6. 系统要求

关于镜像运行的系统要求（如CPU、内存、Docker版本等），请参考X4 BPMS官方文档：X4 BPMS系统要求。

7. 相关资源

• X4 Designer下载：X4 Designer工具（用于X4 BPMS流程建模与配置）
• X4 BPMS文档：官方文档中心
• 申请试用版：30天免费试用
• Keycloak官方文档：Keycloak Docker部署指南
• 联系支持：获取产品与服务咨询