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

Переменные окружения (.env)

Переменные окружения используются для конфигурации приложения Planiqum на уровне инфраструктуры и среды выполнения. Они задаются в файле .env в корне проекта или через переменные среды операционной системы. Такие переменные позволяют управлять параметрами базы данных, путями, ключами, почтовыми настройками и другими важными аспектами работы приложения без необходимости изменять исходный код.

Изменения переменных окружения требуют перезапуска приложения для вступления в силу.

Подробнее смотри в документации разработчика

Переменные окружения

Все переменные можно определить в файле .env или через экспорт в shell. Значения по умолчанию указаны в скобках.

ADMIN_EMAIL

ADMIN_EMAIL=(str, None)
Email администратора для получения сообщений об ошибках.

APPS

APPS=(list, [])
Список приложений для меню (используется в некоторых настройках).

AUTH_LDAP_BASE_DN

AUTH_LDAP_BASE_DN=(str, None)
DN пользователей на LDAP сервере.

AUTH_LDAP_SERVER_URI

AUTH_LDAP_SERVER_URI=(str, 'ldap://localhost')
URI LDAP сервера.

AWS_ACCESS_KEY_ID

AWS_ACCESS_KEY_ID=(str, 'no')
Идентификатор ключа доступа к S3 (если используется).

AWS_S3_ENDPOINT_URL

AWS_S3_ENDPOINT_URL=(str, 'https://storage.yandexcloud.net')
URL точки доступа S3.

AWS_SECRET_ACCESS_KEY

AWS_SECRET_ACCESS_KEY=(str, 'no')
Секретный ключ доступа к S3.

AWS_STORAGE_BUCKET_NAME

AWS_STORAGE_BUCKET_NAME=(str, None)
Имя бакета для S3 по умолчанию.

BRANCH

BRANCH=(str, None)
Устаревший параметр. Используйте CI_COMMIT_BRANCH.

CELERY_BROKER

CELERY_BROKER=(str, None)
Брокер для Celery.

CELERY_RESULT_BACKEND

CELERY_RESULT_BACKEND=(str, 'planiqum.core.django_celery_results.backends.DatabaseBackend')
Бэкенд для хранения результатов Celery.

CELERY_TASK_ALWAYS_EAGER

CELERY_TASK_ALWAYS_EAGER=(bool, False)
Выполнять задачи Celery синхронно (для отладки).

CI_COMMIT_BRANCH

CI_COMMIT_BRANCH=(str, None)
Текущая ветка репозитория (используется для сборки).

COLORTERM

COLORTERM=(str, None)
Используется для цветного вывода в терминале.

COMMAND_MODE

COMMAND_MODE=(str, None)
Режим командной оболочки (shell).

CUSTOM_INSTALLED_APPS

CUSTOM_INSTALLED_APPS=(str, '')
Список дополнительных приложений через запятую (например, planiqum.apps.test_basics).

CURSOR_TRACE_ID

CURSOR_TRACE_ID=(str, None)
ID для интеграции с Cursor IDE.

DATABASE_URL

DATABASE_URL=(str, None)
Строка подключения к базе (альтернатива отдельным DB_* переменным).

DB_ENGINE

DB_ENGINE=(str, 'django.db.backends.mysql')
Движок базы данных (например, django.db.backends.postgresql).

DB_HOST

DB_HOST=(str, '0.0.0.0')
Адрес хоста базы данных.

DB_NAME

DB_NAME=(str, 'planiqum_db')
Имя базы данных.

DB_PASS

DB_PASS=(str, 'no_secret')
Пароль для доступа к базе данных.

DB_PORT

DB_PORT=(str, '3306')
Порт базы данных.

DB_USER

DB_USER=(str, 'planiqum_user')
Пользователь базы данных.

DEBUG

DEBUG=(bool, False)
Режим отладки Django.

DEBUG_TASK

DEBUG_TASK=(bool, False)
Выполнять тестовые задачи Celery для проверки.

DEFAULT_FROM_EMAIL

DEFAULT_FROM_EMAIL=(str, None)
Email отправителя по умолчанию.

DEV

DEV=(bool, True)
Режим разработки.

