From 8cad12b15425247f29feacb817352043515e70e9 Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Tue, 1 Dec 2020 15:26:22 +0100 Subject: [PATCH] documentation. --- docs/configuration.rst | 22 +++++++++++++++++++++- src/paperless/settings.py | 5 ----- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 5f8acfc1c..492d4e76e 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -271,6 +271,7 @@ PAPERLESS_TASK_WORKERS= maintain the automatic matching algorithm, check emails, consume documents, etc. This variable specifies how many things it will do in parallel. + PAPERLESS_THREADS_PER_WORKER= Furthermore, paperless uses multiple threads when consuming documents to speed up OCR. This variable specifies how many pages paperless will process @@ -295,7 +296,6 @@ PAPERLESS_THREADS_PER_WORKER= PAPERLESS_THREADS_PER_WORKER automatically. - PAPERLESS_TIME_ZONE= Set the time zone here. See https://docs.djangoproject.com/en/3.1/ref/settings/#std:setting-TIME_ZONE @@ -312,12 +312,32 @@ PAPERLESS_CONSUMER_POLLING= Defaults to 0, which disables polling and uses filesystem notifications. + PAPERLESS_CONSUMER_DELETE_DUPLICATES= When the consumer detects a duplicate document, it will not touch the original document. This default behavior can be changed here. Defaults to false. + +PAPERLESS_CONSUMER_RECURSIVE= + Enable recursive watching of the consumption directory. Paperless will + then pickup files from files in subdirectories within your consumption + directory as well. + + Defaults to false. + + +PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS= + Set the names of subdirectories as tags for consumed files. + E.g. /foo/bar/file.pdf will add the tags "foo" and "bar" to + the consumed file. Paperless will create any tags that don't exist yet. + + PAPERLESS_CONSUMER_RECURSIVE must be enabled for this to work. + + Defaults to false. + + PAPERLESS_CONVERT_MEMORY_LIMIT= On smaller systems, or even in the case of Very Large Documents, the consumer may explode, complaining about how it's "unable to extend pixel cache". In diff --git a/src/paperless/settings.py b/src/paperless/settings.py index a785f3f1e..d5c6f5c1a 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -332,13 +332,8 @@ CONSUMER_POLLING = int(os.getenv("PAPERLESS_CONSUMER_POLLING", 0)) CONSUMER_DELETE_DUPLICATES = __get_boolean("PAPERLESS_CONSUMER_DELETE_DUPLICATES") -# Consume from subdirectories of CONSUMPTION_DIR as well CONSUMER_RECURSIVE = __get_boolean("PAPERLESS_CONSUMER_RECURSIVE") -# Set the names of subdirectories as tags for consumed files. -# E.g. $CONSUMPTION_DIR/foo/bar/file.pdf will add the tags "foo" and "bar" to -# the consumed file. -# PAPERLESS_CONSUMER_RECURSIVE must be enabled for this to work. CONSUMER_SUBDIRS_AS_TAGS = __get_boolean("PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS") OPTIMIZE_THUMBNAILS = __get_boolean("PAPERLESS_OPTIMIZE_THUMBNAILS", "true")