diff --git a/docs/configuration.rst b/docs/configuration.rst index 49c95bff1..454377283 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -348,11 +348,14 @@ PAPERLESS_TIME_ZONE= Defaults to UTC. +.. _configuration-polling: + PAPERLESS_CONSUMER_POLLING= If paperless won't find documents added to your consume folder, it might not be able to automatically detect filesystem changes. In that case, 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. diff --git a/docs/setup.rst b/docs/setup.rst index e51c4c878..ddd246b16 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -179,6 +179,14 @@ Docker Route You can use any settings from the file ``paperless.conf`` in this file. 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 `. 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