Команда 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 Показать это сообщение и выйти.
