Настройки

Основные настройки
Авторизация
Сообщения
Сессии
Сайты
Статические файлы
Индекс основных настроек

Предупреждение

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

Основные настройки

Вот список настроек, доступных в ядре Django, и их значения по умолчанию. Настройки, предоставляемые приложениями contrib, перечислены ниже, а затем следует тематический индекс основных настроек. Для ознакомительного материала обратитесь к руководству по настройкам.

`ABSOLUTE_URL_OVERRIDES`

Значение по умолчанию: {} (Пустой словарь)

Словарь, сопоставляющий строки "app_label.model_name" с функциями, которые принимают объект модели и возвращают его URL. Это способ вставки или перезаписи get_absolute_url() методов на основе каждой установки. Пример:

ABSOLUTE_URL_OVERRIDES = {
    'blogs.weblog': lambda o: "/blogs/%s/" % o.slug,
    'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),
}

Обратите внимание, что имя модели, используемое в этой настройке, должно быть в нижнем регистре, независимо от регистра фактического имени класса модели.

`ADMINS`

Значение по умолчанию: [] (Пустой список)

Список всех людей, которые получают уведомления об ошибках кода. Когда DEBUG=False и AdminEmailHandler настроены в LOGGING (делается по умолчанию), Django отправляет этим людям подробности исключений, возникших в цикле запроса/ответа.

Каждый элемент в списке должен быть кортежем (Полное имя, адрес электронной почты). Пример:

[('John', 'john@example.com'), ('Mary', 'mary@example.com')]

`ALLOWED_HOSTS`

Значение по умолчанию: [] (Пустой список)

Список строк, представляющих имена хоста/домена, которые может обслуживать этот сайт Django. Это мера безопасности, предотвращающая атаки с использованием заголовка HTTP Host, которые возможны даже при многих, на первый взгляд, безопасных конфигурациях веб-сервера.

Значения в этом списке могут быть полными именами (например, 'www.example.com'), в этом случае они будут точно сопоставляться с заголовком запроса Host (регистронезависимо, без порта). Значение, начинающееся с точки, может использоваться в качестве поддоменного шаблона: '.example.com' будет сопоставляться с example.com, www.example.com, и любым другим поддоменом example.com. Значение '*' будет сопоставляться со всем; в этом случае вы несете ответственность за предоставление собственной проверки заголовка Host (возможно, в middleware; в таком случае этот middleware должен быть указан первым в MIDDLEWARE).

Django также допускает полное доменное имя (FQDN) любых записей. Некоторые браузеры включают конечную точку в заголовке Host, которую Django удаляет при выполнении проверки хоста.

Если заголовок Host (или X-Forwarded-Host, если USE_X_FORWARDED_HOST включен) не соответствует ни одному значению в этом списке, метод django.http.HttpRequest.get_host() вызовет SuspiciousOperation.

Когда DEBUG равно True и ALLOWED_HOSTS пусто, хост проверяется по ['localhost', '127.0.0.1', '[::1]'].

Эта проверка также применяется при запуске тестов ALLOWED_HOSTS.

Эта проверка применяется только через get_host(); если ваш код напрямую обращается к заголовку Host из request.META, вы обходите эту меру защиты безопасности.

`APPEND_SLASH`

Значение по умолчанию: True

Если установлено значение True, если URL запроса не соответствует ни одному из шаблонов в URLconf и не заканчивается слешем, выдаётся HTTP-перенаправление на тот же URL со слешем в конце. Обратите внимание, что перенаправление может привести к потере любых данных, отправленных в POST-запросе.

Настройка APPEND_SLASH используется только при установке CommonMiddleware (см. Middleware). Смотрите также PREPEND_WWW.

`CACHES`

Значение по умолчанию:

{
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
    }
}

Словарь, содержащий настройки всех кэшей, которые будут использоваться с Django. Это вложенный словарь, содержимое которого отображает псевдонимы кэшей в словарь, содержащий параметры для отдельного кэша.

Настройка CACHES должна настроить кэш default; также можно указать любое количество дополнительных кэшей. Если вы используете кэш-бекенд, отличный от кэша локальной памяти, или вам нужно определить несколько кэшей, потребуются другие параметры. Доступны следующие параметры кэша.

