dendrite

Dendrite

Dendrite sekarang dipertahankan di elemen-hq/dendrite

Dendrite adalah matriks homeServer open-source yang dikembangkan dari 2019 hingga 2023 sebagai bagian dari Yayasan Matrix.org. Yayasan matrix.org tidak dapat memelihara pemeliharaan dendrit dan terus dikembangkan oleh elemen tambahan Anda memiliki pilihan matriks homeervers lainnya

Lihat masa depan posting blog Synapse and Dendrite untuk informasi lebih lanjut.

Dendrite adalah matriks generasi kedua HomeServer yang ditulis dalam Go. Ini bermaksud untuk memberikan alternatif yang efisien , andal dan dapat diskalakan untuk sinaps:

• Efisien: Jejak kaki memori kecil dengan kinerja baseline yang lebih baik daripada sinapse out-of-the-box.
• Terpercaya: Menerapkan spesifikasi matriks seperti yang tertulis, menggunakan suite tes yang sama dengan sinaps serta rangkaian tes GO baru.
• Scalable: Dapat berjalan pada beberapa mesin dan akhirnya skala untuk penyebaran homeServer besar -besaran.

Dendrite adalah perangkat lunak beta , yang berarti:

• Dendrite siap untuk pengadopsi awal. Kami merekomendasikan menjalankan Dendrite dengan database PostgreSQL.
• Dendrite memiliki rilis berkala. Kami bermaksud untuk merilis versi baru saat kami memperbaiki bug dan mendaratkan fitur yang signifikan.
• Dendrite mendukung peningkatan skema basis data antar rilis. Ini berarti Anda tidak boleh kehilangan pesan saat meningkatkan Dendrite.

Ini tidak berarti:

• Dendrite bebas bug. Belum telah diuji pertempuran di dunia nyata dan pada awalnya akan rawan kesalahan pada awalnya.
• Dendrite adalah fitur-lengkap. Mungkin ada API klien atau federasi yang tidak diterapkan.
• Dendrite siap untuk penyebaran homeServer besar -besaran. Tidak ada dukungan ketersediaan tinggi/pengelompokan.

Saat ini, kami berharap Dendrite berfungsi dengan baik untuk penyebaran HomeServer kecil (10s/100s pengguna) serta node matriks P2P dalam browser atau di perangkat seluler.

Jika Anda memiliki pertanyaan lebih lanjut, silakan lihat FAQ kami atau bergabunglah dengan kami:

• #dendrite: matrix.org - obrolan umum tentang proyek dendrite, untuk pengguna dan admin server sama
• #dendrite -dev: matrix.org - tempat untuk pengembang, di mana semua diskusi pengembangan dendrit terjadi
• #dendrite -alerts: matrix.org - pemberitahuan rilis dan info penting, sangat disarankan untuk semua admin server dendrite

Persyaratan

Lihat halaman perencanaan Anda untuk informasi lebih lanjut tentang persyaratan.

Untuk membangun dendrite, Anda perlu pergi 1.21 atau lebih baru.

Untuk penyebaran dendrit federasi yang dapat digunakan, Anda juga akan membutuhkan:

• Nama domain (atau subdomain)
• Sertifikat TLS yang valid yang dikeluarkan oleh otoritas tepercaya untuk domain itu
• SRV Records atau file terkenal yang menunjuk pada penyebaran Anda

Juga direkomendasikan adalah:

• Mesin basis data PostgreSQL, yang akan berkinerja lebih baik daripada SQLite dengan banyak pengguna dan/atau kamar yang lebih besar
• Server proxy terbalik, seperti nginx, dikonfigurasi seperti sampel ini

Penguji Federasi dapat digunakan untuk memverifikasi penyebaran Anda.

Mulai

Jika Anda ingin membangun instance Dendrite yang sepenuhnya menggantikan, lihat dokumentasi instalasi. Untuk berjalan di Docker, lihat Build/Docker.

Instruksi berikut sudah cukup untuk memulai dendrite sebagai penyebaran tes yang tidak ada menggunakan sertifikat yang ditandatangani sendiri dan database 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

Kemudian arahkan klien matriks favorit Anda di http://localhost:8008 atau https://localhost:8448 .

Kemajuan

Kami menggunakan skrip yang disebut "Are We Synapse" yang memeriksa tingkat kepatuhan Sytest. Sytest adalah rig uji HomeServer kotak hitam dengan sekitar 900 tes. Skrip mengetahui berapa banyak tes ini yang lulus dendrite dan diperbarui dengan CI. Pada Januari 2023, kami memiliki paritas server server 100% dengan sinaps, dan paritas klien-server berada di 93%, meskipun memeriksa CI untuk angka terbaru. Dalam praktiknya, ini berarti Anda dapat berkomunikasi secara lokal dan melalui federasi dengan server sinaps seperti matrix.org dengan cukup baik, meskipun masih ada beberapa fitur yang hilang (seperti SSO dan API ID pihak ketiga).

Kami memprioritaskan fitur yang akan menguntungkan homeServers pengguna tunggal terlebih dahulu (mis. Penerimaan, E2E) daripada fitur yang mungkin diminati oleh penyebaran besar (OpenID, tamu, API Admin, sebagai API). Ini berarti dukungan dendrit antara lain:

• Fungsionalitas Ruang Inti (Membuat Kamar, Undangan, Aturan Auth)
• Versi kamar 1 hingga 10 didukung
• Backfilling secara lokal dan melalui Federasi
• Akun, profil, dan perangkat
• Daftar kamar yang diterbitkan
• Mengetik
• API Media
• Redaksi
• Penandaan
• Konteks
• Kunci dan daftar perangkat E2E
• Tanda terima
• Dorongan
• Tamu
• Direktori Pengguna
• Kehadiran
• Pencarian FullText

Berkontribusi

Kami akan berterima kasih atas bantuan apa pun tentang masalah yang ditandai seperti kami Synapse. Semua masalah ini memiliki sistem terkait yang perlu dilewati agar masalah ditutup. Setelah Anda menulis kode Anda, Anda dapat dengan cepat menjalankan Sytest untuk memastikan bahwa nama tes sekarang lewat.

Jika Anda baru mengenal proyek ini, lihat halaman yang berkontribusi kami untuk mempercepat, maka cari masalah pertama yang baik. Jika Anda terbiasa dengan proyek ini, cari masalah bantuan yang diinginkan.