chitchatter

Bilhete

_{Logotipo fornecido por @ramyashreeshetty}

O Citchatter é uma ferramenta de comunicação gratuita (como em preço e liberdade). Projetado para ser a maneira mais simples de se conectar com outras pessoas de maneira privada e segura, é:

• Código totalmente aberto (licenciado no GPL V2)
• Pessoa para pessoa
  • Sempre que possível, caso contrário, um servidor de turno é usado para garantir uma conexão confiável de pares
• Criptografado de ponta a ponta (via webrtc)
• Efêmero
  • O conteúdo da mensagem nunca se persiste no disco no cliente ou no servidor
• Descentralizado
  • Não há servidor de API. Tudo o que é necessário para que o Chitchatter funcione é a disponibilidade do GitHub para ativos estáticos e servidores públicos de retransmissão da Web e atordoamento/turno para estabelecer a comunicação ponto a ponto.
• Incorporável
• Auto-hospedável

O bilhete usa o Vite. A mágica segura de rede e streaming não seria possível sem o Trystero. A funcionalidade de transferência de arquivos é alimentada por secure-file-transfer .

Status

Como usá -lo

Abra https://chitchatter.im/ e junte -se a uma sala para começar a conversar com qualquer outra pessoa que esteja na sala. Por padrão, os nomes de quartos são UUIDs aleatórios que são gerados no lado do cliente. Para se comunicar em particular com alguém, é recomendável ingressar em uma dessas salas geradas aleatoriamente e compartilhar o URL (através do botão "?" Na parte superior da página) para quem você deseja se comunicar por meio de um meio seguro de sua escolha (como nota de queimador ou yopass). Seu nome de usuário será apresentado a você, e seria bom compartilhar isso com com quem você estará conversando com antecedência, para que eles saibam que estão falando com você.

Características

• Vários pares por quarto (limitado apenas pelo número de conexões de pares que seu navegador suporta).
• Salas públicas e privadas.
• Vídeo e bate -papo de áudio.
• Compartilhamento de tela.
• Mensagens diretas.
• Compartilhamento de arquivos:
  • Transferências ilimitadas de tamanho de arquivo.
  • Os arquivos são criptografados antes de enviar e descriptografados pelo receptor (a chave é o nome da sala).
• Incorporando -se a outros aplicativos da Web via iframe .
• Suporte a desbaste via react-markdown .
  • Inclui suporte ao destaque da sintaxe do código.
• Conversa a culatra de colegas quando um novo participante se une.
• Suporte a mensagens multilinas (mantenha shift e pressione enter ).
• Temas escuros e claros.
• Verificação automática de colegas por meio de criptografia de chave pública do lado do cliente.

Anti-recurso

• As mensagens nunca são persistidas para o disco. Quando você deixa uma sala de colegas, as mensagens são limpas da memória e não podem ser recuperadas.
• O Citchatter é um aplicativo de comunicação totalmente do lado do cliente. Ele usa servidores públicos da WebTorrent para estabelecer conexões de pares e atordoar/virar servidores de relé quando conexões diretas ponto a ponto não podem ser estabelecidas, mas não há servidor de API do Citchatter.
• Nenhuma análise, rastreamento ou telemetria de qualquer tipo.
• Este é um projeto orientado à comunidade e não financiado que não ganha dinheiro. Os usuários vêm primeiro e não há influência corporativa ou interesse financeiro envolvido.

Por que outro aplicativo de bate -papo?

Não há escassez de aplicativos de bate-papo amigáveis disponíveis, mas eles confiam em um serviço central para facilitar a comunicação. É difícil confiar nesses serviços centrais, pois os interesses comerciais e a pressão do governo podem obrigar os operadores de serviços a trabalhar contra o melhor interesse dos usuários. Mesmo quando os dados do usuário são tratados de boa fé pelos operadores de serviço, resta a possibilidade de que os dados criptografados mantidos em repouso possam ser descriptografados contra a vontade do usuário.

O Citchatter projeta esses riscos com uma arquitetura de malha da web. Não existe um operador de serviço central que armazena ou potencialmente mal a dados de comunicação. Alguns serviços são necessários para estabelecer uma conexão inicial entre pares, mas, caso contrário, o aplicativo usa comunicação direta ponto a ponto para tudo. Quaisquer serviços usados pelo Citchatter não têm associação com o projeto e estão disponíveis publicamente para que todos usem.

Casos de uso

Citchatter oferece uma solução privada e segura para:

• Organização de grupos de pessoas, como sindicatos ou movimentos políticos
• Convenientemente mover texto ou dados de um dispositivo para outro
• Conversando em vídeo com amigos e familiares em sistemas operacionais (como Android e iOS)
• Solução de problemas via compartilhamento de tela
• Transmissão ao vivo
• Compartilhando informações confidenciais, como senhas
• Muito mais!

---

Nota do desenvolvedor

Iquudar o status do projeto

