Переменные окружения ПроAPI Защита¶

Переменные окружения Консоли управления (бэкенд компонента) ПроAPI Защита¶

Переменная	Описание
`MONGO_URI`	Строка подключения к MongoDB
`URL_MANAGER`	Адрес и порт, на который будут подключаться ноды по gRPC. Схему (http://, https://) указывать не нужно. Порт по умолчанию – `8081` Пример значения: `apifw-manager.webmonitorx.dev:8081`
`LICENSE_KEY`	Лицензионный ключ
`SECURE_COOKIE`	Управляет нет атрибутом `secure` для сессионной cookie. Значение по умолчанию `true`. Если вы разворачиваете сервис в тестовых целях и не используете HTTPS, то эту переменную нужно выставить в `false`
`SET_REAL_IP_FROM`	IP адреса, с которых разрешено доверять содержимому заголовка `X-REAL-IP`. Несколько IP указываются через запятую. Требуется для корректного отображения IP адресов пользователей Консоли управления. Не влияет на обработку трафика фильтрующими нодами. В большинстве случаев потребуется указать IP адрес фронтенд компонента консоли управления. Значение по умолчанию отсутствует
`ALLOWED_CORS_ORIGINS`	Применяется, если появляется необходимость настроить CORS. Возможно указать несколько значений через запятую
`GRPC_SERVER_ADDRESS`	Адрес и порт, на котором должен слушать gRPC API для взаимодействия с фильтрующими нодами. Значение по умолчанию `0.0.0.0:8082`
`GRPC_SERVER_CERT_FILE`	Для настройки защищенного gRPC соединения между Консолью управления и фильтрующими узлами нужно указать путь до файла сертификата
`GRPC_SERVER_KEY_FILE`	Путь до файла закрытого ключа
`HTTP_SERVER_ADDRESS`	Адрес и порт, на котором должен слушать HTTP API для взаимодействия с фронтэнд компонентом. Значение по умолчанию `0.0.0.0:8082`
`API_PREFIX`	Префикс для HTTP API. Значение по умолчанию `/API`
`LOGGER_LEVEL`	Уровень логгирования, Достуные значения `ERROR`, `WARNING`, `INFO`, `DEBUG`, `TRACE`. По умолчанию: `DEBUG`
`WRITE_TO_FILE`	Файл лога. Значение по умолчанию `logs.log`
`NODES_NOT_ACTIVE_AFTER`	Считать ноду неактивной если от нее не приходят данные более установленного периода. Значение по умолчанию `1h`
`NODES_DELETED_AFTER`	Удалять неактивные ноды через заданное время. Значение по умолчанию `720h`
`EVENTS_DELETED_AFTER`	Удалять события старше указанного количества часов. Значение по умолчанию `4320h`
`FETCH_SPECS_INTERVAL`	Период повторного запроса OpenAPI спецификации при выборе источника спецификации URL в настройках приложения. Значение по умолчанию `10m`
`RENEW_PASSWORD`	Используется для восстановления пароля. При значении `true` будет сгенерирован новый пароль для пользователя `admin`. После восстановления пароля удалите эту переменную окружения из параметров запуска контейнера

Переменные окружения WEB UI (фронтенд компонента) Консоли управления¶

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

API_BASE_URL URL, который будет использоваться для формирования запросов к API бэкенд компонента консоли управления. Должен соответствовать URL, на котором у вас развернут фронтенд компонент, но с суффиксом /api (суффикс зависит от переменной окружения API_PREFIX бэкенд компонента)
Пример: если вы развернули фронтенд компонент на https://manager.example.com, то значение API_BASE_URL будетhttps://manager.example.com/api

API_BACKEND_URL URL для проксирования запроса от WEB UI на backend. На этот URL встроенный в WEB UI NGINX будет делать proxy_pass.
Пример: https://manager.internal:8082/api/

Переменные окружения ноды ПроAPI Защиты¶

Переменная	Описание
`APIFW_URL`	URL-адрес внутри контейнера, на котором нода будет принимать входящие соединения. Значение по умолчанию: `http://0.0.0.0:8282/`
`APIFW_SERVER_URL`	URL-адрес защищаемого приложения или DNS балансировщика. Например: `http://backend.local:8080`
`APIFW_MANAGER_ADDRESS` (для интеграции с консолью управления ПроAPI Защита)	Адрес и порт консоли управления ПроAPI Защита, схему указывать не нужно Пример: `apifw.webmonitorx.dev:8081`
`APIFW_MANAGER_KEY` (для интеграции с консолью управления ПроAPI Защита)	Ключ приложения. Нужен для первичной регистрации ноды ПроAPI Защиты в консоли управления
`APIFW_LICENSE_KEY` (для интеграции с консолью управления ПроAPI Защита)	Лицензионный ключ
`APIFW_SET_REAL_IP_FROM` (для интеграции с консолью управления ПроAPI Защита)	IP адреса, с которых разрешено доверять содержимому заголовка переданного через `APIFW_REAL_IP_HEADER`. Используется для корректной работы механизма REAL IP
`APIFW_PASS_OPTIONS`	Если установлено значение `true`, ПроAPI Защита не будет блокировать запросы с методом `OPTIONS`, даже если такие запросы не описаны в спецификации. Значение по умолчанию – `false`
`APIFW_REAL_IP_HEADER` (для интеграции с консолью управления ПроAPI Защита)	Заголовок, в котором передается информация об IP адресе клиента. По умолчанию – `X-REAL-IP`
`APIFW_REAL_IP_RECURSIVE` (для интеграции с консолью управления ПроAPI Защита)	`false` – считать IP адресом клиента последний IP адрес из списка переданных в `REAL_IP_HEADER`. `true` – считать IP адресом клиента последний не доверенный IP адрес из списка переданных в `REAL_IP_HEADER` Значение по умолчанию – `false`
`APIFW_MANAGER_CLIENT_CA_FILE` (для интеграции с консолью управления ПроAPI Защита)	CA сертификат. Для настройки Secure gRPC между нодами и консолью управления
`APIFW_MANAGER_CLIENT_CERT_FILE` (для интеграции с консолью управления ПроAPI Защита)	Сертификат клиента. Для Secure gRPC
`APIFW_MANAGER_CLIENT_KEY_FILE` (для интеграции с консолью управления ПроAPI Защита)	Секретный ключ сертификата клиента. Для Secure gRPC
`APIFW_LOG_LEVEL`	Подробность вывода информации в STDOUT и STDERR контейнера. От меньшей к большей. Каждый последующий уровень включает в себя вышестоящие. • `ERROR` - Включает критические ошибки и ошибки валидации запросов • `WARNING` – включает ошибки декодирования, проблемы валидации content-type, shadow api • `INFO` – включает ошибки типа «неизвестный эндпоинт» • `DEBUG` – более дельное логирование • `TRACE` – помимо вышеперечисленного выводить http запросы и ответы, включая их содержимое
`APIFW_BLOCK_ON_PARSING_FAILED`	При `true` будут заблокированы запросы, которые ПроAPI Защита не смогла распарсить. Значение по умолчанию – `true`

Переменные окружения для настройки параметров ноды ПроAPI Защита¶

Переменная	Описание
`APIFW_READ_TIMEOUT`	Тайм-аут на чтение запроса (включая тело). Значение по умолчанию – `5s`
`APIFW_WRITE_TIMEOUT`	Время ожидания ПроAPI Защита для возврата ответа на запрос, отправленный на URL приложения. Значение по умолчанию – `5s`
`APIFW_SERVER_MAX_CONNS_PER_HOST` (для режимов `PROXY` и `graphql`)	Максимальное количество подключений, которые может обрабатывать ПроAPI Защита одновременно. Значение по умолчанию – `512`
`APIFW_SERVER_READ_TIMEOUT` (для режимов `PROXY` и `graphql`)	Тайм-аут для чтения полного ответа (включая тело), возвращаемого приложением на запрос. Значение по умолчанию – `5s`
`APIFW_SERVER_WRITE_TIMEOUT` (для режимов `PROXY` и `graphql`)	Тайм-аут для ПроAPI Защита для записи полного запроса (включая тело) в приложение. Значение по умолчанию – `5s`
`APIFW_SERVER_DIAL_TIMEOUT` (для режимов `PROXY` и `graphql`)	Время ожидания, по которому API Firewall подключается к приложению. Значение по умолчанию – `200ms`
`APIFW_SERVER_CLIENT_POOL_CAPACITY` (для режимов `PROXY` и `graphql`)	Максимальное количество клиентов fasthttp. Значение по умолчанию – `1000`
`APIFW_HEALTH_HOST`	Хост службы проверки работоспособности. Значение по умолчанию – `0.0.0.0:9667`. Путь службы проверки работоспособности – `/v1/liveness`, а путь службы готовности – `/v1/readiness`
`APIFW_READ_BUFFER_SIZE`	Размер буфера для каждого подключения при чтении запроса. Это также ограничивает максимальный размер заголовка. Увеличьте этот буфер, если ваши клиенты отправляют RequestURI размером более 1 КБ и/или заголовки размером более 1 КБ (например, большие файлы cookie). Значение по умолчанию – `8192`
`APIFW_WRITE_BUFFER_SIZE`	Размер буфера для каждого соединения при записи ответа. Значение по умолчанию – `8192`
`APIFW_MAX_REQUEST_BODY_SIZE`	Максимальный размер тела запроса. Сервер отклоняет запросы с телами, превышающими этот предел. Значение по умолчанию – `4194304`
`APIFW_DISABLE_KEEPALIVE`	Отключает постоянно действующие соединения. Сервер закроет все входящие соединения после отправки клиенту первого ответа, если для этого параметра установлено значение true. Значение по умолчанию – `false`
`APIFW_MAX_CONNS_PER_IP`	Максимальное количество одновременных клиентских подключений, разрешённых для одного IP-адреса. Значение по умолчанию – `0` (неограниченно)
`APIFW_MAX_REQUESTS_PER_CONN`	Максимальное количество запросов, обрабатываемых за одно соединение. Сервер закрывает соединение после обработки последнего запроса. Заголовок Connection: `close` добавляется к последнему ответу. Значение по умолчанию – `0` (неограниченно)
`APIFW_SERVER_READ_BUFFER_SIZE`	Размер буфера для каждого подключения при чтении запроса. Это также ограничивает максимальный размер заголовка. Значение по умолчанию – `8192`
`APIFW_SERVER_WRITE_BUFFER_SIZE`	Размер буфера для каждого соединения при записи ответа. Значение по умолчанию – `8192`
`APIFW_SERVER_MAX_RESPONSE_BODY_SIZE`	Максимальный размер тела ответа. Значение по умолчанию – `0` (неограниченно)