synapse-admin

также доступно на: English, Deutsch

Synapse-admin это инструмент который Вы можете использовать для администрирования своего (Matrix) Synapse сервера - управление аккаунтами пользователей, удаления медиа и истории чатов для освобождения дискового пространства и т.д. На этой странице Вы сможете найти инструкции по работе с этим инструментом.

страница пользователей в synapse-admin

Вход

По умолчанию, synapse-admin размещается по адресу https://matrix.yourserver.com/synapse-admin и имеет следующие поля в форме входа:

  • Username: запрашивается ваш MXID (@username:yourserver.com), как на скриншоте ниже
  • Password: запрашивается пароль вашего Matrix пользователя
  • Homeserver URL: должен быть заполнен автоматически после того, как Вы введете правильный MXID в поле Username, если этого не произошло, вы можете заполнить его самостоятельно значением вида https://matrix.yourserver.com, как на скриншоте ниже

и изначально скрытый текст с реализацией и версией homeserver’а (например, Synapse version 1.62.0 на скриншоте ниже). Этот текст станет видим только после того, как в поле Homeserver URL будет введено правильное значение.

форма входа в synapse-admin

Распространенные проблемы

Неверный или пустой Homeserver URL

Обычно это означает, что Вы ввели только локальную часть вашего MXID в поле Username. Вы должны ввести полный MXID (@username:yourserver.com), а не просто username или @username. В некоторых специфических случаях, например, при использовании CDN без CORS-заголовков, synapse-admin не сможет выставить правильное значение автоматически, и вам придется настроить его вручную.

Отсутствие текста с версией homeserver’a

Если Вы не видите под полем Homeserver URL что-то вроде Synapse version x.xx.x, Вы ввели неверное значение в поле Homeserver URL или ваш Matrix сервер упал (в 99% случаев это все-таки неверное значение в поле Homeserver URL).

Ошибки сети

Вы можете увидеть различные сообщения об ошибках, но их все можно разделить на следующие группы:

Неверный Homeserver URL

Да, если в поле Homeserver URL не указано значение вроде https://matrix.yurserver.com, то обычно проблема именно в этом.

Имя пользователя вместо MXID

Если Вы ввели имя пользователя (локальная часть вашего MXID) в поле Username, то это не сработает. Вы должны ввести полный MXID (@username:yourserver.com), а не просто username или @username.

Пользователь не имеет прав администратора homeserver’а

Вы можете войти в synapse-admin и использовать Synapse Admin API (это разные вещи) только пользователем Matrix, у которого есть права администратора homeserver’a.

Массовая регистрация

Для того, чтобы зарегистрировать множество пользователей, Вы можете использовать функцию CSV импорта в synapse-admin.

Для начала, Вам нужно подготовить .csv файл с данными пользоваталей для импорта со следущим контентом:

id,displayname,password,is_guest,admin,deactivated
vasiliy.pupkin,Василий Пупкин,secretpassword,false,false,false

Важно: вторая строчка - это просто пример

  • id - логин будущего Matrix ID (username из @username:yourserver.com)
  • displayname - человеко-читаемое имя пользователя
  • password - пароль пользователея в открытом виде
  • is_guest - должен ли это быть гостевой аккаунт?
  • admin - должен ли это быть администратор сервера?
  • deactivated - должен ли это быть деактивированный аккаунт?

Далее, Вам нужно открыть страницу CSV импорта (кликните на кнопку CSV IMPORT в правом верхнем углу, над таблицей пользователей).

страница пользователей synapse-admin с подсвеченной кнопкной CSV Import

По умолчанию, она доступна по адресу https://matrix.yourserver.com/synapse-admin/#/import_users.

страница CSV импорта пользователей в synapse-admin

На этой странице Вам нужно выбрать следующие опции:

  • Conflict strategy: Stop on conflict (не обязательно, по умолчанию)
  • IDs: Update existing records (обязательно)
  • Simulate only (нижний левый угол): выключено (обязательно)

После того, как Вы выбрали все нужные опции, кликните на IMPORT

Удаление старых загруженных файлов

Чтобы освободить место на диске, иногда необходимо удалить старые медиа (загруженные файлы) на сервере.

Для этого после входа:

  • Кликните на пункт Users' Media в боковом меню
  • Кликните на кнопку DELETE MEDIA в правом углу над таблицей

страница users’ media в synapse-admin

Откроется новое модальное окно с 2 доступными фильтрами:

  • last access before - часто используемый фильтр. Любые файлы, к которым последний раз обращались (загружали/просматривали/скачивали) до указанной даты, будут удалены. Например, если Вы хотите удалить файлы, к которым не обращались в течение последних 7 дней, выберите дату за 7 дней до текущей (как на скриншоте ниже)
  • Larger then (in bytes) - (актуальное название поля в synapse-admin v0.8.5) это поле обычно не используется. Если вы укажите его значение, то все файлы, размер которых превышает указанное значение, будут удалены, включая только что загруженные медиа.

модальное окно удаления файлов в synapse-admin