dendrite admin interface

interface-admin-dendrite

Une interface bot pour administrer un serveur Dendrite à l'aide de l'API d'administration et d'une interface de base de données

Les contributions sont les bienvenues, mais il est recommandé à ce moment-là de rejoindre la salle de discussion avant de contribuer afin de vous assurer que vos contributions correspondent à l'objectif final du projet.

N'hésitez pas à créer un problème pour chaque fonctionnalité demandée. Ainsi, lorsque j'aurai enfin le temps, j'aurai une liste à parcourir et à cocher.

Espace : #admin-interface:pain.agency | Salle de discussion : #admin-interface-support:pain.agency

Installation

• Assurez-vous d'avoir installé une version à moitié récente de node et npm, j'utilise actuellement node v18.18.0 (vérifiez avec node -v ) et npm version 9.2.0 sur mon vps. Si vous exécutez Debian comme je le fais sur mon vps, vous souhaiterez peut-être obtenir une version plus à jour du nœud à partir du magasin Snap ou de la construction à partir des sources.
• Téléchargez et décompressez la dernière version stable ou bêta .zip ou .tar.gz à partir de https://github.com/jjj333-p/dendrite-admin-interface/releases ou clonez à partir de la branche main si vous aimez être à la pointe de la technologie .
• Exécutez npm install qui devrait installer toutes les dépendances requises.
• Copiez le fichier trouvé dans examples/login.yaml dans db/login.yaml et remplissez ces informations. Il y a des instructions pour remplir ces informations dans les commentaires du fichier d'exemple.
• Exécutez le bot ( node index.js ).
• Les commandes sont disponibles uniquement dans la salle d'administration définie dans le fichier login.yaml.

Commandes actuellement implémentées :

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

  • Lorsqu'un ID de salle ou un alias lui est fourni, l'interface exécute le point de terminaison d'évacuation de la salle sur cet ID de salle ou cet alias, obligeant tous les utilisateurs de ce serveur à quitter cette salle. Si l'indicateur --preserve ou -p n'est pas fourni, le point de terminaison de purge de la salle sera également exécuté, purgeant l'état de la salle de la base de données.
  • Lorsqu'elle est fournie avec le MXID d'un utilisateur local, c'est-à-dire @localpart:your.server , l'interface exécutera le point de terminaison d'évacuation de l'utilisateur sur cet utilisateur, obligeant ce compte à quitter toutes les pièces dans lesquelles il se trouve.

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

  Réinitialiser le mot de passe d'un utilisateur

  • mxid/localpart - vous pouvez fournir soit la partie locale d'un utilisateur (c'est-à-dire jjj333 ), soit l'intégralité du mxid (c'est-à-dire @jjj333:pain.agency ). Notez qu'il doit s'agir d'un utilisateur local car il n'y a rien à faire pour les utilisateurs distants.
  • log out accounts?
    • t ou true pour vous déconnecter de toutes les sessions connectées du compte.
    • f ou false pour garder toutes les sessions connectées.
  • ? password - définissez éventuellement un mot de passe à réinitialiser. Si aucun mot de passe n'est fourni, il sera par défaut une chaîne base64 aléatoire de 35 octets qui sera renvoyée. Grâce à Dendrite, le mot de passe doit comporter au moins 8 caractères. En raison de difficultés techniques, vous ne pouvez pas insérer d'espace dans un mot de passe défini via cette interface.

• newaccount <mxid/localpart> ?<password>

  Créez un nouveau compte utilisateur normal.

  • mxid/localpart - le nom d'utilisateur à créer pour l'utilisateur. Il peut s'agir soit uniquement de la partie locale, soit du mxid complet.
  • ? password - mot de passe à définir pour le nouveau compte. Si aucune n'est fournie, une chaîne base64 de 35 octets sera générée et renvoyée.

• deactivate <mxid/localpart>

  désactive l'utilisateur donné

  • mxid/localpart - vous pouvez fournir soit la partie locale d'un utilisateur (c'est-à-dire jjj333 ), soit l'intégralité du mxid (c'est-à-dire @jjj333:pain.agency ). Notez qu'il doit s'agir d'un utilisateur local car il n'y a rien à faire pour les utilisateurs distants.
  • Définit le nom d'affichage et le pfp sur ceux définis dans le bot login.yaml car la dendrite ne les supprime pas avant la désactivation, nous devons donc les désinfecter et nous pouvons y ajouter du style en attendant.
  • Demandera une confirmation pour éviter les exécutions accidentelles
  • REMARQUE : cette commande est permanente, à utiliser avec prudence !