Перейти к содержанию

Приложение 1. Описание переменных файла «.env-vanilla»#

Параметры, запрещенные к изменениям#

Параметр Описание Возможные значения
Запрещено изменять
DOCKER_REGISTRY Задаёт путь до сервера VisionLabs, с которого будет производиться загрузка Docker образов - IP_address – адрес registry (dockerhub. visionlabs.ru/cars по умолчанию)
API_VERSION Задает версию дистрибутива CARS_API. По умолчанию задается актуальная версия Доступные версии CARS_API
STREAM_VERSION Задает версию дистрибутива CARS_Stream. По умолчанию задается актуальная версия Доступные версии CARS_Stream
STREAM_ANPR_VERSION Задает версию дистрибутива CARS_Stream ANPR. По умолчанию задается актуальная версия Доступные версии CARS_Stream ANPR
STREAMREADER_VERSION Задает версию дистрибутива CARS_StreamReader. По умолчанию задается актуальная версия Доступные версии CARS_StreamReader
ANALYTICS_BACKEND_VERSION Задает версию дистрибутива backend CARS_Analytics. По умолчанию задается актуальная версия Доступные версии backend CARS_Analytics
ANALYTICS_FRONTEND_VERSION Задает версию дистрибутива frontend CARS_Analytics. По умолчанию задается актуальная версия Доступные версии frontend CARS_Analytics
STREAM_NUM_THREADS Количество ядер ЦПУ, используемых для нейронных сетей 1…n
STREAM_REID_DIST_THRESHOLD_VALUE1 Внутренняя настройка для стратегии coroutineReID -
STREAM_REID_DIST_THRESHOLD_VALUE2 Внутренняя настройка для стратегии coroutineReID -
STREAM_REID_CENTER_DIST_THRESHOLD Внутренняя настройка для стратегии coroutineReID -
STREAM_REID_MIN_TRACK_LENGTH_MERGING Внутренняя настройка для стратегии coroutineReID -
STREAM_REID_GRAYSCALE_THRESHOLD Внутренняя настройка для стратегии coroutineReID -
STREAM_ANPR_COUNT Количество экземпляров Stream-ANPR 1-2
STREAM_ANPR_STUB Используется для тестирования - True – включено;
- False – выключено
STREAMREADER_COUNT Количество экземпляров StreamReader 1-2
ANALYTICS_RECORD_CACHE_BASIC_EX_TIME Время (в секундах) кэширования промежуточных данных - (900 по умолчанию)
ANALYTICS_DB_CONN_MAX_AGE Время жизни подключения к базе данных от CARS_Analytics 0…3600 (60 по умолчанию)
ANALYTICS_TRACK_END_INTERVAL_PROCESSING Период обработки (в секундах) trackEnds агрегатором 2…n
ANALYTICS_PLATE_MATCH_PERCENTAGE Процент совпадений номеров при агрегации 0…100
ANALYTICS_PLUGIN_NAME Параметр служит для подключения внутренних библиотек -
FRONTEND_URL URL для подключения к frontend части CARS_Analytics - (carsanalytics2.frontend.vlabs по умолчанию)
POSTGRES_PORT Порт подключения к БД Доступные порты (5432 по умолчанию)
POSTGRES_HOSTNAME Имя сервера, где располагается БД Имя хоста БД
REDIS_HOST Имя сервера, где располагается Redis IP адрес сервера Redis
REDIS_PORT Порт для подключения к Redis Доступные порты (6379 по умолчанию)
JSON_EXPORTER_TARGET Получения данных через JSON Exporter -(http://back:8000/api/v1-cars/health по умолчанию)

Параметры, не рекомендуемые к изменениям#

Параметр Описание Возможные значения
Не рекомендуется изменять
INSTALLER_AUTO_CONFIG Настроить автоматическую генерацию конфигурации API и Stream для Nginx и Compose - True – включено;
- False – выключено
CORS_SITE Определяет возможность использования части веб-интерфейса LUNA CARS внутри другого сайта. Для обеспечения данной возможности необходимо указать hostname сайта, где будет использован веб-интерфейс -
STREAMS_LIST Список устройств для запуска экземпляров CARS_Stream. Например, cpu для обработки на центральном процессоре, gpu{N}для запуска сервиса на gpu с индексом N (нумерация gpu начинается с 0) cpu, gpu{N} (работа на GPU поддерживается только на видеокартах NVIDIA с установленными драйверами и NVIDIA Container Toolkit. GPU-карты ниже Turing-архитектуры и старше Ada-архитектуры не поддерживаются)
APIS_LIST Список устройств для запуска экземпляров CARS_API. Количество экземпляров зависит от количества указанных устройств в списке. Например, cpu для процессора, gpu{N} для запуска сервиса на gpu с индексом N (нумерация gpu начинается с 0) cpu, gpu{N} (работа на GPU поддерживается только на видеокартах NVIDIA с установленными драйверами и NVIDIA Container Toolkit. GPU-карты ниже Turing-архитектуры и старше Ada-архитектуры не поддерживаются)
STREAM_PORT_START Начальный номер порта для работы экземпляра CARS_Stream. Этот порт будет увеличиваться в зависимости от количества экземпляров. Каждый экземпляр должен иметь уникальный порт, который не должен пересекаться с портами других подсистем (например, CARS_API). При увеличении количества экземпляров порт увеличивается на 1, начиная с указанного значения Номер порта (34569 по умолчанию)
STREAM_HASP_PORT_START Начальный номер порта для подключения к серверу HASP. Этот порт должен соответствовать номеру дополнительного экземпляра CARS_Stream и не должен пересекаться с портами других подсистем (например, CARS_API). Порт увеличивается на 1 для каждого нового экземпляра Номер порта HASP (1948 по умолчанию)
HEALTH_CHECK_MAX_ERROR_COUNT Лимит ошибок при чтении источника кадров за установленный период. При превышении лимита CarsStream закрывает источник и перестаёт получать из него кадры 1…1000 (200 по умолчанию)
STREAM_VIDEO_DIR Директория для размещения видеофайлов для последующей обработки и добавления в CARS_Analytics в качестве источника Путь к папке сохранения (/tmp/stream/video/ по умолчанию)
STREAM_VEHICLE_STRATEGY Стратегия для обработки транспортных средств coroutineV2, coroutineReID
STREAM_FP_VEHICLE_TRACK_ALGO Алгоритм для фильтрации ложноположительных детекций транспортных средств (например, человек вместо транспортного средства) fullFrame,vehicleCrop
STREAM_FP_VEHICLE_TRACK_DETECTION Включение или отключение детекции ложноположительных треков транспортных средств - 0 – отключено
- 1 – включено
STREAM_FP_VEHICLE_TRACK_THRESHOLD Порог для детекции ложноположительных треков транспортных средств 0…1
STREAM_FP_VEHICLE_TRACK_HUMAN_IMG_SIZE Размер изображения для треков людей в случае ложноположительных детекций если STREAM_FP_VEHICLE_TRACK_ALGO =fullFrame, то рекомендуется 640; если STREAM_FP_VEHICLE_TRACK_ALGO=vehicleCrop, то рекомендуется 320
STREAM_ANPR1_PORT Порт для подключения к первому экземпляру Stream-ANPR Доступные порты (33573 по умолчанию)
STREAM_ANPR2_PORT Порт для подключения ко второму экземпляру Stream-ANPR Доступные порты (33574 по умолчанию)
STREAMREADER1_PORT Порт для подключения к первому экземпляру StreamReader Доступные порты (34575 по умолчанию)
STREAMREADER2_PORT Порт для подключения ко второму экземпляру StreamReader Доступные порты (34576 по умолчанию)
API_HASP_PORT_START Начальный номер порта для работы экземпляра CARS_API. Этот порт будет увеличиваться в зависимости от количества экземпляров. Каждый экземпляр должен иметь уникальный порт, который не должен пересекаться с портами других подсистем (например, CARS_Stream). При увеличении количества экземпляров порт увеличивается на 1, начиная с указанного значения. Номер порта для HASP (2948 по умолчанию)
API_WHEEL_RECOGNITION_NMS_THRESHOLD Порог для алгоритма обнаружения колес -
API_COLOR_THRESHOLD Порог для конфигурирования классификатора цвета ТС. Если скор классификатора цвета ТС ниже установленного порога, то результат будет возвращен как undefined -
API_SYMBOL_THRESHOLD_* Порог точности распознавания символов. Символы, точность распознавания которых определена ниже установленного порога, не отображаются в UI 0…1 (порог по умолчанию зависит от региона параметра)
*Доступные регионы для API_SYMBOL_THRESHOLD: RUS, EU_CIS, UK_ASIA, CHN, THAI, MNG, UAE, PERSIAN, AMERICA
API_FEATURE_THRESHOLD_* Порог для распознавания символов ГРЗ 0…1 (порог по умолчанию зависит от региона параметра)
*Доступные регионы для API_FEATURE_THRESHOLD: CHN, UAE, RUS
API_REGION_FEATURE_THRESHOLD_THAI Порог для распознавания символов ГРЗ в Таиланде 0…1
API_TYPE_FEATURE_THRESHOLD_THAI Порог для распознавания свойств ГРЗ в Таиланде 0…1
API_CPU_COUNT Количество потоков, которые слушает один экземпляр CARS_API 1…n
API_CPU_NT Количество ядер для нейронных сетей 1…n (зависит от количества ядер ЦП)
VEHICLE_DETECTION_TO_FRAME_RATIO_THRESHOLD Пороговое значение отношения площади обнаружения транспортного средства к площади кадра, используемое для фильтрации обнаружений и повторных обнаружений Рекомендуемое значение: 0.04
ANALYTICS_FRONTEND_PORT Порт для подключения к frontend компоненту CARS_Analytics с использованием HTTP Доступные порты (8080 по умолчанию)
ANALYTICS_FRONTEND_SSL_PORT Порт с шифрованием для подключения к frontend компоненту CARS_Analytics с использованием HTTPS Доступные порты (443 по умолчанию)
ANALYTICS_BACKEND_CONCURRENCY Распределение нагрузки работы компонента backend CARS_Analytics на несколько потоков 1…n (зависит от количества ядер ЦП)
ANALYTICS_BACKEND_HANDLER_CONCURRENCY Распределение нагрузки работы обработчиков backend CARS_Analytics на несколько потоков 1…n (зависит от количества ядер ЦП)
ANALYTICS_MEDIA_ROOT_FOLDER Директория, в которую будут сохраняться все изображения, полученные от CARS_Stream. Изображения сортируются в папках по дате получения события. Путь должен быть одинаков для всех запущенных копий в одном контуре Путь к папке сохранения (путь указан по умолчанию)
ANALYTICS_PSQL_FOLDER Директория, в которой будет храниться информация базы данных. Путь должен быть одинаков для всех запущенных копий в одном контуре Путь к папке сохранения (путь указан по умолчанию)
AGGREGATOR_COUNT Количество экземпляров сервиса, используемых для агрегации результатов распознавания и детекций.Рекомендуется увеличивать значение при появлении задержек обработки данных 1…n
ANALYTICS_SYNC_FULLFRAME_WITH_PLATE Определяет, синхронизировать ли полный кадр с кропом ГРЗ - True – синхронизировать;
- False – не синхронизировать
ANALYTICS_SYNC_VCROP_WITH_PLATE Определяет, синхронизировать ли bestshot и кроп ТС с номером при его обновлении - True – синхронизировать;
- False – не синхронизировать
ANALYTICS_STRICT_AGGREGATION Строгая агрегация номеров. Т.е. строго фиксирует количество ГРЗ в треке по первому кадру: сохраняются только изначально обнаруженные номера этого ТС; любые появившиеся позже отсееваются. Выключено — в БД попадают все обнаруженные номера - True – использовать;
- False – не использовать
ANALYTICS_BACKEND_HANDLER_COUNT Количество контейнеров на backend части CARS_Analytics 1…n
ANALYTICS_LOGGING_HANDLERS Режим логирования - console (логировать только в консоль);
- file_error (логи ошибок записываются в соответствующий файл);
- file_warning (логи предупреждающих сообщений записываются в соответствующий файл);
- file_info (логи информационных сообщений записываются в соответствующий файл)
ANALYTICS_CAMERA_CHECK_INTERVAL Частота проверки статуса камеры (в секундах) 1…n

Параметры, разрешенные к изменениям#

Параметр Описание Возможные значения
Разрешено изменять
DB_BACKUP Автоматическое резервное копирование базы данных при изменении версии - True – Включено: при изменении версии базы данных выполняется создание резервной копии, после чего запускаются миграции;
- False – Выключено: резервное копирование не выполняется, так как база данных может занимать значительный объём памяти
LICENSE_TYPE Задаёт тип используемой лицензии - hasp-ldk – HASP;
- guardant – Guardant
HASP_LICENCE_SERVER Задаёт путь до сервера, к которому инсталлятор обращается за сетевой лицензией на CARS_API и CARS_Stream - IP_address – адрес сервера с установленной утилитой HASP
- hostname – имя хоста сервера, на котором установлена утилита HASP
HASP_WAIT_TIME Задаёт время ожидания ответа сервера лицензирования в секундах 10…N
HASP_LICENSE_FILE Задает путь до файла лицензии, к которому обращается инсталлятор. Используется при триальной лицензии Путь до файла с лицензией (./empty по умолчанию)
GUARDANT_LICENSE_SERVER Задаёт путь до сервера, к которому инсталлятор обращается за сетевой лицензией - IP_address – адрес сервера с установленным сервисом Guardant Control Center
- hostname – имя хоста сервера, на котором установлен сервис Guardant Control Center
DOWNLOAD_USER Задает логин пользователя для скачивания дистрибутивов. Для получения логина обратитесь к менеджеру VisionLabs Логин пользователя
DOWNLOAD_PASSWORD Задает пароль пользователя для скачивания дистрибутивов. Для получения логина обратитесь к менеджеру VisionLabs Пароль пользователя
STREAM_LOGGING_LEVEL Уровень логирования для CARS_Stream и StreamReader - ERROR (логирование ошибок);
- INFO (логирование информационных сообщений);
- DEBUG_LVL_1 (логирование дополнительных отладочных сообщений)
STREAM_PROFILING Флаг для включения или отключения профилирования CARS_Stream 0 - отключить, 1 - включить
STREAM_LP_DETECTION_TO_FRAME_RATIO_THRESHOLD Порог для настройки соотношения области детекций ГРЗ к кадру, используемый для фильтрации некорректных детекций ГРЗ 0.0…1 (рекомендуемое значение: 0.003)
STREAM_WHEEL_RECOGNITION_IMAGE_SIZE Размер изображения для распознавания колес -
STREAM_WHEEL_RECOGNITION_SCORE_THRESHOLD Порог для распознавания колес -
STREAM_WHEEL_RECOGNITION_NMS_THRESHOLD Порог для алгоритма обнаружения колес -
STREAM_DETECTOR_TYPES_FOR_BESTSHOTS Настройка позволяющая выбирать откуда отправлять bestshots - all (fullDetect и redetect);
- onlyFullDetect (only fullDetect detections)
SHOW_ALL_FULL_FRAMES Показывать все полные кадры в CARS_Analytics. При выставлении значения False будут отображаться только полные кадры начала и конца трека, а также одного лучшего кадра - True – показывать;
- False – не показывать
API_PLATE_ESTIMATOR_TYPE Тип агрегированного эстиматора. Отличие версий заключается в улучшении качества работы и расширении списка распознаваемых стран V5…
API_WHEEL_RECOGNITION_IMAGE_SIZE Размер изображения для распознавания колес -
API_WHEEL_RECOGNITION_SCORE_THRESHOLD Порог для распознавания колес -
API_AGGREGATED_LP_SCORE_CALC_POLICY Параметр для выбора метода расчёта агрегированного скора номера - Multiplication (перемножение скора символов);
- Average (сложение скоров символов, делённое на количество символов);
- Median (медиана)
API_NON_ZEROING_LP_DATA_SCORE_THRESHOLD Позволяет занулить данные при плохом распознавании номера 0…1
API_COMPLEXED_LP_SCORE_CALC_POLICY Позволяет рассчитывать агрегированный скор номера на основе усреднения скора распознавания номера и скора распознавания страны номера None, AveragingWithLPCountryScore
API_USE_LATIN_CHARACTERS Использование латинских символов при отображении символов ГРЗ. Если нет аналога в латинице, то они будут отображены на кириллице - True – использовать латиницу;
- False – использовать кириллицу
API_LOG_LEVEL Выбор уровня логирования CARS_API - 0 – INFO (логирование информационных сообщений);
- 1 – WARNING (логирование предупреждающих сообщений);
- 2 – ERROR (логирование ошибок);
- 3 – FATAL (логирование критических ошибок)
VEHICLE_DETECTOR_DEFAULT_TYPE Тип детектора транспортных средств VehicleDetectorV4, VehicleDetectorV5, VehicleDetectorV6
ANALYTICS_CLASSIFIER_ROUND_BASE Число символов после запятой для значений из CARS_API; влияет на точность результатов 1…n
ANALYTICS_MAX_PLATES_DISPLAY Максимальное количество отображаемых ГРЗ 1…n
ANALYTICS_ENABLED_CLASSIFIERS_FILTERING Позволяет не классифицировать уже распознанные атрибуты ТС и ГРЗ - True – не классифицировать;
- False – классифицировать
ENABLED_UNICODE_INPUT Использование символов Unicode (можно вводить кириллицу, латиницу и спецзнаки) при поиске ГРЗ по символам в CARS_Analytics - True – использовать;
- False – не использовать
UPDATE_UI_WITH_WEB_SOCKET При включении параметра отправляется сообщение в WebSocket на каждый bestshot из CarsStream — даже если новые результаты хуже текущих в базе данных. При выключенном параметре сообщения отправляются только при улучшении результатов - True – отправлять;
- False – не отправлять
ANALYTICS_LOGGING_LEVEL Уровень логирования сервисов CARS_Analytics - ERROR (логирование ошибок);
- WARNING (логирование предупреждающих сообщений);
- INFO (логирование информационных сообщений)
CELERY_WORKER_PREFETCH_MULTIPLIER - 1
LANGUAGE_CODE Выбор языка интерфейса CARS_Analytics - en-us – английский язык;
- ru-ru – русский язык
EMAIL_USE_SSL Протокол защиты данных Secure Sockets Layer (SSL). Протокол защиты зависит от выбранного SMTP-сервера. Необходимо использовать один из протоколов соединения (SSL или TLS) - True – использовать SSL;
- False – не использовать SSL
EMAIL_USE_TLS Указывает, использовать ли TLS (transport layer security) соединение с SMTP-сервером. Используется для явного TLS подключения - True – использовать TLS;
- False – не использовать TLS
EMAIL_PORT Задаёт порт, используемый при подключении к SMTP-серверу Значения параметров подключения к STMP-серверу берутся из открытых источников (2525 по умолчанию)
EMAIL_HOST Задаёт имя SMTP-сервера, используемое для отправки электронных писем Значения параметров подключения к STMP-серверу берутся из открытых источников
EMAIL_HOST_USER Задаёт имя пользователя, используемое при подключении к SMTP-серверу, указанному в EMAIL_HOST Email адрес, созданный в домене выбранного SMTP-сервера
SERVER_EMAIL Задаёт Email-адрес, используемый в качестве адреса отправителя Email адрес, созданный в домене выбранного SMTP- сервера
DEFAULT_FROM_EMAIL Задаёт Email-адрес, используемый при отправке различных автоматических рассылок Email адрес, созданный в домене выбранного SMTP-сервера
EMAIL_HOST_PASSWORD Задаёт пароль для подключения к SMTP-серверу, который указан в EMAIL_HOST. Эта настройка используется вместе с EMAIL_HOST_USER для авторизации при подключении к SMTP-серверу Пароль, созданный в домене выбранного SMTP-сервера
EVENT_LIFETIME Время жизни зарегистрированного события (в днях). По истечении выставленного значения, событие будет автоматически удалено. Значения 0 - хранить всегда 0…n
INCIDENT_LIFETIME Время жизни зарегистрированного инцидента (в днях). По истечении выставленного значения, инцидент будет автоматически удален. Значения 0 - хранить всегда 0…n
FULL_FRAME_LIFETIME Время жизни полного кадра (в часах). По истечении выставленного значения, полный кадр будет автоматически удален. Значения параметра не ограничены, однако не рекомендуется выставлять высокие значения с целью предотвращения заполнения пространства на жестком диске сервера 1…n
ANALYTICS_DISK_FREE_SPACE_THRESHOLD Порог свободного места на диске в процентах.Когда свободное место на диске опускается ниже этого порога, система принимает меры для предотвращения переполнения 1…100
ANALYTICS_CELERY_CLEAR_EVENTS_TASK_TIME Время (в часах) для выполнения задачи по очистке событий в Celery 1…n
ENABLED_VEHICLE_CLASSIFIERS Доступные классификаторы ТС Список доступных классификаторов указан в Руководстве Администратора CARS_API
SEND_TRACKEND_UPDATE Отправка сообщений по окончанию трека. Используется для типов событий со шлагбаумом. В случаях, когда сообщение об окончании трека приходит поздно (машина остается в кадре, либо трек переносится на другой объект, и т.д.), отключение данного параметра поможет избежать повторного открытия шлагбаума - True – отправлять;
- False – не отправлять
MAX_SYMBOLS_BELOW_THRESHOLD Максимальное количество ошибок при поиске ГРЗ (в количестве символов). Т.е. на какое количество символов возможна допустимая ошибка Системы при поиске ГРЗ (при сравнении со списком номеров) 1…10
TIME_ZONE Задает значение часового пояса для контейнеров. Корректировка временной зоны необходима для того, чтобы все контейнеры работали в одном часовом поясе. Часовой пояс LUNA CARS должен соответствовать расположению серверов LUNA CARS Значение этого параметра может быть любым из доступных в базе данных «time zone»
POSTGRES_DB Задаёт имя базы данных Имя БД
POSTGRES_PASSWORD Задаёт пароль для доступа к базе данных Пароль к БД
POSTGRES_USER Задаёт логин пользователя базы данных Логин пользователя БД
POSTGRES_MAX_CONNECTIONS Максимальное число подключений к базе данных 150…1000
ANALYTICS_UI_MAX_BESTSHOT_COUNT_LIMIT Задает предельное значение для параметра «Максимальное количество bestshots» в UI Analytics 1…n
MONITOR_ENABLE Включение или отключение мониторинга - True – включить;
- False - выключить
GRAFANA_PORT Порт для подключения к Grafana UI Используйте http://${IP}:${GRAFANA_PORT} (3000 по умолчанию)
GRAFANA_PASSWORD Пароль для доступа к Grafana UI Используйте admin/${GRAFANA_PASSWORD}
PROMETHEUS_RETENTION_TIME Время хранения данных в Prometheus 1…n (единицы измерения: y, w, d, h, m, s, ms)
PROMETHEUS_RETENTION_SIZE Максимальный объем хранимых данных в Prometheus (в Gb) 1…n
GRAFANA_TG_BOT_TOKEN Токен для Telegram-бота Grafana null - значения не должны быть пустыми
GRAFANA_TG_CHAT_ID ID чата для отправки уведомлений в Telegram null - значения не должны быть пустыми
GRAFANA_SERVER_NAME Имя сервера, где запущена Grafana Имя сервера