Dendrite is a second-generation Matrix homeserver written in Go!
Go to file
Neil Alexander 9677a95afc
API setup refactoring (#1266)
* Start HTTP endpoint refactoring

* Update SetupAndServeHTTP

* Fix builds

* Don't set up external listener if no address configured

* TLS HTTP setup

* Break apart client/federation/key/media muxes

* Tweaks

* Fix P2P demos

* Fix media API routing

* Review comments @Kegsay

* Update sample config

* Fix gobind build

* Fix External -> Public in federation API test
2020-08-13 12:16:37 +01:00
.github Create FUNDING.yml 2020-07-15 11:30:32 +01:00
appservice Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +01:00
build API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
clientapi API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
cmd API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
currentstateserver Deflake currentstateserver integration tests (#1263) 2020-08-12 11:53:06 +01:00
docs Adding the e2ekey database to the create_db script and docs (#1206) 2020-07-20 09:18:48 +01:00
eduserver Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +01:00
federationapi API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
federationsender API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
internal API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
keyserver Fix more E2E sytests (#1265) 2020-08-12 22:43:02 +01:00
mediaapi API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
roomserver Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +01:00
serverkeyapi Configuration format v1 (#1230) 2020-08-10 14:18:04 +01:00
syncapi API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
userapi Fix more E2E sytests (#1265) 2020-08-12 22:43:02 +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 Bugfixes for 'If remote user leaves room we no longer receive device updates' (#1262) 2020-08-12 10:50:52 +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 API setup refactoring (#1266) 2020-08-13 12:16:37 +01:00
go.mod Configuration format v1 (#1230) 2020-08-10 14:18:04 +01:00
go.sum Configuration format v1 (#1230) 2020-08-10 14:18:04 +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 Bugfixes for 'If remote user leaves room we no longer receive device updates' (#1262) 2020-08-12 10:50:52 +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 Implement key uploads (#1202) 2020-07-15 12:02:34 +01:00
sytest-whitelist Fix more E2E sytests (#1265) 2020-08-12 22:43:02 +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 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

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.