Настройки

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

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

Будьте осторожны при перезаписи настроек, особенно когда значение по умолчанию является непустым списком или словарем, например, MIDDLEWARE_CLASSES и 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 и представление вызывает исключение, Django отправит этим людям электронное письмо с полной информацией об исключении. Каждый элемент в списке должен быть кортежем (Полное имя, адрес электронной почты). Пример:

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

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

`ALLOWED_HOSTS`

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

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

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

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]'].

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

В более старых версиях ALLOWED_HOSTS не проверялся, если DEBUG=True. Это также было изменено в Django 1.8.16 для предотвращения атаки DNS rebinding.

ALLOWED_INCLUDE_ROOTS

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

Устарело начиная с версии 1.8: Эта настройка, а также тег шаблона ssi, устарела и будет удалена в Django 1.10.

Вы также можете установить опцию 'allowed_include_roots' в настройке OPTIONS DjangoTemplates бэкенда вместо этого.

Список строк, представляющих разрешенные префиксы для тега шаблона {% ssi %}. Это мера безопасности, чтобы авторы шаблонов не могли получить доступ к файлам, к которым они не должны иметь доступа.

Например, если ALLOWED_INCLUDE_ROOTS равно ['/home/html', '/var/www'], то {% ssi /home/html/foo.txt %} будет работать, но {% ssi /etc/passwd %} — нет.

`APPEND_SLASH`

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

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

Настройка APPEND_SLASH используется только если установлен CommonMiddleware (см. Средствами). См. также 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

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

`CACHE_MIDDLEWARE_KEY_PREFIX`

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

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

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

`CACHE_MIDDLEWARE_SECONDS`

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

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

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

`CSRF_COOKIE_AGE`

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

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

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

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

`CSRF_COOKIE_DOMAIN`

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

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

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

`CSRF_COOKIE_HTTPONLY`

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

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

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

См. SESSION_COOKIE_HTTPONLY для получения подробностей о HttpOnly.

`CSRF_COOKIE_NAME`

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

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

`CSRF_COOKIE_PATH`

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

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

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

`CSRF_COOKIE_SECURE`

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

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

`CSRF_FAILURE_VIEW`

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

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

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

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

`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).

Бэкенд django.db.backends.postgresql называется django.db.backends.postgresql_psycopg2 в более старых версиях. Для обратной совместимости старое имя всё ещё работает в более новых версиях.

`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

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

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

Установка этого параметра требует установки pytz.

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

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

До Django 1.9, бэкенд базы данных PostgreSQL принимал недокументированный параметр TIME_ZONE, что приводило к повреждению данных.

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

`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.