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

Описание компонента

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

• на ОС 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

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

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

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

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

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

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

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

Параметры логирования

• Debug=<level> — уровень логирования от 0 (минимум сведений) до 4, по умолчанию 0;

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

  • на ОС Windows: C:\TrueConf\Border Controller

  • на ОС Linux: /opt/trueconf/border-controller/var/log

Путь к сохранению логов по умолчанию указан одинаковый для обоих компонентов.

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

• Destination=<id>/<host>:<port> — (*) адрес TrueConf Server или TrueConf Enterprise, на который требуется перенаправить трафик. Здесь:

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

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

  • <port> — TCP-порт, может быть опущен если на ВКС-сервере, который указан в поле <host>, задано значение по-умолчанию 4307;

• Listen <id>/<host>:<port> — сетевой интерфейс на машине с установленным TrueConf Border Controller для получения входящего трафика, если не задан то слушается весь входящий трафик по порту 4307. Здесь:

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

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

  • <port> — TCP-порт, может быть опущен если на ВКС-сервере, который указан в поле <host>, задано значение по-умолчанию 4307;

• 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> к файлу конфигурации;

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

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

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

• -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