Установка#
Существует 2 типа комплекта поставки системы, которые отличаются источниками настроек конфигурации:
- в комплекте поставки под Ubuntu 18.04 x64, Debian 10 x64 и Armbian 23 системой используются файлы конфигурации, которые находятся в папке
/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;
- в
server.conf
, если установка Сервиса производится на ОС Ubuntu 18.04 x64, Debian 10 x64 и и Armbian 23.
Конфигурирование Системы#
Настройка параметров конфигурации может производиться через реестр Windows.
Параметры конфигурации Системы записываются в реестр Windows (все значения выставляются по умолчанию) и могут быть отредактированы администратором (описание параметров см. в "Руководстве администратора", Приложение 1).
Управление Системой#
После завершения установки можно управлять RSE Sever с помощью менеджера служб services.msc
.
Местоположение RSE Server и файлов
*.conf
после установки не должно меняться. В противном случае работоспособность Системы будет нарушена.
Устранение проблем с выборкой метаданных для сенсоров камеры RealSense#
ОС Windows требует наличия специальной записи в реестре для каждого уникального видеоустройства, чтобы предоставлять метаданные. Метаданные, или атрибуты метаданных, относятся к дополнительной информации, предоставляемой библиотекой librealsense
, и необходимы для правильного взаимодействия с сенсорами камеры RealSense.
Для активации функционала, связанного с атрибутами метаданных, в комплект поставки LUNA KIOSK включён файл realsense_metadata_win10.ps1
. Скрипт в файле создает и изменяет записи в реестре Windows для обеспечения корректной работы сенсоров камеры RealSense. Более подробная информация по активации метаданных представлена в документации библиотеки librealsense.
Описание установки на ОС Ubuntu 18.04 x64, Debian 10 x64 и Armbian 23#
Для установки Системы на целевую машину с ОС Ubuntu 18.04 x64, Debian 10 x64 и Armbian 23 используется 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_2.3.0.zip | |
LICENSE_SERVER |
Адрес сервера лицензии. Данные запрашиваются у сотрудника Visionlabs |
https:// |
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
Активация лицензии в офлайн-режиме#
Офлайн-активация выполняется в отсутствии доступа к Интернету на устройстве, на котором должна быть активирована лицензия. В этом случае используется отпечаток вашего устройства, а лицензия активируется на любом другом устройстве с доступом к Интернету.
Запросите у сотрудников VisionLabs адрес сервера лицензии и идентификатор права доступа EID.
На устройстве, на котором должна быть активирована лицензия
1․ Откройте файл license.conf
в каталоге data
, введите EID и сохраните изменения.
2․ — На ОС Ubuntu 18.04 x64, Debian 10 x64 или Armbian 23 перейдите в каталог extras
, где находится утилита FingerprintViewer
.
* Предоставьте права доступа к утилите `FingerprintViewer`:
```
chmod +x FingerprintViewer
```
* Запустите утилиту, указав путь до файла license.conf:
```
./FingerprintViewer ../data/license.conf
```
— На ОС Windows откройте корневую папку дистрибутива, где находится утилита `FingerprintViewer`, и запустите `FingerprintViewer.exe`.
3․ Отпечаток будет выведен в консоли. Скопируйте и сохраните его.
На устройстве с доступом к Интернету
1․ Перейдите на сайт для активации лицензии (адрес был получен в начале).
2․ Введите ваш EID для входа на сайт и активируйте лицензию, используя отпечаток вашего устройства.
3․ Скачайте сертификат лицензии.
4․ Обратите внимание, что по умолчанию имя файла лицензии licenseFile.v2c
. Переименуйте файл одним из представленных ниже способов:
Переместите файл licenseFile.v2c
в каталог data
.
-
Измените параметр
Filename
в файлеlicense.conf
по примеру:xml <param name="Filename" type="Value::String" text="licenseFile.v2c"/>
-
Переименуйте
licenseFile.v2c
вlicense.dat
. ПараметрFilename
в файлеlicense.conf
не требует изменений и остаётся по умолчанию:xml <param name="Filename" type="Value::String" text="license.dat"/>
На устройстве, на котором должна быть активирована лицензия
Скопируйте полученный лицензионный ключ license.dat
в каталог data
.