docs(docker): Big refactor with better structuring, simplified examples, and other improvements #1594

Merged
Jade merged 17 commits from stratself/continuwuity:stratself/docs-docker-improvements into main 2026-04-13 17:34:36 +00:00

17 commits

Author SHA1 Message Date
807e7d4665 docs(docker): New "Other" section and move Docker section there
All checks were successful
Check Changelog / Check for changelog (pull_request_target) Successful in 8s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 10m12s
* Also add warning that server name cannot be changed
* Some other copyediting
2026-04-11 15:54:12 +00:00
36a22f9ac7 docs(docker,delegation): revert delegation changes, small wording fixes 2026-04-11 15:54:12 +00:00
493de65c0f docs(docker,delegation): Fix .well-known docs - check below for details
.well-known env var in example composes now point to `example.com:443`,
and are turned on by default for Caddy labels and the Traefik configs.
For the Caddyfile example, they're left uncommented. Added small
bulletpoint on how to use this env var. Consistencize all the
.well-known comments inside these composes.

I don't want to overly fix the example composes and get it wrong, so
this small change should be enough. Split-domain deployments are fully
outsourced to the Delegation page now, and some changes are also made
there to be more comprehensive.
2026-04-11 15:54:12 +00:00
155512745e docs(docker): Revert to mounting /etc/resolv.conf as configs: won't work
* Fix wording to make mounting resolv.conf more imperative
* Linting and other changes
2026-04-11 15:54:12 +00:00
2825c4d3b4 docs(docker): Update links for DNS tuning guide 2026-04-11 15:54:12 +00:00
5c9739b801 fix(docs): exclude local .yml URLs from dead link checking 2026-04-11 15:54:11 +00:00
d52ef9fbfb chore: Add changelog for #1594 2026-04-11 15:54:11 +00:00
2a55612d5d docs(docker): Rewrite Docker DNS workaround with custom resolv.conf
Instead of /etc/resolv.conf on host. This works around the
systemd-resolved footgunning issue and provide an inline way to
configure resolvers, separate from that of the host system.
2026-04-11 15:54:11 +00:00
3eac48f9c8 docs(docker): Document the new initial registration flow
* Also add a note disclaiming that Docker is for demo purposes only
* Use port 8008 for Docker Quick Run instructions
* Remove the steps to create first admin user

I do believe "Docker - Quick Run" should be moved to after Docker
Compose section, but will want to discuss this before advancing
2026-04-11 15:54:11 +00:00
cb5d12b231 docs(docker): Make example ymls raw-viewable and other copyedit fixes
* Move all *.yml files to docs/public/deploying so they can be viewable
  as raw files on the webpage
* Link to those files with "(view raw)"
* Move minimal environment variables to Docker Compose section
* Unheading the Docker Quick Run stuff to prepare deprioritizing them
* Remove redundant Registry column in Image table
* Rename reverse proxy subsections to have software name as first word
2026-04-11 15:54:11 +00:00
b3105a4bb8 docs(docker): Remove dynamic.yml file and related config lines
The file defines an HSTS middleware and cipher suite prefs, which
should not be needed for a simple deployment
2026-04-11 15:54:11 +00:00
0ec61ec44c docs(docker): Add Caddy via Caddyfile deployment and prioritise them
* Add compose and included Caddyfile using caddy:latest official image
* Rename old Caddy files as caddy-labels.yml and new one as caddy.yml
* Remove external: true network in caddy-labels.yml to simplify docs
* Move all Caddy selections to top, unprioritize Traefik and other RPs
2026-04-11 15:54:11 +00:00
18fdf24a54 docs(docker): Consistencize all domains to example.com and port to 8008
Included some additional comments. .well-known Delegation seems to be
much more convenient for traefik + caddy. How they're documented can be
decided in a future commit.
2026-04-11 15:54:10 +00:00
2201af23bb docs(docker): Remove unnecessary parts from all current compose files
* Remove unnecessary c10y env vars
* Remove unnecessary comment about image build and vim
* Remove references to Element-Web

Other changes like unified port and domain names will be in a future
commit
2026-04-11 15:54:10 +00:00
02a36d5e86 docs(docker): Merge Prerequisites and Images into "Preparation" section
* docs: Remove Matrix Federation Requirements for simpler deployments
* docs: Remove redundant env vars in Docker - Quick Run
2026-04-11 15:54:10 +00:00
84a43d8e5a docs(docker): Upsection headings by one level
* docs: "Docker - Quick Run" and "Docker Compose" are now two top-level
  sections
* docs: Mark building your images as "(Optional)"
* docs: Move calls to "Next step" section
2026-04-11 15:54:10 +00:00
b303957fcf docs(docker): Rework section on available images
* docs: Make "Available Images" a top-level option, to be followed by
  Docker and Docker Compose sections in a future commit
* docs: Make "Mirrors" a subsection of "Available images", and add
  links to the mirrors themselves
* docs: Use indirect linkages to URLs for better maintainability
* docs: Remove initial sentence and its reference to the (advanced)
  building your image flow
* docs: Recommend `latest` OCI tag and include link to
2026-04-11 15:54:10 +00:00