matrix2051

Matrix2051

Treten Sie Matrix von Ihrem bevorzugten IRC -Kunden bei

Matrix2051 (oder kurz M51) ist ein IRC -Server, der von Matrix unterstützt wird. Sie können es auch als IRC -Türsteher sehen, der anstelle von IRC -Servern mit Matrix -Homeservers verbunden ist. Mit anderen Worten:

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

Ziele:

1. Machen Sie es den IRC -Benutzern einfach, sich nahtlos Matrix anzuschließen
2. Unterstützen Sie vorhandene Relais -Bots, um Relais zu ermöglichen, die sich bei IRC besser verhalten als vorhandene IRC/Matrix -Brücken
3. IRCV3-Implementierung von Blutungen
4. Sehr einfach zu installieren. Das heisst:
   1. so wenig Konfiguration und Datenbank wie möglich (idealerweise Null)
   2. Kleine Ablehnung.

Nichtgänger:

1. Ein gehosteter Service zu sein (es würde Spam -Gegenmaßnahmen erfordern, und das ist eine Menge Arbeit).
2. TLS -Unterstützung (siehe vorheriger Punkt). Führen Sie es einfach auf Localhost aus. Wenn Sie es wirklich benötigen, um abgelegen zu sein, greifen Sie über ein VPN oder einen Reverse -Proxy darauf zu.
3. Verbindung zu mehreren Konten pro IRC -Verbindung oder anderen Protokollen (à la bitlbee) herstellen. Dies steht im Widerspruch zu den Zielen 1 und 4.
4. Implementieren von Funktionen nicht nativ von beiden Protokollen (dh keine benötigten Service -Bots, die Sie mit der Verwendung von privMSG miteinander interpragen)

Hauptmerkmale

• Registrierung und Kennwortauthentifizierung
• Räume beitragen
• Senden und Empfangen von Nachrichten (unterstützt Formatierung, Multiline, Hervorhebungen, Antworten, Reagieren auf Nachrichten)
• Partielle Unterstützung von IRCV3 Chathistory; genug, damit Gamja arbeitet. Offene Chathistory -Probleme
• Teiler Anzeigename Support

Mängel

• Direkte Chats werden als reguläre Kanäle mit zufälligen Namen angezeigt
• Fühlt sich nicht wie ein echtes IRC -Netzwerk (noch?) ")
• Benutzer -IDs und Raumnamen sind unangenehm lang
• Laden der Nick -Liste der riesigen Räume wie #matrix: matrix.org überlädt einige IRC -Clients
• IRC -Kunden ohne Hex -Farbunterstützung werden Müll anstelle von Farben sehen. (Obwohl farbiger Text auf Matrix sehr ungewöhnlich erscheint)
• IRC -Kunden ohne fortgeschrittene IRCV3 -Support -Arbeit verpassen viele Funktionen: Zitat Antworten, Reaktionen, Anzeigennamen.

Screenshot

Zwei Notizen zu diesem Screenshot:

• Message -Änderungen werden mit einem Fallback vermittelt, da die Meldungstreitigkeiten von IRC noch nicht unterstützt werden.
• Antworten auf IRCCloud werden mit farbigen Symbolen gerendert, und das Klicken auf diese Symbole öffnet eine Spalte, die den gesamten Thread zeigt. Andere Kunden können Antworten anders machen.

Verwendung

• Systemabhängigkeiten installieren. Zum Beispiel auf Debian: sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
• Installieren Sie Elixir -Abhängigkeiten: mix deps.get
• Führen Sie Tests aus, um sicherzustellen, dass alles funktioniert: mix test
• Run: mix run matrix2051.exs
• Schließen Sie einen Client mit der folgenden Konfiguration an localhost:2051 an:
  • Keine SSL/TLS
  • SASL -Benutzername: Ihre vollständige Matrix -ID ( user:homeserver.example.org )
  • SASL -Passwort: Ihr Matrixkennwort

Weiter unten finden Sie zusätzliche Anweisungen, um mit Web -Clients zu arbeiten.

Eine produktionsorientiertere Anleitung siehe INSTALL.md .

Architektur

• matrix2051.exs startet M51.Application, der M51.Supervisor startet, was beaufsichtigt:
  • config.ex : Global Config Agent
  • irc_server.ex : Ein DynamicSupervisor , der Verbindungen von IRC -Clients erhält.

