5 Commits

Author SHA1 Message Date
Pascal Riemer
6d6b5d19fa
Improve docker-compose.env with missing variables and explanations
This PR updates the docker-compose.env file in the Paperless-ngx documentation to provide a more complete and user-friendly reference for environment variables.

## Changes:
- Added several missing environment variables based on the official Paperless-ngx configuration docs.
- Included explanations for each variable, keeping the style consistent with the existing file.
- Added links to relevant external documentation (e.g., Django docs) where applicable.

## Why this change?
I self-host over 30 services and am used to example .env files in GitHub repositories providing a complete list of configurable options. When setting up Paperless-ngx, I initially overlooked the comment at the top of the file referencing the official configuration docs ("# See http://docs.paperless-ngx.com/configuration/ for all available options.")

This short comment is a bit hidden within a block of other metadata, and I only realized later that many available variables were missing from the example file. 

This update aims to:

- Improve clarity and discoverability of Paperless-ngx settings.
- Reduce confusion for users who, like me, expect docker-compose.env to be a full reference.
- Provide a more practical and self-contained starting point for Docker Compose users.

This expanded docker-compose.env should make it easier to configure Paperless-ngx effectively while keeping the documentation aligned with the official sources.
2025-03-04 15:54:06 +01:00
shamoon
fcf532f13e Documentation: documentation updates 2024-11-24 14:20:20 -08:00
viktor-c
3828d712bd
Info about installing on subpath (#1350)
* Update docker-compose.env

* Update configuration.rst

example.com/paperless is not a subdomain, but a subpath. Also when hosting from a subdomain like paperless.example.com one does not have to change anything in the configuration, it just works, because paperless expects to be hosted at root, i.e. paperless.example.com
This however changes when paperless is not hosted at root anymore but for example at paperless.example.com/paperlessNgx

* Update docker-compose.env

* Apply suggestions from code review

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2022-08-31 16:36:13 -07:00
Michael Shamoon
ca0e86757b add PAPERLESS_URL env variable for CSRF 2022-04-08 00:27:53 -07:00
jonaswinkler
769356733a update docker compose files and documentation #339 2021-01-14 12:59:39 +01:00