matrix2051

matrix2051

เข้าร่วมเมทริกซ์จากไคลเอนต์ IRC ที่คุณชื่นชอบ

Matrix2051 (หรือ M51 สั้น ๆ ) เป็นเซิร์ฟเวอร์ IRC ที่ได้รับการสนับสนุนโดยเมทริกซ์ นอกจากนี้คุณยังสามารถเห็นว่ามันเป็น IRC bouncer ที่เชื่อมต่อกับ Matrix Homeservers แทนเซิร์ฟเวอร์ IRC กล่าวอีกนัยหนึ่ง:

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

เป้าหมาย:

1. ทำให้ผู้ใช้ IRC เข้าร่วมเมทริกซ์ได้อย่างง่ายดาย
2. รองรับบอทรีเลย์ที่มีอยู่เพื่อให้รีเลย์ที่ทำงานได้ดีกว่า IRC มากกว่าสะพาน IRC/Matrix ที่มีอยู่เดิม
3. การใช้งาน IRCV3 ที่มีเลือดออก
4. ติดตั้งง่ายมาก หมายความว่า:
   1. การกำหนดค่าและฐานข้อมูลน้อยที่สุดเท่าที่จะทำได้ (เป็นศูนย์ที่ดีที่สุด)
   2. ชุดย่อยขนาดเล็ก

ไม่ใช่เป้าหมาย:

1. เป็นบริการโฮสต์ (จะต้องมีการตอบโต้สแปมและนั่นเป็นงานจำนวนมาก)
2. การสนับสนุน TLS (ดูจุดก่อนหน้า) เพียงแค่เรียกใช้ใน Localhost หากคุณต้องการให้เป็นระยะไกลให้เข้าถึงผ่าน VPN หรือพร็อกซีย้อนกลับ
3. การเชื่อมต่อกับหลายบัญชีต่อการเชื่อมต่อ IRC หรือโปรโตคอลอื่น ๆ (à la bitlbee) สิ่งนี้ขัดแย้งกับเป้าหมาย 1 และ 4
4. การใช้คุณสมบัติใด ๆ ที่ไม่ได้เกิดขึ้นตามโปรโตคอล ทั้งสอง (เช่นไม่จำเป็นต้องใช้บอทบริการที่คุณหยุดใช้งานด้วยการใช้ PRIMMSG)

คุณสมบัติที่สำคัญ

• การลงทะเบียนและการตรวจสอบรหัสผ่าน
• เข้าร่วมห้องพัก
• การส่งและรับข้อความ (รองรับการจัดรูปแบบ multiline ไฮไลท์การตอบกลับตอบสนองต่อข้อความ)
• การสนับสนุน IRCV3 บางส่วน; เพียงพอที่ Gamja จะทำงาน ปัญหาการเปิด Chathistory
• รองรับชื่อการแสดงผลบางส่วน

ข้อบกพร่อง

• การแชทโดยตรงจะแสดงเป็นช่องปกติพร้อมชื่อสุ่ม
• ไม่ "รู้สึก" เหมือนเครือข่าย IRC จริง (ยัง?)
• รหัสผู้ใช้และชื่อห้องยาวอย่างไม่สบายใจ
• กำลังโหลดรายการนิคของห้องขนาดใหญ่เช่น #Matrix: matrix.org overloads ไคลเอนต์ IRC บางตัว
• ลูกค้า IRC ที่ไม่มีการรองรับสีหกเหลี่ยมจะเห็นขยะแทนสี (แม้ว่าข้อความสีจะดูแปลกมากในเมทริกซ์)
• ไคลเอนต์ IRC ที่ไม่มีงานสนับสนุน IRCV3 ขั้นสูงพลาดคุณสมบัติหลายอย่าง: การตอบกลับใบเสนอราคาตอบสนองชื่อการแสดงผล

ภาพหน้าจอ

บันทึกสองฉบับเกี่ยวกับภาพหน้าจอนี้:

• การแก้ไขข้อความจะแสดงผลด้วยทางเลือกเนื่องจากการแก้ไขข้อความยังไม่ได้รับการสนับสนุนโดย IRC
• การตอบกลับเกี่ยวกับ Irccloud นั้นแสดงด้วยไอคอนสีและการคลิกไอคอนเหล่านี้จะเปิดคอลัมน์ที่แสดงเธรดทั้งหมด ลูกค้ารายอื่นอาจตอบกลับแตกต่างกัน

การใช้งาน

• ติดตั้งการพึ่งพาระบบ ตัวอย่างเช่นใน Debian: sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
• ติดตั้ง Elixir Dependencies: mix deps.get
• เรียกใช้การทดสอบเพื่อให้แน่ใจว่าทุกอย่างทำงานได้: mix test
• Run: mix run matrix2051.exs
• เชื่อมต่อไคลเอนต์กับ localhost:2051 ด้วยการกำหนดค่าต่อไปนี้:
  • ไม่มี SSL/TLS
  • ชื่อผู้ใช้ SASL: รหัสเมทริกซ์เต็มรูปแบบของคุณ ( user:homeserver.example.org )
  • รหัสผ่าน SASL: รหัสผ่านเมทริกซ์ของคุณ

ดูด้านล่างสำหรับคำแนะนำเพิ่มเติมเพื่อทำงานกับเว็บไคลเอนต์

ดู INSTALL.md สำหรับคู่มือที่มุ่งเน้นการผลิตมากขึ้น

สถาปัตยกรรม

• matrix2051.exs เริ่ม M51.Application ซึ่งเริ่ม M51.supervisor ซึ่งดูแล:
  • config.ex : Global Config Agent
  • irc_server.ex : DynamicSupervisor ที่ได้รับการเชื่อมต่อจากไคลเอนต์ IRC

