ervu-lkrp-fl/config.md

# Описание конфигурации параметров проекта

В micord.env заданы следующие переменные окружения:

## Аутентификация через ЕСИА

- `ESIA_SCOPES` - область доступа, позволяющие получить данные о пользователе. Тип данных, к которым система-клиент намерена получить доступ

- `ESIA_BASE_URI` - базовый url для обращения в ЕСИА

- `ESIA_CLIENT_ID` - идентификатор системы-клиента (мнемоника системы в ЕСИА указанная прописными буквами)

- `ESIA_REDIRECT_URL` - ссылка, по которой должен быть направлен пользователь
  Важно: `ESIA_REDIRECT_URL` должна содержать полный адрес вплоть до последнего слэша:
  
  > - https://lkul.ervu.loc/ - правильное значение параметра
  > - https://lkul.ervu.loc - неправильное значение параметра

- `ESIA_LOGOUT_REDIRECT_URL` - ссылка, по которой должен быть направлен пользователь после logout-a
  Важно: `ESIA_LOGOUT_REDIRECT_URL` должна содержать полный адрес вплоть до последнего слэша:
  
  > - https://lkul.ervu.loc/home.html - правильное значение параметра
  > - https://lkul.ervu.loc - неправильное значение параметра

- `SIGN_URL` - url для подписания с помощью КриптоПро секрета клиента, необходимого для аутентификации через ЕСИА

- `ESIA_CLIENT_CERT_HASH` - параметр, содержащий хэш сертификата (fingerprint сертификата) системы-клиента в hex–формате

- `SIGN_VERIFY_URL` - url для отправки маркера доступа от ЕСИА на верификацию

- `ESIA_ISSUER_URL` - организация, выпустившая маркер. Нужен для верификации маркера доступа от ЕСИА

- `ESIA_MARKER_VER` - версия маркера. Нужен для верификации маркера доступа от ЕСИА

## Конфигурация Kafka

- `ERVU_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `ERVU_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `ERVU_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `ERVU_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `ERVU_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `ERVU_KAFKA_DOC_LOGIN_MODULE` - имя класса для входа в систему для SASL-соединений в формате, используемом конфигурационными файлами JAAS
- `ERVU_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `ERVU_KAFKA_REPLY_TIMEOUT` - таймаут ожидания ответа
- `ERVU_KAFKA_RECRUIT_HEADER_CLASS` - класс для идентификации в заголовке запроса на получение данных о повестке, временных мерах и воинском учете
- `ERVU_KAFKA_EXTRACT_HEADER_CLASS` - класс для идентификации в заголовке запроса на получение выписки из Реестра повесток/Реестра воинского учета
- `AUDIT_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `AUDIT_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `AUDIT_KAFKA_LOGIN_MODULE` - имя класса для входа в систему для SASL-соединений в формате, используемом конфигурационными файлами JAAS
- `AUDIT_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `AUDIT_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `AUDIT_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `AUDIT_KAFKA_ENABLED` - флажок для включения записи аудита в кафку

### Топики Kafka

| Наименование                     | Описание                                                                                         | Пишет                              | Читает                             | Имя конфигурации                                |
| -------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------- | ---------------------------------- | ----------------------------------------------- |
| ervu.lkpr.person.search.request  | топик для отправки запроса на получение id                                                       | ervu-lkrp-fl-backend               | ervu-person-registry               | ERVU_KAFKA_REQUEST_TOPIC                        |
| ervu.lkpr.person.search.response | топик для получения id пользователя в системе ЕРВУ                                               | ervu-person-registry               | ervu-lkrp-fl-backend               | ERVU_KAFKA_REPLY_TOPIC                          |
| ervu.extract.empty.request       | топик для отправки запроса на получение выписки из Реестра воинского учета при отсутствии ErvuId | ervu-lkrp-fl-backend               |                                    | ERVU_KAFKA_REGISTRY_EXTRACT_EMPTY_REQUEST_TOPIC |
| ervu.recruit.info.request        | топик для отправки запроса на получение данных о повестке, временных мерах и воинском учете      | ervu-lkrp-fl-backend               | ervu-rp-summons-service            | ERVU_KAFKA_RECRUIT_REQUEST_TOPIC                |
| ervu.recruit.info.response       | топик для получения данных о повестке, временных мерах и воинском учете                          | ervu-rp-summons-service            | ervu-lkrp-fl-backend               | ERVU_KAFKA_RECRUIT_REPLY_TOPIC                  |
| ervu.extract.info.request        | топик для отправки запроса на получение выписки из Реестра воинского учета при наличии ErvuId    | ervu-lkrp-fl-backend               | ervu-extract-from-registry-proider | ERVU_KAFKA_REGISTRY_EXTRACT_REQUEST_TOPIC       |
| ervu.extract.info.response       | топик для получения выписки из Реестра воинского учета                                           | ervu-extract-from-registry-proider | ervu-lkrp-fl-backend               | ERVU_KAFKA_REGISTRY_EXTRACT_REPLY_TOPIC         |
| ervu.lkrp.auth.events            | топик для отправки аудита в журнал авторизации                                                   | ervu-lkrp-fl-backend               | ervu-lkrp-journal-service          | AUDIT_KAFKA_AUTHORIZATION_TOPIC                 |
| ervu.lkrp.action.events          | топик для отправки аудита в журнал действий пользователя                                         | ervu-lkrp-fl-backend               | ervu-lkrp-journal-service          | AUDIT_KAFKA_ACTION_TOPIC                        |
| ervu.lkrp.import.file            | топик для отправки аудита в журнал загрузки ЮЛ и ФЛ                                              | ervu-lkrp-fl-backend               | ervu-lkrp-journal-service          | AUDIT_KAFKA_FILE_DOWNLOAD_TOPIC                 |

## Прочее

- `COOKIE_PATH` - путь для access token
- `COOKIE_SECURE` - параметр secure
- `COOKIE_DOMAIN` - домен для cookie
- `COOKIE_SAME_SITE` - параметр SameSite. Одно из значений: Strict, Lax, None
- `WEBBPM_SECURITY_TOKEN_SECRET_KEY` - секретный ключ для создания JWT токена. Значение должно быть в Base64 кодировке.