Для установки и запуска ExeReport необходимо распаковать архив, содержащий ПО (инсталляционный пакет) и предоставленный Вендором.

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

Затем необходимо отредактировать файл docker-compose.yaml, расположенный в корневой папке каталога:

• заменить по тексту файла параметр [host_ip] на ip адрес хоста, на котором инсталлирован Docker;
• заменить по тексту файла параметр [license_server_ip] на ip адрес хоста, на котором установлен сервер лицензирования Guardant Control Center;
• настроить необходимые переменные окружения.

• скопировать в каталог /exereport/crt сгенерированные ранее сертификаты;
• предоставить права на сгенерированные ранее файлы сертификатов, выполнив команду:

  chmod -R 777 /exereport/crt/

• отредактировать файл docker-compose.yaml: заменить по тексту файла "mycompany.local" на имя домена, для которого сгенерированы сертификаты;
• отредактировать файлы: /exereport/data/exereport/keycloak.json: заменить в ссылках "mycompany.local" на имя домена, для которого сгенерированы сертификаты. Пример:

  { "realm": "exemes", "auth-server-url": "https://keycloak.[домен]:5787/", "ssl-required": "external", "resource": "exereport", "verify-token-audience": false, "credentials": { "secret": "********************************" }, "use-resource-role-mappings": true, "confidential-port": 0, "policy-enforcer": {}, "Logout": "https://report.[домен]:9200/" }

Далее необходимо открыть терминал ОС с root доступом, перейти в каталог, появившийся после распаковки архива, и выполнить команду:

bash install-exereport.sh

при этом произойдет загрузка образов, копирование данных и запуск сервисов.

install-exereport.sh следующий код:

docker volume create portainer_data
docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:2.20.2
systemctl restart docker

chmod +x install-exereport.sh

После завершения выполнения скрипта будут запущены контейнеры приложений ExeReport, что будет подтверждено соответствующим сообщением в терминале.

Если вы запускаете ExeReport в демонстрационных, тестовых или обучающих целях (не на продуктивной среде) с использованием домена mycompany.local, то вы можете пропустить следующие шаги

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

Настройка переменной окружения DBConnection выполняется путем редактирования файла docker-compose.yaml. Пример:

DBConnection: "Host=localhost;Port=5432;Database=exereport;Username=postgres;Password=postgres"

Для разрешения CORS необходимо передать переменную окружения AllowedCORSUrls, в которой через запятую перечислить разрешенные сайты. Настройка переменной окружения AllowedCORSUrls выполняется путем редактирования файла docker-compose.yaml. Пример:

AllowedCORSUrls: "https://elma365.exeplant.local,https://portal.exeplant.local"

Для подключения ExeReport к ExeMES необходимо передать переменную окружения MiddlewareApiRootUri, в которой указать ссылку на запущенное приложение ExeMES Server. Настройка переменной окружения MiddlewareApiRootUri выполняется путем редактирования файла docker-compose.yaml (по умолчанию строка закомментирована в файле в составе инсталляционного пакета). Пример:

MiddlewareApiRootUri: "https://middleware.[домен]:7142/api"

Для настройки времени жизни отчета необходимо передать переменную окружения WebReportLifeTimeInterval, в которой указать значение в секундах. Настройка переменной окружения WebReportLifeTimeInterval выполняется путем редактирования файла docker-compose.yaml. Пример:

WebReportLifeTimeInterval: "600"

Доступно начиная с версии ExeReport 2.1

1. Распакуйте инсталляционный пакет ExeReport на хост, где уже запущен ExeMES;
2. Скопируйте из распакованного инсталляционного пакета каталог /data/exereport в каталог /data/ с конфигурационными файлами ExeMES

   По умолчанию ExeMES устанавливается в каталог root/dev/

3. Проверьте, что используемый в ExeMES сертификат crt содержит имя report.[домен]

   По умолчанию сертификаты ExeMES расположены в каталоге root/dev/crt/

   При необходимости сгенерируйте новые сертификаты с указанием имен для ExeReport.

1. Зайдите в существующий экземпляр keycloak под УЗ администратора. В меню слева выберите реалм exemes и перейдите в пункт меню Clients:
2. В основной части экрана нажмите кнопку «Import client»:
3. Ниже в центральной части экрана нажмите «Browse...»:
4.  Выберите файл из распакованного инсталляционного пакета \upd\exereport_client.json, содержащий настройки для клиента ExeReport и нажмите кнопку Save:
5. При успешном импорте настроек появится соответствующее сообщение:

   При возникновении ошибок в процессе импорта обратитесь в техническую поддержку

