|Neil Alexander b0aa101dcd||3 months ago|
|.github||8 months ago|
|appservice||6 months ago|
|build||3 months ago|
|clientapi||5 months ago|
|cmd||3 months ago|
|docs||4 months ago|
|eduserver||8 months ago|
|federationapi||5 months ago|
|federationsender||3 months ago|
|internal||5 months ago|
|keyserver||5 months ago|
|mediaapi||5 months ago|
|roomserver||4 months ago|
|setup||4 months ago|
|signingkeyserver||8 months ago|
|syncapi||4 months ago|
|userapi||5 months ago|
|.dockerignore||1 year ago|
|.gitignore||5 months ago|
|.golangci.yml||6 months ago|
|CHANGES.md||6 months ago|
|LICENSE||4 years ago|
|README.md||9 months ago|
|are-we-synapse-yet.list||1 year ago|
|are-we-synapse-yet.py||1 year ago|
|build-dendritejs.sh||10 months ago|
|build.sh||8 months ago|
|dendrite-config.yaml||5 months ago|
|go.mod||3 months ago|
|go.sum||3 months ago|
|show-expected-fail-tests.sh||1 year ago|
|sytest-blacklist||6 months ago|
|sytest-whitelist||5 months ago|
Dendrite is a second-generation Matrix homeserver written in Go. It intends to provide an efficient, reliable and scalable alternative to Synapse:
As of October 2020, Dendrite has now entered beta which means:
This does not mean:
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 matrix.org) 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.13 or later.
For a usable federating Dendrite deployment, you will also need:
Also recommended are:
The Federation Tester can be used to verify your deployment.
The following instructions are enough to get Dendrite started as a non-federating test deployment using self-signed certificates and SQLite databases:
$ git clone https://github.com/matrix-org/dendrite $ cd dendrite $ ./build.sh # 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-config.yaml dendrite.yaml # Build and run the server: $ ./bin/dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml
Then point your favourite Matrix client at
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 November 2020 we're at around 58% CS API coverage and 83% 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 matrix.org reasonably well. There's a long list of features that are not implemented, notably:
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:
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
tests/50federation/40devicelists.pl ) 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" -e "POSTGRES=1" -e "DENDRITE_TRACE_HTTP=1" matrixdotorg/sytest-dendrite:latest tests/50federation/40devicelists.pl
See sytest.md 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 export PERL_MM_OPT=INSTALL_BASE=$HOME ./install-deps.pl ./run-tests.pl -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.
#dendrite-dev:matrix.org if you think this is the case for you and we'll be happy to help.
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 matrix.org with ~100s of users in those rooms, including some encrypted rooms:
This means Dendrite should comfortably work on things like Raspberry Pis.