# Ocrmypdf-auto

Ocrmypdf-auto is a container that watches an input directory for PDF files and automatically runs OCRmyPDF with Tesseract, producing searchable PDFs for self-hosted document workflows. It is open source and self-hosted, installable on Proxmox, Unraid and Docker Hub.

Canonical page: https://ourlocalhost.com/app/1157/ocrmypdf-auto

## Description

Ocrmypdf-auto is a container that watches an input directory for PDF files and automatically runs OCRmyPDF with Tesseract, producing searchable PDFs for self-hosted document workflows.

## Platform availability

Available on 2 of 9 platforms: Unraid, Proxmox.

## Health score

21/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 2086 days ago)
- Popular: 43 (136 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=ocrmypdf-auto
- Unraid: https://ca.unraid.net/apps/ocrmypdf-auto-0jebiul02uq2c1?q=ocrmypdf-auto
- GitHub: https://github.com/cmccambridge/ocrmypdf-auto
- Docker Hub: https://hub.docker.com/r/cmccambridge/ocrmypdf-auto

## Common questions

### How can I configure OCRmyPDF differently for files in different input folders?

ocrmypdf-auto supports a hierarchy of configuration files. For each input file, it first checks that file's directory for an ocr.config, and if found uses that file alone to configure OCRmyPDF.

### Can the container OCR PDFs that appear automatically from a scanner share?

The Unraid support thread describes using ocrmypdf-auto as a file-monitoring container to OCR new PDFs, such as files arriving from a scanner share.

### How can I rename or edit OCR output before moving it to a final storage destination such as paperless-ng?

Use an intermediate directory for the OCR output. A custom script can then rename or edit the OCR files before they are stored in the final destination.

### Why might OCR jobs fail or produce PDFs without readable text?

OCRmyPDF needs Tesseract to turn images of text into selectable text. If Tesseract is missing, OCR jobs can fail or produce no readable text.

### Can I integrate OCRmyPDF with closed source code?

OCRmyPDF is licensed under MPL-2.0, which permits integration with other code, including commercial and closed source. It requires publishing source-level modifications made to OCRmyPDF.

---
Source: Our Local Host (https://ourlocalhost.com/app/1157/ocrmypdf-auto), the self-hosted and open-source app directory.