folioci/mod-requests-mediated

FOLIO - mod-requests-mediated 镜像文档

镜像概述

mod-requests-mediated 是 FOLIO 图书馆服务平台的中介请求后端模块，主要用于处理中介请求的后端逻辑。该模块需与 FOLIO 生态中的其他服务（如 Okapi、Kafka）协同工作，提供可配置的批处理能力及系统用户管理功能。

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

核心功能与特性

• 中介请求处理：作为后端模块，负责中介请求的核心处理逻辑
• 批处理配置：支持通过环境变量配置批处理线程数、执行超时、缓存大小等参数
• 系统用户管理：可启用系统用户，配置用户名及密码
• Kafka集成：支持配置Kafka连接参数，包括安全协议、SSL证书位置及密码等
• 数据库依赖：需连接数据库以存储和处理请求数据

使用场景

适用于 FOLIO 图书馆服务平台中需要处理中介请求的后端服务场景，尤其适合需要自定义批处理策略、集成Kafka消息系统或配置系统用户的部署环境。

使用方法与配置说明

基本部署要求

• 需访问数据库服务
• 若启用Kafka集成，需配置Kafka服务地址及相关安全参数
• 需与FOLIO Okapi服务协同工作

Docker 运行示例

bash
docker run -d \
  -p 8081:8081 \
  -e OKAPI_URL=http://okapi:9130 \
  -e KAFKA_HOST=kafka \
  -e KAFKA_PORT=9092 \
  -e SYSTEM_USER_ENABLED=true \
  -e BATCH_REQUEST_THREADS_NUM=4 \
  --name mod-requests-mediated \
  folio/mod-requests-mediated

配置参数说明

基础信息

• 模块端口：8081（容器内服务端口）
• 容器内存：***字节（1GB，建议分配内存不低于此值）
• 数据库连接：true（模块依赖数据库，需提前配置数据库连接）
• JAVA_OPTIONS：-XX:MaxRAMPercentage=66.0（JVM内存配置，最大使用可用内存的66%）

环境变量配置