Download matrix2051 - Download Kode Sumber matrix2051

matrix2051

Kode Sumber AI

1.0.0

Unduh

Matrix2051

Bergabunglah dengan matriks dari klien IRC favorit Anda

Matrix2051 (atau M51 singkatnya) adalah server IRC yang didukung oleh matriks. Anda juga dapat melihatnya sebagai penjaga IRC yang terhubung ke matriks homeservers alih -alih server IRC. Dengan kata lain:

         IRC client
  (eg. weechat or hexchat)
             |
             |     IRC protocol
             v
         Matrix2051
             |
             |     Matrix protocol
             v
     Your Homeserver
     (eg. matrix.org)

Sasaran:

Membuatnya mudah bagi pengguna IRC untuk bergabung dengan Matrix dengan mulus
Mendukung bot relai yang ada, untuk memungkinkan relay yang berperilaku lebih baik pada IRC daripada jembatan IRC/Matrix yang ada
Implementasi IRCV3 tepi perdarahan
Sangat mudah dipasang. Ini berarti:
1. sebagai sedikit konfigurasi dan database mungkin (idealnya nol)
2. Set kecil depenensi.

Non-Goals:

Menjadi layanan yang di -host (akan membutuhkan penanggulangan spam, dan itu banyak pekerjaan).
Dukungan TLS (lihat poin sebelumnya). Jalankan saja di Localhost. Jika Anda benar -benar membutuhkannya untuk menjadi jauh, aksesnya melalui VPN atau proxy terbalik.
Menghubungkan ke beberapa akun per koneksi IRC atau ke protokol lain (à la bitlbee). Ini bertentangan dengan tujuan 1 dan 4.
Menerapkan fitur apa pun yang tidak secara asli oleh kedua protokol (mis. Tidak perlu bot layanan yang Anda interrak dengan menggunakan privmsg)

Fitur utama

Pendaftaran dan otentikasi kata sandi
Bergabung dengan kamar
Mengirim dan menerima pesan (mendukung pemformatan, multiline, highlight, membalas, bereaksi terhadap pesan)
Dukungan chathistory IRCV3 parsial; Cukup agar Gamja bekerja. Buka masalah chathistory
Dukungan nama tampilan parsial

Kekurangan

Obrolan langsung ditampilkan sebagai saluran biasa, dengan nama acak
Tidak "merasa" seperti jaringan IRC nyata (belum?)
ID pengguna dan nama kamar tidak nyaman lama
Memuat daftar Nick dari kamar besar seperti #Matrix: matrix.org membebani beberapa klien IRC
Klien IRC tanpa dukungan warna hex akan melihat beberapa sampah, bukan warna. (Meskipun teks berwarna tampaknya sangat jarang pada matriks)
Klien IRC tanpa pekerjaan dukungan IRCV3 tingkat lanjut kehilangan banyak fitur: balasan kutipan, bereaksi, nama tampilan.

Tangkapan layar

Dua catatan di tangkapan layar ini:

Pengeditan pesan diterjemahkan dengan fallback, karena pengeditan pesan belum didukung oleh IRC,
Balasan tentang Irccloud diberikan dengan ikon berwarna, dan mengklik ikon -ikon ini membuka kolom yang menunjukkan seluruh utas. Klien lain dapat memberikan balasan secara berbeda.

Penggunaan

Instal dependensi sistem. Misalnya, di debian: sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
Instal Elixir Dependencies: mix deps.get
Jalankan tes untuk memastikan semuanya berfungsi: mix test
Jalankan: mix run matrix2051.exs
Hubungkan klien ke localhost:2051 , dengan konfigurasi berikut:
- Tidak ada SSL/TLS
- Nama Pengguna SASL: ID Matriks Lengkap Anda ( user:homeserver.example.org )
- Kata Sandi SASL: Kata Sandi Matriks Anda

Lihat di bawah untuk instruksi tambahan untuk bekerja dengan klien web.

Lihat INSTALL.md untuk panduan yang lebih berorientasi produksi.

Arsitektur

