paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add an example for pdf2pdfocr with the pre-consume hook

Browse Source
This commit is contained in:
Daniel Quinn 2018-09-22 14:00:00 +01:00
parent cce6b43062
commit b4b4d8f25e
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/consumption.rst
View File

@ -76,6 +76,29 @@ Pre-consumption script
* Document file name
A simple but common example for this would be creating a simple script like
this:
.. code:: bash
:name: "/usr/local/bin/ocr-pdf"
#!/usr/bin/env bash
pdf2pdfocr.py -i ${1}
.. code:: bash
:name: /etc/paperless.conf
...
PAPERLESS_PRE_CONSUME_SCRIPT="/usr/local/bin/ocr-pdf"
...
This will pass the path to the document about to be consumed to ``/usr/local/bin/ocr-pdf``,
which will in turn call `pdf2pdfocr.py`_ on your document, which will then
overwrite the file with an OCR'd version of the file and exit. At which point,
the consumption process will begin with the newly modified file.
.. _pdf2pdfocr.py: https://github.com/LeoFCardoso/pdf2pdfocr
.. _consumption-director-hook-variables-post: