folioci/mod-finance-storage

FOLIO - mod-finance-storage 镜像文档

镜像概述和主要用途

本镜像为FOLIO项目的mod-finance-storage模块提供容器化部署，是一个专注于财务数据管理的CRUD（创建、读取、更新、删除）模块。主要用于处理分类账、资金、预算等核心财务数据的存储与操作，是FOLIO生态系统中财务数据管理的基础组件。

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

核心功能和特性

核心功能

• 提供完整的CRUD操作接口，支持财务数据（分类账、资金、预算等）的全生命周期管理。

关键特性

• 固定端口：模块默认监听8081端口，便于服务发现与集成。
• 数据库依赖：需连接外部数据库以持久化存储财务数据。
• JVM配置：支持通过JAVA_OPTIONS自定义JVM参数，默认配置为-XX:MaxRAMPercentage=66.0，优化内存使用效率。
• 资源要求：建议容器分配不低于357913941字节（约341MB）的内存资源以确保稳定运行。

使用场景和适用范围

适用于需要集成FOLIO生态系统进行财务数据管理的场景，尤其适合图书馆、学术机构或其他需要系统化管理财务资源（如预算分配、资金流向跟踪、分类账维护等）的组织，可作为财务系统与FOLIO平台的数据交互中间层。

详细使用方法和配置说明

Docker运行示例

基础运行命令

bash
docker run -d \
  --name mod-finance-storage \
  -p 8081:8081 \
  -e DB_HOST=<数据库主机地址> \
  -e DB_PORT=<数据库端口> \
  -e DB_NAME=<数据库名称> \
  -e DB_USER=<数据库用户名> \
  -e DB_PASSWORD=<数据库密码> \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  --memory=357913941b \
  folio/mod-finance-storage:latest

Docker Compose配置示例

yaml
version: '3'
services:
  mod-finance-storage:
    image: folio/mod-finance-storage:latest
    container_name: mod-finance-storage
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio_finance
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
      - JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0"
    depends_on:
      - postgres
    deploy:
      resources:
        limits:
          memory: 357913941b

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

volumes:
  postgres-data:

配置参数说明

注意事项

• 本模块依赖外部数据库，部署前需确保数据库服务已就绪并配置正确的访问权限。
• 端口映射需根据实际需求调整，若主机8081端口被占用，可修改为其他端口（如-p 8082:8081）。
• JAVA_OPTIONS可根据宿主机资源情况调整，以优化性能（如增加-XX:MaxRAMPercentage值提升内存利用率）。