ทุกครั้งที่ irc_server.ex ได้รับการเชื่อมต่อจะวางไข่ irc_conn/supervisor.ex ซึ่งดูแล:

• irc_conn/state.ex : เก็บสถานะของการเชื่อมต่อ
• irc_conn/writer.ex : Genserver ถือซ็อกเก็ตและอนุญาตให้เขียนบรรทัดลงไป (และชุดของเส้นในอนาคต)
• irc_conn/handler.ex : งานยุ่งอยู่กับคำสั่งที่เข้ามาจากผู้อ่านคำตอบของคำตอบที่เรียบง่ายและส่งคำสั่งที่ซับซ้อนมากขึ้น
• matrix_client/state.ex : รักษาสถานะของการเชื่อมต่อกับ matrix homeserver
• matrix_client/client.ex : จัดการการเชื่อมต่อหนึ่งครั้งกับ Matrix Homeserver ในฐานะผู้ใช้รายเดียว
• matrix_client/sender.ex : ส่งเหตุการณ์ไปยัง Matrix Homeserver และ retries on on Failure
• matrix_client/poller.ex : ถาม Matrix Homeserver ซ้ำ ๆ ซ้ำ ๆ สำหรับเหตุการณ์ใหม่ (รวมถึงการซิงค์เริ่มต้น)
• irc_conn/reader.ex : งานยุ่งอยู่กับสายที่เข้ามาและส่งไปยังตัวจัดการ

สาธารณูปโภค:

• matrix/raw_client.ex : ไคลเอ็นต์เมทริกซ์ระดับต่ำ / wrapper บางรอบคำขอ http
• irc/command.ex : การจัดการสาย IRC รวมถึง "ลดระดับ" สำหรับลูกค้าที่ไม่รองรับความสามารถบางอย่าง
• irc/word_wrap.ex : การห่อเส้นทั่วไป
• format/ : แปลงระหว่างการจัดรูปแบบของ IRC และ org.matrix.custom.html
• matrix_client/chat_history.ex : ดึงประวัติข้อความจากเมทริกซ์เมื่อไคลเอนต์ IRC ร้องขอ

คำถาม

ทำไม

มีลูกค้า IRC ที่ยอดเยี่ยมมากมาย แต่ฉันไม่พบไคลเอนต์เมทริกซ์ที่ฉันชอบ ถึงกระนั้นชุมชนบางแห่งกำลังย้ายจาก IRC ไปเป็นเมทริกซ์ดังนั้นฉันจึงเขียนสิ่งนี้เพื่อที่ฉันจะได้เข้าร่วมกับลูกค้าที่สะดวกสบาย

นี่เป็นวิธีการสร้างต้นแบบคุณสมบัติ IRCV3 ล่าสุดได้อย่างง่ายดายและสำหรับฉันที่จะเรียนรู้โปรโตคอลเมทริกซ์

ลูกค้า IRC ได้รับการสนับสนุนอะไร?

ในทางทฤษฎีลูกค้า IRC ควรทำงาน โดยเฉพาะอย่างยิ่งฉันทดสอบด้วย Gamja, Irccloud, The Lounge และ Weechat

โปรดเปิดปัญหาหากลูกค้าของคุณมีปัญหาใด ๆ

รองรับ Matrix Homeservers ใด

ในทางทฤษฎีใด ๆ ที่ฉันเขียนสิ่งนี้โดยการอ่านข้อมูลจำเพาะของเมทริกซ์ ในทางปฏิบัติสิ่งนี้ถูกทดสอบด้วย synapse เท่านั้น

ข้อยกเว้นที่น่าสังเกตคือการลงทะเบียนซึ่งใช้ API เฉพาะ synapse เนื่องจากเมทริกซ์ไม่ได้ระบุการลงทะเบียน

โปรดเปิดปัญหาหากคุณมีปัญหาใด ๆ กับ Homeserver ของคุณ (การเข้าสู่ระบบหุ่นจำลอง/รหัสผ่านที่ฉันสามารถใช้เพื่อเชื่อมต่อกับมันจะได้รับการชื่นชม)

คุณวางแผนที่จะสนับสนุนคุณสมบัติ x, y, ... ?

ในช่วงเวลาของการเขียนหากทั้งเมทริกซ์และ IRC/IRCV3 สนับสนุนพวกเขา Matrix2051 น่าจะเป็น ดูรายการปัญหา 'การเพิ่มประสิทธิภาพ' แบบเปิด

ข้อยกเว้นที่น่าสังเกตคือข้อความโดยตรงเนื่องจากโมเดลของเมทริกซ์แตกต่างจาก IRC อย่างมีนัยสำคัญ

ฉันสามารถเชื่อมต่อกับเว็บไคลเอนต์ได้หรือไม่?

ในการเชื่อมต่อไคลเอนต์เว็บคุณต้องมีเกตเวย์ WebSocket Matrix2051 ได้รับการทดสอบกับ webircgateway ของ Kiwiirc (ลองใช้แพตช์นี้หากคุณต้องการเรียกใช้ในรุ่นเก่า GO)

นี่คือวิธีที่คุณสามารถกำหนดค่าให้เชื่อมต่อกับ Matrix2051 ด้วย 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 = " "

ชื่ออะไร?

นี่คือการอ้างอิงถึง XKCD 1782:

ฉันยังมีคำถามฉันจะติดต่อคุณได้อย่างไร?

เข้าร่วม #matrix2051 ที่ irc.interlinked.me (ไม่ฉันไม่ได้กินอาหารสุนัขของตัวเองฉันยังคงชอบ "พื้นเมือง" irc)