folioorg/mod-oai-pmh

FOLIO - mod-oai-pmh 镜像文档

镜像概述和主要用途

mod-oai-pmh 是 FOLIO 项目的后端模块，主要功能是实现 OAI-PMH（Open Archives Initiative Protocol for Metadata Harvesting）元数据收割协议，用于元数据的收割、处理与管理。该模块是 FOLIO 生态中负责元数据交互的关键组件。

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

核心功能和特性

• 模块端口：8081（容器内部服务端口）
• 容器内存：603725575 字节（约 575MB）
• 数据库连接：需要数据库连接以存储和处理元数据
• Java 配置：默认 JAVA_OPTIONS 为 -XX:MaxRAMPercentage=66.0 -Dfile.encoding=UTF-8，用于JVM内存分配及文件编码设置
• S3 支持：提供 S3 相关环境变量配置，用于元数据的存储与访问

使用场景和适用范围

适用于需要通过 OAI-PMH 协议进行元数据收割的系统，特别是 FOLIO 图书馆服务平台生态中的后端服务，可用于图书馆、档案馆等机构的元数据管理与共享。

使用方法和配置说明

环境变量配置

以下环境变量需根据实际情况配置：

Docker 部署示例

docker run 命令

bash
docker run -d \
  -p 8081:8081 \
  -e DB_HOST=your-db-host \
  -e DB_PORT=your-db-port \
  -e DB_NAME=your-db-name \
  -e DB_USER=your-db-user \
  -e DB_PASSWORD=your-db-password \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0 -Dfile.encoding=UTF-8" \
  -e S3_URL="http://127.0.0.1:9000/" \
  -e S3_REGION="" \
  -e S3_BUCKET="test-bucket2" \
  -e S3_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" \
  -e S3_SECRET_ACCESS_KEY="your-s3-secret-key" \
  --name mod-oai-pmh \
  folio/mod-oai-pmh

说明

• -p 8081:8081：将容器内 8081 端口映射到主机，对外提供服务
• 数据库相关环境变量（DB_HOST 等）需根据实际数据库配置填写
• S3 相关环境变量根据实际 S3 服务配置调整，S3_SECRET_ACCESS_KEY 需填写实际密钥
• JAVA_OPTIONS 可根据服务器内存情况调整 MaxRAMPercentage 参数