chore: publish 5.0.2+v1.93.0 release

Reviewed-on: #40

.drone.yml

@@ -0,0 +1,49 @@
+---
+kind: pipeline
+name: deploy to swarm-test.autonomic.zone
+steps:
+  - name: deployment
+    image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest
+    settings:
+      host: swarm-test.autonomic.zone
+      stack: matrix-synapse
+      generate_secrets: true
+      purge: true
+      deploy_key:
+        from_secret: drone_ssh_swarm_test
+      networks:
+        - proxy
+    environment:
+      DOMAIN: matrix-synapse.swarm-test.autonomic.zone
+      STACK_NAME: matrix-synapse
+      LETS_ENCRYPT_ENV: production
+      DISCORD_BRIDGE_YAML_VERSION: v1
+      ENTRYPOINT_CONF_VERSION: v1
+      HOMESERVER_YAML_VERSION: v17
+      LOG_CONFIG_VERSION: v1
+      SHARED_SECRET_AUTH_VERSION: v1
+      SIGNAL_BRIDGE_YAML_VERSION: v1
+      TELEGRAM_BRIDGE_YAML_VERSION: v1
+      SECRET_DB_PASSWORD_VERSION: v1
+      SECRET_FORM_SECRET_VERSION: v1
+      SECRET_MACAROON_SECRET_KEY_VERSION: v1
+      SECRET_REGISTRATION_SHARED_SECRET_VERSION: v1
+trigger:
+  branch:
+    - main
+---
+kind: pipeline
+name: generate recipe catalogue
+steps:
+  - name: release a new version
+    image: plugins/downstream
+    settings:
+      server: https://build.coopcloud.tech
+      token:
+        from_secret: drone_abra-bot_token
+      fork: true
+      repositories:
+        - coop-cloud/auto-recipes-catalogue-json
+
+trigger:
+  event: tag

.env.sample

@@ -1,35 +1,55 @@
 TYPE=matrix-synapse
-
+DOMAIN=matrix-synapse.example.com
-DOMAIN=matrix.example.com
+TIMEOUT=300
+ENABLE_AUTO_UPDATE=true
 LETS_ENCRYPT_ENV=production
+COMPOSE_FILE="compose.yml"
+# POST_DEPLOY_CMDS="db set_admin"
+
+## Admin details
+
+ADMIN_EMAIL=admin@example.com
+
+## Secrets
 
 SECRET_DB_PASSWORD_VERSION=v1
-
-SYNAPSE_ADMIN_EMAIL=admin@example.com
-
-SECRET_REGISTRATION_SHARED_SECRET_VERSION=v1
-SECRET_MACAROON_SECRET_KEY_VERSION=v1
 SECRET_FORM_SECRET_VERSION=v1
+SECRET_MACAROON_VERSION=v1
+SECRET_REGISTRATION_VERSION=v1
 
-COMPOSE_FILE="compose.yml"
+## Federation
 
 #DISABLE_FEDERATION=1
 
 # 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
 PASSWORD_LOGIN_ENABLED=true
 
+## Room auto-join
+
 #AUTO_JOIN_ROOM_ENABLED=1
 #AUTO_JOIN_ROOM="#example:example.com"
 
+## Logging
+
+# for the homserver
 SQL_LOG_LEVEL=WARN
 ROOT_LOG_LEVEL=WARN
 
-REDACTION_RETENTION_PERIOD=7d
+# for nginx
+NGINX_ACCESS_LOG_LOCATION="/dev/null"
+NGINX_ERROR_LOG_LOCATION="/dev/null"
+# Comment the previous two lines and uncomment these to enable logging
+#NGINX_ACCESS_LOG_LOCATION="/dev/stdout"
+#NGINX_ERROR_LOG_LOCATION="/dev/stderr"
 
-RETENTION_MAX_LIFETIME=4w
+## Privacy
 
 ENABLE_3PID_LOOKUP=true
 
@@ -37,11 +57,24 @@ USER_IPS_MAX_AGE=1d
 
 ENCRYPTED_BY_DEFAULT=all
 
