Конфигурационные файлы системыLTS

В этой статье

Конфигурационные файлы системы

Некоторые настройки системы можно изменять через конфигурационные файлы или переменные окружения, в зависимости от операционной системы:

Windows — изменения вносятся в конфигурационные файлы, расположенные по умолчанию в каталоге C:\ProgramData\Infomaximum\config\
Примечание: Путь к файлам может отличаться, если система установлена на другой диск или в другой каталог.
Linux — настройки задаются через переменные окружения при запуске Docker-контейнера

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

Пример передачи параметров на Linux:

-e JVM_MAX_MEMORY='4G'

Конфигурационные файлы

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

com.infomaximum.subsystem.frontend.json

Параметр	Переменная окружения	Описание
`"protocol"`	—	Протокол веб-интерфейса — HTTP или HTTPS
`"port"`	—	Порт, на котором будет работать веб-интерфейс
`"ssl_cert_store"`	—	Путь к PFX-файлу с сертификатом и закрытым ключом для работы по протоколу HTTPS. Поддерживаемые форматы: JKS, PKCS#12 Косую черту необходимо экранировать еще одной косой чертой
`"ssl_cert_store_password"`	—	Пароль от PFX-файла Если пароль пустой, укажите `""`
`"trust_store"`	—	Полный путь к файлу хранилища доверенных сертификатов. Поддерживаемые форматы: JKS, PKCS#12
`"trust_store_password"`	—	Пароль хранилища доверенных сертификатов Если пароли хранилища сертификатов и хранилища доверенных сертификатов одинаковые, то это поле можно не заполнять
`"crl"`	—	Полный путь к файлу отозванных сертификатов (необязательное)
`"url"`	`FE_URL`	Адрес сервера Proceset Необходимо указать полностью, с протоколом и портом Используется при создании системой всех ссылок, которые в нее ведут. Например, на основе параметра создаются ссылки в рассылаемых почтовых сообщениях для сброса пароля и приглашения
`"service_mode"`	`FE_SERVICE_MODE`	Включение/выключение сервисного режима По умолчанию выключен. Чтобы включить, укажите `true` Подробнее в разделе Работа с системой
`"service_mode_message"`	`FE_SERVICE_MODE_MESSAGE`	Сообщение, которое отображается у пользователя на странице авторизации при включенном сервисном режиме В сообщении можно использовать язык разметки Markdown
`"session_timeout"`	`FE_SESSION_TIMEOUT`	Время жизни пользовательской сессии По умолчанию период неактивной сессии для каждого пользователя составляет 7 дней Можно указать в часах (`h`) или днях (`d`)
`"support_iframe"`	—	Позволяет встроить интерфейс системы Proceset во фрейм на стороннем сайте Для включения укажите значение `true` По умолчанию указано `false` — возможность выключена
`"web_dir"`	—	Путь к каталогу с файлами веб-интерфейса относительно рабочего каталога Proceset
`"add_exclude_cipher_suites"`	—	Исключенные алгоритмы шифрования
`"host"`	—	Сетевой интерфейс, на котором доступна система По умолчанию — `0.0.0.0`, т.е. для всех. Если указано значение `127.0.0.1` — доступно только на локальном хосту
`"add_exclude_protocols"`	—	Исключенные протоколы SSL-соединения
`"request_timeout"`	—	Таймаут для HTTP-запроса
`"temp_dir"`	—	Каталог временных файлов веб-сервера относительно рабочего каталога Proceset
`"disable_websocket"`	—	Выключение/включение функционала веб-сокетов (подписок) для веб-сервера По умолчанию включено, т.е. `false`
`"use_unsupported_applications"`	—	Позволяет включить отображение системы в Internet Explorer Для включения укажите `true` По умолчанию указано `false` (система не отображается в IE)
`"prometheus"`	`FE_PROMETHEUS`	Позволяет включить функционал сбора и предоставления метрик Prometheus Для включения укажите значение `true` По умолчанию указано `false` — функционал сбора и предоставления метрик выключен
`"cors_policy"`	`FE_CORS_POLICY`	Позволяет настроить CORS для междоменного обмена данными Укажите значение ``, чтобы включить междоменный обмен данными с любыми сайтами. Для ограничения доступа перечислите через запятую список URL-адресов, с которыми необходим междоменный обмен данными, например `["https://infomaximum.com", "https://infomaximum.ru"]` на Windows или `"https://infomaximum.com, https://infomaximum.ru"` на Linux Также поддерживается указание маски для всех поддоменов, например, `["https://(.).infomaximum.com"]` на Windows или `"https://(.*).infomaximum.com"` на Linux Подробнее в разделе JS-трекер
`"graphql_disable"`	`FE_GRAPHQL_DISABLE`	Отключение возможности делать GraphQL-запросы
`"graphql_introspection_disabled"`	`FE_GRAPHQL_INTROSPECTION_DISABLE`	Позволяет включить интроспекцию GraphQL Чтобы включить, укажите значение `false` По умолчанию указано `true` — интроспекция выключена

