Self-host Matrix Synapse (Postgres) on a VPS

A Matrix homeserver backed by Postgres, for self-hosted federated chat and voice/video signaling.

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

Specification

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

About Matrix Synapse (Postgres)

A Matrix homeserver backed by Postgres, for self-hosted federated chat and voice/video signaling. Runs 2 containers (postgres, synapse), with synapse listening on port 8008; data is kept in named volumes.

What it deploys

Matrix Synapse (Postgres) runs as 2 services in a single Compose app, listening on port 8008, with 2 named volume mounts.

ServiceImageTagPortsVolumes
postgres postgres 16-alpine none synapse_postgres_data -> /var/lib/postgresql/data
synapse matrixdotorg/synapse latest 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.
  • Review. Image is not pinned to a version tag, so a redeploy can pull different code (matrixdotorg/synapse:latest).

Settings and environment

You do not have to fill in anything. 4 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
postgresPOSTGRES_DBPreset by the template
postgresPOSTGRES_INITDB_ARGSPreset by the template
postgresPOSTGRES_PASSWORDGenerated at deploy
postgresPOSTGRES_USERPreset by the template
synapseADMIN_PASSWORDGenerated at deploy
synapseADMIN_USERNAMEGenerated at deploy
synapseDB_PASSWORDGenerated at deploy
synapseENABLE_REGISTRATIONPreset by the template
synapseSYNAPSE_PUBLIC_BASEURLPreset by the template
synapseSYNAPSE_REPORT_STATSPreset by the template
synapseSYNAPSE_SERVER_NAMEPreset by the template

Install Matrix Synapse (Postgres) 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-postgres
  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-postgres --name my-matrix-synapse-postgres

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 (Postgres).

More in Communication

All Communication templates