folioorg/mod-roles-keycloak

FOLIO - mod-roles-keycloak

概述

mod-roles-keycloak是FOLIO平台的核心模块之一，用于与Keycloak身份认证服务集成，提供角色管理、权限策略及令牌生命周期管理功能。该模块支持数据库连接配置，可无缝集成到FOLIO生态系统中，为系统提供安全的身份验证与授权机制。

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

核心功能与特性

• Keycloak集成：与Keycloak身份服务深度集成，管理角色相关策略与客户端配置
• 数据库支持：支持FOLIO标准数据库连接，可配置数据库地址、端口、用户名等参数
• 资源配置：默认内存配置为357913941字节（约341MB），服务端口为8081/tcp
• 环境变量定制：支持通过环境变量灵活配置Java运行参数、Keycloak连接信息及令牌生命周期

使用场景

• FOLIO平台中需要与Keycloak集成实现身份验证的场景
• 需管理用户角色、权限策略及令牌有效期的FOLIO系统部署
• 企业级图书馆管理系统中基于Keycloak的统一身份认证架构

使用方法与配置说明

Docker Run命令示例

bash
docker run -d \
  --name mod-roles-keycloak \
  -p 8081:8081 \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_DATABASE=okapi \
  -e DB_USERNAME=folio \
  -e DB_PASSWORD=folio123 \
  -e KC_URL=keycloak: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
      - DB_HOST=folio-db
      - DB_PORT=5432
      - DB_DATABASE=okapi
      - DB_USERNAME=folio
      - DB_PASSWORD=folio123
      - DB_CHARSET=UTF-8
      - KC_URL=keycloak:8080
      - KC_CLIENT_ID=secret
      - KC_CLIENT_SECRET=mod-roles-keycloak
      - KC_TOKEN_TTL=59
    depends_on:
      - folio-db
      - keycloak

环境变量配置说明

Java运行参数

• JAVA_OPTIONS：Java虚拟机参数，默认值为-XX:MaxRAMPercentage=85.0

数据库连接配置

• DB_DATABASE：数据库名称
• DB_HOST：数据库主机地址
• DB_PORT：数据库端口
• DB_USERNAME：数据库用户名
• DB_PASSWORD：数据库密码
• DB_CHARSET：数据库字符集

Keycloak相关配置

• KC_URL：Keycloak服务地址，默认值为keycloak:8080
• KC_CLIENT_ID：Keycloak客户端ID，默认值为secret
• KC_CLIENT_ID_TTL：客户端ID有效期（秒），默认值为3600
• KC_CLIENT_SECRET：Keycloak客户端密钥，默认值为mod-roles-keycloak
• KC_POLICIES_CLIENT_NAME：策略客户端名称，默认值为mod-login-keycloak
• KC_TOKEN_TTL：令牌有效期（秒），默认值为59