Общие сведения

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

Информация о параметрах размещена по разделам соответственно сервисам, к которым эти параметры относятся. Названия сервисов в заголовках разделов указаны так, как они используются в приложении.

Для приложения, развернутого с использованием Docker, название каждого параметра включает в себя префикс, который соответствует использующему параметр сервису. Например, в названии параметра POLYMATICA_CORE_CACHE_TYPE префикс – POLYMATICA_CORE.

Для приложения, развернутого с использованием пакетов, префиксы отсутствуют, а параметры могут быть составными, например, параметры LOG_LVL, LOG_PATH указываются как

"log": {
        "lvl": 4,
        "path": "/var/log/polymatica/platform/dashboards.log",
}

Параметры указываются:

  • для приложения, развернутого с использованием Docker, в соответствующем приложению файле docker-compose.yml, в соответствующих сервисам блоках;
  • для приложения, развернутого с использованием пакетов, в файлах config.json, которые находятся в соответствующих сервисам директориях /etc/polymatica/platform/service/{название_сервиса}/. Для файлов config.json сервисов manager и dashboard выделены отдельные директории /etc/polymatica/platform/manager/ и /etc/polymatica/platform/dashboards/.

Пути размещения, используемые в параметрах, находятся:

  • для приложения, развернутого с использованием Docker, внутри контейнеров соответствующих сервисов, например, параметр POLYMATICA_CORE_LICENSE_FILE_PATH = /etc/polymatica/platform/manager/license.key указывает путь внутри контейнера manager;
  • для приложения, развернутого с использованием пакетов, в окружающей операционной системе.

После изменения значений параметров:

  • для приложения, развернутого с использованием Docker, выполните:

    docker compose up -d || docker-compose up -d

  • для приложения, развернутого с использованием пакетов, выполните:

    systemctl restart polymatica-platform-manager

Поиск

Чтобы найти все упоминания параметра в разделах этого руководства, воспользуйтесь поиском:

Сервис manager

Сервис обеспечивает работу модуля приложения Manager.

Параметр

Назначение

Принимаемое значение

Значение при установке

Значение по умолчанию

Параметры сервиса

POLYMATICA_CORE_CACHE_TYPE

База данных для работы с датасетами.

Предоставляемые базы:

  • clickhouse;
  • postgres
  • clickhouse;
  • postgres


postgres–
POLYMATICA_CORE_CACHE_DSN
DSN базы данных для работы с датасетамиСтрокаpostgres://polymatica:polymatica-secret@postgresql/platform_manager_cache–
POLYMATICA_CORE_APPLICATION_MODE_BETA
Включение бета-режимаБулево–false

Параметры аутентификации

POLYMATICA_CORE_EXPIRE_SESSION_EXPIRE_SECONDS
Срок жизни токена аутентификации

Длительность в секундах

–1800
POLYMATICA_CORE_AUTH_DEFAULT_METHOD

Метод аутентификации по умолчанию. Указанный метод должен быть доступен (см. далее методы аутентификации)

Предоставляемые методы:

  • api – стандартная аутентификация (логин/пароль);
  • ldap – аутентификация с использованием службы каталогов;
  • openIDConnect – аутентификация с использованием OIDC;
  • custom_client_rec
  • api;
  • ldap;
  • openIDConnect;
  • custom_client_rec
–api

Метод аутентификации API (стандартная, логин/пароль)

POLYMATICA_CORE_AUTH_METHOD_API_ACTIVE

Доступность метода стандартной аутентификации.

Если все прочие методы аутентификации недоступны, метод стандартной аутентификации доступен независимо от состояния этого параметра

Булево–true

Метод аутентификация AD/LDAP

POLYMATICA_CORE_AUTH_METHOD_LDAP_ACTIVE
Доступность метода аутентификации с использованием службы каталоговБулево–false
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_SERVER
Адрес контроллера доменаСтрока––
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_PORT
Порт контроллера доменаЦелое число–
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_BASE_DN
Домен или организационная единица, где следует искать запись каталогаСтрока––
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_LOGIN_KEY
Атрибут записи каталога, значение которого следует ассоциировать с логином, указанным для аутентификации
  • cn;
  • uid
