diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index fc652689e..9e1c42f4a 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -2,9 +2,38 @@ Troubleshooting *************** -.. warning:: +No files are added by the consumer +################################## + +Check for the following issues: + +* Ensure that the directory you're putting your documents in is the folder + paperless is watching. With docker, this setting is performed in the + ``docker-compose.yml`` file. Without docker, look at the ``CONSUMPTION_DIR`` + setting. Don't adjust this setting if you're using docker. +* Ensure that redis is up and running. Paperless does its task processing + asynchronously, and for documents to arrive at the task processor, it needs + redis to run. +* Ensure that the task processor is running. Docker does this automatically. + Manually invoke the task processor by executing + + .. code:: shell-session + + $ python3 manage.py qcluster + +* Look at the output of paperless and inspect it for any errors. +* Go to the admin interface, and check if there are failed tasks. If so, the + tasks will contain an error message. + + +Consumer fails to pickup any new files +###################################### + +If you notice, that the consumer will only pickup files in the consumption +directory at startup, but won't find any other files added later, check out +the configuration file and enable filesystem polling with the setting +``PAPERLESS_CONSUMER_POLLING``. - This section is not updated to paperless-ng yet. Consumer warns ``OCR for XX failed`` ####################################