Справка по Synadm

Admin

Общая справка:

Использование: synadm [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  CLI-утилита для администрирования Matrix-Synapse

Опции:
  --version                       Показать версию и выйти.
  -v, --verbose                   Включить логи уровня INFO (-v) или DEBUG (-vv) в консоль.
  --no-confirm, --batch, --yes, --non-interactive, --scripting
                                  Включить неинтерактивный режим. Используйте с осторожностью!
                                  Этот режим:
                                    - Отключает все интерактивные запросы подтверждения.
                                    - Отключает автоматический перевод unix-времени в читаемый формат.
  -o, --output [yaml|json|minified|human|pprint|y|j|m|h|p|]
                                  Переопределить формат вывода по умолчанию.
                                  'human' — табличный или списочный вид (в зависимости от данных),
                                  требует много места по горизонтали для красивого отображения.
                                  'json' — отформатированный JSON.
                                  'minified' — сжатый JSON, удобен для скриптов.
                                  'pprint' — форматированный вывод с помощью модуля pprint в Python.
                                  'yaml' — компромисс между читаемостью человеком и машиной,
                                  требует меньше ширины терминала, чем 'human', и является
                                  форматом по умолчанию в свежих установках.
  -c, --config-file ПУТЬ          Путь к файлу конфигурации. [по умолчанию:
                                  ~/.config/synadm.yaml]
  -h, --help                      Показать эту справку и выйти.

Команды:
  config     Изменить конфигурацию synadm.
  group      Управление группами (сообществами).
  history    Удаление исторических событий из базы данных Synapse.
  matrix     Выполнение вызовов Matrix API.
  media      Управление локальными и удалёнными медиафайлами.
  notice     Отправка сообщений пользователям.
  raw        Выполнение произвольного запроса к Synapse Admin API.
  regtok     Управление токенами регистрации.
  room       Управление комнатами и членством в комнатах.
  user       Просмотр, добавление, изменение, деактивация/удаление пользователей,
             сброс паролей.
  version    Получить версию сервера Synapse.

Admin

Команда synadm config

Использование: synadm config [ОПЦИИ]
  Изменение конфигурации synadm.
  Детали конфигурации обычно всегда запрашиваются в интерактивном режиме.
  Параметры командной строки переопределяют предлагаемые по умолчанию значения в подсказках.

Опции:
  -u, --user ТЕКСТ                Имя администратора, которому разрешён доступ
                                  к Admin API Synapse.
  -t, --token ТЕКСТ               Access-токен администратора.
  -b, --base-url ТЕКСТ            Базовый URL, на котором запущен Synapse.
                                  Обычно это https://localhost:8008 или
                                  https://localhost:8448. Если Admin API Synapse
                                  настроен на доступ из внешнего мира, то это
                                  может быть, например: https://example.org:8448
  --protocol [http|unix]          Протокол для связи с Synapse. Может быть
                                  домен/IP и порт с http(s), либо unix-сокет.
  -p, --admin-path ТЕКСТ          Путь, по которому Synapse предоставляет Admin API,
                                  обычно значение по умолчанию подходит большинству установок.
  -m, --matrix-path ТЕКСТ         Путь, по которому Synapse предоставляет обычные Matrix API,
                                  обычно значение по умолчанию подходит большинству установок.
  -w, --timeout ЦЕЛОЕ_ЧИСЛО       Время в секундах, в течение которого synadm должен ждать
                                  ответа от Admin API или Matrix API.
                                  По умолчанию 7 секунд.
  -o, --output [yaml|json|minified|human|pprint]
                                  Как synadm по умолчанию отображает данные.
                                  Режим 'human' — табличный или списочный вид в зависимости
                                  от полученных данных, но часто требует много места по
                                  горизонтали для корректного отображения.
                                  'json' — отформатированный JSON.
                                  'minified' — сжатый JSON, удобен для использования в скриптах.
                                  'pprint' — форматированный вывод с помощью встроенного
                                  модуля pprint в Python.
                                  'yaml' — компромисс между читаемостью человеком и машиной,
                                  требует меньше ширины терминала, чем 'human', и является
                                  форматом по умолчанию в свежих установках.
                                  Формат вывода по умолчанию всегда можно переопределить
                                  глобальным переключателем --output/-o
                                  (например: 'synadm -o pprint user list').
  -d, --server-discovery [well-known|dns]
                                  Метод обнаружения «собственного имени homeserver».
                                  Поскольку ни один из существующих на данный момент
                                  конечных точек Admin API не предоставляет эту информацию,
                                  для помощи используется federation API (и другие).
                                  При значении "well-known" URI federation API пытается
                                  быть получен через well-known ресурс настроенного
                                  "Synapse base URL".
                                  При значении "dns" используется SRV-запись доменного
                                  имени, найденного в "Synapse base URL".
                                  После получения federation URI можно извлечь имя homeserver.
                                  Если в "Synapse base URL" содержится "localhost", предполагается,
                                  что требуемый federation API уже слушает на localhost:порт
                                  (конечная точка "keys" Matrix API).
                                  Если и это не срабатывает, в качестве последнего средства
                                  имя homeserver можно просто сохранить напрямую в конфигурацию
                                  через параметр "homeserver".
                                  Обратите внимание: получение имени homeserver выполняется
                                  только тогда, когда подкоманда synadm в нём нуждается
                                  (например некоторые подкоманды media и user), и при этом
                                  директива "homeserver" в конфиге установлена в "auto-retrieval".
  -n, --homeserver ТЕКСТ          Имя хоста homeserver Synapse. Обычно matrix.ДОМЕН или ДОМЕН.
                                  Значение по умолчанию 'auto-retrieval' будет пытаться
                                  обнаружить имя с помощью метода, заданного в --server-discovery.
  -i, --ssl-verify                Включать или отключать проверку SSL-сертификатов.
                                  Установите False, чтобы разрешить самоподписанные сертификаты.
  -h, --help                      Показать это сообщение и выйти.

Admin

Команда synadm group

Использование: synadm group [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Управление группами (сообществами).

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  delete                          Удалить локальную группу (сообщество).

Краткое пояснение

Команда synadm group предназначена для управления группами / сообществами (Matrix Communities / Groups) на вашем сервере Synapse.

На момент версии synadm 0.49.x (и большинства актуальных версий на 2025–2026 год) доступна только одна подкоманда:

delete — удаление локальной группы (сообщества), созданной на вашем сервере.

Пример использования:

# Удалить сообщество с идентификатором +community:yourdomain.com
synadm group delete +community:yourdomain.com

Важные замечания

Удаляются только локальные группы (те, которые созданы на вашем сервере).
Федеративные группы (созданные на других серверах) удалить через эту команду нельзя.
Перед удалением synadm обычно запрашивает подтверждение (если не использовать --yes или --non-interactive).
После удаления группа исчезает из списка сообществ, но старые сообщения и членство в комнатах могут сохраниться (зависит от настроек Synapse).

Если вам нужна более полная справка по подкоманде delete — выполните:

synadm group delete --help

Admin

Команда synadm history

Использование: synadm history [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Удаление исторических событий из базы данных Synapse.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  purge                           Удалить события комнаты до определённого момента времени или до определённого...
  purge-status                    Просмотреть статус недавней операции удаления истории.

Краткое пояснение (на русском)

Команда synadm history предназначена для управления удалением старой истории сообщений (purge history) в комнатах Synapse. Это полезно для:

уменьшения размера базы данных
соблюдения требований GDPR / удаления старых данных
очистки комнат от спама или нежелательного контента в прошлом

На данный момент доступны две подкоманды:

purge — запуск удаления событий комнаты до указанного момента времени или до определённого события.
purge-status — проверка статуса уже запущенной (или недавно завершённой) операции удаления истории.

Примеры использования (на русском)

# Запустить удаление всех событий в комнате до 1 января 2025 года
synadm history purge !комната:твой.домен.com --before 2025-01-01

# Запустить удаление событий старше 365 дней
synadm history purge !комната:твой.домен.com --before-ts $(date -d "-365 days" +%s000)

# Посмотреть статус последней операции удаления
synadm history purge-status

Важно знать

Удаление истории — необратимая операция.
Synapse удаляет события только из своей базы (локально), но они могут остаться на других серверах федерации.
Процесс может занять много времени на больших комнатах и нагружать сервер.
Перед запуском рекомендуется сделать резервную копию базы PostgreSQL.

Если нужна более подробная справка по одной из подкоманд (purge или purge-status), выполните в терминале:

synadm history purge --help
synadm history purge-status --help

Admin

Команда synadm matrix

Использование: synadm matrix [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Выполнение вызовов Matrix API.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  login                           Войти в Matrix с помощью имени пользователя и пароля и получить access-токен.
  raw                             Выполнить произвольный запрос к Matrix API.

Краткое пояснение

Команда synadm matrix предназначена для работы с обычным Client-Server API Matrix (не с Admin API Synapse).
Это полезно в случаях, когда нужно выполнить действия от имени обычного пользователя (а не администратора), например:

получить access-токен для дальнейшего использования в скриптах
выполнить любой запрос к стандартному Matrix API (отправка сообщений, получение статуса и т.д.)

На данный момент доступны только две подкоманды:

login — вход по логину и паролю с получением токена
(аналогично тому, как это делает клиент Element при первом входе)
raw — произвольный HTTP-запрос к любому пути Matrix API
(очень мощный инструмент для продвинутых пользователей и отладки)

Примеры использования (на русском)

# 1. Войти под пользователем и получить токен
synadm matrix login --user @rootadmin:твой.домен.com --password ТвойПароль123!

# Полученный токен можно использовать дальше, например:
# synadm config -t "полученный_токен"

# 2. Произвольный запрос (пример: узнать, кто я)
synadm matrix raw GET /_matrix/client/v3/account/whoami

Важные замечания

Для команды login нужно, чтобы регистрация была разрешена или пользователь уже существовал.
Команда raw требует, чтобы у пользователя был действующий токен (можно задать через --token или через конфиг synadm).
Это низкоуровневый инструмент — он не имеет красивого вывода, как остальные команды synadm.
Используйте с осторожностью: неправильные запросы могут повлиять на аккаунт пользователя.

Если нужна более подробная справка по одной из подкоманд (login или raw), выполните в терминале:

synadm matrix login --help
synadm matrix raw --help

Admin

Команда synadm media

Использование: synadm media [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Управление локальными и удалёнными медиафайлами.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  delete                          Удалить локальные медиафайлы по ID, размеру или возрасту
  list                            Показать список локальных медиафайлов по комнате или пользователю
  protect                         Защитить конкретные медиафайлы от помещения в карантин
  purge                           Удалить старые кэшированные удалённые медиафайлы
  quarantine                      Поместить медиафайлы в карантин в комнатах, по пользователям или по ID медиа
  unquarantine                    Убрать медиафайлы из карантина

Краткое пояснение

Команда synadm media предназначена для управления медиафайлами на сервере Synapse:

локальными — загруженными пользователями вашего сервера (хранятся в /var/lib/matrix-synapse/media)
удалёнными — кэшированными с других серверов (через федерацию)

Основные сценарии использования:

очистка места на диске
удаление нежелательного / запрещённого контента
защита важных файлов от автоматического удаления или карантина
карантин подозрительных или спамовых медиафайлов

Краткое описание каждой подкоманды

Команда	Что делает	Типичные случаи использования
delete	Удаляет локальные медиафайлы по ID, размеру, возрасту или другим критериям	Очистка старых аватарок, больших видео, файлов старше N дней
list	Показывает список локальных медиафайлов, фильтруя по комнате или пользователю	Узнать, кто и что загружал в конкретную комнату
protect	Защищает отдельные медиафайлы от помещения в карантин и автоматического удаления	Сохранить важные документы, фото, видео от чистки
purge	Удаляет старые кэшированные удалённые медиафайлы (с других серверов)	Очистка кэша федерации (обычно для экономии места)
quarantine	Помещает медиафайлы в карантин (по комнатам, пользователям или конкретным ID)	Блокировка спама, CSAM, запрещённого контента
unquarantine	Убирает файлы из карантина (возвращает в нормальное состояние)	Отмена ошибочного карантина

Примеры использования

# Показать все локальные медиафайлы пользователя
synadm media list --user @rootadmin:твой.домен.com

# Показать медиафайлы в конкретной комнате
synadm media list --room !комната:твой.домен.com

# Удалить все локальные медиа старше 180 дней
synadm media delete --before 180d

# Поместить в карантин все медиа конкретного пользователя
synadm media quarantine --user @spammer:твой.домен.com

# Защитить конкретный медиафайл от удаления
synadm media protect mxc://твой.домен/идентификатор_файла

# Удалить старый кэш удалённых медиа (старше 90 дней)
synadm media purge --before 90d

Важные замечания

Многие операции необратимы (особенно delete и purge).
Перед массовым удалением рекомендуется сделать бэкап директории /var/lib/matrix-synapse/media.
Карантин не удаляет файлы физически — они просто становятся недоступными для скачивания.
Для полной очистки после карантина используйте delete или purge.

Admin

Команда synadm notice

Использование: synadm notice [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Отправка сообщений пользователям.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  send                            Отправить серверные уведомления (server notices) пользователям на локальном homeserver.

Краткое пояснение

Команда synadm notice предназначена для отправки официальных серверных уведомлений (server notices) всем или части пользователей вашего Synapse-сервера.

Что такое server notices в Matrix/Synapse?
Это специальные системные сообщения, которые появляются у пользователей в виде отдельной комнаты «Server Notices» (или «Уведомления сервера»).
Они выглядят как сообщения от сервера (не от какого-то пользователя), и их нельзя удалить или скрыть обычными средствами.
Обычно используются для:

важных объявлений от администратора сервера
предупреждений о технических работах
уведомлений о нарушении правил
информации о смене политики сервера
сообщений о необходимости обновить клиент и т.д.

На данный момент доступна только одна подкоманда:

send — отправка уведомления

Примеры использования

# Отправить простое уведомление всем пользователям
synadm notice send --message "Внимание! Сегодня в 20:00 будут технические работы на сервере. Ожидайте перерывов в работе."

# Отправить уведомление только администраторам
synadm notice send --message "Обновление сервера завершено успешно." --admin

# Отправить уведомление с указанием темы (отображается жирным)
synadm notice send --message "Важно: изменение политики конфиденциальности" --subject "Изменение правил"

# Отправить уведомление только одному пользователю
synadm notice send --message "Ваш аккаунт будет деактивирован через 7 дней из-за неактивности." --user @username:твой.домен.com

Полезные флаги (обычно указываются при вызове send) :

--message "Текст..." — основной текст уведомления (обязательно)
--subject "Заголовок" — тема/заголовок (отображается жирным)
--admin — отправить только пользователям с правами администратора
--user @user:domain.com — отправить конкретному пользователю
--non-interactive / --yes — отключить подтверждение перед отправкой (для скриптов)

Важные замечания

Уведомления видны только локальным пользователям вашего сервера (не федеративным).
После отправки уведомление появляется в специальной приватной комнате «Server Notices» у каждого получателя.
Пользователь не может удалить эту комнату или скрыть уведомления — они останутся навсегда.
Используйте с осторожностью — слишком много или раздражающих уведомлений могут отпугнуть пользователей.

Admin

Команда synadm raw

Использование: synadm raw [ОПЦИИ] КОНЕЧНАЯ_ТОЧКА
  Выполнение произвольного запроса к Synapse Admin API.

  Аргумент "КОНЕЧНАЯ_ТОЧКА" — это часть URL, которая идёт _после_ настроенного
  "Synapse base URL" и "Synapse Admin API path" (см. команду ``synadm config``).
  Пример: запрос к API "Query User Account" будет выглядеть так:
  ``synadm raw v2/users/%40testuser%3Aexample.org``.
  Кодирование URL (URL encoding) необходимо выполнять вручную на этом этапе.
  Рекомендуется включить отладочный вывод с помощью глобального флага ``-vv``.

Опции:
  -m, --method [get|post|put|delete]
                                  HTTP-метод, который будет использован для запроса.
                                  [по умолчанию: get]

  Данные: [взаимоисключающие]
    -d, --data ТЕКСТ                JSON-строка, которая будет отправлена в теле запроса
                                    для методов post, put и delete — передаётся как строка.
                                    Обязательно экранируйте её от интерпретации оболочкой,
                                    используя одинарные кавычки. Пример:
                                    '{"key1": "value1", "key2": 123}' [по умолчанию: {}]

    -f, --data-file ИМЯ_ФАЙЛА       Прочитать JSON-данные из файла.
                                    Чтобы читать из стандартного ввода (stdin), укажите
                                    "-" в качестве имени файла.

  -h, --help                      Показать это сообщение и выйти.

Краткое пояснение

Команда synadm raw — это самый мощный и гибкий инструмент в synadm.
Она позволяет отправить любой запрос к Admin API Synapse, даже если для этой операции ещё нет отдельной удобной подкоманды.

Зачем это нужно

Выполнять новые или экспериментальные запросы к Admin API
Делать массовые операции (например, сброс пароля нескольким пользователям)
Получать данные, которые synadm пока не умеет красиво показывать
Отлаживать и тестировать API напрямую

Как правильно указывать конечную точку
После настроенного базового URL и пути Admin API (обычно http://localhost:8008/_synapse/admin/) вы добавляете только оставшуюся часть.
Примеры:

v2/users/@testuser:example.org → запрос информации о пользователе
v1/reset_password/@user:domain.com → сброс пароля
v2/rooms/!roomid:domain.com → информация о комнате

Обратите внимание:

Символы @, :, ! и т.д. нужно закодировать в URL-формате:
@ → %40
: → %3A
! → %21
Пример: @testuser:example.org → %40testuser%3Aexample.org

Примеры использования

# Получить информацию о пользователе (GET-запрос)
synadm raw v2/users/%40rootadmin%3Aтвой.домен.com

# Сбросить пароль пользователя (POST-запрос)
synadm raw --method post v1/reset_password/%40rootadmin%3Aтвой.домен.com \
  --data '{"new_password": "НовыйПароль123!", "logout_devices": true}'

# Удалить комнату (DELETE-запрос)
synadm raw --method delete v2/rooms/%21комната%3Aтвой.домен.com

# Отправить данные из файла
synadm raw --method post v1/some_endpoint --data-file request.json

Полезные советы

Всегда используйте -vv для отладки — это покажет полный запрос и ответ:
synadm -vv raw v2/users/%40user%3Adomain.com
Данные в --data обязательно экранируйте одинарными кавычками, иначе оболочка сломает JSON.
Если команда возвращает ошибку 401/403 — проверьте токен в конфиге (synadm config -u).

Admin

Команда synadm regtok

Использование: synadm regtok [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Управление токенами регистрации.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  delete                          Удалить токен регистрации.
  details                         Показать подробную информацию о указанном токене.
  list                            Показать список токенов регистрации.
  new                             Создать новый токен регистрации.
  update                          Обновить существующий токен регистрации.

Краткое пояснение

Команда synadm regtok предназначена для управления токенами регистрации (registration tokens) в Synapse.

Что такое токены регистрации?
Это специальные одноразовые или многоразовые коды/ссылки, которые позволяют пользователям зарегистрироваться на вашем сервере, даже если открытая регистрация полностью отключена (enable_registration: false в конфиге).
Токены очень удобны для:

закрытых сообществ
корпоративных серверов
приглашения конкретных людей
контроля количества регистраций
установки срока действия или ограничения по количеству использований

Краткое описание каждой подкоманды

Команда	Что делает	Типичные случаи использования
delete	Полностью удаляет токен регистрации	Токен больше не нужен или был скомпрометирован
details	Показывает всю информацию о токене: кто создал, срок действия, сколько раз использован и т.д.	Проверить статус конкретного токена
list	Выводит список всех существующих токенов с их статусами и параметрами	Посмотреть, какие токены активны, сколько осталось использований
new	Создаёт новый токен с заданными параметрами (срок, количество использований, заметка и т.д.)	Создать приглашение для нового пользователя или группы
update	Изменяет существующий токен (например, продлить срок, изменить лимит использований)	Обновить параметры уже созданного токена

Примеры использования

# Показать все токены регистрации
synadm regtok list

# Создать новый токен на 10 использований, действителен 30 дней
synadm regtok new --uses-allowed 10 --expiry 30d --note "Приглашение для команды разработки"

# Посмотреть подробности конкретного токена
synadm regtok details токен_строка_здесь_например_abc123xyz

# Обновить токен — увеличить количество использований до 20
synadm regtok update abc123xyz --uses-allowed 20

# Удалить ненужный токен
synadm regtok delete abc123xyz

Важные замечания

Токены работают только если в конфиге Synapse включён параметр registration_shared_secret (или аналогичный механизм).
После создания токена его нужно передать пользователю (например, в виде ссылки https://ваш.домен/register?token=abc123xyz).
Токены не дают прав администратора — это просто способ зарегистрироваться.
После исчерпания лимита использований или истечения срока токен становится неактивным автоматически.

Admin

Команда synadm room

Использование: synadm room [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Управление комнатами и членством в комнатах.

  Синтаксис идентификаторов комнат в synadm соответствует спецификации Matrix:
  https://spec.matrix.org/latest/#room-structure
  Убедитесь, что символ ! экранирован от интерпретации оболочкой.
  В bash и zsh это можно сделать с помощью одинарных кавычек ('), например:
  '!id123abc:matrix.ДОМЕН'

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  block                           Заблокировать или разблокировать комнату.
  block-status                    Узнать, заблокирована ли комната и кто её заблокировал.
  delete                          Удалить комнату (и возможно очистить её историю).
  delete-status                   Получить статус удаления комнаты по её ID или...
  details                         Получить подробную информацию о комнате.
  join                            Присоединиться к комнате.
  list                            Показать список комнат и выполнить поиск.
  make-admin                      Назначить пользователя администратором комнаты.
  members                         Показать текущих участников комнаты.
  power-levels                    Показать уровни прав (power levels) пользователей в комнатах.
  purge-empty                     Удалить пустые комнаты (где сейчас 0 локальных участников).
  resolve                         Преобразовать алиас комнаты в ID или наоборот.
  search                          Псевдоним для команды `synadm room list -n <поисковый_термин>`.
  state                           Получить список всех событий состояния (state events) в комнате.

Краткое пояснение каждой команды

Команда	Что делает	Типичные сценарии использования
block	Блокирует комнату (запрещает вступление и отправку сообщений) или снимает блокировку	Борьба со спам-комнатами или нарушителями
block-status	Показывает, заблокирована ли комната и кем именно	Проверка статуса блокировки
delete	Полностью удаляет комнату (с возможностью очистки истории)	Удаление спам-комнат, тестовых комнат, комнат нарушителей
delete-status	Показывает прогресс и статус запущенного удаления комнаты	Контроль долгого процесса удаления
details	Выводит всю доступную информацию о комнате (создатель, версия, настройки и т.д.)	Диагностика проблем с комнатой
join	Присоединяет указанного пользователя (обычно админа) к комнате	Восстановление доступа админа в комнату без приглашения
list	Показывает список всех комнат с фильтрами и поиском	Обзор всех комнат на сервере, поиск по названию/алиасу
make-admin	Делает пользователя администратором комнаты (power level 100)	Восстановление прав админа в комнате
members	Показывает текущий список участников комнаты	Проверка, кто находится в комнате
power-levels	Показывает уровни прав (power levels) всех пользователей в комнате	Анализ прав доступа в комнате
purge-empty	Массовое удаление комнат, в которых сейчас нет ни одного локального участника	Очистка мёртвых комнат после ухода всех пользователей
resolve	Преобразует алиас (#название:домен) в ID комнаты или наоборот	Узнать настоящий ID комнаты по её алиасу
search	Быстрый поиск комнат по названию/алиасу (то же самое, что list -n)	Быстрый поиск комнаты по ключевому слову
state	Показывает все события состояния (state events) комнаты	Глубокая отладка настроек комнаты (правила, права, плагины)

Важные замечания

Почти все команды работают только с локальными комнатами (созданными на вашем сервере).
Комнаты, созданные на других серверах федерации, можно только просматривать, но не удалять/управлять ими напрямую.
Для работы с ID комнат используйте одинарные кавычки:
'!id123abc:matrix.example.com' — чтобы оболочка не интерпретировала ! как историю команд.
Перед массовым удалением комнат (особенно purge-empty или delete) всегда делайте резервную копию базы данных.

Admin

Команда synadm user

Использование: synadm user [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...
  Просмотр, добавление, изменение, деактивация/удаление пользователей, сброс паролей.

Опции:
  -h, --help                      Показать это сообщение и выйти.

Команды:
  3pid                            Найти пользователя по его Third Party ID (3PID, например email или телефон).
  auth-provider                   Найти пользователя по его идентификатору в провайдере аутентификации.
  deactivate                      Деактивировать пользователя или полностью удалить его данные в соответствии с GDPR.
  deactivate-regex                Деактивировать или удалить по GDPR аккаунты, соответствующие регулярному выражению.
  details                         Показать подробную информацию об аккаунте пользователя.
  list                            Показать список пользователей, выполнить поиск по пользователям.
  login                           Получить access-токен для указанного пользователя.
  media                           Показать все локальные медиафайлы, загруженные пользователем.
  membership                      Показать список всех комнат, в которых состоит пользователь.
  modify                          Создать нового локального пользователя или изменить существующего.
  password                        Изменить пароль пользователя.
  prune-devices                   Удалить устройства пользователя и аннулировать все его access-токены.
  redact                          Удалить (redact) события, созданные пользователем (локальным или удалённым).
  redact-status                   Получить статус операции удаления (redaction) событий пользователя.
  search                          Быстрый способ вызвать 'synadm user list -d -g -n <поисковый_термин>'.
  shadow-ban                      Включить или отключить shadow-ban (теневой бан) для пользователя.
  suspend                         Приостановить аккаунт (запретить любые действия).
  whois                           Показать информацию об активных сессиях пользователя.

Краткое описание каждой команды

Команда	Что делает	Самые частые сценарии использования
3pid	Поиск пользователя по email, телефону или другому 3PID	Найти аккаунт по привязанной почте
auth-provider	Поиск пользователя по ID в LDAP/SSO/OIDC и т.п.	Работа с внешней аутентификацией
deactivate	Деактивация (отключение входа) или полное стирание аккаунта по GDPR	Удаление спам-аккаунтов, уход пользователя
deactivate-regex	Массовое отключение/удаление пользователей по шаблону имени	Чистка ботов или спамеров с похожими именами
details	Полная информация об аккаунте (создание, статус, устройства, 3PID и т.д.)	Диагностика проблем с конкретным пользователем
list	Список всех пользователей с фильтрами и поиском	Обзор всех аккаунтов на сервере
login	Получить access-токен по логину/паролю	Скрипты, автоматизация, отладка
media	Список всех медиафайлов, загруженных пользователем	Проверка, что пользователь загружал (для модерации)
membership	Список всех комнат, где состоит пользователь	Узнать, в каких комнатах сидит человек
modify	Создать нового пользователя или изменить параметры существующего	Ручная регистрация, смена имени/админа/пароля
password	Сменить пароль пользователя	Самый частый запрос от пользователей
prune-devices	Удалить все устройства и аннулировать токены пользователя	При компрометации аккаунта, принудительный выход со всех устройств
redact	Удалить (redact) все или некоторые сообщения пользователя	Удаление спама, оскорблений, утечек данных
redact-status	Показать прогресс операции redact	Контроль долгого процесса удаления сообщений
search	Быстрый поиск по имени пользователя	Удобный алиас для list -n
shadow-ban	Теневой бан — пользователь не видит, что забанен, но не может ничего делать	Борьба с троллями без их оповещения
suspend	Полная приостановка аккаунта (нельзя входить, отправлять сообщения)	Временная блокировка нарушителя
whois	Показать активные сессии, устройства и токены пользователя	Проверка, с каких устройств залогинен человек

Это одна из самых мощных и часто используемых групп команд в synadm — почти всё администрирование пользователей делается именно через synadm user.

База знаний (кластер NBICS)

Справка по Synadm

Общая справка:

Команда synadm config

Команда synadm group

Краткое пояснение

Команда synadm history

Краткое пояснение (на русском)

Примеры использования (на русском)

Команда synadm matrix

Краткое пояснение

Примеры использования (на русском)

Команда synadm media

Краткое пояснение

Краткое описание каждой подкоманды

Примеры использования

Команда synadm notice

Краткое пояснение

Примеры использования

Команда synadm raw

Краткое пояснение

Команда synadm regtok

Краткое пояснение

Краткое описание каждой подкоманды

Примеры использования

Команда synadm room

Краткое пояснение каждой команды

Важные замечания

Команда synadm user

Краткое описание каждой команды