Configuration

Paperless provides a wide range of customizations. Depending on how you run paperless, these settings have to be defined in different places.

If you run paperless on docker, paperless.conf is not used. Rather, configure paperless by copying necessary options to docker-compose.env .

If you are running paperless on anything else, paperless will search for the configuration file in these locations and use the first one it finds:

Required services

Redis Broker

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

More information on securing your Redis Instance .

Defaults to redis://localhost:6379 .

Database

Optional, gives the ability to choose Postgres or MariaDB for database engine. Available options are postgresql and mariadb .

Default is postgresql .

Warning

Using MariaDB comes with some caveats. See MySQL Caveats .

By default, sqlite is used as the database backend. This can be changed here.

Set PAPERLESS_DBHOST and another database will be used instead of sqlite.

Adjust port if necessary.

Default is 5432.

Database name in PostgreSQL or MariaDB.

Defaults to "paperless".

Database user in PostgreSQL or MariaDB.

Defaults to "paperless".

Database password for PostgreSQL or MariaDB.

Defaults to "paperless".

SSL mode to use when connecting to PostgreSQL or MariaDB.

See the official documentation about sslmode for PostgreSQL .

See the official documentation about sslmode for MySQL and MariaDB .

Note : SSL mode values differ between PostgreSQL and MariaDB.

Default is prefer for PostgreSQL and PREFERRED for MariaDB.

SSL root certificate path

See the official documentation about sslmode for PostgreSQL . Changes path of root.crt .

See the official documentation about sslmode for MySQL and MariaDB .

Defaults to unset, using the documented path in the home directory.

SSL client certificate path

See the official documentation about sslmode for PostgreSQL .

See the official documentation about sslmode for MySQL and MariaDB .

Changes path of postgresql.crt .

Defaults to unset, using the documented path in the home directory.

SSL client key path

See the official documentation about sslmode for PostgreSQL .

See the official documentation about sslmode for MySQL and MariaDB .

Changes path of postgresql.key .

Defaults to unset, using the documented path in the home directory.

Amount of time for a database connection to wait for the database to unlock. Mostly applicable for sqlite based installation. Consider changing to postgresql if you are having concurrency problems with sqlite.

Defaults to unset, keeping the Django defaults.

Optional Services

Paperless can make use of Tika and Gotenberg for parsing and converting "Office" documents (such as ".doc", ".xlsx" and ".odt"). Tika and Gotenberg are also needed to allow parsing of E-Mails (.eml).

If you wish to use this, you must provide a Tika server and a Gotenberg server, configure their endpoints, and enable the feature.

Enable (or disable) the Tika parser.

Defaults to false.

Set the endpoint URL were Paperless can reach your Tika server.

Defaults to " http://localhost:9998 ".

Set the endpoint URL were Paperless can reach your Gotenberg server.

Defaults to " http://localhost:3000 ".

If you run paperless on docker, you can add those services to the docker-compose file (see the provided docker-compose.sqlite-tika.yml file for reference).

Add all three configuration parameters to your configuration. If using Docker, this may be the environment key of the webserver or a docker-compose.env file. Bare metal installations may have a .conf file containing the configuration parameters. Be sure to use the correct format and watch out for indentation if editing the YAML file.

Paths and folders

This where your documents should go to be consumed. Make sure that it exists and that the user running the paperless service can read/write its contents before you start Paperless.

Don't change this when using docker, as it only changes the path within the container. Change the local consumption directory in the docker-compose.yml file instead.

Defaults to "../consume/", relative to the "src" directory.

This is where paperless stores all its data (search index, SQLite database, classification model, etc).

Defaults to "../data/", relative to the "src" directory.

Instead of removing deleted documents, they are moved to this directory.

This must be writeable by the user running paperless. When running inside docker, ensure that this path is within a permanent volume (such as "../media/trash") so it won't get lost on upgrades.

Defaults to empty (i.e. really delete documents).

This is where your documents and thumbnails are stored.

