Запуск платформы

Owned by Эдуард Столяр
Last updated: апр. 18, 2023
7 min read

При возникновении проблем при запуске скриптов, выполните настройку Docker по инструкции: Post-installation steps for Linux.

При любом способе установки и обновления, не используйте скрипты run.sh, находящиеся в каталогах v2 и v3, используйте только run.sh, находящийся в корне дистрибутива. Скрипты, которые необходимо запускать из каталогов v2 и v3, явно прописаны.

Для запуска платформы выполните следующие шаги:

  1. Обязательный шаг. Выполните следующую команду с правами суперпользователя, которая создает необходимые папки в /docker-volume:
    sudo v2/prepare-folders.sh

  2. Обязательный шаг. Выполните команду, которая задает конфигурацию запуска:
    v2/prepare-config.sh
    Если никакие параметры изменять не нужно и достаточно тех, что указаны по умолчанию - запустите скрипт без параметров
    Данная команда может выполняться со следующими параметрами:

    • --with-seq <true | false> – запускает платформу с системой логирования Seq. Значение по умолчанию: false.

    • --with-vitalk <true | false> – определяет, будут ли запущены компоненты ViTalk. Значение по умолчанию: false.

    • --policy <true | false> – определяет, будет ли включен режим повышенной безопасности. Значение по умолчанию: false.

    • --remote-viqube <true | false> – запускает ViQube в режиме кластера. Значение по умолчанию: false.

    • --remote-sf <true | false> – запускает Smart Forms на другом сервере. Значение по умолчанию: false.

  3. Опционально. Выполните следующую команду, чтобы задать тэги для кастомных образов:
    v2/prepare-env.sh
    Вы можете использовать данную команду, чтобы задать конкретные версии определенным компонентам.
    Список доступных параметров, которые можно использовать с данной командой:

    • -qt <TAG> – Тэг для образа ViQube. Например: -qt release/viqube:2.30

    • -at <TAG> – Тэг для образа ViQube-Admin. Например: -at release/viqube-admin:2.30

    • -pt <TAG> – Тэг для образа Proxy. Например: -pt release/proxy:2.30

    • -st <TAG> – Тэг для образа SSBI. Например: -st release/ssbi:2.30

    • -ct <TAG> – Тэг для образа SmartForms App. Например: -ct release/smart-forms-app:2.30

    • -mt <TAG> – Тэг для образа SmartForms DB. Например: -mt release/smart-forms-db:2.30

    • -vla <TAG> – Тэг для образа ViLoader Application. Например: -vla release/viloader-app:2.30

    • -vld <TAG> – Тэг для образа ViLoader Database. Например: -vld release/viloader-db:2.30

    • -dt <TAG> – Тэг для компонентов Dashboard Server. Например: -dt release/all:2.30

    • -idt <TAG> – Тэг для образа Identity Server. Например: -idt release/identity-server:2.30

    • -vct <TAG> – Тэг для образа ViTalk-Core. Например: -vct release/vitalk-core:2.30

    • -vlt <TAG> – Тэг для образа ViTalk-Client. Например: -vlt release/vitalk-client:2.30

    • -rt <TAG> – Тэг для образа Regular-Reporting. Например: -rt release/regular-reporting:2.30

    • -kt <TAG> - Тэг для образа Kerberos-Auth-Server. Например: -kt release/kerberos-auth-server:2.30

    • -mdt <TAG> – Тэг для образа MongoDB. Например: -mdt release/mongo-db:2.30

    • -mgt <TAG> – Тэг для образа Migration-Service. Например: -mgt release/migration-service:2.30

    • -mlt <TAG> – Тэг для образа Mail-Service. Например: -mlt release/mail-service:2.30

    • -pst <TAG> – Тэг для образа Python-Script-Service. Например: -pst release/python-script-service:2.30

    • -ptt <TAG> – Тэг для образа Promtail. Например: -ptt release/promtail:2.30

    • -pht <TAG> – Тэг для образа Prometheus. Например: -pht release/prometheus:2.30

    • -lt <TAG> – Тэг для образа Loki. Например: -lt release/loki:2.30

    • -gt <TAG> – Тэг для образа Grafana. Например: -gt release/grafana:2.30

  4. Запустите скрипт run.sh с указанием IP-адреса, где <IP> - IP-адрес или домен вашего сервера:
    ./run.sh -p <IP>
    Данная команда может использоваться со следующими параметрами:

    • -p | --platform-ip <IP> – адрес сервера. Значение параметра может быть как IP-адресом, так и доменным именем сервера с установленной платформой. Например: --platform-ip <127.0.0.1>.

    • --https <true | false> – определяет, используется ли HTTPS. Значение по умолчанию: false. Обратите внимание, что для работы платформы по HTTPS, необходимо пройти шаги конфигурирования в разделе Настройка HTTPS. Одно лишь указание этого флага приведет к недоступности платформы и по HTTP, и по HTTPS.

    • --start v2 – запускает вторую версию платформы. Значение по умолчанию all – запускаются обе версии.

    • --stop – останавливает платформу.

    • --restart – перезапускает платформу.

    • -d | --debug – запускает платформу в режиме отладки.
      Данный скрипт будет использовать параметры запуска, заданные с помощью команд v2/prepare-config.sh и v2/prepare-env.sh.

  5. Подождите, пока произойдет загрузка.

  6. Введите в адресной строке браузера IP-адрес или домен вашего сервера. Например, http://192.168.45.207

  7. Для авторизации введите свой логин и пароль.

