Files
telemt/docs/CLI.ru.md
T
2026-11-11 23:52:01 +03:00

8.2 KiB
Raw Blame History

Командная строка Telemt

English · Русский · Deutsch · Документация

Здесь описан CLI из текущего дерева исходников. Для установленной программы проверьте telemt --version и telemt --help. Указывайте параметры перед путём к конфигурации, а сам путь — последним. Без пути Telemt использует config.toml в рабочем каталоге.

Запуск и управление процессом

telemt run --log-level normal /etc/telemt/telemt.toml

Слово run можно опустить. Под systemd или в контейнере оставляйте процесс на переднем плане и управляйте им через соответствующую службу. На Unix у Telemt также есть собственный режим демона:

telemt start --pid-file /run/telemt/telemt.pid /etc/telemt/telemt.toml
telemt status --pid-file /run/telemt/telemt.pid
telemt reload --pid-file /run/telemt/telemt.pid
telemt stop --pid-file /run/telemt/telemt.pid

Во всех командах используйте один путь к PID-файлу. Его каталог должен существовать и принадлежать подходящему пользователю. status проверяет процесс из PID-файла, но не готовность прокси. reload отправляет SIGHUP обработчику изменений конфигурации. Код 0 подтверждает отправку сигнала, а не применение всех настроек. Проверьте журнал и правила применения конфигурации. Смена поколения через POST /v1/system/reload и перезапуск процесса — отдельные операции.

stop отправляет SIGTERM и ждёт удаления PID-файла примерно до десяти секунд. После успешной отправки сигнала команда может вернуть 0, пока завершение ещё продолжается. Если дальнейшая операция требует остановленного процесса, проверьте его состояние.

Параметр Назначение
--daemon, -d Режим демона Unix; команда start также включает его.
--foreground, -f Работа на переднем плане.
--pid-file PATH PID-файл для запуска и команд status, reload, stop.
--run-as-user USER, --run-as-group GROUP Пользователь и группа процесса на Unix.
--working-dir PATH Рабочий каталог процесса на Unix. Для конфигурации лучше указать абсолютный путь.
--strict-runtime-paths Более строгая проверка служебных путей; используйте одинаково при запуске и управлении демоном.

Проверка работоспособности

telemt healthcheck --mode liveness /etc/telemt/telemt.toml
telemt healthcheck --mode ready /etc/telemt/telemt.toml

Режим liveness используется по умолчанию и обращается к GET /v1/health. Режим ready обращается к GET /v1/health/ready и требует data.ready = true. Оба ожидают HTTP 200 и ok = true; для liveness также нужно data.status = "ok".

Команда берёт адрес API и значение авторизации из указанного конфига. Для адреса прослушивания всех интерфейсов проверка идёт через loopback. Запускайте её там, где этот адрес доступен и разрешён списком доступа API. Команда не открывает сессию MTProxy и не проверяет весь путь от клиента до Telegram.

При server.api.enabled = false команда возвращает 0 без сетевой проверки. Прежде чем использовать результат как подтверждение работоспособности или готовности, включите API. Код 1 означает ошибку чтения конфигурации или проверки; неизвестное либо пропущенное значение --mode даёт 2. Для подключения, чтения и записи установлены таймауты по две секунды. Это не единый двухсекундный срок выполнения всей команды.

Журналирование

Параметр Назначение
--log-level LEVEL Уровень: debug, verbose, normal или silent.
--silent, -s Отключение информационных сообщений.
--syslog Отправка журнала в syslog на поддерживаемых Unix-системах.
--log-file PATH Запись журнала в файл.
--log-file-daily PATH Запись в файл с ежедневной ротацией.
--log-rotation MODE Ротация: never, minutely, hourly, daily или weekly.
--log-max-size-bytes N Порог размера файла для ротации.
--log-max-files N Максимальное число сохраняемых файлов.
--log-max-age-secs N Максимальный возраст сохраняемых файлов в секундах.

RUST_LOG имеет приоритет над настройками уровня журнала. Параметры CLI переопределяют соответствующие поля конфига. Подробности путей, ротации и хранения приведены в справочнике журналирования. Вывод в файл и syslog взаимоисключающие.

Создание начальной конфигурации

--init записывает конфигурацию и файлы службы, после чего может запустить службу. Это установка, а не проверка конфига; повторный запуск может заново создать существующие файлы. Сначала проверьте и сохраните действующую конфигурацию.

telemt --init --port 443 --domain example.com --user alice --config-dir /etc/telemt --no-start

Передавайте значения отдельно от имён параметров, как в примере. По умолчанию используются порт 443, домен www.google.com, пользователь user и каталог /etc/telemt. --secret HEX задаёт пользовательский секрет из 32 шестнадцатеричных знаков; без этого параметра секрет создаётся автоматически. --no-start отменяет запуск службы, но файлы установки всё равно записываются. Значения по умолчанию отличаются от install.sh: это два разных способа установки.

Для автоматизации через API см. Control API и клиент Python с CLI, оба справочника на английском. Утилита Python и описанная здесь программа telemt — разные инструменты.