folioorg/mod-users-keycloak

FOLIO - mod-users-keycloak

镜像概述

mod-users-keycloak是FOLIO项目的核心模块之一，用于实现FOLIO用户系统与Keycloak身份认证服务的集成。该镜像提供用户管理与认证相关功能，是构建基于FOLIO平台的图书馆服务系统的重要组件。

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

核心功能与特性

• 容器资源配置：默认容器内存限制为536870912字节（512MB）
• 网络端口：模块默认监听8081/tcp端口
• JVM参数优化：默认配置JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0，控制JVM最大内存使用比例

使用场景与适用范围

适用于基于FOLIO平台构建的图书馆服务系统，需要与Keycloak身份认证服务集成以实现用户认证、授权管理的场景。可作为FOLIO生态系统中的用户认证中间件，连接FOLIO用户数据库与Keycloak认证服务。

使用方法与配置说明

基本运行命令

使用以下命令启动mod-users-keycloak容器：

bash
docker run -d -p 8081:8081 folio/mod-users-keycloak

环境变量配置

默认环境变量

自定义环境变量

可通过-e参数覆盖默认环境变量，例如调整JVM内存使用比例：

bash
docker run -d -p 8081:8081 -e "JAVA_OPTIONS=-XX:MaxRAMPercentage=75.0" folio/mod-users-keycloak

端口映射

容器内部服务监听8081/tcp端口，需通过-p参数将容器端口映射到主机端口，格式为主机端口:容器端口。例如，将容器8081端口映射到主机8082端口：

bash
docker run -d -p 8082:8081 folio/mod-users-keycloak

docker-compose配置示例

yaml
version: '3'
services:
  mod-users-keycloak:
    image: folio/mod-users-keycloak
    ports:
      - "8081:8081"
    environment:
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    mem_limit: 512m