diff --git a/paperless.conf.example b/paperless.conf.example index 1c62256ab..f825daa6b 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -143,6 +143,29 @@ PAPERLESS_EMAIL_SECRET="" #### Software Tweaks #### ############################################################################### +# Paperless does multiple things in the background: Maintain the search index, +# maintain the automatic matching algorithm, check emails, consume documents, +# etc. This variable specifies how many things it will do in parallel. +#PAPERLESS_TASK_WORKERS=1 + +# Furthermore, paperless uses multiple threads when consuming documents to +# speed up OCR. This variable specifies how many pages paperless will process +# in parallel on a single document. +#PAPERLESS_THREADS_PER_WORKER=1 + +# Ensure that the product +# PAPERLESS_TASK_WORKERS * PAPERLESS_THREADS_PER_WORKER +# does not exceed your CPU core count or else paperless will be extremely slow. +# If you want paperless to process many documents in parallel, choose a high +# worker count. If you want paperless to process very large documents faster, +# use a higher thread per worker count. +# The default is a balance between the two, according to your CPU core count, +# with a slight favor towards threads per worker, and using as much cores as +# possible. +# If you only specify PAPERLESS_TASK_WORKERS, paperless will adjust +# PAPERLESS_THREADS_PER_WORKER automatically. + + # When the consumer detects a duplicate document, it will not touch the # original document. This default behavior can be changed here. #PAPERLESS_CONSUMER_DELETE_DUPLICATES="false" @@ -186,12 +209,6 @@ PAPERLESS_EMAIL_SECRET="" # -# By default, Paperless will attempt to use all available CPU cores to process -# a document, but if you would like to limit that, you can set this value to -# an integer: -#PAPERLESS_OCR_THREADS=1 - - # Customize the default language that tesseract will attempt to use when # parsing documents. The default language is used whenever # - No language could be detected on a document