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

more changes for #118

Browse Source
This commit is contained in:
jonaswinkler
2021-01-04 17:42:42 +01:00
parent 93ebd4d771
commit c676875504
2 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/configuration.rst
View File

@@ -348,11 +348,14 @@ PAPERLESS_TIME_ZONE=<timezone>
Defaults to UTC. Defaults to UTC.
.. _configuration-polling:
PAPERLESS_CONSUMER_POLLING=<num> PAPERLESS_CONSUMER_POLLING=<num>
If paperless won't find documents added to your consume folder, it might If paperless won't find documents added to your consume folder, it might
not be able to automatically detect filesystem changes. In that case, not be able to automatically detect filesystem changes. In that case,
specify a polling interval in seconds here, which will then cause paperless specify a polling interval in seconds here, which will then cause paperless
to periodically check your consumption directory for changes. to periodically check your consumption directory for changes. This will also
disable listening for file system changes with ``inotify``.
Defaults to 0, which disables polling and uses filesystem notifications. Defaults to 0, which disables polling and uses filesystem notifications.

8
docs/setup.rst
View File

@@ -180,6 +180,14 @@ Docker Route
You can use any settings from the file ``paperless.conf`` in this file. You can use any settings from the file ``paperless.conf`` in this file.
Have a look at :ref:`configuration` to see whats available. Have a look at :ref:`configuration` to see whats available.
.. caution::
Certain file systems such as NFS network shares don't support file system
notifications with ``inotify``. When storing the consumption directory
on such a file system, paperless will be unable to pick up new files
with the default configuration. You will need to use ``PAPERLESS_CONSUMER_POLLING``,
which will disable inotify. See :ref:`here <configuration-polling>`.
4. Run ``docker-compose up -d``. This will create and start the necessary 4. Run ``docker-compose up -d``. This will create and start the necessary
containers. This will also build the image of paperless if you grabbed the containers. This will also build the image of paperless if you grabbed the
source archive. source archive.