matrix2051

Matrix2051

Junte -se à Matrix do seu cliente IRC favorito

Matrix2051 (ou M51 para curta) é um servidor IRC apoiado pela Matrix. Você também pode vê -lo como um segurança do IRC que se conecta a Matrix HomeServers em vez de servidores IRC. Em outras palavras:

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

Metas:

1. Facilitar para os usuários do IRC se juntarem à matriz sem problemas
2. Apoie os bots de retransmissão existentes, para permitir relés que se comportam melhor no IRC do que as pontes IRC/Matrix existentes
3. Implementação do IRCV3 de borda sangrando
4. Muito fácil de instalar. Isso significa:
   1. o mínimo de configuração e banco de dados possível (idealmente zero)
   2. Pequeno conjunto de depenências.

Não-Goals:

1. Sendo um serviço hospedado (exigiria contramedidas de spam, e isso é muito trabalho).
2. Suporte TLS (consulte o ponto anterior). Basta executá -lo no host local. Se você realmente precisa que seja remoto, acessá -lo por meio de uma VPN ou proxy reverso.
3. Conectando a várias contas por conexão IRC ou a outros protocolos (à la bitlbee). Isso conflita com os objetivos 1 e 4.
4. Implementando quaisquer recursos não nativamente por ambos os protocolos (ou seja, não há necessidade de bots de serviço que você interna com o uso do PrivMSG)

Principais características

• Autenticação de registro e senha
• Juntar quartos
• Enviando e recebendo mensagens (suporta formatação, multilina, destaques, resposta, reagindo a mensagens)
• Suporte parcial de Chathistory IRCV3; O suficiente para Gamja funcionar. Problemas abertos de chathistory
• Suporte parcial do nome da tela

Deficiências

• Os bate -papos diretos são mostrados como canais regulares, com nomes aleatórios
• Ainda não se sente como uma rede de IRC real (ainda?)
• IDs de usuário e nomes de quartos são desconfortavelmente longos
• Carregando a lista Nick de quartos enormes como #Matrix: Matrix.org sobrecarrega alguns clientes do IRC
• Os clientes do IRC sem suporte de cores hexadecipais verão um pouco de lixo em vez de cores. (Embora o texto colorido pareça muito incomum na matriz)
• Os clientes do IRC sem o trabalho avançado de suporte do IRCV3 perdem muitos recursos: respostas de citações, reagem, nomes de exibição.

Captura de tela

Duas notas nesta captura de tela:

• As edições de mensagens são renderizadas com um retorno, pois as edições de mensagens ainda não são suportadas pelo IRC,
• As respostas no IrcCloud são renderizadas com ícones coloridos e clicar nesses ícones abre uma coluna mostrando o thread inteiro. Outros clientes podem prestar respostas de maneira diferente.

Uso

• Instalar dependências do sistema. Por exemplo, no Debian: sudo apt install elixir erlang erlang-dev erlang-inets erlang-xmerl
• Instale as dependências do elixir: mix deps.get
• Execute testes para garantir que tudo esteja funcionando: mix test
• Run: mix run matrix2051.exs
• Conecte um cliente ao localhost:2051 , com a seguinte configuração:
  • Sem SSL/TLS
  • Nome de usuário SASL: seu ID da matriz completa ( user:homeserver.example.org )
  • Senha SASL: sua senha da matriz

Veja abaixo as instruções extras para trabalhar com clientes da Web.

Consulte INSTALL.md para um guia mais orientado para a produção.

Arquitetura

• matrix2051.exs inicia M51.Application, que inicia M51.Supervisor, que supervisiona:
  • config.ex : agente de configuração global
  • irc_server.ex : Um DynamicSupervisor que recebe conexões de clientes do IRC.

Toda vez que irc_server.ex recebe uma conexão, ele gera irc_conn/supervisor.ex , que supervisiona:

• irc_conn/state.ex : armazena o estado da conexão
• irc_conn/writer.ex : Genserver segurando o soquete e permitindo escrever linhas para ele (e lotes de linhas no futuro)
• irc_conn/handler.ex : tarefas ocupadas nos comandos que recebem do leitor, responde aos simples e despacha comandos mais complexos
• matrix_client/state.ex : mantém o estado da conexão com um Matrix HomeServer
• matrix_client/client.ex : lida com uma conexão com um Matrix HomeServer, como um único usuário
• matrix_client/sender.ex : envia eventos para o Matrix HomeServer e com tentativas no fracasso
• matrix_client/poller.ex : pergunta repetidamente ao Matrix HomeServer para novos eventos (incluindo a sincronização inicial)
• irc_conn/reader.ex : tarefas ocupadas nas linhas de entrada e as envia para o manipulador

Utilitários:

• matrix/raw_client.ex : cliente de matriz de baixo nível / wrapper Thin em torno de solicitações HTTP
• irc/command.ex : Manipulação da linha IRC, incluindo "rebaixá -los" para clientes que não suportam alguns recursos.
• irc/word_wrap.ex : embalagem de linha genérica
• format/ : converta entre a formatação do IRC e org.matrix.custom.html
• matrix_client/chat_history.ex : busca histórico de mensagens da Matrix, quando solicitado pelo cliente IRC

Questões

Por que?

Existem muitos ótimos clientes do IRC, mas não consigo encontrar um cliente Matrix que eu goste. No entanto, algumas comunidades estão se movendo do IRC para a Matrix, então eu escrevi isso para que eu possa me juntar a eles com um cliente confortável.

Essa também é uma maneira de prototipar os recursos mais recentes do IRCV3 facilmente e para aprender o protocolo Matrix.

Quais clientes do IRC são suportados?

Em teoria, qualquer cliente do IRC deve funcionar. Em particular, testo com Gamja, Irccloud, The Lounge e Weechat.

Abra um problema se o seu cliente tiver algum problema.

Quais serventes matriciais são suportados?

Em teoria, qualquer, como escrevi isso lendo as especificações da matriz. Na prática, isso é testado apenas com sinapse.

Uma exceção notável é o registro, que usa uma API específica de sinapse, pois a própria matriz não especifica o registro.

Por favor, abra um problema se você tiver algum problema com o seu HomeServer (um login/senha dummy que eu posso usar para conectar -se a ele seria apreciado).

Você está planejando apoiar os recursos x, y, ...?

No momento da redação deste artigo, se a matriz e o IRC/IRCV3 os apoiarem, o Matrix2051 provavelmente o fará. Dê uma olhada na lista de problemas abertos de 'aprimoramento'.

Uma exceção notável são mensagens diretas, porque o modelo de Matrix difere significativamente dos IRCs.

Posso me conectar com um cliente da web?

Para conectar clientes da Web, você precisa de um gateway do WebSocket. O MATRIX2051 foi testado com o Webircgateway da Kiwiirc (tente este patch se precisar executá -lo nas versões antigas do Go).

Aqui está como você pode configurá -lo para conectar -se ao Matrix2051 com 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 = " "

O que há com o nome?

Esta é uma referência ao XKCD 1782:

Ainda tenho uma pergunta, como posso entrar em contato com você?

Junte -se a #Matrix2051 em irc.interlinked.me. (Não, eu não estou comendo meu próprio cachorro, ainda prefiro o IRC "nativo".)