folioorg/mod-courses

FOLIO - mod-courses 镜像文档

1. 镜像概述和主要用途

mod-courses 是 FOLIO 生态系统中的后端 CRUD 存储模块，主要用于支持课程储备（Course Reserves）功能的核心数据存储与管理。该模块提供标准化的数据操作接口，为上层应用提供课程储备相关资源的持久化存储服务。

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

2. 核心功能与特性

• CRUD 数据操作：支持课程储备相关实体（如课程、储备资源、关联关系等）的创建（Create）、读取（Read）、更新（Update）、删除（Delete）操作。
• 后端存储服务：作为独立模块提供数据持久化能力，与 FOLIO 其他模块协同工作，支撑课程储备业务流程。
• 标准化接口：遵循 FOLIO 模块设计规范，提供 RESTful API 接口供前端或其他服务调用。

3. 使用场景与适用范围

• 适用系统：集成于 FOLIO 图书馆服务平台，作为课程储备功能的底层数据存储组件。
• 用户场景：图书馆或教育机构通过 FOLIO 系统管理课程所需的文献、资料等储备资源时，依赖本模块进行数据存储与访问。

4. 使用方法与配置说明

4.1 基础配置参数

4.2 环境变量配置

4.3 Docker 部署示例

4.3.1 使用 docker run 部署

bash
docker run -d \
  --name mod-courses \
  -p 8081:8081 \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  -e DB_HOST="postgres-host" \
  -e DB_PORT="5432" \
  -e DB_NAME="folio_mod_courses" \
  -e DB_USERNAME="folio_user" \
  -e DB_PASSWORD="your-secure-password" \
  --memory=357913941 \
  folioorg/mod-courses:latest

4.3.2 使用 docker-compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3.8'

services:
  mod-courses:
    image: folioorg/mod-courses:latest
    container_name: mod-courses
    ports:
      - "8081:8081"
    environment:
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio_mod_courses
      - DB_USERNAME=folio_user
      - DB_PASSWORD=secure_password
    mem_limit: 357913941
    depends_on:
      - postgres
    restart: unless-stopped

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

volumes:
  postgres-data:

4.4 部署注意事项

1. 数据库初始化：首次启动前需确保目标数据库已创建，且用户具备表结构创建权限（可通过 FOLIO 的 okapi 模块自动执行数据库迁移）。
2. 内存调整：容器内存限制（--memory）建议不低于默认值 341 MB，生产环境可根据并发量适当提高。
3. 端口冲突：若宿主机 8081 端口已被占用，需修改端口映射（如 -p 8082:8081）。
4. 高可用配置：生产环境建议通过 docker-compose 或 Kubernetes 编排，结合数据库主从复制实现高可用。

5. 代码仓库

完整源代码及详细文档可参考：
https://github.com/folio-org/mod-courses