folioorg/mod-custom-fields

FOLIO - mod-custom-fields

镜像概述和主要用途

mod-custom-fields是FOLIO项目的一个模块镜像，主要功能是存储和维护自定义字段。该镜像为FOLIO生态系统提供自定义字段的管理能力，支持对各类数据实体的扩展属性进行存储与维护。

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

核心功能和特性

• 自定义字段管理：提供自定义字段的存储、查询、更新和删除功能
• 模块端口：默认监听8081端口
• 资源配置：容器内存限制为536870912字节（512MB）
• 数据库依赖：需要数据库连接以持久化存储自定义字段数据
• JVM配置：默认JAVA_OPTIONS为-XX:MaxRAMPercentage=66.0，优化内存使用

使用场景和适用范围

适用于FOLIO生态系统中需要对数据实体（如用户、资源、订单等）添加自定义扩展字段的场景，满足特定机构或业务需求的个性化数据管理。

使用方法和配置说明

基本部署（docker run）

bash
docker run -d \
  -p 8081:8081 \
  -e DB_HOST=<数据库主机地址> \
  -e DB_PORT=<数据库端口> \
  -e DB_USER=<数据库用户名> \
  -e DB_PASSWORD=<数据库密码> \
  -e DB_NAME=<数据库名称> \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  --memory=512m \
  docker.xuanyuan.run/folio/mod-custom-fields

配置参数说明

环境变量

资源限制

• 容器内存限制：512MB（536870912字节），建议部署时保持此限制或根据实际需求调整

Docker Compose示例

yaml
version: '3'
services:
  mod-custom-fields:
    image: folio/mod-custom-fields
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=folio
      - DB_PASSWORD=folio_password
      - DB_NAME=folio_mod_custom_fields
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    mem_limit: 512m
    depends_on:
      - postgres

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_USER=folio
      - POSTGRES_PASSWORD=folio_password
      - POSTGRES_DB=folio_mod_custom_fields
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data: