Параметры конфигурирования компонента

Параметры Шлюза задаются переменными, описанными в файле /etc/opt/termidesk-vdi/termidesk.conf, а также аргументами командной строки.


Перечень доступных переменных и аргументов приведен в таблице.

Информация в таблице относится к ранее установленному с Termidesk Шлюзу termidesk-wsproxy.



Наименование переменнойЗначение по умолчаниюОписаниеАргумент командной строки
WSPROXY_PORT 5099 Порт прослушивания службы Не задан
WSPROXY_BIND_ADDRESS 127.0.0.1 Адрес прослушивания службы. При распределенной установке необходимо использовать значение 0.0.0.0, чтобы порт 5099 прослушивался не только localhost, если планируется принимать запросы на подключения с внешних систем (например, с балансировщиков нагрузки) Не задан
WSPROXY_HEALTH_CHECK_PORT 8101

Порт веб-сервера для обслуживания API-запросов по состоянию Шлюза (healthcheck).

По умолчанию переменная не используется (закомментирована)

 Не задан
WSPROXY_HEALTH_CHECK_CERT /etc/opt/termidesk-vdi/wsproxy-healthcheck.pem

Путь к сертификату (открытому ключу), который используется для защиты подключения API-запросов по состоянию Шлюза (healthcheck).

По умолчанию переменная не используется (закомментирована)

Примечание: сертификат - артефакт, содержащий информацию о владельце ключа и подтверждающий принадлежность ключа владельцу

Не задан
WSPROXY_HEALTH_CHECK_KEY /etc/opt/termidesk-vdi/wsproxy-healthcheck.key

Путь к закрытому ключу, который используется для защиты подключения API-запросов по состоянию Шлюза (healthcheck).

По умолчанию переменная не используется (закомментирована)

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

 Не задан
LOG_LEVEL INFO

Аргумент командной строки применяется для изменения уровня логирования Шлюза. Изначально уровень логирования применяется из значения переменной LOG_LEVEL конфигурационного файла  /etc/opt/termidesk-vdi/termidesk.conf. Для того чтобы применить уровень логирования из аргумента командной строки, необходимо отредактировать unit-файл службы Шлюза:

  • открыть для редактирования файл /lib/systemd/system/termidesk-wsproxy.service ;

  • найти строку, начинающуюся с ExecStart и добавить ключ --loglevel с нужным уровнем.

Пример строки:

ExecStart=/opt/termidesk/share/termidesk-vdi/venv/bin/python wsproxy.py --verification-key=/etc/opt/termidesk-vdi/wsproxy/id_rsa.pub --host=${WSPROXY_BIND_ADDRESS} --port=${WSPROXY_PORT} --loglevel=INFO

Затем выполнить перезапуск конфигурации и службы:

  • выполнить команду sudo systemctl daemon-reload;
  • выполнить команду  sudo systemctl restart termidesk-wsproxy.
 --loglevel



Далее информация относится к новому (экспериментальному) Шлюзу termidesk-gateway.

Параметры конфигурирования нового Шлюза задаются из конфигурационного файла /etc/termidesk/termidesk-gateway.conf. 

Для задания параметров конфигурирования нового Шлюза из файла необходимо:

  • создать пустой файл /etc/termidesk/ termidesk-gateway.conf: 
:~$ sudo touch /etc/termidesk/termidesk-gateway.conf
  • отредактировать файл termidesk-gateway.conf, указав необходимые значения для параметров:
# Адреса, на которых принимать входящие подключения
wsServerIP=0.0.0.0
# Прослушиваемый порт для входящих подключений
wsServerPort=5099
# Адрес брокера, по которому будет осуществляться проверка пользовательских подключений в случае комплексной установки
# Если программный комплекс Termidesk установлен в распределенном варианте, вместо 127.0.0.1 следует указать адрес балансировщика 
urlCheckToken=https://127.0.0.1/api/wsproxy/v1/verify
# Режим журналирования. 
# gatewayLogMode=-l - включить отладку уровня INFO.
# gatewayLogMode=-d - включить отладку уровня DEBUG.
# Пустое значение параметра gatewayLogMode= - выключить отладку.
# gatewayLogMode=-l
  • выполнить перезагрузку службы:
:~$ sudo systemctl restart termidesk-gateway

Доступные параметры, а также аргументы командной строки для нового Шлюза приведены в таблице.

Для получения информации по доступным параметрам из интерфейса командной строки, необходимо выполнить команду:

:~$ termidesk-gateway --help


Параметр конфигурационного файлаЗначение по умолчанию после установки ШлюзаОписаниеАргумент командной строки
wsServerPort 5099 Порт прослушивания службы для входящих подключений --wsServerPort

wsServerIP

127.0.0.1

Адрес прослушивания входящих подключений при комплексной установке.

При распределенной установке необходимо использовать значение 0.0.0.0, чтобы порт 5099 прослушивался не только localhost, если планируется принимать запросы на подключения с внешних систем (например, с балансировщиков нагрузки)

 --wsServerIP

Не задан

10000 Порт прослушивания службы для входящих подключений по протоколу SSL --wssServerPort

Не задан

127.0.0.1

Адрес прослушивания входящих подключений по протоколу SSL при комплексной установке.

При распределенной установке необходимо использовать значение 0.0.0.0, чтобы порт прослушивался не только localhost, если планируется принимать запросы на подключения с внешних систем (например, с балансировщиков нагрузки)

 --wssServerIP

Не задан

Нет

Путь к файлу ключа для соединения SSL

 --sslKey

Не задан

Нет

Путь к файлу сертификата для соединения SSL

 --sslCert

Не задан

Нет Парольная фраза для соединения SSL --sslPassPhrase

Не задан

Нет Путь к файлу с ключами Диффи-Хеллмана для соединения SSL --sslDhParams

Не задан

Нет

Путь к корневому сертификату, на котором выпущен сертификат, указанный в параметре sslCert.

Используется для проверки подлинности указанного в параметре sslCert сертификата

 --sslCa

Не задан

Нет Используемый алгоритм для преобразований для соединения SSL --sslCiphers
urlCheckToken https://127.0.0.1/api/wsproxy/v1/verify

IP-адрес или FQDN диспетчера Termidesk для обслуживания API-запросов по состоянию Шлюза в случае комплексной установки.

Если программный комплекс Termidesk установлен в распределенном варианте, следует изменить значение 127.0.0.1 на IP-адрес или FQDN балансировщика

 Не задан
Не задан 30

Интервал установки соединения (в секундах)

 --wsIdleTimeout
gatewayLogMode Нет

Активация и переключение режима журналирования. Значение задается через файл termidesk-gateway.conf.

При значении «-d» активируется подробный режим уровня DEBUG, при значении «-l» активируется менее подробный режим уровня INFO. Пустое значение параметра приводит к отключению режима журналирования.

Активировать режим можно также через аргумент командной строки, для этого выполнить:

termidesk-gateway <значение>

Пример:

termidesk-gateway -l

Информация будет выводиться в интерфейс командной строки. Для прекращения вывода и отключения режима необходимо нажать сочетание клавиш <Ctrl>+<C>

-d

-l