You can set this and PAPERLESS_DATA_DIR to the same folder to have paperless store all its data within the same volume.

Defaults to "../media/", relative to the "src" directory.

Override the default STATIC_ROOT here. This is where all static files created using "collectstatic" manager command are stored.

Unless you're doing something fancy, there is no need to override this. If this is changed, you may need to run collectstatic again.

Defaults to "../static/", relative to the "src" directory.

Changes the filenames paperless uses to store documents in the media directory. See File name handling for details.

Default is none, which disables this feature.

Tells paperless to replace placeholders in PAPERLESS_FILENAME_FORMAT that would resolve to 'none' to be omitted from the resulting filename. This also holds true for directory names. See File name handling for details.

Defaults to false which disables this feature.

This is where paperless will store log files.

Defaults to PAPERLESS_DATA_DIR/log/ .

This is where paperless will search for the data required for NLTK processing, if you are using it. If you are using the Docker image, this should not be changed, as the data is included in the image already.

Previously, the location defaulted to PAPERLESS_DATA_DIR/nltk . Unless you are using this in a bare metal install or other setup, this folder is no longer needed and can be removed manually.

Defaults to /usr/share/nltk_data

Logging

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

Defaults to 1 MiB.

Number of rotated log files to keep.

Defaults to 20.

Hosting & Security

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.

Use any sequence of characters. The more, the better. You don't need to remember this. Just face-roll your keyboard.

Default is listed in the file src/paperless/settings.py .

This setting can be used to set the three options below (ALLOWED_HOSTS, CORS_ALLOWED_HOSTS and CSRF_TRUSTED_ORIGINS). If the other options are set the values will be combined with this one. Do not include a trailing slash. E.g. https://paperless.domain.com

Defaults to empty string, leaving the other settings unaffected.

This value cannot contain a path (e.g. domain.com/path), even if you are installing paperless-ngx at a subpath.

A list of trusted origins for unsafe requests (e.g. POST). As of Django 4.0 this is required to access the Django admin via the web. See the Django project documentation on the settings

Can also be set using PAPERLESS_URL (see above).

Defaults to empty string, which does not add any origins to the trusted list.

If you're planning on putting Paperless on the open internet, then you really should set this value to the domain name you're using. Failing to do so leaves you open to HTTP host header attacks. You can read more about this in the Django project's documentation

Just remember that this is a comma-separated list, so "example.com" is fine, as is "example.com,www.example.com", but NOT " example.com" or "example.com,"

Can also be set using PAPERLESS_URL (see above).

"localhost" is always allowed for docker healthcheck

Defaults to "*", which is all hosts.

You need to add your servers to the list of allowed hosts that can do CORS calls. Set this to your public domain name.

Can also be set using PAPERLESS_URL (see above).

Defaults to " http://localhost:8000 ".

This may be needed to prevent IP address spoofing if you are using e.g. fail2ban with log entries for failed authorization attempts. Value should be IP address(es).

Defaults to empty string.

To host paperless under a subpath url like example.com/paperless you set this value to /paperless. No trailing slash!

Defaults to none, which hosts paperless at "/".

Override the STATIC_URL here. Unless you're hosting Paperless off a subdomain like /paperless/, you probably don't need to change this. If you do change it, be sure to include the trailing slash.

Defaults to "/static/".

When hosting paperless behind a reverse proxy like Traefik or Nginx at a subpath e.g. example.com/paperlessngx you will also need to set PAPERLESS_FORCE_SCRIPT_NAME (see above).

Specify a username here so that paperless will automatically perform login with the selected user.

Danger

Do not use this when exposing paperless on the internet. There are no checks in place that would prevent you from doing this.

Defaults to none, which disables this feature.

If this environment variable is specified, Paperless automatically creates a superuser with the provided username at start. This is useful in cases where you can not run the createsuperuser command separately, such as Kubernetes or AWS ECS.

Requires PAPERLESS_ADMIN_PASSWORD be set.

