Environment параметры для конфигурации находятся в файле docker-compose.yml

Возможно выполнить конфигурацию сервисов:

• Manager
• Dashboard
• Gateway
• Logstash
• Renderer
• Notifications
• File-storage

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

Manager

Лицензия

• POLYMATICA_CORE_LICENSE_FILE_PATH - путь к файлу лицензии
  По умолчанию = /etc/polymatica/platform/manager/license.key
• POLYMATICA_CORE_LICENSE_UTIL_PATH - путь к утилите, которая проверяет лицензия
  По умолчанию = /usr/bin/polymatica-license
• POLYMATICA_CORE_LICENSE_STRING - параметр для указания лицензии в обход файла лицензии (указание ключа лицензии напрямую)

Настройки хоста

• POLYMATICA_CORE_HTTP_MAX_MULTIPART_BODY_SIZE - макс размер тела запроса в МБайтах
  По умолчанию = 2048
• POLYMATICA_CORE_HTTP_MAX_HEADER_SIZE - макс размер header'а в МБайтах
  По умолчанию = 1
• POLYMATICA_CORE_HTTP_READ_TIMEOUT - таймаут на чтение в секундах
  По умолчанию = 600
• POLYMATICA_CORE_HTTP_WRITE_TIMEOUT - таймаут на запись в секундах
  По умолчанию = 600

Настройки сервиса

• POLYMATICA_CORE_SESSION_EXPIRE_SECONDS - срок жизни токена
  По умолчанию = 1800
• POLYMATICA_CORE_CACHE_TYPE - тип базы данных для работы с датасетами
  По умолчанию = sqlite
  Возможные варианты:
  • mongo
  • clickhouse
  • sqlite
  • postgres
  • mysql
  • questdb
  • vertica
  • mssql
• POLYMATICA_CORE_CACHE_DSN - dsn базы данных для работы с датасетами
  По умолчанию = dataset.db
• POLYMATICA_CORE_APPLICATION_MODE_BETA - Включение бета режима
  По умолчанию = false

Настройка аутентификации

• POLYMATICA_CORE_DEFAULT_AUTH_METHOD - Метод аутентификации по умолчанию
  Доступные значения:
  • api
  • ldap
  • openIDConnect
  • custom_client_rec

API

Параметры настройки стандартной формы аутентификации по логину и паролю:

• POLYMATICA_CORE_AUTH_METHOD_API_ACTIVE
  Тип - булево
  Пример - «POLYMATICA_CORE_AUTH_METHOD_API_ACTIVE = true»

AD/LDAP

Параметры для настройки AD/LDAP аутентификации:

• POLYMATICA_CORE_AUTH_METHOD_LDAP_ACTIVE
  
• POLYMATICA_CORE_ACTIVE_DIRECTORY_SERVER
• POLYMATICA_CORE_ACTIVE_DIRECTORY_PORT
• POLYMATICA_CORE_ACTIVE_DIRECTORY_BASE_DN - Доменное имя, которое ваше приложение будет использовать для привязки к серверу AD

OpenID Connect

Параметры настройки провайдера OpenID Connect:

• POLYMATICA_CORE_OIDC_PROVIDER - кастомный провайдер для аутентификации (если не указан, то используется механизм "по умолчанию")
• POLYMATICA_CORE_AUTH_METHOD_OIDC_ACTIVE
  Тип - булево
  Пример - «POLYMATICA_CORE_AUTH_METHOD_OIDC_ACTIVE = true».
  