Смотрите также

Установка платформы

Для запуска платформы выполните следующие шаги:

  1. Обязательный шаг. Выполните следующую команду для инициализации Docker Swarm

    docker swarm init

  2. Обязательный шаг. Выполните следующую команду для получения идентификатора оборудования (hardware ID):
    v3/prepare-config.sh
    Скопируйте полученный идентификатор и отправьте его в Visiology. Идентификатор будет выглядеть примерно так:
    HARDWARE_ID: ab7a6a1604ce10ea84a06099c3a90b20d3fb383d68ccc549a324a2b63cd023c7

    Компания Visiology вышлет вам ключ лицензии.

  3. Обязательный шаг. Введите команду v3/prepare-config.sh с флагом -l и добавьте после него полученный ключ. Например:

    v3/prepare-config.sh -l khu67gyiTrcyr3WyrexU5fi76Bvgpi78H/p98jPomp0kpoi9hj76gi76 fvtur4dsy543/sxutrcu65vUoiy6vbo87bPiubNp98jo8jihp8i7gi7Ytd534wsaywr3zs6y453s86u5 fcIo76luybLip78hp98j09J0

  4. Опционально. Выполните следующую команду, чтобы задать тэги для кастомных образов:
    v3/prepare-env.sh

    Вы можете использовать данную команду, чтобы задать конкретные версии определенным компонентам.
    Список доступных параметров, которые можно использовать с данной командой:

    • -pt <TAG> – Тэг для образа Proxy. Например: -pt release/proxy-3:3.1

    • -st <TAG> – Тэг для образа Dashboard Service. Например: -st release/dashboard-service-3:3.1

    • -vt <TAG> – Тэг для образа Dashboard Viewer. Например: -vt release/dashboard-viewer-3:3.1

    • -dt <TAG> – Тэг для образа Visiology Designer. Например: -dt release/visiology-designer:3.1

    • -ft <TAG> – Тэг для образа Formula Engine. Например: -ft release/formula-engine:3.1

    • -mt <TAG> – Тэг для образа Data Management Service. Например: -mt release/data-management-service:3.1

    • -kt <TAG> – Тэг для образа KeyCloak. Например: -kt release/keycloak:3.1

    • -ot <TAG> – Тэг для образа Mongo. Например: -ot release/mongo:3.1

    • -gt <TAG> – Тэг для образа Postgres. Например: -gt release/postgres:3.1

    • -ct <TAG> – Тэг для образа ClickHouse. Например: -ct release/clickhouse-server:3.1

    • -jt <TAG> – Тэг для образа JDBC Bridge. Например: -jt release/jdbc-bridge:3.1

    • -nt <TAG> – Тэг для образа Minio. Например: -nt release/minio:3.1

    • -bt <TAG> – Тэг для образа Backup. Например: -bt release/backup-service:3.1

  5. Запустите скрипт run.sh с указанием IP-адреса, где <IP> - IP-адрес или домен вашего сервера:
    ./run.sh -p <IP>
    Данная команда может использоваться со следующими параметрами:

    • -p | --platform-ip <IP> – адрес сервера. Значение параметра может быть как IP-адресом, так и доменным именем сервера с установленной платформой. Например: --platform-ip <127.0.0.1>.

    • --https <true | false> – определяет, используется ли HTTPS. Значение по умолчанию: false. Обратите внимание, что для работы платформы по HTTPS, необходимо пройти шаги конфигурирования в разделе Работа по HTTPS. Одно лишь указание этого флага приведет к недоступности платформы и по HTTP, и по HTTPS.

    • --start v3 – запускает третью версию платформы. Значение по умолчанию all – запускаются обе версии.

    • --stop – останавливает платформу.

    • --restart – перезапускает платформу.

    • -d | --debug – запускает платформу в режиме отладки.
      Данный скрипт будет использовать параметры запуска, заданные с помощью команд v3/prepare-config.sh и v3/prepare-env.sh.

  6. Подождите, пока произойдет загрузка.

  7. Введите в адресной строке браузера следующий URL:
    <IP>/v3
    где <IP> – IP-адрес или домен вашего сервера.

  8. Для авторизации введите свой логин и пароль.

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

