← Directory

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…

  • Productivity
  • Tools & Utilities
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
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

21/100 Low

Maintained
0last commit 2078 days ago
Popular
43136 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 10 days ago

GitHub stars
136
Open issues
9
Last commit
2021-02-04
License
MIT
Activity
stale

Checked 7 days ago - source: GitHub (cmccambridge/ocrmypdf-auto)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Set the folders before starting the watcher Before running watcher.py (the program that watches the input folder), set OCR_INPUT_DIRECTORY and OCR_OUTPUT_DIRECTORY to the real paths for incoming PDFs and finished files, and optionally set OCR_OUTPUT_STRUCTURE=YEAR_MONTH to sort results by month. Without the two required paths, the watcher has nowhere to pick up files or save results. source
  • Check Docker works if you use the image If your setup uses Docker (a tool that runs apps in self-contained containers), run docker run hello-world once to confirm it can download and start containers. If that command fails, the OCRmyPDF Docker image will also fail to launch. source
  • Install Tesseract for scanned text OCRmyPDF needs Tesseract, the engine that turns pictures of text into selectable text; on Windows you can install it with winget. If Tesseract is missing, OCR jobs can fail or produce no readable text. source

Fetched 16 days ago - each note links to its source

Alternatives

No alternatives collected yet.

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.

Answers sourced from forums.unraid.net, forums.unraid.net, github.com, github.com, github.com

Community

Collected 16 days ago - public community threads