ervu-lkrp-av/config.md
2024-10-16 14:02:00 +03:00

41 lines
4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Описание конфигурации параметров проекта
В micord.env заданы следующие переменные окружения:
#### Конфигурация и топики Kafka ЛК РП
- `AV_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `AV_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `AV_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `AV_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `AV_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `AV_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `AV_KAFKA_TOPIC_NAME` - топик для чтения данных по загруженному в личном кабинете файлу
- `AV_KAFKA_STATUS_TOPIC_NAME` - топик для отправки статусов проверки файла
#### Конфигурация и топики Kafka ЕРВУ
- `ERVU_KAFKA_BOOTSTRAP_SERVERS` - список пар хост:порт, использующихся для установки первоначального соединения с кластером Kafka
- `ERVU_KAFKA_SECURITY_PROTOCOL` - протокол, используемый для взаимодействия с брокерами
- `ERVU_KAFKA_SASL_MECHANISM` - механизм SASL, используемый для клиентских подключений
- `ERVU_KAFKA_USERNAME` - пользователь для подключения к Kafka
- `ERVU_KAFKA_PASSWORD` - пароль для подключения к Kafka
- `ERVU_KAFKA_GROUP_ID` - идентификатор группы потребителей, который отвечает за создание группы для объединения нескольких потребителей
- `ERVU_KAFKA_ERROR_TOPIC_NAME` - топик для отправки данных об ошибках проверки файла или наличии вирусов
- `ERVU_KAFKA_SUCCESS_TOPIC_NAME` - топик для отправки данных об успешной проверке файла
- `ERVU_KAFKA_RESPONSE_TOPIC_NAME` - топик для чтения статусов файла, полученных от ЕРВУ
#### Настройки взаимодействия с файлами и антивирусом
- `FILE_SAVING_PATH` - путь для сохранения файла на диске
- `AV_CHECK_ENABLED` - параметр включения/отключения проверки на вирусы
- `AV_REST_ADDRESS` - url для отправки файлов на проверку антивирусом
- `AV_FIRST_TIMEOUT_MILLISECONDS` - таймаут ожидания окончания проверки анивирусом
- `AV_RETRY_MAX_ATTEMPTS_COUNT` - количество попыток проверки файла
- `AV_RETRY_DELAY_MILLISECONDS` - задержка между попытками проверки файла
#### Конфигурация S3
- `S3_ENDPOINT` - url для подключения к S3
- `S3_ACCESS_KEY` - публичная часть пары ключей AWS
- `S3_SECRET_KEY` - закрытая часть пары ключей AWS
- `S3_BUCKET_NAME` - наименование бакета для сохранения проверенного файла
- `S3_PATH_STYLE_ACCESS_ENABLED` - параметр включения/отключения стиля, при котором название бакета указывается в части пути до объекта в URI