com.infomaximum.subsystem.core.json

Параметр	Переменная окружения	Описание
`"reset_count_invalid_logon_duration"`	—	Период, после которого происходит обнуление попыток входа Можно указать в днях, часах, минутах и секундах
`"restorelink_timeout"`	—	Срок жизни ссылки на восстановление пароля По умолчанию срок жизни ссылки на восстановление пароля, которая приходит пользователю на почту, составляет 24 часа Можно указать в днях, часах, минутах и секундах
`"secret_key_path"`	—	Путь к ключу относительно рабочего каталога Proceset, с помощью которого система шифрует чувствительные данные
`"logon_type"`	—	Настройка способа входа в систему через встроенную аутентификацию Значение login — вход через логин, email — через почту
`"system_notification_message"`	`CR_NOTIFICATION_MESSAGE`	Настройка информационного уведомления, которое отображается после обновления системы Для ввода доступен любой текст, который будет показан в информационном окне Если значение параметра не заполнено или атрибут отсутствует в конфигурационном файле, то будет считаться, что уведомление отключено. В этом случае уведомление не показывается Подробнее в разделе Настройки системы
`"employee_tree_depth"`	—	Настройка вывода количества сотрудников в списке до «Показать еще» Диапазон находится в пределах от 1 до 100. По умолчанию установлено значение `20`. В случае необходимости замените значение вручную Если удалить файл конфигурации модуля и перезапустить службу, то произойдет сброс до значения по умолчанию
`"auth_without_role"`	`CR_AUTH_WITHOUT_ROLE`	Настройка аутентификации без роли доступа Если значение отсутствует или выбрано `true` (по умолчанию), то аутентификация без ролей доступа разрешена, если `false` — для аутентификации требуется хотя бы одна роль доступа (может использоваться без привилегий) Подробнее в разделе Пользователи
`"open_org_structure"`	`CR_OPEN_ORG_STRUCTURE`	Переключение режима открытости/закрытости орг. структуры При открытом режиме можно запрашивать список сотрудников без проверки доступа. В профиле сотрудника сняты ограничения на просмотр отдела и доступ к сотрудникам При закрытом режиме запрос списка сотрудников без проверки доступа запрещен. Просмотр отдела в профиле сотрудника возможен только при наличии прав. Добавление сотрудников — через email без поиска по списку (доступен запрос профиля по email) По умолчанию — `true`

com.infomaximum.subsystem.monitoring.json

