Skip to content

docs: simplify README and add Docker Compose + Traefik setup - #4

Merged
Bpoe merged 2 commits into
mainfrom
docs/shorten-readme-compose-traefik
Nov 1, 2026
Merged

Bpoe merged 2 commits into
mainfrom
docs/shorten-readme-compose-traefik

Conversation

@Bpoe

@Bpoe Bpoe commented Nov 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replace the implementation-heavy README with a short introduction and Docker Compose quick start.
  • Document explicit SQLite migrations and the /admin UI.
  • Add copy-paste Traefik and Indirection Compose examples for automatic Let's Encrypt TLS, hostname labels, and a shared Docker network.
  • Explain API key configuration using Docker secrets (shell environment or file) and an optional .env approach.
  • Link to docs/design.md for the architecture details.

Notes

  • Documentation-only change; the existing standalone compose.yaml is unchanged.
  • The Traefik example does not publish Indirection's HTTP port and includes permissions for the non-root container user.
  • Examples were reviewed against the repo's current Compose, runtime configuration, and Docker/Traefik documentation, but not executed in a Docker runtime.

@Bpoe
Bpoe merged commit 88d1aa1 into main Nov 1, 2026
3 checks passed
@Bpoe
Bpoe deleted the docs/shorten-readme-compose-traefik branch November 1, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant