unze/ocrmypdf-watchdog

ocrmypdf-watchdog

镜像概述和主要用途

ocrmypdf-watchdog 是一个基于 jbarlow83/ocrmypdf 镜像构建的监控工具，通过添加文件监控功能，实现对指定文件夹的自动化OCR处理。它能够监控目标文件夹中新增的、符合自定义扩展名的文件，并自动调用 OCRMyPDF（或其他指定命令）将文件转换为PDF格式，同时支持配置文件备份路径和输出路径。

核心功能和特性

• 文件夹监控：实时监控指定输入文件夹（/in）中的新文件
• 扩展名过滤：仅处理符合预定义扩展名的文件
• 自动化转换：自动调用 OCRMyPDF 或自定义命令执行文件转换
• 文件管理：支持配置备份路径（/bak）存储原始文件，输出路径（/out）存储转换后的PDF
• 灵活配置：通过环境变量和命令行参数自定义路径、频率、命令及参数

使用场景和适用范围

• 文档扫描自动化：扫描后的图片文件（如TIFF、PNG）自动转换为可搜索PDF
• 批量文件处理：对指定目录中的历史文件或定期新增文件进行批量OCR转换
• 自定义工作流：通过配置自定义命令和参数，适配非OCRMyPDF的文件转换需求

使用方法和配置说明

Docker部署

基本部署

通过 docker-compose 快速部署，默认会创建 /in（输入）、/bak（备份）、/out（输出）三个卷：

bash
docker-compose up -d

docker-compose.yml 示例

yaml
version: '3'
services:
  ocrmypdf-watchdog:
    image: ocrmypdf-watchdog
    volumes:
      - ./in:/in          # 输入文件夹（监控此目录的新文件）
      - ./bak:/bak        # 备份文件夹（存储原始文件）
      - ./out:/out        # 输出文件夹（存储转换后的PDF）
    environment:
      - OCRMYPDF_EXTENSIONS=pdf,tiff,png  # 监控的文件扩展名
      - WATCHDOG_FREQUENCY=10             # 监控频率（秒）
      - OCRMYPDF_PARAMETER=--force-ocr    # OCRMyPDF额外参数

环境变量配置

支持通过以下环境变量自定义行为：

命令行参数

除环境变量外，还可通过命令行参数覆盖默认配置：

参数使用示例

bash
docker run --rm -v ./in:/in -v ./out:/out ocrmypdf-watchdog \
  --in /in \
  --out /out \
  --frequency 15 \
  --ocrmypdf /usr/local/bin/ocrmypdf