folioci/mod-login-keycloak

FOLIO - mod-login-keycloak

镜像概述

mod-login-keycloak是FOLIO平台的登录模块镜像，用于集成Keycloak身份认证服务，实现用户登录、认证与授权功能。该镜像源自https://github.com/folio-org/mod-login-keycloak%EF%BC%8C%E4%B8%BAFOLIO%E7%94%9F%E6%80%81%E7%B3%BB%E7%BB%9F%E6%8F%90%E4%BE%9B%E5%AE%89%E5%85%A8%E7%9A%84%E8%BA%AB%E4%BB%BD%E9%AA%8C%E8%AF%81%E6%94%AF%E6%8C%81%E3%80%82

核心功能与特性

基础配置

• 容器内存：357913941字节（约341MB）
• 模块端口：8081/tcp（默认服务端口）

数据库支持

• 支持FOLIO数据库连接，需配置数据库相关环境变量
• 提供数据库连接池及查询超时配置

Keycloak配置特性

• 缓存配置：支持设置缓存容量与过期时间
• 存储类型：默认使用临时存储（ephemeral）
• 云服务集成：支持AWS SSM（含IAM认证）配置
• 安全存储集成：支持Vault服务配置（含SSL、密钥库等）
• 故障处理：提供失败缓存超时配置

使用场景

适用于FOLIO平台部署环境，需与Keycloak身份认证服务集成，实现以下场景：

• FOLIO系统用户的身份验证与授权
• 多环境（开发、测试、生产）的Keycloak配置管理
• 结合AWS SSM或Vault进行敏感配置管理的场景

使用方法与配置说明

基本运行命令

bash
docker run -d \
  -p 8081:8081 \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_DATABASE=folio \
  -e DB_USERNAME=folio_user \
  -e DB_PASSWORD=secure_password \
  -e KC_CONFIG_STORE_TYPE=ephemeral \
  folioorg/mod-login-keycloak

docker-compose配置示例

yaml
version: '3'
services:
  mod-login-keycloak:
    image: folioorg/mod-login-keycloak
    ports:
      - "8081:8081"
    environment:
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_DATABASE=folio
      - DB_USERNAME=folio_user
      - DB_PASSWORD=secure_password
      - DB_MAXPOOLSIZE=10
      - DB_QUERYTIMEOUT=30000
      - KC_CONFIG_CACHE_CAPACITY=200
      - KC_CONFIG_CACHE_TTL_MS=7200000
      - KC_CONFIG_STORE_TYPE=ephemeral
    depends_on:
      - postgres

环境变量配置说明

JVM配置

• JAVA_OPTIONS：JVM运行参数，默认值：-XX:MaxRAMPercentage=66.0

数据库连接配置

• DB_DATABASE：数据库名称（必填）
• DB_HOST：数据库主机地址（必填）
• DB_PORT：数据库端口（必填）
• DB_USERNAME：数据库用户名（必填）
• DB_PASSWORD：数据库密码（必填）
• DB_CHARSET：数据库字符集
• DB_MAXPOOLSIZE：数据库连接池最大连接数，默认值：5
• DB_QUERYTIMEOUT：数据库查询超时时间（毫秒），默认值：60000

Keycloak配置（KC_CONFIG_*）

• KC_CONFIG_AWS_SSM_ECS_CREDENTIALS_ENDPOINT：AWS SSM ECS凭证端点
• KC_CONFIG_AWS_SSM_ECS_CREDENTIALS_PATH：AWS SSM ECS凭证路径
• KC_CONFIG_AWS_SSM_REGION：AWS SSM区域
• KC_CONFIG_AWS_SSM_USE_IAM：是否使用IAM认证AWS SSM，默认值：true
• KC_CONFIG_CACHE_CAPACITY：配置缓存容量，默认值：100
• KC_CONFIG_CACHE_TTL_MS：配置缓存过期时间（毫秒），默认值：3600000（1小时）
• KC_CONFIG_EPHEMERAL_CREDENTIALS：临时凭证配置
• KC_CONFIG_FAILURE_CACHE_TTL_MS：失败缓存过期时间（毫秒），默认值：30000（30秒）
• KC_CONFIG_STORE_TYPE：配置存储类型，默认值：ephemeral（临时存储）
• KC_CONFIG_VAULT_ADDRESS：Vault服务地址
• KC_CONFIG_VAULT_ENABLE_SSL：是否启用Vault SSL，默认值：false
• KC_CONFIG_VAULT_KEYSTORE_FILE_PATH：Vault密钥库文件路径
• KC_CONFIG_VAULT_KEYSTORE_PASSWORD：Vault密钥库密码
• KC_CONFIG_VAULT_PEM_FILE_PATH：Vault PEM文件路径
• KC_CONFIG_VAULT_TOKEN：Vault访问令牌
• KC_CONFIG_VAULT_TRUSTSTORE_FILE_PATH：Vault信任库文件路径