`BACKEND`

Значение по умолчанию: '' (Пустая строка)

Используемый кэш-бекенд. Встроенные кэш-бекенды:

'django.core.cache.backends.db.DatabaseCache'
'django.core.cache.backends.dummy.DummyCache'
'django.core.cache.backends.filebased.FileBasedCache'
'django.core.cache.backends.locmem.LocMemCache'
'django.core.cache.backends.memcached.MemcachedCache'
'django.core.cache.backends.memcached.PyLibMCCache'

Вы можете использовать кэш-бекенд, который не поставляется с Django, установив BACKEND на полный путь к классу кэш-бекенда (например, mypackage.backends.whatever.WhateverCache).

`KEY_FUNCTION`

Строка, содержащая путь к функции (или любому вызываемому объекту), которая определяет, как составить префикс, версию и ключ в окончательный ключ кэша. Реализация по умолчанию эквивалентна функции:

def make_key(key, key_prefix, version):
    return ':'.join([key_prefix, str(version), key])

Вы можете использовать любую функцию ключа, которую хотите, при условии, что она имеет такую же сигнатуру аргумента.

Дополнительную информацию см. в документации по кэшу.

`KEY_PREFIX`

Значение по умолчанию: '' (Пустая строка)

Строка, которая будет автоматически включена (по умолчанию в начале) ко всем ключам кэша, используемым сервером Django.

Дополнительную информацию см. в документации по кэшу.

`LOCATION`

Значение по умолчанию: '' (Пустая строка)

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

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
        'LOCATION': '/var/tmp/django_cache',
    }
}

`OPTIONS`

Значение по умолчанию: None

Дополнительные параметры для передачи кэш-бекенду. Доступные параметры варьируются в зависимости от вашего кэш-бекенда.

Некоторые сведения об доступных параметрах можно найти в документации по аргументам кэша. Более подробную информацию можно найти в документации модуля вашего бэкенда.

`TIMEOUT`

Значение по умолчанию: 300

Количество секунд, после которого запись кэша считается устаревшей. Если значение этой настройки равно None, записи кэша не будут истекать.

`VERSION`

Значение по умолчанию: 1

Номер версии по умолчанию для ключей кэша, генерируемых сервером Django.

Дополнительную информацию см. в документации по кэшу.

`CACHE_MIDDLEWARE_ALIAS`

Значение по умолчанию: default

Подключение к кэшу, которое нужно использовать для middleware кэша.

`CACHE_MIDDLEWARE_KEY_PREFIX`

Значение по умолчанию: '' (Пустая строка)

Строка, которая будет предварять ключи кэша, генерируемые middleware кэша. Этот префикс комбинируется с настройкой KEY_PREFIX; он его не заменяет.

См. фреймворк кэша Django.

`CACHE_MIDDLEWARE_SECONDS`

Значение по умолчанию: 600

Количество секунд по умолчанию для кэширования страницы для middleware кэша.

См. фреймворк кэша Django.

`CSRF_COOKIE_AGE`

Значение по умолчанию: 31449600 (примерно 1 год, в секундах)

Срок действия CSRF-куки в секундах.

Причина установки длительного срока действия срока действия — предотвратить проблемы в случае закрытия пользователем браузера или добавления страницы в закладки, а затем загрузки этой страницы из кеша браузера. Без постоянных файлов cookie отправка формы в этом случае завершится ошибкой.

Некоторые браузеры (в частности, Internet Explorer) могут запретить использование постоянных файлов cookie или повредить индексы в хранилище файлов cookie на диске, что приведет к (иногда прерывистому) отказу проверки CSRF-защиты. Измените это значение на None, чтобы использовать файлы cookie CSRF на основе сеанса, которые хранят файлы cookie в памяти вместо постоянного хранения.

`CSRF_COOKIE_DOMAIN`

По умолчанию: None

Домен, который будет использоваться при установке файла cookie CSRF. Это может быть полезно для удобного исключения запросов с разных поддоменов из обычной защиты от поддельных запросов с одного сайта. Он должен быть задан в виде строки, например, "example.com", чтобы разрешить POST-запрос из формы на одном поддомене, который будет принят представлением, обслуживаемым с другого поддомена.

