Paperless-ng

Paperless is an application by Daniel Quinn and others that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.

Official integration

Created 4 years ago - Last update 1 year ago

Paperless is an application by Daniel Quinn and others that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.

Deployed services

paperless-ng

jonaswinkler/paperless-ng:$$cap_app_version

paperless-ng-data:/usr/src/paperless/data
paperless-ng-media:/usr/src/paperless/media
paperless-ng-export:/usr/src/paperless/export
paperless-ng-consume:/usr/src/paperless/consume

8000

always

paperless-ng-redis

custom

paperless-ng-redis-data:/data

always

paperless-ng-db

postgres:$$cap_postgres_version

paperless-ng-db:/var/lib/postgresql/data

always

paperless-ng-gotenberg

thecodingmachine/gotenberg:6

3000

unless-stopped

paperless-ng-tika

apache/tika

9998

unless-stopped

Variables

Paperless-ng

Default: 1.4.1

$$cap_app_version
Check out their docker page for the valid tags https://hub.docker.com/r/jonaswinkler/paperless-ng/tags

Postgres Version

Default: 13

$$cap_postgres_version
Check out their Docker page for the valid tags https://hub.docker.com/r/library/postgres/tags/

Redis version

Default: 6.2.1-alpine

$$cap_redis_version

Database Name

Default: paperless

$$cap_dbname

Database User

Default: paperless

$$cap_dbuser

Database Password

Default: $$cap_gen_random_hex(64)

$$cap_dbpass

Filename Format

Default: null

