folioci/mod-users

mod-users - FOLIO模块

镜像概述和主要用途

mod-users是FOLIO项目的核心模块之一，专注于提供用户管理的领域模型（Domain Model to Manage Users），用于管理用户相关的数据和功能。该模块是FOLIO生态系统中用户管理的基础组件。

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

核心功能和特性

• 提供用户管理的领域模型，支持用户数据的存储、查询与管理
• 作为FOLIO模块，可与其他FOLIO组件集成，实现用户相关业务逻辑
• 依赖数据库连接以确保用户数据的持久化存储

使用场景和适用范围

适用于FOLIO生态系统中的用户管理场景，尤其适用于需要集中管理用户信息、权限及相关属性的图书馆管理系统、学术资源平台等基于FOLIO框架的应用环境。

详细使用方法和配置说明

基本部署要求

• 需配置数据库连接（模块依赖数据库存储用户数据）
• 支持Kafka消息队列集成（通过环境变量控制启用状态）
• 可选集成AWS服务（通过环境变量配置存储相关参数）

配置参数说明

模块基础信息

• 模块端口：8081（容器内服务端口）
• 容器内存限制：536870912字节（即512MB）
• 数据库连接：必须（需提前配置数据库服务）

JAVA_OPTIONS配置

• -XX:MaxRAMPercentage=66.0：设置JVM最大可用内存占容器内存的百分比为66.0%

环境变量配置

Docker部署示例

Docker Run命令示例

bash
docker run -d \
  -p 8081:8081 \
  -e KAFKA_ENABLE=true \
  -e KAFKA_HOST=10.0.2.15 \
  -e KAFKA_PORT=9092 \
  -e AWS_URL=http://127.0.0.1:9000/ \
  -e AWS_BUCKET=example-bucket \
  -e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
  -e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/EXAMPLEKEY \
  -e AWS_SDK=false \
  -e JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0 \
  --memory=512m \
  folio/mod-users

Docker Compose配置示例

yaml
version: '3'
services:
  mod-users:
    image: folio/mod-users
    ports:
      - "8081:8081"
    environment:
      - KAFKA_ENABLE=true
      - KAFKA_HOST=10.0.2.15
      - KAFKA_PORT=9092
      - AWS_URL=[***]
      - AWS_BUCKET=example-bucket
      - AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
      - AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/EXAMPLEKEY
      - AWS_SDK=false
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    deploy:
      resources:
        limits:
          memory: 512M
    depends_on:
      - db  # 需提前部署并配置数据库服务