Переменные окружения
Backend
WARNING
Пример заполнения переменных есть в Backend, файл .env_example. Обычно нужно заполнить только основные переменные т.к. есть файл генерации .env файлов для сервисов
| Переменная | По умолчанию | Зачем нужна? |
|---|---|---|
BACKEND_DEBUG | False | При включении расширяет вывод логов для FastApi и SqlAlchemy |
BACKEND_APP_PREFIX | /pepeunit | Стандартный префикс, позволяющий дистанцировать навигацию от домена, обычно не требует изменений. Нужен для сложных встраиваемых систем |
BACKEND_API_V1_PREFIX | /api/v1 | Префикс версии REST API, нужен для возможности поддержки старых версий REST API, а также для систем требующих поддержки нескольких версий одновременно |
BACKEND_WORKER_COUNT | 2 | Число воркеров Gunicorn, позволяет увеличить нагрузку, которую способен выдержать Backend |
BACKEND_DOMAIN | - | Доменное имя или ip. Влияет на ссылки которые генерирует Backend. Позволяет Unit связываться с Backend. Устанавливается в Unit ENV - в поле PEPEUNIT_URL |
BACKEND_SECURE | True | Если True, то Backend будет генерировать ссылки с https для BACKEND_DOMAIN. Устанавливается в Unit ENV - в поле HTTP_TYPE, но уже в формате https/http |
BACKEND_AUTH_TOKEN_EXPIRATION | 2678400 | Время жизни токенов авторизации Пользователей в секундах |
BACKEND_SAVE_REPO_PATH | repo_cache | Путь по которому Backend хранит внешние Git репозитории. Устанавливается относительно корневой дирректории Backend |
SQLALCHEMY_DATABASE_URL | - | Ссылка для подключения к Postgresql |
CLICKHOUSE_DATABASE_URL | - | Ссылка для подключения к Clickhouse |
BACKEND_SECRET_KEY | - | 32 байтовый ключ в формате base64. Отвечает за подпись токенов авторизации. В случае изменения все jwt токены созданные до изменения - становятся не действительными |
BACKEND_ENCRYPT_KEY | - | 32 байтовый ключ в формате base64. Отвечает за шифрование всех данных. В случае изменения все шифрованные записи - становится невозможно расшифровать |
BACKEND_STATIC_SALT | - | 32 байтовый ключ в формате base64. Отвечает за генерацию hash для паролей пользователей. В случае изменения все учётные записи созданные до момента изменения - потеряют возможность авторизоваться |
BACKEND_STATE_SEND_INTERVAL | 60 | Частота в секундах с которой Unit'ы должны отправлять своё состояние. Устанавливается в Unit ENV - в поле STATE_SEND_INTERVAL |
BACKEND_MAX_EXTERNAL_REPO_SIZE | 50 | Значение в МБ, ограничивающее размер внешних Git репозиториев для скачивания |
BACKEND_MAX_CIPHER_LENGTH | 1000000 | Максимальная длинна в символах для шифруемой информации |
BACKEND_MIN_TOPIC_UPDATE_TIME | 30 | Частота обновления сообщений в domain.com/+/pepeunit топиках MQTT |
BACKEND_UNIT_LOG_EXPIRATION | 86400 | Вермя жизни логов, которые присылают Unit в секундах |
TELEGRAM_TOKEN | - | Токен Telegram Bot API, можно получить через Telegram Bot Father. Секретный, никому не показывайте |
TELEGRAM_BOT_LINK | - | Ссылка на Telegram Bot которым управляет Backend. Используется для генерации верификационных ссылок для пользователей бота. Передаётся в openapi.json |
PROMETHEUS_MULTIPROC_DIR | ./prometheus_metrics | Дирректория, которую Prometheus использует для хранения статистик с нескольких worker - uvicorn. При старте приложения содержимое дирректории отчищается |
REDIS_URL | redis://redis:6379/0 | Ссылка для доступа к Redis, которую использует Backend для соединения c Redis. Инстанс Redis должен быть единым с MQTT_REDIS_AUTH_URL |
MQTT_HOST | - | Доменное имя или ip. Позволяет Backend управлять и подписываться на топики EMQX MQTT Broker. Позволяет Unit связываться с EMQX MQTT Broker. Устанавливается в Unit ENV - в поле MQTT_URL |
MQTT_SECURE | True | Если True, то Backend будет использовать https для настройки EMQX MQTT Broker |
MQTT_PORT | 1883 | Порт по которому Unit и Backend связываются c EMQX MQTT Broker. Устанавливается в Unit ENV - в поле MQTT_PORT |
MQTT_API_PORT | 18083 | Порт API EMQX MQTT Broker, по которому Backend производит настройку EMQX MQTT Broker |
MQTT_KEEPALIVE | 60 | Максимальный период в секундах между отправками ping от Backend до EMQX MQTT Broker |
MQTT_USERNAME | - | Имя пользователя EMQX MQTT Broker. Backend использует его для первичной настройки брокера |
MQTT_PASSWORD | - | Пароль пользователя EMQX MQTT Broker. Backend использует его для первичной настройки брокера |
MQTT_REDIS_AUTH_URL | redis://redis:6379/0 | Ссылка для доступа к Redis, которую использует EMQX MQTT Broker для соединения c Redis. Инстанс Redis должен быть единым с REDIS_URL |
MQTT_MAX_CLIENTS | 10000 | Максимальное число клиентов EMQX MQTT Broker |
MQTT_MAX_CLIENT_CONNECTION_RATE | 20/s | Максимальная скорость подписки клиентов EMQX MQTT Broker |
MQTT_MAX_CLIENT_ID_LEN | 512 | Максимальная длинная id клиентов EMQX MQTT Broker |
MQTT_CLIENT_MAX_MESSAGES_RATE | 30/s | Максимальная частота отправки сообщений одним клиентом EMQX MQTT Broker |
MQTT_CLIENT_MAX_BYTES_RATE | 1MB/s | Максимальная скорость соединения с клиентом EMQX MQTT Broker |
MQTT_MAX_PAYLOAD_SIZE | 256 | Максимальный размер в кБ, для данных передаваемых через топики EMQX MQTT Broker |
MQTT_MAX_QOS | 2 | Максимальное качество обслуживания доступное в EMQX MQTT Broker |
MQTT_MAX_TOPIC_LEVELS | 5 | Максимальная вложенность топиков EMQX MQTT Broker |
MQTT_MAX_LEN_MESSAGE_QUEUE | 128 | Максимальная длинна очереди сообщений EMQX MQTT Broker |
MQTT_MAX_TOPIC_ALIAS | 128 | Максимальное число топиков-ссылок EMQX MQTT Broker |
INFO
Для тестирования Backend также выделены переменные:
Frontend
WARNING
У Frontend нет значений по умолчанию.
| Переменная | Пример | Зачем нужна? |
|---|---|---|
VITE_INSTANCE_NAME | example.com | Используется для генерации ссылок между разными Node основного графа |
VITE_SELF_URI | https://example.com/ | Используется для тегов og:url и og:image в index.html |
VITE_BACKEND_URI | https://example.com/pepeunit/graphql | Используется для отправки GQL запросов к Backend |