Документация TrueConf

# Компонент для протокола TrueConf

Предоставляется в виде установщиков для Windows и всех поддерживаемых ОС Linux. Настройки для работы компонента указываются в файле конфигурации tc_bc.cfg, который создаётся автоматически при установке. Пример файла конфигурации смотрите после перечисления параметров.

После установки компонента в ОС автоматически появится соответствующая служба:

  • на ОС Windows с названием TrueConf Border Controller и id tc_bc, путь к исполняемому файлу C:\Program Files\TrueConf\Border Controller\tc_bc.exe

  • на ОС Linux: trueconf-bc, путь к исполняемому файлу /opt/trueconf/border-controller/bin/tc_bc

# Список параметров

При установке компонента будет создан файл конфигурации для указания параметров работы:

  • на ОС Windows: C:\Program Files\TrueConf\Border Controller\etc\tc_bc.cfg

  • на ОС Linux: /opt/trueconf/border-controller/etc/tc_bc.cfg

Компонент поддерживает следующие параметры (в скобках для некоторых представлены альтернативные варианты вызова).

# Общие параметры

  • --Debug <level> — уровень логирования от 0 (отключен) до 4;

  • --LogDirectory <path> — путь к сохранению лог-файлов по работе расширения;

  • --LogToConsole — вывод логов в консоль вместо лог-файла;

  • --Daemonize <path to the PID lock-file> (только для Linux) — запуск в виде демона (daemon) с указанием пути сохранения PID-файла;

  • --Service (только для Windows) — запуск в виде службы;

  • --R — автоматический перезапуск службы при ошибке.

# Параметры маршрутизации

  • -D <id>/<host>:<port> (--Destination <id>/<host>:<port>) — адрес или FQDN TrueConf Server или TrueConf Enterprise для перенаправления трафика. Здесь:

    • <id> — (опционально) уникальная строка идентификатора для объединения опций (если требуется работа одного TrueConf Border Controller с несколькими правилами перенаправления, не рекомендуется);

    • <host> — IPv4, IPv6 или FQDN (IPv6 должен быть указан в квадратных скобках [IPv6]);

    • <port> — (опционально) порт, может быть опущен если равен значению по-умолчанию 4307;

  • -L <id>/<host>:<port> (--Listen <id>/<host>:<port>) — сетевой интерфейс для получения входящего трафика, опции совпадают с таковыми для параметра -D;

  • -E <id>/<cipher>:<flags>:<key> (--Encryption <id>/<cipher>:<flags>:<key>) — шифрование пакетов от TrueConf Border Controller к серверу видеосвязи. Здесь:

    • <id> — (опционально) уникальная строка идентификатора для объединения опций;

    • <cipher> — используемый шифр, принимает значения None (без шифрования, по-умолчанию), ChaCha20, AES-256-CTR, AES-256-OFB, AES-192-CTR, AES-192-OFB, AES-128-CTR, AES-128-OFB, xoshiro256++, xoshiro256**;

    • <key> — ключ для шифрования (в 16-ричном виде), может быть опущен, чтобы использовалось случайно сгенерированное значение (не совместимо с режимом PSK);

    • <flags> — если имеется и равен PSK, значит, используется шифрование с использованием Pre-Shared Key. Тогда требуется его настройка на стороне сервера видеосвязи.

# Параметры командной строки для запуска из терминала (консоли)

Вы можете запустить исполняемый файл компонента из терминала с некоторыми параметрами, которые нельзя использовать в файле конфигурации:

  • -h (--help) — вывод встроенной помощи со списком параметров и примерами;

  • -c <path> (--ConfigFile <path>) — путь <path> к файлу конфигурации;

  • -v (--version) — версия компонента.

Например, вызов справки для ОС Linux:

sudo /opt/trueconf/border-controller/bin/tc_bc -h

# Пример файла конфигурации

LogDirectory=/opt/trueconf/border-controller/var/log
Listen=10.140.10.123
Destination=10.110.10.10
Encryption=ChaCha20

# Запуск компонента

После настройки файла конфигурации можно запустить компонент.

# На ОС Windows

Для управления службами на ОС Windows можно использовать как графический интерфейс так и командную строку (терминал).

Чтобы быстро открыть окно управления службами, запустите командную строку (терминал) или PowerShell и выполните команду services.msc. В открывшемся окне вы сможете выбрать в списке службу TrueConf Border Controller и запустить её, а также настроить её автозапуск при старте ОС.

Для управления службами полностью с помощью терминала используется утилита sc.exe (opens new window). Все команды выполняются от имени администратора ОС. Например, чтобы запустить службу, выполните:

sc start tc_bc

Чтобы добавить службу в автозапуск, выполните:

sc config tc_bc start=auto

# На ОС Linux

Управление службами (которые в терминологии Linux называются демонами, от англ. daemon) осуществляется с помощью утилиты systemctl.

Чтобы запустить демон trueconf-bc, выполните:

sudo systemctl start trueconf-bc

Чтобы демон trueconf-bc запускался при старте ОС, выполните:

sudo systemctl enable trueconf-bc

← Компонент для протокола HTTPS →