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

Added docs for pre-consume hook

Browse Source
This commit is contained in:
Daniel Quinn 2016-07-01 14:47:17 -07:00
parent 8d992335f3
commit 48bca7ea57
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/consumption.rst
View File

@ -42,27 +42,44 @@ Hooking into the Consumption Process
Sometimes you may want to do something arbitrary whenever a document is Sometimes you may want to do something arbitrary whenever a document is
consumed. Rather than try to predict what you may want to do, Paperless lets consumed. Rather than try to predict what you may want to do, Paperless lets
you execute a script of your own choosing every time a document is consumed. you execute scripts of your own choosing just before or after a document is
consumed using a couple simple hooks.
Just write a script, put it somewhere that Paperless can read & execute, and Just write a script, put it somewhere that Paperless can read & execute, and
then put the path to that script in ``paperless.conf`` with the variable name then put the path to that script in ``paperless.conf`` with the variable name
``PAPERLESS_POST_CONSUME_SCRIPT``. of either ``PAPERLESS_PRE_CONSUME_SCRIPT`` or
``PAPERLESS_POST_CONSUME_SCRIPT``. The script will be executed before or
or after the document is consumed respectively.
.. important:: .. important::
This script is executed in a **blocking** process, which means that if the These scripts are executed in a **blocking** process, which means that if
script takes a long time to run, it can significantly slow down your a script takes a long time to run, it can significantly slow down your
document consumption flow. If you want things to run asynchronously, document consumption flow. If you want things to run asynchronously,
you'll have to fork the process in your script and exit. you'll have to fork the process in your script and exit.
.. _consumption-directory-hook-variables .. _consumption-directory-hook-variables
What Can This Script Do? What Can These Scripts Do?
........................ ..........................
It's your script, so you're only limited by your imagination and the laws of It's your script, so you're only limited by your imagination and the laws of
physics. However, the following values are passed to the script in order: physics. However, the following values are passed to the scripts in order:
.. _consumption-director-hook-variables-pre
Pre-consumption script
::::::::::::::::::::::
* Document file name
.. _consumption-director-hook-variables-post
Post-consumption script
:::::::::::::::::::::::
* Document id * Document id
* Generated file name * Generated file name