docs: align docker-compose env docs with #7907 (required credentials, TRUST_PROXY default)

[JohnMcLear]

Follow-up to #7907 (merged), which changed docker-compose.yml to require ADMIN_PASSWORD and the database password and to default TRUST_PROXY to false — but didn't touch the docs/templates. This brings them in line.

Changes

• .env.default — document DOCKER_COMPOSE_APP_TRUST_PROXY (set true only behind a trusted reverse proxy; otherwise HTTPS detection / secure cookies and client-IP handling are wrong), and note that DOCKER_COMPOSE_APP_ADMIN_PASSWORD is now required (compose won't start while it's empty).
• .env.dev.default — document the dev equivalent DOCKER_COMPOSE_APP_DEV_ENV_TRUST_PROXY (defaults true in docker-compose.dev.yml).
• README.md / doc/docker.md — refresh the embedded compose snippets, which still showed the old :-admin / TRUST_PROXY:-true defaults.

Notes

• This is docs/templates only — no code or compose behaviour change.
• Heads-up for the changelog at next release: docker-compose: harden default credentials and proxy trust (draft, under discussion) #7907 is a breaking change for docker-compose users — docker compose up now fails until ADMIN_PASSWORD/DB password are set, and anyone running behind a reverse proxy must now set DOCKER_COMPOSE_APP_TRUST_PROXY=true (previously the compose defaulted it to true). Worth a release-note line.
• Separately: .env.default still ships an empty DOCKER_COMPOSE_APP_ADMIN_PASSWORD=, so copying it and running now hard-fails by design. If that first-run friction is unwanted, softening the compose :? to a warning would be a follow-up to docker-compose: harden default credentials and proxy trust (draft, under discussion) #7907 (code, not docs) — left out of this PR intentionally.

🤖 Generated with Claude Code

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0)

1. Missing final newline 🐞 Bug ⚙ Maintainability

Description

.env.dev.default still has no trailing newline, violating the repo’s EditorConfig and potentially
causing formatting/lint noise or messy diffs on future edits.

Code

.env.dev.default[22]

DOCKER_COMPOSE_POSTGRES_DEV_ENV_POSTGRES_USER=etherpad-lite-user

Evidence

The repository’s EditorConfig requires a final newline, but .env.dev.default ends at the last
variable assignment without one (also indicated by the PR diff’s No newline at end of file
marker).

.editorconfig[1-9]
.env.dev.default[14-22]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The file `.env.dev.default` does not end with a newline, which violates the repository’s `.editorconfig` setting `insert_final_newline = true`.

### Issue Context
This PR modifies `.env.dev.default` but retains the missing final newline, which can trigger formatting checks and create awkward diffs.

### Fix Focus Areas
- `.env.dev.default[22-22]`

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

[qodo-free-for-open-source-projects]

PR Summary by Qodo

Docs: align docker-compose env templates with required creds + TRUST_PROXY default

📝 Documentation ⚙️ Configuration changes 🕐 10-20 Minutes

AI Description

• Document required docker-compose credentials (admin + DB) and explain security impact.
• Clarify TRUST_PROXY defaults and when to enable it behind a trusted reverse proxy.
• Update README/docker docs compose snippets to match current compose behavior.

Diagram

graph TD
  U(("User")) --> D["Docs (README/docker.md)"] --> E["Env templates (.env*)"] --> C["docker-compose.yml"] --> S["Etherpad container"] --> P[("Postgres")]
  C -. "starts" .-> P

  subgraph Legend
    direction LR
    _u(("User")) ~~~ _f["File/Doc"] ~~~ _s["Service"] ~~~ _db[("Database")]
  end

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Generate docs snippets from docker-compose.yml

• ➕ Prevents drift between compose behavior and documented examples
• ➕ Makes future breaking changes harder to miss in docs
• ➖ Requires tooling (docs build step or CI) and authoring workflow changes
• ➖ Harder to keep docs narrative clean if raw compose is verbose

2. Single source of truth for env templates (include/templating)

• ➕ Ensures .env.default, .env.dev.default, and docs stay consistent
• ➕ Reduces duplicate explanations of TRUST_PROXY/credential requirements
• ➖ Adds templating/processing complexity to an otherwise simple repo artifact
• ➖ May reduce approachability for contributors editing plain text files

Recommendation: The PR’s approach (directly updating the docs and env templates) is the right immediate fix for the drift introduced by #7907. If this project has recurring doc/compose mismatches, consider a follow-up to generate or validate embedded compose snippets from docker-compose.yml in CI to keep them synchronized.

Files changed (4) +22 / -8

Documentation (2) +8 / -8

README.mdUpdate docker-compose snippet to require passwords and default TRUST_PROXY=false +4/-4

Update docker-compose snippet to require passwords and default TRUST_PROXY=false

• Refreshes the embedded compose environment block to use required-variable syntax for ADMIN_PASSWORD and DB/POSTGRES passwords (no insecure fallbacks). Updates TRUST_PROXY example default from true to false.

README.md

docker.mdAlign docker docs compose snippet with required passwords and TRUST_PROXY default +4/-4

Align docker docs compose snippet with required passwords and TRUST_PROXY default

• Mirrors the README snippet updates: required ADMIN_PASSWORD and DB/POSTGRES password variables and TRUST_PROXY defaulting to false. Keeps documentation consistent with current compose behavior from #7907.

doc/docker.md

Other (2) +14 / -0

.env.defaultDocument required admin password and TRUST_PROXY default/usage +10/-0

Document required admin password and TRUST_PROXY default/usage

• Adds explicit guidance that DOCKER_COMPOSE_APP_ADMIN_PASSWORD is required and compose will refuse to start if empty. Documents DOCKER_COMPOSE_APP_TRUST_PROXY defaulting to false and explains when it must be enabled behind a trusted reverse proxy.

.env.default

.env.dev.defaultAdd dev TRUST_PROXY variable documentation +4/-0

Add dev TRUST_PROXY variable documentation

• Documents DOCKER_COMPOSE_APP_DEV_ENV_TRUST_PROXY and notes the dev compose default is true for convenience. Adds guidance to disable it when not behind a reverse proxy.

.env.dev.default

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[qodo-free-for-open-source-projects]

Code Review by Qodo

New Review Started

This review has been superseded by a new analysis

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review