From aa53b01b696177a233260babcfb4b2fd332cb017 Mon Sep 17 00:00:00 2001 From: stratself Date: Sat, 28 Mar 2026 09:22:40 +0000 Subject: [PATCH] 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. --- docs/deploying/docker-compose.for-traefik.yml | 10 +++++----- docs/deploying/docker-compose.override.yml | 8 +++++--- docs/deploying/docker-compose.with-caddy.yml | 6 +++--- docs/deploying/docker-compose.with-traefik.yml | 10 +++++----- docs/deploying/docker-compose.yml | 6 +++--- docs/deploying/docker.mdx | 2 ++ 6 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/deploying/docker-compose.for-traefik.yml b/docs/deploying/docker-compose.for-traefik.yml index b4f52d33e..9878bf07a 100644 --- a/docs/deploying/docker-compose.for-traefik.yml +++ b/docs/deploying/docker-compose.for-traefik.yml @@ -16,14 +16,14 @@ services: - "traefik.http.routers.continuwuity.entrypoints=websecure" # your HTTPS entry point - "traefik.http.routers.continuwuity.tls=true" - "traefik.http.routers.continuwuity.service=continuwuity" - - "traefik.http.services.continuwuity.loadbalancer.server.port=6167" + - "traefik.http.services.continuwuity.loadbalancer.server.port=8008" # possibly, depending on your config: # - "traefik.http.routers.continuwuity.tls.certresolver=letsencrypt" environment: - CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS + CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity CONTINUWUITY_ADDRESS: 0.0.0.0 - CONTINUWUITY_PORT: 6167 # should match the loadbalancer traefik label + CONTINUWUITY_PORT: 8008 # This must match with traefik's loadbalancer label #CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above # We need some way to serve the client and server .well-known json. The simplest way is via the CONTINUWUITY_WELL_KNOWN @@ -31,8 +31,8 @@ services: # see the override file for more information about delegation CONTINUWUITY_WELL_KNOWN: | { - client=https://your.server.name.example, - server=your.server.name.example:443 + client=https://matrix.example.com, + server=matrix.example.com:443 } #cpuset: "0-4" # Uncomment to limit to specific CPU cores ulimits: # Continuwuity uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it diff --git a/docs/deploying/docker-compose.override.yml b/docs/deploying/docker-compose.override.yml index 1997d3e4d..3e4dabfb7 100644 --- a/docs/deploying/docker-compose.override.yml +++ b/docs/deploying/docker-compose.override.yml @@ -6,11 +6,13 @@ services: - "traefik.enable=true" - "traefik.docker.network=proxy" # Change this to the name of your Traefik docker proxy network - - "traefik.http.routers.to-continuwuity.rule=Host(`.`)" # Change to the address on which Continuwuity is hosted + - "traefik.http.routers.to-continuwuity.rule=Host(`matrix.example.com`)" # Change to the address on which Continuwuity is hosted - "traefik.http.routers.to-continuwuity.tls=true" - "traefik.http.routers.to-continuwuity.tls.certresolver=letsencrypt" - "traefik.http.routers.to-continuwuity.middlewares=cors-headers@docker" - - "traefik.http.services.to_continuwuity.loadbalancer.server.port=6167" + + # This must match with CONTINUWUITY_PORT (default: 8008) + - "traefik.http.services.to_continuwuity.loadbalancer.server.port=8008" - "traefik.http.middlewares.cors-headers.headers.accessControlAllowOriginList=*" - "traefik.http.middlewares.cors-headers.headers.accessControlAllowHeaders=Origin, X-Requested-With, Content-Type, Accept, Authorization" @@ -18,7 +20,7 @@ services: # If you want to have your account on , but host Continuwuity on a subdomain, # you can let it only handle the well known file on that domain instead - #- "traefik.http.routers.to-matrix-wellknown.rule=Host(``) && PathPrefix(`/.well-known/matrix`)" + #- "traefik.http.routers.to-matrix-wellknown.rule=Host(`example.com`) && PathPrefix(`/.well-known/matrix`)" #- "traefik.http.routers.to-matrix-wellknown.tls=true" #- "traefik.http.routers.to-matrix-wellknown.tls.certresolver=letsencrypt" #- "traefik.http.routers.to-matrix-wellknown.middlewares=cors-headers@docker" diff --git a/docs/deploying/docker-compose.with-caddy.yml b/docs/deploying/docker-compose.with-caddy.yml index 66b7f9dbd..7f11ff604 100644 --- a/docs/deploying/docker-compose.with-caddy.yml +++ b/docs/deploying/docker-compose.with-caddy.yml @@ -16,7 +16,7 @@ services: restart: unless-stopped labels: caddy: example.com - caddy.reverse_proxy: /.well-known/matrix/* homeserver:6167 + caddy.reverse_proxy: /.well-known/matrix/* homeserver:8008 homeserver: image: forgejo.ellis.link/continuwuation/continuwuity:latest @@ -30,7 +30,7 @@ services: CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity CONTINUWUITY_ADDRESS: 0.0.0.0 - CONTINUWUITY_PORT: 6167 + CONTINUWUITY_PORT: 8008 #CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above # Required for .well-known delegation - edit these according to your chosen domain @@ -40,7 +40,7 @@ services: - caddy labels: caddy: matrix.example.com - caddy.reverse_proxy: "{{upstreams 6167}}" + caddy.reverse_proxy: "{{upstreams 8008}}" volumes: db: diff --git a/docs/deploying/docker-compose.with-traefik.yml b/docs/deploying/docker-compose.with-traefik.yml index c4f7b6d78..28985dea4 100644 --- a/docs/deploying/docker-compose.with-traefik.yml +++ b/docs/deploying/docker-compose.with-traefik.yml @@ -16,14 +16,14 @@ services: - "traefik.http.routers.continuwuity.rule=(Host(`matrix.example.com`) || (Host(`example.com`) && PathPrefix(`/.well-known/matrix`)))" - "traefik.http.routers.continuwuity.entrypoints=websecure" - "traefik.http.routers.continuwuity.tls.certresolver=letsencrypt" - - "traefik.http.services.continuwuity.loadbalancer.server.port=6167" + - "traefik.http.services.continuwuity.loadbalancer.server.port=8008" # Uncomment and adjust the following if you want to use middleware # - "traefik.http.routers.continuwuity.middlewares=secureHeaders@file" environment: - CONTINUWUITY_SERVER_NAME: your.server.name.example # EDIT THIS + CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity CONTINUWUITY_ADDRESS: 0.0.0.0 - CONTINUWUITY_PORT: 6167 # you need to match this with the traefik load balancer label if you're want to change it + CONTINUWUITY_PORT: 8008 # This must match with traefik's loadbalancer label #CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above # We need some way to serve the client and server .well-known json. The simplest way is via the CONTINUWUITY_WELL_KNOWN @@ -31,8 +31,8 @@ services: # reverse proxy, but since you do not have a reverse proxy and following this guide, this example is included CONTINUWUITY_WELL_KNOWN: | { - client=https://your.server.name.example, - server=your.server.name.example:443 + client=https://matrix.example.com, + server=matrix.example.com:443 } #cpuset: "0-4" # Uncomment to limit to specific CPU cores ulimits: # Continuwuity uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it diff --git a/docs/deploying/docker-compose.yml b/docs/deploying/docker-compose.yml index 86bdcd2b7..ff472e54c 100644 --- a/docs/deploying/docker-compose.yml +++ b/docs/deploying/docker-compose.yml @@ -6,15 +6,15 @@ services: restart: unless-stopped command: /sbin/conduwuit ports: - - 8448:6167 + - 127.0.0.1:8008:8008 volumes: - db:/var/lib/continuwuity #- ./continuwuity.toml:/etc/continuwuity.toml environment: - CONTINUWUITY_SERVER_NAME: your.server.name # EDIT THIS + CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity CONTINUWUITY_ADDRESS: 0.0.0.0 - CONTINUWUITY_PORT: 6167 + CONTINUWUITY_PORT: 8008 #CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above volumes: diff --git a/docs/deploying/docker.mdx b/docs/deploying/docker.mdx index 821bc00bd..e29151aad 100644 --- a/docs/deploying/docker.mdx +++ b/docs/deploying/docker.mdx @@ -197,6 +197,8 @@ docker network create caddy ``` +You will then need to point your reverse proxy towards Continuwuity at `127.0.0.1:8008` + #### Override file for customisation