$$cap_filename_format
Changes the filenames paperless uses to store documents in the media directory. See File name handling (https://paperless-ng.readthedocs.io/en/latest/advanced_usage.html#advanced-file-name-handling) for details. Default is none, which disables this feature.

Log Rotate Max Size (in bytes)

Default: undefined

$$cap_logrotate_max_size
Maximum file size for log files before they are rotated, in bytes.

Log Rotate Max Backup Count

Default: 20

$$cap_logrotate_max_backup
Number of rotated log files to keep.

Paperless Secret Key

Default: $$cap_gen_random_hex(64)

$$cap_secret_key
Paperless uses this to make session tokens.

Admin User

Default: admin

$$cap_admin_user

Admin Password

Default: $$cap_gen_random_hex(10)

$$cap_admin_password

Admin Email

Default: root@localhost

$$cap_admin_email

OCR Language

Default: eng

$$cap_ocr_language
Customize the language that paperless will attempt to use when parsing documents. It should be a 3-letter language code consistent with ISO 639 https://www.loc.gov/standards/iso639-2/php/code_list.php This can be a combination of multiple languages such as deu+eng, in which case tesseract will use whatever language matches best. Keep in mind that tesseract uses much more cpu time with multiple languages enabled.

OCR Mode

Default: skip

$$cap_ocr_mode
Tell paperless when and how to perform ocr on your documents. Four modes are available- skip, skip_noarchive, redo, force. Read more about this in the OCRmyPDF documentation (https://ocrmypdf.readthedocs.io/en/latest/advanced.html#when-ocr-is-skipped).

OCR Clean

Default: clean

$$cap_ocr_clean
Tells paperless to use unpaper to clean any input document before sending it to tesseract. This uses more resources, but generally results in better OCR results. Available mode- clean, clean-final, none

OCR Deskew

Default: true

$$cap_ocr_deskew
Tells paperless to correct skewing (slight rotation of input images mainly due to improper scanning).

OCR Rotate Pages

Default: true

$$cap_ocr_rotate_pages
Tells paperless to correct page rotation (90°, 180° and 270° rotation). If you notice that paperless is not rotating incorrectly rotated pages (or vice versa), try adjusting the threshold up or down (see below).

OCR Rotate Pages Threshold

Default: 12

$$cap_ocr_rotate_threshold
This is an arbitrary value reported by tesseract. “15” is a very conservative value, whereas “2” is a very aggressive option and will often result in correctly rotated pages being rotated as well.

OCR Output Type

Default: pdfa

$$cap_ocr_output_type
Specify the the type of PDF documents that paperless should produce. Choices- pdf, pdfa, pdfa-1, pdfa-2, pdfa-3

OCR Pages Count

Default: 0

$$cap_ocr_pages
Tells paperless to use only the specified amount of pages for OCR. Documents with less than the specified amount of pages get OCR’ed completely. Specifying 1 here will only use the first page. Specifying 0 disables this feature a and always use all pages.

OCR Image DPI

Default: undefined

$$cap_ocr_image_dpi
Set this to the DPI your scanner produces images at. Default is none, which will automatically calculate image DPI so that the produced PDF documents are A4 sized.

OCR User Args

Default: undefined

$cap_ocr_user_args
See https://ocrmypdf.readthedocs.io/en/latest/api.html#reference for valid parameters. Specify arguments as a JSON dictionary. Keep note of lower case booleans and double quoted parameter names and strings.

Timezone

Default: UTC

$$cap_timezone
Set the time zone here. See https://docs.djangoproject.com/en/3.1/ref/settings/#std:setting-TIME_ZONE for details on how to set it.

Consumer Polling (seconds)

Default: 0

$$cap_consumer_polling
Defaults to 0, which disables polling and uses filesystem notifications.

Consumer Delete Duplicates

Default: false

$$cap_consumer_delete_duplicates
When the consumer detects a duplicate document, it will not touch the original document.

Consumer Recursive

Default: false

$$cap_consumer_recursive
Enable recursive watching of the consumption directory. Paperless will then pickup files from files in subdirectories within your consumption directory as well.

Consumer Sub Directory as tags

Default: false

$$cap_consumer_subdirs_as_tags
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

Convert Memory Limit

Default: 0

$$cap_convert_memory_limit
For more information on how to use this value, you should search the web for “MAGICK_MEMORY_LIMIT”.

Convert Memory Limit

Default: undefined

$$cap_convert_tempdir
For more information on how to use this value, you should search the web for “MAGICK_TMPDIR”.

Optimize Thumbnails

Default: true

$$cap_optimize_thumbnails
This usually reduces the size of thumbnails by about 20%, but uses considerable compute time during consumption.

Pre Consume Script (path)

Default: undefined

$$cap_pre_consume_script
Executed after the consumer sees a new document in the consumption folder, but before any processing of the document is performed. For more information, take a look at Pre-consumption script (https://paperless-ng.readthedocs.io/en/latest/advanced_usage.html?highlight=PAPERLESS_PRE_CONSUME_SCRIPT#pre-consumption-script)

Post Consume Script (path)

Default: undefined

$$cap_post_consume_script
Executed after the consumer has successfully processed a document and has moved it into paperless. For more information, take a look at Post-consumption script (https://paperless-ng.readthedocs.io/en/latest/advanced_usage.html#advanced-post-consume-script)

Filename Date Order

Default: undefined

$$cap_filename_date_order
Defaults to none, which disables this feature. The date order can be set to any option as specified in https://dateparser.readthedocs.io/en/latest/settings.html#date-order.

Thumbnail Font Name

Default: /usr/share/fonts/liberation/LiberationSerif-Regular.ttf

$$cap_thumbnail_font_name
Paperless creates thumbnails for plain text files by rendering the content of the file on an image and uses a predefined font for that

Ignore Dates

Default: undefined

$$cap_paperless_ignore_dates
You may specify dates in a multitude of formats supported by dateparser (see https://dateparser.readthedocs.io/en/latest/#popular-formats)

Webserver Workers

Default: 2

$$cap_webserver_workers
The number of worker processes the webserver should spawn.

Usermap UID

Default: 1000

$$cap_usermap_uid
Set this to your actual user ID on the host system, which you can get by executing ```id -u```

Usermap GID

Default: 1000

$$cap_usermap_gid
Set this to your actual user ID on the host system, which you can get by executing ```id -g```

OCR Languages to install

Default: undefined

$$cap_docker_ocr_languages
Additional OCR languages to install. By default, paperless comes with English, German, Italian, Spanish and French.