dendrite

树突

树突现在维持在元素-HQ/dendrite

Dendrite是从2019年到2023年开发的开源矩阵Homeserver，作为Matrix.org基金会的一部分。 matrix.org基金会无法资源维护树突，并且它继续由元素开发，另外您可以选择其他矩阵HomeServers

有关更多信息，请参见Synapse和Dendrite博客文章的未来。

Dendrite是用GO编写的第二代矩阵Homeserver。它打算为突触提供有效，可靠和可扩展的替代方案：

• 高效：与开箱即用的突触相比，具有更好基线性能的小记忆足迹。
• 可靠：使用与Synapse相同的测试套件以及全新的GO测试套件来实现矩阵规范。
• 可扩展：可以在多台机器上运行，并最终扩展到大规模的Homeserver部署。

Dendrite是Beta软件，这意味着：

• 树突已准备好早期采用者。我们建议使用PostgreSQL数据库运行Dendrite。
• 树突有周期性释放。我们打算在修复错误并降落的重要功能时发布新版本。
• Dendrite支持在发行版之间升级数据库架构。这意味着在升级树突时，您绝对不要丢失消息。

这并不意味着：

• 树突不漏洞。它尚未在现实​​世界中进行过战斗测试，因此最初会出现错误。
• 树突是特征完成的。可能有未实施的客户或联邦API。
• Dendrite已准备好进行大规模的家庭服务部署。没有高可用性/聚类支持。

目前，我们希望Dendrite对小型（10s/100s用户）Homeserver部署以及浏览器或移动设备上的P2P矩阵节点的运作良好。

如果您还有其他疑问，请查看我们的常见问题解答或加入我们：

• #dendrite：matrix.org-有关用户和服务器管理员的通用聊天
• ＃Dendrite -dev：matrix.org-开发人员的场所，所有树突开发讨论发生
• ＃Dendrite -Alerts：Matrix.org-释放通知和重要信息，强烈建议所有Dendrite Server Admins使用

要求

有关要求的更多信息，请参见计划您的安装页面。

要构建树突，您将需要1.21或更高版本。

对于可用的联合树突部署，您还需要：

• 域名（或子域）
• 该领域受信任机构颁发的有效TLS证书
• SRV记录或指向您部署的众所周知的文件

还建议：

• PostgreSQL数据库引擎，该引擎的性能要比许多用户和/或更大的房间都更好
• 像Nginx之类的反向代理服务器，像此示例一样配置

联合测试仪可用于验证您的部署。

开始

如果您想构建一个完整的树突实例，请参见“安装文档”。有关在Docker中运行的，请参见build/docker。

以下说明足以使Dendrite使用自签名证书和SQLITE数据库作为非赋予测试部署开始：

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

然后将您喜欢的矩阵客户端指向http://localhost:8008或https://localhost:8448 。

进步

我们使用一个称为“我们是突触的脚本”，该脚本可以检查智能依从性率。 Sytest是一个黑盒Homeserver测试钻机，大约900个测试。该脚本算出了其中有多少个测试在树突上传递，并通过CI更新。截至2023年1月，我们拥有100％的Server-Server Syrapse，而客户服务器均等为93％，尽管检查CI是否有最新数字。在实践中，这意味着您可以在本地和联邦通过突触服务器（例如matrix.org）进行交流，尽管仍然存在一些缺失的功能（例如SSO和第三方ID API）。

我们正在优先考虑将单用户家庭服务器受益的功能（例如，收据，E2E），而不是大规模部署可能对的功能（OpenID，访客，管理员API，作为API）。这意味着Dendrite在其中支持：

• 核心房间功能（创建房间，邀请，验证规则）
• 房间版本1至10支持
• 在本地和联邦进行回填
• 帐户，配置文件和设备
• 出版的房间清单
• 打字
• 媒体API
• 修订
• 标记
• 语境
• E2E键和设备列表
• 收据
• 推
• 客人
• 用户目录
• 在场
• 完整搜索

贡献

我们将感谢您对标记的问题的任何帮助，以及我们的突触。这些问题都具有相关的隔离，需要通过，以使问题关闭。写出代码后，您可以快速运行Sytest，以确保测试名称现在通过。

如果您是该项目的新手，请参阅我们的贡献页面以提高速度，然后寻找一个好的第一个问题。如果您熟悉该项目，请寻找帮助的问题。