Общая информация

1. Изменение базовых настроек портала выполняются из WEB-клиента Аналитического портала и в файле настроек «modusbi.json», расположенного в каталоге исполняемого файла Аналитического портала.
2. Настройки Аналитического портала, редактируемые из WEB-клиента сохраняются и считываются в базе метаданных. Подробнее см. таблицу с описанием настроек «Таблица. Настройки портала».
3. Настройки в файле редактируются вручную, изменения в WEB-клиенте не изменяют файл настроек.
4. Часть настроек доступных из WEB-клиента дублируется настройками из файла настроек, подробнее см. подраздел «Файл настроек «modusbi.json»». Обратите внимание! Настройки из файла имеют более высокий приоритет.
5. Если есть необходимость настраивать смежные настройки из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство).

Настройки из WEB-клиента

Используя WEB-клиент, перейдите в меню «Администрирование» (вкладка «Настройки») и выберите раздел «Настройки портала».

Откроется окно с настройками, описание представлено в таблице ниже.

Доступные из WEB-клиента настройки:

• «Скачать Frontend» — кнопка позволяет сформировать полноценный архив с повторением структуры папок (частей URL) и с файлами фронтенда;
• «Обновить Frontend» — кнопка позволяет загрузить файл обновления Frontend. Выберите файл в диалоге и укажите под каким именем будет загружен дистрибутив. Под указанным именем в дальнейшем дистрибутив будет доступен для выбора в выпадающем списке настроек «Версия Frontend портала»;
• «Импортировать обновление» — кнопка позволяет загрузить файл обновления. Выберите файл в диалоге;
• «Загрузить лицензию» — кнопка позволяет загрузить лицензии для обновления лицензии портала. Файл лицензии содержит настройки и лицензионные ограничения для конкретной реализации портала по количеству пользователей, сроку работы, доступности функционала отдельных модулей (формы ввода данных, RLS, коррекции данных и т.д.);
• «Сменить мастер-пароли» —  кнопка смены мастер-паролей позволяет заменить пароли к встроенным учетным записям. Новые пароли будут записаны в файлы developer.secret и system.secret в каталоге где размещён исполняемый файл портала.

Файл настроек «modusbi.json»

Файл настроек «modusbi.json» находится в каталоге размещения исполняемого файла Аналитического портала.

{
 "metadata": {
 "driver": "postgres",
 "datasource": "postgres://pg_user:pg_passw@pg_server:5432/BASE_NAME?application_name=modusbi&sslmode=disable",
 "maxopenconns": 100,
 "maxidleconns" : 20,
 "maxlifetime": 3600
 },
 "server": {
 "host": "192.168.0.1",
 "port": 3000,
 "debug": "enabled"
 },
 "backend": {
 "protocol": "http",
 "host": "192.168.0.1",
 "port": 3000,
 "base_url": "/v1/api/"
 },
 "frontend": {
 "base_url": "/"
 },
 "form": {
 "base_url": "/fvd"
 },
 "update": {
 "path": "update"
 },
 "backup": {
 "path": "backup"
 },
 "Databases": {
 "Vertica" : {
 "InMemoryResultRowLimit": 1000
 }
 },
 "CollLogger": "enabled",
 "auth": {
 "log": {
 "to_file": true,
 "to_metadata": false
 }
 }
} 

Назначение параметров файла приведено в таблице ниже в формате: «ключ — тип — описание» (key — type — description).

Шифрование файла «modusbi.json»

Для шифрования определенных значений в конфигурационных файлах используется специальная утилита encryption-settings.

Шифровать имеет смысл файлы с доступными для редактирования вручную настройками. Например, файл конфигурации Аналитического портала — «modusbi.json».

1. Для определения необходимых полей файла конфигурации создайте файл с расширением *.jsonpath и укажите поля для шифрования.

   {
     "secrets": [
       "$.metadata.datasource"
     ]
   }

2. Генерация ключей. 

   Запустите утилиту с параметром для генерации ключей, выполнив команду:

   <утилита> -g

   После выполнения ключи создаются в текущем каталоге:

   • public_key.pem — публичный ключ;
   • private_key.pem — приватный ключ.
3. Шифрование настроек. 

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

   <утилита> -e -settings <путь к файлу конфигурации> -key <путь к файлу с публичным ключом> -fields <путь к файлу со списком полей для шифрования>

   При этом:

   • <путь к файлу конфигурации> – укажите путь к файлу, который нужно зашифровать (например, settings.json);
   • <путь к файлу с публичным ключом> – укажите путь к файлу с публичным ключом, который был сгенерирован;
   • <путь к файлу со списком полей для шифрования> – укажите путь к вашему файлу *.jsonpath.

   После шифрования указанные поля будут иметь вид:

     "metadata": {
       "datasource": {
         "encrypted": true,
         "value": "XUN8ygFGdRl4FtWiVDhD+ZELfPkHY+EjpDkWEDtjItzTOdGqpCFP36irQiHCDPy2a/a4MdzN9yTlDBBRntRmQG3Pg6P3y5wJMGarQC9pfu8LALp8x+HQgh5ggAffZZNKfRofoqYES9YnFuiB9kPk31BkMAAU4WLNV+NZYpFx8ZYbuaYF0AAOvf/FYOHzr/Qh4109xITCEAODS5ph0cRWQRoQI/jScGn/TrM6XfzjTw+joC38uKG/zQMwAfZBQ/qSz8Aa5ybEIlNcSOuKf6AdoivaTtPepkweF2F/8csgXdAjC1iNySsDMeOyKg7OlackN0kXQGDKXW/3VNA8iKf7ufSBB/eD"
       }

После выполнения в файле конфигурации зашифровываются указанные поля.

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

Убедитесь, что приватный ключ и файл с зашифрованными настройками находятся рядом с исполняемым файлом Аналитического портала или Агента ETL.

Соответствие настроек WEB-клиента и файла настроек

Некоторые настройки можно редактировать как в интерфейсе WEB-клиента так и в файле настроек «modusbi.json»: