Запустите 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, чтобы бот мог взаимодействовать там.

Форма настройки учетной записи Matrix для выделенного бота Mjölnir с замаскированным токеном доступа.
Первоочередная задача настройки — создание отдельного идентификатора бота; ни в коем случае не раскрывайте его токен доступа на скриншоте или в публичном журнале.

2. Настройте Мьёльнир для вашего домашнего сервера.

На хосте Docker создайте каталог для постоянных данных и скопируйте в него пример конфигурации проекта ./mjolnir/config/production.yaml. В примере файла описаны дополнительные параметры; задайте только те значения, которые необходимы для вашего развертывания. Как минимум, используйте URL-адрес клиентского API вашего домашнего сервера, токен бота, встроенное шифрование и идентификатор или псевдоним комнаты управления Matrix:

homeserverUrl: "https://matrix.example.org"
accessToken: "YOUR_BOT_ACCESS_TOKEN"
encryption:
  use: true
managementRoom: "!roomid:example.org"

Замените все примерные значения. Идентификатор комнаты начинается с !; псевдоним начинается с #. Не вставляйте matrix.toссылку в managementRoom. Рассматривайте файл конфигурации и токен как секреты: ограничьте доступ к файлу, не допускайте его попадания в систему контроля версий и не публикуйте его в запросах в службу поддержки. Если бот не может расшифровать комнату управления, перепроверьте настройки шифрования и подтвердите, что бот присоединился к комнате.

Пример конфигурации в формате YAML, показывающий URL-адрес домашнего сервера, замаскированный токен доступа, включенное шифрование и идентификатор комнаты управления.
В примере показаны необходимые поля конфигурации; замените указанные в примере сервер, токен и идентификатор комнаты своими значениями.

3. Запустите службу Docker Compose.

В официальных инструкциях Docker используется matrixdotorg/mjolnirобраз, и каталог хоста монтируется в /data. Создайте docker-compose.ymlрядом с этим mjolnirкаталогом:

services:
  mjolnir:
    image: matrixdotorg/mjolnir:latest
    restart: unless-stopped
    volumes:
      - ./mjolnir:/data

Из этой директории запустите Mjölnir с помощью команды docker compose up -d`.`. Смонтированная директория сохранит конфигурацию и данные бота при повторном создании контейнера. В официальном руководстве latestв качестве примера используется тег; для производственного сервера выберите протестированный вами тег релиза и запишите его, чтобы обновления выполнялись целенаправленно. После запуска выполните команду ` docker compose logs -f --tail 100 mjolnir.`. Дождитесь сообщений о запуске Mjölnir в комнате управления, прежде чем продолжить.

В терминале отображается запуск службы Mjölnir Docker Compose с постоянным томом данных.
Запустите службу из каталога, содержащего файл Compose, затем просмотрите ее журналы на наличие ошибок запуска.

4. Составьте список правил и обеспечьте безопасность номеров.

В комнате управления, !mjolnir helpесли бот не отвечает, запросите у него разрешение. Создайте список заблокированных пользователей с коротким кодом и псевдонимом комнаты, затем сделайте его списком по умолчанию:

!mjolnir list create COC code-of-conduct-ban-list
!mjolnir default COC

Mjölnir создает список рассылки и приглашает вас в него. Список рассылки — это комната Matrix, содержащая правила модерации, поэтому перед тем, как поделиться им, проверьте его видимость и состав участников. Добавьте каждую комнату сообщества, которую вы хотите, чтобы Mjölnir отслеживал:

!mjolnir rooms add #community:example.org
!mjolnir verify

Для выполнения модерационных действий, обычно включающих блокировку пользователей и редактирование событий, боту требуется достаточная мощность в каждой защищенной комнате. Используйте настройки уровня мощности комнаты, чтобы предоставить только необходимые разрешения. Команда verifyпроверяет, есть ли у Mjölnir необходимые разрешения в защищенных комнатах. Добавьте бота в комнату перед тем, как защищать ее. Не устанавливайте эти параметры protectAllJoinedRoomsпроизвольно: это расширит защиту на комнаты, в которые бот присоединяется, и сделает выбор комнат по отдельности менее удобным.

В зашифрованной комнате модераторов Matrix отображается сообщение о том, что Mjölnir находится в сети, и команда создает список политик COC.
После того, как бот ответит в приватной комнате управления, создайте список и протестируйте команды там.