This will not change an existing [super]user's password, nor will it recreate a user that already exists. You can leave this throughout the lifecycle of the containers.

(Optional) Specify superuser email address. Only used when PAPERLESS_ADMIN_USER is set.

Defaults to [email protected] .

Only used when PAPERLESS_ADMIN_USER is set. This will be the password of the automatically created superuser.

Specify a prefix that is added to the cookies used by paperless to identify the currently logged in user. This is useful for when you're running two instances of paperless on the same host.

After changing this, you will have to login again.

Defaults to "" , which does not alter the cookie names.

Allows authentication via HTTP_REMOTE_USER which is used by some SSO applications.

Warning

This will allow authentication by simply adding a Remote-User: <username> header to a request. Use with care! You especially *must: ensure that any such header is not passed from your proxy server to paperless.

If you're exposing paperless to the internet directly, do not use this.

Also see the warning in the official documentation .

Defaults to "false" which disables this feature.

If "PAPERLESS_ENABLE_HTTP_REMOTE_USER" is enabled, this property allows to customize the name of the HTTP header from which the authenticated username is extracted. Values are in terms of HttpRequest.META . Thus, the configured value must start with HTTP* followed by the normalized actual header name.

Defaults to "HTTP_REMOTE_USER".

URL to redirect the user to after a logout. This can be used together with PAPERLESS_ENABLE_HTTP_REMOTE_USER to redirect the user back to the SSO application's logout page.

Defaults to None, which disables this feature.

Configures the Django setting USE_X_FORWARDED_HOST which may be needed for hosting behind a proxy.

Defaults to False

Configures the Django setting USE_X_FORWARDED_PORT which may be needed for hosting behind a proxy.

Defaults to False

Configures the Django setting SECURE_PROXY_SSL_HEADER which may be needed for hosting behind a proxy. The two values in the list will form the tuple of HTTP header/value expected by Django, eg '["HTTP_X_FORWARDED_PROTO", "https"]' .

Defaults to None

Warning

Settings this value has security implications. Read the Django documentation and be sure you understand its usage before setting it.

OCR settings

Paperless uses OCRmyPDF for performing OCR on documents and images. Paperless uses sensible defaults for most settings, but all of them can be configured to your needs.

Customize the language that paperless will attempt to use when parsing documents.

It should be a 3-letter code, see the list of languages Tesseract supports .

Set this to the language most of your documents are written in.

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.

Defaults to "eng".

If your language contains a '-' such as chi-sim, you must use chi_sim .

Tell paperless when and how to perform ocr on your documents. Four modes are available:

skip : Paperless skips all pages and will perform ocr only on pages where no text is present. This is the safest option.

redo : Paperless will OCR all pages of your documents and attempt to replace any existing text layers with new text. This will be useful for documents from scanners that already performed OCR with insufficient results. It will also perform OCR on purely digital documents.

This option may fail on some documents that have features that cannot be removed, such as forms. In this case, the text from the document is used instead.

force : Paperless rasterizes your documents, converting any text into images and puts the OCRed text on top. This works for all documents, however, the resulting document may be significantly larger and text won't appear as sharp when zoomed

The default is skip , which only performs OCR when necessary and always creates archived documents.

Read more about this in the OCRmyPDF documentation .

Specify when you would like paperless to skip creating an archived version of your documents. This is useful if you don't want to have two almost-identical versions of your documents in the media folder.

The default is never .

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. The following modes are available:

Defaults to clean .

clean-final is incompatible with ocr mode redo . When both clean-final and the ocr mode redo is configured, clean is used instead.

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

Defaults to true , which enables this feature.

Deskewing is incompatible with ocr mode redo . Deskewing will get disabled automatically if redo is used as the ocr mode.

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).

Defaults to true , which enables this feature.

Adjust the threshold for automatic page rotation by PAPERLESS_OCR_ROTATE_PAGES . 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.

Defaults to "12".

Specify the the type of PDF documents that paperless should produce.

