lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates references to config vars to use direct links

Browse Source
This commit is contained in:
shamoon 2023-09-21 10:46:11 -07:00
parent d1f006c6a7
commit ff9b76439d
5 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/administration.md
View File

@ -286,7 +286,7 @@ other files.
The filenames generated by this command follow the format The filenames generated by this command follow the format
`[date created] [correspondent] [title].[extension]`. If you want `[date created] [correspondent] [title].[extension]`. If you want
paperless to use `PAPERLESS_FILENAME_FORMAT` for exported filenames paperless to use [`PAPERLESS_FILENAME_FORMAT`](/configuration#PAPERLESS_FILENAME_FORMAT) for exported filenames
instead, specify `-f` or `--use-filename-format`. instead, specify `-f` or `--use-filename-format`.
If `-na` or `--no-archive` is provided, no archive files will be exported, If `-na` or `--no-archive` is provided, no archive files will be exported,
@ -560,7 +560,7 @@ Enabling encryption is no longer supported.
Basic usage to disable encryption of your document store: Basic usage to disable encryption of your document store:
(Note: If `PAPERLESS_PASSPHRASE` isn't set already, you need to specify (Note: If [`PAPERLESS_PASSPHRASE`](/configuration#PAPERLESS_PASSPHRASE) isn't set already, you need to specify
it here) it here)
``` ```

8
docs/advanced_usage.md
View File

