Dendrite is a second-generation Matrix homeserver written in Go!
Go to file
Neil Alexander c45d0936b5
Generic-based internal HTTP API (#2626)
* Generic-based internal HTTP API (tested out on a few endpoints in the federation API)

* Add `PerformInvite`

* More tweaks

* Fix metric name

* Fix LookupStateIDs

* Lots of changes to clients

* Some serverside stuff

* Some error handling

* Use paths as metric names

* Revert "Use paths as metric names"

This reverts commit a9323a6a343f5ce6461a2e5bd570fe06465f1b15.

* Namespace metric names

* Remove duplicate entry

* Remove another duplicate entry

* Tweak error handling

* Some more tweaks

* Update error behaviour

* Some more error tweaking

* Fix API path for `PerformDeleteKeys`

* Fix another path

* Tweak federation client proxying

* Fix another path

* Don't return typed nils

* Some more tweaks, not that it makes any difference

* Tweak federation client proxying

* Maybe fix the key backup test
2022-08-11 15:29:33 +01:00
.github Disable stack protector on Linux CI build pipelines for now (to avoid relocation target __stack_chk_fail_local not defined errors) 2022-08-03 10:50:45 +01:00
appservice Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
build Add race testing to tests, and fix a few small race conditions in the tests (#2587) 2022-08-05 09:19:33 +01:00
clientapi Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
cmd Do not use ioutil as it is deprecated (#2625) 2022-08-05 10:26:59 +01:00
docs Add race testing to tests, and fix a few small race conditions in the tests (#2587) 2022-08-05 09:19:33 +01:00
federationapi Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
internal Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
keyserver Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
mediaapi Do not use ioutil as it is deprecated (#2625) 2022-08-05 10:26:59 +01:00
roomserver Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
setup Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
syncapi Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
test Do not use ioutil as it is deprecated (#2625) 2022-08-05 10:26:59 +01:00
userapi Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
.dockerignore Docker Hub (#1053) 2020-05-21 13:02:28 +01:00
.gitignore New documentation: https://matrix-org.github.io/dendrite/ 2022-05-11 15:39:36 +01:00
.golangci.yml Increase gocyclo complexity to 25 (and remove all but 2 golint directives related to it) (#1783) 2021-03-03 14:35:57 +00:00
are-we-synapse-yet.list Update AWSY test groups (#2365) 2022-04-21 17:17:52 +01:00
are-we-synapse-yet.py Add Are We Synapse Yet to GHA (#2321) 2022-04-05 15:32:30 +02:00
build-dendritejs.sh Add startup testing for Wasm Pinecone build (#1910) 2021-07-20 12:14:58 +01:00
build.cmd build.sh to build.cmd (#2319) 2022-04-05 11:27:29 +01:00
build.sh Disable WebAssembly builds for now 2022-07-01 09:50:06 +01:00
CHANGES.md Version 0.9.1 (#2616) 2022-08-03 17:42:13 +01:00
dendrite-sample.monolith.yaml Update TURN config in sample config files 2022-08-05 13:16:54 +01:00
dendrite-sample.polylith.yaml Update TURN config in sample config files 2022-08-05 13:16:54 +01:00
go.mod Update Pinecone 2022-08-03 10:38:36 +01:00
go.sum Update Pinecone 2022-08-03 10:38:36 +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 2022-08-05 10:44:08 +01:00
run-sytest.sh Add race testing to tests, and fix a few small race conditions in the tests (#2587) 2022-08-05 09:19:33 +01:00
show-expected-fail-tests.sh Add Are We Synapse Yet to GHA (#2321) 2022-04-05 15:32:30 +02:00
sytest-blacklist Disable flakey test 2022-08-02 15:33:28 +01:00
sytest-whitelist Update sytest-whitelist 2022-07-14 13:51:00 +01:00
test-dendritejs.sh Add startup testing for Wasm Pinecone build (#1910) 2021-07-20 12:14:58 +01:00

Dendrite

Build status Dendrite Dendrite Dev

Dendrite is a second-generation Matrix homeserver written in Go. It intends to provide an efficient, reliable and scalable alternative to Synapse:

  • Efficient: A small memory footprint with better baseline performance than an out-of-the-box Synapse.
  • Reliable: Implements the Matrix specification as written, using the same test suite as Synapse as well as a brand new Go test suite.
  • Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.

As of October 2020 (current progress below), Dendrite has now entered beta which means:

  • Dendrite is ready for early adopters. We recommend running in Monolith mode with a PostgreSQL database.
  • Dendrite has periodic semver releases. We intend to release new versions as we land significant features.
  • Dendrite supports database schema upgrades between releases. This means you should never lose your messages when upgrading Dendrite.
  • Breaking changes will not occur on minor releases. This means you can safely upgrade Dendrite without modifying your database or config file.

This does not mean:

  • Dendrite is bug-free. It has not yet been battle-tested in the real world and so will be error prone initially.
  • Dendrite is feature-complete. There may be client or federation APIs that are not implemented.
  • Dendrite is ready for massive homeserver deployments. You cannot shard each microservice, only run each one on a different machine.

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:

Requirements

See the Planning your Installation page for more information on requirements.

To build Dendrite, you will need Go 1.18 or later.

For a usable federating Dendrite deployment, you will also need:

  • A domain name (or subdomain)
  • A valid TLS certificate issued by a trusted authority for that domain
  • SRV records or a well-known file pointing to your deployment

Also recommended are:

  • A PostgreSQL database engine, which will perform better than SQLite with many users and/or larger rooms
  • A reverse proxy server, such as nginx, configured like this sample

The Federation Tester can be used to verify your deployment.

Get started

If you wish to build a fully-federating Dendrite instance, see the Installation documentation. For running in Docker, see build/docker.

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-sample.monolith.yaml dendrite.yaml

# Build and run the server:
$ ./bin/dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml

# Create an user account (add -admin for an admin user).
# Specify the localpart only, e.g. 'alice' for '@alice:domain.com'
$ ./bin/create-account --config dendrite.yaml -username alice

Then point your favourite Matrix client at http://localhost:8008 or https://localhost:8448.

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 2022 we're at around 83% CS API coverage and 95% 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, although there are still some missing features (like Search).

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)
  • Room versions 1 to 10 supported
  • Backfilling locally and via federation
  • Accounts, profiles and devices
  • Published room lists
  • Typing
  • Media APIs
  • Redaction
  • Tagging
  • Context
  • E2E keys and device lists
  • Receipts
  • Push
  • Guests
  • User Directory
  • Presence

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.

If you're new to the project, see our Contributing page to get up to speed, then look for Good First Issues. If you're familiar with the project, look for Help Wanted issues.