Конфигурационные файлы «Удаленного помощника»

Конфигурационные файлы серверной части

Конфигурационный файл серверной части

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

  • в конфигурационном файле /etc/opt/termidesk-assistant/assistant.conf. После установки конфигурационный файл не существует, поэтому его нужно предварительно создать. Если файл не существует, параметры в нем закомментированы или какие-то из параметров не указаны, то будут использоваться значения по умолчанию, указанные в таблице (см. таблицу Параметры конфигурационного файла серверной части Удаленного помощника). Для переопределения значений по умолчанию нужно раскомментировать нужный параметр;

  • через переменную окружения, заданную в файле /etc/default/termidesk-assistant-server. Переменная окружения имеет более высокий приоритет, чем параметры, заданные через конфигурационный файл.

Пример файла /etc/opt/termidesk-assistant/assistant.conf с изначально закомментированными параметрами:

# STUN_SERVER_URL1="stun:stun.services.mozilla.com"
# STUN_SERVER_URL2="stun:stun.l.google.com:19302"
# STUN_SERVER_URL3=""
# WEBRTC_MOUSE_CURSOR=Yes
# BROWSER_MOUSE_CURSOR=Yes
# MEMCACHE_HOST1="127.0.0.1:11211"
# REDIS_HOST1=""
# AUDIT_SYSLOG_HOST1="127.0.0.1:514"
# AUDIT_SYSLOG_PROTO="UDP"
# AUDIT_SYSLOG_FACILITY="syslog"
# AUDIT_MAX_MESSAGE_LENGTH=1024
# AUDIT_QUEUE_SIZE=1000
# AUDIT_TLS_CERT_PATH=
# AUDIT_TLS_KEY_PATH=
# AUDIT_TLS_CA_PATH=
# AUTH_IP_LIST=["0.0.0.0/0"]
# AUTH_TOKEN_LIST=['Значение1', 'Значение2']
# AUDIO_ENABLE=Yes
# CAMERA_ENABLE=Yes
# MEDIA_ROOT = "/opt/termidesk/share/assistant/var/media"
# LOG_DIR=/var/log/termidesk/assistant

Описание параметров конфигурационного файла серверной части приведено в таблице (см. таблицу Параметры конфигурационного файла серверной части Удаленного помощника).

Таблица 1. Параметры конфигурационного файла серверной части Удаленного помощника
Параметр Значение по умолчанию Описание

STUN_SERVER_URL1

stun:stun.services.mozilla.com

Менять параметр не рекомендуется.

IP-адрес или FQDN сервера STUN. Используется для возможности установки сеанса связи через внешнюю сеть.

Можно задать несколько адресов, но не более трех

STUN_SERVER_URL2

stun:stun.l.google.com:19302

Менять параметр не рекомендуется.

IP-адрес или FQDN сервера STUN. Используется для возможности установки сеанса связи через внешнюю сеть.

Можно задать несколько адресов, но не более трех

WEBRTC_MOUSE_CURSOR

Yes

Управление поведением курсора мыши при подключении к экрану пользователя.

Возможные значения:

  • Yes - включить отображение курсора как экрана пользовательской ОС, так и локальной ОС;

  • No - выключить отображение локального курсора в области отображения экрана пользовательской ОС

BROWSER_MOUSE_CURSOR

Yes

Менять параметр не рекомендуется.

Управление поведением курсора мыши из гостевой ОС в браузер.

Возможные значения:

  • Yes - включить отображение курсора в браузере;

  • No - выключить отображение курсора в браузере

MEMCACHE_HOST1

127.0.0.1:11211

Менять параметр не рекомендуется.

IP-адрес или FQDN сервера memcache и порт.

Можно задать только один сервер

REDIS_HOST1

Не задано

IP-адрес или FQDN сервера Redis и порт.

Можно задать только один сервер. Если IP-адрес и порт не заданы, сервер Redis не используется.

Примеры:

  • REDIS_HOST1="127.0.0.1:6379" - сервер redis задан и используется;

  • REDIS_HOST1="" - сервер redis не используется

AUDIT_ENABLE

No

Управление отправкой сообщений на сервер syslog.

Возможные значения:

  • Yes - отправка сообщений включена;

  • No - отправка сообщений отключена

AUDIT_SYSLOG_HOST1

127.0.0.1:514

IP-адрес или FQDN сервера syslog и порт. Если параметр не задан, сообщения не будут отправлены.

Можно задать только один сервер

AUDIT_SYSLOG_PROTO

UDP

Протокол подключения к серверу syslog.