@ -107,7 +107,7 @@ document is consumed using a couple of simple hooks.
Just write a script, put it somewhere that Paperless can read & execute, Just write a script, put it somewhere that Paperless can read & execute,
and then put the path to that script in `paperless.conf` or and then put the path to that script in `paperless.conf` or
`docker-compose.env` with the variable name of either `docker-compose.env` with the variable name of either
`PAPERLESS_PRE_CONSUME_SCRIPT` or `PAPERLESS_POST_CONSUME_SCRIPT`. [`PAPERLESS_PRE_CONSUME_SCRIPT`](/configuration#PAPERLESS_PRE_CONSUME_SCRIPT) or [`PAPERLESS_POST_CONSUME_SCRIPT`](/configuration#PAPERLESS_POST_CONSUME_SCRIPT).
!!! info !!! info
@ -249,7 +249,7 @@ document. You will end up getting files like `0000123.pdf` in your media
directory. This isn't necessarily a bad thing, because you normally directory. This isn't necessarily a bad thing, because you normally
don't have to access these files manually. However, if you wish to name don't have to access these files manually. However, if you wish to name
your files differently, you can do that by adjusting the your files differently, you can do that by adjusting the
`PAPERLESS_FILENAME_FORMAT` configuration option. Paperless adds the [`PAPERLESS_FILENAME_FORMAT`](/configuration#PAPERLESS_FILENAME_FORMAT) configuration option. Paperless adds the
correct file extension e.g. `.pdf`, `.jpg` automatically. correct file extension e.g. `.pdf`, `.jpg` automatically.
This variable allows you to configure the filename (folders are allowed) This variable allows you to configure the filename (folders are allowed)
@ -377,7 +377,7 @@ When a single storage layout is not sufficient for your use case,
storage paths come to the rescue. Storage paths allow you to configure storage paths come to the rescue. Storage paths allow you to configure
more precisely where each document is stored in the file system. more precisely where each document is stored in the file system.
- Each storage path is a `PAPERLESS_FILENAME_FORMAT` and - Each storage path is a [`PAPERLESS_FILENAME_FORMAT`](/configuration#PAPERLESS_FILENAME_FORMAT) and
follows the rules described above follows the rules described above
- Each document is assigned a storage path using the matching - Each document is assigned a storage path using the matching
algorithms described above, but can be overwritten at any time algorithms described above, but can be overwritten at any time
@ -417,7 +417,7 @@ Insurances/ # Insurances
!!! tip !!! tip
Defining a storage path is optional. If no storage path is defined for a Defining a storage path is optional. If no storage path is defined for a
document, the global `PAPERLESS_FILENAME_FORMAT` is applied. document, the global [`PAPERLESS_FILENAME_FORMAT`](/configuration#PAPERLESS_FILENAME_FORMAT) is applied.
## Celery Monitoring {#celery-monitoring} ## Celery Monitoring {#celery-monitoring}

48
docs/setup.md
View File

@ -153,7 +153,7 @@ steps described in [Docker setup](#docker_hub) automatically.
!!! note !!! note
You can utilize Docker secrets for configuration settings by You can utilize Docker secrets for configuration settings by
appending `_FILE` to configuration values. For example `PAPERLESS_DBUSER` appending `_FILE` to configuration values. For example [`PAPERLESS_DBUSER`](/configuration#PAPERLESS_DBUSER)
can be set using `PAPERLESS_DBUSER_FILE=/var/run/secrets/password.txt`. can be set using `PAPERLESS_DBUSER_FILE=/var/run/secrets/password.txt`.
!!! warning !!! warning
@ -162,7 +162,7 @@ steps described in [Docker setup](#docker_hub) automatically.
system notifications with `inotify`. When storing the consumption system notifications with `inotify`. When storing the consumption
directory on such a file system, paperless will not pick up new directory on such a file system, paperless will not pick up new
files with the default configuration. You will need to use files with the default configuration. You will need to use
`PAPERLESS_CONSUMER_POLLING`, which will disable inotify. See [`PAPERLESS_CONSUMER_POLLING`](/configuration#PAPERLESS_CONSUMER_POLLING), which will disable inotify. See
[here](/configuration#polling). [here](/configuration#polling).
6. Run `docker-compose pull`. This will pull the image. 6. Run `docker-compose pull`. This will pull the image.
@ -350,23 +350,23 @@ supported.
needs. Required settings for getting needs. Required settings for getting
paperless running are: paperless running are:
- `PAPERLESS_REDIS` should point to your redis server, such as - [`PAPERLESS_REDIS`](/configuration#PAPERLESS_REDIS) should point to your redis server, such as
<redis://localhost:6379>. <redis://localhost:6379>.
- `PAPERLESS_DBENGINE` optional, and should be one of `postgres`, - [`PAPERLESS_DBENGINE`](/configuration#PAPERLESS_DBENGINE) optional, and should be one of `postgres`,
`mariadb`, or `sqlite` `mariadb`, or `sqlite`
- `PAPERLESS_DBHOST` should be the hostname on which your - [`PAPERLESS_DBHOST`](/configuration#PAPERLESS_DBHOST) should be the hostname on which your
PostgreSQL server is running. Do not configure this to use PostgreSQL server is running. Do not configure this to use
SQLite instead. Also configure port, database name, user and SQLite instead. Also configure port, database name, user and
password as necessary. password as necessary.
- `PAPERLESS_CONSUMPTION_DIR` should point to a folder which - [`PAPERLESS_CONSUMPTION_DIR`](/configuration#PAPERLESS_CONSUMPTION_DIR) should point to a folder which
paperless should watch for documents. You might want to have paperless should watch for documents. You might want to have
this somewhere else. Likewise, `PAPERLESS_DATA_DIR` and this somewhere else. Likewise, [`PAPERLESS_DATA_DIR`](/configuration#PAPERLESS_DATA_DIR) and
`PAPERLESS_MEDIA_ROOT` define where paperless stores its data. [`PAPERLESS_MEDIA_ROOT`](/configuration#PAPERLESS_MEDIA_ROOT) define where paperless stores its data.
If you like, you can point both to the same directory. If you like, you can point both to the same directory.
- `PAPERLESS_SECRET_KEY` should be a random sequence of - [`PAPERLESS_SECRET_KEY`](/configuration#PAPERLESS_SECRET_KEY) should be a random sequence of
characters. It's used for authentication. Failure to do so characters. It's used for authentication. Failure to do so
allows third parties to forge authentication credentials. allows third parties to forge authentication credentials.
- `PAPERLESS_URL` if you are behind a reverse proxy. This should - [`PAPERLESS_URL`](/configuration#PAPERLESS_URL) if you are behind a reverse proxy. This should
point to your domain. Please see point to your domain. Please see
[configuration](/configuration) for more [configuration](/configuration) for more
information. information.
@ -374,9 +374,9 @@ supported.
Many more adjustments can be made to paperless, especially the OCR Many more adjustments can be made to paperless, especially the OCR
part. The following options are recommended for everyone: part. The following options are recommended for everyone:
- Set `PAPERLESS_OCR_LANGUAGE` to the language most of your - Set [`PAPERLESS_OCR_LANGUAGE`](/configuration#PAPERLESS_OCR_LANGUAGE) to the language most of your
documents are written in. documents are written in.
- Set `PAPERLESS_TIME_ZONE` to your local time zone. - Set [`PAPERLESS_TIME_ZONE`](/configuration#PAPERLESS_TIME_ZONE) to your local time zone.
!!! warning !!! warning
@ -522,7 +522,7 @@ supported.
not available for most distributions. not available for most distributions.
15. Optional: If using the NLTK machine learning processing (see 15. Optional: If using the NLTK machine learning processing (see
`PAPERLESS_ENABLE_NLTK` in [configuration](/configuration#software_tweaks) for details), [`PAPERLESS_ENABLE_NLTK`](/configuration#PAPERLESS_ENABLE_NLTK) for details),
download the NLTK data for the Snowball download the NLTK data for the Snowball
Stemmer, Stopwords and Punkt tokenizer to your Stemmer, Stopwords and Punkt tokenizer to your
`PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
@ -670,23 +670,23 @@ commands as well.
1. Stop and remove the paperless container 1. Stop and remove the paperless container
2. If using an external database, stop the container 2. If using an external database, stop the container
3. Update Redis configuration 3. Update Redis configuration
a) If `REDIS_URL` is already set, change it to `PAPERLESS_REDIS` a) If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](/configuration#PAPERLESS_REDIS)
and continue to step 4. and continue to step 4.
b) Otherwise, in the `docker-compose.yml` add a new service for b) Otherwise, in the `docker-compose.yml` add a new service for
Redis, following [the example compose Redis, following [the example compose
files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
c) Set the environment variable `PAPERLESS_REDIS` so it points to c) Set the environment variable [`PAPERLESS_REDIS`](/configuration#PAPERLESS_REDIS) so it points to
the new Redis container the new Redis container
4. Update user mapping 4. Update user mapping
a) If set, change the environment variable `PUID` to `USERMAP_UID` a) If set, change the environment variable `PUID` to `USERMAP_UID`
b) If set, change the environment variable `PGID` to `USERMAP_GID` b) If set, change the environment variable `PGID` to `USERMAP_GID`
5. Update configuration paths 5. Update configuration paths
a) Set the environment variable `PAPERLESS_DATA_DIR` to `/config` a) Set the environment variable [`PAPERLESS_DATA_DIR`](/configuration#PAPERLESS_DATA_DIR) to `/config`
6. Update media paths 6. Update media paths
a) Set the environment variable `PAPERLESS_MEDIA_ROOT` to a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](/configuration#PAPERLESS_MEDIA_ROOT) to
`/data/media` `/data/media`
7. Update timezone 7. Update timezone
a) Set the environment variable `PAPERLESS_TIME_ZONE` to the same a) Set the environment variable [`PAPERLESS_TIME_ZONE`](/configuration#PAPERLESS_TIME_ZONE) to the same
value as `TZ` value as `TZ`
8. Modify the `image:` to point to 8. Modify the `image:` to point to
`ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version `ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version
@ -823,27 +823,27 @@ the Pi and configuring some options in paperless can help improve
performance immensely: performance immensely:
- Stick with SQLite to save some resources. - Stick with SQLite to save some resources.
- Consider setting `PAPERLESS_OCR_PAGES` to 1, so that paperless will - Consider setting [`PAPERLESS_OCR_PAGES`](/configuration#PAPERLESS_OCR_PAGES) to 1, so that paperless will
only OCR the first page of your documents. In most cases, this page only OCR the first page of your documents. In most cases, this page
contains enough information to be able to find it. contains enough information to be able to find it.
- `PAPERLESS_TASK_WORKERS` and `PAPERLESS_THREADS_PER_WORKER` are - [`PAPERLESS_TASK_WORKERS`](/configuration#PAPERLESS_TASK_WORKERS) and [`PAPERLESS_THREADS_PER_WORKER`](/configuration#PAPERLESS_THREADS_PER_WORKER) are
configured to use all cores. The Raspberry Pi models 3 and up have 4 configured to use all cores. The Raspberry Pi models 3 and up have 4
cores, meaning that paperless will use 2 workers and 2 threads per cores, meaning that paperless will use 2 workers and 2 threads per
worker. This may result in sluggish response times during worker. This may result in sluggish response times during
consumption, so you might want to lower these settings (example: 2 consumption, so you might want to lower these settings (example: 2
workers and 1 thread to always have some computing power left for workers and 1 thread to always have some computing power left for
other tasks). other tasks).
- Keep `PAPERLESS_OCR_MODE` at its default value `skip` and consider - Keep [`PAPERLESS_OCR_MODE`](/configuration#PAPERLESS_OCR_MODE) at its default value `skip` and consider
OCR'ing your documents before feeding them into paperless. Some OCR'ing your documents before feeding them into paperless. Some
scanners are able to do this! scanners are able to do this!
- Set `PAPERLESS_OCR_SKIP_ARCHIVE_FILE` to `with_text` to skip archive - Set [`PAPERLESS_OCR_SKIP_ARCHIVE_FILE`](/configuration#PAPERLESS_OCR_SKIP_ARCHIVE_FILE) to `with_text` to skip archive
file generation for already ocr'ed documents, or `always` to skip it file generation for already ocr'ed documents, or `always` to skip it
for all documents. for all documents.
- If you want to perform OCR on the device, consider using - If you want to perform OCR on the device, consider using
`PAPERLESS_OCR_CLEAN=none`. This will speed up OCR times and use `PAPERLESS_OCR_CLEAN=none`. This will speed up OCR times and use
less memory at the expense of slightly worse OCR results. less memory at the expense of slightly worse OCR results.
- If using docker, consider setting `PAPERLESS_WEBSERVER_WORKERS` to 1. This will save some memory. - If using docker, consider setting [`PAPERLESS_WEBSERVER_WORKERS`](/configuration#PAPERLESS_WEBSERVER_WORKERS) to 1. This will save some memory.
- Consider setting `PAPERLESS_ENABLE_NLTK` to false, to disable the - Consider setting [`PAPERLESS_ENABLE_NLTK`](/configuration#PAPERLESS_ENABLE_NLTK) to false, to disable the
more advanced language processing, which can take more memory and more advanced language processing, which can take more memory and
processing time. processing time.

7
docs/troubleshooting.md
View File

@ -46,8 +46,7 @@ run:
If you notice that the consumer will only pickup files in the If you notice that the consumer will only pickup files in the
consumption directory at startup, but won't find any other files added consumption directory at startup, but won't find any other files added
later, you will need to enable filesystem polling with the configuration later, you will need to enable filesystem polling with the configuration
option `PAPERLESS_CONSUMER_POLLING`, see option [`PAPERLESS_CONSUMER_POLLING`](/configuration#PAPERLESS_CONSUMER_POLLING).
`[here](/configuration#polling).
This will disable listening to filesystem changes with inotify and This will disable listening to filesystem changes with inotify and
paperless will manually check the consumption directory for changes paperless will manually check the consumption directory for changes
@ -320,7 +319,7 @@ many workers attempting to access the database simultaneously.
Consider changing to the PostgreSQL database if you will be processing Consider changing to the PostgreSQL database if you will be processing
many documents at once often. Otherwise, try tweaking the many documents at once often. Otherwise, try tweaking the
`PAPERLESS_DB_TIMEOUT` setting to allow more time for the database to [`PAPERLESS_DB_TIMEOUT`](/configuration#PAPERLESS_DB_TIMEOUT) setting to allow more time for the database to
unlock. This may have minor performance implications. unlock. This may have minor performance implications.
## gunicorn fails to start with "is not a valid port number" ## gunicorn fails to start with "is not a valid port number"
@ -330,7 +329,7 @@ environment variable named `${serviceName}_PORT`. This is
the same environment variable which is used by Paperless to optionally the same environment variable which is used by Paperless to optionally
change the port gunicorn listens on. change the port gunicorn listens on.
To fix this, set `PAPERLESS_PORT` again to your desired port, or the To fix this, set [`PAPERLESS_PORT`](/configuration#PAPERLESS_PORT) again to your desired port, or the
default of 8000. default of 8000.
## Database Warns about unique constraint "documents_tag_name_uniq ## Database Warns about unique constraint "documents_tag_name_uniq

2
docs/usage.md
View File

@ -208,7 +208,7 @@ different means. These are as follows:
them further. them further.
Paperless is set up to check your mails every 10 minutes. This can be Paperless is set up to check your mails every 10 minutes. This can be
configured via `PAPERLESS_EMAIL_TASK_CRON` (see [software tweaks](/configuration#software_tweaks)) configured via [`PAPERLESS_EMAIL_TASK_CRON`](/configuration#PAPERLESS_EMAIL_TASK_CRON)
### REST API ### REST API