mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-09 09:58:20 -05:00
6d6b5d19fa
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.