Considero que o Flitchatter é preenchido na medida em que faz tudo o que eu preciso pessoalmente para fazer. Não tenho planos específicos para adicionar funcionalidades significativas no futuro, mas posso fazê -lo se parecer divertido para mim no momento. Estou comprometido em corrigir bugs significativos relatados; portanto, abra um problema se você descobrir um! Além disso, o Citchatter está efetivamente no modo de manutenção no futuro próximo.

Se você deseja que um recurso seja implementado e esteja disposto a pagar um custo de desenvolvimento para garantir que ele seja feito, registre um problema do GitHub descrevendo o recurso e indique que está disposto a compensar o trabalho. Se você não estiver disposto a pagar, abra um problema do GitHub independentemente. Posso implementá -lo se parecer divertido, mas outros membros da comunidade também podem avançar para implementá -lo por meio de solicitações de puxar.

Sempre farei de suporte de tempo, puxe solicitações de outras pessoas. Se você estiver disposto a fazer o trabalho para melhorar o Citchatter, estou disposto a ajudar o pastor que trabalha junto e enviá -lo.

Se você não concorda com a direção do projeto, poderá ser bem -vindo ao Fork Citchatter e levá -lo em outro.

Suporte e desenvolvimento personalizado

Estou disposto a fazer instalações pagas e personalizações de cromadas para suas necessidades. Se você quiser me contratar para criar uma versão do Citchatter que seja personalizada para você, envie -me um email para me @jeremyckahn.com e deixe -me saber o que você tem em mente para começar.

---

Veracidade

O núcleo do modelo de segurança do Citchatter é o fato de ser totalmente aberto. Você é gratuito (e incentivado) a auditar completamente o código -fonte e a infraestrutura do projeto. Não apenas o código -fonte está disponível nos termos da GPL, mas todos os registros de construção também são acessíveis ao público.

Se você deseja verificar se o aplicativo hospedado em https://chitchatter.im/ é o que está hospedado no Github, você pode usar dig :

 $ dig chitchatter.im

; <<>> DiG 9.18.1-1ubuntu1.1-Ubuntu <<>> chitchatter.im
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 61332
;; flags: qr rd ra; QUERY: 1, ANSWER: 5, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 65494
;; QUESTION SECTION:
;chitchatter.im.                        IN      A

;; ANSWER SECTION:
chitchatter.im.         231     IN      CNAME   jeremyckahn.github.io.
jeremyckahn.github.io.  231     IN      A       185.199.111.153
jeremyckahn.github.io.  231     IN      A       185.199.110.153
jeremyckahn.github.io.  231     IN      A       185.199.109.153
jeremyckahn.github.io.  231     IN      A       185.199.108.153

Para examinar os ativos estáticos que são servidos para os usuários finais, você pode auditar a filial gh-pages .

Roteiro do projeto

Veja o backlog completo do ingresso aqui.

Ambientes

• Ambiente de produção: https://chitchatter.im/
  • Espelho: https://chitchatter.vercel.app/ (observe que os colegas não podem se conectar nos domínios)
• Apertação: https://chitchatter-git-develop-jeremyckahn.vercel.app/

Sdk

Você pode usar o SDK oficial do Citchatter para incorporar o aplicativo como um componente da Web chamado <chat-room /> .

 < script src =" https://chitchatter.im/sdk.js " > </ script >

< chat-room />

O componente <chat-room /> suporta os seguintes atributos opcionais:

• room : o nome da sala do batchatter que o usuário deve entrar. O valor padrão é o URL da página de incorporação.
• user-name : o nome amigável do usuário (que eles podem mudar).
• user-id : o ID estático do usuário. O valor padrão é um UUID aleatório.
• root-url : O URL da instância do Citchatter para usar. O valor padrão é https://chitchatter.im/ .
• color-mode : light ou dark . O valor padrão está dark .
• play-message-sound : se deve ou não reproduzir um som quando um usuário recebe uma mensagem enquanto a janela não está em foco. O valor padrão é false .

Bem como os seguintes atributos padrão <iframe />

• height
• width
• style
• referrerpolicy
• sandbox

Desenvolvendo Citchatter

Importante

Atualmente, o Citchatter só pode ser desenvolvido em sistemas *nix, como Linux e MacOS. Se você estiver usando o Windows, poderá usar o WSL para configurar um ambiente Linux.

Para fazer alterações no Citchatter, clone o código -fonte do GitHub. Verifique se você possui o nó e o NPM instalado. Então, no diretório do projeto, execute:

 npm install

Isso instalará todas as dependências.

Scripts disponíveis

No diretório do projeto, você pode executar:

npm dev

Executa toda a pilha (cliente + rastreador WebTorrent) localmente.

npm start

Executa o aplicativo front -end no modo de desenvolvimento. Usa rastreadores públicos da WebCorrent. Abra http: // localhost: 3000 para visualizá -lo no seu navegador.

A página será recarregada quando você fizer alterações. Você também pode ver quaisquer erros de fiapos no console.