Проверьте настройки и избегайте распространенных ошибок.

  • Бот находится в сети: docker compose ps отображается информация о работе сервиса, в логах отсутствуют повторяющиеся ошибки аутентификации или шифрования, и бот публикует свой статус запуска в комнате управления.
  • Использование команд ограничено: модераторы могут использовать !mjolnir statusих !mjolnir rulesв настроенной комнате. Не тестируйте команды в общедоступной комнате.
  • Помещения защищены: !mjolnir rooms отображается список предназначенных для них помещений и !mjolnir verifyсообщается об адекватном уровне электропитания.
  • Секреты остаются конфиденциальными: токен не хранится в общедоступном репозитории, истории командной строки или опубликованных логах. В случае утечки, токен следует отозвать или сменить, выйдя из сессии бота и обновив конфигурацию перед перезапуском.

Если бот молчит, сначала убедитесь, что идентификатор или псевдоним комнаты управления указан верно и что бот является зарегистрированным участником. Для зашифрованных комнат проверьте, включено ли шифрование и может ли бот расшифровывать сообщения. Если модерация не удается только в одной комнате, убедитесь, что она защищена и что ее уровни мощности позволяют выполнить запрошенное действие. Для получения информации о синтаксисе команд и параметрах конфигурации обратитесь к текущему руководству модератора Mjölnir , руководству по настройке Docker и примеру конфигурации .

Оставить комментарий

Безопасное восстановление Matrix Synapse с помощью дампа PostgreSQL

Создайте резервную копию Synapse с помощью pg_dump, защитите ключ подписи и носители, а затем восстановите данные в чистую базу данных PostgreSQL, не используя повторно устаревшие одноразовые ключи.

Запустите Mjölnir в качестве бота для модерации комнат Matrix с помощью Docker.

Запустите Mjölnir в качестве бота для модерации комнат Matrix с помощью Docker.

Настройте Mjölnir, используя выделенный аккаунт Matrix, зашифрованную комнату управления, Docker Compose, список политик и проверки разрешений.

Включите встроенную синхронизацию Matrix Sliding для более быстрой загрузки на мобильных устройствах.

Включите встроенную синхронизацию Matrix Sliding для более быстрой загрузки на мобильных устройствах.

Откажитесь от устаревшего прокси и настройте встроенную в Synapse функцию Sliding Sync. Проверьте обнаружение клиентов, затем измерьте скорость загрузки списка комнат и поведение при переподключении на совместимом телефоне.

Разместите Element Web на Nginx с пользовательским Homeserver.

Разверните Element Web как статический сайт, укажите в качестве сервера ваш домашний сервер Matrix, добавьте HTTPS и настройте Nginx для обслуживания обновлений без устаревших файлов.

Запустите облегченный домашний сервер Matrix на Raspberry Pi 4.

Настройте Conduit на 64-битном Raspberry Pi 4 с сохранением данных, федерацией HTTPS, защищенной регистрацией и проверкой работоспособности домашнего сервера.

Настройте собственный псевдоним для комнаты Matrix в своем домене.

Присвойте комнате Matrix легкодоступный адрес в вашем домене, используя Element или API Matrix, с проверкой прав доступа, именованием Synapse и федерацией.

Настройте Coturn для надежных голосовых и видеозвонков Matrix.

Настройте coturn и Synapse с использованием совпадающих учетных данных TURN, откройте необходимые порты ретрансляции и убедитесь, что клиенты Matrix могут получать кандидатов на ретрансляцию.

Развертывание Matrix Synapse с помощью Docker Compose и PostgreSQL

Развертывание Matrix Synapse с помощью Docker Compose и PostgreSQL

Перед тем как сделать его доступным по HTTPS, настройте постоянный домашний сервер Synapse с помощью Docker Compose, PostgreSQL, частной конфигурации и проверок.

Настройте тему и фирменный стиль Element Web.

Задайте фирменное название, пользовательские цвета и элементы авторизации для вашей веб-версии Element, при этом понимая, какие части останутся фирменными.

Увеличьте лимит файлов Systemd в Synapse без догадок.

Увеличьте лимит файлов Systemd в Synapse без догадок.

Проверьте, не превысил ли Synapse лимит на количество открытых файлов в одном процессе, установите параметр systemd для нужной службы или рабочего процесса и проверьте текущий лимит.