-ALLOWED_LIFETIME_MAX=4w
-
 #ENABLE_ALLOWLIST=1
 #FEDERATION_ALLOWLIST="[]"
 
+# Set these to keyservers you trust - usually the same as your federation allowlist
+#TRUSTED_KEYSERVERS="trusted_key_servers:\n  - server_name: 'example.com'\n  - server_name: 'example2.com'"
+
+## Retention
+
+ALLOWED_LIFETIME_MAX=4w
+
+REDACTION_RETENTION_PERIOD=7d
+RETENTION_MAX_LIFETIME=4w
+
+#MEDIA_RETENTION_LOCAL_LIFETIME=30d
+#MEDIA_RETENTION_REMOTE_LIFETIME=14d
+
+## Keycloak SSO
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.keycloak.yml"
 #KEYCLOAK_ENABLED=1
 #KEYCLOAK_ID=keycloak
@@ -52,23 +85,26 @@ ALLOWED_LIFETIME_MAX=4w
 #KEYCLOAK_ALLOW_EXISTING_USERS=false
 #SECRET_KEYCLOAK_CLIENT_SECRET_VERSION=v1
 
-#COMPOSE_FILE="$COMPOSE_FILE:compose.keycloak2.yml"
+## TURN
-#KEYCLOAK2_ENABLED=1
+
-#KEYCLOAK2_ID=keycloak2
+#COMPOSE_FILE="$COMPOSE_FILE:compose.keycloak3.yml"
-#KEYCLOAK2_NAME=
+#KEYCLOAK3_ENABLED=1
-#KEYCLOAK2_URL=
+#KEYCLOAK3_ID=keycloak3
-#KEYCLOAK2_CLIENT_ID=
+#KEYCLOAK3_NAME=
-#KEYCLOAK2_CLIENT_DOMAIN=
+#KEYCLOAK3_URL=
-#KEYCLOAK2_ALLOW_EXISTING_USERS=false
+#KEYCLOAK3_CLIENT_ID=
-#SECRET_KEYCLOAK2_CLIENT_SECRET_VERSION=v1
+#KEYCLOAK3_CLIENT_DOMAIN=
+#KEYCLOAK3_ALLOW_EXISTING_USERS=false
+#SECRET_KEYCLOAK3_CLIENT_SECRET_VERSION=v1
 
 #COMPOSE_FILE="$COMPOSE_FILE:compose.turn.yml"
 #TURN_ENABLED=1
 #TURN_URIS="[\"turns:coturn.foo.zone?transport=udp\", \"turns:coturn.foo.zone?transport=tcp\"]"
 #TURN_ALLOW_GUESTS=true
-#KEYCLOAK2_ALLOW_EXISTING_USERS=false
 #SECRET_TURN_SHARED_SECRET_VERSION=v1
 
+## SMTP
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.smtp.yml"
 #SMTP_ENABLED=1
 #SMTP_APP_NAME=
@@ -78,9 +114,13 @@ ALLOWED_LIFETIME_MAX=4w
 #SMTP_USER=
 #SECRET_SMTP_PASSWORD_VERSION=v1
 
+## App services
+
 #APP_SERVICES_ENABLED=1
 #APP_SERVICE_CONFIGS="[\"...\"]"
 
+## Telegram bridge
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.telegram.yml"
 #APP_SERVICE_BOT_USERNAME=telegrambot
 #APP_SERVICE_DISPLAY_NAME="Telegram bridge bot"
@@ -90,28 +130,33 @@ ALLOWED_LIFETIME_MAX=4w
 #VERIFY_SSL=false
 #ENABLE_ENCRYPTION=true
 #TELEGRAM_APP_ID=
-#TELEGRAM_BRIDGE_ADMIN_1=
+#TELEGRAM_BRIDGE_PERMISSIONS="{ \"*\": \"relaybot\" }"
-#TELEGRAM_BRIDGE_ADMIN_2=
+#TELEGRAM_SYNC_CHANNEL_MEMBERS=true
 #SECRET_TELEGRAM_DB_PASSWORD_VERSION=v1
 #SECRET_TELEGRAM_API_HASH_VERSION=v1
 #SECRET_TELEGRAM_BOT_TOKEN_VERSION=v1
 #SECRET_TELEGRAM_AS_TOKEN_VERSION=v1
 #SECRET_TELEGRAM_HS_TOKEN_VERSION=v1
 