Параметр	Переменная окружения	Описание
`"phased_agent_upgrade"`	—	Позволяет настроить поэтапное обновление агентов Укажите в блоке настройки: — `"stable_version"` — стабильная версия агента (должна быть указана и проходить валидацию по шаблону XXX.XXX.XXX) — `"host_mask"` — массив FQDN имен компьютеров в формате регулярных выражений, которые будут обновляться на версию выше, чем указано в параметре `"stable_version"` (не может быть пустым)
`"agent_log_config"`	—	Блок настройки уровня технических логов sessionInspector.log на агентах мониторинга
`"parsing_activity_enabled"`	—	Включение/выключение фоновых процессов по разбору и синхронизации архивов активности в ClickHouse
`"agent_activity_queue_dir"`	—	Для переноса папки с сырой активностью на другой диск укажите в параметре новое расположение Косую черту необходимо экранировать еще одной косой чертой
`"activity_queue_retention"`	—	Срок хранения сырых данных активности Сырые данные необходимы при возникновении ошибки, чтобы после ее исправления загрузить исходные данные повторно Значение по умолчанию — 14 дней (`14d`), минимальное значение — 1 день (`1d`)
`"partition_life_circle_time"`	—	Количество дней хранения логов агентов мониторинга в таблице `monitoring_agent_inspector_log` По умолчанию 14 дней
`"rdb_ch_synchronization"`	`MN_SYNC_CH_DELAY` `MN_SYNC_CH_INTERVAL`	Настройка синхронизации собранной агентами активности между встроенной файловой базой данных и ClickHouse Параметры первой (после старта системы) и последующих синхронизаций с собранной агентами активностью между встроенной файловой базой данных и ClickHouse `{ "delay": "1m", "interval": "5m" }`, где: `"delay"` — синхронизация после старта `"interval"` — период между первой и последующей синхронизациями
`"parameters_hashing"`	—	Глобальный параметр хеширования, отвечает за включение и отключение хеширования данных из форм ввода, собираемых агентом мониторинга Значение `"default"` установлено по умолчанию и означает, что хеширование включено, `"none"` — данные не хешируются и передаются в открытом виде на сервер Любое изменение конфигурации хеширования будет применено после перезагрузки сервера
`"storage_guid"`	`MN_STORAGE_GUID`	Определяет идентификатор хранилища данных ClickHouse, подключенного к системе Proceset, в котором хранится активность, собранная агентом мониторинга. Определяет, к какому серверу ClickHouse будет подключаться система При изменении значения этого параметра новая активность начнет записываться в новое хранилище. Система автоматически будет переносить накопленные данные в новое хранилище, начиная с самой ранней записи Параметр `"storage_guid"` используется совместно с параметром `"monitoring_database_name"`, который указывает имя базы данных внутри выбранного хранилища Переменная activity_table хранит актуальный путь к таблице `monitoring_activity`, используя значения параметров `"storage_guid"` и `"monitoring_database_name"`. Это позволяет скриптам автоматизации обращаться к данным без необходимости вручную менять путь к таблице при переносе данных
`"monitoring_database_name"`	`MN_DB_NAME`	Определяет имя базы данных для хранения активности внутри хранилища ClickHouse (`"storage_guid"`), где хранится таблица `monitoring_activity` Если параметр отсутствует или указана пустая строка, используется значение по умолчанию — `"main"` Если параметр задан, новая активность будет записываться в указанную базу данных Требования к имени базы данных: 1. Длина не более 255 символов 2. Состоит только из латинских букв в верхнем или нижнем регистре, цифр и символов подчеркивания «_» 3. Начинается с буквы, а не с цифры или символа подчеркивания Переменная activity_table формирует актуальный путь к базе данных и таблице `monitoring_activity`, используя значение этого параметра Имена таблиц `monitoring_activity` и monitoring_agent_inspector_log не изменяются
`"researches_enabled"`	`MN_RESEARCHES`	Включение/выключение функционала исследований По умолчанию — `true` Подробнее в разделе Сбор скриншотов агентом мониторинга
`"monitoring_screenshot_blur"`	—	Настройка размытия скриншотов, собираемых агентом мониторинга По умолчанию установлено значение 50 Можно задать значение от 1 до 100. Если размытие не требуется, укажите 0

com.infomaximum.subsystem.bidata.json