Возможные значения:

  • TLS. Для использования защищенного соединения по протоколу TLS нужно также задать параметры AUDIT_TLS_CERT_PATH, AUDIT_TLS_KEY_PATH и AUDIT_TLS_CA_PATH. Если указанные параметры не заданы, то подключение работать будет, но без защитного преобразования;

  • TCP;

  • UDP

AUDIT_SYSLOG_FACILITY

syslog

Категория сообщений syslog. Возможные значения:

  • auth;

  • authpriv;

  • cron;

  • daemon;

  • ftp;

  • kern;

  • lpr;

  • mail;

  • news;

  • syslog;

  • user;

  • uucp;

  • local0;

  • local1;

  • local2;

  • local3;

  • local4;

  • local5;

  • local6;

  • local

AUDIT_MAX_MESSAGE_LENGTH

1024

Максимальная длина сообщений аудита

AUDIT_QUEUE_SIZE

1000

Длина очереди сообщений

AUDIT_TLS_CERT_PATH

Не задано

Путь к файлу сертификата для соединения TLS. Параметр должен быть задан, если в параметре AUDIT_SYSLOG_PROTO задано значение TLS.

Файл сертификата должен быть скопирован в каталог /opt/termidesk/share/assistant/django_termidesk_assistant/.

Параметр не имеет значения по умолчанию.

Пример:

AUDIT_TLS_CERT_PATH='/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-snakeoil.pem' или AUDIT_TLS_CERT_PATH="/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-snakeoil.pem"

AUDIT_TLS_KEY_PATH

Не задано

Путь к файлу ключа для соединения TLS. Параметр должен быть задан, если используется параметр AUDIT_TLS_CERT_PATH.

Ключ может иметь парольную защиту. Для использования ключа нужно преобразовать его к начальному значению:

openssl rsa -in <путь_к_файлу_ключа>.key -out <путь_сохранения_преобразованного_ключа>.key

Файл ключа должен быть скопирован в каталог /opt/termidesk/share/assistant/django_termidesk_assistant/.

Параметр не имеет значения по умолчанию.

Пример:

AUDIT_TLS_KEY_PATH='/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-snakeoil.key' или AUDIT_TLS_KEY_PATH="/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-snakeoil.key"

AUDIT_TLS_CA_PATH

Не задано

Путь к корневому сертификату, на котором выпущен сертификат, указанный в параметре AUDIT_TLS_CERT_PATH. Файл корневого сертификата должен быть скопирован в каталог /opt/termidesk/share/assistant/django_termidesk_assistant/.

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

Параметр не имеет значения по умолчанию.

Пример:

AUDIT_TLS_CA_PATH='/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-ca.crt’ или `AUDIT_TLS_CA_PATH="/opt/termidesk/share/assistant/django_termidesk_assistant/ssl-cert-ca.crt"

AUTH_IP_LIST

0.0.0.0/0

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

Если подключение инициируется через «Портал администратора» Termidesk, то в списке должны быть заданы:

  • IP-адрес «Портала администратора» Termidesk;

  • IP-адрес РМ, к которому производится подключение.

Если подключение инициируется вручную, не через «Портал администратора» Termidesk, то ограничение списка сетей, заданное в этом параметре, игнорируется.

Поддерживается задание списка сетей в следующих форматах:

  • IP-адрес;

  • IP-адрес в формате CIDR.

Пример:

AUTH_IP_LIST=[192.0.2.10, 198.51.100.0/24]

AUTH_TOKEN_LIST

Не задано

Значение мастер-ключа «Портала администратора» Termidesk. Используется для авторизации запросов на создание сессии при подключении через «Портала администратора» Termidesk.

Этот тип авторизации имеет более высокий приоритет, чем авторизация по IP-адресам (параметр AUTH_IP_LIST).

После задания параметра потребуется перезагрузка службы termidesk-assistant-server.

Значение можно получить, перейдя в «Портале администратора» по пути «Системные параметры - Системные настройки - Безопасность» и скопировав значение параметра «Мастер-ключ».

Особенности функционирования:

  • если параметр используется (не закомментирован), то:

    • при подключении через «Портала администратора» Termidesk в запросе к серверной части Удаленного помощника будет передан токен (заголовок X-TDSK-TOKEN), содержащий преобразованное значение мастер-ключа;

    • серверная часть Удаленного помощника выполнит обратное преобразование значения для получения мастер-ключа и затем сравнит его с тем, что задано в этом параметре;

    • если полученное значение окажется отличным от того, что задано в параметре, то сессия не создастся и пользователю будет отображена ошибка 401;

  • если параметр не используется (закомментирован), то проверка значений серверной частью Удаленного помощника не производится. При подключении через «Портала администратора» Termidesk серверная часть Удаленного помощника создаст сессию без авторизации по токенам.

