feat: use nginx proxy, config for public rooms (fedi)

See #38.

.env.sample

@@ -1,21 +1,21 @@
 TYPE=matrix-synapse
 DOMAIN=matrix-synapse.example.com
-TIMEOUT=300
-ENABLE_AUTO_UPDATE=true
+#TIMEOUT=300
+#ENABLE_AUTO_UPDATE=true
 LETS_ENCRYPT_ENV=production
 COMPOSE_FILE="compose.yml"
 # POST_DEPLOY_CMDS="db set_admin"
 
 ## Admin details
 
-SYNAPSE_ADMIN_EMAIL=admin@example.com
+ADMIN_EMAIL=admin@example.com
 
 ## Secrets
 
 SECRET_DB_PASSWORD_VERSION=v1
 SECRET_FORM_SECRET_VERSION=v1
-SECRET_MACAROON_SECRET_KEY_VERSION=v1
-SECRET_REGISTRATION_SHARED_SECRET_VERSION=v1
+SECRET_MACAROON_VERSION=v1
+SECRET_REGISTRATION_VERSION=v1
 
 ## Federation
 
@@ -24,6 +24,8 @@ SECRET_REGISTRATION_SHARED_SECRET_VERSION=v1
 # Set "true" to enable federation endpoint on $DOMAIN/.well-known/matrix/server
 SERVE_SERVER_WELLKNOWN=false
 
+ALLOW_PUBLIC_ROOMS_FEDERATION=false
+
 ## Registration
 
 ENABLE_REGISTRATION=false

abra.sh

@@ -1,10 +1,13 @@
 export DISCORD_BRIDGE_YAML_VERSION=v2
 export ENTRYPOINT_CONF_VERSION=v1
-export HOMESERVER_YAML_VERSION=v23
+export HOMESERVER_YAML_VERSION=v24
 export LOG_CONFIG_VERSION=v2
 export SHARED_SECRET_AUTH_VERSION=v1
 export SIGNAL_BRIDGE_YAML_VERSION=v4
 export TELEGRAM_BRIDGE_YAML_VERSION=v6
