Dendrite is a second-generation Matrix homeserver written in Go!
Go to file
Kegsay 37db60f4d4
Update README/docs (#1199)
* Update README

* Update docs
2020-07-14 12:58:00 +01:00
.github Add SyTest support to CI (#704) 2019-05-24 15:00:03 +01:00
appservice Move account/device DBs to userapi (#1141) 2020-06-17 12:05:56 +01:00
build Yggdrasil demo updates 2020-07-10 16:28:18 +01:00
clientapi Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
cmd Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
currentstateserver Finish implementing redactions (#1189) 2020-07-08 17:45:39 +01:00
docs Update README/docs (#1199) 2020-07-14 12:58:00 +01:00
eduserver BREAKING: Make eduserver/appservice use userapi (#1138) 2020-06-16 17:39:56 +01:00
federationapi Implement local redaction (#1182) 2020-07-03 17:24:51 +01:00
federationsender Send-to-device messages over federation (#1198) 2020-07-14 12:33:37 +01:00
internal Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
keyserver Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
mediaapi Yet another v1 vs r0 media endpoint (#1190) 2020-07-08 16:39:50 +01:00
roomserver Finish implementing redactions (#1189) 2020-07-08 17:45:39 +01:00
serverkeyapi More server key updates, tests (#1129) 2020-06-16 13:11:20 +01:00
syncapi Finish implementing redactions (#1189) 2020-07-08 17:45:39 +01:00
userapi Fix Yggdrasil gobind build, set display name at registration 2020-07-01 13:35:58 +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 Update awsy list 2020-06-30 10:26:26 +01:00
are-we-synapse-yet.py Fix div 0 error and add new tests to list 2020-06-26 11:34:25 +01:00
build-dendritejs.sh Bake in git commit into dendritejs binary (#1048) 2020-05-19 16:42:30 +01:00
build.sh Unbreak the wasm build (#986) 2020-04-28 16:22:00 +01:00
dendrite-config.yaml Remove publicroomsapi (#1176) 2020-07-02 17:11:33 +01:00
go.mod Bump GMSL version to fix sytest 2020-07-14 10:47:34 +01:00
go.sum Bump GMSL version to fix sytest 2020-07-14 10:47:34 +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/docs (#1199) 2020-07-14 12:58:00 +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 Blacklist a test 2020-07-03 14:18:58 +01:00
sytest-whitelist Send-to-device messages over federation (#1198) 2020-07-14 12:33:37 +01:00

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. An overview of the design can be found in DESIGN.md.

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 July 2020 we're at around 48% CS API coverage and 50% 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
  • E2E keys and device lists

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

Contributing

Everyone is welcome to help out and contribute! See CONTRIBUTING.md to get started!

Discussion

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