element-hq/dendrite is a open-source project on GitHub, written primarily in Go. It has 991 stars. Dendrite is a second-generation Matrix homeserver written in Go!
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Dendrite is a second-generation Matrix homeserver written in Go. It is currently in maintenance mode,
meaning only security fixes are being applied, for example room version 12.
It intends to provide an efficient and reliable 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 suites as Synapse.
Dendrite is beta software, which means:
Dendrite is ready for early adopters. We recommend running Dendrite with a PostgreSQL database.
Dendrite has periodic releases. We intend to release new versions as we fix bugs and land significant features.
Dendrite supports database schema upgrades between releases. This means you should never lose your messages when upgrading Dendrite.
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. There is no high-availability/clustering support.
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.
If you have further questions, please take a look at our FAQ or join us in:
#dendrite:matrix.org - General chat about the Dendrite project, for users and server admins alike
#dendrite-dev:matrix.org - The place for developers, where all Dendrite development discussion happens
#dendrite-alerts:matrix.org - Release notifications and important info, highly recommended for all Dendrite server admins
Dendrite does not currently support the following MSCs, which impacts the ability to use Element X with Dendrite servers:
MSC4186: Simplified Sliding Sync
MSC3861: Next-gen auth OIDC
Requirements
See the Planning your Installation page for
more information on requirements.
To build Dendrite, you will need Go 1.21 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/element-hq/dendrite
$ cd dendrite
$ go build -o bin/ ./cmd/...
# 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.yaml dendrite.yaml
# Build and run the server:
$ ./bin/dendrite --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.
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.
This software is dual-licensed by New Vector Ltd (Element). It can be used either:
(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
Yes — element-hq/dendrite ships under the AGPL-3.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/element-hq/dendrite.
What is element-hq/dendrite?
element-hq/dendrite (element-hq/dendrite) is a Go project on GitHub. From the project's own README: Dendrite is a second-generation Matrix homeserver written in Go!
Where do I read more about element-hq/dendrite?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/element-hq/dendrite is the definitive source.
Read full README in the tab above.
Is dendrite worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of dendrite.