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-postgresSpecification
- 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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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.
| Service | Variable | Value |
|---|---|---|
| postgres | POSTGRES_DB | Preset by the template |
| postgres | POSTGRES_INITDB_ARGS | Preset by the template |
| postgres | POSTGRES_PASSWORD | Generated at deploy |
| postgres | POSTGRES_USER | Preset by the template |
| synapse | ADMIN_PASSWORD | Generated at deploy |
| synapse | ADMIN_USERNAME | Generated at deploy |
| synapse | DB_PASSWORD | Generated at deploy |
| synapse | ENABLE_REGISTRATION | Preset by the template |
| synapse | SYNAPSE_PUBLIC_BASEURL | Preset by the template |
| synapse | SYNAPSE_REPORT_STATS | Preset by the template |
| synapse | SYNAPSE_SERVER_NAME | Preset by the template |
Install Matrix Synapse (Postgres) on a VPS
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get matrix-synapse-postgres -
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).
Docs and upstream
More in Communication
- Matrix SynapseA federated, end-to-end encrypted chat server implementing the Matrix protocol.
- MatterbridgeBridges chat between platforms. The install form carries matterbridge.toml as an editable file with a local API gateway, so you add your own accounts there.
- MattermostAn open-source, self-hosted alternative to Slack for team messaging and collaboration.
- Mail server (mox, experimental)Experimental. Needs APP_EXPERIMENTAL=mail on the control plane: without it this template is hidden and cannot be installed. Install with the MAIL_FIRST_DOMAIN setting (templates install mail-mox --env MAIL_FIRST_DOMAIN=example.com). MAIL_HOSTNAME (the FQDN other servers connect to) defaults to mail. that domain and MAIL_ADMIN_EMAIL to postmaster@ that domain. Ports 25, 465, 587 and 993 are published on the host with a private bind by default. After install, open them with the CLI command mail ports open --confirm (or Open mail ports on the Mail page): that makes only those four ports public and allows them in the host firewall, then set up DNS. Webmail and the account UI are on port 8025 (private, no admin pages). The admin API and metrics are never published; never make them public. TLS: the first start makes a self-signed certificate (valid for localhost only, made by mox itself) so the server comes up with no manual steps. Replace it before sending real mail: put your certificate and key in the config volume and set MAIL_TLS_CERT_FILE and MAIL_TLS_KEY_FILE (paths under /mox/config, for example certs/cur.pem and certs/cur.key). Existing files at those paths are never overwritten. A changed certificate needs a container restart. Relay mode: set MAIL_SMARTHOST_HOST (and port, user, password) to send through a provider. Changing it needs a restart. The admin password is the generated secret SERVICE_PASSWORD_MAILADMIN. Back up the config and data volumes together. Deliverability depends on reverse DNS, SPF, DKIM and a clean IP; see the mail template guide. Licence: MIT.
- LiveKitOpen-source WebRTC server for real-time audio, video and data, with an API for rooms and tokens. The install form carries livekit.yaml as an editable file and generates the API key and secret.
- ListmonkA self-hosted newsletter and mailing list manager with a fast, dependency-light core.