folioci/mod-email

FOLIO mod-email 镜像文档

1. 镜像概述和主要用途

FOLIO mod-email是FOLIO开源图书馆服务平台的核心模块之一，主要功能是提供通知发送服务。该模块负责在FOLIO系统中生成并分发各类通知信息，支持与平台其他模块集成，确保用户及工作人员及时获取系统相关通知。

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

2. 核心功能和特性

核心功能

• 提供通知发送服务，支持FOLIO系统内各类通知的生成与分发。

主要特性

• 模块集成：与FOLIO平台其他模块无缝对接，接收并处理通知请求
• 端口配置：默认使用8081端口提供服务
• 数据库依赖：需数据库连接支持（数据库连接为true），用于存储或获取通知相关数据
• JVM优化：通过JAVA_OPTIONS配置JVM内存参数，默认设置-XX:MaxRAMPercentage=66.0以优化内存分配

3. 使用场景和适用范围

使用场景

适用于FOLIO图书馆服务平台中需发送系统通知的各类场景，包括但不限于：

• 用户借阅提醒、逾期通知、预约到馆通知
• 系统状态变更通知、错误告警
• 工作人员任务分配、流程提醒

适用范围

部署FOLIO开源图书馆服务平台的图书馆、学术机构及相关组织，用于满足系统内通知分发需求。

4. 使用方法和配置说明

4.1 基础配置参数

4.2 环境变量配置

运行该模块需配置以下关键环境变量（具体变量名需参考FOLIO官方文档）：

• 数据库连接参数：包括DB_HOST（数据库主机）、DB_PORT（数据库端口）、DB_NAME（数据库名）、DB_USER（数据库用户名）、DB_PASSWORD（数据库密码）等，用于建立数据库连接
• JAVA_OPTIONS：JVM运行参数，默认值为-XX:MaxRAMPercentage=66.0，可根据实际环境调整

4.3 Docker部署示例

4.3.1 Docker Run命令

bash
docker run -d \
  --name mod-email \
  -p 8081:8081 \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_NAME=folio_mod_email \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=secure_password \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  folio/mod-email:latest

4.3.2 Docker Compose配置

yaml
version: '3'
services:
  mod-email:
    image: folio/mod-email:latest
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=folio-db
      - DB_PORT=5432
      - DB_NAME=folio_mod_email
      - DB_USER=folio_user
      - DB_PASSWORD=secure_password
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    depends_on:
      - folio-db
  folio-db:
    image: postgres:13
    environment:
      - POSTGRES_DB=folio_mod_email
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=secure_password

4.4 部署验证

模块启动后，可通过访问http://<主机IP>:8081/health（若提供健康检查接口）验证服务状态，或查看容器日志确认无错误信息输出。

5. 注意事项

• 需确保数据库服务已提前部署并配置正确的访问权限
• 模块版本需与FOLIO平台其他模块版本保持兼容，建议参考官方版本兼容性文档
• 根据实际部署环境调整JVM参数（JAVA_OPTIONS）及容器资源限制，避免资源不足或浪费