DISABLE_AUTO_UPDATE

DISABLE_AUTO_UPDATE=(bool, False)
Отключить автообновление (если используется).

EMAIL_HOST

EMAIL_HOST=(str, None)
Адрес SMTP-сервера для отправки почты.

EMAIL_HOST_PASSWORD

EMAIL_HOST_PASSWORD=(str, None)
Пароль для SMTP-сервера.

EMAIL_HOST_USER

EMAIL_HOST_USER=(str, None)
Email-аккаунт для отправки писем.

EMAIL_PORT

EMAIL_PORT=(int, 1025)
Порт SMTP-сервера.

EXPORT_ROOT

EXPORT_ROOT=(str, None)
Путь для экспорта данных.

EXCLUDE_ALL_PARENTS

EXCLUDE_ALL_PARENTS=(bool, False)
Отключить заполнение таблицы core_hierarchy_all_parents (временная мера).

FORCE_PASSWORD_CHANGE

FORCE_PASSWORD_CHANGE=(bool, False)
Принудительная смена пароля при первом входе.

GRAYLOG_HOST

GRAYLOG_HOST=(str, None)
Адрес Graylog для логирования (если используется).

HISTORY_DEPTH_BANNED_IP_DAYS

HISTORY_DEPTH_BANNED_IP_DAYS=(int, 30)
Сколько дней хранить историю блокировок по IP.

HOST

HOST=(str, 'planiqum.ru')
Доменное имя сайта.

IMPORT_ROOT

IMPORT_ROOT=(str, None)
Путь для импорта данных.

INCLUDE_DEFAULT_APPS

INCLUDE_DEFAULT_APPS=(bool, True)
Включать ли стандартные приложения (ibp, demand_planning, supply_planning).

INFOPATH

INFOPATH=(str, None)
Пути поиска справки в Unix.

LANG

LANG=(str, 'ru_RU.UTF-8')
Язык системы.

LANGUAGE_CODE

LANGUAGE_CODE=(str, 'ru')
Код языка по умолчанию для Django.

LANGUAGES

LANGUAGES=(list, [('en', 'English'), ('ru', 'Russian')])
Список поддерживаемых языков.

LDAP_ONLY

LDAP_ONLY=(bool, False)
Использовать только LDAP-аутентификацию.

LDAP_SUPPORT

LDAP_SUPPORT=(bool, True)
Включить поддержку LDAP-аутентификации.

LOCALE_PATHS

LOCALE_PATHS=(list, [])
Пути к локализациям.

LOGIN_FAIL_ATTEMPT_COUNT

LOGIN_FAIL_ATTEMPT_COUNT=(int, 3)
Количество неудачных попыток входа до блокировки.

LOGIN_FAIL_BAN_TIMEOUT

LOGIN_FAIL_BAN_TIMEOUT=(int, 5)
Время блокировки IP (минуты).

LOGIN_REDIRECT_URL

LOGIN_REDIRECT_URL=(str, '/#/collaboration/activities')
URL для редиректа после логина.

MASTER_PASSWORD

MASTER_PASSWORD=(str, None)
Главный пароль для администратора.

MEDIA_ROOT

MEDIA_ROOT=(str, None)
Путь к директории для медиафайлов.

MEDIA_URL

MEDIA_URL=(str, '/media/')
URL для доступа к медиафайлам.

MIN_PASSWORD_LENGTH

MIN_PASSWORD_LENGTH=(int, 10)
Минимальная длина пароля.

MQ_HOST

MQ_HOST=(str, None)
Хост очереди сообщений (RabbitMQ и др.).

MQ_QUEUE

MQ_QUEUE=(str, None)
Имя очереди сообщений.

OLDPWD

OLDPWD=(str, None)
Переменная окружения shell (предыдущий путь).

PASSWORD_HISTORY_CHECK_LENGTH

PASSWORD_HISTORY_CHECK_LENGTH=(int, 0)
Сколько последних паролей нельзя повторять.

PATH

PATH=(str, None)
Пути поиска исполняемых файлов.

PATH_CORE

PATH_CORE=(str, None)
Путь к основному модулю core.

PROJECT

