folioci/mod-oai-pmh

FOLIO - mod-oai-pmh 镜像文档

镜像概述

mod-oai-pmh是FOLIO项目的后端模块，专门实现OAI-PMH（Open Archives Initiative Protocol for Metadata Harvesting）元数据收割协议，用于元数据的标准化获取、管理与共享。该模块需配合数据库运行，并支持通过环境变量配置S3存储服务。

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

核心功能与特性

• OAI-PMH协议实现：完整支持OAI-PMH元数据收割协议，满足元数据的发现与获取需求
• 后端服务能力：提供8081端口的后端服务，处理元数据收割请求
• 数据库依赖：需配置数据库连接，用于元数据相关数据的存储与管理
• S3存储集成：支持通过环境变量配置S3服务，实现元数据的持久化存储
• JVM参数可调：通过JAVA_OPTIONS环境变量自定义JVM运行参数，默认配置为-XX:MaxRAMPercentage=66.0 -Dfile.encoding=UTF-8

使用场景与适用范围

适用于图书馆、学术机构、数字档案馆等需要标准化元数据收割的场景，可集成到FOLIO生态系统或独立部署，为元数据管理系统提供OAI-PMH协议支持。

使用方法与配置说明

基础信息

• 模块端口：8081（容器内部服务端口）
• 容器内存需求：603725575字节（约576MB）
• 数据库依赖：必须配置数据库连接（具体数据库类型需参考FOLIO项目规范）

环境变量配置

部署示例

Docker Run命令

bash
docker run -d \
  --name mod-oai-pmh \
  -p 8081:8081 \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0 -Dfile.encoding=UTF-8" \
  -e S3_URL="http://your-s3-endpoint:9000/" \
  -e S3_BUCKET="your-metadata-bucket" \
  -e S3_ACCESS_KEY_ID="your-access-key" \
  -e S3_SECRET_ACCESS_KEY="your-secret-key" \
  folio/mod-oai-pmh:latest

注：实际部署时需替换your-s3-endpoint、your-metadata-bucket、your-access-key、your-secret-key为实际环境参数，并确保数据库连接已正确配置（具体数据库配置需参考FOLIO项目部署文档）。