+export NGINX_CONFIG_VERSION=v4
+export WK_SERVER_VERSION=v1
+export WK_CLIENT_VERSION=v1
 
 set_admin () {
     admin=akadmin

compose.discord.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - APP_SERVICES_ENABLED
       - APP_SERVICE_CONFIGS

compose.keycloak.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret

compose.keycloak2.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - keycloak2_client_secret
     environment:

compose.keycloak3.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - keycloak3_client_secret
     environment:

compose.shared_secret_auth.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - SHARED_SECRET_AUTH_ENABLED
     secrets:

compose.signal.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - APP_SERVICES_ENABLED
       - APP_SERVICE_CONFIGS

compose.smtp.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret

compose.telegram.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - APP_SERVICES_ENABLED
       - APP_SERVICE_CONFIGS
@@ -10,7 +10,7 @@ services:
       - telegram-data:/telegram-data
 
   telegrambridge:
-    image: dock.mau.dev/mautrix/telegram:v0.14.0
+    image: dock.mau.dev/mautrix/telegram:v0.14.2
     depends_on:
       - telegramdb
     configs:

compose.turn.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret

compose.yml

@@ -3,11 +3,40 @@ version: "3.8"
 
 services:
   app:
-    image: "matrixdotorg/synapse:v1.87.0"
+    image: nginx:1.23.3
+    networks:
+      - proxy
+      - internal
+    environment:
+      - STACK_NAME
+    configs:
+      - source: nginx_config
+        target: /etc/nginx/nginx.conf
+      - source: wk_server
+        target: /var/www/.well-known/matrix/server
+      - source: wk_client
+        target: /var/www/.well-known/matrix/client
+    deploy:
+      restart_policy:
+        condition: on-failure
+      labels:
+        - "traefik.enable=true"
+        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=80"
+        - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
+        - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
+        - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
+        - "coop-cloud.${STACK_NAME}.version=5.0.0+v1.93.0"
+        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
+    healthcheck:
+      test: curl -f http://synapse:8008/health || exit 1
+      interval: 5s
+      timeout: 3s
+      retries: 20
+
+  synapse:
+    image: "matrixdotorg/synapse:v1.93.0"
     volumes:
       - "data:/data"
-    depends_on:
-      - db
     secrets:
       - db_password
       - registration_shared_secret
@@ -15,6 +44,7 @@ services:
       - form_secret
     environment:
       - ALLOWED_LIFETIME_MAX
+      - ALLOW_PUBLIC_ROOMS_FEDERATION
       - AUTO_JOIN_ROOM
       - AUTO_JOIN_ROOM_ENABLED
       - DISABLE_FEDERATION
@@ -41,7 +71,6 @@ services:
       - VIRTUAL_HOST=${DOMAIN}
       - VIRTUAL_PORT=8008
     networks:
-      - proxy
       - internal
     entrypoint: /docker-entrypoint.sh
     configs:
@@ -52,17 +81,6 @@ services:
       - source: entrypoint_conf
         target: /docker-entrypoint.sh
         mode: 0555
-    deploy:
-      restart_policy:
-        condition: on-failure
-      labels:
-        - "traefik.enable=true"
-        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=8008"
-        - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
-        - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
-        - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
-        - "coop-cloud.${STACK_NAME}.version=3.9.1+v1.87.0"
-        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8008/health"]
       interval: 30s
@@ -121,6 +139,18 @@ configs:
     name: ${STACK_NAME}_log_config_${LOG_CONFIG_VERSION}
     file: log.config.tmpl
     template_driver: golang
+  nginx_config:
+    name: ${STACK_NAME}_nginx_config_${NGINX_CONFIG_VERSION}
+    file: nginx.conf.tmpl
+    template_driver: golang
+  wk_server:
+    name: ${STACK_NAME}_wk_server_${WK_SERVER_VERSION}
+    file: well_known_server.conf.tmpl
+    template_driver: golang
+  wk_client:
+    name: ${STACK_NAME}_wk_client_${WK_CLIENT_VERSION}
+    file: well_known_client.conf.tmpl
+    template_driver: golang
 
 secrets:
   db_password:
@@ -128,10 +158,10 @@ secrets:
     name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
   registration_shared_secret:
     external: true
-    name: ${STACK_NAME}_db_password_${SECRET_REGISTRATION_SHARED_SECRET_VERSION}
+    name: ${STACK_NAME}_registration_${SECRET_REGISTRATION_VERSION}
   macaroon_secret_key:
     external: true
-    name: ${STACK_NAME}_db_password_${SECRET_MACAROON_SECRET_KEY_VERSION}
+    name: ${STACK_NAME}_macaroon_${SECRET_MACAROON_VERSION}
   form_secret:
     external: true
-    name: ${STACK_NAME}_db_password_${SECRET_FORM_SECRET_VERSION}
+    name: ${STACK_NAME}_form_secret_${SECRET_FORM_SECRET_VERSION}

homeserver.yaml.tmpl

@@ -78,7 +78,7 @@ allow_public_rooms_without_auth: false
 # If set to 'true', allows any other homeserver to fetch the server's public
 # rooms directory via federation. Defaults to 'false'.
 #
-allow_public_rooms_over_federation: false
+allow_public_rooms_over_federation: {{ env "ALLOW_PUBLIC_ROOMS_FEDERATION" }}
 
 listeners:
   # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy

nginx.conf.tmpl

@@ -0,0 +1,31 @@
+user www-data;
+
+events {
+  worker_connections 768;
+}
+
+http {
+  server {
+    listen 80;
+
+    access_log off;
+    error_log /dev/null;
+
+    server_name {{ env "DOMAIN" }};
+
+    location ~* ^(\/_matrix|\/_synapse\/client) {
+      proxy_pass http://{{ env "STACK_NAME"}}_synapse:8008;
+      proxy_set_header X-Forwarded-For $remote_addr;
+      proxy_set_header X-Forwarded-Proto $scheme;
+      proxy_set_header Host $host;
+      client_max_body_size 50M;
+      proxy_http_version 1.1;
+    }
+
+    location /.well-known/matrix/ {
+      root /var/www/;
+      default_type application/json;
+      add_header Access-Control-Allow-Origin  *;
+    }
+  }
+}

release/4.0.0+v1.93.0

@@ -0,0 +1,8 @@
+We had to rename some secrets: https://git.coopcloud.tech/coop-cloud/matrix-synapse/issues/35
+
+Copy the secrets:
+
+* `registration_shared_secret` to `registration`
+* `macaroon_secret_key` to `macaroon`
+
+Regeneration of these secrets should also work.

release/5.0.0+v1.93.0

@@ -0,0 +1,17 @@
+An Nginx proxy has been configured as the entrypoint for Synapse. This is not
+optional. This is done to counteract IP collection in Synapse itself. See more:
+
+!!! You MUST undeploy your Synapse install before upgrading to this version !!!
+
+This is because there have been a service rename in the recipe configuration:
+
+* `app` -> `synapse`
+
+This could break stuff in the recipe, so please report issues if you run into
+anything!
+
+    https://git.coopcloud.tech/coop-cloud/matrix-synapse/issues/38
+
+Thanks!
+
+-- d1

well_known_client.conf.tmpl

@@ -0,0 +1,5 @@
+{
+  "m.homeserver": {
+    "base_url": "https://{{ env "DOMAIN" }}"
+  }
+}

well_known_server.conf.tmpl

@@ -0,0 +1,3 @@
+{
+  "m.server": "{{ env "DOMAIN" }}:443"
+}