Jedes Mal, wenn irc_server.ex eine Verbindung empfängt, wird irc_conn/supervisor.ex erzeugt, was beaufsichtigt:

• irc_conn/state.ex : speichert den Status der Verbindung
• irc_conn/writer.ex : Genserver hält den Socket und erlaubt, Zeilen darauf zu schreiben (und in Zukunft Zeilenstapel)
• irc_conn/handler.ex : Aufgabe, die auf den eingehenden Befehlen des Lesers geschäftig sind, Antworten auf die einfachen und sendet komplexere Befehle
• matrix_client/state.ex : Hält den Zustand der Verbindung zu einem Matrix -Homeserver
• matrix_client/client.ex : Verwendet eine Verbindung zu einem Matrix -Homeserver als einzelner Benutzer
• matrix_client/sender.ex : Sendet Ereignisse an den Matrix Homeserver und mit Wiederholungen zum Ausfall
• matrix_client/poller.ex : fragt wiederholt den Matrix Homeserver nach neuen Ereignissen (einschließlich der anfänglichen Synchronisierung)
• irc_conn/reader.ex : Aufgabe, auf den eingehenden Zeilen zu erwarten, und sendet sie an den Handler

Versorgungsunternehmen:

• matrix/raw_client.ex : Matrix-Client / Dünn-Wrapper mit niedriger Ebene um HTTP-Anforderungen
• irc/command.ex : Manipulation von IRC -Linien, einschließlich "Herabstufung" für Kunden, die einige Funktionen nicht unterstützen.
• irc/word_wrap.ex : Generisches Zeilenverpackung
• format/ : Konvertieren Sie zwischen IRCs Formatierung und org.matrix.custom.html
• matrix_client/chat_history.ex : Fetches Nachrichtenverlauf von Matrix, wenn er vom IRC -Client angefordert wird

Fragen

Warum?

Es gibt viele großartige IRC -Kunden, aber ich kann keinen Matrix -Kunden finden, den ich mag. Einige Gemeinden wechseln jedoch von IRC zu Matrix, also habe ich dies geschrieben, damit ich mich mit einem komfortablen Kunden anschließen kann.

Dies ist auch eine Möglichkeit, die neuesten IRCV3 -Funktionen leicht zu prototypisieren und das Matrixprotokoll zu lernen.

Welche IRC -Kunden werden unterstützt?

Theoretisch sollte jeder IRC -Kunde funktionieren. Insbesondere teste ich es mit Gamja, Irccloud, der Lounge und Weechat.

Bitte öffnen Sie ein Problem, wenn Ihr Kunde Probleme hat.

Welche Matrix -Homeservers werden unterstützt?

Theoretisch schrieb jeder, wie ich dies schrieb, indem ich die Matrixspezifikationen liest. In der Praxis wird dies nur mit Synapse getestet.

Eine bemerkenswerte Ausnahme ist die Registrierung, bei der eine synapsenspezifische API verwendet wird, da Matrix selbst keine Registrierung angibt.

Bitte öffnen Sie ein Problem, wenn Sie ein Problem mit Ihrem HomeServer haben (ein Dummy -Login/Passwort, mit dem ich eine Verbindung damit herstellen kann, wäre geschätzt).

Planen Sie, Funktionen X, Y, ... zu unterstützen?

Zum Zeitpunkt des Schreibens wird Matrix2051, wenn sowohl Matrix als auch IRC/IRCV3 sie unterstützen, wahrscheinlich. Schauen Sie sich die Liste der offenen „Verbesserungsprobleme“ an.

Eine bemerkenswerte Ausnahme sind Direktnachrichten, da das Modell von Matrix erheblich von IRCs unterscheidet.

Kann ich eine Verbindung mit einem Web -Client herstellen?

Um Web -Clients zu verbinden, benötigen Sie ein WebSocket -Gateway. Matrix2051 wurde mit dem Webircgateway von Kiwiirc getestet (probieren Sie diesen Patch, wenn Sie es in alten Go -Versionen ausführen müssen).

So konfigurieren Sie es mit Gamja, um eine Verbindung zu Matrix2051 herzustellen:

[ 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 = " "

Was ist mit dem Namen?

Dies ist ein Verweis auf XKCD 1782:

Ich habe noch eine Frage, wie kann ich Sie kontaktieren?

Treten Sie #matrix2051 unter irc.interlinked.me bei. (Nein, ich esse nicht mein eigenes Hundefutter, ich bevorzuge immer noch "einheimische" irc.)