matrix2051.exs Mulai M51.Application, yang memulai M51.Supervisor, yang mengawasi:
- config.ex : agen konfigurasi global
- irc_server.ex : DynamicSupervisor yang menerima koneksi dari klien IRC.

Setiap kali irc_server.ex menerima koneksi, itu memunculkan irc_conn/supervisor.ex , yang diawasi:

irc_conn/state.ex : Menyimpan status koneksi
irc_conn/writer.ex : Genserver memegang soket dan memungkinkan untuk menulis garis untuk itu (dan batch garis di masa depan)
irc_conn/handler.ex : Tugas sibuk menunggu perintah yang masuk dari pembaca, jawaban untuk yang sederhana, dan mengirimkan perintah yang lebih kompleks
matrix_client/state.ex : menjaga keadaan koneksi ke matriks homeerver
matrix_client/client.ex : Menangani satu koneksi ke Matrix HomeServer, sebagai satu pengguna
matrix_client/sender.ex : Mengirim acara ke Matrix HomeServer dan dengan retries pada kegagalan
matrix_client/poller.ex : berulang kali meminta Matrix HomeServer untuk acara baru (termasuk sinkronisasi awal)
irc_conn/reader.ex : Tugas sibuk menunggu di baris yang masuk, dan mengirimkannya ke pawang

Utilitas:

matrix/raw_client.ex : Klien Matriks Tingkat Rendah / Pembungkus Tipis di sekitar Permintaan HTTP
irc/command.ex : Manipulasi garis IRC, termasuk "menurunkan" mereka untuk klien yang tidak mendukung beberapa kemampuan.
irc/word_wrap.ex : Pembungkus garis generik
format/ : Konversi antara pemformatan IRC dan org.matrix.custom.html
matrix_client/chat_history.ex : Mengambil riwayat pesan dari matriks, jika diminta oleh klien IRC

Pertanyaan

Mengapa?

Ada banyak klien IRC yang hebat, tetapi saya tidak dapat menemukan klien matriks yang saya sukai. Namun, beberapa komunitas pindah dari IRC ke matriks, jadi saya menulis ini sehingga saya dapat bergabung dengan mereka dengan klien yang nyaman.

Ini juga merupakan cara untuk membuat prototipe fitur IRCV3 terbaru dengan mudah, dan bagi saya untuk mempelajari protokol matriks.

Klien IRC apa yang didukung?

Secara teori, setiap klien IRC harus bekerja. Secara khusus, saya mengujinya dengan Gamja, Irccloud, Lounge, dan Weechat.

Harap buka masalah jika klien Anda memiliki masalah.

Matrix Homeservers apa yang didukung?

Secara teori, apa pun, seperti yang saya tulis ini dengan membaca spesifikasi matriks. Dalam praktiknya, ini hanya diuji dengan sinaps.

Pengecualian penting adalah pendaftaran, yang menggunakan API spesifik sinapsis karena matriks itu sendiri tidak menentukan pendaftaran.

Harap buka masalah jika Anda memiliki masalah dengan HomeServer Anda (login/kata sandi dummy yang dapat saya gunakan untuk terhubung ke sana akan dihargai).

Apakah Anda berencana untuk mendukung fitur x, y, ...?

Pada saat penulisan, jika Matrix dan IRC/IRCV3 mendukung mereka, Matrix2051 kemungkinan akan. Lihatlah daftar masalah 'peningkatan' terbuka.

Pengecualian penting adalah pesan langsung, karena model Matrix berbeda secara signifikan dari IRC.

Bisakah saya terhubung dengan klien web?

Untuk menghubungkan klien web, Anda memerlukan gateway Websocket. Matrix2051 diuji dengan Webircgay Kiwiirc (coba tambalan ini jika Anda perlu menjalankannya di versi GO lama).

Inilah cara Anda dapat mengonfigurasinya untuk terhubung ke matrix2051 dengan gamja:

[ fileserving ]
enabled = true
webroot = " /path/to/gamja "


[ upstream . 1 ]
hostname = " localhost "
port = 2051
tls = false
# Connection timeout in seconds
timeout = 20
# Throttle the lines being written by X per second
throttle = 100
webirc = " "
serverpassword = " "