Self-host Matrix Synapse on a VPS

A federated, end-to-end encrypted chat server implementing the Matrix protocol.

levelrail-cli templates deploy matrix-synapse --name my-matrix-synapse

Specification

Status
Listed
Category
Communication
Services
synapse
Ports
8008
Volumes
1
Memory
about 1 GiB
arm64
image published
amd64
image published
Settings to fill in
none
License
not yet recorded

About Matrix Synapse

A federated, end-to-end encrypted chat server implementing the Matrix protocol. Runs as a single container from the synapse image, listening on port 8008; data is kept in named volumes.

What it deploys

Matrix Synapse runs as one service in a single Compose app, listening on port 8008, with 1 named volume mount.

ServiceImageTagPortsVolumes
synapse matrixdotorg/synapse v1.145.0 8008 synapse_data -> /data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 8008 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. Values are never shown here.

ServiceVariableValue
synapseSYNAPSE_REPORT_STATSPreset by the template
synapseSYNAPSE_SERVER_NAMEPreset by the template

Install Matrix Synapse on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get matrix-synapse
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy matrix-synapse --name my-matrix-synapse

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Matrix Synapse.

More in Communication

All Communication templates