Параметр	Переменная окружения	Описание
`"temp_table_lifetime"`	—	Время жизни временных таблиц, создаваемых в ClickHouse при загрузке CSV-файлов Значение по умолчанию: `2h` (2 часа)
`"max_transition_count_for_process_map"`	—	Карта процесса: максимальное количество переходов для вычислителя Значение по умолчанию: `300`
`"max_variant_count_for_process_map"`	—	Карта процесса: максимальное количество цепочек вариантов Значение по умолчанию: `100`
`"max_variant_length_for_process_map"`	—	Карта процесса: максимальная длина цепочки вариантов Значение по умолчанию: `100`
`"use_clickhouse_balancer"`	—	Карта процесса: использовать балансировщики ClickHouse Значение по умолчанию: `false` - `true` — в запросах при использовании кластерного хранилища будут задействоваться обычные таблицы (`CREATE TABLE …`) - `false` — в запросах при использовании кластерного хранилища будут задействоваться TEMPORARY-таблицы (`CREATE TEMPORARY TABLE …`) Для некластерного подключения всегда используются TEMPORARY-таблицы

com.infomaximum.subsystem.dashboard.json

Параметр	Переменная окружения	Описание
`"rows_export_limit"`	`DB_ROWS_LIMIT`	Настройка лимита количества строк при выгрузке таблиц в форматах .xlsx и .csv из дашборда По умолчанию — 5000 Допустимо любое значение Подробнее в разделе Экспорт табличного отчета
`"temp_table_lifetime"`	—	Определяет срока хранения временных таблиц По умолчанию — 1 день Можно указать значения в днях (`d`) и часах (`h`)

com.infomaximum.subsystem.automation.json

Параметр	Переменная окружения	Описание
`"is_production"`	`AU_PROD`	Определяет, какие блоки будут доступны в скриптах: все или только стабильные версии Если указано `false`, появляется доступ к экспериментальному функционалу. По умолчанию установлено `true`
`"script_version_lifetime"`	—	Срок хранения версий скрипта. Может указываться в секундах (`s`), минутах (`m`), часах (`h`) Если указать значение `0d`, будет задан бесконечный срок хранения
`"exchange_retry_count"`	—	Количество автоматических повторных запросов при возникновении определенных ошибок Exchange `0` — отключает повторы (ошибка приводит к немедленному завершению блока с ошибкой) `1` — одна попытка повтора `>1` — соответствующее число повторов с интервалом 1 минута. По умолчанию — `25`
`"exchange_ignore_exceptions"`	—	Включение режима игнорирования ошибок при работе с календарями Exchange Если указано `true` — ошибки при обработке отдельных календарей не прерывают выполнение скрипта; информация об ошибках фиксируется в логах Если указано `false` — ошибки приводят к прерыванию обработки (значение по умолчанию) Примечание: После изменения параметра требуется перезапуск центрального сервера

com.infomaximum.subsystem.clickhouse.standalone.json

Параметр	Описание
`"repeat_sql_query_count"`	Позволяет установить количество повторений запросов при возникновении ошибки
`"repeat_sql_query_time"`	Время между повторными запросами Указывается в миллисекундах
`"log_queries"`	Отвечает за запись SQL запросов в таблицу `system.query_log`, которые генерируют дашборды и виджеты в таблицу `system.query_log` сервера ClickHouse Если выбрано значение `false` (по умолчанию), то информация не записывается, если `true` — записывается
`"checkout_timeout"`	Ограничивает время, в течение которого Proceset будет ожидать подключения к ClickHouse в том случае, если пул доступных соединений к ClickHouse исчерпан Указывается в миллисекундах

com.infomaximum.platform.component.database.json

Параметр Описание

"periodical_backup_enabled" Включение/выключение создания периодической перезаписываемой резервной копии встроенной файловой базы данных, которое выполняется в полночь

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

По умолчанию — "backup". При необходимости можно указать другой каталог

Косую черту необходимо экранировать еще одной косой чертой

Параметр	Описание
`"periodical_backup_enabled"`	Включение/выключение создания периодической перезаписываемой резервной копии встроенной файловой базы данных, которое выполняется в полночь
`"backup_path"`	Путь к каталогу, в котором будет сохраняться периодическая резервная копия встроенной файловой базы данных относительно рабочего каталога Proceset По умолчанию — `"backup"`. При необходимости можно указать другой каталог Косую черту необходимо экранировать еще одной косой чертой

