Skip to main content

How to Self-Host Matrix Synapse 2026

·OSSAlt Team
matrixsynapseelementmessagingself-hostingdockerencryption2026
Share:

TL;DR

Matrix is an open standard for decentralized, E2E-encrypted messaging. Synapse (Apache 2.0, ~12K GitHub stars, Python) is the reference homeserver — your own private messaging infrastructure that federates with the global Matrix network. Element is the polished web/desktop/mobile client. Matrix is the chat infrastructure used by the German federal government, France's Defense Ministry, and thousands of companies who need encrypted, self-sovereign communications.

Key Takeaways

  • Matrix/Synapse: Apache 2.0, ~12K stars — decentralized, federated, E2E encrypted messaging
  • Federation: Users on your server can message users on any Matrix server (matrix.org, etc.)
  • Bridges: Connect your Matrix server to Slack, Discord, Telegram, WhatsApp, Signal via bridges
  • Element: The best Matrix client — web, desktop, iOS, Android — all free
  • E2E by default: All DMs and rooms can be E2E encrypted; keys verified via cross-signing
  • vs Signal: Matrix is self-hosted and federated; Signal is centralized but simpler

Part 1: Docker Setup

# docker-compose.yml
services:
  synapse:
    image: matrixdotorg/synapse:latest
    container_name: synapse
    restart: unless-stopped
    ports:
      - "8008:8008"
    volumes:
      - synapse_data:/data
    environment:
      SYNAPSE_SERVER_NAME: "yourdomain.com"
      SYNAPSE_REPORT_STATS: "no"
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:16-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: synapse
      POSTGRES_PASSWORD: "${POSTGRES_PASSWORD}"
      POSTGRES_DB: synapse
      POSTGRES_INITDB_ARGS: "--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
    volumes:
      - postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U synapse"]
      interval: 10s
      start_period: 20s

volumes:
  synapse_data:
  postgres_data:

Generate Synapse config

# Generate the homeserver.yaml config:
docker run --rm \
  -v synapse_data:/data \
  -e SYNAPSE_SERVER_NAME=yourdomain.com \
  -e SYNAPSE_REPORT_STATS=no \
  matrixdotorg/synapse:latest generate

# The config is now at: synapse_data/homeserver.yaml
# Edit it to configure PostgreSQL:
# homeserver.yaml (key sections):
server_name: "yourdomain.com"

# PostgreSQL database:
database:
  name: psycopg2
  args:
    user: synapse
    password: "your-db-password"
    database: synapse
    host: postgres
    cp_min: 5
    cp_max: 10

# Email for notifications:
email:
  smtp_host: smtp.yourdomain.com
  smtp_port: 587
  smtp_user: "matrix@yourdomain.com"
  smtp_pass: "your-smtp-password"
  notif_from: "Matrix <matrix@yourdomain.com>"
  enable_notifs: true

# Disable registration (invite-only):
enable_registration: false
registration_requires_token: true

# Enable federation:
federation_domain_whitelist:
  # Remove to allow all federation, or list allowed servers:
  # - matrix.org
  # - element.io
# Start Synapse:
docker compose up -d

# Create admin user:
docker exec synapse register_new_matrix_user \
  -u admin -p your-password -a \
  -c /data/homeserver.yaml http://localhost:8008

Part 2: HTTPS with Caddy

Matrix requires specific routing for federation:

