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

fixup: mention inotify in 'utilities.rst'

Browse Source
This commit is contained in:
Erik Arvstedt 2018-05-21 21:23:57 +02:00
parent 8218b1aa51
commit f96e7f7895
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/utilities.rst
View File

@ -52,7 +52,8 @@ The consumer script runs in an infinite loop, constantly looking at a directory
for documents to parse and index. The process is pretty straightforward: for documents to parse and index. The process is pretty straightforward:
1. Look in ``CONSUMPTION_DIR`` for a document. If one is found, go to #2. 1. Look in ``CONSUMPTION_DIR`` for a document. If one is found, go to #2.
If not, wait 10 seconds and try again. If not, wait 10 seconds and try again. On Linux, new documents are detected
instantly via inotify, so there's no waiting involved.
2. Parse the document with Tesseract 2. Parse the document with Tesseract
3. Create a new record in the database with the OCR'd text 3. Create a new record in the database with the OCR'd text
4. Attempt to automatically assign document attributes by doing some guesswork. 4. Attempt to automatically assign document attributes by doing some guesswork.
@ -74,8 +75,8 @@ The consumer is started via the ``manage.py`` script:
$ /path/to/paperless/src/manage.py document_consumer $ /path/to/paperless/src/manage.py document_consumer
This starts the service that will run in a loop, consuming documents as they This starts the service that will consume documents as they appear in
appear in ``CONSUMPTION_DIR``. ``CONSUMPTION_DIR``.
Note that this command runs continuously, so exiting it will mean your webserver Note that this command runs continuously, so exiting it will mean your webserver
disappears. If you want to run this full-time (which is kind of the point) disappears. If you want to run this full-time (which is kind of the point)