Длина строки получаемого токена (преобразованного значения мастер-ключа) ограничена 1024 байтами.

Пример:

AUTH_TOKEN_LIST=['123456789', 'masterkey']

AUDIO_ENABLE

Yes

Управление передачей звука при подключении к пользователю.

Если подключение выполняется через «Портал администратора» Termidesk, то настройки с сервера Termidesk, заданные через политики фонда рабочих мест, приоритетнее, чем настройка, заданная в этом параметре.

Если подключения выполняется через REST API, то настройки, переданные в запросе, приоритетнее, чем настройка, заданная в этом параметре.

Возможные значения:

  • Yes - передача звука включена;

  • No - передача звука отключена

CAMERA_ENABLE

Yes

Управление передачей веб-камеры при подключении к пользователю.

Если подключение выполняется через «Портал администратора» Termidesk, то настройки с сервера Termidesk, заданные через политики фонда рабочих мест, приоритетнее, чем настройка, заданная в этом параметре.

Если подключения выполняется через REST API, то настройки, переданные в запросе, приоритетнее, чем настройка, заданная в этом параметре.

Возможные значения:

  • Yes - передача веб-камеры включена;

  • No - передача веб-камеры отключена

MEDIA_ROOT

/opt/termidesk/share/assistant/var/media

Каталог для хранения файлов

LOG_DIR

/var/log/termidesk/assistant

Каталог хранения журналов серверной части Удаленного помощника.

Для записи журналов в новый каталог он должен быть предварительно создан:

sudo mkdir <путь_к_каталогу>
sudo chown termidesk-assistant:termidesk-assistant <путь_к_каталогу>

Файл /etc/default/termidesk-assistant-server

Одним из параметров службы termidesk-assistant-server является аргумент EnvironmentFile, задающий путь к дополнительным аргументам запуска, перечисленным в файле /etc/default/termidesk-assistant-server.

Файл /etc/default/termidesk-assistant-server:

  • является необязательным и может отсутствовать в ОС;

  • если он существует, то происходит его построчное чтение в формате <ключ>=<значение> и в запускаемый процесс добавляются переменные окружения, которые указаны в этом файле (см. подраздел Переменные окружения).

Конфигурационные файлы клиентской части

Конфигурационный файл клиентской части

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

  • для ОС Linux:

    • в конфигурационном файле /etc/termidesk/assistant/client.conf;

    • через переменную окружения, заданную в файле /etc/default/termidesk-assistant-client;

  • для ОС Microsoft Windows:

    • в конфигурационном файле C:\ProgramData\UVEON\Termidesk Assistant.ini. При отсутствии данного файла используется файл C:\Users\<Пользователь>\AppData\Roaming\UVEON\Termidesk Assistant.ini;

    • через переменную окружения (см. подраздел Переменные окружения).

Переменная окружения имеет более высокий приоритет, чем параметры, заданные через конфигурационный файл. После установки конфигурационный файл не существует, поэтому его нужно предварительно создать. Если файл не существует, параметры в нем закомментированы или какие-то из параметров не указаны, то будут использоваться значения по умолчанию, указанные в таблице (см. таблицу Параметры конфигурационного файла клиентской части Удаленного помощника).

Пример содержимого конфигурационного файла клиентской части:

LOG_DIR=~/.config/UVEON/logs

Описание параметров конфигурационного файла клиентской части приведено в таблице (см. таблицу Параметры конфигурационного файла клиентской части Удаленного помощника).

Таблица 2. Параметры конфигурационного файла клиентской части Удаленного помощника
Параметр Значение по умолчанию Описание

LOG_DIR

Для ОС Linux: ~/.config/UVEON/logs

Для ОС Microsoft Windows: C:/Users/<Пользователь>/AppData/Roaming/UVEON/logs

Каталог хранения журналов клиентской части Удаленного помощника.

Для записи журналов в новый каталог он должен быть предварительно создан:

sudo mkdir <путь_к_каталогу>
sudo chown $USER:$USER <путь_к_каталогу>

Файл /etc/default/termidesk-assistant-client

Одним из параметров службы termidesk-assistant-client является аргумент EnvironmentFile, задающий путь к дополнительным аргументам запуска, перечисленным в файле /etc/default/termidesk-assistant-client.

Файл /etc/default/termidesk-assistant-client:

  • является необязательным и может отсутствовать в ОС;

  • если он существует, то происходит его построчное чтение в формате <ключ>=<значение> и в запускаемый процесс добавляются переменные окружения, которые указаны в этом файле (см. подраздел Переменные окружения).