diff --git a/docs/advanced_usage.md b/docs/advanced_usage.md index 029d1ec40..85f2ef87c 100644 --- a/docs/advanced_usage.md +++ b/docs/advanced_usage.md @@ -691,7 +691,7 @@ More details about configuration option for various providers can be found in th Once external auth is set up, 'regular' login can be disabled with the [PAPERLESS_DISABLE_REGULAR_LOGIN](configuration.md#PAPERLESS_DISABLE_REGULAR_LOGIN) setting and / or users can be automatically redirected with the [PAPERLESS_REDIRECT_LOGIN_TO_SSO](configuration.md#PAPERLESS_REDIRECT_LOGIN_TO_SSO) setting. -## Decryption of encrypted emails before consumption +## Decryption of encrypted emails before consumption {#gpg-decryptor} Paperless-ngx can be configured to decrypt gpg encrypted emails before consumption. @@ -706,15 +706,11 @@ gpg --encrypt --armor -r person@email.com name_of_file gpg --decrypt name_of_file.asc ``` -### Setting up docker-compose file +### Setup -Add the following variable to your `docker-compose.env` file: +First, enable the [PAPERLESS_GPG_DECRYPTOR environment variable](configuration.md#PAPERLESS_GPG_DECRYPTOR). -```conf. -PAPERLESS_GPG_DECRYPTOR=True -``` - -Determine your local `gpg-agent.extra` socket by invoking +Then determine your local `gpg-agent.extra` socket by invoking ``` gpgconf --list-dir agent-extra-socket @@ -723,7 +719,7 @@ gpgconf --list-dir agent-extra-socket on your host. A possible output is `~/.gnupg/S.gpg-agent.extra`. Also find the location of your public keyring. -Add the following volume mounts to your `docker-compose.yml` file: +If using docker, you'll need to add the following volume mounts to your `docker-compose.yml` file: ```yaml webserver: diff --git a/docs/configuration.md b/docs/configuration.md index e719e043d..8d062ac29 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1149,6 +1149,12 @@ within your documents. second, and year last order. Characters D, M, or Y can be shuffled to meet the required order. +#### [`PAPERLESS_GPG_DECRYPTOR=`](#PAPERLESS_GPG_DECRYPTOR) {#PAPERLESS_GPG_DECRYPTOR} + +: Enable or disable the GPG decryptor for encrypted files. See [GPG Decryptor](advanced_usage.md#gpg-decryptor) for more information. + + Defaults to false. + ### Polling {#polling} #### [`PAPERLESS_CONSUMER_POLLING=`](#PAPERLESS_CONSUMER_POLLING) {#PAPERLESS_CONSUMER_POLLING}