Dendrite is a second-generation Matrix homeserver written in Go!
Find a file
dependabot[bot] e5bede475c
Bump actions/upload-pages-artifact from 1 to 3 (#3461)
Bumps
[actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact)
from 1 to 3.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/actions/upload-pages-artifact/releases">actions/upload-pages-artifact's
releases</a>.</em></p>
<blockquote>
<h2>v3.0.0</h2>
<h1>Changelog</h1>
<ul>
<li>Use <code>v4</code> upload-artifact tag <a
href="https://github.com/robherley"><code>@​robherley</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/80">#80</a>)</li>
<li>Upload pages artifact with upload-artifact v4-beta <a
href="https://github.com/konradpabjan"><code>@​konradpabjan</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/78">#78</a>)</li>
</ul>
<p>To deploy a GitHub Pages site which has been uploaded with this
version of <code>actions/upload-pages-artifact</code>, you must also use
<code>actions/deploy-pages@v4</code> or newer.</p>
<p>⚠️ For use with products other than GitHub.com, such as GitHub
Enterprise Server, please be aware that this new Actions artifacts
service is not yet supported in the latest GHES release at this
time.</p>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v2.0.0...v3.0.0">all
code changes</a> since previous release.</p>
<h2>v2.0.0</h2>
<h1>Changelog</h1>
<ul>
<li>⚠️ <strong>BREAKING CHANGE:</strong> Remove built-in
<code>chmod</code> commands for <code>v2</code> <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/69">#69</a>)</li>
<li>Update README for <code>v2</code> <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/70">#70</a>)</li>
</ul>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v1.0.10...v2.0.0">all
code changes</a> since previous release.</p>
<h2>v1.0.10</h2>
<h1>Changelog</h1>
<ul>
<li>readme: fix/improve note about permissions <a
href="https://github.com/tshepang"><code>@​tshepang</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/65">#65</a>)</li>
<li>Revert <code>chmod</code> removal for <code>v1</code> <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/68">#68</a>)</li>
<li>Add file perms handling <a
href="https://github.com/tsusdere"><code>@​tsusdere</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/64">#64</a>)</li>
</ul>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v1.0.9...v1.0.10">all
code changes</a> since previous release.</p>
<h2>v1.0.9</h2>
<p>Removed <code>chmod</code> as we moved towards trusting correct file
permissions have been set. In the event this isn't the case then we
raise an error in the action related to the file permissions.</p>
<h2>v1.0.8</h2>
<h1>Changelog</h1>
<ul>
<li>Fail if no artifact file is found to upload <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/55">#55</a>)</li>
<li>Fix link to releases in README <a
href="https://github.com/waldyrious"><code>@​waldyrious</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/53">#53</a>)</li>
<li>Bump actions/publish-action from 0.2.1 to 0.2.2 <a
href="https://github.com/dependabot"><code>@​dependabot</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/47">#47</a>)</li>
<li>Add Dependabot config for Actions usage updates <a
href="https://github.com/JamesMGreene"><code>@​JamesMGreene</code></a>
(<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/46">#46</a>)</li>
</ul>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v1.0.7...v1.0.8">all
code changes</a> since previous release.</p>
<h2>v1.0.7</h2>
<h1>Changelog</h1>
<ul>
<li>Don't change file permissions of other files <a
href="https://github.com/KyeRussell"><code>@​KyeRussell</code></a> (<a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/44">#44</a>)</li>
</ul>
<p>See details of <a
href="https://github.com/actions/upload-pages-artifact/compare/v1.0.6...v1.0.7">all
code changes</a> since previous release.</p>
<h2>v1.0.6</h2>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="56afc609e7"><code>56afc60</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/94">#94</a>
from SilverRainZ/main</li>
<li><a
href="d12fdfb149"><code>d12fdfb</code></a>
Merge branch 'main' into main</li>
<li><a
href="aef5542762"><code>aef5542</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/88">#88</a>
from uiolee/patch-1</li>
<li><a
href="29cedd75fc"><code>29cedd7</code></a>
Merge branch 'main' into patch-1</li>
<li><a
href="a69c22e32e"><code>a69c22e</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/92">#92</a>
from actions/dependabot/github_actions/non-breaking-ch...</li>
<li><a
href="794e304fb3"><code>794e304</code></a>
Group tar's output to prevent it from messing up logs</li>
<li><a
href="14007f6464"><code>14007f6</code></a>
Bump the non-breaking-changes group with 1 update</li>
<li><a
href="0191170de1"><code>0191170</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/upload-pages-artifact/issues/91">#91</a>
from actions/dependabot-grouping</li>
<li><a
href="0e7832dab2"><code>0e7832d</code></a>
Update Dependabot config to group non-breaking changes</li>
<li><a
href="1a6d9fac9a"><code>1a6d9fa</code></a>
Update README.md</li>
<li>Additional commits viewable in <a
href="https://github.com/actions/upload-pages-artifact/compare/v1...v3">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/upload-pages-artifact&package-manager=github_actions&previous-version=1&new-version=3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-18 08:05:47 +01:00
.github Bump actions/upload-pages-artifact from 1 to 3 (#3461) 2024-12-18 08:05:47 +01:00
appservice Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
build Fix linting 2024-11-14 16:40:08 +01:00
clientapi Update dependencies (#3449) 2024-12-15 11:27:27 +01:00
cmd Bump nhooyr.io/websocket from 1.8.7 to 1.8.17 (#3456) 2024-12-18 08:01:41 +01:00
contrib Fix linting 2024-11-14 16:40:08 +01:00
docs Replace references to the repository 2024-10-17 17:34:12 +02:00
federationapi Update dependencies (#3449) 2024-12-15 11:27:27 +01:00
helm Replace references to the repository 2024-10-17 17:34:12 +02:00
internal Update dependencies (#3449) 2024-12-15 11:27:27 +01:00
mediaapi Fix linting 2024-11-14 16:40:08 +01:00
relayapi Fix linting 2024-11-14 16:40:08 +01:00
roomserver Various fixes in fetchAuthEvents (#3447) 2024-12-17 19:18:05 +01:00
setup Fix linting 2024-11-14 16:40:08 +01:00
syncapi Support for fallback keys (#3451) 2024-12-17 19:19:15 +01:00
test Update dependencies (#3449) 2024-12-15 11:27:27 +01:00
userapi Fetch oldest OTKs first (MSC4225) (#3452) 2024-12-17 19:19:35 +01:00
.dockerignore Add revision to version string (#3147) 2023-07-11 13:56:25 +02:00
.gitignore [helm] Update postgresql chart to 14.2.3 (#3292) 2024-02-29 08:46:40 +01:00
.golangci.yml Update golangci config (#3343) 2024-03-21 10:24:53 +01:00
are-we-synapse-yet.list Support for room version v11 (#3204) 2023-09-27 08:27:08 +02: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
CHANGES.md Version 0.13.8 (#3421) 2024-09-13 15:06:07 +02:00
CONTRIBUTING.md add DCO (#3395) 2024-07-25 15:24:35 +00:00
dendrite-sample.yaml Replace references to the repository 2024-10-17 17:34:12 +02:00
Dockerfile Update the license headers to mention the commercial license 2024-10-18 16:14:08 +02:00
go.mod Bump nhooyr.io/websocket from 1.8.7 to 1.8.17 (#3456) 2024-12-18 08:01:41 +01:00
go.sum Bump github.com/gorilla/websocket from 1.5.0 to 1.5.3 (#3455) 2024-12-17 21:44:13 +00:00
LICENSE Update license file 2024-10-17 17:21:06 +02:00
LICENSE-COMMERCIAL Add commercial license 2024-10-18 15:06:26 +02:00
README.md Replace references to the repository 2024-10-17 17:34:12 +02:00
run-sytest.sh Use /usr/bin/env bash in shebangs to make them universal (#2735) 2022-09-27 09:42:08 +01:00
show-expected-fail-tests.sh Use /usr/bin/env bash in shebangs to make them universal (#2735) 2022-09-27 09:42:08 +01:00
sytest-blacklist Various fixes in fetchAuthEvents (#3447) 2024-12-17 19:18:05 +01:00
sytest-whitelist Support for fallback keys (#3451) 2024-12-17 19:19:15 +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.

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:

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.

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 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 homeservers first (e.g Receipts, E2E) rather than features that massive deployments may be interested in (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
  • 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.