From ff9b76439d02c3a33cf342b55725096a2d6b2353 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 21 Sep 2023 10:46:11 -0700 Subject: [PATCH] Updates references to config vars to use direct links --- docs/administration.md | 4 ++-- docs/advanced_usage.md | 8 +++---- docs/setup.md | 48 ++++++++++++++++++++--------------------- docs/troubleshooting.md | 7 +++--- docs/usage.md | 2 +- 5 files changed, 34 insertions(+), 35 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 627aa4136..7be462068 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -286,7 +286,7 @@ other files. The filenames generated by this command follow the format `[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`. 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: -(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) ``` diff --git a/docs/advanced_usage.md b/docs/advanced_usage.md index 3980261e6..60180eb72 100644 --- a/docs/advanced_usage.md +++ b/docs/advanced_usage.md @@ -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, and then put the path to that script in `paperless.conf` or `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 @@ -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 don't have to access these files manually. However, if you wish to name 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. 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 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 - Each document is assigned a storage path using the matching algorithms described above, but can be overwritten at any time @@ -417,7 +417,7 @@ Insurances/ # Insurances !!! tip 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} diff --git a/docs/setup.md b/docs/setup.md index 6ade1cb96..8021e6339 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -153,7 +153,7 @@ steps described in [Docker setup](#docker_hub) automatically. !!! note 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`. !!! warning @@ -162,7 +162,7 @@ steps described in [Docker setup](#docker_hub) automatically. system notifications with `inotify`. When storing the consumption directory on such a file system, paperless will not pick up new 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). 6. Run `docker-compose pull`. This will pull the image. @@ -350,23 +350,23 @@ supported. needs. Required settings for getting 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 . - - `PAPERLESS_DBENGINE` optional, and should be one of `postgres`, + - [`PAPERLESS_DBENGINE`](/configuration#PAPERLESS_DBENGINE) optional, and should be one of `postgres`, `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 SQLite instead. Also configure port, database name, user and 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 - this somewhere else. Likewise, `PAPERLESS_DATA_DIR` and - `PAPERLESS_MEDIA_ROOT` define where paperless stores its data. + this somewhere else. Likewise, [`PAPERLESS_DATA_DIR`](/configuration#PAPERLESS_DATA_DIR) and + [`PAPERLESS_MEDIA_ROOT`](/configuration#PAPERLESS_MEDIA_ROOT) define where paperless stores its data. 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 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 [configuration](/configuration) for more information. @@ -374,9 +374,9 @@ supported. Many more adjustments can be made to paperless, especially the OCR 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. - - Set `PAPERLESS_TIME_ZONE` to your local time zone. + - Set [`PAPERLESS_TIME_ZONE`](/configuration#PAPERLESS_TIME_ZONE) to your local time zone. !!! warning @@ -522,7 +522,7 @@ supported. not available for most distributions. 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 Stemmer, Stopwords and Punkt tokenizer to your `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK @@ -670,23 +670,23 @@ commands as well. 1. Stop and remove the paperless container 2. If using an external database, stop the container 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. b) Otherwise, in the `docker-compose.yml` add a new service for Redis, following [the example 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 4. Update user mapping a) If set, change the environment variable `PUID` to `USERMAP_UID` b) If set, change the environment variable `PGID` to `USERMAP_GID` 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 - a) Set the environment variable `PAPERLESS_MEDIA_ROOT` to + a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](/configuration#PAPERLESS_MEDIA_ROOT) to `/data/media` 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` 8. Modify the `image:` to point to `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: - 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 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 cores, meaning that paperless will use 2 workers and 2 threads per worker. This may result in sluggish response times during consumption, so you might want to lower these settings (example: 2 workers and 1 thread to always have some computing power left for 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 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 for all documents. - If you want to perform OCR on the device, consider using `PAPERLESS_OCR_CLEAN=none`. This will speed up OCR times and use 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. -- Consider setting `PAPERLESS_ENABLE_NLTK` to false, to disable the +- If using docker, consider setting [`PAPERLESS_WEBSERVER_WORKERS`](/configuration#PAPERLESS_WEBSERVER_WORKERS) to 1. This will save some memory. +- Consider setting [`PAPERLESS_ENABLE_NLTK`](/configuration#PAPERLESS_ENABLE_NLTK) to false, to disable the more advanced language processing, which can take more memory and processing time. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index baf91a27c..bf65f1e7f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -46,8 +46,7 @@ run: If you notice that the consumer will only pickup files in the consumption directory at startup, but won't find any other files added later, you will need to enable filesystem polling with the configuration -option `PAPERLESS_CONSUMER_POLLING`, see -`[here](/configuration#polling). +option [`PAPERLESS_CONSUMER_POLLING`](/configuration#PAPERLESS_CONSUMER_POLLING). This will disable listening to filesystem changes with inotify and 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 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. ## 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 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. ## Database Warns about unique constraint "documents_tag_name_uniq diff --git a/docs/usage.md b/docs/usage.md index 9f561ee01..3121d35b6 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -208,7 +208,7 @@ different means. These are as follows: them further. 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