npm test

Inicia o corredor de teste no modo de relógio interativo.

npm run build

Construa o aplicativo para produção na pasta dist . Os pacotes corretamente reagem no modo de produção e otimiza a construção para obter o melhor desempenho.

A construção é minificada e os nomes de arquivos incluem os hashes.

Auto-hospedagem

O bilhete foi projetado para ser bifurcado e auto-hospedado. Se você deseja alterar a configuração do emparelhamento ou do servidor de retransmissão ou preferir controlar suas próprias construções e versões, bifurque este repositório e siga as etapas abaixo.

Importante

As conexões de pares de bilhete estão ligadas ao domínio da instância. Portanto, um usuário do Citchatter em https://chitchatter.im/ não seria capaz de se conectar a um usuário de uma instância de bitnack em outro domínio (como um garfo pessoal hospedado no Github).

Etapas necessárias após o bifurrão

Supondo que você esteja hospedando Citchatter nas páginas do Github:

1. Altere a propriedade homepage no package.json para qualquer instância da sua instância do seu bilhete será hospedada. Isso será algo como https://github_user_or_org_name.github.io/chitchatter/ .
2. Definir um segredo de ação do DEPLOY_KEY Github (em https://github.com/github_user_or_org_name/chitchatter/settings/secrets/actions ). Consulte os Docs para peaceiris/actions-gh-pages para obter mais informações.
3. Se você estiver usando páginas do Github sem um domínio personalizado, precisará definir o nome do repo como a propriedade base em vite.config.ts . Aqui está um exemplo de como isso pode parecer:

 const config = ( ) => {
   return defineConfig ( {
      base : '/chitchatter/' ,
      build : {
       ...
} 

Implantação

No github

Quando hospedado nas páginas do GitHub e a configuração acima foi realizada, o ambiente de produção é atualizado quando a ramificação main remota é atualizada (uma vez que as ações do GitHub estiverem ativadas).

Em hosts não-GitHub

Crie o aplicativo com npm run build e sirva o diretório dist . Qualquer solução de porção de arquivo estático deve funcionar, desde que esteja usando um contexto seguro.

Configuração de tempo de execução

Explore os arquivos no src/config para modificar a configuração de emparelhamento e retransmissão do servidor.

Personalização temática

O Citchatter utiliza a biblioteca de componentes MUI, que é terminável. Você pode personalizar a aparência de Citchatter modificando a definição do tema do shell.

Solução de problemas

Se você tiver algum problema com uma instalação personalizada, primeiro verifique se está usando a versão mais recente do código. Se você estiver hospedando sua instalação com as páginas do Github, sincronize sua filial main e não a sua ramificação gh-pages . A atualização da sua filial main acionará uma reconstrução adequada da sua filial gh-pages .

• https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

Colegas não se conectam

Isso pode acontecer por vários motivos. O mais provável é que um ou mais pares não podem se conectar diretamente e devem usar o relé de atordoamento/turno configurado como fallback. O relé padrão é gratuito e não garante nenhum nível de serviço; portanto, pode simplesmente não estar disponível por algum tempo (ou simplesmente não funcionar para alguns usuários). Não há muito o que fazer senão esperar até que fique disponível novamente, ou possivelmente tente de outro dispositivo ou local.

Questões específicas para navegadores com extensões de bloqueio de anúncios

Alguns bloqueadores de anúncios (como o Ublock Origin) impedem conexões com determinados servidores da WebTorrent. Isso impede que os colegas da Citchatter se conectem. Para contornar isso, você pode desativar seu bloqueador de anúncios ou se auto-hospedar sua própria instância de Citchatter.

Questões específicas para iOS Safari

O Citchatter trabalha no iOS Safari, mas os bugs no nível do navegador geralmente impedem os colegas de se juntar à sala quando o navegador é fechado e posteriormente reaberto (por exemplo, ao alternar aplicativos). A solução alternativa sugerida para esta questão é refrescar a página para se juntar à sala.

Questões específicas para o Firefox

Por #36, verifique se você about:config e verifique se media.peerconnection.enabled está ativado .

Os arquivos oferecidos não podem ser baixados de colegas

O Citchatter usa StreamSaver.js para facilitar grandes transferências de arquivos. Sabe -se que os gerentes de download como FDM interferem no StreamSaver.js, por isso é recomendável desativar esses gerentes de download ao tentar receber arquivos.

Segurança

O Citchatter passa por auditorias semanais de segurança para identificar e abordar possíveis vulnerabilidades. Relatórios de todas as auditorias podem ser encontrados em questões .

Colaboradores

️ Isenção de responsabilidade

Ao usar o Citchatter, você concorda em aceitar total responsabilidade por suas ações relacionadas ao seu uso. Além disso, você concorda em não manter nenhum contribuinte para o projeto Citchatter responsável por qualquer resultado do seu uso. Os desenvolvedores de Citchatter não endossam atividades ilegais.