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，以確保測試名稱現在通過。

如果您是該項目的新手，請參閱我們的貢獻頁面以提高速度，然後尋找一個好的第一個問題。如果您熟悉該項目，請尋找幫助的問題。