• POLYMATICA_CORE_OIDC_PROVIDER_ISSUER
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_ISSUER = { адрес keycloak провайдера OIDC: http://{keycloakhost}:{keycloakport}/auth/realms/{realm} }, пример: http://localhost:8080/realms/master».
  
• POLYMATICA_CORE_OIDC_PROVIDER_REDIRECT_URL
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_REDIRECT_URL = { адрес Polymatica: http://{polymatica-base-url}/auth }».
  
• POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_ID
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_ID = { OIDC client_id }, настраивается в провайдере».
  
• POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_SECRET
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_CLIENT_SECRET = { OIDC client_secret }, настраивается в провайдере».
  
• POLYMATICA_CORE_OIDC_PROVIDER_SCOPE
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_SCOPE = "openid email profile"».
  
• POLYMATICA_CORE_OIDC_PROVIDER_NAME
  Тип -строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_NAME = { произвольное имя провайдера }, пример: "keycloak"».
  
• POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_PREFERRED_USERNAME_KEY
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_PREFERRED_USERNAME_KEY = "preferred_username" или иной, в зависимости от настроек провайдера OIDC. Ожидаемое значение - ключ claims, по которому будет определен username пользователя в системе Polymatica».
  
• POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_EMAIL_KEY
  Тип - строка
  Пример - «POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_EMAIL_KEY = "email" или иное, в зависимости от настроек провайдера OIDC. Ожидаемое значение - ключ claims, по которому будет определен email пользователя в системе Polymatica».

Custom

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

• POLYMATICA_CORE_AUTH_METHOD_CUSTOM_CLIENT_REC_ACTIVE
  Тип - булево
• POLYMATICA_CORE_CUSTOM_AUTH_CLIENT_REC_HEADER_KEY
  Тип - строка
  

Настройка логирования

• POLYMATICA_CORE_SYSTEM_LOG_FILE - файл записи системных логов сервиса
  По умолчанию = /tmp/POLYMATICA_SYSTEM_MANAGER.log
• POLYMATICA_CORE_LOG_LEVEL - уровень логирования
  По умолчанию = 5
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_CORE_LOG_WITH_RESPONSE - логирование ответа
  По умолчанию = false
• POLYMATICA_CORE_LOG_FILE - файл для записи сервисных логов
  По умолчанию = /tmp/POLYMATICA_MANAGER.log

Настройка Redis

• POLYMATICA_CORE_REDIS_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_CORE_REDIS_PORT
  По умолчанию = 6379
• POLYMATICA_CORE_REDIS_USERNAME
• POLYMATICA_CORE_REDIS_PASSWORD
• POLYMATICA_CORE_REDIS_DB
  По умолчанию = 0
• POLYMATICA_CORE_REDIS_TOKEN_DB
  По умолчанию = 1

Настройка Rabbit MQ

• POLYMATICA_CORE_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_CORE_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_CORE_RABBIT_MQ_VHOST
• POLYMATICA_CORE_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_CORE_RABBIT_MQ_PASSWORD
  По умолчанию = guest

Настройка соединений с базой данных

• POLYMATICA_CORE_STRUCT_DB_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_CORE_STRUCT_DB_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать.
  По умолчанию = 100
• POLYMATICA_CORE_CACHE_DB_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_CORE_CACHE_DB_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать.
  По умолчанию = 100

SSL сертификат для Clickhouse

Для указания пути к сертификату необходимо разместить сертификат в папке на сервере, например: /srv/cert/ и, в случае с docker, смонтировать его в docker-compose.yml для контейнера manager-backend

	volumes:
    	  - /srv/polymatica/cert/:/etc/polymatica/platform/manager/cert/

Dashboard

Настройка логирования

• POLYMATICA_DASHBOARD_LOG_LVL - уровень логирования
  По умолчанию = 4
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_DASHBOARD_LOG_PATH - файл для записи сервисных логов
  По умолчанию = /tmp/POLYMATICA_DASHBOARD.log
• POLYMATICA_DASHBOARD_LOG_WITH_RESPONSE - логирование ответа
  По умолчанию = false
• POLYMATICA_DASHBOARD_LOG_SYSTEM_LOG_FILE - файл для записи системных логов сервиса
  По умолчанию = /tmp/POLYMATICA_SYSTEM_DASHBOARD.log

Настройка подключения к OSM серверу

• POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_BASE_URL - Адрес OSM сервера 
  Тип - строка
  Пример - POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_BASE_URL=https://tile.openstreetmap.org/
  
• POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_SKIP_INSECURE - Пропускать незащищенное соединение http
  Тип - булево
  Пример - POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_SKIP_INSECURE=true
  
• POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_URL_POSTFIX - Расширение тайлов
  Тип - строка
  Пример - POLYMATICA_DASHBOARD_MAPS_TILE_SERVER_URL_POSTFIX=.png

Настройка Redis

• POLYMATICA_DASHBOARD_REDIS_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_DASHBOARD_REDIS_PORT
  По умолчанию = 6379
• POLYMATICA_DASHBOARD_REDIS_PASSWORD
• POLYMATICA_DASHBOARD_REDIS_USERNAME
• POLYMATICA_DASHBOARD_REDIS_DB
  По умолчанию = 2

Настройка Rabbit MQ

• POLYMATICA_DASHBOARD_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_DASHBOARD_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_DASHBOARD_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_DASHBOARD_RABBIT_MQ_PASSWORD
  По умолчанию = guest
• POLYMATICA_DASHBOARD_RABBIT_MQ_VHOST

Настройка соединений с базой данных

• POLYMATICA_DASHBOARD_DATABASE_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_DASHBOARD_DATABASE_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать
  По умолчанию = 100

Gateway

Сервис служит роутером запросов

Настройки хоста

• POLYMATICA_GATEWAY_HTTP_BODY_LIMIT - макс размер тела запроса в Байтах
  По умолчанию = 262144000
• POLYMATICA_GATEWAY_HTTP_READ_TIMEOUT - таймаут на чтение в наносекундах 
  По умолчанию = 600000000000
• POLYMATICA_GATEWAY_HTTP_WRITE_TIMEOUT- таймаут на запись в наносекундах 
  По умолчанию = 600000000000

Настройка логирования

• POLYMATICA_GATEWAY_LOG_LVL - уровень логирования
  По умолчанию = 5
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_GATEWAY_LOG_PATH - файл для записи сервисных логов
  По умолчанию = /tmp/platform/gateway.log

Настройка Rabbit MQ

• POLYMATICA_GATEWAY_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_GATEWAY_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_GATEWAY_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_GATEWAY_RABBIT_MQ_PASSWORD
  По умолчанию = guest
• POLYMATICA_GATEWAY_RABBIT_MQ_VHOST

Logstash

Сервис используется для сбора логов событий

Настройки хоста

• POLYMATICA_LOGSTASH_HTTP_READ_TIMEOUT - таймаут на чтение
  По умолчанию = 0 (неограниченно)
• POLYMATICA_LOGSTASH_HTTP_WRITE_TIMEOUT - таймаут на запись
  По умолчанию = 0 (неограниченно)
• POLYMATICA_LOGSTASH_HTTP_MAX_MULTIPART_BODY_SIZE - макс размер тела запроса в МБайтах
  По умолчанию = 0 (неограниченно)
• POLYMATICA_LOGSTASH_HTTP_MAX_HEADER_SIZE - макс размер header`а запроса в МБайтах
  По умолчанию = 0 (неограниченно)

Настройки сервиса

• POLYMATICA_LOGSTASH_REPOSITORY_PATH - путь до папки хранения логов
  По умолчанию = /usr/share/polymatica/platform/logstash/

Настройка логирования

• POLYMATICA_LOGSTASH_LOG_LVL - уровень логирования
  По умолчанию = 5
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_LOGSTASH_LOG_PATH - файл для записи сервисных логов
  По умолчанию = /tmp/platform/logstash.log

Настройка Redis

• POLYMATICA_LOGSTASH_REDIS_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_LOGSTASH_REDIS_PORT
  По умолчанию = 6379
• POLYMATICA_LOGSTASH_REDIS_USERNAME
• POLYMATICA_LOGSTASH_REDIS_PASSWORD
• POLYMATICA_LOGSTASH_REDIS_DB
  По умолчанию = 3

Настройка Rabbit MQ

• POLYMATICA_LOGSTASH_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_LOGSTASH_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_LOGSTASH_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_LOGSTASH_RABBIT_MQ_PASSWORD
  По умолчанию = guest
• POLYMATICA_LOGSTASH_RABBIT_MQ_VHOST

Настройка соединений с базой данных

• POLYMATICA_LOGSTASH_DATABASE_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_LOGSTASH_DATABASE_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать
  По умолчанию = 100

Renderer

Сервис используется для экспорта в изображение

Настройка логирования chrome driver

• POLYMATICA_RENDERER_LOG_CHROME_DRIVER_LOG_PATH
  По умолчанию = "/tmp/POLYMATICA_RENDERER_CHROMEDRIVER.log"
• POLYMATICA_RENDERER_LOG_CHROME_DRIVER_LOG_LEVEL
  По умолчанию = "ALL"

Настройка сервиса

• 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 - уровень логирования
  По умолчанию = 5
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_NOTIFICATIONS_LOG_PATH - файл для записи сервисных логов
  По умолчанию = "/tmp/platform/notifications.log"

Настройка Rabbit MQ

• POLYMATICA_NOTIFICATIONS_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_NOTIFICATIONS_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_NOTIFICATIONS_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_NOTIFICATIONS_RABBIT_MQ_PASSWORD
  По умолчанию = guest
• POLYMATICA_NOTIFICATIONS_RABBIT_MQ_VHOST

Настройка соединений с базой данных

• POLYMATICA_NOTIFICATIONS_DATABASE_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_NOTIFICATIONS_DATABASE_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать
  По умолчанию = 100

File-storage

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

Настройка логирования

• POLYMATICA_STORAGE_LOG_LEVEL - уровень логирования
  По умолчанию = 5
  Доступные варианты:
  • 0 - Panic level
  • 1 - Fatal level
  • 2 - Error level
  • 3 - Warning level
  • 4 - Info level
  • 5 - Debug level
  • 6 - Trace level
• POLYMATICA_STORAGE_LOG_PATH - файл для записи сервисных логов
  По умолчанию = "/tmp/platform/storage.log
• POLYMATICA_STORAGE_STORAGE_ROOT_PATH
  По умолчанию = ""
• POLYMATICA_STORAGE_STORAGE_ASSETS_STATIC_PATH - путь для хранения статичных файлов
  По умолчанию = "/usr/share/polymatica/platform/file-storage/assets/"

Настройка Rabbit MQ

• POLYMATICA_STORAGE_RABBIT_MQ_HOST
  По умолчанию = 127.0.0.1
• POLYMATICA_STORAGE_RABBIT_MQ_PORT
  По умолчанию = 5672
• POLYMATICA_STORAGE_RABBIT_MQ_USER
  По умолчанию = guest
• POLYMATICA_STORAGE_RABBIT_MQ_PASSWORD
  По умолчанию = guest
• POLYMATICA_STORAGE_RABBIT_MQ_VHOST

Настройка соединений с базой данных

• POLYMATICA_STORAGE_DATABASE_MAX_OPENED_CONNECTIONS – максимальное количество соединений с базой, доступных для открытия, если другие соединения заняты.
  По умолчанию = 100
• POLYMATICA_STORAGE_DATABASE_MAX_IDLE_CONNECTIONS – максимальное количество открытых соединений, ожидающих в пуле, которые можно переиспользовать
  По умолчанию = 100