Charlotte's custom fork of the Dendrite matrix homeserver
 
 
 
 
Go to file
Neil Alexander 60524f4b99
Update gomatrixserverlib to matrix-org/gomatrixserverlib#223
2020-09-23 12:47:16 +01:00
.github Create FUNDING.yml 2020-07-15 11:30:32 +01:00
appservice Report which component failed to consume (#1375) 2020-09-01 16:53:38 +01:00
build Remove current state server (#1405) 2020-09-07 14:47:59 +01:00
clientapi Peeking via MSC2753 (#1370) 2020-09-10 14:39:18 +01:00
cmd Implement rejected events (#1426) 2020-09-16 13:00:52 +01:00
docs Peeking via MSC2753 (#1370) 2020-09-10 14:39:18 +01:00
eduserver Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +01:00
federationapi Initial notary support (#1436) 2020-09-22 14:40:54 +01:00
federationsender Fix backoff bug 2020-09-22 14:53:36 +01:00
internal Enforce valid key IDs (#1437) 2020-09-23 11:07:57 +01:00
keyserver Peeking via MSC2753 (#1370) 2020-09-10 14:39:18 +01:00
mediaapi Fix #1361 (#1362) 2020-08-28 09:46:32 +01:00
roomserver Use room version cache in Events() 2020-09-21 16:49:37 +01:00
serverkeyapi Initial notary support (#1436) 2020-09-22 14:40:54 +01:00
syncapi Handle state with input event as new events (#1415) 2020-09-15 11:17:46 +01:00
userapi Password changes (#1397) 2020-09-04 15:16:13 +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
LICENSE Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
README.md Add hardware requirements; fixes #324 (#1420) 2020-09-10 17:37:31 +01: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 Version imprint (#1383) 2020-09-02 16:18:08 +01:00
dendrite-config.yaml Enforce valid key IDs (#1437) 2020-09-23 11:07:57 +01:00
go.mod Update gomatrixserverlib to matrix-org/gomatrixserverlib#223 2020-09-23 12:47:16 +01:00
go.sum Update gomatrixserverlib to matrix-org/gomatrixserverlib#223 2020-09-23 12:47:16 +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 Soft-fail (#1364) 2020-09-21 14:55:46 +01:00
sytest-whitelist Initial notary support (#1436) 2020-09-22 14:40:54 +01:00

README.md

Dendrite Build Status Dendrite Dev on Matrix Dendrite on Matrix

Dendrite is a second-generation Matrix homeserver written in Go. It is not recommended to use Dendrite as a production homeserver at this time as there is no stable release.

Dendrite will start to receive versioned releases stable enough to run once we enter beta.

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.

Discussion

For questions about Dendrite we have a dedicated room on Matrix #dendrite:matrix.org. Development discussion should happen in #dendrite-dev:matrix.org.