[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/bpatrick47/ocrmypdf-auto/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","bpatrick47","reponame","ocrmypdf-auto","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-08-22T15:02:59.455778Z","description","Convert pdf to OCR PDF\nForked from : cmccambridge/ocrmypdf-auto \nfor updating versions ocrmypdf 11","is_private","last_updated","2020-08-31T16:29:18.594621Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",881,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","![ocrmypdf-auto logo](https://raw.githubusercontent.com/cmccambridge/ocrmypdf-auto/master/media/logo.png)\n\n# cmccambridge/ocrmypdf-auto\n[![Docker Repository on Quay](https://quay.io/repository/cmccambridge/ocrmypdf-auto/status \"Docker Repository on Quay\")](https://quay.io/repository/cmccambridge/ocrmypdf-auto) [![CircleCI](https://circleci.com/gh/cmccambridge/ocrmypdf-auto/tree/master.svg?style=shield)](https://circleci.com/gh/cmccambridge/ocrmypdf-auto/tree/master)\n\nThis container automates one stage in a \"paperless\" document processing pipeline: Take all the PDFs in a folder, run OCR on them, and save the output to another folder. It combines the excellent tools [OCRmyPDF][ocrmypdf] and [tesseract-ocr][tesseract] with `inotify`-based file monitoring and some new configurability.\n\nFor example, you could configure a wireless document scanner to save all images to one volume, and use this container to monitor all new incoming files, OCR them, and write the finished (searchable!) PDFs to another volume.\n\n![ocrmypdf-auto workflow. Scan to input volume, ocrmypdf-auto runs, collect results in output volume](https://raw.githubusercontent.com/cmccambridge/ocrmypdf-auto/master/media/flow.png)\n\n* [Usage](#usage)\n* [Volumes](#volumes)\n* [Environment Variables](#environment-variables-and-global-configuration)\n* [`OCRmyPDF` Configuration Files](#ocrmypdf-configuration-files)\n* [unRAID Integration](#unraid-integration)\n* [Future Work](#future-work)\n\n[ocrmypdf]: https://github.com/jbarlow83/OCRmyPDF\n[tesseract]: https://github.com/tesseract-ocr/tesseract\n\n## Usage\n\nQuick & Easy:\n```\ndocker create \\\n -v :/input \\\n -v :/output \\\n -v :/config \\\n quay.io/cmccambridge/ocrmypdf-auto\n```\n\nFull Custom:\n```\ndocker create \\\n -v :/input \\\n -v :/output \\\n -v :/config \\\n -v :/ocrtemp \\\n -v :/archive \\\n -e OCR_LANGUAGES=\"deu chi-sim ita\" \\\n -e OCR_OUTPUT_MODE=MIRROR_TREE \\\n -e OCR_PROCESS_EXISTING_ON_START=1 \\\n -e OCR_ACTION_ON_SUCCESS=ARCHIVE_INPUT_FILES \\\n -e OCR_NOTIFY_URL=http://server.local/path \\\n quay.io/cmccambridge/ocrmypdf-auto\n```\n\n## Volumes\n\n### Required Volumes\n\nA few volumes are required for normal operation of `ocrmypdf-auto`:\n\n|Volume|Description|\n|---|---|\n|`/input`|Directory to monitor for input files|\n|`/output`|Directory to write OCR'ed PDF output to|\n|`/config`|Directory to store the master `ocr.config` OCRmyPDF configuration file|\n\n## Optional Volumes\n\nA few additional volumes may be mounted for advanced configuration:\n\n|Volume|Description|\n|---|---|\n|`/ocrtemp`|Directory to use for all OCRmyPDF temporary files, e.g. to select a ramdisk or a local cache|\n|`/archive`|Directory to use for archiving input files after successful processing, in `ARCHIVE_INPUT_FILES` output mode|\n\n## Environment Variables and Global Configuration\n\n`ocrmypdf-auto` can be configured with a few top-level / global parameters that affect the overall operations of the container:\n\n|Environment Variable|Description|\n|---|---|\n|`OCR_LANGUAGES` | Additional languages (besides English) to install. Given as a space separated list. All possible packages can be found on the [Ubuntu site][ocr-languages]. Example: `deu chi-sim ita` |\n|`OCR_OUTPUT_MODE` | Controls the output directory layout:
`MIRROR_TREE` - (Default) Mirror the directory structure of the input directory, i.e. for an input file `/input/foo/bar.pdf` create an output file `/output/foo/bar.pdf`.
`SINGLE_FOLDER` - Collect all output files in a single flat folder, i.e. for an input file `/input/foo/bar.pdf` create an output file `/output/bar.pdf`.|\n|`OCR_PROCESS_EXISTING_ON_START` | Set to `1` to enable processing of any files in the input directory when the container is launched.
Set to `0` (Default) or unset to ignore existing files until they are modified.|\n|`OCR_ACTION_ON_SUCCESS` | Controls the action (if any) to perform after successful OCR processing:
`NOTHING` - (Default) Do nothing. Input files remain in place where they were found.
`ARCHIVE_INPUT_FILES` - Archive input files by **moving** them (overwriting existing files!) to the `/archive` Volume
`DELETE_INPUT_FILES` - Delete the input file after successful processing.|\n|`OCR_NOTIFY_URL` | On a successful completion, a POST will be made to the given URL, with a JSON payload of `{'pdf': '/output/doc.pdf', 'txt': '/output/doc.pdf.txt'}`. The txt property will only be present if you add the `--sidecar` option to the ocr.config file. This could be used to kick off additional processing, like indexing of the content or notifications. |\n|`OCR_VERBOSITY` | Control the verbosity of debug logging. Accepts python `logging` levels, e.g. `warn` (Default), `info`, `debug`, etc.|\n|`USERMAP_UID` | Set the UID that the OCR tools will run as.|\n|`USERMAP_GID` | Set the GID that the OCR tools will run as.|\n\n[ocr-languages]: https://packages.ubuntu.com/search?keywords=tesseract-ocr-&searchon=names&suite=bionic§ion=all\n\n## OCRmyPDF Configuration Files\n\n`ocrmypdf-auto` supports flexible configuration of the `ocrmypdf` binary itself, by allowing you to specify command line options in text files, one option per line.\n\nExample:\n```\n# ocrmypdf-auto Config File\n#\n# The contents of this file are exactly one command-line option per line,\n# including the \"value\" following the option, if any.\n#\n# Any blank lines or lines BEGINNING with a '#' are ignored\n\n# Common OCRmyPDF options (see ocrmypdf --help for full current list!)\n\n# Deskew the input file before OCR (and rebuild the output file with the skew correction)\n--deskew\n\n# Enable automatic page rotation based on tesseract orientation and script detection\n--rotate-pages\n\n# Configure automatic rotation threshold (in arbitrary units defined by tesseract)\n--rotate-pages-threshold 4\n```\n\nNotes:\n* The syntax is very simplistic, as described in the default `ocr.config` file that is created when the container is started with a new or empty `/config` Volume.\n* It is recommended for consistency of behavior that you specify the `--skip-text` option, which will cause `OCRmyPDF` NOT to consider it an error when an input page already contains text.\n\n### `ocr.config` File Selection\n\nTo support flexible configuration of OCRmyPDF from a single container, `ocrmypdf-auto` supports a \"hierarchy\" of configuration files. For a given input file, `ocrmypdf-auto` will first examine the file's own directory for an `ocr.config` to read. If found, that file (and that file _alone_) will be used to configure OCRmyPDF. If no `ocr.config` is present in the input directory, the parent directory will be searched next, and then the parent's parent, and so on up to the base `/input` Volume. If no `ocr.config` is found at any level of the directory hierarchy, then a final location is examined at `/config/ocr.config`.\n\nNote that only a _single_ `ocr.config` file is used for a given OCRmyPDF invocation, so all desired command-line options must be specified in the corresponding configuration file. (There is no mechanism to \"override\" configuration from parent directories.)\n\nFor example, in this `/input` Volume hierarchy:\n\n```\n/input\n├── foo\n│ ├── bar\n│ │ ├── bar.pdf\n│ │ └── ocr.config\n│ ├── baz\n│ │ └── baz.pdf\n│ ├── foo.pdf\n│ └── ocr.config\n├── qux.pdf\n└── quux\n └── quuux\n └── quuuux.pdf\n```\n\nThe following `ocr.config` file selections would be made:\n\n|PDF file|`ocr.config` file|Notes|\n|---|---|---|\n|`/input/foo/bar/bar.pdf`|`/input/foo/bar/ocr.config`|Same directory as `bar.pdf`|\n|`/input/foo/baz/baz.pdf`|`/input/foo/ocr.config`|No config file in `baz`, so parent's is selected|\n|`/input/foo/foo.pdf`|`/input/foo/ocr.config`|Same directory as `foo.pdf`|\n|`/input/qux.pdf`|`/config/ocr.config`|No config file exists in this directory, which is the `/input` Volume root|\n|`/input/quux/quuux/quuuux.pdf`|`/config/ocr.config`|No config file in the same directory nor any parent all the way to the `/input` Volume root|\n\n## unRAID Integration\n\nIf you're an [unRAID][unraid] user, you may want to install ocrmypdf-auto through [Community Applications][ca] instead of directly installing this Docker image. The unRAID template will set some default settings that integrate well with unRAID (see below), as well as the latest updates if the container template itself changes over time.\n\n### unRAID-specific Recommended Settings\n\nNotes:\n* _I'm using unRAID terminology_ `path` _and_ `variable` _here, for clarity, in place of Docker terminology_ `volume` _and_ `environment variable`.\n* _You can also review these settings in the [ocrmypdf-auto template][template] itself_\n\n|Type|Setting|Value|Notes|\n|----|-------|-----|-----|\n|Path|`/config`|`/mnt/user/appdata/ocrmypdf-auto`|Store configuration files (ocr.config) in standard unRAID appdata location|\n|Variable|`OCR_LANGUAGES`|``|Additional languages (besides English) to install. Given as a space separated list. Example: `deu chi-sim ita` |\n|Variable|`OCR_OUTPUT_MODE`|`MIRROR_TREE`|Organizes a tree of output files that mirrors the input files. This is a good, non-surprising default for running as a NAS service.|\n|Variable|`OCR_ACTION_ON_SUCCESS`|`NOTHING`|By default, don't touch the input files after processing. This is a **safe** default for running as a NAS service, but **Note:** you may wish to customize this behavior once you're comfortable with ocrmypdf-auto operations!|\n|Variable|`OCR_PROCESS_EXISTING_ON_START`|`0`|Corresponding with the `OCR_ACTION_ON_SUCCESS`, we explicitly disable processing existing files on startup to avoid reprocessing all files every time the container is updated or unRAID is rebooted.|\n|Variable|`OCR_NOTIFY_URL`|``|URL that gets a POST if set, with a JSON that has a pdf (and txt if --sidecar is used) property set with the relative path of the output.|\n|Variable|`USERMAP_UID`|`99`|This is the UID of unRAID's `nobody` user. You should use this value unless you really know what you're doing!|\n|Variable|`USERMAP_GID`|`100`|This is the GID of unRAID's `users` group. You should use this value unless you really know what you're doing!|\n\n[unraid]: https://lime-technology.com/\n[ca]: https://lime-technology.com/forums/topic/38582-plug-in-community-applications/\n[template]: https://github.com/cmccambridge/unraid-templates/blob/master/cmccambridge/ocrmypdf-auto.xml\n\n## Future Work\n\nSome specific future work items I have planned:\n* [#2][i2] Add automatic OCR language pack installation (via tesseract language packages) \n* [#3][i3] Build an Alpine-based image for size reduction (requires tesseract v4 to be supported in Alpine for best quality results)\n\nPlease also see the [GitHub Issues][issues], where you can report any problems or make any feature requests as well!\n\n[i2]: https://github.com/cmccambridge/ocrmypdf-auto/issues/2\n[i3]: https://github.com/cmccambridge/ocrmypdf-auto/issues/3\n[issues]: https://github.com/cmccambridge/ocrmypdf-auto/issues/\n\n## Credits\n\nAdditional credits for icons in the flow chart:\n* Icon made by [Freepik][cr-freepik] from [www.flaticon.com][cr-flaticon]\n* Icon made by [Smashicons][cr-smashicons] from [www.flaticon.com][cr-flaticon]\n\n[cr-freepik]: https://www.freepik.com\n[cr-smashicons]: https://smashicons.com\n[cr-flaticon]: https://www.flaticon.com\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",892634603,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",4968227,"full_size",266780676,"id",114363807,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:8fd78453158480b707d4de9d0528db6e8b872bf61e887007e6b8827e58b3e7de","features","","last_pulled","2026-09-23T23:28:10.564674181Z","last_pushed","2020-08-31T16:29:19Z","os","linux","os_features","os_version","size","variant","2020-08-31T16:29:18.179421Z","last_updater","last_updater_username","media_type","latest","repository",9683993,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

bpatrick47/ocrmypdf-auto

Tags for bpatrick47/ocrmypdf-auto