dendrite admin interface

dendrite-admin-interface

Uma interface de bot para administrar um servidor Dendrite usando a API de administração e alguma interface de banco de dados

Contribuições são muito bem-vindas, no entanto, neste momento é recomendado que você participe da sala de discussão antes de contribuir para garantir que suas contribuições estejam alinhadas com o objetivo final do projeto

Sinta-se à vontade para criar um problema para cada recurso solicitado para que, quando finalmente tiver tempo, tenha uma lista para verificar e verificar.

Espaço: #admin-interface:pain.agency | Sala de discussão: #admin-interface-support:pain.agency

Configurar

• Certifique-se de ter uma versão semi-recente do node e do npm instalada. Atualmente uso o node v18.18.0 (verifique com node -v ) e o npm versão 9.2.0 em meu vps. Se você executa o debian como eu faço no meu vps, você pode querer obter uma versão mais atualizada do node no snap store ou compilar a partir do código-fonte.
• Baixe e descompacte a última versão estável ou beta .zip ou .tar.gz de https://github.com/jjj333-p/dendrite-admin-interface/releases ou clone do branch main se você gosta de estar no limite .
• Execute npm install que deve instalar todas as dependências necessárias.
• Copie o arquivo encontrado em examples/login.yaml para db/login.yaml e preencha essas informações. Há instruções para preencher essas informações nos comentários do arquivo de exemplo.
• Execute o bot ( node index.js ).
• Os comandos estão disponíveis apenas na sala de administração definida no arquivo login.yaml.

Comandos atualmente implementados:

• evacuate User MXID | Room ID | Room Alias> ?<--preserve | -p>

  • Quando é fornecido um ID de sala ou alias, a interface executa o endpoint de evacuação da sala nesse roomID ou alias, fazendo com que todos os usuários neste servidor saiam daquela sala. Se o sinalizador --preserve ou -p não for fornecido, o endpoint de limpeza da sala também será executado, limpando o estado da sala do banco de dados.
  • Quando fornecida com um MXID de um usuário local, ou seja @localpart:your.server , a interface executará o endpoint evacuate do usuário nesse usuário, fazendo com que essa conta saia de todas as salas em que estiver.

• passwd <mxid/localpart> <log out accounts?> ?<password>

  Redefinir a senha de um usuário

  • mxid/localpart - você pode fornecer a parte local de um usuário (ou seja, jjj333 ) ou o mxid inteiro (ou seja, @jjj333:pain.agency ). Observe que deve ser um usuário local, pois não há nada que possa ser feito para usuários remotos.
  • log out accounts?
    • t ou true para desconectar todas as sessões logadas da conta.
    • f ou false para manter todas as sessões conectadas.
  • ? password - opcionalmente, defina uma senha para redefinir. Se nenhuma senha for fornecida, o padrão será uma string base64 aleatória de 35 bytes que será retornada. Por causa do Dendrite a senha deve ter pelo menos 8 caracteres. Devido a dificuldades técnicas não é possível deixar espaços em uma senha definida através desta interface.

• newaccount <mxid/localpart> ?<password>

  Crie uma nova conta de usuário normal.

  • mxid/localpart - o nome de usuário a ser criado para o usuário. Pode ser apenas a parte local ou o mxid completo.
  • ? password - senha a ser definida para a nova conta. Se nada for fornecido, uma string base64 de 35 bytes será gerada e retornada.

• deactivate <mxid/localpart>

  desativa o usuário fornecido

  • mxid/localpart - você pode fornecer a parte local de um usuário (ou seja, jjj333 ) ou o mxid inteiro (ou seja, @jjj333:pain.agency ). Observe que deve ser um usuário local, pois não há nada que possa ser feito para usuários remotos.
  • Define o nome de exibição e o pfp para aqueles definidos no bot login.yaml, pois o dendrite não os remove antes de desativá-los, portanto, precisamos higienizar e podemos adicionar um toque a ele enquanto isso.
  • Pedirá confirmação para evitar execuções acidentais
  • NOTA : este comando é permanente, use com cuidado!