feat: make v4 release & add notes

.env.sample

@@ -1,7 +1,10 @@
 TYPE=matrix-synapse
-DOMAIN=matrix.example.com
+DOMAIN=matrix-synapse.example.com
+#TIMEOUT=300
+#ENABLE_AUTO_UPDATE=true
 LETS_ENCRYPT_ENV=production
 COMPOSE_FILE="compose.yml"
+# POST_DEPLOY_CMDS="db set_admin"
 
 ## Admin details
 
@@ -11,8 +14,8 @@ SYNAPSE_ADMIN_EMAIL=admin@example.com
 
 SECRET_DB_PASSWORD_VERSION=v1
 SECRET_FORM_SECRET_VERSION=v1
-SECRET_MACAROON_SECRET_KEY_VERSION=v1
+SECRET_MACAROON_VERSION=v1
-SECRET_REGISTRATION_SHARED_SECRET_VERSION=v1
+SECRET_REGISTRATION_VERSION=v1
 
 ## Federation
 
@@ -48,6 +51,9 @@ ENCRYPTED_BY_DEFAULT=all
 #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
@@ -116,6 +122,7 @@ RETENTION_MAX_LIFETIME=4w
 #ENABLE_ENCRYPTION=true
 #TELEGRAM_APP_ID=
 #TELEGRAM_BRIDGE_PERMISSIONS="{ \"*\": \"relaybot\" }"
+#TELEGRAM_SYNC_CHANNEL_MEMBERS=true
 #SECRET_TELEGRAM_DB_PASSWORD_VERSION=v1
 #SECRET_TELEGRAM_API_HASH_VERSION=v1
 #SECRET_TELEGRAM_BOT_TOKEN_VERSION=v1

README.md

@@ -24,6 +24,10 @@
 
 ## Tips & Tricks
 
+### Set Admin User
+
+`abra app cmd YOURAPPDOMAIN db set_admin <adminuser>`
+
 ### Disabling federation
 
 - Use `DISABLE_FEDERATION=1` to turn off federation listeners

abra.sh

@@ -1,7 +1,16 @@
 export DISCORD_BRIDGE_YAML_VERSION=v2
 export ENTRYPOINT_CONF_VERSION=v1
-export HOMESERVER_YAML_VERSION=v18
+export HOMESERVER_YAML_VERSION=v23
 export LOG_CONFIG_VERSION=v2
 export SHARED_SECRET_AUTH_VERSION=v1
 export SIGNAL_BRIDGE_YAML_VERSION=v4
-export TELEGRAM_BRIDGE_YAML_VERSION=v5
+export TELEGRAM_BRIDGE_YAML_VERSION=v6
+
+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.keycloak2.yml

@@ -6,8 +6,10 @@ services:
     secrets:
       - keycloak2_client_secret
     environment:
+      - KEYCLOAK2_ALLOW_EXISTING_USERS
       - KEYCLOAK2_CLIENT_ID
       - KEYCLOAK2_ENABLED
+      - KEYCLOAK2_ID
       - KEYCLOAK2_NAME
       - KEYCLOAK2_URL
 

compose.signal.yml

@@ -17,7 +17,7 @@ services:
       - 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:

compose.telegram.yml

@@ -10,7 +10,7 @@ services:
       - telegram-data:/telegram-data
 
   telegrambridge:
-    image: dock.mau.dev/mautrix/telegram:v0.13.0
+    image: dock.mau.dev/mautrix/telegram:v0.14.2
     depends_on:
       - telegramdb
     configs:
@@ -25,6 +25,7 @@ services:
       - HOMESERVER_URL
       - TELEGRAM_APP_ID
       - TELEGRAM_BRIDGE_PERMISSIONS
+      - TELEGRAM_SYNC_CHANNEL_MEMBERS
       - VERIFY_SSL
     secrets:
       - telegram_api_hash

compose.yml

@@ -3,7 +3,7 @@ version: "3.8"
 
 services:
   app:
-    image: "matrixdotorg/synapse:v1.78.0"
+    image: "matrixdotorg/synapse:v1.93.0"
     volumes:
       - "data:/data"
     depends_on:
@@ -61,7 +61,14 @@ services:
         - "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.3.0+v1.78.0"
+        - "coop-cloud.${STACK_NAME}.version=4.0.0+v1.93.0"
+        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8008/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
 
   db:
     image: postgres:13-alpine
@@ -74,10 +81,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", "$POSTGRES_USER" ]
+      test: ["CMD", "pg_isready", "-U", "synapse"]
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
     volumes:
       - postgres:/var/lib/postgresql/data
     deploy:
@@ -116,10 +128,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

@@ -38,7 +38,7 @@ modules:
 # lowercase and may contain an explicit port.
 # Examples: matrix.org, localhost:8080
 #
-server_name: {{ env "DOMAIN" }}
+server_name: {{ or (env "SERVER_NAME") (env "DOMAIN") }}
 
 # The public-facing base URL that clients use to access this Homeserver (not
 # including _matrix/...). This is the same URL a user might enter into the
@@ -427,8 +427,12 @@ signing_key_path: "/data/{{ env "DOMAIN" }}.signing.key"
 #      "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
 #  - server_name: "my_other_trusted_server.example.com"
 #
+{{ if eq (env "ENABLE_ALLOWLIST") "1" }}
+{{ env "TRUSTED_KEYSERVERS" }}
+{{ else }}
 trusted_key_servers:
   - server_name: "matrix.org"
+{{ end }}
 
 ## Single sign-on integration ##
 
@@ -605,12 +609,13 @@ oidc_providers:
   {{ end }}
 
   {{ if eq (env "KEYCLOAK2_ENABLED") "1" }}
-  - idp_id: keycloak2
+  - idp_id: {{ env "KEYCLOAK2_ID" }}
     idp_name: {{ env "KEYCLOAK2_NAME" }}
     issuer: "{{ env "KEYCLOAK2_URL" }}"
     client_id: "{{ env "KEYCLOAK2_CLIENT_ID" }}"
     client_secret: "{{ secret "keycloak2_client_secret" }}"
     scopes: ["openid", "profile"]
+    allow_existing_users: {{ env "KEYCLOAK2_ALLOW_EXISTING_USERS" }}
     user_mapping_provider:
       config:
         localpart_template: "{{ "{{ user.preferred_username }}" }}"
@@ -618,12 +623,13 @@ oidc_providers:
   {{ end }}
 
   {{ if eq (env "KEYCLOAK3_ENABLED") "1" }}
-  - idp_id: keycloak3
+  - idp_id: {{ env "KEYCLOAK3_ID" }}
     idp_name: {{ env "KEYCLOAK3_NAME" }}
     issuer: "{{ env "KEYCLOAK3_URL" }}"
     client_id: "{{ env "KEYCLOAK3_CLIENT_ID" }}"
     client_secret: "{{ secret "keycloak3_client_secret" }}"
     scopes: ["openid", "profile"]
+    allow_existing_users: {{ env "KEYCLOAK3_ALLOW_EXISTING_USERS" }}
     user_mapping_provider:
       config:
         localpart_template: "{{ "{{ user.preferred_username }}" }}"
@@ -685,7 +691,7 @@ email:
   # authentication is attempted.
   #
   smtp_user: {{ env "SMTP_USER" }}
-  smtp_pass: {{ secret "smtp_password" }}
+  smtp_pass: "{{ secret "smtp_password" }}"
 
   # Uncomment the following to require TLS transport security for SMTP.
   # By default, Synapse will connect over plain text, and will then switch to

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.

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