paperless-ngx
paperless-ngx
OfficialDocker app from Selfhosters
Overview
Requirements: Paperless-ngx requires Redis as external service. You can install it from the CA store. Make sure to adjust the configuration in the template accordingly. Setup: Create a user account after this container is created i.e. from Unraids Docker UI, click the paperless-ngx icon and choose Console. Then enter "python manage.py createsuperuser" in the prompt and follow the instructions. Paperless-ngx Documentation: https://paperless-ngx.readthedocs.io/en/latest/ Additional Template Variables: https://paperless-ngx.readthedocs.io/en/latest/configuration.html Demo: https://demo.paperless-ngx.com/
Requirements
Runtime arguments
- Web UI
http://[IP]:[PORT:8000]- Network
bridge- Shell
bash- Privileged
- false
Template configuration
Container Port: 8000
- Target
- 8000
- Default
- 8000
Container Path: /usr/src/paperless/data . This contains the paperless database. Should be in appdata.
- Target
- /usr/src/paperless/data
- Default
- /mnt/user/appdata/paperless-ngx/data
Container Path: /usr/src/paperless/media . This is where your consumed documents and thumbnails are stored.
- Target
- /usr/src/paperless/media
Container Path: /usr/src/paperless/consume . Files placed here will be consumed by paperless.
- Target
- /usr/src/paperless/consume
Container Path: /usr/src/paperless/export . Location for files used by the exporter utility. See https://paperless-ngx.readthedocs.io/en/latest/administration.html#document-exporter
- Target
- /usr/src/paperless/export
Container Variable: PAPERLESS_REDIS . This is required for processing scheduled tasks such as email fetching, index optimization and for training the automatic document matcher.
- Default
- redis://[REPLACE-WITH-IP]:6379
Container Variable: PAPERLESS_OCR_LANGUAGE . The default language to use for OCR. Set this to the language most of your documents are written in. Use 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.
- Default
- eng
Container Variable: PAPERLESS_OCR_LANGUAGES . Additional languages to install for text recognition. The container installs English, German, Italian, Spanish and French by default. Use a space separated list of 3-letter language codes consistent with ISO 639: https://www.loc.gov/standards/iso639-2/php/code_list.php
Container Variable: PAPERLESS_FILENAME_FORMAT . Changes the filenames paperless uses to store documents in the media directory. Setting none disables this feature. Uniqueness of filenames is ensured, as an incrementing counter is attached. See https://paperless-ngx.readthedocs.io/en/latest/advanced_usage.html#file-name-handling for placeholders.
- Default
- {{ created }}-{{ correspondent }}-{{ title }}
Container Variable: PAPERLESS_TIME_ZONE . Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
- Default
- America/Los_Angeles
Container Variable: PAPERLESS_IGNORE_DATES . Comma separated list of dates supported by dateparser that should be ignored when extracting the creation date. Example: 2020-12-02,22.04.1999
Container Variable: PAPERLESS_CONSUMER_POLLING . If set to a value n greater than 0, inotify is disabled and the directory is polled every n seconds. This option is useful when inotify doesn't fire events like when the consume folder is a NFS share
- Default
- 0
Container Variable: PAPERLESS_SECRET_KEY . Paperless uses this to make session tokens. If you expose paperless on the internet, you need to change this, since the default secret is well known
- Default
- e11fl1oa-*ytql8p)(06fbj4ukrlo+n7k&q5+$1md7i+mge=ee
Container Variable: USERMAP_UID
- Target
- USERMAP_UID
- Default
- 99
Container Variable: USERMAP_GID
- Target
- USERMAP_GID
- Default
- 100
Categories
Details
ghcr.io/paperless-ngx/paperless-ngxRun paperless-ngx on Unraid.
paperless-ngx is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.