dendrite admin interface

interfaz-admin-dendrita

Una interfaz de bot para administrar un servidor Dendrite usando la API de administración y alguna interfaz de base de datos.

Las contribuciones son bienvenidas; sin embargo, se recomienda en este momento que se una a la sala de discusión antes de contribuir para garantizar que sus contribuciones se alineen con el objetivo final del proyecto.

Siéntase libre de hacer un problema para cada función solicitada, de modo que cuando finalmente tenga tiempo tenga una lista para revisar y marcar.

Espacio: #admin-interface:pain.agency | Sala de debate: #admin-interface-support:pain.agency

Configuración

• Asegúrese de tener instalada una versión medio reciente de node y npm. Actualmente uso el nodo v18.18.0 (verifique con node -v ) y la versión 9.2.0 de npm en mi vps. Si ejecuta Debian como lo hago yo en mi vps, es posible que desee obtener una versión más actualizada de Node desde la tienda Snap o compilando desde la fuente.
• Descargue y descomprima la última versión estable o beta .zip o .tar.gz de https://github.com/jjj333-p/dendrite-admin-interface/releases o clone desde la rama main si desea estar a la vanguardia .
• Ejecute npm install que debería instalar todas las dependencias requeridas.
• Copie el archivo que se encuentra en examples/login.yaml a db/login.yaml y complete esa información. Hay instrucciones para completar esa información en los comentarios del archivo de ejemplo.
• Ejecute el bot ( node index.js ).
• Los comandos solo están disponibles en la sala de administración definida en el archivo login.yaml.

Comandos actualmente implementados:

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

  • Cuando se proporciona un ID o alias de habitación, la interfaz ejecuta el punto final de evacuación de habitación en ese ID de habitación o alias, lo que hace que todos los usuarios de este servidor abandonen esa habitación. Si no se proporciona el indicador --preserve o -p , también se ejecutará el punto final de purga de la sala, purgando el estado de la sala de la base de datos.
  • Cuando se le proporciona un MXID de un usuario local, es decir @localpart:your.server , la interfaz ejecutará el punto final de evacuación de usuario en ese usuario, haciendo que esa cuenta abandone todas las habitaciones en las que se encuentra.

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

  Restablecer la contraseña de un usuario

  • mxid/localpart : puede proporcionar la parte local de un usuario (es decir, jjj333 ) o el mxid completo (es decir, @jjj333:pain.agency ). Tenga en cuenta que debe ser un usuario local, ya que no se puede hacer nada con los usuarios remotos.
  • log out accounts?
    • t o true para cerrar sesión en todas las sesiones iniciadas de la cuenta.
    • f o false para mantener todas las sesiones iniciadas.
  • ? password : opcionalmente, establezca una contraseña para restablecerla. Si no se proporciona ninguna contraseña, se devolverá de forma predeterminada una cadena base64 aleatoria de 35 bytes. Gracias a Dendrite, la contraseña debe tener al menos 8 caracteres. Debido a dificultades técnicas, no puede tener espacios en una contraseña establecida a través de esta interfaz.

• newaccount <mxid/localpart> ?<password>

  Cree una nueva cuenta de usuario normal.

  • mxid/localpart : el nombre de usuario que se creará para el usuario. Puede ser solo la parte local o el mxid completo.
  • ? password : contraseña que se establecerá para la nueva cuenta. Si no se proporciona ninguno, se generará y devolverá una cadena base64 de 35 bytes.

• deactivate <mxid/localpart>

  desactiva el usuario dado

  • mxid/localpart : puede proporcionar la parte local de un usuario (es decir, jjj333 ) o el mxid completo (es decir, @jjj333:pain.agency ). Tenga en cuenta que debe ser un usuario local, ya que no se puede hacer nada con los usuarios remotos.
  • Establece el nombre para mostrar y pfp en los definidos en el bot login.yaml, ya que dendrite no los elimina antes de desactivarlos, por lo tanto, necesitamos desinfectarlos y, mientras tanto, podemos agregarle estilo.
  • Solicitará confirmación para evitar ejecuciones accidentales.
  • NOTA : este comando es permanente, ¡úselo con precaución!