Обратите внимание, что наличие этого параметра не означает, что защита Django от поддельных запросов с одного сайта по умолчанию защищена от атак с разных поддоменов — см. раздел Ограничения CSRF.

`CSRF_COOKIE_HTTPONLY`

По умолчанию: False

Использовать флаг HttpOnly для файла cookie CSRF. Если это значение установлено в True, клиентский JavaScript не сможет получить доступ к файлу cookie CSRF.

Отмечание файла cookie CSRF как HttpOnly не обеспечивает никакой практической защиты, так как CSRF предназначен только для защиты от атак с разных доменных зон. Если злоумышленник может прочитать файл cookie через JavaScript, он уже находится на том же домене, насколько браузер знает, поэтому он может делать все, что захочет. (XSS — гораздо более крупная брешь, чем CSRF.)

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

Если вы включили это и вам нужно отправить значение маркера CSRF с AJAX-запросом, ваш JavaScript должен извлечь значение из скрытого поля формы маркера CSRF вместо из файла cookie.

См. SESSION_COOKIE_HTTPONLY для получения подробной информации о HttpOnly.

`CSRF_COOKIE_NAME`

По умолчанию: 'csrftoken'

Имя файла cookie, используемого для маркера аутентификации CSRF. Вы можете использовать любое имя (только если оно отличается от других имён файлов cookie в вашем приложении). См. Защита от поддельных запросов с одного сайта.

`CSRF_COOKIE_PATH`

По умолчанию: '/'

Путь, установленный для файла cookie CSRF. Он должен либо совпадать с путем URL вашего установленного Django, либо быть родительским по отношению к этому пути.

Это полезно, если у вас установлено несколько экземпляров Django под одним и тем же именем хоста. Они могут использовать различные пути файлов cookie, и каждый экземпляр будет видеть только свой собственный файл cookie CSRF.

`CSRF_COOKIE_SAMESITE`

По умолчанию: 'Lax'

Значение флага SameSite в файле cookie CSRF. Этот флаг предотвращает отправку файла cookie в запросах с разных сайтов.

См. SESSION_COOKIE_SAMESITE для получения подробной информации о SameSite.

`CSRF_COOKIE_SECURE`

По умолчанию: False

Использовать безопасный файл cookie для файла cookie CSRF. Если это значение установлено в True, файл cookie будет помечен как «безопасный», что означает, что браузеры могут убедиться, что файл cookie отправляется только с подключением HTTPS.

`CSRF_USE_SESSIONS`

По умолчанию: False

Хранить маркер CSRF в сеансе пользователя вместо файла cookie. Требуется использование django.contrib.sessions.

Хранение маркера CSRF в файле cookie (стандартное поведение Django) безопасно, но хранение в сеансе — обычная практика в других веб-фреймворках и поэтому иногда требуется аудиторами безопасности.

`CSRF_FAILURE_VIEW`

По умолчанию: 'django.views.csrf.csrf_failure'

Путь к функции представления, которая будет использоваться при отклонении входящего запроса защитой от поддельных запросов с одного сайта. Функция должна иметь следующий вид:

def csrf_failure(request, reason=""):
    ...

где reason — короткое сообщение (предназначенное для разработчиков или протоколирования, а не для конечных пользователей), указывающее причину отклонения запроса. Она должна возвращать HttpResponseForbidden.

django.views.csrf.csrf_failure() принимает дополнительный параметр template_name, по умолчанию '403_csrf.html'. Если шаблон с таким именем существует, он будет использован для отображения страницы.

`CSRF_HEADER_NAME`

По умолчанию: 'HTTP_X_CSRFTOKEN'

Имя заголовка запроса, используемого для аутентификации CSRF.

Как и другие заголовки HTTP в request.META, имя заголовка, полученное от сервера, нормализуется путем преобразования всех символов в верхний регистр, замены всех тире подчеркиванием и добавления префикса 'HTTP_' к имени. Например, если ваш клиент отправляет заголовок 'X-XSRF-TOKEN', настройка должна быть 'HTTP_X_XSRF_TOKEN'.

`CSRF_TRUSTED_ORIGINS`

По умолчанию: [] (Пустой список)

Список хостов, которые являются доверенными источниками для небезопасных запросов (например, POST). Для небезопасного запроса secure, защита Django от поддельных запросов с одного сайта требует, чтобы запрос содержал заголовок Referer, который соответствует источнику в заголовке Host. Это предотвращает, например, запрос POST из subdomain.example.com от успешного выполнения против api.example.com. Если вам нужны запросы с разных источников через HTTPS, продолжая пример, добавьте "subdomain.example.com" в этот список. Настройка также поддерживает поддомены, поэтому вы можете добавить ".example.com", например, чтобы разрешить доступ со всех поддоменов example.com.

`DATABASES`

По умолчанию: {} (Пустой словарь)

Словарь, содержащий настройки для всех баз данных, которые будут использоваться с Django. Это вложенный словарь, содержимое которого сопоставляет псевдоним базы данных со словарем, содержащим параметры для отдельной базы данных.

Настройка DATABASES должна настроить базу данных default; также можно указать любое количество дополнительных баз данных.

Самый простой возможный файл настроек — для настройки с одной базой данных, используя SQLite. Это можно настроить следующим образом:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'mydatabase',
    }
}

При подключении к другим базам данных, таким как MySQL, Oracle или PostgreSQL, потребуются дополнительные параметры подключения. См. настройку ENGINE ниже о том, как указать другие типы баз данных. Этот пример для PostgreSQL:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'mydatabase',
        'USER': 'mydatabaseuser',
        'PASSWORD': 'mypassword',
        'HOST': '127.0.0.1',
        'PORT': '5432',
    }
}

Доступны следующие внутренние параметры, которые могут потребоваться для более сложных конфигураций:

`ATOMIC_REQUESTS`

По умолчанию: False

Установите это значение в True, чтобы обернуть каждое представление в транзакцию в этой базе данных. См. Связывание транзакций с HTTP-запросами.

`AUTOCOMMIT`

По умолчанию: True

Установите это значение в False, если вы хотите отключить управление транзакциями Django и реализовать свою собственную.

`ENGINE`

По умолчанию: '' (Пустая строка)

Используемый движок базы данных. Встроенные движки баз данных:

'django.db.backends.postgresql'
'django.db.backends.mysql'
'django.db.backends.sqlite3'
'django.db.backends.oracle'

Вы можете использовать движок базы данных, который не поставляется с Django, задав ENGINE в полном квалифицированном пути (т. е. mypackage.backends.whatever).

`HOST`

По умолчанию: '' (Пустая строка)

Используемый хост при подключении к базе данных. Пустая строка означает localhost. Не используется с SQLite.

Если это значение начинается с прямой косой черты ('/') и вы используете MySQL, MySQL подключится через сокет Unix к указанному сокету. Например:

"HOST": '/var/run/mysql'

Если вы используете MySQL и это значение не начинается с прямой косой черты, то это значение предполагается как хост.

Если вы используете PostgreSQL, по умолчанию (пустой HOST) подключение к базе данных выполняется через сокеты доменной области UNIX («локальные» строки в pg_hba.conf). Если ваш сокет доменной области UNIX не в стандартном расположении, используйте то же значение unix_socket_directory из postgresql.conf. Если вы хотите подключиться через TCP-сокеты, установите HOST в «localhost» или «127.0.0.1» («хост» строки в pg_hba.conf). В Windows вы всегда должны определить HOST, так как сокеты доменной области UNIX недоступны.

`NAME`

По умолчанию: '' (Пустая строка)

Имя базы данных для использования. Для SQLite — это полный путь к файлу базы данных. При указании пути всегда используйте прямые косые черты, даже в Windows (например, C:/homes/user/mysite/sqlite3.db).

`CONN_MAX_AGE`

По умолчанию: 0

Время жизни подключения к базе данных в секундах. Используйте 0, чтобы закрывать подключения к базам данных в конце каждого запроса — историческое поведение Django, и None для неограниченных постоянных подключений.

`OPTIONS`

Значение по умолчанию: {} (Пустой словарь)

Дополнительные параметры для использования при подключении к базе данных. Доступные параметры зависят от используемого вами серверного программного обеспечения базы данных.

Некоторую информацию об доступных параметрах можно найти в документации Серверные программные обеспечения баз данных. Для получения дополнительной информации, обратитесь к документации модуля вашего серверного программного обеспечения.

`PASSWORD`

Значение по умолчанию: '' (Пустая строка)

Пароль для использования при подключении к базе данных. Не используется с SQLite.

`PORT`

Значение по умолчанию: '' (Пустая строка)

Порт для использования при подключении к базе данных. Пустая строка означает использование стандартного порта. Не используется с SQLite.

`TIME_ZONE`

Значение по умолчанию: None

Строка, представляющая часовой пояс для дат и времени, хранящихся в этой базе данных (если она не поддерживает часовые пояса) или None. Этот внутренний параметр настройки DATABASES принимает те же значения, что и общий параметр TIME_ZONE.

Это позволяет взаимодействовать с базами данных сторонних разработчиков, которые хранят даты и время в местном времени, а не в UTC. Чтобы избежать проблем, связанных с изменением летнего времени, не следует устанавливать этот параметр для баз данных, управляемых Django.

Когда USE_TZ равен True и база данных не поддерживает часовые пояса (например, SQLite, MySQL, Oracle), Django считывает и записывает даты и время в местном времени согласно этому параметру, если он установлен, и в UTC, если он не установлен.

Когда USE_TZ равен True и база данных поддерживает часовые пояса (например, PostgreSQL), установка этого параметра приводит к ошибке.

Когда USE_TZ равен False, установка этого параметра приводит к ошибке.

`DISABLE_SERVER_SIDE_CURSORS`

Значение по умолчанию: False

Установите это значение в True, если хотите отключить использование курсоров на стороне сервера с QuerySet.iterator(). Пулы транзакций и курсоры на стороне сервера описывает случай использования.

Это параметр, специфичный для PostgreSQL.

`USER`

Значение по умолчанию: '' (Пустая строка)

Имя пользователя для подключения к базе данных. Не используется с SQLite.

`TEST`

Значение по умолчанию: {} (Пустой словарь)

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

Вот пример с конфигурацией тестовой базы данных:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'USER': 'mydatabaseuser',
        'NAME': 'mydatabase',
        'TEST': {
            'NAME': 'mytestdatabase',
        },
    },
}

Следующие ключи в словаре TEST доступны:

`CHARSET`

Значение по умолчанию: None

Кодировка набора символов, используемая для создания тестовой базы данных. Значение этой строки передаётся напрямую в базу данных, поэтому её формат зависит от серверного программного обеспечения.

Поддерживается серверными программными обеспечениями PostgreSQL (postgresql) и MySQL (mysql)

`COLLATION`

Значение по умолчанию: None

Порядок сортировки для использования при создании тестовой базы данных. Это значение передаётся напрямую в серверное программное обеспечение, поэтому его формат зависит от серверного программного обеспечения.

Поддерживается только для серверного программного обеспечения mysql (см. документацию MySQL для получения подробностей).

`DEPENDENCIES`

Значение по умолчанию: ['default'], для всех баз данных, кроме default, которая не имеет зависимостей.

Зависимости в порядке создания базы данных. Для получения подробностей см. документацию о управлении порядком создания тестовых баз данных.

`MIRROR`

Значение по умолчанию: None

Псевдоним базы данных, которую эта база данных должна дублировать во время тестирования.

Этот параметр позволяет тестировать конфигурации мастер-раб (в некоторых базах данных называется мастер-слейв) нескольких баз данных. Для получения подробностей см. документацию о тестировании конфигураций мастер-раб.

`NAME`

Значение по умолчанию: None

Имя базы данных, используемой при выполнении набора тестов.

Если используется значение по умолчанию (None) с движком базы данных SQLite, тесты будут использовать базу данных памяти. Для всех других движков баз данных тестовая база данных будет использовать имя 'test_' + DATABASE_NAME.

См. Тестовая база данных.

`SERIALIZE`

Булево значение, определяющее, сериализует ли стандартный тест-раннер базу данных в строку JSON в памяти перед запуском тестов (используется для восстановления состояния базы данных между тестами, если у вас нет транзакций). Вы можете установить это значение в False для ускорения времени создания, если у вас нет никаких тестовых классов с serialized_rollback=True.

`TEMPLATE`

Это параметр, специфичный для PostgreSQL.

Имя шаблона (например, 'template0'), по которому будет создана тестовая база данных.