Работа без авторизации

Для отключения авторизации необходимо в скрипте run.sh изменить значение параметра USE_AUTHORIZATION с true на false и перезапустить платформу.

sed -i 's|USE_AUTHORIZATION=true|USE_AUTHORIZATION=false|g' run.sh

Смотрите также

Установка платформы

Для запуска платформы выполните следующие шаги:

  1. Обязательный шаг. Выполните следующую команду с правами суперпользователя, которая создает необходимые папки в /docker-volume:
    sudo v2/prepare-folders.sh

  2. Обязательный шаг. Выполните команду, которая задает конфигурацию запуска:
    v2/prepare-config.sh
    Если никакие параметры изменять не нужно и достаточно тех, что указаны по умолчанию - запустите скрипт без параметров
    Данная команда может выполняться со следующими параметрами:

    • --with-seq <true | false> – запускает платформу с системой логирования Seq. Значение по умолчанию: false.

    • --with-vitalk <true | false> – определяет, будут ли запущены компоненты ViTalk. Значение по умолчанию: false.

    • --policy <true | false> – определяет, будет ли включен режим повышенной безопасности. Значение по умолчанию: false.

    • --remote-viqube <true | false> – запускает ViQube в режиме кластера. Значение по умолчанию: false.

    • --remote-sf <true | false> – запускает Smart Forms на другом сервере. Значение по умолчанию: false.

  3. Опционально. Выполните следующую команду, чтобы задать тэги для кастомных образов:
    v2/prepare-env.sh
    Вы можете использовать данную команду, чтобы задать конкретные версии определенным компонентам.
    Список доступных параметров, которые можно использовать с данной командой:

    • -qt <TAG> – Тэг для образа ViQube. Например: -qt release/viqube:2.30

    • -at <TAG> – Тэг для образа ViQube-Admin. Например: -at release/viqube-admin:2.30

    • -pt <TAG> – Тэг для образа Proxy. Например: -pt release/proxy:2.30

    • -st <TAG> – Тэг для образа SSBI. Например: -st release/ssbi:2.30

    • -ct <TAG> – Тэг для образа SmartForms App. Например: -ct release/smart-forms-app:2.30

    • -mt <TAG> – Тэг для образа SmartForms DB. Например: -mt release/smart-forms-db:2.30

    • -vla <TAG> – Тэг для образа ViLoader Application. Например: -vla release/viloader-app:2.30

    • -vld <TAG> – Тэг для образа ViLoader Database. Например: -vld release/viloader-db:2.30

    • -dt <TAG> – Тэг для компонентов Dashboard Server. Например: -dt release/all:2.30

    • -idt <TAG> – Тэг для образа Identity Server. Например: -idt release/identity-server:2.30

    • -vct <TAG> – Тэг для образа ViTalk-Core. Например: -vct release/vitalk-core:2.30

    • -vlt <TAG> – Тэг для образа ViTalk-Client. Например: -vlt release/vitalk-client:2.30

    • -rt <TAG> – Тэг для образа Regular-Reporting. Например: -rt release/regular-reporting:2.30

    • -kt <TAG> - Тэг для образа Kerberos-Auth-Server. Например: -kt release/kerberos-auth-server:2.30

    • -mdt <TAG> – Тэг для образа MongoDB. Например: -mdt release/mongo-db:2.30

    • -mgt <TAG> – Тэг для образа Migration-Service. Например: -mgt release/migration-service:2.30

    • -mlt <TAG> – Тэг для образа Mail-Service. Например: -mlt release/mail-service:2.30

    • -pst <TAG> – Тэг для образа Python-Script-Service. Например: -pst release/python-script-service:2.30

    • -ptt <TAG> – Тэг для образа Promtail. Например: -ptt release/promtail:2.30

    • -pht <TAG> – Тэг для образа Prometheus. Например: -pht release/prometheus:2.30

    • -lt <TAG> – Тэг для образа Loki. Например: -lt release/loki:2.30

    • -gt <TAG> – Тэг для образа Grafana. Например: -gt release/grafana:2.30

  4. Обязательный шаг. Выполните следующую команду для получения идентификатора оборудования (hardware ID):
    v3/prepare-config.sh
    Скопируйте полученный идентификатор и отправьте его в Visiology. Идентификатор будет выглядеть примерно так:
    HARDWARE_ID: ab7a6a1604ce10ea84a06099c3a90b20d3fb383d68ccc549a324a2b63cd023c7

    Компания Visiology вышлет вам ключ лицензии.

  5. Обязательный шаг. Введите команду v3/prepare-config.sh с флагом -l и добавьте после него полученный ключ. Например:

    v3/prepare-config.sh -l khu67gyiTrcyr3WyrexU5fi76Bvgpi78H/p98jPomp0kpoi9hj76gi76 fvtur4dsy543/sxutrcu65vUoiy6vbo87bPiubNp98jo8jihp8i7gi7Ytd534wsaywr3zs6y453s86u5 fcIo76luybLip78hp98j09J0

  6. Опционально. Выполните следующую команду, чтобы задать тэги для кастомных образов:
    v3/prepare-env.sh

    Вы можете использовать данную команду, чтобы задать конкретные версии определенным компонентам.

    Список доступных параметров, которые можно использовать с данной командой:

    • -pt <TAG> – Тэг для образа Proxy. Например: -pt release/proxy-3:3.1

    • -st <TAG> – Тэг для образа Dashboard Service. Например: -st release/dashboard-service-3:3.1

    • -vt <TAG> – Тэг для образа Dashboard Viewer. Например: -vt release/dashboard-viewer-3:3.1

    • -dt <TAG> – Тэг для образа Visiology Designer. Например: -dt release/visiology-designer:3.1

    • -ft <TAG> – Тэг для образа Formula Engine. Например: -ft release/formula-engine:3.1

    • -mt <TAG> – Тэг для образа Data Management Service. Например: -mt release/data-management-service:3.1

    • -kt <TAG> – Тэг для образа KeyCloak. Например: -kt release/keycloak:3.1

    • -ot <TAG> – Тэг для образа Mongo. Например: -ot release/mongo:3.1

    • -gt <TAG> – Тэг для образа Postgres. Например: -gt release/postgres:3.1

    • -ct <TAG> – Тэг для образа ClickHouse. Например: -ct release/clickhouse-server:3.1

    • -jt <TAG> – Тэг для образа JDBC Bridge. Например: -jt release/jdbc-bridge:3.1

    • -nt <TAG> – Тэг для образа Minio. Например: -nt release/minio:3.1

    • -bt <TAG> – Тэг для образа Backup. Например: -bt release/backup-service:3.1

  7. Запустите скрипт run.sh с указанием IP-адреса, где <IP> - IP-адрес или домен вашего сервера:
    ./run.sh -p <IP>
    Данная команда может использоваться со следующими параметрами:

    • -p | --platform-ip <IP> – адрес сервера. Значение параметра может быть как IP-адресом, так и доменным именем сервера с установленной платформой. Например: --platform-ip <127.0.0.1>.

    • --https <true | false> – определяет, используется ли HTTPS. Значение по умолчанию: false. Обратите внимание, что для работы платформы по HTTPS, необходимо пройти шаги конфигурирования в разделе Настройка HTTPS. Одно лишь указание этого флага приведет к недоступности платформы и по HTTP, и по HTTPS.

    • --start all – запускает обе версии платформы (значение по умолчанию).

    • --stop – останавливает платформу.

    • --restart – перезапускает платформу.

    • -d | --debug – запускает платформу в режиме отладки.
      Данный скрипт будет использовать параметры запуска, заданные с помощью команд v2/prepare-config.sh , v2/prepare-env.sh , v3/prepare-config.sh и v3/prepare-env.sh.

  8. Подождите, пока произойдет загрузка.

  9. Войдите в систему:
    Для версии 2: введите в адресной строке браузера IP-адрес или домен вашего сервера. Например, http://192.168.45.207
    Для версии 3: введите в адресной строке браузера следующий URL: <IP>/v3 , где <IP> – IP-адрес или домен вашего сервера.

  10. Для авторизации введите свой логин и пароль.

Смотрите также

Установка платформы v. 2.30
Установка платформы v. 3.1

Нужна дополнительная помощь?

Свяжитесь с технической поддержкой.