Inicio
» Cómo
»
Ejecuta Mjölnir como un bot de moderación de salas Matrix con Docker.
Ejecuta Mjölnir como un bot de moderación de salas Matrix con Docker.
Si la moderación de Matrix está dispersa entre cuentas y salas personales, ejecute Mjölnir como un bot dedicado y asigne a los moderadores una sala de administración privada para recibir comandos. La configuración autoalojada más sencilla utiliza Docker Compose, una cuenta de Matrix independiente y una sala de administración cifrada; luego, agregue las salas de la comunidad que Mjölnir debe proteger y verifique sus permisos.
Qué hace Mjölnir y qué necesita
Mjölnir es un bot de moderación de Matrix que aplica listas de políticas y acciones de moderación como si fuera su propia cuenta. Un servidor principal es el servidor de Matrix que aloja las cuentas de usuario y las salas. Una sala de administración es la sala privada donde los moderadores autorizados emiten comandos al bot. Una sala protegida es una sala que Mjölnir supervisa y puede moderar.
Para esta guía, necesitas acceso a una cuenta de Matrix en el servidor principal, permiso para crear una cuenta de bot y salas, y un host con Docker Engine y el complemento Docker Compose. No necesitas que Mjölnir sea administrador del servidor principal para la moderación de salas habitual. Algunas acciones a nivel de servidor, como desactivar usuarios o cerrar salas, requieren un servidor principal Synapse y privilegios de administrador del servidor; omite esos privilegios a menos que tu caso de uso los requiera. Consulta el repositorio oficial de Mjölnir del proyecto .
1. Crea una cuenta de bot y una sala de control privada.
Regístrate con una cuenta dedicada, por ejemplo, @mjolnir:example.orgen tu servidor doméstico. No uses la cuenta personal de un moderador: las credenciales separadas facilitan la rotación del acceso y mantienen las acciones del bot diferenciadas. Crea una sala privada para moderadores, habilita el cifrado de extremo a extremo e invita tanto a los moderadores humanos como al bot. Limita la membresía a personas de tu confianza. Cualquier persona en la sala de administración configurada puede emitir comandos, y Mjölnir no proporciona permisos de comando más específicos dentro de esa sala.
Inicia sesión como el bot en un perfil de navegador independiente o en una ventana privada para obtener su token de acceso a Matrix a través de la sección Ayuda y Acerca de de Element . Copia el token de forma segura en tu configuración. Cierra esa ventana del navegador sin cerrar sesión; cerrar sesión invalida el token. La documentación oficial de configuración recomienda el cifrado para la sala de administración e indica que se debe habilitar el cifrado en la configuración de Mjölnir para que el bot pueda comunicarse allí.
La primera tarea de configuración consiste en crear una identidad de bot independiente; nunca exponga su token de acceso en una captura de pantalla o en un registro público.
2. Configura Mjölnir para tu servidor doméstico
En el host de Docker, cree un directorio de datos persistente y copie la configuración de ejemplo del proyecto en él ./mjolnir/config/production.yaml. El archivo de ejemplo documenta opciones adicionales; configure solo los valores necesarios para su implementación. Como mínimo, utilice la URL de la API del cliente de su servidor principal, el token del bot, el cifrado nativo y el ID o alias de la sala Matrix de la sala de administración:
Reemplaza cada valor de ejemplo. Un ID de sala comienza con !; un alias comienza con #. No pegues un matrix.toenlace en managementRoom. Trata el archivo de configuración y el token como secretos: restringe el acceso al archivo, mantén el archivo fuera del control de versiones y no lo publiques en las solicitudes de soporte. Si el bot no puede descifrar la sala de administración, vuelve a comprobar la configuración de cifrado y confirma que el bot se haya unido a la sala.
El ejemplo ilustra los campos de configuración necesarios; sustituya el servidor, el token y el ID de sala del ejemplo por sus propios valores.
3. Inicie el servicio Docker Compose.
Las instrucciones oficiales de Docker utilizan la matrixdotorg/mjolnirimagen y montan un directorio del host en /data. Cree docker-compose.ymljunto al mjolnirdirectorio:
Desde ese directorio, inicie Mjölnir con docker compose up -d. El directorio montado conserva la configuración y los datos del bot cuando se recrea el contenedor. La guía oficial utiliza la latestetiqueta como ejemplo; para un servidor de producción, elija una etiqueta de lanzamiento que haya probado y regístrela para que las actualizaciones sean deliberadas. A continuación, inicie con docker compose logs -f --tail 100 mjolnir. Espere los mensajes de inicio de Mjölnir en la sala de administración antes de continuar.
Inicie el servicio desde el directorio que contiene el archivo Compose y, a continuación, revise sus registros en busca de errores de inicio.
4. Cree una lista de políticas y proteja las habitaciones.
En la sala de administración, pregúntale al bot !mjolnir helpsi no responde. Crea una lista de bloqueo con un código corto y un nombre de alias de sala, luego establécela como lista predeterminada:
!mjolnir list create COC code-of-conduct-ban-list
!mjolnir default COC
Mjölnir crea la sala de la lista y te invita a unirte. Una lista de políticas es una sala de Matrix que contiene reglas de moderación, así que revisa su visibilidad y miembros antes de compartirla. Agrega cada sala de la comunidad que quieras que Mjölnir supervise:
El bot necesita suficiente poder en cada sala protegida para realizar acciones de moderación, como la capacidad de expulsar usuarios y censurar eventos. Utilice la configuración de nivel de poder de la sala para otorgar únicamente los permisos necesarios. El verifycomando verifica si Mjölnir cuenta con los permisos necesarios en las salas protegidas. Añada el bot a una sala antes de protegerla. No lo configure protectAllJoinedRoomsa la ligera: esto extiende la protección a las salas a las que se une el bot y dificulta la selección sala por sala.
Una vez que el bot responda en la sala de administración privada, cree una lista y pruebe los comandos allí.
Verifica la configuración y evita errores comunes.
El bot está en línea:docker compose ps muestra que el servicio está en funcionamiento, los registros no muestran errores repetidos de autenticación o cifrado, y el bot publica su estado de inicio en la sala de administración.
Los comandos están restringidos: los moderadores pueden usarlos !mjolnir statusen !mjolnir rulesla sala configurada. No pruebe los comandos en una sala pública.
Las habitaciones están protegidas:!mjolnir rooms se enumeran las habitaciones previstas y !mjolnir verifyse informa de los niveles de energía adecuados.
Los secretos permanecen privados: el token no se encuentra en un repositorio público, en el historial de la consola ni en los registros publicados. Si se expone, revoque o rote el token cerrando la sesión del bot y actualizando la configuración antes de reiniciarlo.
Si el bot permanece inactivo, primero confirme que el ID o alias de la sala de administración sea exacto y que el bot sea un miembro registrado. Para salas encriptadas, verifique que el cifrado esté habilitado y que el bot pueda descifrar los mensajes. Si la moderación falla solo en una sala, verifique que esté protegida y que sus niveles de permisos permitan la acción solicitada. Para obtener información sobre la sintaxis de los comandos y las opciones de configuración, consulte la guía de moderación de Mjölnir , la guía de configuración de Docker y la configuración de ejemplo .