matrix-synapse/compose.yml

---
version: "3.8"

services:
  web:
    image: nginx:1.31.1
    networks:
      - proxy
      - internal
    environment:
      - DOMAIN
      - STACK_NAME
      - MAS_ENABLED
      - NGINX_ACCESS_LOG_LOCATION
      - NGINX_ERROR_LOG_LOCATION
      - MAX_UPLOAD_SIZE
    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: any
      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}"
        - "traefik.http.routers.${STACK_NAME}-federation.rule=Host(`${SERVER_NAME}`)"
        - "traefik.http.routers.${STACK_NAME}-federation.entrypoints=matrix-federation"
        - "traefik.http.routers.${STACK_NAME}-federation.tls=true"
        - "traefik.http.routers.${STACK_NAME}-federation.tls.certresolver=${LETS_ENCRYPT_ENV}"
        - "traefik.http.routers.${STACK_NAME}-federation.service=${STACK_NAME}"
    healthcheck:
      test: curl -f http://${STACK_NAME}_app:8008/health || exit 1
      interval: 30s
      timeout: 15s
      retries: 90
      start_period: 2m

  app:
    image: "matrixdotorg/synapse:v1.154.0"
    volumes:
      - "data:/data"
    secrets:
      - db_password
      - registration
      - macaroon
      - form_secret
    environment:
      - MAS_ENABLED
      - ALLOWED_LIFETIME_MAX
      - ALLOW_PUBLIC_ROOMS_FEDERATION
      - AUTO_JOIN_ROOM
      - AUTO_JOIN_ROOM_ENABLED
      - DISABLE_FEDERATION
      - DOMAIN
      - ENABLE_3PID_LOOKUP
      - ENABLE_ALLOWLIST
      - ENABLE_REGISTRATION
      - REGISTRATION_REQUIRES_TOKEN
      - ENCRYPTED_BY_DEFAULT
      - OLD_SIGNING_KEY
      - OLD_SIGNING_KEY_ID
      - OLD_SIGNING_KEY_EXPIRES
      - USER_DIRECTORY_ENABLED=${USER_DIRECTORY_ENABLED:-true}
      - USER_DIRECTORY_SEARCH_ALL_USERS=${USER_DIRECTORY_SEARCH_ALL_USERS:-true}
      - USER_DIRECTORY_PREFER_LOCAL_USERS=${USER_DIRECTORY_PREFER_LOCAL_USERS:-true}
      - USER_DIRECTORY_SHOW_LOCKED_USERS=${USER_DIRECTORY_SHOW_LOCKED_USERS:-false}
      - FEDERATION_ALLOWLIST
      - REQUIRE_AUTH_FOR_PROFILE_REQUESTS=${REQUIRE_AUTH_FOR_PROFILE_REQUESTS:-false}
      - LIMIT_PROFILE_REQUESTS_TO_USERS_WHO_SHARE_ROOMS=${LIMIT_PROFILE_REQUESTS_TO_USERS_WHO_SHARE_ROOMS:-false}
      - DELETE_STALE_DEVICES_AFTER
      - SESSION_LIFETIME
      - TRACK_PUPPETED_USER_IPS=${TRACK_PUPPETED_USER_IPS:-false}
      - LETSENCRYPT_HOST=${DOMAIN}
      - MEDIA_RETENTION_LOCAL_LIFETIME
      - MEDIA_RETENTION_REMOTE_LIFETIME
      - PASSWORD_LOGIN_ENABLED
      - REDACTION_RETENTION_PERIOD
      - RETENTION_MAX_LIFETIME
      - ROOT_LOG_LEVEL
      - SERVE_SERVER_WELLKNOWN
      - SQL_LOG_LEVEL
      - STACK_NAME
      - SYNAPSE_ADMIN_EMAIL
      - SYNAPSE_REPORT_STATS=no
      - SYNAPSE_SERVER_NAME=${DOMAIN}
      - USER_IPS_MAX_AGE
      - VIRTUAL_HOST=${DOMAIN}
      - VIRTUAL_PORT=8008
      - LOGIN_LIMIT_IP_PER_SECOND=${LOGIN_LIMIT_IP_PER_SECOND:-0.003}
      - LOGIN_LIMIT_IP_BURST=${LOGIN_LIMIT_IP_BURST:-5}
      - LOGIN_LIMIT_ACCOUNT_PER_SECOND=${LOGIN_LIMIT_ACCOUNT_PER_SECOND:-0.003}
      - LOGIN_LIMIT_ACCOUNT_BURST=${LOGIN_LIMIT_ACCOUNT_BURST:-5}
      - ROOM_COMPLEXITY_LIMIT=${ROOM_COMPLEXITY_LIMIT:-100.0}
      - WEB_CLIENT_LOCATION
    networks:
      - internal
    entrypoint: /docker-entrypoint.sh
    configs:
      - source: homeserver_yaml
        target: /data/homeserver.yaml
      - source: log_config
        target: /data/log.config
      - source: entrypoint_conf
        target: /docker-entrypoint.sh
        mode: 0555
    deploy:
      restart_policy:
        condition: on-failure
      labels:
        - "coop-cloud.${STACK_NAME}.version=7.3.0+v1.154.0"
        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT}"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8008/health"]
      interval: 30s
      timeout: 10s
      retries: 30
      start_period: 1m

  db:
    image: pgautoupgrade/pgautoupgrade:18-alpine
    secrets:
      - db_password
    environment:
      # postgres:18 relocated the default PGDATA to /var/lib/postgresql/18/docker.
      # Pin it to the legacy path so pgautoupgrade finds the existing cluster on the
      # mounted volume and upgrades it in place, instead of init'ing an empty one.
      - PGDATA=/var/lib/postgresql/data
      - LC_COLLATE=C
      - LC_CTYPE=C
      - POSTGRES_DB=synapse
      - POSTGRES_INITDB_ARGS=-E UTF8
      - POSTGRES_PASSWORD_FILE=/run/secrets/db_password
      - POSTGRES_USER=synapse
      - DOMAIN
    networks:
      - internal
    healthcheck:
      interval: 30s
      timeout: 10s
      retries: 20
      start_period: 1m
    volumes:
      - postgres:/var/lib/postgresql/data
    deploy:
      labels:
        backupbot.backup: "${ENABLE_BACKUPS:-true}"
        backupbot.backup.pre-hook: "/pg_backup.sh backup"
        backupbot.backup.volumes.postgres.path: "backup.sql"
        backupbot.restore.post-hook: "/pg_backup.sh restore"
    configs:
      - source: pg_backup
        target: /pg_backup.sh
        mode: 0555

volumes:
  data:
  postgres:

networks:
  proxy:
    external: true
  internal:

configs:
  entrypoint_conf:
    name: ${STACK_NAME}_entrypoint_${ENTRYPOINT_CONF_VERSION}
    file: entrypoint.sh.tmpl
    template_driver: golang
  homeserver_yaml:
    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
  pg_backup:
    name: ${STACK_NAME}_pg_backup_${PG_BACKUP_VERSION}
    file: pg_backup.sh

secrets:
  db_password:
    external: true
    name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
  registration:
    external: true
    name: ${STACK_NAME}_registration_${SECRET_REGISTRATION_VERSION}
  macaroon:
    external: true
    name: ${STACK_NAME}_macaroon_${SECRET_MACAROON_VERSION}
  form_secret:
    external: true
    name: ${STACK_NAME}_form_secret_${SECRET_FORM_SECRET_VERSION}