folioci/mod-roles-keycloak

mod-roles-keycloak 镜像文档

镜像概述和主要用途

mod-roles-keycloak是FOLIO项目的核心模块之一，提供与Keycloak集成的角色管理和认证授权功能。该Docker镜像封装了此模块，可直接部署用于FOLIO生态系统中的身份认证与权限控制。

代码仓库：https://github.com/folio-org/mod-roles-keycloak

核心功能和特性

• Keycloak集成：与Keycloak身份认证服务无缝集成，处理认证流程和令牌管理
• 角色管理：提供FOLIO系统角色的创建、分配和管理功能
• 权限控制：基于Keycloak策略实现细粒度权限控制
• 数据库支持：依赖数据库存储角色和权限相关数据
• 可配置参数：支持JVM参数、数据库连接和Keycloak连接参数的自定义配置

使用场景和适用范围

适用于基于FOLIO框架构建的应用系统，特别是需要与Keycloak集成进行身份认证和角色权限管理的场景，如图书馆管理系统、学术资源平台等FOLIO生态应用。

使用方法和配置说明

基础信息

• 容器内存：357913941字节
• 默认端口：8081/tcp（需映射宿主机端口使用）

环境变量配置

Docker部署示例

基本运行命令

bash
docker run -d \
  --name mod-roles-keycloak \
  -p 8081:8081 \
  -e DB_HOST=folio-postgres \
  -e DB_PORT=5432 \
  -e DB_DATABASE=folio_mod_roles \
  -e DB_USERNAME=folio_user \
  -e DB_PASSWORD=secure_password \
  -e KC_URL=keycloak-server:8080 \
  folioorg/mod-roles-keycloak

Docker Compose配置示例

yaml
version: '3'
services:
  mod-roles-keycloak:
    image: folioorg/mod-roles-keycloak
    ports:
      - "8081:8081"
    environment:
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=85.0 -Xms256m
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_DATABASE=folio
      - DB_USERNAME=folio_user
      - DB_PASSWORD=folio_password
      - KC_URL=keycloak:8080
      - KC_CLIENT_ID=folio-client
      - KC_CLIENT_SECRET=folio-client-secret
    depends_on:
      - postgres
      - keycloak

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_DB=folio
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=folio_password

  keycloak:
    image: quay.io/keycloak/keycloak:18.0
    environment:
      - KEYCLOAK_ADMIN=admin
      - KEYCLOAK_ADMIN_PASSWORD=admin
    command: start-dev

注意事项

• 必须配置数据库连接参数（DB_HOST、DB_PORT、DB_DATABASE、DB_USERNAME、DB_PASSWORD），否则模块无法启动
• Keycloak服务需提前部署并确保KC_URL可访问
• 根据实际环境调整JVM参数（JAVA_OPTIONS）以优化性能