Установка и запуск

5 минутное чтение

Состав и содержание дистрибутива

Дистрибутив содержит:

«modusbi» — исполняемый файл, являющийся сервером для Аналитического портала. Расширение файла зависит от платформы (операционной системы):
- «Windows» — исполняемый файл «modusbi.exe»;
- «Linux» — исполняемый файл «modusbi»;
«modusbi.json» — файл настройки, который можно использовать для быстрой первичной настройки. Позволяет не изменяя метаданные запустить портал с любыми предварительными настройками;
«modusbi-init.mbm» — файл инициализации базы данных Аналитического портала;
«modusbi.mbv» — триальный ключ, позволяющий работать с Аналитическим порталом 30 дней.
«update/modusbi.mbu» — файл обновления базы данных Аналитического портала до последней версии.

Дополнительно, в дистрибутиве для «Windows» содержатся:

«modusbi.bat» — файл для запуска Аналитического портала как приложения;
«service-create.bat» — файл создания сервиса Аналитического портала;
«service-delete.bat» — файл удаления сервиса Аналитического портала.

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

Подготовка перед установкой АП

Перед установкой аналитического портала необходимо развернуть базу данных под управлением СУБД PostgrеSQL для хранения настроек АП.

Для установки СУБД Postger SQL обратитесь к официальному руководству:

https://www.postgresql.org/download/

https://www.postgresql.org/docs/10/runtime-config.html_

После установки СУБД, создайте новую базу данных, например «modusbi»:

CREATE DATABASE "modusbi"

Установка АП для Windows

Необходимо запустить файл дистрибутива «ModusBI-xx.xx.xx.exe», где «хх.хх.хх» - номер устанавливаемого релиза. В появившемся окне нажать кнопку «Далее» и указать путь к каталогу, куда будет установлен аналитический портала, затем подождать пока файлы распакуются и завершить установку.

Запуск портала в режиме службы

Для запуска портала в режиме службы необходимо запустить файл «service-create.bat», для удаления «service-delete.bat». Оба файла находятся в каталоге, куда была выполнена установка.

Установка АП из .deb пакета

Необходимо скопировать на диск файл установки с расширением «.deb» и выполнить команду:

sudo dpkg -i ИмяФайла.deb

По умолчанию программа будет установлена в каталог «/opt/modusbi».

Запуск и остановка службы выполняется командами:

systemctl start/stop modusbi

Важно! У пользователя, под которым работает служба аналитического портала, должен быть создан домашний каталог.

Установка АП из .rpm пакета

Необходимо скопировать на диск файл установки с расширением «.rpm» и выполнить команду:

sudo rpm -i ИмяФайла.rpm

По умолчанию программа будет установлена в каталог «/opt/modusbi».

Запуск и остановка службы выполняется командами:

systemctl start/stop modusbi

Важно! У пользователя, под которым работает служба аналитического портала, должен быть создан домашний каталог.

Первоначальная настройка аналитического портала

Настройка «modusbi.json»

После установки необходимо перейти в каталог, куда были распакованы файлы и в первую очередь необходимо отредактировать файл «modusbi.json». Далее требуется несколько действий, описанных ниже.

Настроить параметры подключения к СУБД PostgreSQL в блоке «metadata».

{
  "metadata": { 
    "driver": "postgres", 
    "datasource": "postgres://<ПОЛЬЗОВАТЕЛЬ_БД>:<ПАРОЛЬ_БД>@<IP-АДРЕС_PG>:<ПОРТ_PG>/<ИМЯ_БД>?application_name=modusbi&sslmode=disable", 
    "maxopenconns": <максимальное количество одновременно открытых соединений, не больше значения max_connections в PostgreSQL>, 
    "maxidleconns": <максимальное количество открытых (ожидающих) соединений в пуле>, 
    "maxlifetime": <максимальное время жизни соединения в пуле, секунды> 
    }
}

Например, СУБД установлена на том же сервере, что и аналитический портал, и подключение к ней выполняется стандартный порт 5432. Была создана база данных «modusbi» и был создан пользователь «postgres», ему задан пароль «my_pass». Тогда строка подключения будет выглядеть по умолчанию следующим образом:

{
  "metadata": { 
    "driver": "postgres", 
    "datasource": "postgres://postgres:my_pass@127.0.0.1:5432/modus?application_name=modusbi&sslmode=disable", 
    "maxopenconns": 100, 
    "maxidleconns" : 20, 
    "maxlifetime": 3600 
    }
}

Настроить хост сервера в блоке «server». По умолчанию сервер прослушивает порт 3000 только на локальном хосте 127.0.0.1, если предполагается переход в аналитический портал с других устройств, необходимо установить в качестве значение "host": "0.0.0.0"

Например, предполагается вход на аналитический портал с других устройств на порт 3000. Тогда блок «server» будет иметь следующие настройки:

{
...
  "server": {
    "host": "0.0.0.0",
    "port": 3000
  }
...
}

Настроить параметры подключения к серверу Бэкэнда. К этому адресу будут обращаться клиентские соединения из браузера при работе с аналитическим порталом. В общем случае обращение должно выполняться к устройству, на котором запущен аналитический портал. По умолчанию сервер обращается к локальному хосту 127.0.0.1 на порт 3000. Для работы с других устройств необходимо указать значения и параметры подключения к внутреннему или внешнему адресу сервера, с указанием протокола, по которому будет проходить соединение.

Например, предполагается вход на аналитический портал для пользователей с других устройств, находящихся в локальной сети. Аналитический портал развернут по адресу 192.168.0.3, сервер слушает порт 3000. Тогда блок «backend» будет иметь следующие настройки:

{
...
  "backend": {
    "protocol": "http",
    "host": "192.168.0.3",
    "port": 3000,
    "base_url": "/v1/api/"
  }
...
}

Подробней о настройке конфигурации аналитического портала читать здесь.

Запуск инициализации Базы данных

После настройки портала необходимо выполнить его первичную инициализацию. Для этого необходимо в командной строке в режиме администратор или в среде bash перейти в каталог портала и запустить исполняемый файл «modusbi.exe» (в Linux системах «modusbi») с параметром -init.

Например, Аналитический портал установлен в каталог «C:\Program Files\ModusBI». Тогда команда инициализации будет иметь вид:

cd "Program Files\ModusBI"
"modusbi.exe" -init

После выполнения команды начнется создание структуры метаданных в указанной в настройках информационной базе. Результатом выполнения команды должно стать информационное сообщение «созданы метаданные в ‘<БД PostgreSQL>’, необходимо перезапустить сервер». Детальная информация о процессе инициализации будет записана в файл журнала «modusbi.log».

Важно! Инициализация базы данных портала выполняется только один раз при первом запуске.

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

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

Проверьте работоспособность портала

Для проверки перейдите по адресу аналитического портала в своем браузере. На новом портале доступна учетная запись:

имя: «admin»;
пароль: «admin».

Поле первого входа, рекомендуется поменять стандартные параметры подключения.

Портал готов к работе.