–uid
Настройки синхронизации групп пользователей с Active Directory
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_CLASS
Класс объекта данных о пользователеСтрокаuser
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_LOGIN_ATTR
Наименование атрибута логина пользователяСтрокаcn
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_MAIL_ATTR
Наименование атрибута email пользователяСтрокаmail
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_FIRSTNAME_ATTR
Наименование атрибута Имя пользователяСтрокаgivenName
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_LASTNAME_ATTR
Наименование атрибута Фамилия пользователяСтрокаsn
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_USER_PATRONYMIC_ATTR
Наименование атрибута Отчество пользователяСтрока- 
POLYMATICA_CORE_AUTH_ACTIVE_DIRECTORY_GROUP_CLASS
Наименование класса Группы пользователяСтрокаgroup

Метод аутентификация OpenID Connect

POLYMATICA_CORE_OIDC_AUTH_METHOD_ACTIVE
Доступность метода аутентификация OIDCБулево–false
POLYMATICA_CORE_OIDC_PROVIDER_ISSUER

Провайдер-поставщик аутентификации

Значение ключа "issuer" в метаданных провайдера––
POLYMATICA_CORE_OIDC_PROVIDER_REDIRECT_URL

Адрес переадресации после аутентификации в провайдере

Строкаhttps://хост/auth/oidc-callback–
POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_ID

Client ID, указываемый в провайдере для приложения

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_SECRET

Client secret, выдаваемый провайдером 

Строка––
POLYMATICA_CORE_CORE_OIDC_PROVIDER_SCOPE

Скоуп, запрашиваемый у провайдера

Строкаopenid email profile–
POLYMATICA_CORE_OIDC_PROVIDER_NAME

Произвольное имя провайдера

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_PREFERRED_USERNAME_KEY

Ключ claims, по которому будет определено значение username пользователя в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_EMAIL_KEY

Ключ claims, по которому будет определено значение email пользователя в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_FIRST_NAME_KEY

Ключ claims, по которому будет определено значение "имя пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_LAST_NAME_KEY

Ключ claims, по которому будет определено значение "фамилия пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_MIDDLE_NAME_KEY

Ключ claims, по которому будет определено значение "отчество пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_INSECURE_OVERRIDE_ISSUER

Не выполнять валидацию issuer_url

Булево–false
POLYMATICA_CORE_OIDC_PROVIDER_ACTUAL_ISSUER

Эндпоинт issuer_url для валидации id_token когда валидация issuer_url не выполняется

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_AUTHORIZE_IAM_URL

Адрес эндпоинта /authorize ЕЦП "Гостех" для получения роли пользователя

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_LOGOUT_URL

Адрес эндпоинта /logout для выхода из сессии OpenID ЕЦП  "Гостех"

Строка--

Метод Custom

POLYMATICA_CORE_INTEGRATION_AUTH_METHOD_CLIENT_REC_ACTIVE

Доступность метода

Булево–false
POLYMATICA_CORE_INTEGRATION_AUTH_CLIENT_REC_HEADER_KEY

Заголовок запроса, содержащий имя пользователя (username) должен приходить на POST-запрос "/auth/custom-client-rec/login"

Строка––

Параметры логирования

POLYMATICA_CORE_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

Целое число

–4
POLYMATICA_CORE_LOG_WITH_RESPONSE

Запись в лог тела ответа

Булево–false

Параметр правила перехода в Polymatica Analytics

POLYMATICA_CORE_INTEGRATION_DETAILING_UNDER_ANONYMOUS

Метод аутентификации в Polymatica Analytics, который будет запрашиваться для сквозной детализации из виджета.

Принимает значения:

  • true – аутентификация в Polymatica Analytics всегда выполняется под временным анонимным пользователем, права анонимного пользователя в Polymatica Analytics определяются группой пользователей shared_resources;

  • false – метод аутентификации в Polymatica Analytics выполняется в зависимости от использованного метода аутентификации в Polymatica Dashboards TN

Булево–false

Параметры датасета

POLYMATICA_CORE_DATASETS_RIGHTS_TO_DATA_FOR_ALL_USERS

Устанавливает глобальное правило ограничения данных по умолчанию при создании датасета.

Принимает значения:

  • allow-all – по умолчанию устанавливается правило «Разрешить всем», аналогично отсутствию параметра;
  • restrict-all – (а также любое значение отличное от allow-all) по умолчанию устанавливается правило «Запретить всем»
Строка–allow-all

Параметры проекта

POLYMATICA_DASHBOARD_SHARING_DISABLED

Блокировка функциональности «Поделиться доступом».

Когда параметр определен со значением true, кнопка «Поделиться» не отображается в проектах.

Обратите внимание!

Существующие ссылки остаются работоспособными. Необходимо вручную закрыть по ним доступ до блокировки

Булево–false


Сервис dashboard

Сервис обеспечивает работу модуля приложения Dashboard.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

POLYMATICA_DASHBOARD_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

POLYMATICA_DASHBOARD_LOG_WITH_RESPONSE

Запись в лог тела ответа

Булево–false

Параметры подключения к OSM-серверу

POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_BASE_URL
Адрес OSM-сервераСтрока–

–

POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_SKIP_INSECURE
Пропускать незащищенное HTTP-соединениеБулево–false
POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_URL_POSTFIX

Формат тайлов

Строка–.png

Сервис gateway

Сервис обеспечивает маршрутизацию запросов между фронтендом и остальными сервисами.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

POLYMATICA_GATEWAY_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

POLYMATICA_GATEWAY_LOG_PATH
Файл для записи логов сервисаСтрока–/tmp/platform/gateway.log
POLYMATICA_GATEWAY_PROXY_DOCUMENTATION
Управление доступом к Swagger-клиентам сервисов (спецификациям API)Булево–false

Сервис logstash

Сервис обеспечивает сбор, хранение и отправку по HTTP логов событий приложения.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

POLYMATICA_LOGSTASH_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Параметры сервиса

POLYMATICA_LOGSTASH_REPOSITORY_PATH

Путь до директории хранения логов

Строка–/usr/share/polymatica/platform/logstash/
POLYMATICA_LOGSTASH_PIPELINE_CONFIG_PATH

Путь до файла конфигурации

Строка–/etc/polymatica/platform/service/logstash/pipeline-config.json

Сервис renderer

Сервис обеспечивает для фронтенда экспорт в изображение.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

POLYMATICA_RENDERER_LOG_CHROME_DRIVER_LOG_LVL

Уровень логирования действий сервиса

Строка

–

ALL

POLYMATICA_RENDERER_LOG_CHROME_DRIVER_LOG_PATH
Файл для записи логов сервисаСтрока–/tmp/POLYMATICA_RENDERER_CHROMEDRIVER.log

Параметры сервиса

POLYMATICA_RENDERER_DRIVER_WEB_DRIVER_POOL_WARM_START

Начальный размер активных соединений

Число

–10
POLYMATICA_RENDERER_DRIVER_WEB_DRIVER_POOL_MAX_IDLE_SIZE

Максимальный размер пула соединений

Число–20
POLYMATICA_RENDERER_DRIVER_RENDER_TIMEOUT_SEC

Таймаут

Длительность
в секундах		–300

Сервис notifications

Сервис обеспечивает для фронтенда работу функциональности «Уведомления».

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

POLYMATICA_NOTIFICATIONS_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Сервис file-storage

Сервис обеспечивает для фронтенда хранение статических файлов (компоненты, изображения, видео).

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования 

POLYMATICA_STORAGE_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Параметры сервиса

POLYMATICA_STORAGE_ASSETS_STATIC_PATH
Путь до директории хранения статичных файловСтрока–/usr/share/polymatica/platform/file-storage/assets/

Сервис data-transformer

Сервис обеспечивает для фронтенда работу расчетных колонок датасета.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования 

POLYMATICA_DATA_TRANSFORMER_LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Параметры Python-скрипта

POLYMATICA_DATA_TRANSFORMER_PY_SCRIPT_PYTHON_PATH
Путь до интерпретатора PythonСтрока–/usr/share/polymatica/platform/data-transformer/python/venv/bin/python

  • Нет меток