6. В меню слева перейдите в пункт меню Clients, выберите в списке клиент exereport:
7. Перейдите на вкладку Settings и укажите следующие значения в соответствии с вашей конфигурацией:

   Root URL = https://report.[домен].local:9200/
   Home URL = https://report.[домен].local:9200/
   Valid redirect URIs = https://report.[домен].local:9200/*
   Valid post logout redirect URIs = https://report.[домен].local:9200/*

   

   При использовании демонстрационного домена и сертификатов mycompany.local, которые входят в инсталляционный пакет ExeReport, пункты 7 и 8 можно пропустить

    

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

1. В центральной части экрана перейдите на вкладку «Roles» и нажмите кнопку «Create role»:
2. Создайте 2 роли со следующими параметрами:
   • Role name = MR, Description = Доступ к настройке отчетов.
   • Role name = VR, Description = Доступ к просмотру отчетов.
3. Назначьте новые роли соответствующим группам пользователей, в зависимости от вашей конфигурации. Подробно об Управлении доступом к ExeReport.

Активируйте лицензию ExeReport на уже существующем сервере лицензирования ExeMES или установите сервер лицензирования и активируйте лицензию отдельно для ExeReport.

1. Откройте консоль под УЗ администратора ОС на хосте с установленным ExeMES;
2. Перейдите в папку с распакованным инсталляционным пакетом ExeReport;
3. Выполните команду:

   docker load -i ./images/exereport[версия ExeReport].tar

4. Перейдите в каталог с установленным экземпляром ExeMES;

   По умолчанию ExeMES устанавливается в каталог root/dev/

5. Модифицируйте существующий файл docker-compose.yaml ExeMES: добавьте следующий код в файл docker-compose.yaml:

   exereport: container_name: exereport image: "git.exeplant.ru:5050/mes-develop/exereport:[версия ExeReport]" restart: always environment: ASPNETCORE_URLS: "https://+;http://+" ASPNETCORE_HTTPS_PORT: "9200" ASPNETCORE_Kestrel__Certificates__Default__Password: "[пароль сертификата pfx]" ASPNETCORE_Kestrel__Certificates__Default__Path: "/root/.aspnet/https/[имя сертификата ExeReport].pfx" TZ: "Europe/Moscow" DBConnection: "[строка подключения к экземпляру PG SQL, который используется ExeMES]" GCCSettings:BroadcastRemoteLicenses: "0" GCCSettings:UseRemoteHosts: "1" GCCSettings:Remotehosts: "[license_server_ip]" WebReportLifeTimeInterval: "60" MiddlewareApiRootUri: "https://[имя запущенного приложения ExeMES Server]:7142/api" volumes: - type: bind source: /root/dev/crt/[имя сертификата ExeReport].pfx target: /root/.aspnet/https/[имя сертификата ExeReport].pfx - type: bind source: /root/dev/crt/[имя сертификата ExeReport].crt target: /etc/ssl/certs/[имя сертификата ExeReport].pem ports: - "9200:443" extra_hosts: - "localhost report.[домен] middleware.[домен] keycloak.[домен]:[host_ip]"

   Следующие параметры можно сконфигурировать по аналогии с имеющейся конфигурацией в файле docker-compose.yaml: строка подключения к экземпляру PG SQL, который используется ExeMES; имя запущенного приложение ExeMES Server; имя сертификата pfx (если используются существующий сертификат ExeMES); пароль сертификата pfx (если используются существующий сертификат ExeMES); license_server_ip (если используется существующий сервер лицензирования); host_ip; домен.

6. Откройте консоль и перейдите в папку с отредактированным файлом docker-compose.yaml;
7. Выполните команду:

   docker compose up -d

Если вы хотите отказаться от использования портов в адресах приложений, то необходимо использовать прокси-сервер, например Nginx

В настройках контейнеров ExeReport по умолчанию указана синхронизация времени контейнера с временем хоста, на котором он запущен. Рекомендуется синхронизировать локальное время хостов, на которых запускаются контейнеры ExeReport с корпоративным ntp сервером.