Перенос настроек Django в переменные среды

В Django проекте многие настройки можно вынести в переменные среды для повышения безопасности и гибкости конфигурации. Это особенно полезно для чувствительных данных, таких как секретные ключи, пароли и другие конфиденциальные настройки. Вот как это можно сделать на примере этого проекта:

1. Импорт библиотеки os: Убедитесь, что вы импортировали библиотеку os для работы с переменными среды.

2. Использование os.getenv: Используйте функцию os.getenv для получения значений из переменных среды. (Второй аргумент этой функции — это значение по умолчанию, которое будет использоваться, если переменная среды не установлена.)

3. Если использовать  .env файл, то необходимо доустановить библиотеку python-dotenv.  pip install python-dotenv и добавить строки 

   from dotenv import load_dotenv
   
   load_dotenv('.env') # Путь до .env файла, начиная с корня проекта

   
    

Настраиваем settings.py

"""
Django settings for choocha project.

Generated by 'django-admin startproject' using Django 5.1.4.

For more information on this file, see
https://docs.djangoproject.com/en/5.1/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/5.1/ref/settings/
"""
import os
from pathlib import Path
from dotenv import load_dotenv

load_dotenv('.env')

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.getenv('DJANGO_SECRET_KEY')

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = os.getenv('DJANGO_DEBUG', 'False') == 'True'

# Разрешенные хосты
ALLOWED_HOSTS = os.getenv('DJANGO_ALLOWED_HOSTS').split(', ')


INTERNAL_IPS = [
...
]
# Application definition

INSTALLED_APPS = [
...
]



MIDDLEWARE = [
...
]


TEMPLATES = [
...
]


# Настройки базы данных
DATABASES = {
    'default': {
        'ENGINE': os.getenv('DB_ENGINE'),
        'NAME': os.getenv('DB_NAME'),
        'USER': os.getenv('DB_USER'),
        'PASSWORD': os.getenv('DB_PASSWORD'),
        'HOST': os.getenv('DB_HOST'),
        'PORT': os.getenv('DB_PORT'),
    }
}

# Password validation
AUTH_PASSWORD_VALIDATORS = [
...
]

# Internationalization
LANGUAGE_CODE = 'ru-ru'
TIME_ZONE = 'Europe/Moscow'
USE_TZ = True

# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.1/howto/static-files/

STATIC_URL = 'static/'
STATIC_ROOT = BASE_DIR / 'static'

MEDIA_URL = 'media/'
MEDIA_ROOT = BASE_DIR / 'media'



# Default primary key field type
# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'


LOGIN_REDIRECT_URL = "home"
LOGOUT_REDIRECT_URL = "home"
LOGIN_URL = 'users:login'

AUTHENTICATION_BACKENDS = (
...
)

# EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
EMAIL_HOST = os.getenv('EMAIL_HOST')
EMAIL_PORT = os.getenv('EMAIL_PORT')
EMAIL_HOST_USER = os.getenv('EMAIL_HOST_USER')
EMAIL_HOST_PASSWORD = os.getenv('EMAIL_HOST_PASSWORD')
EMAIL_USE_TLS = os.getenv('EMAIL_USE_TLS')

DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
SERVER_EMAIL = EMAIL_HOST_USER
EMAIL_ADMIN = EMAIL_HOST_USER

AUTH_USER_MODEL = 'users.User'

SOCIAL_AUTH_PIPELINE = (
...
)

SOCIAL_AUTH_GITHUB_KEY = os.getenv('SOCIAL_AUTH_GITHUB_KEY')
SOCIAL_AUTH_GITHUB_SECRET = os.getenv('SOCIAL_AUTH_GITHUB_SECRET')

Как установить переменные среды

1. В Linux/macOS:
   Вы можете добавить переменные среды в файл .bashrc, .zshrc, или .bash_profile:

   export DJANGO_SECRET_KEY='ваш_секретный_ключ'
   export DJANGO_DEBUG='True'
   export DJANGO_ALLOWED_HOSTS='127.0.0.1,localhost'
   export DJANGO_EMAIL_HOST_PASSWORD='ваш_пароль'

2. В Windows:
   Вы можете установить переменные среды через командную строку:

   set DJANGO_SECRET_KEY=ваш_секретный_ключ
   set DJANGO_DEBUG=True
   set DJANGO_ALLOWED_HOSTS=127.0.0.1,localhost
   set DJANGO_EMAIL_HOST_PASSWORD=ваш_пароль

   Или через графический интерфейс:

   • Правой кнопкой мыши на "Мой компьютер" -> "Свойства" -> "Дополнительные параметры системы" -> "Переменные среды".

3. В Docker:
   Вы можете указать переменные среды в docker-compose.yml или в Dockerfile:

   environment:
     - DJANGO_SECRET_KEY=ваш_секретный_ключ
     - DJANGO_DEBUG=True
     - DJANGO_ALLOWED_HOSTS=127.0.0.1,localhost
     - DJANGO_EMAIL_HOST_PASSWORD=ваш_пароль

4. В .env файле:
   Вы можете использовать библиотеку python-decouple или django-environ для загрузки переменных из .env файла. 

   Пример .env файла (значения переменных используёте свои): 

   DJANGO_SECRET_KEY=secret_key
   DJANGO_DEBUG=False
   DJANGO_ALLOWED_HOSTS=*
   
   # Database settings
   DB_ENGINE=db_engine
   DB_NAME=db_name
   DB_USER=db_user
   DB_PASSWORD=db_password
   DB_HOST=db_host
   DB_PORT=db_port
   
   # Email settings
   EMAIL_HOST=host
   EMAIL_PORT=port
   EMAIL_HOST_USER=user
   EMAIL_HOST_PASSWORD=password
   EMAIL_USE_TLS=True
   
   # Social auth settings
   SOCIAL_AUTH_GITHUB_KEY=key
   SOCIAL_AUTH_GITHUB_SECRET=secret

Теперь ваши настройки будут более безопасными и гибкими, так как они могут быть легко изменены без изменения кода.

Примечание.

При создании .env файла через far manager, столкнулся с тем, что редактор по умолчанию добавляет BOM. 

В Far нажимаем < Ctrl+O>. В командной строке вводим far:config. Параметр Editor.AddUnicodeBOM меняем на false. И сохраняем настройки, либо при сохранении через Shift + F2 убираем BOM.