yourdomain.com {
    # Matrix federation API:
    handle /_matrix/* {
        reverse_proxy localhost:8008
    }

    # Matrix client API:
    handle /.well-known/matrix/* {
        respond `{"m.homeserver":{"base_url":"https://yourdomain.com"},"m.identity_server":{"base_url":"https://vector.im"}}` 200
    }
}

# If using a subdomain for Matrix (matrix.yourdomain.com):
matrix.yourdomain.com {
    reverse_proxy localhost:8008
}

Run Synapse on matrix.yourdomain.com but have user IDs as @user:yourdomain.com:

yourdomain.com {
    handle /.well-known/matrix/server {
        respond `{"m.server":"matrix.yourdomain.com:443"}` 200
    }
    handle /.well-known/matrix/client {
        respond `{"m.homeserver":{"base_url":"https://matrix.yourdomain.com"}}` 200
    }
}

matrix.yourdomain.com {
    reverse_proxy localhost:8008
}

Part 3: Element Web Client

Host Element Web yourself:

# Add to docker-compose.yml:
services:
  element-web:
    image: vectorim/element-web:latest
    container_name: element
    restart: unless-stopped
    ports:
      - "8080:80"
    volumes:
      - ./element-config.json:/app/config.json:ro
{
  "default_server_config": {
    "m.homeserver": {
      "base_url": "https://matrix.yourdomain.com",
      "server_name": "yourdomain.com"
    }
  },
  "disable_custom_urls": true,
  "brand": "My Matrix Chat",
  "show_labs_settings": false,
  "features": {
    "feature_video_rooms": false
  }
}
chat.yourdomain.com {
    reverse_proxy localhost:8080
}

Part 4: Bridges

Bridges connect your Matrix server to other chat platforms:

Telegram bridge (mautrix-telegram)

# Add to docker-compose.yml:
services:
  mautrix-telegram:
    image: dock.mau.dev/mautrix/telegram:latest
    container_name: mautrix_telegram
    restart: unless-stopped
    volumes:
      - ./bridges/telegram:/data
    depends_on:
      - synapse
# Generate config:
docker run --rm -v ./bridges/telegram:/data dock.mau.dev/mautrix/telegram:latest

# Edit ./bridges/telegram/config.yaml:
# homeserver.address: https://matrix.yourdomain.com
# bridge.permissions: {"@admin:yourdomain.com": "admin"}
# appservice.as_token and hs_token: generate random strings

# Register bridge with Synapse (add to homeserver.yaml):
# app_service_config_files:
#   - /data/telegram-registration.yaml

Available bridges

PlatformBridgeGitHub
Telegrammautrix-telegramdock.mau.dev/mautrix/telegram
WhatsAppmautrix-whatsappdock.mau.dev/mautrix/whatsapp
Discordmautrix-discorddock.mau.dev/mautrix/discord
Slackmautrix-slackdock.mau.dev/mautrix/slack
Signalmautrix-signaldock.mau.dev/mautrix/signal
iMessagemautrix-imessagedock.mau.dev/mautrix/imessage (macOS only)

Part 5: User Management

# Create a user:
docker exec synapse register_new_matrix_user \
  -u alice -p secure-password \
  -c /data/homeserver.yaml http://localhost:8008

# Create a registration token (for invite-only signup):
docker exec synapse synapse_port_db --config-file /data/homeserver.yaml \
  --generate-registration-token

# Or via Admin API:
curl -X POST "https://matrix.yourdomain.com/_synapse/admin/v1/registration_tokens/new" \
  -H "Authorization: Bearer $ADMIN_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"uses_allowed": 1}'

# List users:
curl "https://matrix.yourdomain.com/_synapse/admin/v2/users?from=0&limit=100" \
  -H "Authorization: Bearer $ADMIN_ACCESS_TOKEN" | jq '.users[].name'

# Deactivate a user:
curl -X PATCH "https://matrix.yourdomain.com/_synapse/admin/v2/users/@alice:yourdomain.com" \
  -H "Authorization: Bearer $ADMIN_ACCESS_TOKEN" \
  -d '{"deactivated": true}'

Part 6: E2E Encryption and Cross-Signing

Matrix supports E2E encryption with device verification:

  1. Enable E2E in a room: Room Settings → Security → Enable Encryption
  2. Cross-signing: In Element → Security → Set up → creates a cross-signing key
  3. Verification: Verify other users' devices via emoji comparison or QR code
  4. Secure backup: Store encrypted key backup so you don't lose messages if you lose your device
# Check E2E status via API:
curl "https://matrix.yourdomain.com/_matrix/client/v3/keys/query" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{"device_keys": {"@alice:yourdomain.com": []}}'

Maintenance

# Update Synapse:
docker compose pull
docker compose up -d

# Database maintenance (run monthly):
docker exec synapse synapse_port_db --config-file /data/homeserver.yaml --update-stats

# Purge old room events (reduce database size):
curl -X POST "https://matrix.yourdomain.com/_synapse/admin/v1/purge_history_jobs" \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -d '{"delete_local_events": true, "purge_up_to_ts": 1609459200000}'

# Backup:
docker exec synapse-postgres-1 pg_dump -U synapse synapse \
  | gzip > synapse-db-$(date +%Y%m%d).sql.gz

# Logs:
docker compose logs -f synapse

Why Self-Host Matrix Synapse?

The case for self-hosting Matrix Synapse comes down to three practical factors: data ownership, cost at scale, and operational control.

Data ownership is the fundamental argument. When you use a SaaS version of any tool, your data lives on someone else's infrastructure subject to their terms of service, their security practices, and their business continuity. If the vendor raises prices, gets acquired, changes API limits, or shuts down, you're left scrambling. Self-hosting Matrix Synapse means your data and configuration stay on infrastructure you control — whether that's a VPS, a bare metal server, or a home lab.

Cost at scale matters once you move beyond individual use. Most SaaS equivalents charge per user or per data volume. A self-hosted instance on a $10-20/month VPS typically costs less than per-user SaaS pricing for teams of five or more — and the cost doesn't scale linearly with usage. One well-configured server handles dozens of users for a flat monthly fee.

Operational control is the third factor. The Docker Compose configuration above exposes every setting that commercial equivalents often hide behind enterprise plans: custom networking, environment variables, storage backends, and authentication integrations. You decide when to update, how to configure backups, and what access controls to apply.

The honest tradeoff: you're responsible for updates, backups, and availability. For teams running any production workloads, this is familiar territory. For individuals, the learning curve is real but the tooling (Docker, Caddy, automated backups) is well-documented and widely supported.

Server Requirements and Sizing

Before deploying Matrix Synapse, assess your server capacity against expected workload.

Minimum viable setup: A 1 vCPU, 1GB RAM VPS with 20GB SSD is sufficient for personal use or small teams. Most consumer VPS providers — Hetzner, DigitalOcean, Linode, Vultr — offer machines in this range for $5-10/month. Hetzner offers excellent price-to-performance for European and US regions.

Recommended production setup: 2 vCPUs with 4GB RAM and 40GB SSD handles most medium deployments without resource contention. This gives Matrix Synapse headroom for background tasks, caching, and concurrent users while leaving capacity for other services on the same host.

Storage planning: The Docker volumes in this docker-compose.yml store all persistent Matrix Synapse data. Estimate your storage growth rate early — for data-intensive tools, budget for 3-5x your initial estimate. Hetzner Cloud and Vultr both support online volume resizing without stopping your instance.

Operating system: Any modern 64-bit Linux distribution works. Ubuntu 22.04 LTS and Debian 12 are the most commonly tested configurations. Ensure Docker Engine 24.0+ and Docker Compose v2 are installed — verify with docker --version and docker compose version. Avoid Docker Desktop on production Linux servers; it adds virtualization overhead and behaves differently from Docker Engine in ways that cause subtle networking issues.

Network: Only ports 80 and 443 need to be publicly accessible when running behind a reverse proxy. Internal service ports should be bound to localhost only. A minimal UFW firewall that blocks all inbound traffic except SSH, HTTP, and HTTPS is the single most effective security measure for a self-hosted server.

Backup and Disaster Recovery

Running Matrix Synapse without a tested backup strategy is an unacceptable availability risk. Docker volumes are not automatically backed up — if you delete a volume or the host fails, data is gone with no recovery path.

What to back up: The named Docker volumes containing Matrix Synapse's data (database files, user uploads, application state), your docker-compose.yml and any customized configuration files, and .env files containing secrets.

Backup approach: For simple setups, stop the container, archive the volume contents, then restart. For production environments where stopping causes disruption, use filesystem snapshots or database dump commands (PostgreSQL pg_dump, SQLite .backup, MySQL mysqldump) that produce consistent backups without downtime.

For a complete automated backup workflow that ships snapshots to S3-compatible object storage, see the Restic + Rclone backup guide. Restic handles deduplication and encryption; Rclone handles multi-destination uploads. The same setup works for any Docker volume.

Backup cadence: Daily backups to remote storage are a reasonable baseline for actively used tools. Use a 30-day retention window minimum — long enough to recover from mistakes discovered weeks later. For critical data, extend to 90 days and use a secondary destination.

Restore testing: A backup that has never been restored is a backup you cannot trust. Once a month, restore your Matrix Synapse backup to a separate Docker Compose stack on different ports and verify the data is intact. This catches silent backup failures, script errors, and volume permission issues before they matter in a real recovery.

Security Hardening

Self-hosting means you are responsible for Matrix Synapse's security posture. The Docker Compose setup provides a functional base; production deployments need additional hardening.

Always use a reverse proxy: Never expose Matrix Synapse's internal port directly to the internet. The docker-compose.yml binds to localhost; Caddy or Nginx provides HTTPS termination. Direct HTTP access transmits credentials in plaintext. A reverse proxy also centralizes TLS management, rate limiting, and access logging.

Strong credentials: Change default passwords immediately after first login. For secrets in docker-compose environment variables, generate random values with openssl rand -base64 32 rather than reusing existing passwords.

Firewall configuration:

ufw default deny incoming
ufw allow 22/tcp
ufw allow 80/tcp
ufw allow 443/tcp
ufw enable

Internal service ports (databases, admin panels, internal APIs) should only be reachable from localhost or the Docker network, never directly from the internet.

Network isolation: Docker Compose named networks keep Matrix Synapse's services isolated from other containers on the same host. Database containers should not share networks with containers that don't need direct database access.

VPN access for sensitive services: For internal-only tools, restricting access to a VPN adds a strong second layer. Headscale is an open source Tailscale control server that puts your self-hosted stack behind a WireGuard mesh, eliminating public internet exposure for internal tools.

Update discipline: Subscribe to Matrix Synapse's GitHub releases page to receive security advisory notifications. Schedule a monthly maintenance window to pull updated images. Running outdated container images is the most common cause of self-hosted service compromises.

Troubleshooting Common Issues

Container exits immediately or won't start

Check logs first — they almost always explain the failure:

docker compose logs -f matrix

Common causes: a missing required environment variable, a port already in use, or a volume permission error. Port conflicts appear as bind: address already in use. Find the conflicting process with ss -tlpn | grep PORT and either stop it or change Matrix Synapse's port mapping in docker-compose.yml.

Cannot reach the web interface

Work through this checklist:

  1. Confirm the container is running: docker compose ps
  2. Test locally on the server: curl -I http://localhost:PORT
  3. If local access works but external doesn't, check your firewall: ufw status
  4. If using a reverse proxy, verify it's running and the config is valid: caddy validate --config /etc/caddy/Caddyfile

Permission errors on volume mounts

Some containers run as a non-root user. If the Docker volume is owned by root, the container process cannot write to it. Find the volume's host path with docker volume inspect VOLUME_NAME, check the tool's documentation for its expected UID, and apply correct ownership:

chown -R 1000:1000 /var/lib/docker/volumes/your_volume/_data

High resource usage over time

Memory or CPU growing continuously usually indicates unconfigured log rotation, an unbound cache, or accumulated data needing pruning. Check current usage with docker stats matrix. Add resource limits in docker-compose.yml to prevent one container from starving others. For ongoing visibility into resource trends, deploy Prometheus + Grafana or Netdata.

Data disappears after container restart

Data stored in the container's writable layer — rather than a named volume — is lost when the container is removed or recreated. This happens when the volume mount path in docker-compose.yml doesn't match where the application writes data. Verify mount paths against the tool's documentation and correct the mapping. Named volumes persist across container removal; only docker compose down -v deletes them.

Keeping Matrix Synapse Updated

Matrix Synapse follows a regular release cadence. Staying current matters for security patches and compatibility. The update process with Docker Compose is straightforward:

docker compose pull          # Download updated images
docker compose up -d         # Restart with new images
docker image prune -f        # Remove old image layers (optional)

Read the changelog before major version updates. Some releases include database migrations or breaking configuration changes. For major version bumps, test in a staging environment first — run a copy of the service on different ports with the same volume data to validate the migration before touching production.

Version pinning: For stability, pin to a specific image tag in docker-compose.yml instead of latest. Update deliberately after reviewing the changelog. This trades automatic patch delivery for predictable behavior — the right call for business-critical services.

Post-update verification: After updating, confirm Matrix Synapse is functioning correctly. Most services expose a /health endpoint that returns HTTP 200 — curl it from the server or monitor it with your uptime tool.

Frequently Asked Questions

How much does it cost to self-host Matrix Synapse?

The primary cost is your server. A Hetzner CAX11 (2 vCPU ARM, 4GB RAM) runs about $5/month — enough for Matrix Synapse plus a few companion services. Add a domain ($12/year) and you're under $75/year for a complete self-hosted deployment. Compare that to SaaS pricing that typically starts at $5-15/user/month.

Can I run Matrix Synapse on a VPS with other services?

Yes. The docker-compose.yml above isolates Matrix Synapse on its own named Docker network. As long as your server has sufficient RAM and disk — 4GB RAM and 20GB disk handles most combinations — running multiple self-hosted services on one VPS is both practical and common. Tools like Dozzle and Portainer make monitoring multi-container setups manageable.

How do I migrate data if I switch servers?

Stop the Matrix Synapse container, export the Docker volumes (using docker run --rm -v VOLUME:/data -v $(pwd):/backup alpine tar czf /backup/backup.tar.gz /data), transfer to the new server, restore the volumes, and update your DNS. Most migrations complete in under an hour. Test the restoration on the new server before decommissioning the old one.

What happens if Matrix Synapse releases a breaking update?

Pin your docker-compose.yml to a specific image tag (e.g., image: matrix/synapse:1.2.3 instead of latest). Subscribe to the GitHub releases page for advance notice. When you're ready to upgrade, read the release notes, back up first, test on a staging instance, then update production.

Is Matrix Synapse suitable for production use?

Yes, with the hardening described above: reverse proxy for HTTPS, firewall rules, regular backups, and a pinned image tag. Many teams run Matrix Synapse in production successfully. The main requirement is treating your self-hosted instance with the same operational discipline you'd apply to any business-critical service.


See all open source communication tools at OSSAlt.com/categories/communication.

See open source alternatives to Element on OSSAlt.

The SaaS-to-Self-Hosted Migration Guide (Free PDF)

Step-by-step: infrastructure setup, data migration, backups, and security for 15+ common SaaS replacements. Used by 300+ developers.

Join 300+ self-hosters. Unsubscribe in one click.