folioorg/mod-audit

FOLIO - mod-audit 镜像文档

1. 镜像概述和主要用途

mod-audit 是 FOLIO 生态系统中的核心模块之一，主要用于审计数据的管理。该模块负责系统操作审计日志的收集、存储、查询及维护，为 FOLIO 系统提供审计跟踪能力，支持管理员对系统活动进行合规性检查、故障排查及操作追溯。

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

2. 核心功能和特性

• 审计数据管理：支持系统操作审计日志的全生命周期管理，包括数据收集、持久化存储与查询。
• 数据库集成：需连接数据库以实现审计数据的持久化存储，确保审计信息的可靠性。
• 资源配置：预设模块端口与内存限制，保障服务稳定运行。
• JVM 参数优化：提供默认 JVM 内存配置，支持根据部署环境调整。

3. 使用场景和适用范围

适用于 FOLIO 生态系统中需跟踪用户操作、系统事件、数据变更等审计信息的场景，例如：

• 图书馆管理系统中用户借阅、编目等操作的审计跟踪；
• 系统管理员对关键配置变更的合规性审查；
• 故障排查时的操作日志回溯。

4. 使用方法和配置说明

4.1 Docker 运行命令示例

bash
docker run -d \
  --name mod-audit \
  -p 8081:8081 \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  -e DB_URL="jdbc:postgresql://db-host:5432/folio_audit" \
  -e DB_USER="folio_user" \
  -e DB_PASSWORD="folio_password" \
  --memory=715827883b \
  folioorg/mod-audit:latest

说明：

• -p 8081:8081：映射模块端口（容器内端口 8081）；
• --memory=715827883b：容器内存限制（约 683MB，按元数据配置）；
• 环境变量 DB_URL、DB_USER、DB_PASSWORD 为数据库连接必需参数（需根据实际环境替换）。

4.2 Docker Compose 配置示例

yaml
version: '3.8'
services:
  mod-audit:
    image: folioorg/mod-audit:latest
    container_name: mod-audit
    ports:
      - "8081:8081"
    environment:
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
      - DB_URL=jdbc:postgresql://db:5432/folio_audit
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
    mem_limit: 715827883b
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:14
    container_name: folio-db
    environment:
      - POSTGRES_DB=folio_audit
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=folio_password
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

4.3 配置参数说明

注：数据库连接参数（如 DB_URL 格式、驱动要求等）需参考 https://github.com/folio-org/mod-audit 的详细文档进行配置。