m42e/mayan-mam-worker

Mayan自动元数据(MAM)工具

镜像概述和主要用途

MAM（Mayan Automatic Metadata）是一个针对Mayan EDMS的自动元数据处理工具，旨在通过自动化方式为文档添加标签和元数据，避免重复的手动操作。该工具由三个核心部分组成：Mayan触发点（接收工作流请求）、处理worker（执行文档分析和元数据添加）和自定义插件（用户需自行开发或获取）。

核心功能和特性

• 模块化架构：包含触发点、worker和插件三个独立组件，分工明确
• 自动化处理：接收文档ID后自动从Mayan获取文档数据，应用策略添加元数据和标签
• 灵活的插件支持：支持通过Git仓库拉取插件或本地挂载插件目录
• Docker化部署：提供完整Docker配置，可与Mayan EDMS集成在同一Docker网络
• 环境变量配置：通过环境变量灵活配置连接信息、认证参数和插件来源

使用场景和适用范围

适用于使用Mayan EDMS进行文档管理的用户，尤其是需要在文档OCR处理完成后自动添加元数据和标签的场景。可广泛应用于企业文档管理、个人文件分类等需要高效处理文档元数据的场景。

使用方法和配置说明

前提条件

• 运行中的Mayan EDMS实例，且与MAM服务网络互通（用于webhook通信）
• Mayan中具有足够权限的用户（需能访问文档、解析内容及OCR内容）
• Docker环境（推荐使用Docker Compose进行部署）

部署方式

推荐将MAM集成到现有Mayan的Docker Compose配置中，使用同一网络。以下是docker-compose配置示例：

yaml
version: '2'

services:
  mayan-mam-web:
    container_name: mayan-mam-web
    image: m42e/mayan-mam-web
    restart: always
    environment:
      REDIS_URL: redis://results:6379/
      
  mayan-mam-worker:
    container_name: mayan-mam-worker
    image: m42e/mayan-mam-worker
    restart: always
    environment:
      REDIS_URL: redis://results:6379/
      MAYAN_USER: mam-user
      MAYAN_PASSWORD: secretpassword
      MAYAN_URL: https://yourinstance/api/
      USE_GIT_PLUGINS: 0
      GIT_PLUGINS_URL: https://mygithubuser:<applicationtoken>@github.com/mygithubuser/mam-plugins

环境变量说明

通用环境变量

• REDIS_URL: Redis服务URL，用于任务队列（例如：redis://results:6379/）

Worker专用环境变量

• MAYAN_USER: Mayan用户账号，需具有文档访问和元数据添加权限
• MAYAN_PASSWORD: Mayan用户密码，用于认证
• MAYAN_URL: Mayan实例API地址，需包含/api/后缀（例如：https://yourinstance/api/）
• USE_GIT_PLUGINS: 插件获取方式开关，1表示从Git仓库拉取，0表示使用本地插件
• GIT_PLUGINS_URL: Git插件仓库URL，需包含认证信息（例如：https://githubuser:token@github.com/user/mam-plugins）

插件配置

除通过Git仓库获取插件外，还可通过Docker挂载方式使用本地插件：

yaml
volumes:
  - /path/to/local/plugins:/app/plugins

触发方式

通过向web服务发送HTTP请求触发处理，需在OCR内容可用后执行：

• 请求类型：POST或GET
• 端点格式：http://mayan-mam-web:8000/<documentid>
• 示例：http://mayan-mam-web:8000/345（处理ID为345的文档）

Worker工作流程

1. 接收由web服务转发的文档处理请求
2. 使用配置的Mayan用户账号认证并访问Mayan API
3. 获取文档的解析内容和OCR内容
4. 应用插件中定义的策略分析文档内容
5. 根据分析结果自动添加元数据和标签到Mayan文档