From 13b4610c1d9c2dfa7554e591c4c77869d503a177 Mon Sep 17 00:00:00 2001 From: David Martin Date: Sun, 21 May 2017 14:52:12 +1000 Subject: [PATCH] Clarify consumption documentation to match the current Paperless behaviour. The configuration does not have to be hardcoded in settings.py anymore, and instead happens in the config file. Also, we added that the emails are checked at startup [0]. [0] see commit 3153bbd6a8d674362eccb4d48b8458b33298f6a9 --- docs/consumption.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/consumption.rst b/docs/consumption.rst index 8fa0a9a32..ee5ee4f64 100644 --- a/docs/consumption.rst +++ b/docs/consumption.rst @@ -121,14 +121,15 @@ So, with all that in mind, here's what you do to get it running: 1. Setup a new email account somewhere, or if you're feeling daring, create a folder in an existing email box and note the path to that folder. -2. In ``settings.py`` set all of the appropriate values in ``MAIL_CONSUMPTION``. +2. In ``/etc/paperless.conf`` set all of the appropriate values in + ``PATHS AND FOLDERS`` and ``SECURITY``. If you decided to use a subfolder of an existing account, then make sure you - set ``INBOX`` accordingly here. You also have to set the - ``UPLOAD_SHARED_SECRET`` to something you can remember 'cause you'll have to - include that in every email you send. + set ``PAPERLESS_CONSUME_MAIL_INBOX`` accordingly here. You also have to set + the ``PAPERLESS_SHARED_SECRET`` to something you can remember 'cause you'll + have to include that in every email you send. 3. Restart the :ref:`consumer `. The consumer will check - the configured email account every 10 minutes for something new and pull down - whatever it finds. + the configured email account at startup and from then on every 10 minutes + for something new and pulls down whatever it finds. 4. Send yourself an email! Note that the subject is treated as the file name, so if you set the subject to ``Correspondent - Title - tag,tag,tag``, you'll get what you expect. Also, you must include the aforementioned secret