Self-host Matrix Synapse with Levelrail
A federated, end-to-end encrypted chat server implementing the Matrix protocol.
- Memory1 GiB
- Archarm64
- Services1
How to self-host Matrix Synapse
-
Pull the images
One image is pulled on your server.
Show images
matrixdotorg/synapse:v1.145.0
-
Create the app
One service starts in a single Compose app, with 1 named volume mount for your data, on port 8008.
-
Fill in the secrets
2 settings are preset, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Matrix Synapse requirements
- Memory
- About 1 GiB
- Architectures
- amd64 image published, arm64 image published
- Ports
- 8008
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- not yet recorded
- Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
- Host ports. It publishes port 8008 on the host, so open them in the VPS firewall only if you want that.
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Matrix Synapse. New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Matrix Synapse docs page.
Deploy Matrix Synapse your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Matrix Synapse from the CLI
levelrail-cli templates deploy matrix-synapse --name my-matrix-synapse Deploy Matrix Synapse with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/matrix-synapse/deploy Matrix Synapse configuration
Matrix Synapse services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| synapse | matrixdotorg/synapse:v1.145.0 | 8008 | synapse_data -> /data |
Matrix Synapse environment variables
| Variable | Service | Value |
|---|---|---|
| SYNAPSE_REPORT_STATS | synapse | Preset by the template |
| SYNAPSE_SERVER_NAME | synapse | Preset by the template |
Ports and volumes
- Ports
- 8008
- Volumes
- 1 named mount: synapse_data -> /data
Matrix Synapse FAQ
How much memory does Matrix Synapse need?
The catalog lists about 1 GiB of memory for Matrix Synapse.
Does Matrix Synapse run on arm64?
For Matrix Synapse, an arm64 image is published; amd64 is image published.
Does Matrix Synapse need configuration before it starts?
No. The template fills in its own defaults.
Which ports does Matrix Synapse use?
Matrix Synapse listens on port 8008 inside the stack.
Where does Matrix Synapse keep its data?
In a named volume: synapse_data mounted at /data.
Can I deploy Matrix Synapse on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Matrix Synapse, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image matrixdotorg/synapse:v1.145.0 is what you deploy there.