+## Discord bridge
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.discord.yml"
 #DISCORD_CLIENT_ID=
 #DISCORD_BRIDGE_ADMIN=
 #SECRET_DISCORD_BOT_TOKEN_VERSION=v1
 #SECRET_DISCORD_DB_PASSWORD_VERSION=v1
 
+## Signal bridge
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.signal.yml"
 #SIGNAL_ENABLE_ENCRYPTION=true
-#SIGNAL_BRIDGE_ADMIN_1="@foo:example.com"
+#SIGNAL_BRIDGE_PERMISSIONS="{ \"*\": \"relay\" }"
-#SIGNAL_BRIDGE_ADMIN_2="@bar:example.com"
 #SECRET_SIGNAL_AS_TOKEN_VERSION=v1
 #SECRET_SIGNAL_DB_PASSWORD_VERSION=v1
 #SECRET_SIGNAL_HS_TOKEN_VERSION=v1
 
+## Shared auth
+
 #COMPOSE_FILE="$COMPOSE_FILE:compose.shared_secret_auth.yml"
 #SHARED_SECRET_AUTH_ENABLED=1
 #SECRET_SHARED_SECRET_AUTH_VERSION=v1 # length=128

README.md

@@ -18,73 +18,32 @@
 1. Set up Docker Swarm and [`abra`](https://docs.coopcloud.tech/abra/)
 2. Deploy [`coop-cloud/traefik`](https://git.coopcloud.tech/coop-cloud/traefik)
 3. `abra app new matrix-synapse --secrets` (optionally with `--pass` if you'd like to save secrets in `pass`)
-4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to your Docker swarm box
+4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to your Docker swarm box
-5. `abra app YOURAPPDOMAIN deploy`
+5. `abra app deploy YOURAPPDOMAIN`
-6. Create an initial user: `abra app YOURAPPDOMAIN run app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
+6. Create an initial user: `abra app run YOURAPPDOMAIN app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
 
 ## Tips & Tricks
 
+### Set Admin User
+
+`abra app cmd YOURAPPDOMAIN db set_admin <adminuser>`
+
 ### Disabling federation
 
-> We're not sure this does it exactly and there is still a discussion running
+- Use `DISABLE_FEDERATION=1` to turn off federation listeners
-> upstream about whether this is the right way to do it & whether it could be
+- Don't use [`compose.matrix.yml`](https://git.coopcloud.tech/coop-cloud/traefik/src/branch/master/compose.matrix.yml) in your traefik config to keep the federation ports closed
-> more convenient. We welcome issues / change sets to close up more federation
-> functionality.
-
-- use `DISABLE_FEDERATION=1` to turn off federation listeners
-- don't use [`compose.matrix.yml`](https://git.coopcloud.tech/coop-cloud/traefik/src/branch/master/compose.matrix.yml) in your traefik config to keep the federation ports closed
 
 ### Enabling federation
 
-See [`#27`](https://git.coopcloud.tech/coop-cloud/matrix-synapse/pulls/27) for more.
+See [`#27`](https://git.coopcloud.tech/coop-cloud/matrix-synapse/pulls/27) for more. Depending on your setup, using `SERVE_SERVER_WELLKNOWN=true` might work to start federating. Make sure you don't leave `DISABLE_FEDERATION=1` set!
-
-Depending on your setup, using `SERVE_SERVER_WELLKNOWN=true` might work to start federating.
-
-Make sure you don't leave `DISABLE_FEDERATION=1` set!
-
-### Seeing what changed in `homeserver.yaml` between versions
-
-Change the version range to suit your needs.
-
-```
-git clone https://github.com/matrix-org/synapse
-cd synapse/docs
-git log --follow -p v1.48.0..v1.51.0 sample_config.yaml
-```
-
-### Generating a new `homeserver.yaml`
-
-The default is also available to see [here](https://matrix-org.github.io/synapse/latest/usage/configuration/homeserver_sample_config.html).
-
-```
-docker run -it \
-  --entrypoint="" \
-  -e SYNAPSE_SERVER_NAME=foo.com \
-  -e SYNAPSE_REPORT_STATS=no \
-  matrixdotorg/synapse:v1.48.0 \
-  sh -c '/start.py generate; cat /data/homeserver.yaml' > homeserver.yaml.tmpl`
-```
-
-### Generating a new `<server>.log.config`
-
-```
-docker run -it \
-  --entrypoint="" \
-  -e SYNAPSE_SERVER_NAME=foo.com \
-  -e SYNAPSE_REPORT_STATS=no \
-  matrixdotorg/synapse:v1.48.0 \
-  sh -c '/start.py generate; cat /data/foo.com.log.config' > log.config
-```
 
 ### Getting client discovery on a custom domain
 
-You'll need to deploy something like [this](https://git.autonomic.zone/ruangrupa/well-known-uris).
+You'll need to deploy something like [this](https://git.autonomic.zone/ruangrupa/well-known-uris). This could be implemented in this recipe but we haven't merged it in yet. Change sets are welcome.
-
-This could be implemented in this recipe but we haven't merged it in yet. Change sets are welcome.
 
 ### Telegram bridging
 
-> WIP
+> WIP docs
 
 Setting it up is a bit of a chicken/egg & chasing cats moment.
 
@@ -123,7 +82,7 @@ Some helpful documentation:
 
 ### Discord bridging
 
-> WIP
+> WIP docs
 
 Just as messy as the Telegram bridging above! Rough guide:
 
@@ -142,9 +101,9 @@ Some helpful documentation:
 
 ### Signal bridging
 
-> WIP
+> WIP docs
 
-OK, it's also awful to set this up. Do you see a pattern emerging? :)
+OK, it's also awful to set this up. Do you see a pattern emerging :)
 
 - fake that you have the required tokens:
   - `abra app secret insert example.com signal_hs_token v1 foo`

abra.sh

@@ -1,7 +1,19 @@
+export DISCORD_BRIDGE_YAML_VERSION=v2
 export ENTRYPOINT_CONF_VERSION=v1
-export HOMESERVER_YAML_VERSION=v13
+export HOMESERVER_YAML_VERSION=v26
 export LOG_CONFIG_VERSION=v2
-export TELEGRAM_BRIDGE_YAML_VERSION=v3
-export DISCORD_BRIDGE_YAML_VERSION=v1
-export SIGNAL_BRIDGE_YAML_VERSION=v2
 export SHARED_SECRET_AUTH_VERSION=v1
+export SIGNAL_BRIDGE_YAML_VERSION=v4
+export TELEGRAM_BRIDGE_YAML_VERSION=v6
+export NGINX_CONFIG_VERSION=v5
+export WK_SERVER_VERSION=v1
+export WK_CLIENT_VERSION=v1
+
+set_admin () {
+    admin=akadmin
+    if [ -n "$1" ]
+    then
+        admin=$1
+    fi
+    psql -U synapse -c "UPDATE users SET admin = 1 WHERE name = '@$admin:$DOMAIN'";
+}

compose.discord.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - APP_SERVICES_ENABLED
       - APP_SERVICE_CONFIGS
@@ -43,7 +43,7 @@ services:
     networks:
       - internal
     healthcheck:
-      test: ["CMD", "pg_isready", "-U", "synapse"]
+      test: ["CMD", "pg_isready", "-U", "$POSTGRES_USER" ]
     volumes:
       - discord-postgres:/var/lib/postgresql/data
 

compose.keycloak.yml

@@ -2,13 +2,13 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret
       - keycloak_client_secret
-      - macaroon_secret_key
+      - macaroon
-      - registration_shared_secret
+      - registration
     environment:
       - KEYCLOAK_CLIENT_DOMAIN
       - KEYCLOAK_CLIENT_ID

compose.keycloak2.yml

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

compose.keycloak3.yml

@@ -0,0 +1,19 @@
+---
+version: "3.8"
+
+services:
+  synapse:
+    secrets:
+      - keycloak3_client_secret
+    environment:
+      - KEYCLOAK3_ALLOW_EXISTING_USERS
+      - KEYCLOAK3_CLIENT_ID
+      - KEYCLOAK3_ENABLED
+      - KEYCLOAK3_ID
+      - KEYCLOAK3_NAME
+      - KEYCLOAK3_URL
+
+secrets:
+  keycloak3_client_secret:
+    external: true
+    name: ${STACK_NAME}_keycloak3_client_secret_${SECRET_KEYCLOAK3_CLIENT_SECRET_VERSION}

compose.shared_secret_auth.yml

@@ -2,14 +2,14 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - SHARED_SECRET_AUTH_ENABLED
     secrets:
       - shared_secret_auth
     configs:
       - source: shared_secret_auth
-        target: /usr/local/lib/python3.9/site-packages/shared_secret_authenticator.py
+        target: /usr/local/lib/python3.11/site-packages/shared_secret_authenticator.py
 
 configs:
   shared_secret_auth:

compose.signal.yml

@@ -2,7 +2,7 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     environment:
       - APP_SERVICES_ENABLED
       - APP_SERVICE_CONFIGS
@@ -10,14 +10,14 @@ services:
       - signal-data:/signal-data
 
   signald:
-    image: docker.io/signald/signald:0.23.0-non-root
+    image: docker.io/signald/signald:0.23.2-non-root
     networks:
       - internal
     volumes:
       - signald-data:/signald
 
   signalbridge:
-    image: dock.mau.dev/mautrix/signal:v0.4.2
+    image: dock.mau.dev/mautrix/signal:v0.4.3
     depends_on:
       - signaldb
     configs:
@@ -26,8 +26,7 @@ services:
     environment:
       - HOMESERVER_DOMAIN
       - HOMESERVER_URL
-      - SIGNAL_BRIDGE_ADMIN_1
+      - SIGNAL_BRIDGE_PERMISSIONS
-      - SIGNAL_BRIDGE_ADMIN_2
       - SIGNAL_ENABLE_ENCRYPTION
       - VERIFY_SSL
     secrets:
@@ -55,7 +54,7 @@ services:
     networks:
       - internal
     healthcheck:
-      test: ["CMD", "pg_isready", "-U", "synapse"]
+      test: ["CMD", "pg_isready", "-U", "$POSTGRES_USER" ]
     volumes:
       - signal-postgres:/var/lib/postgresql/data
 

compose.smtp.yml

@@ -2,12 +2,12 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret
-      - macaroon_secret_key
+      - macaroon
-      - registration_shared_secret
+      - registration
       - smtp_password
     environment:
       - SMTP_APP_NAME

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.12.2
+    image: dock.mau.dev/mautrix/telegram:v0.14.2
     depends_on:
       - telegramdb
     configs:
@@ -24,8 +24,8 @@ services:
       - HOMESERVER_DOMAIN
       - HOMESERVER_URL
       - TELEGRAM_APP_ID
-      - TELEGRAM_BRIDGE_ADMIN_1
+      - TELEGRAM_BRIDGE_PERMISSIONS
-      - TELEGRAM_BRIDGE_ADMIN_2
+      - TELEGRAM_SYNC_CHANNEL_MEMBERS
       - VERIFY_SSL
     secrets:
       - telegram_api_hash
@@ -53,7 +53,7 @@ services:
     networks:
       - internal
     healthcheck:
-      test: ["CMD", "pg_isready", "-U", "synapse"]
+      test: ["CMD", "pg_isready", "-U", "$POSTGRES_USER" ]
     volumes:
       - telegram-postgres:/var/lib/postgresql/data
 

compose.turn.yml

@@ -2,12 +2,12 @@
 version: "3.8"
 
 services:
-  app:
+  synapse:
     secrets:
       - db_password
       - form_secret
-      - macaroon_secret_key
+      - macaroon
-      - registration_shared_secret
+      - registration
       - turn_shared_secret
     environment:
       - TURN_ALLOW_GUESTS

compose.yml

@@ -3,18 +3,50 @@ version: "3.8"
 
 services:
   app:
-    image: "matrixdotorg/synapse:v1.73.0"
+    image: nginx:1.23.3
+    networks:
+      - proxy
+      - internal
+    environment:
+      - STACK_NAME
+      - NGINX_ACCESS_LOG_LOCATION
+      - NGINX_ERROR_LOG_LOCATION
+    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.2+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
+      - registration
-      - macaroon_secret_key
+      - macaroon
       - form_secret
     environment:
       - ALLOWED_LIFETIME_MAX
+      - ALLOW_PUBLIC_ROOMS_FEDERATION
       - AUTO_JOIN_ROOM
       - AUTO_JOIN_ROOM_ENABLED
       - DISABLE_FEDERATION
@@ -25,6 +57,8 @@ services:
       - ENCRYPTED_BY_DEFAULT
       - FEDERATION_ALLOWLIST
       - LETSENCRYPT_HOST=${DOMAIN}
+      - MEDIA_RETENTION_LOCAL_LIFETIME
+      - MEDIA_RETENTION_REMOTE_LIFETIME
       - PASSWORD_LOGIN_ENABLED
       - REDACTION_RETENTION_PERIOD
       - RETENTION_MAX_LIFETIME
@@ -39,7 +73,6 @@ services:
       - VIRTUAL_HOST=${DOMAIN}
       - VIRTUAL_PORT=8008
     networks:
-      - proxy
       - internal
     entrypoint: /docker-entrypoint.sh
     configs:
@@ -50,16 +83,12 @@ services:
       - source: entrypoint_conf
         target: /docker-entrypoint.sh
         mode: 0555
-    deploy:
+    healthcheck:
-      restart_policy:
+      test: ["CMD", "curl", "-f", "http://localhost:8008/health"]
-        condition: on-failure
+      interval: 30s
-      labels:
+      timeout: 10s
-        - "traefik.enable=true"
+      retries: 10
-        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=8008"
+      start_period: 1m
-        - "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=2.5.0+v1.73.0"
 
   db:
     image: postgres:13-alpine
@@ -72,10 +101,15 @@ services:
       - POSTGRES_INITDB_ARGS="-E \"UTF8\""
       - POSTGRES_PASSWORD_FILE=/run/secrets/db_password
       - POSTGRES_USER=synapse
+      - DOMAIN
     networks:
       - internal
     healthcheck:
       test: ["CMD", "pg_isready", "-U", "synapse"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
     volumes:
       - postgres:/var/lib/postgresql/data
     deploy:
@@ -100,24 +134,36 @@ configs:
     file: entrypoint.sh.tmpl
     template_driver: golang
   homeserver_yaml:
-    name: ${STACK_NAME}_homserver_yaml_${HOMESERVER_YAML_VERSION}
+    name: ${STACK_NAME}_homeserver_yaml_${HOMESERVER_YAML_VERSION}
     file: homeserver.yaml.tmpl
     template_driver: golang
   log_config:
     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:
     external: true
     name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
-  registration_shared_secret:
+  registration:
     external: true
-    name: ${STACK_NAME}_db_password_${SECRET_REGISTRATION_SHARED_SECRET_VERSION}
+    name: ${STACK_NAME}_registration_${SECRET_REGISTRATION_VERSION}
-  macaroon_secret_key:
+  macaroon:
     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}

discord_bridge.yaml.tmpl

@@ -50,7 +50,7 @@ auth:
 
 logging:
   # What level should the logger output to the console at.
-  console: "warn" #silly, verbose, info, http, warn, error, silent
+  console: "error" #silly, verbose, info, http, warn, error, silent
   lineDateFormat: "MMM-D HH:mm:ss.SSS" # This is in moment.js format
   files:
     - file: "debug.log"

nginx.conf.tmpl

@@ -0,0 +1,31 @@
+user www-data;
+
+events {
+  worker_connections 768;
+}
+
+http {
+  server {
+    listen 80;
+
+    access_log {{ env "NGINX_ACCESS_LOG_LOCATION" }};
+    error_log {{ env "NGINX_ERROR_LOG_LOCATION" }};
+
+    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 https;
+      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/3.0.0+v1.74.0

@@ -0,0 +1,17 @@
+WARNING: There are a lot of config breaking changes in this one, watch out!
+
+* KEYCLOAK2* env vars have gone away, they were experimental.
+
+* TELEGRAM_BRIDGE_ADMIN* is replaced by TELEGRAM_BRIDGE_PERMISSIONS.
+
+* SIGNAL_BRIDGE_ADMIN* is replaced by SIGNAL_BRIDGE_PERMISSIONS.
+
+* The homeserver config has been trimmed, see coop-cloud/matrix-synapse#33 for more.
+
+* Bridge logging is only ERROR level now to minimise leaking plaintext.
+
+* It is possible to use SSO & federation env vars in combination now.
+
+* Media retention is now configurable with #MEDIA_RETENTION_* env vars.
+
+@decentral1se

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

release/5.0.1+v1.93.0

@@ -0,0 +1,8 @@
+take care when upgrading! You need to add two variables to your .env file:
+use the following if you don't want any access logs (including users' IP addresses):
+NGINX_ACCESS_LOG_LOCATION="/dev/null"
+NGINX_ERROR_LOG_LOCATION="/dev/null"
+
+use the following if you want logs:
+NGINX_ACCESS_LOG_LOCATION="/dev/stdout"
+NGINX_ERROR_LOG_LOCATION="/dev/stderr"

release/next

@@ -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.

signal_bridge.yaml.tmpl

@@ -267,10 +267,8 @@ bridge:
     #        * - All Matrix users
     #   domain - All users on that homeserver
     #     mxid - Specific user
-    permissions:
+    permissions: {{ env "SIGNAL_BRIDGE_PERMISSIONS" }}
-        "*": "relay"
+
-        "{{ env "SIGNAL_BRIDGE_ADMIN_1" }}": "admin"
-        "{{ env "SIGNAL_BRIDGE_ADMIN_2" }}": "admin"
     relay:
         # Whether relay mode should be allowed. If allowed, `!signal set-relay` can be used to turn any
         # authenticated user into a relaybot for that chat.
@@ -318,9 +316,9 @@ logging:
             formatter: colored
     loggers:
         mau:
-            level: DEBUG
+            level: ERROR
         aiohttp:
-            level: INFO
+            level: ERROR
     root:
-        level: DEBUG
+        level: ERROR
         handlers: [console]

telegram_bridge.yaml.tmpl

@@ -151,7 +151,7 @@ bridge:
     # Whether or not to sync the member list in channels.
     # If no channel admins have logged into the bridge, the bridge won't be able to sync the member
     # list regardless of this setting.
-    sync_channel_members: true
+    sync_channel_members: {{ env "TELEGRAM_SYNC_CHANNEL_MEMBERS" }}
     # Whether or not to skip deleted members when syncing members.
     skip_deleted_members: true
     # Whether or not to automatically synchronize contacts and chats of Matrix users logged into
@@ -412,10 +412,7 @@ bridge:
     #        * - All Matrix users
     #   domain - All users on that homeserver
     #     mxid - Specific user
-    permissions:
+    permissions: {{ env "TELEGRAM_BRIDGE_PERMISSIONS" }}
-        "*": "relaybot"
-        "{{ env "TELEGRAM_BRIDGE_ADMIN_1" }}": "admin"
-        "{{ env "TELEGRAM_BRIDGE_ADMIN_2" }}": "admin"
 
     # Options related to the message relay Telegram bot.
     relaybot:
@@ -537,11 +534,11 @@ logging:
             formatter: colored
     loggers:
         mau:
-            level: DEBUG
+            level: ERROR
         telethon:
-            level: INFO
+            level: ERROR
         aiohttp:
-            level: INFO
+            level: ERROR
     root:
-        level: DEBUG
+        level: ERROR
         handlers: [file, console]

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"
+}