Главная
» Как сделать
»
Запустите Mjölnir в качестве бота для модерации комнат Matrix с помощью Docker.
Запустите Mjölnir в качестве бота для модерации комнат Matrix с помощью Docker.
Если модерация Matrix распределена по личным аккаунтам и комнатам, запустите Mjölnir как выделенного бота и предоставьте модераторам одну частную комнату управления для команд. Простейшая самостоятельная настройка использует Docker Compose, отдельный аккаунт Matrix и зашифрованную комнату управления; затем вы добавляете комнаты сообщества, которые Mjölnir должен защищать, и проверяете его права доступа.
Чем занимается «Мьёльнир» и что ему нужно.
Mjölnir — это бот-модератор Matrix, который применяет списки правил и выполняет действия модерации от имени своей учетной записи. Домашний сервер — это сервер Matrix, на котором размещаются учетные записи пользователей и комнаты. Комната управления — это приватная комната, где авторизованные модераторы отдают команды боту. Защищенная комната — это комната, которую Mjölnir отслеживает и может модерировать.
Для выполнения этого руководства вам потребуется доступ к учетной записи Matrix на домашнем сервере, разрешение на создание учетной записи бота и комнат, а также хост с Docker Engine и плагином Docker Compose. Для обычной модерации комнат вам не нужно назначать Mjölnir администратором домашнего сервера. Некоторые действия на уровне сервера, такие как деактивация пользователей или закрытие комнат, требуют домашнего сервера Synapse и прав администратора сервера; не назначайте эти права, если только они не требуются для вашего конкретного случая. См. официальный репозиторий Mjölnir проекта .
1. Создайте аккаунт бота и личную комнату управления.
Зарегистрируйте отдельный аккаунт, например, @mjolnir:example.orgна вашем домашнем сервере. Не используйте личный аккаунт модератора: отдельные учетные данные упрощают ротацию доступа и позволяют различать действия бота. Создайте приватную комнату для модераторов, включите сквозное шифрование и пригласите как модераторов-людей, так и бота. Ограничьте членство только теми, кому вы доверяете. Любой человек в настроенной комнате управления может отдавать команды, и Mjölnir не предоставляет более детальных прав доступа к командам внутри этой комнаты.
Войдите в систему как бот в отдельном профиле браузера или в приватном окне, чтобы получить токен доступа к Matrix через настройки «Справка и информация» в Element . Скопируйте токен в свою конфигурацию безопасным способом. Закройте это окно браузера, не выходя из системы; выход из системы аннулирует токен. В официальной документации по настройке рекомендуется использовать шифрование для комнаты управления и указано, что необходимо включить шифрование в конфигурации Mjölnir, чтобы бот мог взаимодействовать там.
Первоочередная задача настройки — создание отдельного идентификатора бота; ни в коем случае не раскрывайте его токен доступа на скриншоте или в публичном журнале.
2. Настройте Мьёльнир для вашего домашнего сервера.
На хосте Docker создайте каталог для постоянных данных и скопируйте в него пример конфигурации проекта ./mjolnir/config/production.yaml. В примере файла описаны дополнительные параметры; задайте только те значения, которые необходимы для вашего развертывания. Как минимум, используйте URL-адрес клиентского API вашего домашнего сервера, токен бота, встроенное шифрование и идентификатор или псевдоним комнаты управления Matrix:
Замените все примерные значения. Идентификатор комнаты начинается с !; псевдоним начинается с #. Не вставляйте matrix.toссылку в managementRoom. Рассматривайте файл конфигурации и токен как секреты: ограничьте доступ к файлу, не допускайте его попадания в систему контроля версий и не публикуйте его в запросах в службу поддержки. Если бот не может расшифровать комнату управления, перепроверьте настройки шифрования и подтвердите, что бот присоединился к комнате.
В примере показаны необходимые поля конфигурации; замените указанные в примере сервер, токен и идентификатор комнаты своими значениями.
3. Запустите службу Docker Compose.
В официальных инструкциях Docker используется matrixdotorg/mjolnirобраз, и каталог хоста монтируется в /data. Создайте docker-compose.ymlрядом с этим mjolnirкаталогом:
Из этой директории запустите Mjölnir с помощью команды docker compose up -d`.`. Смонтированная директория сохранит конфигурацию и данные бота при повторном создании контейнера. В официальном руководстве latestв качестве примера используется тег; для производственного сервера выберите протестированный вами тег релиза и запишите его, чтобы обновления выполнялись целенаправленно. После запуска выполните команду ` docker compose logs -f --tail 100 mjolnir.`. Дождитесь сообщений о запуске Mjölnir в комнате управления, прежде чем продолжить.
Запустите службу из каталога, содержащего файл Compose, затем просмотрите ее журналы на наличие ошибок запуска.
4. Составьте список правил и обеспечьте безопасность номеров.
В комнате управления, !mjolnir helpесли бот не отвечает, запросите у него разрешение. Создайте список заблокированных пользователей с коротким кодом и псевдонимом комнаты, затем сделайте его списком по умолчанию:
!mjolnir list create COC code-of-conduct-ban-list
!mjolnir default COC
Mjölnir создает список рассылки и приглашает вас в него. Список рассылки — это комната Matrix, содержащая правила модерации, поэтому перед тем, как поделиться им, проверьте его видимость и состав участников. Добавьте каждую комнату сообщества, которую вы хотите, чтобы Mjölnir отслеживал:
Для выполнения модерационных действий, обычно включающих блокировку пользователей и редактирование событий, боту требуется достаточная мощность в каждой защищенной комнате. Используйте настройки уровня мощности комнаты, чтобы предоставить только необходимые разрешения. Команда verifyпроверяет, есть ли у Mjölnir необходимые разрешения в защищенных комнатах. Добавьте бота в комнату перед тем, как защищать ее. Не устанавливайте эти параметры protectAllJoinedRoomsпроизвольно: это расширит защиту на комнаты, в которые бот присоединяется, и сделает выбор комнат по отдельности менее удобным.
После того, как бот ответит в приватной комнате управления, создайте список и протестируйте команды там.
Проверьте настройки и избегайте распространенных ошибок.
Бот находится в сети:docker compose ps отображается информация о работе сервиса, в логах отсутствуют повторяющиеся ошибки аутентификации или шифрования, и бот публикует свой статус запуска в комнате управления.
Использование команд ограничено: модераторы могут использовать !mjolnir statusих !mjolnir rulesв настроенной комнате. Не тестируйте команды в общедоступной комнате.
Помещения защищены:!mjolnir rooms отображается список предназначенных для них помещений и !mjolnir verifyсообщается об адекватном уровне электропитания.
Секреты остаются конфиденциальными: токен не хранится в общедоступном репозитории, истории командной строки или опубликованных логах. В случае утечки, токен следует отозвать или сменить, выйдя из сессии бота и обновив конфигурацию перед перезапуском.
Если бот молчит, сначала убедитесь, что идентификатор или псевдоним комнаты управления указан верно и что бот является зарегистрированным участником. Для зашифрованных комнат проверьте, включено ли шифрование и может ли бот расшифровывать сообщения. Если модерация не удается только в одной комнате, убедитесь, что она защищена и что ее уровни мощности позволяют выполнить запрошенное действие. Для получения информации о синтаксисе команд и параметрах конфигурации обратитесь к текущему руководству модератора Mjölnir , руководству по настройке Docker и примеру конфигурации .