folioci/mod-courses

FOLIO - mod-courses

概述

mod-courses是FOLIO项目的后端CRUD存储模块，主要用于支持课程储备（Course Reserves）功能，提供数据的创建、读取、更新和删除（CRUD）操作。

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

核心功能与特性

• 提供后端CRUD存储能力，支持课程储备相关数据的全生命周期管理
• 模块内置服务端口：8081
• 依赖数据库存储数据，需配置数据库连接
• 支持通过JAVA_OPTIONS配置JVM内存使用参数

使用场景与适用范围

适用于FOLIO图书馆服务平台环境中，需管理课程储备相关数据的场景，如高校图书馆的课程教学参考资料、课程关联资源等数据的存储与维护。

使用方法与配置说明

模块基本信息

• 服务端口：8081（容器内部服务端口，部署时需映射至主机端口以提供外部访问）
• 数据库依赖：必需（模块需连接数据库以存储课程储备数据）
• 建议容器内存：357913941字节（约357MB，可根据实际部署环境调整）
• 默认JVM参数：-XX:MaxRAMPercentage=66.0（控制JVM内存使用占容器总内存的比例）

部署配置要求

数据库连接配置

模块运行前需通过环境变量配置数据库连接信息（具体环境变量名称可参考项目代码仓库文档），通常包括：

• 数据库主机地址
• 数据库端口
• 数据库名称
• 数据库用户名
• 数据库用户密码

JVM参数自定义

可通过环境变量JAVA_OPTIONS覆盖默认JVM参数，例如调整内存占比：

bash
-e JAVA_OPTIONS="-XX:MaxRAMPercentage=70.0"  # 将JVM最大内存占比调整为70%

Docker部署示例

基础运行命令

bash
docker run -d \
  -p 8081:8081 \  # 映射模块端口至主机
  -e DB_HOST=your-db-host \  # 数据库主机地址
  -e DB_PORT=5432 \  # 数据库端口（示例为PostgreSQL默认端口）
  -e DB_NAME=folio_mod_courses \  # 数据库名称
  -e DB_USER=db-username \  # 数据库用户名
  -e DB_PASSWORD=db-password \  # 数据库密码
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \  # JVM参数
  --name mod-courses \  # 容器名称
  folio/mod-courses  # 镜像名称

说明

• 替换上述命令中的数据库连接参数为实际环境值
• 根据主机资源情况调整端口映射（主机端口可自定义，如-p 9000:8081）
• 容器内存限制可通过--memory参数设置，例如--memory=512m限制容器最大使用512MB内存