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.
* Updates the Gotenberg version to use 7.10 and gotenberg-client to match
* Fixes a long standing bug in this test where a whole page was missing from the expected
* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command
* Update docs/setup.md
Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command
---------
Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
* Removing Mariadb default open port
Removing the listening port 3306 for the DB, Docker networks will let the containers talk to one another. The existing setup would allow anyone to connect to the DB and use the default passwords.
* Update docker-compose.mariadb-tika.yml
Adding change to the other compose file to remove open port
* Remove excess blank lines
* Remove excess blank lines
Co-authored-by: Felix E <felix@eckhofer.com>
* 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>
* Create arm variant for sqlite-tika as apache/tika does not support arm64 arch right now
https://github.com/jonaswinkler/paperless-ng/discussions/1256
* Update documentation to explain why there is a seemingly duplicated docker-compose file
* Add caveat about arm arch
* Update docs to encourage use of the new docker-compose
* Remove whitespace
https://github.com/jonaswinkler/paperless-ng/pull/1354/checks?check_run_id=3756807426
* Update docker container to use official ngx
Co-authored-by: Quinn Casey <quinn@quinncasey.com>
* doesn -> does not
* Update docker/compose/docker-compose.postgres-tika.yml
Co-authored-by: Jan-Hendrik Ewers <jh.ewers@gmail.com>
* Update docker/compose/docker-compose.sqlite-tika.arm.yml
Co-authored-by: Jan-Hendrik Ewers <jh.ewers@gmail.com>
* Update docker/compose/docker-compose.sqlite-tika.yml
Co-authored-by: Jan-Hendrik Ewers <jh.ewers@gmail.com>
* Update docker/compose/docker-compose.sqlite-tika.arm.yml
* Update docker-compose.sqlite-tika.arm.yml
* Update docker/compose/docker-compose.sqlite-tika.arm.yml
Co-authored-by: Jan-Hendrik Ewers <jh.ewers@gmail.com>
* Add redisdata to volumes
Co-authored-by: Quinn Casey <quinn@quinncasey.com>
