Перейти к содержанию

Установка#

Существует 2 типа комплекта поставки системы, которые отличаются источниками настроек конфигурации:

  • в комплекте поставки под Ubuntu 18.04 x64 и Debian 10 x64 системой используются файлы конфигурации, которые находятся в папке /client. Эти файлы носят наименование server.conf и rsengine.conf:
  • server.conf содержит параметры настройки работы сервера и уровней логирования;
  • rsengine.conf содержит настройки порогов для выполнения проверок Liveness;
  • в комплекте поставки под ОС Windows по умолчанию системой используется реестр Windows, где хранятся настройки для RSE Server и библиотеки RSEngine после установки Системы.

По умолчанию файлы конфигурации в поставке под ОС Windows в папке /client отсутствуют, т.к. рекомендуемый способ настройки – через реестр Windows. В случае, если выбран способ настройки через файлы конфигурации, их необходимо отдельно запросить у VisionLabs

Описание установки на ОС Windows#

RSE Server устанавливается как сервис Windows.

Для установки Системы на ОС Windows необходимо выполнить следующие шаги:

Активация лицензии#

Необходимо указать данные лицензии в параметрах файла лицензии.

Для этого в файле data/license.conf необходимо указать соответствующие значения.

Значения параметров лицензирования берется из письма с лицензией по запросу у представителя VisionLabs.

Таблица 2. Описание переменных в файле data/license.conf

Переменная Описание Пример
Server Адрес сервера лицензии. https://
EID Идентификатор права доступа. 00000000-0000-0000-0000-000000000000
ProductID Идентификатор продукта. 00000000-0000-0000-0000-000000000000
LICENSE_FILENAME Название файла лицензии. Не рекомендуется изменять. license.dat
LICENSE_CONTAINERMODE Запуск лицензии в контейнере.Система поддерживает только локальную лицензию. 0 – запуск в контейнере.
1 – локально.

Подготовка к установке Системы#

Местом установки Системы является место, где расположен дистрибутив Системы.

Для установки Системы необходимо запустить пакетный файл InstallService.bat, который находится в корневой папке поставки.

Необходимо выполнять запуск InstallService.bat от имени администратора.

При установке Системы будет создана директория для записи логов (адрес по умолчанию C:\RSE\logs).

Конфигурирование Системы#

Настройка параметров конфигурации может производиться через реестр Windows.

Параметры конфигурации Системы записываются в реестр Windows (все значения выставляются по умолчанию) и могут быть отредактированы администратором (описание параметров см. в "Руководстве администратора", Приложение 1).

Управление Системой#

После завершения установки можно управлять RSE Sever с помощью менеджера служб services.msc.

Местоположение RSE Server и файлов *.conf после установки не должно меняться. В противном случае работоспособность Системы будет нарушена.

Описание установки на ОС Ubuntu 18.04 x64 и Debian 10 x64#

Для установки Системы на целевую машину с ОС Ubuntu 18.04 x64 и Debian 10 x64 используется Ansible, который необходимо предварительно установить:

apt-get install ansible

Для того, чтобы проверить, что Ansible установился корректно, необходимо ввести следующую команду:

ansible --version

При успешной установке в консоли отобразиться версия Ansible и прочая информация:

  ansible [core 2.12.4]
    config file = /etc/ansible/ansible.cfg
    configured module search path = ['/home/vivek/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
    ansible python module location = /usr/lib/python3/dist-packages/ansible
    ansible collection location = /home/vivek/.ansible/collections:/usr/share/ansible/collections
    executable location = /usr/bin/ansible
    python version = 3.8.10 (default, Mar 15 2022, 12:22:08) [GCC 9.4.0]
    jinja version = 2.10.1
    libyaml = True

Предварительные действия и активация лицензии#

Перед запуском установки необходимо:

  • добавить в файл ansible/hosts, адреса (ip или hostname) целевых устройств для установки дистрибутива. В каждой строчке указывается один адрес.

Пример:

[rse]
12\.16.58.33
  • скорректировать общие переменные и данные лицензии (Таблица 3) в файле group_vars/all.yml для установочных Ansible скриптов.

LICENSE_SERVER, LICENSE_EID, LICENSE_PRODUCTID отвечают за лицензирования Системы – данная информация берется из письма с лицензией по запросу у сотрудника VisionLabs

Таблица 3. Описание переменных для установочных Ansible скриптов в файле group_var/all.yml

Переменная Описание Возможные значения
RSE_HOME Директория для установки. Не рекомендуется изменять путь. /var/lib/kiosk
RSE_VERSION Версия Системы. Значение должно совпадать с именем архива ```ub1804_x64_v1.0.4_rc2
RSE_ZIP_LOCATION Расположение дистрибутива. Абсолютный или относительный путь до дистрибутива RSE Server внутри дистрибутива поставки. ../distr/rse-server_{{ RSE_VERSION }}.zip
LICENSE_SERVER Адрес сервера лицензии. Данные запрашиваются у сотрудника Visionlabs. https://.com
LICENSE_EID Идентификатор права доступа. Данные запрашиваются у сотрудника Visionlabs. 00000000-0000-0000-0000-000000000000
LICENSE_PRODUCTID Идентификатор продукта. Данные запрашиваются у сотрудника Visionlabs. 00000000-0000-0000-0000-000000000000
LICENSE_FILENAME Название файла лицензии. Не рекомендуется изменять. license.dat
LICENSE_CONTAINERMODE Запуск лицензии в контейнере.Система поддерживает только локальную лицензию. 0 – запуск в контейнере.
1 – локально.

Установка Системы#

Местом установки Системы является путь, указанный в переменной RSE_HOME.

Для запуска процесса установки необходимо:

  • перейти в папку ansible;
  • если установка производится на несколько устройств сразу (в host указано более одного ip адреса), то необходимо запустить команду:
ansible-playbook -I hosts install_rse.yml

В процессе установки Ansible пытается подключиться в качестве пользователя Системы (по умолчанию root) через соответствующую пару ключей SSH. Если вместо ключей используется пароль, то к команде на установку потребуется добавить флаг --ask-pass.

  • если установка производится локально на одно устройство, то следует запустить команду:
ansible-playbook -i hosts–-connection=local–-inventory 127.0.0.1, install_rse.yml

Настройка Системы#

При запуске RSE Server, Система использует настройки из файлов конфигурации server.conf и rsengine.conf (описание параметров см. в "Руководстве администратора", Приложение 1).

В случае, если необходимо изменить настройки клиентской конфигурации необходимо внести изменения в файлах server.conf и rsengine.conf и перезапустить RSE Server.

В случае успешной установки и после запуска Системы логи будут записываться в лог-файлы в директорию по умолчанию ./logs. Соответствующий путь до нее можно изменить в параметре log-path в файле server.conf.

Управление Системой в Linux#

После завершения установки можно управлять RSE Sever с помощью утилиты командной строки systemctl.

Для запуска RSE Sever необходимо запустить следующую команду:

systemctl start kiosk

Для остановки RSE Sever необходимо запустить следующую команду:

systemctl stop kiosk