folioci/mod-configuration

FOLIO - mod-configuration 镜像文档

镜像概述与主要用途

mod-configuration是FOLIO平台的核心配置模块，基于raml-module-builder框架开发，通过RAML和JSON模式定义配置结构，依托PostgreSQL数据库异步实现配置数据的存储与管理，为FOLIO生态系统提供集中式配置服务。

核心功能与特性

• 技术架构：基于raml-module-builder构建，遵循RAML规范设计API接口
• 数据模型：采用RAML和JSON模式定义配置数据结构，确保配置规范性
• 存储实现：通过PostgreSQL数据库异步驱动实现配置数据的持久化管理
• 服务端口：默认监听8081端口，支持服务发现与集成
• 资源配置：预设容器内存限制为357913941字节（约341MB），优化资源占用
• JVM优化：默认JAVA_OPTIONS配置为-XX:MaxRAMPercentage=66.0，控制JVM内存使用比例

使用场景与适用范围

适用于FOLIO平台的配置集中管理场景，可作为图书馆管理系统、学术资源平台等基于FOLIO构建的业务系统的配置中枢，支持系统参数、模块配置等关键信息的统一存储与检索。

使用方法与配置说明

前置条件

• 已安装Docker环境
• 可访问的PostgreSQL数据库实例（需提前创建数据库及用户）

环境变量配置

运行容器时需配置以下关键环境变量：

Docker运行示例

bash
docker run -d \
  --name mod-configuration \
  -p 8081:8081 \
  -e DB_HOST=postgres-host \
  -e DB_PORT=5432 \
  -e DB_NAME=folio_config \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=secure_password \
  --memory=357913941b \
  folio/mod-configuration:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  mod-configuration:
    image: folio/mod-configuration:latest
    container_name: mod-configuration
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio_config
      - DB_USER=folio_user
      - DB_PASSWORD=secure_password
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    mem_limit: 357913941b
    depends_on:
      - postgres
    restart: unless-stopped

  postgres:
    image: postgres:13
    container_name: folio-postgres
    environment:
      - POSTGRES_DB=folio_config
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=secure_password
    volumes:
      - postgres-data:/var/lib/postgresql/data
    ports:
      - "5432:5432"

volumes:
  postgres-data:

配置参数说明

• 端口映射：通过-p 8081:8081将容器8081端口映射至宿主机，对外暴露配置服务接口
• 内存限制：可通过--memory（Docker run）或mem_limit（Docker Compose）调整容器内存，建议不低于预设的357913941字节
• 数据库连接：必须正确配置DB_HOST、DB_PORT、DB_NAME、DB_USER、DB_PASSWORD参数，确保与PostgreSQL实例正常通信
• JVM参数：可通过JAVA_OPTIONS自定义JVM参数，如调整内存分配、GC策略等，默认配置已针对容器环境优化内存使用比例