dendrite

樹状突起

樹状突起は現在、Element-HQ/樹状突起で維持されています

Dendriteは、Matrix.org Foundationの一部として2019年から2023年まで開発されたオープンソースMatrix Homeserverです。 Matrix.org Foundationは樹状突起のリソースメンテナンスができず、さらに要素によって開発され続けています。さらに、他のMatrix Homeserversを選択できます。

詳細については、Synapse and Dendriteのブログ投稿の未来をご覧ください。

樹状突起は、GOで書かれた第2世代のマトリックスホームサーバーです。シナプスの効率的で信頼性が高く、スケーラブルな代替品を提供する予定です。

• 効率的：すぐにボックスシナプスよりも優れたベースラインパフォーマンスを備えた小さなメモリフットプリント。
• 信頼性：Synapseと同じテストスイートとまったく新しいGo Test Suiteを使用して、書かれたマトリックス仕様を実装します。
• スケーラブル：複数のマシンで実行し、最終的には大規模なHomeserverの展開にスケーリングできます。

樹状突起はベータソフトウェアです。つまり、次のことを意味します。

• 樹状突起は早期採用者の準備ができています。 PostgreSQLデータベースで樹状突起を実行することをお勧めします。
• 樹状突起には定期的なリリースがあります。バグを修正し、重要な機能を着陸させるときに、新しいバージョンをリリースする予定です。
• Dendriteは、リリース間のデータベーススキーマのアップグレードをサポートしています。これは、樹状突起をアップグレードするときにメッセージを失うことは決してないことを意味します。

これは意味しません：

• 樹状突起はバグがありません。それはまだ現実の世界で戦闘テストされていないので、最初はエラーが発生しやすくなります。
• 樹状突起は機能が完全です。実装されていないクライアントまたはフェデレーションAPIが存在する場合があります。
• 樹状突起は、大規模なHomeserverの展開の準備ができています。高可用性/クラスタリングサポートはありません。

現在、樹状突起は、ブラウザー内またはモバイルデバイスでP2Pマトリックスノードと同様に、小規模（10s/100のユーザー）のHomeserver展開でうまく機能すると予想しています。

さらに質問がある場合は、FAQをご覧になるか、ご参加ください。

• #dendrite：matrix.org-ユーザーとサーバー管理者向けの樹状突起プロジェクトについての一般的なチャット
• ＃dendrite-dev：matrix.org-すべての樹状突起開発の議論が起こる開発者の場所
• ＃dendrite -alerts：matrix.org-すべての樹状突起サーバー管理者に強く推奨される通知と重要な情報をリリースする

要件

要件の詳細については、インストールの計画ページを参照してください。

樹状突起を構築するには、1.21以降に行く必要があります。

使用可能なフェデレーション樹状突起の展開には、次のことも必要です。

• ドメイン名（またはサブドメイン）
• そのドメインの信頼できる当局によって発行された有効なTLS証明書
• SRVレコードまたは展開を指す有名なファイル

また、推奨されます：

• 多くのユーザーやより大きな部屋でSQLiteよりも優れたパフォーマンスを発揮するPostgreSQLデータベースエンジン
• nginxなどのリバースプロキシサーバーは、このサンプルのように構成されています

フェデレーションテスターを使用して、展開を確認できます。

始めましょう

完全に拡張する樹状突起インスタンスを構築する場合は、インストールドキュメントを参照してください。 Dockerで実行するには、build/dockerを参照してください。

以下の指示は、樹状突起を自己署名証明書と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コンプライアンス率をチェックする「we synapse」というスクリプトを使用します。 Sytestは、約900のテストを備えたブラックボックスホームサーバーテストリグです。このスクリプトは、これらのテストのうち何人が樹状突起を渡しているかを説明し、CIで更新します。 2023年1月の時点で、Synapseの100％のサーバーサーバーパリティがあり、クライアントサーバーパリティは93％ですが、最新の数字についてはCIを確認してください。実際には、これは、Matrix.orgなどのSynapseサーバーを合理的によく連邦で通信できることを意味しますが、まだいくつかの機能（SSOやサードパーティID APIなど）がありません。

大規模な展開（OpenID、ゲスト、管理者API、API）に関心がある機能ではなく、単一ユーザーのホームサーバー（領収書、E2Eなど）に役立つ機能に優先順位を付けています。これは、とりわけ樹状突起のサポートを意味します。

• コアルーム機能（部屋の作成、招待、認証ルール）
• ルームバージョン1〜10がサポートされています
• ローカルおよびフェデレーション経由で埋め戻します
• アカウント、プロファイル、デバイス
• 公開された部屋リスト
• タイピング
• メディアAPI
• 編集
• タグ付け
• コンテクスト
• E2Eキーとデバイスリスト
• 領収書
• 押す
• ゲスト
• ユーザーディレクトリ
• 面前
• フルテキスト検索

貢献

私たちはまだシナプスと同様に、マークされた問題についての助けに感謝します。これらの問題にはすべて、問題を閉鎖するために合格する必要がある関連するシステムがあります。コードを作成したら、Sytestをすばやく実行して、テスト名が渡されていることを確認できます。

プロジェクトを初めて使用する場合は、貢献ページを参照してスピードを上げるには、良い最初の問題を探してください。プロジェクトに精通している場合は、ヘルプが必要な問題を探してください。