If not specified, pdfa is used. Remember that paperless also keeps the original input file as well as the archived version.

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.

When combined with PAPERLESS_OCR_MODE=redo or PAPERLESS_OCR_MODE=force , paperless will not modify any text it finds on excluded pages and copy it verbatim.

Defaults to 0, which disables this feature and always uses all pages.

Paperless will OCR any images you put into the system and convert them into PDF documents. This is useful if your scanner produces images. In order to do so, paperless needs to know the DPI of the image. Most images from scanners will have this information embedded and paperless will detect and use that information. In case this fails, it uses this value as a fallback.

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.

Paperless will raise a warning when OCRing images which are over this limit and will not OCR images which are more than twice this limit. Note this does not prevent the document from being consumed, but could result in missing text content.

If unset, will default to the value determined by Pillow .

Increasing this limit could cause Paperless to consume additional resources when consuming a file. Be sure you have sufficient system resources.

Warning

The limit is intended to prevent malicious files from consuming system resources and causing crashes and other errors. Only increase this value if you are certain your documents are not malicious and you need the text which was not OCRed

OCRmyPDF offers many more options. Use this parameter to specify any additional arguments you wish to pass to OCRmyPDF. Since Paperless uses the API of OCRmyPDF, you have to specify these in a format that can be passed to the API. See the API reference of OCRmyPDF for valid parameters. All command line options are supported, but they use underscores instead of dashes.

Warning

Paperless has been tested to work with the OCR options provided above. There are many options that are incompatible with each other, so specifying invalid options may prevent paperless from consuming any documents.

Specify arguments as a JSON dictionary. Keep note of lower case booleans and double quoted parameter names and strings. Examples:

{"deskew": true, "optimize": 3, "unpaper_args": "--pre-rotate 90"}
Software tweaks
PAPERLESS_TASK_WORKERS=<num>
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.
Defaults to 1
PAPERLESS_THREADS_PER_WORKER=<num>
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.
Warning
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:
CPU core count
Workers
Threads
If you only specify PAPERLESS_TASK_WORKERS, paperless will adjust
PAPERLESS_THREADS_PER_WORKER automatically.
PAPERLESS_WORKER_TIMEOUT=<num>
Machines with few cores or weak ones might not be able to finish OCR
on large documents within the default 1800 seconds. So extending
this timeout may prove to be useful on weak hardware setups.
PAPERLESS_TIME_ZONE=<timezone>
Set the time zone here. See more details on
why and how to set it in the Django project documentation
for details on how to set it.
Defaults to UTC.
PAPERLESS_ENABLE_NLTK=<bool>
Enables or disables the advanced natural language processing
used during automatic classification. If disabled, paperless will
still perform some basic text pre-processing before matching.
See also PAPERLESS_NLTK_DIR.
Defaults to 1.
PAPERLESS_EMAIL_TASK_CRON=<cron expression>
Configures the scheduled email fetching frequency. The value
should be a valid crontab(5) expression describing when to run.
If set to the string "disable", no emails will be fetched automatically.
Defaults to */10 * * * * or every ten minutes.
PAPERLESS_TRAIN_TASK_CRON=<cron expression>
Configures the scheduled automatic classifier training frequency. The value
should be a valid crontab(5) expression describing when to run.
If set to the string "disable", the classifier will not be trained automatically.
Defaults to 5 */1 * * * or every hour at 5 minutes past the hour.
PAPERLESS_INDEX_TASK_CRON=<cron expression>
Configures the scheduled search index update frequency. The value
should be a valid crontab(5) expression describing when to run.
If set to the string "disable", the search index will not be automatically updated.
Defaults to 0 0 * * * or daily at midnight.
PAPERLESS_SANITY_TASK_CRON=<cron expression>
Configures the scheduled sanity checker frequency.
If set to the string "disable", the sanity checker will not run automatically.
Defaults to 30 0 * * sun or Sunday at 30 minutes past midnight.
PAPERLESS_ENABLE_COMPRESSION=<bool>
Enables compression of the responses from the webserver.
Defaults to 1, enabling compression.
If you are using a proxy such as nginx, it is likely more efficient
to enable compression in your proxy configuration rather than
the webserver
PAPERLESS_CONVERT_MEMORY_LIMIT=<num>
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 such cases, try setting this to a reasonably low
value, like 32. The default is to use whatever is necessary to do
everything without writing to disk, and units are in megabytes.
For more information on how to use this value, you should search the
web for "MAGICK_MEMORY_LIMIT".
Defaults to 0, which disables the limit.
PAPERLESS_CONVERT_TMPDIR=<path>
Similar to the memory limit, if you've got a small system and your
OS mounts /tmp as tmpfs, you should set this to a path that's on a
physical disk, like /home/your_user/tmp or something. ImageMagick
will use this as scratch space when crunching through very large
documents.
For more information on how to use this value, you should search the
web for "MAGICK_TMPDIR".
Default is none, which disables the temporary directory.
Document Consumption
PAPERLESS_CONSUMER_DELETE_DUPLICATES=<bool>
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=<bool>
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=<bool>
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 will create any tags that
don't exist yet.
This is useful for sorting documents with certain tags such as car
or todo prior to consumption. These folders won't be deleted.
PAPERLESS_CONSUMER_RECURSIVE must be enabled for this to work.
Defaults to false.
PAPERLESS_CONSUMER_IGNORE_PATTERNS=<json>
By default, paperless ignores certain files and folders in the
consumption directory, such as system files created by the Mac OS
or hidden folders some tools use to store data.
This can be adjusted by configuring a custom json array with
patterns to exclude.
For example, .DS_STORE/* will ignore any files found in a folder
named .DS_STORE, including .DS_STORE/bar.pdf and foo/.DS_STORE/bar.pdf
A pattern like ._* will ignore anything starting with ._, including:
._foo.pdf and ._bar/foo.pdf
Defaults to
[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini", "@eaDir/*"].
PAPERLESS_CONSUMER_BARCODE_SCANNER=<string>
Sets the barcode scanner used for barcode functionality.
Currently, "PYZBAR" (the default) or "ZXING" might be selected.
If you have problems that your Barcodes/QR-Codes are not detected
(especially with bad scan quality and/or small codes), try the other one.
zxing is not available on all platforms.
PAPERLESS_PRE_CONSUME_SCRIPT=<filename>
After some initial validation, Paperless can trigger an arbitrary
script if you like before beginning consumption. This script will be provided
data for it to work with via the environment.
For more information, take a look at pre-consumption script.
The default is blank, which means nothing will be executed.
PAPERLESS_POST_CONSUME_SCRIPT=<filename>
After a document is consumed, Paperless can trigger an arbitrary
script if you like. This script will be provided
data for it to work with via the environment.
For more information, take a look at Post-consumption script.
The default is blank, which means nothing will be executed.
PAPERLESS_FILENAME_DATE_ORDER=<format>
Paperless will check the document text for document date
information. Use this setting to enable checking the document
filename for date information. The date order can be set to any
option as specified in
https://dateparser.readthedocs.io/en/latest/settings.html#date-order.
The filename will be checked first, and if nothing is found, the
document text will be checked as normal.
A date in a filename must have some separators (., ,, -, /, etc) for it to be parsed.
Defaults to none, which disables this feature.
PAPERLESS_NUMBER_OF_SUGGESTED_DATES=<num>
Paperless searches an entire document for dates. The first date
found will be used as the initial value for the created date. When
this variable is greater than 0 (or left to it's default value),
paperless will also suggest other dates found in the document, up to
a maximum of this setting. Note that duplicates will be removed,
which can result in fewer dates displayed in the frontend than this
setting value.
The task to find all dates can be time-consuming and increases with
a higher (maximum) number of suggested dates and slower hardware.
Defaults to 3. Set to 0 to disable this feature.
PAPERLESS_THUMBNAIL_FONT_NAME=<filename>
Paperless creates thumbnails for plain text files by rendering the
content of the file on an image and uses a predefined font for that.
This font can be changed here.
Note that this won't have any effect on already generated
thumbnails.
Defaults to
/usr/share/fonts/liberation/LiberationSerif-Regular.ttf.
PAPERLESS_IGNORE_DATES=<string>
Paperless parses a documents creation date from filename and file
content. You may specify a comma separated list of dates that should
be ignored during this process. This is useful for special dates
(like date of birth) that appear in documents regularly but are very
unlikely to be the documents creation date.
The date is parsed using the order specified in PAPERLESS_DATE_ORDER
Defaults to an empty string to not ignore any dates.
PAPERLESS_DATE_ORDER=<format>
Paperless will try to determine the document creation date from its
contents. Specify the date format Paperless should expect to see
within your documents.
This option defaults to DMY which translates to day first, month
second, and year last order. Characters D, M, or Y can be shuffled
to meet the required order.
Polling
PAPERLESS_CONSUMER_POLLING=<num>
If paperless won't find documents added to your consume folder, it
might not be able to automatically detect filesystem changes. In
that case, specify a polling interval in seconds here, which will
then cause paperless to periodically check your consumption
directory for changes. This will also disable listening for file
system changes with inotify.
Defaults to 0, which disables polling and uses filesystem
notifications.
PAPERLESS_CONSUMER_POLLING_RETRY_COUNT=<num>
If consumer polling is enabled, sets the number of times paperless
will check for a file to remain unmodified.
Defaults to 5.
PAPERLESS_CONSUMER_POLLING_DELAY=<num>
If consumer polling is enabled, sets the delay in seconds between
each check (above) paperless will do while waiting for a file to
remain unmodified.
Defaults to 5.
iNotify
PAPERLESS_CONSUMER_INOTIFY_DELAY=<num>
Sets the time in seconds the consumer will wait for additional
events from inotify before the consumer will consider a file ready
and begin consumption. Certain scanners or network setups may
generate multiple events for a single file, leading to multiple
consumers working on the same file. Configure this to prevent that.
Defaults to 0.5 seconds.
Barcodes
PAPERLESS_CONSUMER_ENABLE_BARCODES=<bool>
Enables the scanning and page separation based on detected barcodes.
This allows for scanning and adding multiple documents per uploaded
file, which are separated by one or multiple barcode pages.
For ease of use, it is suggested to use a standardized separation
page, e.g. here.
If no barcodes are detected in the uploaded file, no page separation
will happen.
The original document will be removed and the separated pages will
be saved as pdf.
See additional information in the advanced usage documentation
Defaults to false.
PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT=<bool>
Whether TIFF image files should be scanned for barcodes. This will
automatically convert any TIFF image(s) to pdfs for later
processing. This only has an effect, if
PAPERLESS_CONSUMER_ENABLE_BARCODES has been enabled.
Defaults to false.
PAPERLESS_CONSUMER_BARCODE_STRING=<string>
Defines the string to be detected as a separator barcode. If
paperless is used with the PATCH-T separator pages, users shouldn't
change this.
Defaults to "PATCHT"
PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE=<bool>
Enables the detection of barcodes in the scanned document and
setting the ASN (archive serial number) if a properly formatted
barcode is detected.
The barcode must consist of a (configurable) prefix and the ASN
to be set, for instance ASN00123.
This option is compatible with barcode page separation, since
pages will be split up before reading the ASN.
If no ASN barcodes are detected in the uploaded file, no ASN will
be set. If a barcode with an existing ASN is detected, the
document will not be consumed and an error logged.
Defaults to false.
PAPERLESS_CONSUMER_ASN_BARCODE_PREFIX=<string>
Defines the prefix that is used to identify a barcode as an ASN
barcode.
Defaults to "ASN"
PAPERLESS_CONSUMER_BARCODE_UPSCALE=<float>
Defines the upscale factor used in barcode detection.
Improves the detection of small barcodes, i.e. with a value of 1.5 by
upscaling the document beforce the detection process. Upscaling will
only take place if value is bigger than 1.0. Otherwise upscaling will
not be performed to save resources. Try using in combination with
PAPERLESS_CONSUMER_BARCODE_DPI set to a value higher than default.
Defaults to 0.0
PAPERLESS_CONSUMER_BARCODE_DPI=<int>
During barcode detection every page from a PDF document needs
to be converted to an image. A dpi value can be specified in the
conversion process. Default is 300. If the detection of small barcodes
fails a bigger dpi value i.e. 600 can fix the issue. Try using in
combination with PAPERLESS_CONSUMER_BARCODE_UPSCALE bigger than 1.0.
Defaults to "300"
Binaries
There are a few external software packages that Paperless expects to
find on your system when it starts up. Unless you've done something
creative with their installation, you probably won't need to edit any
of these. However, if you've installed these programs somewhere where
simply typing the name of the program doesn't automatically execute it
(ie. the program isn't in your \$PATH), then you'll need to specify
the literal path for that program.
PAPERLESS_CONVERT_BINARY=<path>
Defaults to "convert".
PAPERLESS_GS_BINARY=<path>
Defaults to "gs".
Docker-specific options
These options don't have any effect in paperless.conf. These options
adjust the behavior of the docker container. Configure these in
docker-compose.env.
PAPERLESS_WEBSERVER_WORKERS=<num>
The number of worker processes the webserver should spawn. More
worker processes usually result in the front end to load data much
quicker. However, each worker process also loads the entire
application into memory separately, so increasing this value will
increase RAM usage.
Defaults to 1.
PAPERLESS_BIND_ADDR=<ip address>
The IP address the webserver will listen on inside the container.
There are special setups where you may need to configure this value
to restrict the Ip address or interface the webserver listens on.
Defaults to [::], meaning all interfaces, including IPv6.
PAPERLESS_PORT=<port>
The port number the webserver will listen on inside the container.
There are special setups where you may need this to avoid collisions
with other services (like using podman with multiple containers in
one pod).
Don't change this when using Docker. To change the port the
webserver is reachable outside of the container, instead refer to
the "ports" key in docker-compose.yml.
Defaults to 8000.
USERMAP_UID=<uid>
The ID of the paperless user in the container. Set this to your
actual user ID on the host system, which you can get by executing
$ id -u
Paperless will change ownership on its folders to this user, so you
need to get this right in order to be able to write to the
consumption directory.
Defaults to 1000.
USERMAP_GID=<gid>
The ID of the paperless Group in the container. Set this to your
actual group ID on the host system, which you can get by executing
$ id -g
Paperless will change ownership on its folders to this group, so you
need to get this right in order to be able to write to the
consumption directory.
Defaults to 1000.
PAPERLESS_OCR_LANGUAGES=<list>
Additional OCR languages to install. By default, paperless comes
with English, German, Italian, Spanish and French. If your language
is not in this list, install additional languages with this
configuration option. You will need to find the right LangCodes
but note that (tesseract-ocr-* package names)[https://packages.debian.org/bullseye/graphics/]
do not always correspond with the language codes e.g. "chi_tra" should be
specified as "chi-tra".
PAPERLESS_OCR_LANGUAGES=tur ces chi-tra
Make sure it's a space separated list when using several values.
To actually use these languages, also set the default OCR language
of paperless:
PAPERLESS_OCR_LANGUAGE=tur
Defaults to none, which does not install any additional languages.
PAPERLESS_ENABLE_FLOWER=<defined>
If this environment variable is defined, the Celery monitoring tool
Flower will be
started by the container.
You can read more about this in the advanced documentation.
Update Checking
PAPERLESS_ENABLE_UPDATE_CHECK=<bool>
This setting was deprecated in favor of a frontend setting after
v1.9.2. A one-time migration is performed for users who have this
setting set. This setting is always ignored if the corresponding
frontend setting has been set.