Dendrite is a second-generation Matrix homeserver written in Go!
Go to file
Kegan Dougal b12b7abcc0 v0.1.0
Squashed commit of the following:

commit 570528e5f19d76fe2fd7ea646246eea9650b1b60
Author: Kegan Dougal <kegan@matrix.org>
Date:   Thu Oct 8 14:52:10 2020 +0100

    v0.1.0

commit 02c020bced3be6d1a63e1001ab9c0ef6231ba087
Merge: db840f02 8035c50c
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Thu Oct 8 14:46:32 2020 +0100

    Merge branch 'master' into v0.1.0

commit db840f025b5d7b7c7e1ba905646571cb03dd7b22
Merge: adc19a3d 78f6e1a3
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Thu Oct 8 13:31:36 2020 +0100

    Merge branch 'master' into v0.1.0

commit adc19a3d5f0c9d5a85b3c1dd7d1772236fb8cc9b
Merge: c8fc6855 3e12f6e9
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Thu Oct 8 10:31:58 2020 +0100

    Merge branch 'master' into v0.1.0

commit c8fc68555c3607b0153d10df91d357d9603ccf90
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Wed Oct 7 18:41:04 2020 +0100

    Version 0.1.0rc3

commit 15bf3851415dc21ebcfa98e0f2a5ec725034d6dd
Merge: e7d9eea4 8bca7a83
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Wed Oct 7 18:39:25 2020 +0100

    Merge branch 'master' into v0.1.0

commit e7d9eea4a09be7b05a87b1df2a9e87d3109e8fcc
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Oct 5 17:56:45 2020 +0100

    v0.1.0rc2

commit 3fa76370f214e2ba3ec04f4c6f0f63d3baa273e7
Merge: f7cecdd9 52ddded7
Author: Neil Alexander <neilalexander@users.noreply.github.com>
Date:   Mon Oct 5 17:56:28 2020 +0100

    Merge branch 'master' into v0.1.0

commit f7cecdd9a85fe2806a99e426b806832e7036da1e
Author: Kegan Dougal <kegan@matrix.org>
Date:   Fri Oct 2 17:25:59 2020 +0100

    Bump to 0.1.0rc1
2020-10-08 14:53:46 +01:00
.github Update PULL_REQUEST_TEMPLATE.md 2020-10-02 16:56:13 +01:00
appservice Report which component failed to consume (#1375) 2020-09-01 16:53:38 +01:00
build Rename serverkeyapi to signingkeyserver (#1492) 2020-10-07 16:23:18 +01:00
clientapi Return 200 on join before time out (#1493) 2020-10-07 15:29:14 +01:00
cmd Update monolith -api behaviour (#1484) 2020-10-07 16:59:22 +01:00
docs Rename serverkeyapi to signingkeyserver (#1492) 2020-10-07 16:23:18 +01:00
eduserver Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +01:00
federationapi Use [] not null when there are no devices (#1480) 2020-10-06 11:05:15 +01:00
federationsender Remove KindRewrite (#1481) 2020-10-06 11:05:00 +01:00
internal v0.1.0 2020-10-08 14:53:46 +01:00
keyserver Update all usages of tx.Stmt to sqlutil.TxStmt (#1423) 2020-09-24 11:10:14 +01:00
mediaapi Fix #1361 (#1362) 2020-08-28 09:46:32 +01:00
roomserver Don't get into situations where we have no forward extremities 2020-10-08 14:46:25 +01:00
signingkeyserver Rename serverkeyapi to signingkeyserver (#1492) 2020-10-07 16:23:18 +01:00
syncapi Remove notifs about key changes in syncapi (#1496) 2020-10-08 10:27:10 +01:00
userapi Implement account deactivation (#1455) 2020-10-02 17:18:20 +01:00
.dockerignore Docker Hub (#1053) 2020-05-21 13:02:28 +01:00
.gitignore Support embedding Riot Web (#1113) 2020-06-11 10:16:46 +01:00
.golangci.yml Get room versions from database (#918) 2020-03-17 18:00:10 +00:00
are-we-synapse-yet.list AWSY: new groups and add AS API section (#1270) 2020-08-14 11:26:06 +01:00
are-we-synapse-yet.py AWSY: new groups and add AS API section (#1270) 2020-08-14 11:26:06 +01:00
build-dendritejs.sh Bake in git commit into dendritejs binary (#1048) 2020-05-19 16:42:30 +01:00
build.sh Fix build.sh 2020-10-02 11:49:13 +01:00
dendrite-config.yaml Rename serverkeyapi to signingkeyserver (#1492) 2020-10-07 16:23:18 +01:00
go.mod Update to matrix-org/gomatrixserverlib#233 2020-10-06 15:37:31 +01:00
go.sum Update to matrix-org/gomatrixserverlib#233 2020-10-06 15:37:31 +01:00
LICENSE Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
README.md Update README.md 2020-10-01 15:28:01 +01:00
show-expected-fail-tests.sh Fix newlines between white/blacklist test names in buildkite annotations (#1003) 2020-05-04 14:48:49 +01:00
sytest-blacklist Resolve state after event against current room state when determining latest state changes (#1479) 2020-10-05 17:47:08 +01:00
sytest-whitelist Deep checking of forward extremities (#1491) 2020-10-07 14:05:33 +01:00

Dendrite Build Status Dendrite Dendrite Dev

Dendrite is a second-generation Matrix homeserver written in Go!

Join us in:

Quick start

Requires Go 1.13+ and SQLite3 (Postgres is also supported):

$ git clone https://github.com/matrix-org/dendrite
$ cd dendrite

# generate self-signed certificate and an event signing key for federation
$ go build ./cmd/generate-keys
$ ./generate-keys --private-key matrix_key.pem --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 filenames
$ cp dendrite-config.yaml dendrite.yaml

# build and run the server
$ go build ./cmd/dendrite-monolith-server
$ ./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml

Then point your favourite Matrix client at http://localhost:8008. For full installation information, see INSTALL.md. For running in Docker, see build/docker.

Progress

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 August 2020 we're at around 52% CS API coverage and 65% 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:

  • Receipts
  • Push
  • Search and Context
  • User Directory
  • Presence
  • Guests

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)
  • Federation in rooms v1-v6
  • Backfilling locally and via federation
  • Accounts, Profiles and Devices
  • Published room lists
  • Typing
  • Media APIs
  • Redaction
  • Tagging
  • E2E keys and device lists

Contributing

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/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. Ask on #dendrite-dev:matrix.org if you think this is the case for you and we'll be happy to help.

If you're new to the project, see CONTRIBUTING.md 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 matrix.org 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.