docs(docker): Restructure deployment guide and add env var reference #1361
Labels
No labels
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
Wont fix
old/ci/cd
old/rust
No milestone
No project
No assignees
5 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
continuwuation/continuwuity!1361
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "tcpipuk/docker-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
To fix #1360, add Quick Run section with complete getting-started workflow including admin user creation via --execute flag. Consolidate Docker Compose to treat reverse proxy as essential with Traefik/Caddy/nginx examples.
Move detailed image building to development guide, keeping deployment docs focused on using pre-built images.
Create environment variables reference with practical examples and context. Clarify built-in TLS is for testing only; production should use reverse proxies.
Preview:
@ -57,3 +69,1 @@If you just want to test Continuwuity for a short time, you can use the `--rm`flag, which cleans up everything related to your container after you stopit.Replace `matrix.example.com` with your actual server name.and admin with your preferred username
@ -60,0 +97,4 @@volume mount)- `CONTINUWUITY_ADDRESS` - Bind address (use `0.0.0.0` to listen on allinterfaces)- `CONTINUWUITY_ALLOW_REGISTRATION` - Set to `false` to prevent openuh to prevent any registration
I've clarified this, and added a note about reg tokens
@ -64,1 +109,3 @@of the provided `docker-compose` files.Docker Compose is the recommended deployment method for Continuwuity with areverse proxy. These examples include both Continuwuity and a reverse proxyconfigured for Matrix federation.style: I feel like some of these paragraphs could be more consise in the context of the guide? feels a bit repetitive to be saying "Continuwuity and a reverse proxy" again
I've tightened up a few bits including this!
@ -69,0 +115,4 @@For Matrix federation to work, you need to serve `.well-known/matrix/client` and`.well-known/matrix/server` endpoints. You can achieve this either by:1. **Using a well-known service** (recommended for Traefik) - The compose filesa rule like
traefik.http.routers.conduwuit-testing.rule=(Host(matrix.pissing.dev) || (Host(pissing.dev) && PathPrefix(/.well-known/matrix)))is by far the easiest for traefikI accidentally stripped this out when rearranging, have re-added a clean example again!
@ -101,0 +179,4 @@Before running, create the Caddy network:```bashdocker network create caddyDoes compose not do this automatically?
caddy-docker-proxyrequires an external network that it watches for containers joining. The network needs to exist before you start the compose stack.@ -60,3 +61,1 @@or remove default features; or define all the features in one central workspacecrate that propagate down/up to the other workspace crates. It is a Cargo pitfall,and we'd like to see better developer UX in Rust's Workspaces.The rationale for this is due to Rust / Cargo not supporting ["workspace levelfwiw all these line wraps are causing a bit of diff noise and might mess up the blame a bit
I'm also massively rearranging the file, so I figured there's not much point preserving the exact whitespace here?
fa31f02ef8ad19a9085cad19a9085c2d70c25f202d70c25f20c57c97fad1c57c97fad1cac1c9a352cac1c9a3524fa67b33a6WIP: docs(docker): Restructure deployment guide and add env var referenceto docs(docker): Restructure deployment guide and add env var reference@Jade you are now allowed to review, thank you 😊
I've made a change to the "For existing Traefik setup" example after feedback from River in #COT because the /etc/resolv.conf line caused them trouble - it makes more sense to me to just add a callout underneath.
The deploy preview at https://tcpipuk-docker-docs.continuwuity.pages.dev/reference/environment-variables doesn't seem to have the page coming up in the sidebar at all
Only slight changes. I kind of want to make a lil thing that converts TOML to env vars rather than having all the examples on the env variable guide, but that's way out of scope lol.
@ -62,3 +109,2 @@If the `docker run` command is not suitable for you or your setup, you can also use oneof the provided `docker-compose` files.Docker Compose is the recommended deployment method. These examples includeWe suggest using Docker Compse to help manage your containers
Isn't that what it says? 😕
@ -74,9 +164,17 @@ Depending on your proxy setup, you can use one of the following files:```**Note:** If you need Continuwuity to use your host's DNS resolver instead ofyou can use
suntax to make this pop a bit more.
Should also probably mention why you would want to do that
Also, given it applies to all the compose files, it should probably not be hidden in the collapsed details for one of them
@ -0,0 +3,4 @@Continuwuity can be configured entirely through environment variables, making itideal for containerised deployments and infrastructure-as-code scenarios.This is a convenience reference and may not be exhaustive. TheGiven it's not meant to be exhastive, why not call it a guide?
It doesn't read like a guide to me? I figured a guide would just be the intro about how config options are converted to underscores... I wanted this to be a reference, it's just difficult to ensure it always contains 100% of options, so I clarified that it's there for convenience.
@ -69,0 +141,4 @@services:continuwuity:image: forgejo.ellis.link/continuwuation/continuwuity:latestcommand: --execute "users create-user admin"Hi, I just registered, since I am currently setting continuwuity up via docker compose myself I stumbled across this pr.
This doesn't work since the docker image doesn't have an explicit entry point set so it defaults to bash, instead it should be something like this:
maybe this can be set in the actual Dockerfile instead?
This could probably be fixed by modifying the dockerfile, to aboid having to add config everywhere else. Would be a quick fix
4fa67b33a6612cdc55b3612cdc55b347e661b4ddI think the Configuration Basics should also be edited to include the env var page, with updated env vars too
47e661b4dd5a44f3e5e4Seems like this is blocked until @Jade's requested changes are done. Do you mind unblocking it? Or we can continue on this unmerged PR
I think docs for the new initial registration token flow is needed