Synapse
Synapse is the reference homeserver implementation for Matrix, an open standard for secure, decentralised, real-time communication.
Deploy Synapse on Dokploy
- Install Dokploy on your server if you haven't already.
- In your Dokploy panel, open a project and click Create Service → Template.
- Search for Synapse and click Create — Dokploy configures domains, environment variables, and volumes for you.
Alternatively, create a Compose service, go to Advanced → Import from Base64, and paste this payload:
ewogICJjb21wb3NlIjogInNlcnZpY2VzOlxuICBzeW5hcHNlOlxuICAgIGltYWdlOiBtYXRyaXhkb3Rvcmcvc3luYXBzZTp2MS4xNTYuMFxuICAgIHJlc3RhcnQ6IHVubGVzcy1zdG9wcGVkXG4gICAgIyBUaGUgc3RvY2sgZW50cnlwb2ludCAoL3N0YXJ0LnB5KSBkb2VzIG5vdCBnZW5lcmF0ZSB0aGUgc2lnbmluZyBrZXkgd2hlbiBhXG4gICAgIyBjb25maWcgZmlsZSBpcyBwcm92aWRlZCwgc28gZ2VuZXJhdGUgYW55IG1pc3Npbmcga2V5cyBvbiBmaXJzdCBib290IGFuZFxuICAgICMgbWFrZSBzdXJlIHRoZSBkYXRhIHZvbHVtZSBpcyBvd25lZCBieSB0aGUgc3luYXBzZSB1c2VyICg5OTEpIGJlZm9yZVxuICAgICMgaGFuZGluZyBvdmVyIHRvIHRoZSByZWd1bGFyIGVudHJ5cG9pbnQuXG4gICAgZW50cnlwb2ludDpcbiAgICAgIC0gL2Jpbi9zaFxuICAgICAgLSAtY1xuICAgICAgLSB8XG4gICAgICAgIHB5dGhvbiAtbSBzeW5hcHNlLmFwcC5ob21lc2VydmVyIC0tY29uZmlnLXBhdGggL2NvbmZpZy9ob21lc2VydmVyLnlhbWwgLS1rZXlzLWRpcmVjdG9yeSAvZGF0YSAtLWdlbmVyYXRlLWtleXNcbiAgICAgICAgY2hvd24gLVIgOTkxOjk5MSAvZGF0YVxuICAgICAgICBleGVjIC9zdGFydC5weVxuICAgIGVudmlyb25tZW50OlxuICAgICAgU1lOQVBTRV9DT05GSUdfUEFUSDogL2NvbmZpZy9ob21lc2VydmVyLnlhbWxcbiAgICB2b2x1bWVzOlxuICAgICAgLSBzeW5hcHNlLWRhdGE6L2RhdGFcbiAgICAgIC0gLi4vZmlsZXMvaG9tZXNlcnZlci55YW1sOi9jb25maWcvaG9tZXNlcnZlci55YW1sOnJvXG4gICAgICAtIC4uL2ZpbGVzL2xvZy5jb25maWc6L2NvbmZpZy9sb2cuY29uZmlnOnJvXG4gICAgZGVwZW5kc19vbjpcbiAgICAgIHBvc3RncmVzOlxuICAgICAgICBjb25kaXRpb246IHNlcnZpY2VfaGVhbHRoeVxuICAgIGhlYWx0aGNoZWNrOlxuICAgICAgdGVzdDogW1wiQ01ELVNIRUxMXCIsIFwiY3VybCAtZlNzIGh0dHA6Ly9sb2NhbGhvc3Q6ODAwOC9oZWFsdGggfHwgZXhpdCAxXCJdXG4gICAgICBpbnRlcnZhbDogMTVzXG4gICAgICB0aW1lb3V0OiA1c1xuICAgICAgcmV0cmllczogMTBcbiAgICAgIHN0YXJ0X3BlcmlvZDogOTBzXG5cbiAgcG9zdGdyZXM6XG4gICAgaW1hZ2U6IHBvc3RncmVzOjE2LWFscGluZVxuICAgIHJlc3RhcnQ6IHVubGVzcy1zdG9wcGVkXG4gICAgZW52aXJvbm1lbnQ6XG4gICAgICBQT1NUR1JFU19VU0VSOiBzeW5hcHNlXG4gICAgICBQT1NUR1JFU19QQVNTV09SRDogJHtQT1NUR1JFU19QQVNTV09SRH1cbiAgICAgIFBPU1RHUkVTX0RCOiBzeW5hcHNlXG4gICAgICAjIFN5bmFwc2UgcmVxdWlyZXMgYSBkYXRhYmFzZSB3aXRoIEMgY29sbGF0aW9uXG4gICAgICBQT1NUR1JFU19JTklUREJfQVJHUzogXCItLWVuY29kaW5nPVVURi04IC0tbGMtY29sbGF0ZT1DIC0tbGMtY3R5cGU9Q1wiXG4gICAgdm9sdW1lczpcbiAgICAgIC0gcG9zdGdyZXMtZGF0YTovdmFyL2xpYi9wb3N0Z3Jlc3FsL2RhdGFcbiAgICBoZWFsdGhjaGVjazpcbiAgICAgIHRlc3Q6IFtcIkNNRC1TSEVMTFwiLCBcInBnX2lzcmVhZHkgLVUgc3luYXBzZSAtZCBzeW5hcHNlXCJdXG4gICAgICBpbnRlcnZhbDogMTBzXG4gICAgICB0aW1lb3V0OiA1c1xuICAgICAgcmV0cmllczogNVxuXG52b2x1bWVzOlxuICBzeW5hcHNlLWRhdGE6XG4gIHBvc3RncmVzLWRhdGE6IiwKICAiY29uZmlnIjogIlt2YXJpYWJsZXNdXG5tYWluX2RvbWFpbiA9IFwiJHtkb21haW59XCJcbnBvc3RncmVzX3Bhc3N3b3JkID0gXCIke3Bhc3N3b3JkOjMyfVwiXG5yZWdpc3RyYXRpb25fc2hhcmVkX3NlY3JldCA9IFwiJHtwYXNzd29yZDozMn1cIlxubWFjYXJvb25fc2VjcmV0X2tleSA9IFwiJHtwYXNzd29yZDozMn1cIlxuZm9ybV9zZWNyZXQgPSBcIiR7cGFzc3dvcmQ6MzJ9XCJcblxuW2NvbmZpZ11cbmVudiA9IFtcbiAgICBcIlBPU1RHUkVTX1BBU1NXT1JEPSR7cG9zdGdyZXNfcGFzc3dvcmR9XCIsXG5dXG5cbltbY29uZmlnLmRvbWFpbnNdXVxuc2VydmljZU5hbWUgPSBcInN5bmFwc2VcIlxucG9ydCA9IDgwMDhcbmhvc3QgPSBcIiR7bWFpbl9kb21haW59XCJcblxuW1tjb25maWcubW91bnRzXV1cbmZpbGVQYXRoID0gXCJob21lc2VydmVyLnlhbWxcIlxuY29udGVudCA9IFwiXCJcIlxuIyBTeW5hcHNlIGhvbWVzZXJ2ZXIgY29uZmlndXJhdGlvblxuIyBodHRwczovL2VsZW1lbnQtaHEuZ2l0aHViLmlvL3N5bmFwc2UvbGF0ZXN0L3VzYWdlL2NvbmZpZ3VyYXRpb24vY29uZmlnX2RvY3VtZW50YXRpb24uaHRtbFxuXG5zZXJ2ZXJfbmFtZTogXCIke21haW5fZG9tYWlufVwiXG5wdWJsaWNfYmFzZXVybDogXCJodHRwczovLyR7bWFpbl9kb21haW59L1wiXG5waWRfZmlsZTogL2RhdGEvaG9tZXNlcnZlci5waWRcbnNpZ25pbmdfa2V5X3BhdGg6IFwiL2RhdGEvc2lnbmluZy5rZXlcIlxubG9nX2NvbmZpZzogXCIvY29uZmlnL2xvZy5jb25maWdcIlxubWVkaWFfc3RvcmVfcGF0aDogL2RhdGEvbWVkaWFfc3RvcmVcbnJlcG9ydF9zdGF0czogZmFsc2VcblxuIyBTZXJ2ZSAvLndlbGwta25vd24vbWF0cml4L3NlcnZlciBzbyBvdGhlciBob21lc2VydmVycyBjYW4gZmVkZXJhdGUgd2l0aFxuIyB0aGlzIHNlcnZlciBvdmVyIHBvcnQgNDQzICh0aGUgZGVkaWNhdGVkIGZlZGVyYXRpb24gcG9ydCA4NDQ4IGlzIG5vdCBleHBvc2VkKS5cbnNlcnZlX3NlcnZlcl93ZWxsa25vd246IHRydWVcblxubGlzdGVuZXJzOlxuICAtIHBvcnQ6IDgwMDhcbiAgICB0bHM6IGZhbHNlXG4gICAgdHlwZTogaHR0cFxuICAgIHhfZm9yd2FyZGVkOiB0cnVlXG4gICAgYmluZF9hZGRyZXNzZXM6IFsnMC4wLjAuMCddXG4gICAgcmVzb3VyY2VzOlxuICAgICAgLSBuYW1lczogW2NsaWVudCwgZmVkZXJhdGlvbl1cbiAgICAgICAgY29tcHJlc3M6IGZhbHNlXG5cbmRhdGFiYXNlOlxuICBuYW1lOiBwc3ljb3BnMlxuICBhcmdzOlxuICAgIHVzZXI6IHN5bmFwc2VcbiAgICBwYXNzd29yZDogXCIke3Bvc3RncmVzX3Bhc3N3b3JkfVwiXG4gICAgZGF0YWJhc2U6IHN5bmFwc2VcbiAgICBob3N0OiBwb3N0Z3Jlc1xuICAgIHBvcnQ6IDU0MzJcbiAgICBjcF9taW46IDVcbiAgICBjcF9tYXg6IDEwXG5cbiMgUHVibGljIHJlZ2lzdHJhdGlvbiBpcyBkaXNhYmxlZC4gQ3JlYXRlIHVzZXJzIHdpdGggdGhlXG4jIHJlZ2lzdGVyX25ld19tYXRyaXhfdXNlciB0b29sIChzZWUgdGhlIHRlbXBsYXRlIGluc3RydWN0aW9ucykuXG5lbmFibGVfcmVnaXN0cmF0aW9uOiBmYWxzZVxucmVnaXN0cmF0aW9uX3NoYXJlZF9zZWNyZXQ6IFwiJHtyZWdpc3RyYXRpb25fc2hhcmVkX3NlY3JldH1cIlxuXG5tYWNhcm9vbl9zZWNyZXRfa2V5OiBcIiR7bWFjYXJvb25fc2VjcmV0X2tleX1cIlxuZm9ybV9zZWNyZXQ6IFwiJHtmb3JtX3NlY3JldH1cIlxuXG50cnVzdGVkX2tleV9zZXJ2ZXJzOlxuICAtIHNlcnZlcl9uYW1lOiBcIm1hdHJpeC5vcmdcIlxuc3VwcHJlc3Nfa2V5X3NlcnZlcl93YXJuaW5nOiB0cnVlXG5cIlwiXCJcblxuW1tjb25maWcubW91bnRzXV1cbmZpbGVQYXRoID0gXCJsb2cuY29uZmlnXCJcbmNvbnRlbnQgPSBcIlwiXCJcbnZlcnNpb246IDFcblxuZm9ybWF0dGVyczpcbiAgcHJlY2lzZTpcbiAgICBmb3JtYXQ6ICclKGFzY3RpbWUpcyAtICUobmFtZSlzIC0gJShsaW5lbm8pZCAtICUobGV2ZWxuYW1lKXMgLSAlKHJlcXVlc3QpcyAtICUobWVzc2FnZSlzJ1xuXG5oYW5kbGVyczpcbiAgY29uc29sZTpcbiAgICBjbGFzczogbG9nZ2luZy5TdHJlYW1IYW5kbGVyXG4gICAgZm9ybWF0dGVyOiBwcmVjaXNlXG5cbmxvZ2dlcnM6XG4gIHN5bmFwc2Uuc3RvcmFnZS5TUUw6XG4gICAgbGV2ZWw6IElORk9cblxucm9vdDpcbiAgbGV2ZWw6IElORk9cbiAgaGFuZGxlcnM6IFtjb25zb2xlXVxuXG5kaXNhYmxlX2V4aXN0aW5nX2xvZ2dlcnM6IGZhbHNlXG5cIlwiXCIiCn0=
Configuration
The exact Docker Compose and template configuration this template deploys.
Instructions
Instructions
Synapse is deployed with public registration disabled, so you need to create the first user (your admin account) from the command line.
Create the first user
Open a terminal on the server running Dokploy (or use the container terminal in
the Dokploy UI) and run the following inside the synapse service container:
bash
The tool prompts for a username and password, and asks whether the user should
be an admin. It authenticates against the server using the
registration_shared_secret that was generated for this deployment (stored in
the mounted homeserver.yaml), so no registration needs to be enabled.
Log in
Point any Matrix client (for example Element Web at https://app.element.io) at
your homeserver URL https://your-domain and log in with the user you just
created. You can verify the server is up with:
bash
Notes
- Data (signing keys, media uploads) is stored in the
synapse-datavolume and the database in thepostgres-datavolume. - Federation with other Matrix servers works through
.well-knowndelegation over HTTPS (port 443). The dedicated federation port 8448 is not exposed. - To allow open registration instead, edit
enable_registrationin the mountedhomeserver.yaml(see Synapse docs for the required spam-check options such as CAPTCHA or email verification).
Related Templates
Conduit
Version: v0.9.0
Conduit is a simple, fast and reliable chat server powered by Matrix
Conduwuit
Version: latest
Well-maintained, featureful Matrix chat homeserver (fork of Conduit)
Chatto (single binary)
Version: 0.3.8
A fully-featured real-time chat application for teams and communities. This template deploys the single Chatto binary with embedded NATS. Note: email/password registration requires SMTP to be configured after deployment; voice/video calls are not included in the single-binary setup.
Coral
Version: 9.7.0
Coral is a revolutionary commenting platform designed to enhance website interactions. It features smart technology for meaningful discussions, journalist identification, moderation tools with AI support, and complete data control without ads or trackers. Used by major news sites worldwide.
Fonoster
Version: 0.15.15
Fonoster is an open-source alternative to Twilio. A complete telephony stack for building voice applications with SIP, WebRTC, and PSTN connectivity.
Mumble
Version: latest
Mumble is an open-source, low-latency, high-quality voice chat software primarily intended for use while gaming.
Self-host Synapse in minutes
Dokploy is a free, open source deployment platform. Deploy Synapse and 499+ other templates on your own infrastructure with a single click.