概述

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper. Paperless-ngx forked from paperless-ng to continue the great work and distribute responsibility of supporting and advancing the project among a team of people.

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/

要求

Redis container installed

运行时参数

网络用户界面: http://[IP]:[PORT:8000]
网络: bridge
外壳: bash
特权: false

模板配置

PortPorttcp

Container Port: 8000

目标: 8000
默认值: 8000

DataPathrw

Container Path: /usr/src/paperless/data . This contains the paperless database. Should be in appdata.

目标: /usr/src/paperless/data
默认值: /mnt/user/appdata/paperless-ngx/data

MediaPathrw

Container Path: /usr/src/paperless/media . This is where your consumed documents and thumbnails are stored.

目标: /usr/src/paperless/media

ConsumptionPathrw

Container Path: /usr/src/paperless/consume . Files placed here will be consumed by paperless.

目标: /usr/src/paperless/consume

ExportPathrw

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

目标: /usr/src/paperless/export

PAPERLESS_REDISVariable

Container Variable: PAPERLESS_REDIS . This is required for processing scheduled tasks such as email fetching, index optimization and for training the automatic document matcher.

默认值: redis://[REPLACE-WITH-IP]:6379

PAPERLESS_OCR_LANGUAGEVariable

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.

默认值: eng

PAPERLESS_OCR_LANGUAGESVariable

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

PAPERLESS_FILENAME_FORMATVariable

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.

默认值: {{ created }}-{{ correspondent }}-{{ title }}

PAPERLESS_TIME_ZONEVariable

Container Variable: PAPERLESS_TIME_ZONE . Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.

默认值: America/Los_Angeles

PAPERLESS_IGNORE_DATESVariable

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

PAPERLESS_CONSUMER_POLLINGVariable

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

默认值: 0

PAPERLESS_SECRET_KEYVariable

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