From 6a8850b55696a03fc120ea4fcb9301a77ab63d40 Mon Sep 17 00:00:00 2001 From: stratself Date: Sun, 29 Mar 2026 09:48:10 +0000 Subject: [PATCH] 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 --- docs/deploying/docker.mdx | 149 +++++++++--------- .../deploying/docker-compose.for-traefik.yml | 0 .../deploying/docker-compose.override.yml | 0 .../docker-compose.with-caddy-labels.yml | 0 .../deploying/docker-compose.with-caddy.yml | 0 .../deploying/docker-compose.with-traefik.yml | 0 .../{ => public}/deploying/docker-compose.yml | 0 7 files changed, 71 insertions(+), 78 deletions(-) rename docs/{ => public}/deploying/docker-compose.for-traefik.yml (100%) rename docs/{ => public}/deploying/docker-compose.override.yml (100%) rename docs/{ => public}/deploying/docker-compose.with-caddy-labels.yml (100%) rename docs/{ => public}/deploying/docker-compose.with-caddy.yml (100%) rename docs/{ => public}/deploying/docker-compose.with-traefik.yml (100%) rename docs/{ => public}/deploying/docker-compose.yml (100%) diff --git a/docs/deploying/docker.mdx b/docs/deploying/docker.mdx index 6b63561dc..4e38b4f1c 100644 --- a/docs/deploying/docker.mdx +++ b/docs/deploying/docker.mdx @@ -6,12 +6,12 @@ The following OCI images are available for Continuwuity: -| Registry | Image | Notes | -| ---------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| Forgejo Registry | [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. (recommended) | -| Forgejo Registry | [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. | -| Forgejo Registry | [https://forgejo.ellis.link/continuwuation/continuwuity:**latest-maxperf**][latest-maxperf] | Latest tagged release, [performance optimised version](./generic.mdx#performance-optimised-builds). | -| Forgejo Registry | [https://forgejo.ellis.link/continuwuation/continuwuity:**main-maxperf**][main-maxperf] | Latest `main` branch commit, [performance optimised version](./generic.mdx#performance-optimised-builds). | +| Image | Notes | +| ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. (recommended) | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest-maxperf**][latest-maxperf] | Latest tagged release, [performance optimised version](./generic.mdx#performance-optimised-builds). | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**main-maxperf**][main-maxperf] | Latest `main` branch commit, [performance optimised version](./generic.mdx#performance-optimised-builds). | [latest]: https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/latest [main]: https://forgejo.ellis.link/continuwuation/-/packages/container/continuwuity/main @@ -39,64 +39,52 @@ Continuwuity requires HTTPS for Matrix federation. You'll need: - A domain name pointing to your server's IP address - we will be using `example.com` in this guide. - A reverse proxy with SSL/TLS certificates (Traefik, Caddy, nginx, etc.) - see [Docker Compose](#docker-compose) for complete examples. -- Port `:443` and `:8448` opened on your server's firewall. +- Port `:443` (for Client-Server traffic) and `:8448` (for federation traffic) opened on your server's firewall. :::tip Alternative setups -For other deployment options such as serving `.well-known` files, consult the [Delegation/Split-domain](../advanced/delegation) page. +For setups with `.well-known` delegation, different ports, and/or split-domain deployments, consult the [Delegation/Split-domain](../advanced/delegation) page. ::: ## Docker - Quick Run Get a working Continuwuity server with an admin user in four steps: -### Environment Variables +1. Pull the image -- `CONTINUWUITY_SERVER_NAME` - Your Matrix server's domain name -- `CONTINUWUITY_DATABASE_PATH` - Where to store your database (must match the volume mount) -- `CONTINUWUITY_ADDRESS` - Bind address (use `0.0.0.0` to listen on all interfaces) + ```bash + docker pull forgejo.ellis.link/continuwuation/continuwuity:latest + ``` -For a list of all config options, see the [reference configuration](../reference/config) page +2. Start the server with initial admin user -### 1. Pull the image + ```bash + docker run -d \ + -p 6167:6167 \ + -v continuwuity_db:/var/lib/continuwuity \ + -e CONTINUWUITY_SERVER_NAME="matrix.example.com" \ + -e CONTINUWUITY_DATABASE_PATH="/var/lib/continuwuity" \ + -e CONTINUWUITY_ADDRESS="0.0.0.0" \ + -e CONTINUWUITY_ALLOW_REGISTRATION="false" \ + --name continuwuity \ + forgejo.ellis.link/continuwuation/continuwuity:latest \ + /sbin/conduwuit --execute "users create-user admin" + ``` -```bash -docker pull forgejo.ellis.link/continuwuation/continuwuity:latest -``` + Replace `matrix.example.com` with your actual server name and `admin` with your preferred username. -### 2. Start the server with initial admin user +3. Get your admin password -```bash -docker run -d \ - -p 6167:6167 \ - -v continuwuity_db:/var/lib/continuwuity \ - -e CONTINUWUITY_SERVER_NAME="matrix.example.com" \ - -e CONTINUWUITY_DATABASE_PATH="/var/lib/continuwuity" \ - -e CONTINUWUITY_ADDRESS="0.0.0.0" \ - -e CONTINUWUITY_ALLOW_REGISTRATION="false" \ - --name continuwuity \ - forgejo.ellis.link/continuwuation/continuwuity:latest \ - /sbin/conduwuit --execute "users create-user admin" -``` + ```bash + docker logs continuwuity 2>&1 | grep "Created user" + ``` -Replace `matrix.example.com` with your actual server name and `admin` with -your preferred username. + You'll see output like: -### 3. Get your admin password + ``` + Created user with user_id: @admin:matrix.example.com and password: `[auto-generated-password]` + ``` -```bash -docker logs continuwuity 2>&1 | grep "Created user" -``` - -You'll see output like: - -``` -Created user with user_id: @admin:matrix.example.com and password: `[auto-generated-password]` -``` - -### 4. Configure your reverse proxy - -Configure your reverse proxy to forward HTTPS traffic to Continuwuity. See -[Docker Compose](#docker-compose) for examples. +4. Configure your reverse proxy to forward HTTPS traffic to Continuwuity. See [Docker Compose](#docker-compose) for examples. Once configured, log in with any Matrix client using `@admin:matrix.example.com` and the generated password. You'll automatically be invited to the admin room @@ -104,10 +92,15 @@ where you can manage your server. ## Docker Compose -Docker Compose is the recommended deployment method. These examples include -reverse proxy configurations for Matrix federation. +Docker Compose is the recommended deployment method for Continuwuity containers. The following environment variables will be set: -This routes your Matrix domain and well-known paths to Continuwuity. +- `CONTINUWUITY_SERVER_NAME` - Your Matrix server's domain name. +- `CONTINUWUITY_DATABASE_PATH` - Where to store your database. This must match the docker volume mount. +- `CONTINUWUITY_ADDRESS` - Bind address (use `0.0.0.0` to listen on all interfaces). + +Alternatively, you can specify a path to mount the configuration file using the `CONTINUWUITY_CONFIG` environment variable. + +See the [reference configuration](../reference/config) page for all config options, and the [Configuration page](../configuration#environment-variables) on how to convert them into Environment Variables. ### Creating Your First Admin User @@ -130,7 +123,7 @@ docker compose logs continuwuity | grep "Created user" ### Choose Your Reverse Proxy -Select the compose file that matches your setup: +These examples include reverse proxy configurations for Matrix federation, which will route your Matrix domain (and optionally .well-known paths) to Continuwuity. :::note DNS Performance Docker's default DNS resolver can cause performance issues with Matrix @@ -147,45 +140,56 @@ See [Troubleshooting - DNS Issues](../troubleshooting.mdx#potential-dns-issues-w for more details and alternative solutions. ::: -#### With Caddy (using Caddyfile) +#### Caddy (using Caddyfile)
-docker-compose.with-caddy.yml +docker-compose.with-caddy.yml ([view raw](./docker-compose.with-caddy.yml)) -```yaml file="./docker-compose.with-caddy.yml" +```yaml file="../public/deploying/docker-compose.with-caddy.yml" ```
-#### With Caddy (using labels) +#### Caddy (using labels)
-docker-compose.with-caddy-labels.yml +docker-compose.with-caddy-labels.yml ([view raw](./docker-compose.with-caddy-labels.yml)) -```yaml file="./docker-compose.with-caddy-labels.yml" +```yaml file="../public/deploying/docker-compose.with-caddy-labels.yml" ```
-#### For existing Traefik setup +#### Traefik (for existing setup)
-docker-compose.for-traefik.yml +docker-compose.for-traefik.yml ([view raw](./docker-compose.for-traefik.yml)) -```yaml file="./docker-compose.for-traefik.yml" +```yaml file="../public/deploying/docker-compose.for-traefik.yml" ```
-#### With Traefik included +#### Traefik included
-docker-compose.with-traefik.yml +docker-compose.with-traefik.yml ([view raw](./docker-compose.with-traefik.yml)) -```yaml file="./docker-compose.with-traefik.yml" +```yaml file="../public/deploying/docker-compose.with-traefik.yml" + +``` + +
+ +#### Traefik (as override file) + +
+docker-compose.override.yml ([view raw](./docker-compose.override.yml)) + +```yaml file="../public/deploying/docker-compose.override.yml" ``` @@ -194,27 +198,16 @@ for more details and alternative solutions. #### For other reverse proxies
-docker-compose.yml +docker-compose.yml ([view raw](./docker-compose.yml)) -```yaml file="./docker-compose.yml" +```yaml file="../public/deploying/docker-compose.yml" ``` +
+ You will then need to point your reverse proxy towards Continuwuity at `127.0.0.1:8008` -
- -#### Override file for customisation - -
-docker-compose.override.yml - -```yaml file="./docker-compose.override.yml" - -``` - -
- ### Starting Your Server 1. Choose your compose file and rename it to `docker-compose.yml` diff --git a/docs/deploying/docker-compose.for-traefik.yml b/docs/public/deploying/docker-compose.for-traefik.yml similarity index 100% rename from docs/deploying/docker-compose.for-traefik.yml rename to docs/public/deploying/docker-compose.for-traefik.yml diff --git a/docs/deploying/docker-compose.override.yml b/docs/public/deploying/docker-compose.override.yml similarity index 100% rename from docs/deploying/docker-compose.override.yml rename to docs/public/deploying/docker-compose.override.yml diff --git a/docs/deploying/docker-compose.with-caddy-labels.yml b/docs/public/deploying/docker-compose.with-caddy-labels.yml similarity index 100% rename from docs/deploying/docker-compose.with-caddy-labels.yml rename to docs/public/deploying/docker-compose.with-caddy-labels.yml diff --git a/docs/deploying/docker-compose.with-caddy.yml b/docs/public/deploying/docker-compose.with-caddy.yml similarity index 100% rename from docs/deploying/docker-compose.with-caddy.yml rename to docs/public/deploying/docker-compose.with-caddy.yml diff --git a/docs/deploying/docker-compose.with-traefik.yml b/docs/public/deploying/docker-compose.with-traefik.yml similarity index 100% rename from docs/deploying/docker-compose.with-traefik.yml rename to docs/public/deploying/docker-compose.with-traefik.yml diff --git a/docs/deploying/docker-compose.yml b/docs/public/deploying/docker-compose.yml similarity index 100% rename from docs/deploying/docker-compose.yml rename to docs/public/deploying/docker-compose.yml