cluster.json

Параметр	Переменная окружения	Описание
`"name"`	`CL_NAME`	Имя текущей ноды в кластере Proceset Подробнее в разделе Установка модуля автоматизации на другой сервер
`"name"`	`CL_PORT`	Порт текущей ноды для работы в кластере Proceset Подробнее в разделе Установка модуля автоматизации на другой сервер
`"nodes"`	`CL_REMOTE_NODES`	Список других нод в кластере Proceset

Переменные окружения

Заметка

Некоторые переменные окружения не связаны с конкретными конфигурационными файлами.

Переменная окружения Описание

CR_LOG_LEVEL Уровень технических логов (main.log)

Возможные значения: trace, debug, info, warn, error

По умолчанию — debug

Подробнее в разделе Ротация журнала безопасности

JVM_MAX_MEMORY Лимит оперативной памяти на java-машину

По умолчанию — 4G

На Windows значение изменяется через реестр

Подробнее в разделах Установка приложения Infomaximum на Linux и Указание доступного для приложения Infomaximum объема оперативной памяти

Переменная окружения	Описание
`CR_LOG_LEVEL`	Уровень технических логов (main.log) Возможные значения: `trace`, `debug`, `info`, `warn`, `error` По умолчанию — `debug` Подробнее в разделе Ротация журнала безопасности
`JVM_MAX_MEMORY`	Лимит оперативной памяти на java-машину По умолчанию — 4G На Windows значение изменяется через реестр Подробнее в разделах Установка приложения Infomaximum на Linux и Указание доступного для приложения Infomaximum объема оперативной памяти

Редактирование конфигурационных файлов на ОС Linux

Заметка

Не все параметры можно изменить через переменные окружения, так как не все настройки системы вынесены в них.

Если представленных переменных окружения недостаточно, можно использовать переменную SKIP_CONFIGURE. Если указать ее в команде запуска Docker-контейнера, все переменные окружения, кроме JVM_MAX_MEMORY, будут проигнорированы. В этом случае конфигурацию нужно будет редактировать вручную в файлах, расположенных в каталоге /var/lib/infomaximum/config/ внутри контейнера.

Чтобы использовать переменную SKIP_CONFIGURE:

Запустите систему Proceset обычным способом. Это нужно для того, чтобы конфигурационные файлы заполнились необходимыми данными.
Скопируйте конфигурационные файлы из контейнера на хост. Используйте команду:
```
docker cp a382:/var/lib/infomaximum/config/ /home/user/config
```
Где a382 — это идентификатор контейнера, который можно узнать с помощью команды docker ps, и /home/user/config — это каталог на вашем хосте.
Остановите контейнер.
```
docker service rm infomaximum-app
```
Откройте и отредактируйте необходимые конфигурационные файлы в указанном каталоге.
При следующем запуске укажите, где находятся файлы с настройками с помощью параметра --mount, и добавьте параметр, который запретит системе менять настройки: -e SKIP_CONFIGURE='yes'.

Пример команды:

docker service create --name infomaximum-app \
--secret infomaximum_app_https_certificate \
--secret infomaximum_app_https_certificate_password \
--mount type=volume,src=infomaximum-app-data-t,target=/var/lib/infomaximum/data/ \
--mount type=volume,src=infomaximum-app-log-t,target=/var/log/infomaximum/ \
--mount type=bind,source=/home/user/config,target=/var/lib/infomaximum/config/ \
--publish published=443,target=8010,mode=host \
--restart-max-attempts 5 \
--restart-condition "on-failure" \
-e JVM_MAX_MEMORY='4G' \
-e FE_URL="https://proceset.local" \
-e SKIP_CONFIGURE='yes' \
dockerhub.office.infomaximum.com/infomaximum/infomaximum_app:d240710

Предупреждение

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

Была ли статья полезна?

Да

Нет

Работа с системой

Метрики Prometheus