matrix

README

Matrix

Matrix server written in Golang.

It intends to provide an efficient, reliable and scalable matrix server service

• Efficient: A small memory footprint with good baseline performance
• 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 server deployments.

If you have further questions, please take a look at our FAQ or join us in:

This project is a fork of: https://github.com/antinvestor/matrix

Requirements

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

To build Matrix, you will need Go 1.23 or later.

For a usable federating Matrix 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 matrix instance, see the Installation documentation. For running in Docker, see build/docker.

The following instructions are enough to get matrix started as a non-federating test deployment using self-signed certificates and SQLite databases:

$ git clone https://github.com/antinvestor/matrix
$ 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 matrix.yaml

# Build and run the server:
$ ./bin/dendrite --tls-cert server.crt --tls-key server.key --config matrix.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 matrix.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 matrix and it updates with CI. As of January 2023, we have 100% server-server parity with Synapse, and the client-server parity is at 93% , 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 SSO and Third-party ID APIs).

We are prioritising features that will benefit single-user home servers first (e.g Receipts, E2E) rather than features that massive deployments may be interested in (OpenID, Guests, Admin APIs, AS API).

This means Matrix support 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
• Fulltext search

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.