Dendrite is a second-generation Matrix homeserver written in Go!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Neil Alexander 519bc1124b
Add `evacuateUser` endpoint, use it when deactivating accounts (#2545)
7 hours ago
.github Checkout correct branch for Sytest 2 months ago
appservice Handle invite in appservice roomserver consumer (#2476) 1 month ago
build Avoid panicking unnecessarily when shutting down the `gobind` P2P demos (#2520) 3 weeks ago
clientapi Add `evacuateUser` endpoint, use it when deactivating accounts (#2545) 7 hours ago
cmd Make the linter happy again 2 weeks ago
docs Add `evacuateUser` endpoint, use it when deactivating accounts (#2545) 7 hours ago
federationapi Add `InputDeviceListUpdate` to the keyserver, remove old input API (#2536) 2 weeks ago
internal Version 0.8.8 (#2525) 3 weeks ago
keyserver Add `InputDeviceListUpdate` to the keyserver, remove old input API (#2536) 2 weeks ago
mediaapi Rate limiting changes (#2519) 3 weeks ago
roomserver Add `evacuateUser` endpoint, use it when deactivating accounts (#2545) 7 hours ago
setup Add `InputDeviceListUpdate` to the keyserver, remove old input API (#2536) 2 weeks ago
syncapi Don't return `end` if there are not more messages (#2542) 13 hours ago
test Really SKIP_NODB (#2472) 1 month ago
userapi Add `evacuateUser` endpoint, use it when deactivating accounts (#2545) 7 hours ago
.dockerignore Docker Hub (#1053) 2 years ago
.gitignore New documentation: 2 months ago
.golangci.yml Increase gocyclo complexity to 25 (and remove all but 2 golint directives related to it) (#1783) 1 year ago Version 0.8.8 (#2525) 3 weeks ago
LICENSE Add Apache Version 2.0 license and headers to all golang files 5 years ago Update readme 1 month ago
are-we-synapse-yet.list Update AWSY test groups (#2365) 2 months ago Add Are We Synapse Yet to GHA (#2321) 3 months ago Add startup testing for Wasm Pinecone build (#1910) 11 months ago
build.cmd to build.cmd (#2319) 3 months ago Various updates for renaming the `master` branch to `main` 5 months ago
dendrite-sample.monolith.yaml Update sample configs for `exempt_user_ids` 3 weeks ago
dendrite-sample.polylith.yaml Update sample configs for `exempt_user_ids` 3 weeks ago
go.mod Fix nats.go commit (#2540) 3 days ago
go.sum Fix nats.go commit (#2540) 3 days ago Implement Push Notifications (#1842) 4 months ago Add Are We Synapse Yet to GHA (#2321) 3 months ago
sytest-blacklist Unlist test since it no longer seems to be flakey (hopefully?) 2 months ago
sytest-whitelist Correctly redact events over federation (#2526) 3 weeks ago Add startup testing for Wasm Pinecone build (#1910) 11 months ago


Build status Dendrite Dendrite Dev

Dendrite is a second-generation Matrix homeserver written in Go. It intends to provide an efficient, reliable and scalable alternative to Synapse:

  • Efficient: A small memory footprint with better baseline performance than an out-of-the-box Synapse.
  • Reliable: Implements the Matrix specification as written, using the same test suite as Synapse as well as a brand new Go test suite.
  • Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.

As of October 2020 (current progress below), Dendrite has now entered beta which means:

  • Dendrite is ready for early adopters. We recommend running in Monolith mode with a PostgreSQL database.
  • Dendrite has periodic semver releases. We intend to release new versions as we land significant features.
  • Dendrite supports database schema upgrades between releases. This means you should never lose your messages when upgrading Dendrite.
  • Breaking changes will not occur on minor releases. This means you can safely upgrade Dendrite without modifying your database or config file.

This does not mean:

  • Dendrite is bug-free. It has not yet been battle-tested in the real world and so will be error prone initially.
  • All of the CS/Federation APIs are implemented. We are tracking progress via a script called 'Are We Synapse Yet?'. In particular, presence and push notifications are entirely missing from Dendrite. See for updates.
  • Dendrite is ready for massive homeserver deployments. You cannot shard each microservice, only run each one on a different machine.

Currently, we expect Dendrite to function well for small (10s/100s of users) homeserver deployments as well as P2P Matrix nodes in-browser or on mobile devices. In the future, we will be able to scale up to gigantic servers (equivalent to via polylith mode.

If you have further questions, please take a look at our FAQ or join us in:


To build Dendrite, you will need Go 1.16 or later.

For a usable federating Dendrite deployment, you will also need:

  • A domain name (or subdomain)
  • A valid TLS certificate issued by a trusted authority for that domain
  • SRV records or a well-known file pointing to your deployment

Also recommended are:

  • A PostgreSQL database engine, which will perform better than SQLite with many users and/or larger rooms
  • A reverse proxy server, such as nginx, configured like this sample

The Federation Tester can be used to verify your deployment.

Get started

If you wish to build a fully-federating Dendrite instance, see the Installation documentation. For running in Docker, see build/docker.

The following instructions are enough to get Dendrite started as a non-federating test deployment using self-signed certificates and SQLite databases:

$ git clone
$ cd dendrite
$ ./

# Generate a Matrix signing key for federation (required)
$ ./bin/generate-keys --private-key matrix_key.pem

# Generate a self-signed certificate (optional, but a valid TLS certificate is normally
# needed for Matrix federation/clients to work properly!)
$ ./bin/generate-keys --tls-cert server.crt --tls-key server.key

# Copy and modify the config file - you'll need to set a server name and paths to the keys
# at the very least, along with setting up the database connection strings.
$ cp dendrite-sample.monolith.yaml dendrite.yaml

# Build and run the server:
$ ./bin/dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml

# Create an user account (add -admin for an admin user).
# Specify the localpart only, e.g. 'alice' for ''
$ ./bin/create-account --config dendrite.yaml -username alice

Then point your favourite Matrix client at http://localhost:8008 or https://localhost:8448.


We use a script called Are We Synapse Yet which checks Sytest compliance rates. Sytest is a black-box homeserver test rig with around 900 tests. The script works out how many of these tests are passing on Dendrite and it updates with CI. As of April 2022 we're at around 83% CS API coverage and 95% Federation coverage, though check CI for the latest numbers. In practice, this means you can communicate locally and via federation with Synapse servers such as reasonably well, although there are still some missing features (like Search).

We are prioritising features that will benefit single-user homeservers first (e.g Receipts, E2E) rather than features that massive deployments may be interested in (User Directory, OpenID, Guests, Admin APIs, AS API). This means Dendrite supports amongst others:

  • Core room functionality (creating rooms, invites, auth rules)
  • Room versions 1 to 10 supported
  • Backfilling locally and via federation
  • Accounts, profiles and devices
  • Published room lists
  • Typing
  • Media APIs
  • Redaction
  • Tagging
  • Context
  • E2E keys and device lists
  • Receipts
  • Push
  • Guests
  • User Directory
  • Presence


We would be grateful for any help on issues marked as Are We Synapse Yet. These issues all have related Sytests which need to pass in order for the issue to be closed. Once you've written your code, you can quickly run Sytest to ensure that the test names are now passing.

For example, if the test Local device key changes get to remote servers was marked as failing, find the test file (e.g via grep or via the CI log output it's tests/50federation/ ) then to run Sytest:

docker run --rm --name sytest
-v "/Users/kegan/github/sytest:/sytest"
-v "/Users/kegan/github/dendrite:/src"
-v "/Users/kegan/logs:/logs"
-v "/Users/kegan/go/:/gopath"
matrixdotorg/sytest-dendrite:latest tests/50federation/

See for the full description of these flags.

You can try running sytest outside of docker for faster runs, but the dependencies can be temperamental and we recommend using docker where possible.

cd sytest
export PERL5LIB=$HOME/lib/perl5
export PERL_MB_OPT=--install_base=$HOME

./ -I Dendrite::Monolith -d $PATH_TO_DENDRITE_BINARIES

Sometimes Sytest is testing the wrong thing or is flakey, so it will need to be patched. Ask on if you think this is the case for you and we'll be happy to help.

If you're new to the project, see to get up to speed then look for Good First Issues. If you're familiar with the project, look for Help Wanted issues.

Hardware requirements

Dendrite in Monolith + SQLite works in a range of environments including iOS and in-browser via WASM.

For small homeserver installations joined on ~10s rooms on with ~100s of users in those rooms, including some encrypted rooms:

  • Memory: uses around 100MB of RAM, with peaks at around 200MB.
  • Disk space: After a few months of usage, the database grew to around 2GB (in Monolith mode).
  • CPU: Brief spikes when processing events, typically idles at 1% CPU.

This means Dendrite should comfortably work on things like Raspberry Pis.