PROJECT=(str, None)
Название проекта (влияет на сборку).

PWD

PWD=(str, None)
Текущий путь shell.

PYTHONPATH

PYTHONPATH=(str, None)
Пути поиска модулей Python.

REDIS_DB

REDIS_DB=(str, '0')
Номер базы Redis.

REDIS_HOST

REDIS_HOST=(str, '0.0.0.0')
Хост Redis.

REDIS_PORT

REDIS_PORT=(str, '6379')
Порт Redis.

REDIS_URL

REDIS_URL=(str, None)
URL для подключения к Redis.

RESET_OLD_PASSWORDS

RESET_OLD_PASSWORDS=(bool, False)
Принудительно обновлять старые пароли.

ROOT_URLCONF

ROOT_URLCONF=(str, 'project.urls')
Основной urls.py для Django.

S3

S3=(bool, True)
Использовать облачное хранилище для медиафайлов.

SECRET_KEY

SECRET_KEY=(str, 'no_secret')
Секретный ключ Django.

SEND_EMAIL

SEND_EMAIL=(bool, True)
Включить отправку писем из бизнес-логики.

SERVER_EMAIL

SERVER_EMAIL=(str, None)
Email для отправки сообщений об ошибках.

SESSION_COOKIE_AGE=(int, 1209600)
Время жизни сессии (секунды).

SESSION_ENGINE

SESSION_ENGINE=(str, None)
Движок хранения сессий Django.

SHLVL

SHLVL=(int, 1)
Уровень вложенности shell.

SITE_ID

SITE_ID=(int, 1)
ID сайта для Django.

SQL_DEBUG

SQL_DEBUG=(bool, False)
Включить отладку SQL-запросов.

MAX_DEBUG_QUERY_LENGTH

MAX_DEBUG_QUERY_LENGTH=(int, 5000)
Максимальная длина SQL-запроса в логах (в символах). Запросы длиннее этого значения будут обрезаны при логировании.

EXPLAIN_QUERIES

EXPLAIN_QUERIES=(bool, False)
Включить вывод плана выполнения SQL-запросов (EXPLAIN) в debug-логи. Полезно для анализа производительности запросов.

STATIC_ROOT

STATIC_ROOT=(str, None)
Путь для сбора статики.

STATIC_URL

STATIC_URL=(str, '/static/')
URL для статики.

STATICFILES_DIRS

STATICFILES_DIRS=(list, [])
Дополнительные директории для поиска статики.

TEMP_FILES_DIR

TEMP_FILES_DIR=(str, None)
Путь для временных файлов (например, CSV).

TEST

TEST=(bool, False)
Режим тестирования.

TIME_ZONE

TIME_ZONE=(str, 'Europe/Moscow')
Часовой пояс.

TIMEOUT

TIMEOUT=(int, 300)
Таймаут выполнения запросов.

TRIGGER_BY_FACTS

TRIGGER_BY_FACTS=(bool, False)
Передавать факты при запуске триггера.

USER

USER=(str, None)
Имя пользователя (shell).

USER_IP_BLOCKING

USER_IP_BLOCKING=(bool, False)
Блокировка пользователя по IP при неудачных попытках входа.

USER_PASSWORD_TIMEOUT_MINUTES

USER_PASSWORD_TIMEOUT_MINUTES=(int, 30 * 60 * 12)
Время жизни пароля (минуты).

USER_ZDOTDIR

USER_ZDOTDIR=(str, None)
Путь к настройкам пользователя shell.

USE_CELERY

USE_CELERY=(bool, True)
Включить Celery для бизнес-логики.

USE_QUENE

USE_QUENE=(bool, False)
Включить очереди задач (устаревшее, используйте Celery).

VIRTUAL_ENV

VIRTUAL_ENV=(str, None)
Путь к виртуальному окружению Python.

WSGI_APPLICATION

WSGI_APPLICATION=(str, 'project.wsgi.application')
WSGI точка входа для Django.

YANDEX_CLIENT_MEDIA_BUCKET_NAME

YANDEX_CLIENT_MEDIA_BUCKET_NAME=(str, 'dev-media-shared')
Имя бакета для хранения медиафайлов в Yandex Cloud.