dendrite admin interface

дендрит-администратор-интерфейс

Интерфейс бота для администрирования сервера Dendrite с использованием API администрирования и некоторого интерфейса базы данных.

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

Не стесняйтесь создавать проблемы для каждой запрошенной функции, чтобы, когда у меня наконец появится время, у меня был список, который нужно просмотреть и отметить.

Пространство: #admin-interface:pain.agency | Комната обсуждений: #admin-interface-support:pain.agency

Настраивать

• Убедитесь, что у вас установлена ​​половина последней версии node и npm. В настоящее время я использую node v18.18.0 (проверьте с помощью node -v ) и npm версии 9.2.0 на своем vps. Если вы запускаете Debian, как я, на своем VPS, возможно, вы захотите получить более актуальную версию узла из Snap Store или собрать его из исходного кода.
• Загрузите и распакуйте последнюю стабильную или бета-версию .zip или .tar.gz с https://github.com/jjj333-p/dendrite-admin-interface/releases или клонируйте из main ветки, если вы хотите быть в курсе последних событий .
• Запустите npm install , который должен установить все необходимые зависимости.
• Скопируйте файл, найденный по адресу examples/login.yaml , в db/login.yaml и заполните эту информацию. Инструкции по заполнению этой информации есть в комментариях к файлу примера.
• Запустите бота ( node index.js ).
• Команды доступны только в комнате администрирования, определенной в файле login.yaml.

На данный момент реализованы команды:

• evacuate User MXID | Room ID | Room Alias> ?<--preserve | -p>

  • При предоставлении идентификатора или псевдонима комнаты интерфейс запускает конечную точку эвакуации комнаты с этим идентификатором комнаты или псевдонимом, в результате чего все пользователи на этом сервере покидают эту комнату. Если флаг --preserve или -p не указан, также будет запущена конечная точка очистки комнаты, удаляющая состояние комнаты из базы данных.
  • При предоставлении MXID локального пользователя, т. е. @localpart:your.server , интерфейс запустит конечную точку эвакуации пользователя для этого пользователя, заставляя эту учетную запись покинуть все комнаты, в которых она находится.

• passwd <mxid/localpart> <log out accounts?> ?<password>

  Сбросить пароль пользователя

  • mxid/localpart — вы можете указать либо локальную часть пользователя (т. е. jjj333 ), либо весь mxid (т. е. @jjj333:pain.agency ). Обратите внимание, что это должен быть локальный пользователь, поскольку для удаленных пользователей ничего нельзя сделать.
  • log out accounts?
    • t или true чтобы выйти из всех сеансов учетной записи.
    • f или false чтобы сохранить вход во все сеансы.
  • ? password — опционально установите пароль для сброса. Если пароль не указан, по умолчанию будет возвращена рандомизированная 35-байтовая строка base64. Из-за дендрита пароль должен быть не менее 8 символов. Из-за технических трудностей в пароле, установленном через этот интерфейс, нельзя использовать пробелы.

• newaccount <mxid/localpart> ?<password>

  Создайте новую учетную запись обычного пользователя.

  • mxid/localpart — имя пользователя, которое необходимо создать для пользователя. Это может быть либо только локальная часть, либо полный mxid.
  • ? password – пароль, который будет установлен для новой учетной записи. Если ничего не указано, будет сгенерирована и возвращена строка base64 длиной 35 байт.

• deactivate <mxid/localpart>

  деактивирует данного пользователя

  • mxid/localpart — вы можете указать либо локальную часть пользователя (т. е. jjj333 ), либо весь mxid (т. е. @jjj333:pain.agency ). Обратите внимание, что это должен быть локальный пользователь, поскольку для удаленных пользователей ничего нельзя сделать.
  • Устанавливает отображаемое имя и pfp в соответствии с теми, которые определены в файле login.yaml бота, поскольку дендрит не удаляет их перед деактивацией, поэтому нам необходимо провести санацию, а тем временем мы можем добавить к нему изюминку.
  • Попросит подтверждение, чтобы предотвратить случайные запуски.
  • ПРИМЕЧАНИЕ . Эта команда является постоянной, используйте ее с осторожностью!