SUPPORT-8619: add environment variables description to config.md

This commit is contained in:
gulnaz 2024-10-16 11:25:25 +03:00 committed by gulnaz
parent d5a903ccd4
commit 1720916423

View file

@ -741,6 +741,45 @@ JBPM использует 3 корневых категории логирова
"jivo_chat_widget_enabled": false
```
# Описание конфигурации параметров проекта
В micord.env заданы следующие переменные окружения:
#### Настройки базы данных приложения
- `DB_APP_NAME` - наименование
- `DB_APP_USERNAME` - пользователь
- `DB_APP_PASSWORD` - пароль
- `DB_APP_HOST` - хост
- `DB_APP_PORT` - порт
#### Аутентификация через ЕСИА
- `ESIA_SCOPES` - область доступа, позволяющие получить данные о пользователе. Тип данных, к которым система-клиент намерена получить доступ
- `ESIA_BASE_URI` - базовый url для обращения в ЕСИА
- `ESIA_CLIENT_ID` - идентификатор системы-клиента (мнемоника системы в ЕСИА указанная прописными буквами)
- `ESIA_CLIENT_CERT_HASH` - параметр, содержащий хэш сертификата (fingerprint сертификата) системы-клиента в hexформате
- `ESIA_REDIRECT_URL` - ссылка, по которой должен быть направлен пользователь
- `SIGN_URL` - url для подписания с помощью КриптоПро секрета клиента, необходимого для аутентификации через ЕСИА
#### Конфигурация и топики Kafka
- `ERVU_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `ERVU_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `ERVU_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `ERVU_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `ERVU_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `ERVU_KAFKA_DOC_LOGIN_MODULE` - имя класса для входа в систему для SASL-соединений в формате, используемом конфигурационными файлами JAAS
- `ERVU_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `ERVU_KAFKA_REPLY_TIMEOUT` - таймаут ожидания ответа
- `ERVU_KAFKA_REQUEST_TOPIC` - топик для отправки запроса на получение id пользователя в системе ЕРВУ
- `ERVU_KAFKA_REPLY_TOPIC` - топик для получения id пользователя в системе ЕРВУ
- `ERVU_KAFKA_RECRUIT_REQUEST_TOPIC` - топик для отправки запроса на получение данных о повестке, временных мерах и воинском учете
- `ERVU_KAFKA_RECRUIT_REPLY_TOPIC` - топик для получения данных о повестке, временных мерах и воинском учете
- `ERVU_KAFKA_RECRUIT_HEADER_CLASS` - класс для идентификации в заголовке запроса на получение данных о повестке, временных мерах и воинском учете
- `ERVU_KAFKA_SUBPOENA_EXTRACT_REQUEST_TOPIC` - топик для отправки запроса на получение выписки из Реестра повесток
- `ERVU_KAFKA_SUBPOENA_EXTRACT_REPLY_TOPIC` - топик для получения выписки из Реестра повесток
- `ERVU_KAFKA_REGISTRY_EXTRACT_REQUEST_TOPIC` - топик для отправки запроса на получение выписки из Реестра воинского учета
- `ERVU_KAFKA_REGISTRY_EXTRACT_REPLY_TOPIC` - топик для получения выписки из Реестра воинского учета
- `ERVU_KAFKA_EXTRACT_HEADER_CLASS` - класс для идентификации в заголовке запроса на получение выписки из Реестра повесток/Реестра воинского учета
# Прочее
## Смена удалённого репозитория