CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="ROBOTS" content="ALL" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="Copyright" content="Django Software Foundation" /> <meta name="keywords" content="Python, Django, framework, open-source" /> <meta name="description" content="" /> <link rel="canonical" href="https://docs.djangoproject.com/en/5.1/ref/settings/"> <link rel="alternate" hreflang="el" href="https://docs.djangoproject.com/el/3.0/ref/settings/"> <link rel="alternate" hreflang="en" href="https://docs.djangoproject.com/en/3.0/ref/settings/"> <link rel="alternate" hreflang="es" href="https://docs.djangoproject.com/es/3.0/ref/settings/"> <link rel="alternate" hreflang="fr" href="https://docs.djangoproject.com/fr/3.0/ref/settings/"> <link rel="alternate" hreflang="id" href="https://docs.djangoproject.com/id/3.0/ref/settings/"> <link rel="alternate" hreflang="ja" href="https://docs.djangoproject.com/ja/3.0/ref/settings/"> <link rel="alternate" hreflang="ko" href="https://docs.djangoproject.com/ko/3.0/ref/settings/"> <link rel="alternate" hreflang="pl" href="https://docs.djangoproject.com/pl/3.0/ref/settings/"> <link rel="alternate" hreflang="pt-br" href="https://docs.djangoproject.com/pt-br/3.0/ref/settings/"> <link rel="alternate" hreflang="zh-hans" href="https://docs.djangoproject.com/zh-hans/3.0/ref/settings/"> <link rel="search" type="application/opensearchdescription+xml" href="https://docs.djangoproject.com/en/3.0/search/description/" title="Django documentation">  <link rel="apple-touch-icon" href="https://static.djangoproject.com/img/icon-touch.e4872c4da341.png"> <link rel="icon" sizes="192x192" href="https://static.djangoproject.com/img/icon-touch.e4872c4da341.png"> <link rel="shortcut icon" href="https://static.djangoproject.com/img/favicon.6dbf28c0650e.ico"> <meta name="msapplication-TileColor" content="#113228"> <meta name="msapplication-TileImage" content="https://static.djangoproject.com/img/icon-tile.b01ac0ef9f67.png"> <meta name="theme-color" content="#0C4B33"> <meta property="og:title" content="Settings | Django documentation" /> <meta property="og:description" content="The web framework for perfectionists with deadlines." /> <meta property="og:image" content="https://static.djangoproject.com/img/logos/django-logo-negative.1d528e2cb5fb.png" /> <meta property="og:image:alt" content="Django logo" /> <meta property="og:image:width" content="1200" /> <meta property="og:image:height" content="546" /> <meta property="og:image:type" content="image/png" /> <meta property="og:url" content="https://docs.djangoproject.com/en/3.0/ref/settings/" /> <meta property="og:site_name" content="Django Project" /> <meta property="twitter:creator" content="djangoproject" /> <meta property="twitter:site" content="djangoproject" /> <meta property="twitter:card" content="summary"> <title>Settings | Django documentation | Django</title> <link rel="stylesheet" href="https://static.djangoproject.com/css/output.fde294a46e8e.css" > <script src="https://static.djangoproject.com/js/lib/webfontloader/webfontloader.e75218f5f090.js"></script> <script> WebFont.load({ custom: { families: ['FontAwesome', 'Fira+Mono'], }, google: { families: ['Roboto:400italic,700italic,300,700,400:latin' ] }, classes: false, events: false, timeout: 1000 }); </script> <script src="https://static.djangoproject.com/js/lib/modernizr.3b36762e418a.js"></script> <script src="https://static.djangoproject.com/js/mod/switch-dark-mode.69777ee87b91.js"></script> </head> <body id="generic" class=""> <div role="banner" id="top"> <div class="container container--flex--wrap--mobile"> <a class="logo" href="https://www.djangoproject.com/">Django</a> The web framework for perfectionists with deadlines. <div class="mobile-toggle"> <button class="theme-toggle"> <div class="visually-hidden theme-label-when-auto">Toggle theme (current theme: auto)</div> <div class="visually-hidden theme-label-when-light">Toggle theme (current theme: light)</div> <div class="visually-hidden theme-label-when-dark">Toggle theme (current theme: dark)</div> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg aria-hidden="true" class="theme-icon-when-auto"> <use xlink:href="#icon-auto" /> </svg> <svg aria-hidden="true" class="theme-icon-when-dark"> <use xlink:href="#icon-moon" /> </svg> <svg aria-hidden="true" class="theme-icon-when-light"> <use xlink:href="#icon-sun" /> </svg> </button> </div> <button class="menu-button"> Menu </button> <div role="navigation"> <ul> <li> <a href="https://www.djangoproject.com/start/overview/">Overview</a> </li> <li> <a href="https://www.djangoproject.com/download/">Download</a> </li> <li class="active"> <a href="https://docs.djangoproject.com/">Documentation</a> </li> <li> <a href="https://www.djangoproject.com/weblog/">News</a> </li> <li> <a href="https://www.djangoproject.com/community/">Community</a> </li> <li> <a href="https://github.com/django/django" target="_blank" rel="noopener">Code</a> </li> <li> <a href="https://code.djangoproject.com/">Issues</a> </li> <li> <a href="https://www.djangoproject.com/foundation/">About</a> </li> <li> <a href="https://www.djangoproject.com/fundraising/">♥ Donate</a> </li> <li> <button class="theme-toggle"> <div class="visually-hidden theme-label-when-auto">Toggle theme (current theme: auto)</div> <div class="visually-hidden theme-label-when-light">Toggle theme (current theme: light)</div> <div class="visually-hidden theme-label-when-dark">Toggle theme (current theme: dark)</div> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg aria-hidden="true" class="theme-icon-when-auto"> <use xlink:href="#icon-auto" /> </svg> <svg aria-hidden="true" class="theme-icon-when-dark"> <use xlink:href="#icon-moon" /> </svg> <svg aria-hidden="true" class="theme-icon-when-light"> <use xlink:href="#icon-sun" /> </svg> </button> </li> </ul> </div> </div> </div> <div class="copy-banner"> <div class="container container--flex container--flex--wrap--mobile "> <h1><a href="https://docs.djangoproject.com/en/3.0/">Documentation</a></h1> <form action="https://docs.djangoproject.com/en/3.0/search/" class="search form-input" role="search"> <label class="visuallyhidden" for="id_q">Search:</label> <input type="search" name="q" placeholder="Search 3.0 documentation" id="id_q"> <button type="submit"> Search </button> </form> </div> </div> <div id="billboard"></div> <div class="container sidebar-right"> <div role="main"> <div id="version-switcher"> <ul id="faq-link"> <li class="current-link"> <a href="https://docs.djangoproject.com/en/3.0/faq/help/"> Getting Help </a> </li> </ul> <ul id="doc-languages" class="language-switcher doc-switcher"> <li class="other"> <a href="https://docs.djangoproject.com/el/3.0/ref/settings/">el</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/es/3.0/ref/settings/">es</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/fr/3.0/ref/settings/">fr</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/id/3.0/ref/settings/">id</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/ja/3.0/ref/settings/">ja</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/ko/3.0/ref/settings/">ko</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/pl/3.0/ref/settings/">pl</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/pt-br/3.0/ref/settings/">pt-br</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/zh-hans/3.0/ref/settings/">zh-hans</a> </li> <li class="current" title="Click on the links on the left to switch to another language."> Language: en </li> </ul> <ul id="doc-versions" class="version-switcher doc-switcher"> <li class="other"> <a href="https://docs.djangoproject.com/en/1.8/ref/settings/">1.8</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/1.10/ref/settings/">1.10</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/1.11/ref/settings/">1.11</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/2.0/ref/settings/">2.0</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/2.1/ref/settings/">2.1</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/2.2/ref/settings/">2.2</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/3.1/ref/settings/">3.1</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/3.2/ref/settings/">3.2</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/4.0/ref/settings/">4.0</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/4.1/ref/settings/">4.1</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/4.2/ref/settings/">4.2</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/5.0/ref/settings/">5.0</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/5.1/ref/settings/">5.1</a> </li> <li class="other"> <a href="https://docs.djangoproject.com/en/dev/ref/settings/">dev</a> </li> <li class="current" title="This document describes Django 3.0. Click on the links on the left to see other versions."> Documentation version: 3.0 </li> </ul> <ul id="backtotop-link"> <li class="current-link"> <a href="#top" aria-label="Back to top" class="icon-chevron-up-align"></a> </li> </ul> </div> <div id="docs-content"> <div class="section" id="s-settings"> <h1>Settings<a class="headerlink" href="#settings" title="Permalink to this headline">¶</a></h1> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#core-settings" id="id12">Core Settings</a></li> <li><a class="reference internal" href="#auth" id="id13">Auth</a></li> <li><a class="reference internal" href="#messages" id="id14">Messages</a></li> <li><a class="reference internal" href="#sessions" id="id15">Sessions</a></li> <li><a class="reference internal" href="#sites" id="id16">Sites</a></li> <li><a class="reference internal" href="#static-files" id="id17">Static Files</a></li> <li><a class="reference internal" href="#core-settings-topical-index" id="id18">Core Settings Topical Index</a></li> </ul> </div> <div class="admonition warning"> Warning Be careful when you override settings, especially when the default value is a non-empty list or dictionary, such as <a class="reference internal" href="#std:setting-STATICFILES_FINDERS"><code class="xref std std-setting docutils literal notranslate">STATICFILES_FINDERS</code></a>. Make sure you keep the components required by the features of Django you wish to use. </div> <div class="section" id="s-core-settings"> <h2><a class="toc-backref" href="#id12">Core Settings</a><a class="headerlink" href="#core-settings" title="Permalink to this headline">¶</a></h2> Here’s a list of settings available in Django core and their default values. Settings provided by contrib apps are listed below, followed by a topical index of the core settings. For introductory material, see the <a class="reference internal" href="../../topics/settings/">settings topic guide</a>. <div class="section" id="s-absolute-url-overrides"> <h3><code class="docutils literal notranslate">ABSOLUTE_URL_OVERRIDES</code><a class="headerlink" href="#absolute-url-overrides" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">{}</code> (Empty dictionary) A dictionary mapping <code class="docutils literal notranslate">"app_label.model_name"</code> strings to functions that take a model object and return its URL. This is a way of inserting or overriding <code class="docutils literal notranslate">get_absolute_url()</code> methods on a per-installation basis. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>ABSOLUTE_URL_OVERRIDES = { 'blogs.weblog': lambda o: "/blogs/%s/" % o.slug, 'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug), } </pre></div> </div> The model name used in this setting should be all lowercase, regardless of the case of the actual model class name. </div> <div class="section" id="s-admins"> <h3><code class="docutils literal notranslate">ADMINS</code><a class="headerlink" href="#admins" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of all the people who get code error notifications. When <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG=False</code></a> and <a class="reference internal" href="../../topics/logging/#django.utils.log.AdminEmailHandler" title="django.utils.log.AdminEmailHandler"><code class="xref py py-class docutils literal notranslate">AdminEmailHandler</code></a> is configured in <a class="reference internal" href="#std:setting-LOGGING"><code class="xref std std-setting docutils literal notranslate">LOGGING</code></a> (done by default), Django emails these people the details of exceptions raised in the request/response cycle. Each item in the list should be a tuple of (Full name, email address). Example: <div class="highlight-default notranslate"><div class="highlight"><pre>[('John', 'john@example.com'), ('Mary', 'mary@example.com')] </pre></div> </div> </div> <div class="section" id="s-allowed-hosts"> <h3><code class="docutils literal notranslate">ALLOWED_HOSTS</code><a class="headerlink" href="#allowed-hosts" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of strings representing the host/domain names that this Django site can serve. This is a security measure to prevent <a class="reference internal" href="../../topics/security/#host-headers-virtual-hosting">HTTP Host header attacks</a>, which are possible even under many seemingly-safe web server configurations. Values in this list can be fully qualified names (e.g. <code class="docutils literal notranslate">'www.example.com'</code>), in which case they will be matched against the request’s <code class="docutils literal notranslate">Host</code> header exactly (case-insensitive, not including port). A value beginning with a period can be used as a subdomain wildcard: <code class="docutils literal notranslate">'.example.com'</code> will match <code class="docutils literal notranslate">example.com</code>, <code class="docutils literal notranslate">www.example.com</code>, and any other subdomain of <code class="docutils literal notranslate">example.com</code>. A value of <code class="docutils literal notranslate">'*'</code> will match anything; in this case you are responsible to provide your own validation of the <code class="docutils literal notranslate">Host</code> header (perhaps in a middleware; if so this middleware must be listed first in <a class="reference internal" href="#std:setting-MIDDLEWARE"><code class="xref std std-setting docutils literal notranslate">MIDDLEWARE</code></a>). Django also allows the <a class="reference external" href="https://en.wikipedia.org/wiki/Fully_qualified_domain_name">fully qualified domain name (FQDN)</a> of any entries. Some browsers include a trailing dot in the <code class="docutils literal notranslate">Host</code> header which Django strips when performing host validation. If the <code class="docutils literal notranslate">Host</code> header (or <code class="docutils literal notranslate">X-Forwarded-Host</code> if <a class="reference internal" href="#std:setting-USE_X_FORWARDED_HOST"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_HOST</code></a> is enabled) does not match any value in this list, the <a class="reference internal" href="../request-response/#django.http.HttpRequest.get_host" title="django.http.HttpRequest.get_host"><code class="xref py py-meth docutils literal notranslate">django.http.HttpRequest.get_host()</code></a> method will raise <a class="reference internal" href="../exceptions/#django.core.exceptions.SuspiciousOperation" title="django.core.exceptions.SuspiciousOperation"><code class="xref py py-exc docutils literal notranslate">SuspiciousOperation</code></a>. When <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> is <code class="docutils literal notranslate">True</code> and <code class="docutils literal notranslate">ALLOWED_HOSTS</code> is empty, the host is validated against <code class="docutils literal notranslate">['localhost', '127.0.0.1', '[::1]']</code>. <code class="docutils literal notranslate">ALLOWED_HOSTS</code> is also <a class="reference internal" href="../../topics/testing/advanced/#topics-testing-advanced-multiple-hosts">checked when running tests</a>. This validation only applies via <a class="reference internal" href="../request-response/#django.http.HttpRequest.get_host" title="django.http.HttpRequest.get_host"><code class="xref py py-meth docutils literal notranslate">get_host()</code></a>; if your code accesses the <code class="docutils literal notranslate">Host</code> header directly from <code class="docutils literal notranslate">request.META</code> you are bypassing this security protection. </div> <div class="section" id="s-append-slash"> <h3><code class="docutils literal notranslate">APPEND_SLASH</code><a class="headerlink" href="#append-slash" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">True</code> When set to <code class="docutils literal notranslate">True</code>, if the request URL does not match any of the patterns in the URLconf and it doesn’t end in a slash, an HTTP redirect is issued to the same URL with a slash appended. Note that the redirect may cause any data submitted in a POST request to be lost. The <a class="reference internal" href="#std:setting-APPEND_SLASH"><code class="xref std std-setting docutils literal notranslate">APPEND_SLASH</code></a> setting is only used if <a class="reference internal" href="../middleware/#django.middleware.common.CommonMiddleware" title="django.middleware.common.CommonMiddleware"><code class="xref py py-class docutils literal notranslate">CommonMiddleware</code></a> is installed (see <a class="reference internal" href="../../topics/http/middleware/">Middleware</a>). See also <a class="reference internal" href="#std:setting-PREPEND_WWW"><code class="xref std std-setting docutils literal notranslate">PREPEND_WWW</code></a>. </div> <div class="section" id="s-caches"> <h3><code class="docutils literal notranslate">CACHES</code><a class="headerlink" href="#caches" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>{ 'default': { 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', } } </pre></div> </div> A dictionary containing the settings for all caches to be used with Django. It is a nested dictionary whose contents maps cache aliases to a dictionary containing the options for an individual cache. The <a class="reference internal" href="#std:setting-CACHES"><code class="xref std std-setting docutils literal notranslate">CACHES</code></a> setting must configure a <code class="docutils literal notranslate">default</code> cache; any number of additional caches may also be specified. If you are using a cache backend other than the local memory cache, or you need to define multiple caches, other options will be required. The following cache options are available. <div class="section" id="s-backend"> <h4><code class="docutils literal notranslate">BACKEND</code><a class="headerlink" href="#backend" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The cache backend to use. The built-in cache backends are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.core.cache.backends.db.DatabaseCache'</code></li> <li><code class="docutils literal notranslate">'django.core.cache.backends.dummy.DummyCache'</code></li> <li><code class="docutils literal notranslate">'django.core.cache.backends.filebased.FileBasedCache'</code></li> <li><code class="docutils literal notranslate">'django.core.cache.backends.locmem.LocMemCache'</code></li> <li><code class="docutils literal notranslate">'django.core.cache.backends.memcached.MemcachedCache'</code></li> <li><code class="docutils literal notranslate">'django.core.cache.backends.memcached.PyLibMCCache'</code></li> </ul> You can use a cache backend that doesn’t ship with Django by setting <a class="reference internal" href="#std:setting-CACHES-BACKEND"><code class="xref std std-setting docutils literal notranslate">BACKEND</code></a> to a fully-qualified path of a cache backend class (i.e. <code class="docutils literal notranslate">mypackage.backends.whatever.WhateverCache</code>). </div> <div class="section" id="s-key-function"> <h4><code class="docutils literal notranslate">KEY_FUNCTION</code><a class="headerlink" href="#key-function" title="Permalink to this headline">¶</a></h4> A string containing a dotted path to a function (or any callable) that defines how to compose a prefix, version and key into a final cache key. The default implementation is equivalent to the function: <div class="highlight-default notranslate"><div class="highlight"><pre>def make_key(key, key_prefix, version): return ':'.join([key_prefix, str(version), key]) </pre></div> </div> You may use any key function you want, as long as it has the same argument signature. See the <a class="reference internal" href="../../topics/cache/#cache-key-transformation">cache documentation</a> for more information. </div> <div class="section" id="s-key-prefix"> <h4><code class="docutils literal notranslate">KEY_PREFIX</code><a class="headerlink" href="#key-prefix" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) A string that will be automatically included (prepended by default) to all cache keys used by the Django server. See the <a class="reference internal" href="../../topics/cache/#cache-key-prefixing">cache documentation</a> for more information. </div> <div class="section" id="s-location"> <h4><code class="docutils literal notranslate">LOCATION</code><a class="headerlink" href="#location" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The location of the cache to use. This might be the directory for a file system cache, a host and port for a memcache server, or an identifying name for a local memory cache. e.g.: <div class="highlight-default notranslate"><div class="highlight"><pre>CACHES = { 'default': { 'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache', 'LOCATION': '/var/tmp/django_cache', } } </pre></div> </div> </div> <div class="section" id="s-options"> <h4><code class="docutils literal notranslate">OPTIONS</code><a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">None</code> Extra parameters to pass to the cache backend. Available parameters vary depending on your cache backend. Some information on available parameters can be found in the <a class="reference internal" href="../../topics/cache/#cache-arguments">cache arguments</a> documentation. For more information, consult your backend module’s own documentation. </div> <div class="section" id="s-timeout"> <h4><code class="docutils literal notranslate">TIMEOUT</code><a class="headerlink" href="#timeout" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">300</code> The number of seconds before a cache entry is considered stale. If the value of this settings is <code class="docutils literal notranslate">None</code>, cache entries will not expire. </div> <div class="section" id="s-version"> <h4><code class="docutils literal notranslate">VERSION</code><a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">1</code> The default version number for cache keys generated by the Django server. See the <a class="reference internal" href="../../topics/cache/#cache-versioning">cache documentation</a> for more information. </div> </div> <div class="section" id="s-cache-middleware-alias"> <h3><code class="docutils literal notranslate">CACHE_MIDDLEWARE_ALIAS</code><a class="headerlink" href="#cache-middleware-alias" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'default'</code> The cache connection to use for the <a class="reference internal" href="../../topics/cache/#the-per-site-cache">cache middleware</a>. </div> <div class="section" id="s-cache-middleware-key-prefix"> <h3><code class="docutils literal notranslate">CACHE_MIDDLEWARE_KEY_PREFIX</code><a class="headerlink" href="#cache-middleware-key-prefix" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) A string which will be prefixed to the cache keys generated by the <a class="reference internal" href="../../topics/cache/#the-per-site-cache">cache middleware</a>. This prefix is combined with the <a class="reference internal" href="#std:setting-CACHES-KEY_PREFIX"><code class="xref std std-setting docutils literal notranslate">KEY_PREFIX</code></a> setting; it does not replace it. See <a class="reference internal" href="../../topics/cache/">Django’s cache framework</a>. </div> <div class="section" id="s-cache-middleware-seconds"> <h3><code class="docutils literal notranslate">CACHE_MIDDLEWARE_SECONDS</code><a class="headerlink" href="#cache-middleware-seconds" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">600</code> The default number of seconds to cache a page for the <a class="reference internal" href="../../topics/cache/#the-per-site-cache">cache middleware</a>. See <a class="reference internal" href="../../topics/cache/">Django’s cache framework</a>. </div> <div class="section" id="s-csrf-cookie-age"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_AGE</code><a class="headerlink" href="#csrf-cookie-age" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">31449600</code> (approximately 1 year, in seconds) The age of CSRF cookies, in seconds. The reason for setting a long-lived expiration time is to avoid problems in the case of a user closing a browser or bookmarking a page and then loading that page from a browser cache. Without persistent cookies, the form submission would fail in this case. Some browsers (specifically Internet Explorer) can disallow the use of persistent cookies or can have the indexes to the cookie jar corrupted on disk, thereby causing CSRF protection checks to (sometimes intermittently) fail. Change this setting to <code class="docutils literal notranslate">None</code> to use session-based CSRF cookies, which keep the cookies in-memory instead of on persistent storage. </div> <div class="section" id="s-csrf-cookie-domain"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_DOMAIN</code><a class="headerlink" href="#csrf-cookie-domain" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The domain to be used when setting the CSRF cookie. This can be useful for easily allowing cross-subdomain requests to be excluded from the normal cross site request forgery protection. It should be set to a string such as <code class="docutils literal notranslate">"example.com"</code> to allow a POST request from a form on one subdomain to be accepted by a view served from another subdomain. Please note that the presence of this setting does not imply that Django’s CSRF protection is safe from cross-subdomain attacks by default - please see the <a class="reference internal" href="../csrf/#csrf-limitations">CSRF limitations</a> section. </div> <div class="section" id="s-csrf-cookie-httponly"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_HTTPONLY</code><a class="headerlink" href="#csrf-cookie-httponly" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to use <code class="docutils literal notranslate">HttpOnly</code> flag on the CSRF cookie. If this is set to <code class="docutils literal notranslate">True</code>, client-side JavaScript will not be able to access the CSRF cookie. Designating the CSRF cookie as <code class="docutils literal notranslate">HttpOnly</code> doesn’t offer any practical protection because CSRF is only to protect against cross-domain attacks. If an attacker can read the cookie via JavaScript, they’re already on the same domain as far as the browser knows, so they can do anything they like anyway. (XSS is a much bigger hole than CSRF.) Although the setting offers little practical benefit, it’s sometimes required by security auditors. If you enable this and need to send the value of the CSRF token with an AJAX request, your JavaScript must pull the value <a class="reference internal" href="../csrf/#acquiring-csrf-token-from-html">from a hidden CSRF token form input</a> instead of <a class="reference internal" href="../csrf/#acquiring-csrf-token-from-cookie">from the cookie</a>. See <a class="reference internal" href="#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_HTTPONLY</code></a> for details on <code class="docutils literal notranslate">HttpOnly</code>. </div> <div class="section" id="s-csrf-cookie-name"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_NAME</code><a class="headerlink" href="#csrf-cookie-name" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'csrftoken'</code> The name of the cookie to use for the CSRF authentication token. This can be whatever you want (as long as it’s different from the other cookie names in your application). See <a class="reference internal" href="../csrf/">Cross Site Request Forgery protection</a>. </div> <div class="section" id="s-csrf-cookie-path"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_PATH</code><a class="headerlink" href="#csrf-cookie-path" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'/'</code> The path set on the CSRF cookie. This should either match the URL path of your Django installation or be a parent of that path. This is useful if you have multiple Django instances running under the same hostname. They can use different cookie paths, and each instance will only see its own CSRF cookie. </div> <div class="section" id="s-csrf-cookie-samesite"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_SAMESITE</code><a class="headerlink" href="#csrf-cookie-samesite" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'Lax'</code> The value of the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite">SameSite</a> flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. See <a class="reference internal" href="#std:setting-SESSION_COOKIE_SAMESITE"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_SAMESITE</code></a> for details about <code class="docutils literal notranslate">SameSite</code>. </div> <div class="section" id="s-csrf-cookie-secure"> <h3><code class="docutils literal notranslate">CSRF_COOKIE_SECURE</code><a class="headerlink" href="#csrf-cookie-secure" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to use a secure cookie for the CSRF cookie. If this is set to <code class="docutils literal notranslate">True</code>, the cookie will be marked as “secure”, which means browsers may ensure that the cookie is only sent with an HTTPS connection. </div> <div class="section" id="s-csrf-use-sessions"> <h3><code class="docutils literal notranslate">CSRF_USE_SESSIONS</code><a class="headerlink" href="#csrf-use-sessions" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to store the CSRF token in the user’s session instead of in a cookie. It requires the use of <a class="reference internal" href="../../topics/http/sessions/#module-django.contrib.sessions" title="django.contrib.sessions: Provides session management for Django projects."><code class="xref py py-mod docutils literal notranslate">django.contrib.sessions</code></a>. Storing the CSRF token in a cookie (Django’s default) is safe, but storing it in the session is common practice in other web frameworks and therefore sometimes demanded by security auditors. Since the <a class="reference internal" href="../views/#error-views">default error views</a> require the CSRF token, <a class="reference internal" href="../middleware/#django.contrib.sessions.middleware.SessionMiddleware" title="django.contrib.sessions.middleware.SessionMiddleware"><code class="xref py py-class docutils literal notranslate">SessionMiddleware</code></a> must appear in <a class="reference internal" href="#std:setting-MIDDLEWARE"><code class="xref std std-setting docutils literal notranslate">MIDDLEWARE</code></a> before any middleware that may raise an exception to trigger an error view (such as <a class="reference internal" href="../exceptions/#django.core.exceptions.PermissionDenied" title="django.core.exceptions.PermissionDenied"><code class="xref py py-exc docutils literal notranslate">PermissionDenied</code></a>) if you’re using <code class="docutils literal notranslate">CSRF_USE_SESSIONS</code>. See <a class="reference internal" href="../middleware/#middleware-ordering">Middleware ordering</a>. </div> <div class="section" id="s-csrf-failure-view"> <h3><code class="docutils literal notranslate">CSRF_FAILURE_VIEW</code><a class="headerlink" href="#csrf-failure-view" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.views.csrf.csrf_failure'</code> A dotted path to the view function to be used when an incoming request is rejected by the <a class="reference internal" href="../csrf/">CSRF protection</a>. The function should have this signature: <div class="highlight-default notranslate"><div class="highlight"><pre>def csrf_failure(request, reason=""): ... </pre></div> </div> where <code class="docutils literal notranslate">reason</code> is a short message (intended for developers or logging, not for end users) indicating the reason the request was rejected. It should return an <a class="reference internal" href="../request-response/#django.http.HttpResponseForbidden" title="django.http.HttpResponseForbidden"><code class="xref py py-class docutils literal notranslate">HttpResponseForbidden</code></a>. <code class="docutils literal notranslate">django.views.csrf.csrf_failure()</code> accepts an additional <code class="docutils literal notranslate">template_name</code> parameter that defaults to <code class="docutils literal notranslate">'403_csrf.html'</code>. If a template with that name exists, it will be used to render the page. </div> <div class="section" id="s-csrf-header-name"> <h3><code class="docutils literal notranslate">CSRF_HEADER_NAME</code><a class="headerlink" href="#csrf-header-name" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'HTTP_X_CSRFTOKEN'</code> The name of the request header used for CSRF authentication. As with other HTTP headers in <code class="docutils literal notranslate">request.META</code>, the header name received from the server is normalized by converting all characters to uppercase, replacing any hyphens with underscores, and adding an <code class="docutils literal notranslate">'HTTP_'</code> prefix to the name. For example, if your client sends a <code class="docutils literal notranslate">'X-XSRF-TOKEN'</code> header, the setting should be <code class="docutils literal notranslate">'HTTP_X_XSRF_TOKEN'</code>. </div> <div class="section" id="s-csrf-trusted-origins"> <h3><code class="docutils literal notranslate">CSRF_TRUSTED_ORIGINS</code><a class="headerlink" href="#csrf-trusted-origins" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of hosts which are trusted origins for unsafe requests (e.g. <code class="docutils literal notranslate">POST</code>). For a <a class="reference internal" href="../request-response/#django.http.HttpRequest.is_secure" title="django.http.HttpRequest.is_secure"><code class="xref py py-meth docutils literal notranslate">secure</code></a> unsafe request, Django’s CSRF protection requires that the request have a <code class="docutils literal notranslate">Referer</code> header that matches the origin present in the <code class="docutils literal notranslate">Host</code> header. This prevents, for example, a <code class="docutils literal notranslate">POST</code> request from <code class="docutils literal notranslate">subdomain.example.com</code> from succeeding against <code class="docutils literal notranslate">api.example.com</code>. If you need cross-origin unsafe requests over HTTPS, continuing the example, add <code class="docutils literal notranslate">"subdomain.example.com"</code> to this list. The setting also supports subdomains, so you could add <code class="docutils literal notranslate">".example.com"</code>, for example, to allow access from all subdomains of <code class="docutils literal notranslate">example.com</code>. </div> <div class="section" id="s-databases"> <h3><code class="docutils literal notranslate">DATABASES</code><a class="headerlink" href="#databases" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">{}</code> (Empty dictionary) A dictionary containing the settings for all databases to be used with Django. It is a nested dictionary whose contents map a database alias to a dictionary containing the options for an individual database. The <a class="reference internal" href="#std:setting-DATABASES"><code class="xref std std-setting docutils literal notranslate">DATABASES</code></a> setting must configure a <code class="docutils literal notranslate">default</code> database; any number of additional databases may also be specified. The simplest possible settings file is for a single-database setup using SQLite. This can be configured using the following: <div class="highlight-default notranslate"><div class="highlight"><pre>DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': 'mydatabase', } } </pre></div> </div> When connecting to other database backends, such as MariaDB, MySQL, Oracle, or PostgreSQL, additional connection parameters will be required. See the <a class="reference internal" href="#std:setting-DATABASE-ENGINE"><code class="xref std std-setting docutils literal notranslate">ENGINE</code></a> setting below on how to specify other database types. This example is for PostgreSQL: <div class="highlight-default notranslate"><div class="highlight"><pre>DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'NAME': 'mydatabase', 'USER': 'mydatabaseuser', 'PASSWORD': 'mypassword', 'HOST': '127.0.0.1', 'PORT': '5432', } } </pre></div> </div> The following inner options that may be required for more complex configurations are available: <div class="section" id="s-atomic-requests"> <h4><code class="docutils literal notranslate">ATOMIC_REQUESTS</code><a class="headerlink" href="#atomic-requests" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">False</code> Set this to <code class="docutils literal notranslate">True</code> to wrap each view in a transaction on this database. See <a class="reference internal" href="../../topics/db/transactions/#tying-transactions-to-http-requests">Tying transactions to HTTP requests</a>. </div> <div class="section" id="s-autocommit"> <h4><code class="docutils literal notranslate">AUTOCOMMIT</code><a class="headerlink" href="#autocommit" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">True</code> Set this to <code class="docutils literal notranslate">False</code> if you want to <a class="reference internal" href="../../topics/db/transactions/#deactivate-transaction-management">disable Django’s transaction management</a> and implement your own. </div> <div class="section" id="s-engine"> <h4><code class="docutils literal notranslate">ENGINE</code><a class="headerlink" href="#engine" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The database backend to use. The built-in database backends are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.db.backends.postgresql'</code></li> <li><code class="docutils literal notranslate">'django.db.backends.mysql'</code></li> <li><code class="docutils literal notranslate">'django.db.backends.sqlite3'</code></li> <li><code class="docutils literal notranslate">'django.db.backends.oracle'</code></li> </ul> You can use a database backend that doesn’t ship with Django by setting <code class="docutils literal notranslate">ENGINE</code> to a fully-qualified path (i.e. <code class="docutils literal notranslate">mypackage.backends.whatever</code>). </div> <div class="section" id="s-host"> <h4><code class="docutils literal notranslate">HOST</code><a class="headerlink" href="#host" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) Which host to use when connecting to the database. An empty string means localhost. Not used with SQLite. If this value starts with a forward slash (<code class="docutils literal notranslate">'/'</code>) and you’re using MySQL, MySQL will connect via a Unix socket to the specified socket. For example: <div class="highlight-default notranslate"><div class="highlight"><pre>"HOST": '/var/run/mysql' </pre></div> </div> If you’re using MySQL and this value doesn’t start with a forward slash, then this value is assumed to be the host. If you’re using PostgreSQL, by default (empty <a class="reference internal" href="#std:setting-HOST"><code class="xref std std-setting docutils literal notranslate">HOST</code></a>), the connection to the database is done through UNIX domain sockets (‘local’ lines in <code class="docutils literal notranslate">pg_hba.conf</code>). If your UNIX domain socket is not in the standard location, use the same value of <code class="docutils literal notranslate">unix_socket_directory</code> from <code class="docutils literal notranslate">postgresql.conf</code>. If you want to connect through TCP sockets, set <a class="reference internal" href="#std:setting-HOST"><code class="xref std std-setting docutils literal notranslate">HOST</code></a> to ‘localhost’ or ‘127.0.0.1’ (‘host’ lines in <code class="docutils literal notranslate">pg_hba.conf</code>). On Windows, you should always define <a class="reference internal" href="#std:setting-HOST"><code class="xref std std-setting docutils literal notranslate">HOST</code></a>, as UNIX domain sockets are not available. </div> <div class="section" id="s-name"> <h4><code class="docutils literal notranslate">NAME</code><a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The name of the database to use. For SQLite, it’s the full path to the database file. When specifying the path, always use forward slashes, even on Windows (e.g. <code class="docutils literal notranslate">C:/homes/user/mysite/sqlite3.db</code>). </div> <div class="section" id="s-conn-max-age"> <h4><code class="docutils literal notranslate">CONN_MAX_AGE</code><a class="headerlink" href="#conn-max-age" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">0</code> The lifetime of a database connection, as an integer of seconds. Use <code class="docutils literal notranslate">0</code> to close database connections at the end of each request — Django’s historical behavior — and <code class="docutils literal notranslate">None</code> for unlimited persistent connections. </div> <div class="section" id="s-std:setting-OPTIONS"> <h4><code class="docutils literal notranslate">OPTIONS</code><a class="headerlink" href="#std:setting-OPTIONS" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">{}</code> (Empty dictionary) Extra parameters to use when connecting to the database. Available parameters vary depending on your database backend. Some information on available parameters can be found in the <a class="reference internal" href="../databases/">Database Backends</a> documentation. For more information, consult your backend module’s own documentation. </div> <div class="section" id="s-password"> <h4><code class="docutils literal notranslate">PASSWORD</code><a class="headerlink" href="#password" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The password to use when connecting to the database. Not used with SQLite. </div> <div class="section" id="s-port"> <h4><code class="docutils literal notranslate">PORT</code><a class="headerlink" href="#port" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The port to use when connecting to the database. An empty string means the default port. Not used with SQLite. </div> <div class="section" id="s-time-zone"> <h4><code class="docutils literal notranslate">TIME_ZONE</code><a class="headerlink" href="#time-zone" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">None</code> A string representing the time zone for datetimes stored in this database (assuming that it doesn’t support time zones) or <code class="docutils literal notranslate">None</code>. This inner option of the <a class="reference internal" href="#std:setting-DATABASES"><code class="xref std std-setting docutils literal notranslate">DATABASES</code></a> setting accepts the same values as the general <a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a> setting. This allows interacting with third-party databases that store datetimes in local time rather than UTC. To avoid issues around DST changes, you shouldn’t set this option for databases managed by Django. When <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a> is <code class="docutils literal notranslate">True</code> and the database doesn’t support time zones (e.g. SQLite, MySQL, Oracle), Django reads and writes datetimes in local time according to this option if it is set and in UTC if it isn’t. When <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a> is <code class="docutils literal notranslate">True</code> and the database supports time zones (e.g. PostgreSQL), it is an error to set this option. When <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a> is <code class="docutils literal notranslate">False</code>, it is an error to set this option. </div> <div class="section" id="s-disable-server-side-cursors"> <h4><code class="docutils literal notranslate">DISABLE_SERVER_SIDE_CURSORS</code><a class="headerlink" href="#disable-server-side-cursors" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">False</code> Set this to <code class="docutils literal notranslate">True</code> if you want to disable the use of server-side cursors with <a class="reference internal" href="../models/querysets/#django.db.models.query.QuerySet.iterator" title="django.db.models.query.QuerySet.iterator"><code class="xref py py-meth docutils literal notranslate">QuerySet.iterator()</code></a>. <a class="reference internal" href="../databases/#transaction-pooling-server-side-cursors">Transaction pooling and server-side cursors</a> describes the use case. This is a PostgreSQL-specific setting. </div> <div class="section" id="s-user"> <h4><code class="docutils literal notranslate">USER</code><a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">''</code> (Empty string) The username to use when connecting to the database. Not used with SQLite. </div> <div class="section" id="s-test"> <h4><code class="docutils literal notranslate">TEST</code><a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">{}</code> (Empty dictionary) A dictionary of settings for test databases; for more details about the creation and use of test databases, see <a class="reference internal" href="../../topics/testing/overview/#the-test-database">The test database</a>. Here’s an example with a test database configuration: <div class="highlight-default notranslate"><div class="highlight"><pre>DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'USER': 'mydatabaseuser', 'NAME': 'mydatabase', 'TEST': { 'NAME': 'mytestdatabase', }, }, } </pre></div> </div> The following keys in the <code class="docutils literal notranslate">TEST</code> dictionary are available: <div class="section" id="s-charset"> <h5><code class="docutils literal notranslate">CHARSET</code><a class="headerlink" href="#charset" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> The character set encoding used to create the test database. The value of this string is passed directly through to the database, so its format is backend-specific. Supported by the <a class="reference external" href="https://www.postgresql.org/docs/current/multibyte.html">PostgreSQL</a> (<code class="docutils literal notranslate">postgresql</code>) and <a class="reference external" href="https://dev.mysql.com/doc/refman/en/charset-charsets.html">MySQL</a> (<code class="docutils literal notranslate">mysql</code>) backends. </div> <div class="section" id="s-collation"> <h5><code class="docutils literal notranslate">COLLATION</code><a class="headerlink" href="#collation" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> The collation order to use when creating the test database. This value is passed directly to the backend, so its format is backend-specific. Only supported for the <code class="docutils literal notranslate">mysql</code> backend (see the <a class="reference external" href="https://dev.mysql.com/doc/refman/en/charset-charsets.html">MySQL manual</a> for details). </div> <div class="section" id="s-dependencies"> <h5><code class="docutils literal notranslate">DEPENDENCIES</code><a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">['default']</code>, for all databases other than <code class="docutils literal notranslate">default</code>, which has no dependencies. The creation-order dependencies of the database. See the documentation on <a class="reference internal" href="../../topics/testing/advanced/#topics-testing-creation-dependencies">controlling the creation order of test databases</a> for details. </div> <div class="section" id="s-mirror"> <h5><code class="docutils literal notranslate">MIRROR</code><a class="headerlink" href="#mirror" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> The alias of the database that this database should mirror during testing. This setting exists to allow for testing of primary/replica (referred to as master/slave by some databases) configurations of multiple databases. See the documentation on <a class="reference internal" href="../../topics/testing/advanced/#topics-testing-primaryreplica">testing primary/replica configurations</a> for details. </div> <div class="section" id="s-std:setting-TEST_NAME"> <h5><code class="docutils literal notranslate">NAME</code><a class="headerlink" href="#std:setting-TEST_NAME" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> The name of database to use when running the test suite. If the default value (<code class="docutils literal notranslate">None</code>) is used with the SQLite database engine, the tests will use a memory resident database. For all other database engines the test database will use the name <code class="docutils literal notranslate">'test_' + DATABASE_NAME</code>. See <a class="reference internal" href="../../topics/testing/overview/#the-test-database">The test database</a>. </div> <div class="section" id="s-serialize"> <h5><code class="docutils literal notranslate">SERIALIZE</code><a class="headerlink" href="#serialize" title="Permalink to this headline">¶</a></h5> Boolean value to control whether or not the default test runner serializes the database into an in-memory JSON string before running tests (used to restore the database state between tests if you don’t have transactions). You can set this to <code class="docutils literal notranslate">False</code> to speed up creation time if you don’t have any test classes with <a class="reference internal" href="../../topics/testing/overview/#test-case-serialized-rollback">serialized_rollback=True</a>. </div> <div class="section" id="s-template"> <h5><code class="docutils literal notranslate">TEMPLATE</code><a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h5> This is a PostgreSQL-specific setting. The name of a <a class="reference external" href="https://www.postgresql.org/docs/current/sql-createdatabase.html">template</a> (e.g. <code class="docutils literal notranslate">'template0'</code>) from which to create the test database. </div> <div class="section" id="s-create-db"> <h5><code class="docutils literal notranslate">CREATE_DB</code><a class="headerlink" href="#create-db" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">True</code> This is an Oracle-specific setting. If it is set to <code class="docutils literal notranslate">False</code>, the test tablespaces won’t be automatically created at the beginning of the tests or dropped at the end. </div> <div class="section" id="s-create-user"> <h5><code class="docutils literal notranslate">CREATE_USER</code><a class="headerlink" href="#create-user" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">True</code> This is an Oracle-specific setting. If it is set to <code class="docutils literal notranslate">False</code>, the test user won’t be automatically created at the beginning of the tests and dropped at the end. </div> <div class="section" id="s-std:setting-TEST_USER"> <h5><code class="docutils literal notranslate">USER</code><a class="headerlink" href="#std:setting-TEST_USER" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The username to use when connecting to the Oracle database that will be used when running tests. If not provided, Django will use <code class="docutils literal notranslate">'test_' + USER</code>. </div> <div class="section" id="s-std:setting-TEST_PASSWD"> <h5><code class="docutils literal notranslate">PASSWORD</code><a class="headerlink" href="#std:setting-TEST_PASSWD" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The password to use when connecting to the Oracle database that will be used when running tests. If not provided, Django will generate a random password. </div> <div class="section" id="s-oracle-managed-files"> <h5><code class="docutils literal notranslate">ORACLE_MANAGED_FILES</code><a class="headerlink" href="#oracle-managed-files" title="Permalink to this headline">¶</a></h5> <div class="versionadded"> New in Django 2.2. </div> Default: <code class="docutils literal notranslate">False</code> This is an Oracle-specific setting. If set to <code class="docutils literal notranslate">True</code>, Oracle Managed Files (OMF) tablespaces will be used. <a class="reference internal" href="#std:setting-DATAFILE"><code class="xref std std-setting docutils literal notranslate">DATAFILE</code></a> and <a class="reference internal" href="#std:setting-DATAFILE_TMP"><code class="xref std std-setting docutils literal notranslate">DATAFILE_TMP</code></a> will be ignored. </div> <div class="section" id="s-tblspace"> <h5><code class="docutils literal notranslate">TBLSPACE</code><a class="headerlink" href="#tblspace" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The name of the tablespace that will be used when running tests. If not provided, Django will use <code class="docutils literal notranslate">'test_' + USER</code>. </div> <div class="section" id="s-tblspace-tmp"> <h5><code class="docutils literal notranslate">TBLSPACE_TMP</code><a class="headerlink" href="#tblspace-tmp" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The name of the temporary tablespace that will be used when running tests. If not provided, Django will use <code class="docutils literal notranslate">'test_' + USER + '_temp'</code>. </div> <div class="section" id="s-datafile"> <h5><code class="docutils literal notranslate">DATAFILE</code><a class="headerlink" href="#datafile" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The name of the datafile to use for the TBLSPACE. If not provided, Django will use <code class="docutils literal notranslate">TBLSPACE + '.dbf'</code>. </div> <div class="section" id="s-datafile-tmp"> <h5><code class="docutils literal notranslate">DATAFILE_TMP</code><a class="headerlink" href="#datafile-tmp" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">None</code> This is an Oracle-specific setting. The name of the datafile to use for the TBLSPACE_TMP. If not provided, Django will use <code class="docutils literal notranslate">TBLSPACE_TMP + '.dbf'</code>. </div> <div class="section" id="s-datafile-maxsize"> <h5><code class="docutils literal notranslate">DATAFILE_MAXSIZE</code><a class="headerlink" href="#datafile-maxsize" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'500M'</code> This is an Oracle-specific setting. The maximum size that the DATAFILE is allowed to grow to. </div> <div class="section" id="s-datafile-tmp-maxsize"> <h5><code class="docutils literal notranslate">DATAFILE_TMP_MAXSIZE</code><a class="headerlink" href="#datafile-tmp-maxsize" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'500M'</code> This is an Oracle-specific setting. The maximum size that the DATAFILE_TMP is allowed to grow to. </div> <div class="section" id="s-datafile-size"> <h5><code class="docutils literal notranslate">DATAFILE_SIZE</code><a class="headerlink" href="#datafile-size" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'50M'</code> This is an Oracle-specific setting. The initial size of the DATAFILE. </div> <div class="section" id="s-datafile-tmp-size"> <h5><code class="docutils literal notranslate">DATAFILE_TMP_SIZE</code><a class="headerlink" href="#datafile-tmp-size" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'50M'</code> This is an Oracle-specific setting. The initial size of the DATAFILE_TMP. </div> <div class="section" id="s-datafile-extsize"> <h5><code class="docutils literal notranslate">DATAFILE_EXTSIZE</code><a class="headerlink" href="#datafile-extsize" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'25M'</code> This is an Oracle-specific setting. The amount by which the DATAFILE is extended when more space is required. </div> <div class="section" id="s-datafile-tmp-extsize"> <h5><code class="docutils literal notranslate">DATAFILE_TMP_EXTSIZE</code><a class="headerlink" href="#datafile-tmp-extsize" title="Permalink to this headline">¶</a></h5> Default: <code class="docutils literal notranslate">'25M'</code> This is an Oracle-specific setting. The amount by which the DATAFILE_TMP is extended when more space is required. </div> </div> </div> <div class="section" id="s-data-upload-max-memory-size"> <h3>DATA_UPLOAD_MAX_MEMORY_SIZE<a class="headerlink" href="#data-upload-max-memory-size" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">2621440</code> (i.e. 2.5 MB). The maximum size in bytes that a request body may be before a <a class="reference internal" href="../exceptions/#django.core.exceptions.SuspiciousOperation" title="django.core.exceptions.SuspiciousOperation"><code class="xref py py-exc docutils literal notranslate">SuspiciousOperation</code></a> (<code class="docutils literal notranslate">RequestDataTooBig</code>) is raised. The check is done when accessing <code class="docutils literal notranslate">request.body</code> or <code class="docutils literal notranslate">request.POST</code> and is calculated against the total request size excluding any file upload data. You can set this to <code class="docutils literal notranslate">None</code> to disable the check. Applications that are expected to receive unusually large form posts should tune this setting. The amount of request data is correlated to the amount of memory needed to process the request and populate the GET and POST dictionaries. Large requests could be used as a denial-of-service attack vector if left unchecked. Since web servers don’t typically perform deep request inspection, it’s not possible to perform a similar check at that level. See also <a class="reference internal" href="#std:setting-FILE_UPLOAD_MAX_MEMORY_SIZE"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_MAX_MEMORY_SIZE</code></a>. </div> <div class="section" id="s-data-upload-max-number-fields"> <h3>DATA_UPLOAD_MAX_NUMBER_FIELDS<a class="headerlink" href="#data-upload-max-number-fields" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">1000</code> The maximum number of parameters that may be received via GET or POST before a <a class="reference internal" href="../exceptions/#django.core.exceptions.SuspiciousOperation" title="django.core.exceptions.SuspiciousOperation"><code class="xref py py-exc docutils literal notranslate">SuspiciousOperation</code></a> (<code class="docutils literal notranslate">TooManyFields</code>) is raised. You can set this to <code class="docutils literal notranslate">None</code> to disable the check. Applications that are expected to receive an unusually large number of form fields should tune this setting. The number of request parameters is correlated to the amount of time needed to process the request and populate the GET and POST dictionaries. Large requests could be used as a denial-of-service attack vector if left unchecked. Since web servers don’t typically perform deep request inspection, it’s not possible to perform a similar check at that level. </div> <div class="section" id="s-database-routers"> <h3><code class="docutils literal notranslate">DATABASE_ROUTERS</code><a class="headerlink" href="#database-routers" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) The list of routers that will be used to determine which database to use when performing a database query. See the documentation on <a class="reference internal" href="../../topics/db/multi-db/#topics-db-multi-db-routing">automatic database routing in multi database configurations</a>. </div> <div class="section" id="s-date-format"> <h3><code class="docutils literal notranslate">DATE_FORMAT</code><a class="headerlink" href="#date-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'N j, Y'</code> (e.g. <code class="docutils literal notranslate">Feb. 4, 2003</code>) The default formatting to use for displaying date fields in any part of the system. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a>, <a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a> and <a class="reference internal" href="#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATE_FORMAT</code></a>. </div> <div class="section" id="s-date-input-formats"> <h3><code class="docutils literal notranslate">DATE_INPUT_FORMATS</code><a class="headerlink" href="#date-input-formats" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ '%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', # '2006-10-25', '10/25/2006', '10/25/06' '%b %d %Y', '%b %d, %Y', # 'Oct 25 2006', 'Oct 25, 2006' '%d %b %Y', '%d %b, %Y', # '25 Oct 2006', '25 Oct, 2006' '%B %d %Y', '%B %d, %Y', # 'October 25 2006', 'October 25, 2006' '%d %B %Y', '%d %B, %Y', # '25 October 2006', '25 October, 2006' ] </pre></div> </div> A list of formats that will be accepted when inputting data on a date field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s <a class="reference external" href="https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior" title="(in Python v3.9)">datetime module syntax</a>, not the format strings from the <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">date</code></a> template filter. When <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is <code class="docutils literal notranslate">True</code>, the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-DATETIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATETIME_INPUT_FORMATS</code></a> and <a class="reference internal" href="#std:setting-TIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">TIME_INPUT_FORMATS</code></a>. </div> <div class="section" id="s-datetime-format"> <h3><code class="docutils literal notranslate">DATETIME_FORMAT</code><a class="headerlink" href="#datetime-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'N j, Y, P'</code> (e.g. <code class="docutils literal notranslate">Feb. 4, 2003, 4 p.m.</code>) The default formatting to use for displaying datetime fields in any part of the system. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a>, <a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a> and <a class="reference internal" href="#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATETIME_FORMAT</code></a>. </div> <div class="section" id="s-datetime-input-formats"> <h3><code class="docutils literal notranslate">DATETIME_INPUT_FORMATS</code><a class="headerlink" href="#datetime-input-formats" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ '%Y-%m-%d %H:%M:%S', # '2006-10-25 14:30:59' '%Y-%m-%d %H:%M:%S.%f', # '2006-10-25 14:30:59.000200' '%Y-%m-%d %H:%M', # '2006-10-25 14:30' '%Y-%m-%d', # '2006-10-25' '%m/%d/%Y %H:%M:%S', # '10/25/2006 14:30:59' '%m/%d/%Y %H:%M:%S.%f', # '10/25/2006 14:30:59.000200' '%m/%d/%Y %H:%M', # '10/25/2006 14:30' '%m/%d/%Y', # '10/25/2006' '%m/%d/%y %H:%M:%S', # '10/25/06 14:30:59' '%m/%d/%y %H:%M:%S.%f', # '10/25/06 14:30:59.000200' '%m/%d/%y %H:%M', # '10/25/06 14:30' '%m/%d/%y', # '10/25/06' ] </pre></div> </div> A list of formats that will be accepted when inputting data on a datetime field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s <a class="reference external" href="https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior" title="(in Python v3.9)">datetime module syntax</a>, not the format strings from the <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">date</code></a> template filter. When <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is <code class="docutils literal notranslate">True</code>, the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-DATE_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATE_INPUT_FORMATS</code></a> and <a class="reference internal" href="#std:setting-TIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">TIME_INPUT_FORMATS</code></a>. </div> <div class="section" id="s-debug"> <h3><code class="docutils literal notranslate">DEBUG</code><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that turns on/off debug mode. Never deploy a site into production with <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> turned on. One of the main features of debug mode is the display of detailed error pages. If your app raises an exception when <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> is <code class="docutils literal notranslate">True</code>, Django will display a detailed traceback, including a lot of metadata about your environment, such as all the currently defined Django settings (from <code class="docutils literal notranslate">settings.py</code>). As a security measure, Django will not include settings that might be sensitive, such as <a class="reference internal" href="#std:setting-SECRET_KEY"><code class="xref std std-setting docutils literal notranslate">SECRET_KEY</code></a>. Specifically, it will exclude any setting whose name includes any of the following: <ul class="simple"> <li><code class="docutils literal notranslate">'API'</code></li> <li><code class="docutils literal notranslate">'KEY'</code></li> <li><code class="docutils literal notranslate">'PASS'</code></li> <li><code class="docutils literal notranslate">'SECRET'</code></li> <li><code class="docutils literal notranslate">'SIGNATURE'</code></li> <li><code class="docutils literal notranslate">'TOKEN'</code></li> </ul> Note that these are partial matches. <code class="docutils literal notranslate">'PASS'</code> will also match PASSWORD, just as <code class="docutils literal notranslate">'TOKEN'</code> will also match TOKENIZED and so on. Still, note that there are always going to be sections of your debug output that are inappropriate for public consumption. File paths, configuration options and the like all give attackers extra information about your server. It is also important to remember that when running with <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> turned on, Django will remember every SQL query it executes. This is useful when you’re debugging, but it’ll rapidly consume memory on a production server. Finally, if <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> is <code class="docutils literal notranslate">False</code>, you also need to properly set the <a class="reference internal" href="#std:setting-ALLOWED_HOSTS"><code class="xref std std-setting docutils literal notranslate">ALLOWED_HOSTS</code></a> setting. Failing to do so will result in all requests being returned as “Bad Request (400)”. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> sets <code class="docutils literal notranslate">DEBUG = True</code> for convenience. </div> </div> <div class="section" id="s-debug-propagate-exceptions"> <h3><code class="docutils literal notranslate">DEBUG_PROPAGATE_EXCEPTIONS</code><a class="headerlink" href="#debug-propagate-exceptions" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> If set to <code class="docutils literal notranslate">True</code>, Django’s exception handling of view functions (<a class="reference internal" href="../urls/#django.conf.urls.handler500" title="django.conf.urls.handler500"><code class="xref py py-data docutils literal notranslate">handler500</code></a>, or the debug view if <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> is <code class="docutils literal notranslate">True</code>) and logging of 500 responses (<a class="reference internal" href="../../topics/logging/#django-request-logger">django.request</a>) is skipped and exceptions propagate upwards. This can be useful for some test setups. It shouldn’t be used on a live site unless you want your web server (instead of Django) to generate “Internal Server Error” responses. In that case, make sure your server doesn’t show the stack trace or other sensitive information in the response. </div> <div class="section" id="s-decimal-separator"> <h3><code class="docutils literal notranslate">DECIMAL_SEPARATOR</code><a class="headerlink" href="#decimal-separator" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'.'</code> (Dot) Default decimal separator used when formatting decimal numbers. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a>, <a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a> and <a class="reference internal" href="#std:setting-USE_THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a>. </div> <div class="section" id="s-default-charset"> <h3><code class="docutils literal notranslate">DEFAULT_CHARSET</code><a class="headerlink" href="#default-charset" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'utf-8'</code> Default charset to use for all <code class="docutils literal notranslate">HttpResponse</code> objects, if a MIME type isn’t manually specified. Used when constructing the <code class="docutils literal notranslate">Content-Type</code> header. </div> <div class="section" id="s-default-exception-reporter-filter"> <h3><code class="docutils literal notranslate">DEFAULT_EXCEPTION_REPORTER_FILTER</code><a class="headerlink" href="#default-exception-reporter-filter" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'</code><a class="reference internal" href="../../howto/error-reporting/#django.views.debug.SafeExceptionReporterFilter" title="django.views.debug.SafeExceptionReporterFilter"><code class="xref py py-class docutils literal notranslate">django.views.debug.SafeExceptionReporterFilter</code></a><code class="docutils literal notranslate">'</code> Default exception reporter filter class to be used if none has been assigned to the <a class="reference internal" href="../request-response/#django.http.HttpRequest" title="django.http.HttpRequest"><code class="xref py py-class docutils literal notranslate">HttpRequest</code></a> instance yet. See <a class="reference internal" href="../../howto/error-reporting/#filtering-error-reports">Filtering error reports</a>. </div> <div class="section" id="s-default-file-storage"> <h3><code class="docutils literal notranslate">DEFAULT_FILE_STORAGE</code><a class="headerlink" href="#default-file-storage" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'</code><a class="reference internal" href="../files/storage/#django.core.files.storage.FileSystemStorage" title="django.core.files.storage.FileSystemStorage"><code class="xref py py-class docutils literal notranslate">django.core.files.storage.FileSystemStorage</code></a><code class="docutils literal notranslate">'</code> Default file storage class to be used for any file-related operations that don’t specify a particular storage system. See <a class="reference internal" href="../../topics/files/">Managing files</a>. </div> <div class="section" id="s-default-from-email"> <h3><code class="docutils literal notranslate">DEFAULT_FROM_EMAIL</code><a class="headerlink" href="#default-from-email" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'webmaster@localhost'</code> Default email address to use for various automated correspondence from the site manager(s). This doesn’t include error messages sent to <a class="reference internal" href="#std:setting-ADMINS"><code class="xref std std-setting docutils literal notranslate">ADMINS</code></a> and <a class="reference internal" href="#std:setting-MANAGERS"><code class="xref std std-setting docutils literal notranslate">MANAGERS</code></a>; for that, see <a class="reference internal" href="#std:setting-SERVER_EMAIL"><code class="xref std std-setting docutils literal notranslate">SERVER_EMAIL</code></a>. </div> <div class="section" id="s-default-index-tablespace"> <h3><code class="docutils literal notranslate">DEFAULT_INDEX_TABLESPACE</code><a class="headerlink" href="#default-index-tablespace" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) Default tablespace to use for indexes on fields that don’t specify one, if the backend supports it (see <a class="reference internal" href="../../topics/db/tablespaces/">Tablespaces</a>). </div> <div class="section" id="s-default-tablespace"> <h3><code class="docutils literal notranslate">DEFAULT_TABLESPACE</code><a class="headerlink" href="#default-tablespace" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) Default tablespace to use for models that don’t specify one, if the backend supports it (see <a class="reference internal" href="../../topics/db/tablespaces/">Tablespaces</a>). </div> <div class="section" id="s-disallowed-user-agents"> <h3><code class="docutils literal notranslate">DISALLOWED_USER_AGENTS</code><a class="headerlink" href="#disallowed-user-agents" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) List of compiled regular expression objects representing User-Agent strings that are not allowed to visit any page, systemwide. Use this for bots/crawlers. This is only used if <code class="docutils literal notranslate">CommonMiddleware</code> is installed (see <a class="reference internal" href="../../topics/http/middleware/">Middleware</a>). </div> <div class="section" id="s-email-backend"> <h3><code class="docutils literal notranslate">EMAIL_BACKEND</code><a class="headerlink" href="#email-backend" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'</code><a class="reference internal" href="../../topics/email/#django.core.mail.backends.smtp.EmailBackend" title="django.core.mail.backends.smtp.EmailBackend"><code class="xref py py-class docutils literal notranslate">django.core.mail.backends.smtp.EmailBackend</code></a><code class="docutils literal notranslate">'</code> The backend to use for sending emails. For the list of available backends see <a class="reference internal" href="../../topics/email/">Sending email</a>. </div> <div class="section" id="s-email-file-path"> <h3><code class="docutils literal notranslate">EMAIL_FILE_PATH</code><a class="headerlink" href="#email-file-path" title="Permalink to this headline">¶</a></h3> Default: Not defined The directory used by the <a class="reference internal" href="../../topics/email/#topic-email-file-backend">file email backend</a> to store output files. </div> <div class="section" id="s-email-host"> <h3><code class="docutils literal notranslate">EMAIL_HOST</code><a class="headerlink" href="#email-host" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'localhost'</code> The host to use for sending email. See also <a class="reference internal" href="#std:setting-EMAIL_PORT"><code class="xref std std-setting docutils literal notranslate">EMAIL_PORT</code></a>. </div> <div class="section" id="s-email-host-password"> <h3><code class="docutils literal notranslate">EMAIL_HOST_PASSWORD</code><a class="headerlink" href="#email-host-password" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) Password to use for the SMTP server defined in <a class="reference internal" href="#std:setting-EMAIL_HOST"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST</code></a>. This setting is used in conjunction with <a class="reference internal" href="#std:setting-EMAIL_HOST_USER"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST_USER</code></a> when authenticating to the SMTP server. If either of these settings is empty, Django won’t attempt authentication. See also <a class="reference internal" href="#std:setting-EMAIL_HOST_USER"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST_USER</code></a>. </div> <div class="section" id="s-email-host-user"> <h3><code class="docutils literal notranslate">EMAIL_HOST_USER</code><a class="headerlink" href="#email-host-user" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) Username to use for the SMTP server defined in <a class="reference internal" href="#std:setting-EMAIL_HOST"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST</code></a>. If empty, Django won’t attempt authentication. See also <a class="reference internal" href="#std:setting-EMAIL_HOST_PASSWORD"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST_PASSWORD</code></a>. </div> <div class="section" id="s-email-port"> <h3><code class="docutils literal notranslate">EMAIL_PORT</code><a class="headerlink" href="#email-port" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">25</code> Port to use for the SMTP server defined in <a class="reference internal" href="#std:setting-EMAIL_HOST"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST</code></a>. </div> <div class="section" id="s-email-subject-prefix"> <h3><code class="docutils literal notranslate">EMAIL_SUBJECT_PREFIX</code><a class="headerlink" href="#email-subject-prefix" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'[Django] '</code> Subject-line prefix for email messages sent with <code class="docutils literal notranslate">django.core.mail.mail_admins</code> or <code class="docutils literal notranslate">django.core.mail.mail_managers</code>. You’ll probably want to include the trailing space. </div> <div class="section" id="s-email-use-localtime"> <h3><code class="docutils literal notranslate">EMAIL_USE_LOCALTIME</code><a class="headerlink" href="#email-use-localtime" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to send the SMTP <code class="docutils literal notranslate">Date</code> header of email messages in the local time zone (<code class="docutils literal notranslate">True</code>) or in UTC (<code class="docutils literal notranslate">False</code>). </div> <div class="section" id="s-email-use-tls"> <h3><code class="docutils literal notranslate">EMAIL_USE_TLS</code><a class="headerlink" href="#email-use-tls" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to use a TLS (secure) connection when talking to the SMTP server. This is used for explicit TLS connections, generally on port 587. If you are experiencing hanging connections, see the implicit TLS setting <a class="reference internal" href="#std:setting-EMAIL_USE_SSL"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_SSL</code></a>. </div> <div class="section" id="s-email-use-ssl"> <h3><code class="docutils literal notranslate">EMAIL_USE_SSL</code><a class="headerlink" href="#email-use-ssl" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to use an implicit TLS (secure) connection when talking to the SMTP server. In most email documentation this type of TLS connection is referred to as SSL. It is generally used on port 465. If you are experiencing problems, see the explicit TLS setting <a class="reference internal" href="#std:setting-EMAIL_USE_TLS"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_TLS</code></a>. Note that <a class="reference internal" href="#std:setting-EMAIL_USE_TLS"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_TLS</code></a>/<a class="reference internal" href="#std:setting-EMAIL_USE_SSL"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_SSL</code></a> are mutually exclusive, so only set one of those settings to <code class="docutils literal notranslate">True</code>. </div> <div class="section" id="s-email-ssl-certfile"> <h3><code class="docutils literal notranslate">EMAIL_SSL_CERTFILE</code><a class="headerlink" href="#email-ssl-certfile" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> If <a class="reference internal" href="#std:setting-EMAIL_USE_SSL"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_SSL</code></a> or <a class="reference internal" href="#std:setting-EMAIL_USE_TLS"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_TLS</code></a> is <code class="docutils literal notranslate">True</code>, you can optionally specify the path to a PEM-formatted certificate chain file to use for the SSL connection. </div> <div class="section" id="s-email-ssl-keyfile"> <h3><code class="docutils literal notranslate">EMAIL_SSL_KEYFILE</code><a class="headerlink" href="#email-ssl-keyfile" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> If <a class="reference internal" href="#std:setting-EMAIL_USE_SSL"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_SSL</code></a> or <a class="reference internal" href="#std:setting-EMAIL_USE_TLS"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_TLS</code></a> is <code class="docutils literal notranslate">True</code>, you can optionally specify the path to a PEM-formatted private key file to use for the SSL connection. Note that setting <a class="reference internal" href="#std:setting-EMAIL_SSL_CERTFILE"><code class="xref std std-setting docutils literal notranslate">EMAIL_SSL_CERTFILE</code></a> and <a class="reference internal" href="#std:setting-EMAIL_SSL_KEYFILE"><code class="xref std std-setting docutils literal notranslate">EMAIL_SSL_KEYFILE</code></a> doesn’t result in any certificate checking. They’re passed to the underlying SSL connection. Please refer to the documentation of Python’s <a class="reference external" href="https://docs.python.org/3/library/ssl.html#ssl.wrap_socket" title="(in Python v3.9)"><code class="docutils literal notranslate">ssl.wrap_socket()</code></a> function for details on how the certificate chain file and private key file are handled. </div> <div class="section" id="s-email-timeout"> <h3><code class="docutils literal notranslate">EMAIL_TIMEOUT</code><a class="headerlink" href="#email-timeout" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> Specifies a timeout in seconds for blocking operations like the connection attempt. </div> <div class="section" id="s-file-charset"> <h3><code class="docutils literal notranslate">FILE_CHARSET</code><a class="headerlink" href="#file-charset" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'utf-8'</code> The character encoding used to decode any files read from disk. This includes template files, static files, and translation catalogs. <div class="deprecated"> Deprecated since version 2.2: This setting is deprecated. Starting with Django 3.1, files read from disk must be UTF-8 encoded. </div> </div> <div class="section" id="s-file-upload-handlers"> <h3><code class="docutils literal notranslate">FILE_UPLOAD_HANDLERS</code><a class="headerlink" href="#file-upload-handlers" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ 'django.core.files.uploadhandler.MemoryFileUploadHandler', 'django.core.files.uploadhandler.TemporaryFileUploadHandler', ] </pre></div> </div> A list of handlers to use for uploading. Changing this setting allows complete customization – even replacement – of Django’s upload process. See <a class="reference internal" href="../../topics/files/">Managing files</a> for details. </div> <div class="section" id="s-file-upload-max-memory-size"> <h3><code class="docutils literal notranslate">FILE_UPLOAD_MAX_MEMORY_SIZE</code><a class="headerlink" href="#file-upload-max-memory-size" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">2621440</code> (i.e. 2.5 MB). The maximum size (in bytes) that an upload will be before it gets streamed to the file system. See <a class="reference internal" href="../../topics/files/">Managing files</a> for details. See also <a class="reference internal" href="#std:setting-DATA_UPLOAD_MAX_MEMORY_SIZE"><code class="xref std std-setting docutils literal notranslate">DATA_UPLOAD_MAX_MEMORY_SIZE</code></a>. </div> <div class="section" id="s-file-upload-directory-permissions"> <h3><code class="docutils literal notranslate">FILE_UPLOAD_DIRECTORY_PERMISSIONS</code><a class="headerlink" href="#file-upload-directory-permissions" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The numeric mode to apply to directories created in the process of uploading files. This setting also determines the default permissions for collected static directories when using the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> management command. See <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> for details on overriding it. This value mirrors the functionality and caveats of the <a class="reference internal" href="#std:setting-FILE_UPLOAD_PERMISSIONS"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_PERMISSIONS</code></a> setting. </div> <div class="section" id="s-file-upload-permissions"> <h3><code class="docutils literal notranslate">FILE_UPLOAD_PERMISSIONS</code><a class="headerlink" href="#file-upload-permissions" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">0o644</code> The numeric mode (i.e. <code class="docutils literal notranslate">0o644</code>) to set newly uploaded files to. For more information about what these modes mean, see the documentation for <a class="reference external" href="https://docs.python.org/3/library/os.html#os.chmod" title="(in Python v3.9)"><code class="xref py py-func docutils literal notranslate">os.chmod()</code></a>. If <code class="docutils literal notranslate">None</code>, you’ll get operating-system dependent behavior. On most platforms, temporary files will have a mode of <code class="docutils literal notranslate">0o600</code>, and files saved from memory will be saved using the system’s standard umask. For security reasons, these permissions aren’t applied to the temporary files that are stored in <a class="reference internal" href="#std:setting-FILE_UPLOAD_TEMP_DIR"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_TEMP_DIR</code></a>. This setting also determines the default permissions for collected static files when using the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> management command. See <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> for details on overriding it. <div class="admonition warning"> Warning Always prefix the mode with <code class="docutils literal notranslate">0o</code> . If you’re not familiar with file modes, please note that the <code class="docutils literal notranslate">0o</code> prefix is very important: it indicates an octal number, which is the way that modes must be specified. If you try to use <code class="docutils literal notranslate">644</code>, you’ll get totally incorrect behavior. </div> <div class="versionchanged"> Changed in Django 3.0: In older versions, the default value is <code class="docutils literal notranslate">None</code>. </div> </div> <div class="section" id="s-file-upload-temp-dir"> <h3><code class="docutils literal notranslate">FILE_UPLOAD_TEMP_DIR</code><a class="headerlink" href="#file-upload-temp-dir" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The directory to store data to (typically files larger than <a class="reference internal" href="#std:setting-FILE_UPLOAD_MAX_MEMORY_SIZE"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_MAX_MEMORY_SIZE</code></a>) temporarily while uploading files. If <code class="docutils literal notranslate">None</code>, Django will use the standard temporary directory for the operating system. For example, this will default to <code class="docutils literal notranslate">/tmp</code> on *nix-style operating systems. See <a class="reference internal" href="../../topics/files/">Managing files</a> for details. </div> <div class="section" id="s-first-day-of-week"> <h3><code class="docutils literal notranslate">FIRST_DAY_OF_WEEK</code><a class="headerlink" href="#first-day-of-week" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">0</code> (Sunday) A number representing the first day of the week. This is especially useful when displaying a calendar. This value is only used when not using format internationalization, or when a format cannot be found for the current locale. The value must be an integer from 0 to 6, where 0 means Sunday, 1 means Monday and so on. </div> <div class="section" id="s-fixture-dirs"> <h3><code class="docutils literal notranslate">FIXTURE_DIRS</code><a class="headerlink" href="#fixture-dirs" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) List of directories searched for fixture files, in addition to the <code class="docutils literal notranslate">fixtures</code> directory of each application, in search order. Note that these paths should use Unix-style forward slashes, even on Windows. See <a class="reference internal" href="../../howto/initial-data/#initial-data-via-fixtures">Providing data with fixtures</a> and <a class="reference internal" href="../../topics/testing/tools/#topics-testing-fixtures">Fixture loading</a>. </div> <div class="section" id="s-force-script-name"> <h3><code class="docutils literal notranslate">FORCE_SCRIPT_NAME</code><a class="headerlink" href="#force-script-name" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> If not <code class="docutils literal notranslate">None</code>, this will be used as the value of the <code class="docutils literal notranslate">SCRIPT_NAME</code> environment variable in any HTTP request. This setting can be used to override the server-provided value of <code class="docutils literal notranslate">SCRIPT_NAME</code>, which may be a rewritten version of the preferred value or not supplied at all. It is also used by <a class="reference internal" href="../applications/#django.setup" title="django.setup"><code class="xref py py-func docutils literal notranslate">django.setup()</code></a> to set the URL resolver script prefix outside of the request/response cycle (e.g. in management commands and standalone scripts) to generate correct URLs when <code class="docutils literal notranslate">SCRIPT_NAME</code> is not <code class="docutils literal notranslate">/</code>. </div> <div class="section" id="s-form-renderer"> <h3><code class="docutils literal notranslate">FORM_RENDERER</code><a class="headerlink" href="#form-renderer" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'</code><a class="reference internal" href="../forms/renderers/#django.forms.renderers.DjangoTemplates" title="django.forms.renderers.DjangoTemplates"><code class="xref py py-class docutils literal notranslate">django.forms.renderers.DjangoTemplates</code></a><code class="docutils literal notranslate">'</code> The class that renders form widgets. It must implement <a class="reference internal" href="../forms/renderers/#low-level-widget-render-api">the low-level render API</a>. </div> <div class="section" id="s-format-module-path"> <h3><code class="docutils literal notranslate">FORMAT_MODULE_PATH</code><a class="headerlink" href="#format-module-path" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> A full Python path to a Python package that contains custom format definitions for project locales. If not <code class="docutils literal notranslate">None</code>, Django will check for a <code class="docutils literal notranslate">formats.py</code> file, under the directory named as the current locale, and will use the formats defined in this file. For example, if <a class="reference internal" href="#std:setting-FORMAT_MODULE_PATH"><code class="xref std std-setting docutils literal notranslate">FORMAT_MODULE_PATH</code></a> is set to <code class="docutils literal notranslate">mysite.formats</code>, and current language is <code class="docutils literal notranslate">en</code> (English), Django will expect a directory tree like: <div class="highlight-default notranslate"><div class="highlight"><pre>mysite/ formats/ __init__.py en/ __init__.py formats.py </pre></div> </div> You can also set this setting to a list of Python paths, for example: <div class="highlight-default notranslate"><div class="highlight"><pre>FORMAT_MODULE_PATH = [ 'mysite.formats', 'some_app.formats', ] </pre></div> </div> When Django searches for a certain format, it will go through all given Python paths until it finds a module that actually defines the given format. This means that formats defined in packages farther up in the list will take precedence over the same formats in packages farther down. Available formats are: <ul class="simple"> <li><a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-DATE_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATE_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a>,</li> <li><a class="reference internal" href="#std:setting-DATETIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATETIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-DECIMAL_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">DECIMAL_SEPARATOR</code></a></li> <li><a class="reference internal" href="#std:setting-FIRST_DAY_OF_WEEK"><code class="xref std std-setting docutils literal notranslate">FIRST_DAY_OF_WEEK</code></a></li> <li><a class="reference internal" href="#std:setting-MONTH_DAY_FORMAT"><code class="xref std std-setting docutils literal notranslate">MONTH_DAY_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a></li> <li><a class="reference internal" href="#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATETIME_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">TIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-YEAR_MONTH_FORMAT"><code class="xref std std-setting docutils literal notranslate">YEAR_MONTH_FORMAT</code></a></li> </ul> </div> <div class="section" id="s-ignorable-404-urls"> <h3><code class="docutils literal notranslate">IGNORABLE_404_URLS</code><a class="headerlink" href="#ignorable-404-urls" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) List of compiled regular expression objects describing URLs that should be ignored when reporting HTTP 404 errors via email (see <a class="reference internal" href="../../howto/error-reporting/">Error reporting</a>). Regular expressions are matched against <a class="reference internal" href="../request-response/#django.http.HttpRequest.get_full_path" title="django.http.HttpRequest.get_full_path"><code class="xref py py-meth docutils literal notranslate">request's full paths</code></a> (including query string, if any). Use this if your site does not provide a commonly requested file such as <code class="docutils literal notranslate">favicon.ico</code> or <code class="docutils literal notranslate">robots.txt</code>. This is only used if <a class="reference internal" href="../middleware/#django.middleware.common.BrokenLinkEmailsMiddleware" title="django.middleware.common.BrokenLinkEmailsMiddleware"><code class="xref py py-class docutils literal notranslate">BrokenLinkEmailsMiddleware</code></a> is enabled (see <a class="reference internal" href="../../topics/http/middleware/">Middleware</a>). </div> <div class="section" id="s-installed-apps"> <h3><code class="docutils literal notranslate">INSTALLED_APPS</code><a class="headerlink" href="#installed-apps" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of strings designating all applications that are enabled in this Django installation. Each string should be a dotted Python path to: <ul class="simple"> <li>an application configuration class (preferred), or</li> <li>a package containing an application.</li> </ul> <a class="reference internal" href="../applications/">Learn more about application configurations</a>. <div class="admonition-use-the-application-registry-for-introspection admonition"> Use the application registry for introspection Your code should never access <a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a> directly. Use <a class="reference internal" href="../applications/#django.apps.apps" title="django.apps.apps"><code class="xref py py-attr docutils literal notranslate">django.apps.apps</code></a> instead. </div> <div class="admonition-application-names-and-labels-must-be-unique-in-setting-installed-apps admonition"> Application names and labels must be unique in <a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a> Application <a class="reference internal" href="../applications/#django.apps.AppConfig.name" title="django.apps.AppConfig.name"><code class="xref py py-attr docutils literal notranslate">names</code></a> — the dotted Python path to the application package — must be unique. There is no way to include the same application twice, short of duplicating its code under another name. Application <a class="reference internal" href="../applications/#django.apps.AppConfig.label" title="django.apps.AppConfig.label"><code class="xref py py-attr docutils literal notranslate">labels</code></a> — by default the final part of the name — must be unique too. For example, you can’t include both <code class="docutils literal notranslate">django.contrib.auth</code> and <code class="docutils literal notranslate">myproject.auth</code>. However, you can relabel an application with a custom configuration that defines a different <a class="reference internal" href="../applications/#django.apps.AppConfig.label" title="django.apps.AppConfig.label"><code class="xref py py-attr docutils literal notranslate">label</code></a>. These rules apply regardless of whether <a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a> references application configuration classes or application packages. </div> When several applications provide different versions of the same resource (template, static file, management command, translation), the application listed first in <a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a> has precedence. </div> <div class="section" id="s-internal-ips"> <h3><code class="docutils literal notranslate">INTERNAL_IPS</code><a class="headerlink" href="#internal-ips" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of IP addresses, as strings, that: <ul class="simple"> <li>Allow the <a class="reference internal" href="../templates/api/#django.template.context_processors.debug" title="django.template.context_processors.debug"><code class="xref py py-func docutils literal notranslate">debug()</code></a> context processor to add some variables to the template context.</li> <li>Can use the <a class="reference internal" href="../contrib/admin/admindocs/#admindocs-bookmarklets">admindocs bookmarklets</a> even if not logged in as a staff user.</li> <li>Are marked as “internal” (as opposed to “EXTERNAL”) in <a class="reference internal" href="../../topics/logging/#django.utils.log.AdminEmailHandler" title="django.utils.log.AdminEmailHandler"><code class="xref py py-class docutils literal notranslate">AdminEmailHandler</code></a> emails.</li> </ul> </div> <div class="section" id="s-language-code"> <h3><code class="docutils literal notranslate">LANGUAGE_CODE</code><a class="headerlink" href="#language-code" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'en-us'</code> A string representing the language code for this installation. This should be in standard <a class="reference internal" href="../../topics/i18n/#term-language-code">language ID format</a>. For example, U.S. English is <code class="docutils literal notranslate">"en-us"</code>. See also the <a class="reference external" href="http://www.i18nguy.com/unicode/language-identifiers.html">list of language identifiers</a> and <a class="reference internal" href="../../topics/i18n/">Internationalization and localization</a>. <a class="reference internal" href="#std:setting-USE_I18N"><code class="xref std std-setting docutils literal notranslate">USE_I18N</code></a> must be active for this setting to have any effect. It serves two purposes: <ul class="simple"> <li>If the locale middleware isn’t in use, it decides which translation is served to all users.</li> <li>If the locale middleware is active, it provides a fallback language in case the user’s preferred language can’t be determined or is not supported by the website. It also provides the fallback translation when a translation for a given literal doesn’t exist for the user’s preferred language.</li> </ul> See <a class="reference internal" href="../../topics/i18n/translation/#how-django-discovers-language-preference">How Django discovers language preference</a> for more details. </div> <div class="section" id="s-language-cookie-age"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_AGE</code><a class="headerlink" href="#language-cookie-age" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> (expires at browser close) The age of the language cookie, in seconds. </div> <div class="section" id="s-language-cookie-domain"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_DOMAIN</code><a class="headerlink" href="#language-cookie-domain" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The domain to use for the language cookie. Set this to a string such as <code class="docutils literal notranslate">"example.com"</code> for cross-domain cookies, or use <code class="docutils literal notranslate">None</code> for a standard domain cookie. Be cautious when updating this setting on a production site. If you update this setting to enable cross-domain cookies on a site that previously used standard domain cookies, existing user cookies that have the old domain will not be updated. This will result in site users being unable to switch the language as long as these cookies persist. The only safe and reliable option to perform the switch is to change the language cookie name permanently (via the <a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_NAME"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_NAME</code></a> setting) and to add a middleware that copies the value from the old cookie to a new one and then deletes the old one. </div> <div class="section" id="s-language-cookie-httponly"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_HTTPONLY</code><a class="headerlink" href="#language-cookie-httponly" title="Permalink to this headline">¶</a></h3> <div class="versionadded"> New in Django 3.0. </div> Default: <code class="docutils literal notranslate">False</code> Whether to use <code class="docutils literal notranslate">HttpOnly</code> flag on the language cookie. If this is set to <code class="docutils literal notranslate">True</code>, client-side JavaScript will not be able to access the language cookie. See <a class="reference internal" href="#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_HTTPONLY</code></a> for details on <code class="docutils literal notranslate">HttpOnly</code>. </div> <div class="section" id="s-language-cookie-name"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_NAME</code><a class="headerlink" href="#language-cookie-name" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django_language'</code> The name of the cookie to use for the language cookie. This can be whatever you want (as long as it’s different from the other cookie names in your application). See <a class="reference internal" href="../../topics/i18n/">Internationalization and localization</a>. </div> <div class="section" id="s-language-cookie-path"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_PATH</code><a class="headerlink" href="#language-cookie-path" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'/'</code> The path set on the language cookie. This should either match the URL path of your Django installation or be a parent of that path. This is useful if you have multiple Django instances running under the same hostname. They can use different cookie paths and each instance will only see its own language cookie. Be cautious when updating this setting on a production site. If you update this setting to use a deeper path than it previously used, existing user cookies that have the old path will not be updated. This will result in site users being unable to switch the language as long as these cookies persist. The only safe and reliable option to perform the switch is to change the language cookie name permanently (via the <a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_NAME"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_NAME</code></a> setting), and to add a middleware that copies the value from the old cookie to a new one and then deletes the one. </div> <div class="section" id="s-language-cookie-samesite"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_SAMESITE</code><a class="headerlink" href="#language-cookie-samesite" title="Permalink to this headline">¶</a></h3> <div class="versionadded"> New in Django 3.0. </div> Default: <code class="docutils literal notranslate">None</code> The value of the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite">SameSite</a> flag on the language cookie. This flag prevents the cookie from being sent in cross-site requests. See <a class="reference internal" href="#std:setting-SESSION_COOKIE_SAMESITE"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_SAMESITE</code></a> for details about <code class="docutils literal notranslate">SameSite</code>. </div> <div class="section" id="s-language-cookie-secure"> <h3><code class="docutils literal notranslate">LANGUAGE_COOKIE_SECURE</code><a class="headerlink" href="#language-cookie-secure" title="Permalink to this headline">¶</a></h3> <div class="versionadded"> New in Django 3.0. </div> Default: <code class="docutils literal notranslate">False</code> Whether to use a secure cookie for the language cookie. If this is set to <code class="docutils literal notranslate">True</code>, the cookie will be marked as “secure”, which means browsers may ensure that the cookie is only sent under an HTTPS connection. </div> <div class="section" id="s-languages"> <h3><code class="docutils literal notranslate">LANGUAGES</code><a class="headerlink" href="#languages" title="Permalink to this headline">¶</a></h3> Default: A list of all available languages. This list is continually growing and including a copy here would inevitably become rapidly out of date. You can see the current list of translated languages by looking in <a class="reference external" href="https://github.com/django/django/blob/master/django/conf/global_settings.py">django/conf/global_settings.py</a>. The list is a list of two-tuples in the format (<a class="reference internal" href="../../topics/i18n/#term-language-code">language code</a>, <code class="docutils literal notranslate">language name</code>) – for example, <code class="docutils literal notranslate">('ja', 'Japanese')</code>. This specifies which languages are available for language selection. See <a class="reference internal" href="../../topics/i18n/">Internationalization and localization</a>. Generally, the default value should suffice. Only set this setting if you want to restrict language selection to a subset of the Django-provided languages. If you define a custom <a class="reference internal" href="#std:setting-LANGUAGES"><code class="xref std std-setting docutils literal notranslate">LANGUAGES</code></a> setting, you can mark the language names as translation strings using the <a class="reference internal" href="../utils/#django.utils.translation.gettext_lazy" title="django.utils.translation.gettext_lazy"><code class="xref py py-func docutils literal notranslate">gettext_lazy()</code></a> function. Here’s a sample settings file: <div class="highlight-default notranslate"><div class="highlight"><pre>from django.utils.translation import gettext_lazy as _ LANGUAGES = [ ('de', _('German')), ('en', _('English')), ] </pre></div> </div> </div> <div class="section" id="s-languages-bidi"> <h3><code class="docutils literal notranslate">LANGUAGES_BIDI</code><a class="headerlink" href="#languages-bidi" title="Permalink to this headline">¶</a></h3> Default: A list of all language codes that are written right-to-left. You can see the current list of these languages by looking in <a class="reference external" href="https://github.com/django/django/blob/master/django/conf/global_settings.py">django/conf/global_settings.py</a>. The list contains <a class="reference internal" href="../../topics/i18n/#term-language-code">language codes</a> for languages that are written right-to-left. Generally, the default value should suffice. Only set this setting if you want to restrict language selection to a subset of the Django-provided languages. If you define a custom <a class="reference internal" href="#std:setting-LANGUAGES"><code class="xref std std-setting docutils literal notranslate">LANGUAGES</code></a> setting, the list of bidirectional languages may contain language codes which are not enabled on a given site. </div> <div class="section" id="s-locale-paths"> <h3><code class="docutils literal notranslate">LOCALE_PATHS</code><a class="headerlink" href="#locale-paths" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of directories where Django looks for translation files. See <a class="reference internal" href="../../topics/i18n/translation/#how-django-discovers-translations">How Django discovers translations</a>. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>LOCALE_PATHS = [ '/home/www/project/common_files/locale', '/var/local/translations/locale', ] </pre></div> </div> Django will look within each of these paths for the <code class="docutils literal notranslate"><locale_code>/LC_MESSAGES</code> directories containing the actual translation files. </div> <div class="section" id="s-logging"> <h3><code class="docutils literal notranslate">LOGGING</code><a class="headerlink" href="#logging" title="Permalink to this headline">¶</a></h3> Default: A logging configuration dictionary. A data structure containing configuration information. The contents of this data structure will be passed as the argument to the configuration method described in <a class="reference internal" href="#std:setting-LOGGING_CONFIG"><code class="xref std std-setting docutils literal notranslate">LOGGING_CONFIG</code></a>. Among other things, the default logging configuration passes HTTP 500 server errors to an email log handler when <a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a> is <code class="docutils literal notranslate">False</code>. See also <a class="reference internal" href="../../topics/logging/#configuring-logging">Configuring logging</a>. You can see the default logging configuration by looking in <a class="reference external" href="https://github.com/django/django/blob/master/django/utils/log.py">django/utils/log.py</a>. </div> <div class="section" id="s-logging-config"> <h3><code class="docutils literal notranslate">LOGGING_CONFIG</code><a class="headerlink" href="#logging-config" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'logging.config.dictConfig'</code> A path to a callable that will be used to configure logging in the Django project. Points at an instance of Python’s <a class="reference external" href="https://docs.python.org/3/library/logging.config.html#logging-config-dictschema" title="(in Python v3.9)">dictConfig</a> configuration method by default. If you set <a class="reference internal" href="#std:setting-LOGGING_CONFIG"><code class="xref std std-setting docutils literal notranslate">LOGGING_CONFIG</code></a> to <code class="docutils literal notranslate">None</code>, the logging configuration process will be skipped. </div> <div class="section" id="s-managers"> <h3><code class="docutils literal notranslate">MANAGERS</code><a class="headerlink" href="#managers" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list in the same format as <a class="reference internal" href="#std:setting-ADMINS"><code class="xref std std-setting docutils literal notranslate">ADMINS</code></a> that specifies who should get broken link notifications when <a class="reference internal" href="../middleware/#django.middleware.common.BrokenLinkEmailsMiddleware" title="django.middleware.common.BrokenLinkEmailsMiddleware"><code class="xref py py-class docutils literal notranslate">BrokenLinkEmailsMiddleware</code></a> is enabled. </div> <div class="section" id="s-media-root"> <h3><code class="docutils literal notranslate">MEDIA_ROOT</code><a class="headerlink" href="#media-root" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) Absolute filesystem path to the directory that will hold <a class="reference internal" href="../../topics/files/">user-uploaded files</a>. Example: <code class="docutils literal notranslate">"/var/www/example.com/media/"</code> See also <a class="reference internal" href="#std:setting-MEDIA_URL"><code class="xref std std-setting docutils literal notranslate">MEDIA_URL</code></a>. <div class="admonition warning"> Warning <a class="reference internal" href="#std:setting-MEDIA_ROOT"><code class="xref std std-setting docutils literal notranslate">MEDIA_ROOT</code></a> and <a class="reference internal" href="#std:setting-STATIC_ROOT"><code class="xref std std-setting docutils literal notranslate">STATIC_ROOT</code></a> must have different values. Before <a class="reference internal" href="#std:setting-STATIC_ROOT"><code class="xref std std-setting docutils literal notranslate">STATIC_ROOT</code></a> was introduced, it was common to rely or fallback on <a class="reference internal" href="#std:setting-MEDIA_ROOT"><code class="xref std std-setting docutils literal notranslate">MEDIA_ROOT</code></a> to also serve static files; however, since this can have serious security implications, there is a validation check to prevent it. </div> </div> <div class="section" id="s-media-url"> <h3><code class="docutils literal notranslate">MEDIA_URL</code><a class="headerlink" href="#media-url" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) URL that handles the media served from <a class="reference internal" href="#std:setting-MEDIA_ROOT"><code class="xref std std-setting docutils literal notranslate">MEDIA_ROOT</code></a>, used for <a class="reference internal" href="../../topics/files/">managing stored files</a>. It must end in a slash if set to a non-empty value. You will need to <a class="reference internal" href="../../howto/static-files/#serving-uploaded-files-in-development">configure these files to be served</a> in both development and production environments. If you want to use <code class="docutils literal notranslate">{{ MEDIA_URL }}</code> in your templates, add <code class="docutils literal notranslate">'django.template.context_processors.media'</code> in the <code class="docutils literal notranslate">'context_processors'</code> option of <a class="reference internal" href="#std:setting-TEMPLATES"><code class="xref std std-setting docutils literal notranslate">TEMPLATES</code></a>. Example: <code class="docutils literal notranslate">"http://media.example.com/"</code> <div class="admonition warning"> Warning There are security risks if you are accepting uploaded content from untrusted users! See the security guide’s topic on <a class="reference internal" href="../../topics/security/#user-uploaded-content-security">User-uploaded content</a> for mitigation details. </div> <div class="admonition warning"> Warning <a class="reference internal" href="#std:setting-MEDIA_URL"><code class="xref std std-setting docutils literal notranslate">MEDIA_URL</code></a> and <a class="reference internal" href="#std:setting-STATIC_URL"><code class="xref std std-setting docutils literal notranslate">STATIC_URL</code></a> must have different values. See <a class="reference internal" href="#std:setting-MEDIA_ROOT"><code class="xref std std-setting docutils literal notranslate">MEDIA_ROOT</code></a> for more details. </div> </div> <div class="section" id="s-middleware"> <h3><code class="docutils literal notranslate">MIDDLEWARE</code><a class="headerlink" href="#middleware" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> A list of middleware to use. See <a class="reference internal" href="../../topics/http/middleware/">Middleware</a>. </div> <div class="section" id="s-migration-modules"> <h3><code class="docutils literal notranslate">MIGRATION_MODULES</code><a class="headerlink" href="#migration-modules" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">{}</code> (Empty dictionary) A dictionary specifying the package where migration modules can be found on a per-app basis. The default value of this setting is an empty dictionary, but the default package name for migration modules is <code class="docutils literal notranslate">migrations</code>. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>{'blog': 'blog.db_migrations'} </pre></div> </div> In this case, migrations pertaining to the <code class="docutils literal notranslate">blog</code> app will be contained in the <code class="docutils literal notranslate">blog.db_migrations</code> package. If you provide the <code class="docutils literal notranslate">app_label</code> argument, <a class="reference internal" href="../django-admin/#django-admin-makemigrations"><code class="xref std std-djadmin docutils literal notranslate">makemigrations</code></a> will automatically create the package if it doesn’t already exist. When you supply <code class="docutils literal notranslate">None</code> as a value for an app, Django will consider the app as an app without migrations regardless of an existing <code class="docutils literal notranslate">migrations</code> submodule. This can be used, for example, in a test settings file to skip migrations while testing (tables will still be created for the apps’ models). If this is used in your general project settings, remember to use the <a class="reference internal" href="../django-admin/#cmdoption-migrate-run-syncdb"><code class="xref std std-option docutils literal notranslate">migrate --run-syncdb</code></a> option if you want to create tables for the app. </div> <div class="section" id="s-month-day-format"> <h3><code class="docutils literal notranslate">MONTH_DAY_FORMAT</code><a class="headerlink" href="#month-day-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'F j'</code> The default formatting to use for date fields on Django admin change-list pages – and, possibly, by other parts of the system – in cases when only the month and day are displayed. For example, when a Django admin change-list page is being filtered by a date drilldown, the header for a given day displays the day and month. Different locales have different formats. For example, U.S. English would say “January 1,” whereas Spanish might say “1 Enero.” Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the corresponding locale-dictated format has higher precedence and will be applied. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a>, <a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a>, <a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a> and <a class="reference internal" href="#std:setting-YEAR_MONTH_FORMAT"><code class="xref std std-setting docutils literal notranslate">YEAR_MONTH_FORMAT</code></a>. </div> <div class="section" id="s-number-grouping"> <h3><code class="docutils literal notranslate">NUMBER_GROUPING</code><a class="headerlink" href="#number-grouping" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">0</code> Number of digits grouped together on the integer part of a number. Common use is to display a thousand separator. If this setting is <code class="docutils literal notranslate">0</code>, then no grouping will be applied to the number. If this setting is greater than <code class="docutils literal notranslate">0</code>, then <a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a> will be used as the separator between those groups. Some locales use non-uniform digit grouping, e.g. <code class="docutils literal notranslate">10,00,00,000</code> in <code class="docutils literal notranslate">en_IN</code>. For this case, you can provide a sequence with the number of digit group sizes to be applied. The first number defines the size of the group preceding the decimal delimiter, and each number that follows defines the size of preceding groups. If the sequence is terminated with <code class="docutils literal notranslate">-1</code>, no further grouping is performed. If the sequence terminates with a <code class="docutils literal notranslate">0</code>, the last group size is used for the remainder of the number. Example tuple for <code class="docutils literal notranslate">en_IN</code>: <div class="highlight-default notranslate"><div class="highlight"><pre>NUMBER_GROUPING = (3, 2, 0) </pre></div> </div> Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-DECIMAL_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">DECIMAL_SEPARATOR</code></a>, <a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a> and <a class="reference internal" href="#std:setting-USE_THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a>. </div> <div class="section" id="s-prepend-www"> <h3><code class="docutils literal notranslate">PREPEND_WWW</code><a class="headerlink" href="#prepend-www" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to prepend the “www.” subdomain to URLs that don’t have it. This is only used if <a class="reference internal" href="../middleware/#django.middleware.common.CommonMiddleware" title="django.middleware.common.CommonMiddleware"><code class="xref py py-class docutils literal notranslate">CommonMiddleware</code></a> is installed (see <a class="reference internal" href="../../topics/http/middleware/">Middleware</a>). See also <a class="reference internal" href="#std:setting-APPEND_SLASH"><code class="xref std std-setting docutils literal notranslate">APPEND_SLASH</code></a>. </div> <div class="section" id="s-root-urlconf"> <h3><code class="docutils literal notranslate">ROOT_URLCONF</code><a class="headerlink" href="#root-urlconf" title="Permalink to this headline">¶</a></h3> Default: Not defined A string representing the full Python import path to your root URLconf, for example <code class="docutils literal notranslate">"mydjangoapps.urls"</code>. Can be overridden on a per-request basis by setting the attribute <code class="docutils literal notranslate">urlconf</code> on the incoming <code class="docutils literal notranslate">HttpRequest</code> object. See <a class="reference internal" href="../../topics/http/urls/#how-django-processes-a-request">How Django processes a request</a> for details. </div> <div class="section" id="s-secret-key"> <h3><code class="docutils literal notranslate">SECRET_KEY</code><a class="headerlink" href="#secret-key" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">''</code> (Empty string) A secret key for a particular Django installation. This is used to provide <a class="reference internal" href="../../topics/signing/">cryptographic signing</a>, and should be set to a unique, unpredictable value. <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> automatically adds a randomly-generated <code class="docutils literal notranslate">SECRET_KEY</code> to each new project. Uses of the key shouldn’t assume that it’s text or bytes. Every use should go through <a class="reference internal" href="../utils/#django.utils.encoding.force_str" title="django.utils.encoding.force_str"><code class="xref py py-func docutils literal notranslate">force_str()</code></a> or <a class="reference internal" href="../utils/#django.utils.encoding.force_bytes" title="django.utils.encoding.force_bytes"><code class="xref py py-func docutils literal notranslate">force_bytes()</code></a> to convert it to the desired type. Django will refuse to start if <a class="reference internal" href="#std:setting-SECRET_KEY"><code class="xref std std-setting docutils literal notranslate">SECRET_KEY</code></a> is not set. <div class="admonition warning"> Warning Keep this value secret. Running Django with a known <a class="reference internal" href="#std:setting-SECRET_KEY"><code class="xref std std-setting docutils literal notranslate">SECRET_KEY</code></a> defeats many of Django’s security protections, and can lead to privilege escalation and remote code execution vulnerabilities. </div> The secret key is used for: <ul class="simple"> <li>All <a class="reference internal" href="../../topics/http/sessions/">sessions</a> if you are using any other session backend than <code class="docutils literal notranslate">django.contrib.sessions.backends.cache</code>, or are using the default <a class="reference internal" href="../../topics/auth/customizing/#django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash" title="django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash"><code class="xref py py-meth docutils literal notranslate">get_session_auth_hash()</code></a>.</li> <li>All <a class="reference internal" href="../contrib/messages/">messages</a> if you are using <a class="reference internal" href="../contrib/messages/#django.contrib.messages.storage.cookie.CookieStorage" title="django.contrib.messages.storage.cookie.CookieStorage"><code class="xref py py-class docutils literal notranslate">CookieStorage</code></a> or <a class="reference internal" href="../contrib/messages/#django.contrib.messages.storage.fallback.FallbackStorage" title="django.contrib.messages.storage.fallback.FallbackStorage"><code class="xref py py-class docutils literal notranslate">FallbackStorage</code></a>.</li> <li>All <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.views.PasswordResetView" title="django.contrib.auth.views.PasswordResetView"><code class="xref py py-class docutils literal notranslate">PasswordResetView</code></a> tokens.</li> <li>Any usage of <a class="reference internal" href="../../topics/signing/">cryptographic signing</a>, unless a different key is provided.</li> </ul> If you rotate your secret key, all of the above will be invalidated. Secret keys are not used for passwords of users and key rotation will not affect them. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> creates a unique <code class="docutils literal notranslate">SECRET_KEY</code> for convenience. </div> </div> <div class="section" id="s-secure-browser-xss-filter"> <h3><code class="docutils literal notranslate">SECURE_BROWSER_XSS_FILTER</code><a class="headerlink" href="#secure-browser-xss-filter" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> If <code class="docutils literal notranslate">True</code>, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> sets the <a class="reference internal" href="../middleware/#x-xss-protection">X-XSS-Protection: 1; mode=block</a> header on all responses that do not already have it. Modern browsers don’t honor <code class="docutils literal notranslate">X-XSS-Protection</code> HTTP header anymore. Although the setting offers little practical benefit, you may still want to set the header if you support older browsers. </div> <div class="section" id="s-secure-content-type-nosniff"> <h3><code class="docutils literal notranslate">SECURE_CONTENT_TYPE_NOSNIFF</code><a class="headerlink" href="#secure-content-type-nosniff" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">True</code> If <code class="docutils literal notranslate">True</code>, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> sets the <a class="reference internal" href="../middleware/#x-content-type-options">X-Content-Type-Options: nosniff</a> header on all responses that do not already have it. <div class="versionchanged"> Changed in Django 3.0: In older versions, the default value is <code class="docutils literal notranslate">False</code>. </div> </div> <div class="section" id="s-secure-hsts-include-subdomains"> <h3><code class="docutils literal notranslate">SECURE_HSTS_INCLUDE_SUBDOMAINS</code><a class="headerlink" href="#secure-hsts-include-subdomains" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> If <code class="docutils literal notranslate">True</code>, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> adds the <code class="docutils literal notranslate">includeSubDomains</code> directive to the <a class="reference internal" href="../middleware/#http-strict-transport-security">HTTP Strict Transport Security</a> header. It has no effect unless <a class="reference internal" href="#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_SECONDS</code></a> is set to a non-zero value. <div class="admonition warning"> Warning Setting this incorrectly can irreversibly (for the value of <a class="reference internal" href="#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_SECONDS</code></a>) break your site. Read the <a class="reference internal" href="../middleware/#http-strict-transport-security">HTTP Strict Transport Security</a> documentation first. </div> </div> <div class="section" id="s-secure-hsts-preload"> <h3><code class="docutils literal notranslate">SECURE_HSTS_PRELOAD</code><a class="headerlink" href="#secure-hsts-preload" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> If <code class="docutils literal notranslate">True</code>, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> adds the <code class="docutils literal notranslate">preload</code> directive to the <a class="reference internal" href="../middleware/#http-strict-transport-security">HTTP Strict Transport Security</a> header. It has no effect unless <a class="reference internal" href="#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_SECONDS</code></a> is set to a non-zero value. </div> <div class="section" id="s-secure-hsts-seconds"> <h3><code class="docutils literal notranslate">SECURE_HSTS_SECONDS</code><a class="headerlink" href="#secure-hsts-seconds" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">0</code> If set to a non-zero integer value, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> sets the <a class="reference internal" href="../middleware/#http-strict-transport-security">HTTP Strict Transport Security</a> header on all responses that do not already have it. <div class="admonition warning"> Warning Setting this incorrectly can irreversibly (for some time) break your site. Read the <a class="reference internal" href="../middleware/#http-strict-transport-security">HTTP Strict Transport Security</a> documentation first. </div> </div> <div class="section" id="s-secure-proxy-ssl-header"> <h3><code class="docutils literal notranslate">SECURE_PROXY_SSL_HEADER</code><a class="headerlink" href="#secure-proxy-ssl-header" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> A tuple representing a HTTP header/value combination that signifies a request is secure. This controls the behavior of the request object’s <code class="docutils literal notranslate">is_secure()</code> method. By default, <code class="docutils literal notranslate">is_secure()</code> determines if a request is secure by confirming that a requested URL uses <code class="docutils literal notranslate">https://</code>. This method is important for Django’s CSRF protection, and it may be used by your own code or third-party apps. If your Django app is behind a proxy, though, the proxy may be “swallowing” whether the original request uses HTTPS or not. If there is a non-HTTPS connection between the proxy and Django then <code class="docutils literal notranslate">is_secure()</code> would always return <code class="docutils literal notranslate">False</code> – even for requests that were made via HTTPS by the end user. In contrast, if there is an HTTPS connection between the proxy and Django then <code class="docutils literal notranslate">is_secure()</code> would always return <code class="docutils literal notranslate">True</code> – even for requests that were made originally via HTTP. In this situation, configure your proxy to set a custom HTTP header that tells Django whether the request came in via HTTPS, and set <code class="docutils literal notranslate">SECURE_PROXY_SSL_HEADER</code> so that Django knows what header to look for. Set a tuple with two elements – the name of the header to look for and the required value. For example: <div class="highlight-default notranslate"><div class="highlight"><pre>SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') </pre></div> </div> This tells Django to trust the <code class="docutils literal notranslate">X-Forwarded-Proto</code> header that comes from our proxy, and any time its value is <code class="docutils literal notranslate">'https'</code>, then the request is guaranteed to be secure (i.e., it originally came in via HTTPS). You should only set this setting if you control your proxy or have some other guarantee that it sets/strips this header appropriately. Note that the header needs to be in the format as used by <code class="docutils literal notranslate">request.META</code> – all caps and likely starting with <code class="docutils literal notranslate">HTTP_</code>. (Remember, Django automatically adds <code class="docutils literal notranslate">'HTTP_'</code> to the start of x-header names before making the header available in <code class="docutils literal notranslate">request.META</code>.) <div class="admonition warning"> Warning Modifying this setting can compromise your site’s security. Ensure you fully understand your setup before changing it. Make sure ALL of the following are true before setting this (assuming the values from the example above): <ul class="simple"> <li>Your Django app is behind a proxy.</li> <li>Your proxy strips the <code class="docutils literal notranslate">X-Forwarded-Proto</code> header from all incoming requests. In other words, if end users include that header in their requests, the proxy will discard it.</li> <li>Your proxy sets the <code class="docutils literal notranslate">X-Forwarded-Proto</code> header and sends it to Django, but only for requests that originally come in via HTTPS.</li> </ul> If any of those are not true, you should keep this setting set to <code class="docutils literal notranslate">None</code> and find another way of determining HTTPS, perhaps via custom middleware. </div> </div> <div class="section" id="s-secure-redirect-exempt"> <h3><code class="docutils literal notranslate">SECURE_REDIRECT_EXEMPT</code><a class="headerlink" href="#secure-redirect-exempt" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) If a URL path matches a regular expression in this list, the request will not be redirected to HTTPS. The <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> strips leading slashes from URL paths, so patterns shouldn’t include them, e.g. <code class="docutils literal notranslate">SECURE_REDIRECT_EXEMPT = [r'^no-ssl/$', …]</code>. If <a class="reference internal" href="#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal notranslate">SECURE_SSL_REDIRECT</code></a> is <code class="docutils literal notranslate">False</code>, this setting has no effect. </div> <div class="section" id="s-secure-referrer-policy"> <h3><code class="docutils literal notranslate">SECURE_REFERRER_POLICY</code><a class="headerlink" href="#secure-referrer-policy" title="Permalink to this headline">¶</a></h3> <div class="versionadded"> New in Django 3.0. </div> Default: <code class="docutils literal notranslate">None</code> If configured, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> sets the <a class="reference internal" href="../middleware/#referrer-policy">Referrer Policy</a> header on all responses that do not already have it to the value provided. </div> <div class="section" id="s-secure-ssl-host"> <h3><code class="docutils literal notranslate">SECURE_SSL_HOST</code><a class="headerlink" href="#secure-ssl-host" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> If a string (e.g. <code class="docutils literal notranslate">secure.example.com</code>), all SSL redirects will be directed to this host rather than the originally-requested host (e.g. <code class="docutils literal notranslate">www.example.com</code>). If <a class="reference internal" href="#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal notranslate">SECURE_SSL_REDIRECT</code></a> is <code class="docutils literal notranslate">False</code>, this setting has no effect. </div> <div class="section" id="s-secure-ssl-redirect"> <h3><code class="docutils literal notranslate">SECURE_SSL_REDIRECT</code><a class="headerlink" href="#secure-ssl-redirect" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> If <code class="docutils literal notranslate">True</code>, the <a class="reference internal" href="../middleware/#django.middleware.security.SecurityMiddleware" title="django.middleware.security.SecurityMiddleware"><code class="xref py py-class docutils literal notranslate">SecurityMiddleware</code></a> <a class="reference internal" href="../middleware/#ssl-redirect">redirects</a> all non-HTTPS requests to HTTPS (except for those URLs matching a regular expression listed in <a class="reference internal" href="#std:setting-SECURE_REDIRECT_EXEMPT"><code class="xref std std-setting docutils literal notranslate">SECURE_REDIRECT_EXEMPT</code></a>). <div class="admonition note"> Note If turning this to <code class="docutils literal notranslate">True</code> causes infinite redirects, it probably means your site is running behind a proxy and can’t tell which requests are secure and which are not. Your proxy likely sets a header to indicate secure requests; you can correct the problem by finding out what that header is and configuring the <a class="reference internal" href="#std:setting-SECURE_PROXY_SSL_HEADER"><code class="xref std std-setting docutils literal notranslate">SECURE_PROXY_SSL_HEADER</code></a> setting accordingly. </div> </div> <div class="section" id="s-serialization-modules"> <h3><code class="docutils literal notranslate">SERIALIZATION_MODULES</code><a class="headerlink" href="#serialization-modules" title="Permalink to this headline">¶</a></h3> Default: Not defined A dictionary of modules containing serializer definitions (provided as strings), keyed by a string identifier for that serialization type. For example, to define a YAML serializer, use: <div class="highlight-default notranslate"><div class="highlight"><pre>SERIALIZATION_MODULES = {'yaml': 'path.to.yaml_serializer'} </pre></div> </div> </div> <div class="section" id="s-server-email"> <h3><code class="docutils literal notranslate">SERVER_EMAIL</code><a class="headerlink" href="#server-email" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'root@localhost'</code> The email address that error messages come from, such as those sent to <a class="reference internal" href="#std:setting-ADMINS"><code class="xref std std-setting docutils literal notranslate">ADMINS</code></a> and <a class="reference internal" href="#std:setting-MANAGERS"><code class="xref std std-setting docutils literal notranslate">MANAGERS</code></a>. <div class="admonition-why-are-my-emails-sent-from-a-different-address admonition"> Why are my emails sent from a different address? This address is used only for error messages. It is not the address that regular email messages sent with <a class="reference internal" href="../../topics/email/#django.core.mail.send_mail" title="django.core.mail.send_mail"><code class="xref py py-meth docutils literal notranslate">send_mail()</code></a> come from; for that, see <a class="reference internal" href="#std:setting-DEFAULT_FROM_EMAIL"><code class="xref std std-setting docutils literal notranslate">DEFAULT_FROM_EMAIL</code></a>. </div> </div> <div class="section" id="s-short-date-format"> <h3><code class="docutils literal notranslate">SHORT_DATE_FORMAT</code><a class="headerlink" href="#short-date-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'m/d/Y'</code> (e.g. <code class="docutils literal notranslate">12/31/2003</code>) An available formatting that can be used for displaying date fields on templates. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the corresponding locale-dictated format has higher precedence and will be applied. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a> and <a class="reference internal" href="#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATETIME_FORMAT</code></a>. </div> <div class="section" id="s-short-datetime-format"> <h3><code class="docutils literal notranslate">SHORT_DATETIME_FORMAT</code><a class="headerlink" href="#short-datetime-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'m/d/Y P'</code> (e.g. <code class="docutils literal notranslate">12/31/2003 4 p.m.</code>) An available formatting that can be used for displaying datetime fields on templates. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the corresponding locale-dictated format has higher precedence and will be applied. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a> and <a class="reference internal" href="#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATE_FORMAT</code></a>. </div> <div class="section" id="s-signing-backend"> <h3><code class="docutils literal notranslate">SIGNING_BACKEND</code><a class="headerlink" href="#signing-backend" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.core.signing.TimestampSigner'</code> The backend used for signing cookies and other data. See also the <a class="reference internal" href="../../topics/signing/">Cryptographic signing</a> documentation. </div> <div class="section" id="s-silenced-system-checks"> <h3><code class="docutils literal notranslate">SILENCED_SYSTEM_CHECKS</code><a class="headerlink" href="#silenced-system-checks" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list of identifiers of messages generated by the system check framework (i.e. <code class="docutils literal notranslate">["models.W001"]</code>) that you wish to permanently acknowledge and ignore. Silenced checks will not be output to the console. See also the <a class="reference internal" href="../checks/">System check framework</a> documentation. </div> <div class="section" id="s-templates"> <h3><code class="docutils literal notranslate">TEMPLATES</code><a class="headerlink" href="#templates" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) A list containing the settings for all template engines to be used with Django. Each item of the list is a dictionary containing the options for an individual engine. Here’s a setup that tells the Django template engine to load templates from the <code class="docutils literal notranslate">templates</code> subdirectory inside each installed application: <div class="highlight-default notranslate"><div class="highlight"><pre>TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'APP_DIRS': True, }, ] </pre></div> </div> The following options are available for all backends. <div class="section" id="s-std:setting-TEMPLATES-BACKEND"> <h4><code class="docutils literal notranslate">BACKEND</code><a class="headerlink" href="#std:setting-TEMPLATES-BACKEND" title="Permalink to this headline">¶</a></h4> Default: Not defined The template backend to use. The built-in template backends are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.template.backends.django.DjangoTemplates'</code></li> <li><code class="docutils literal notranslate">'django.template.backends.jinja2.Jinja2'</code></li> </ul> You can use a template backend that doesn’t ship with Django by setting <code class="docutils literal notranslate">BACKEND</code> to a fully-qualified path (i.e. <code class="docutils literal notranslate">'mypackage.whatever.Backend'</code>). </div> <div class="section" id="s-std:setting-TEMPLATES-NAME"> <h4><code class="docutils literal notranslate">NAME</code><a class="headerlink" href="#std:setting-TEMPLATES-NAME" title="Permalink to this headline">¶</a></h4> Default: see below The alias for this particular template engine. It’s an identifier that allows selecting an engine for rendering. Aliases must be unique across all configured template engines. It defaults to the name of the module defining the engine class, i.e. the next to last piece of <a class="reference internal" href="#std:setting-TEMPLATES-BACKEND"><code class="xref std std-setting docutils literal notranslate">BACKEND</code></a>, when it isn’t provided. For example if the backend is <code class="docutils literal notranslate">'mypackage.whatever.Backend'</code> then its default name is <code class="docutils literal notranslate">'whatever'</code>. </div> <div class="section" id="s-dirs"> <h4><code class="docutils literal notranslate">DIRS</code><a class="headerlink" href="#dirs" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">[]</code> (Empty list) Directories where the engine should look for template source files, in search order. </div> <div class="section" id="s-app-dirs"> <h4><code class="docutils literal notranslate">APP_DIRS</code><a class="headerlink" href="#app-dirs" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">False</code> Whether the engine should look for template source files inside installed applications. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> sets <code class="docutils literal notranslate">'APP_DIRS': True</code>. </div> </div> <div class="section" id="s-std:setting-TEMPLATES-OPTIONS"> <h4><code class="docutils literal notranslate">OPTIONS</code><a class="headerlink" href="#std:setting-TEMPLATES-OPTIONS" title="Permalink to this headline">¶</a></h4> Default: <code class="docutils literal notranslate">{}</code> (Empty dict) Extra parameters to pass to the template backend. Available parameters vary depending on the template backend. See <a class="reference internal" href="../../topics/templates/#django.template.backends.django.DjangoTemplates" title="django.template.backends.django.DjangoTemplates"><code class="xref py py-class docutils literal notranslate">DjangoTemplates</code></a> and <a class="reference internal" href="../../topics/templates/#django.template.backends.jinja2.Jinja2" title="django.template.backends.jinja2.Jinja2"><code class="xref py py-class docutils literal notranslate">Jinja2</code></a> for the options of the built-in backends. </div> </div> <div class="section" id="s-test-runner"> <h3><code class="docutils literal notranslate">TEST_RUNNER</code><a class="headerlink" href="#test-runner" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.test.runner.DiscoverRunner'</code> The name of the class to use for starting the test suite. See <a class="reference internal" href="../../topics/testing/advanced/#other-testing-frameworks">Using different testing frameworks</a>. </div> <div class="section" id="s-test-non-serialized-apps"> <h3><code class="docutils literal notranslate">TEST_NON_SERIALIZED_APPS</code><a class="headerlink" href="#test-non-serialized-apps" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) In order to restore the database state between tests for <code class="docutils literal notranslate">TransactionTestCase</code>s and database backends without transactions, Django will <a class="reference internal" href="../../topics/testing/overview/#test-case-serialized-rollback">serialize the contents of all apps</a> when it starts the test run so it can then reload from that copy before running tests that need it. This slows down the startup time of the test runner; if you have apps that you know don’t need this feature, you can add their full names in here (e.g. <code class="docutils literal notranslate">'django.contrib.contenttypes'</code>) to exclude them from this serialization process. </div> <div class="section" id="s-thousand-separator"> <h3><code class="docutils literal notranslate">THOUSAND_SEPARATOR</code><a class="headerlink" href="#thousand-separator" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">','</code> (Comma) Default thousand separator used when formatting numbers. This setting is used only when <a class="reference internal" href="#std:setting-USE_THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a> is <code class="docutils literal notranslate">True</code> and <a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a> is greater than <code class="docutils literal notranslate">0</code>. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a>, <a class="reference internal" href="#std:setting-DECIMAL_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">DECIMAL_SEPARATOR</code></a> and <a class="reference internal" href="#std:setting-USE_THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a>. </div> <div class="section" id="s-time-format"> <h3><code class="docutils literal notranslate">TIME_FORMAT</code><a class="headerlink" href="#time-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'P'</code> (e.g. <code class="docutils literal notranslate">4 p.m.</code>) The default formatting to use for displaying time fields in any part of the system. Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the locale-dictated format has higher precedence and will be applied instead. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a> and <a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a>. </div> <div class="section" id="s-time-input-formats"> <h3><code class="docutils literal notranslate">TIME_INPUT_FORMATS</code><a class="headerlink" href="#time-input-formats" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ '%H:%M:%S', # '14:30:59' '%H:%M:%S.%f', # '14:30:59.000200' '%H:%M', # '14:30' ] </pre></div> </div> A list of formats that will be accepted when inputting data on a time field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s <a class="reference external" href="https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior" title="(in Python v3.9)">datetime module syntax</a>, not the format strings from the <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">date</code></a> template filter. When <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is <code class="docutils literal notranslate">True</code>, the locale-dictated format has higher precedence and will be applied instead. See also <a class="reference internal" href="#std:setting-DATE_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATE_INPUT_FORMATS</code></a> and <a class="reference internal" href="#std:setting-DATETIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATETIME_INPUT_FORMATS</code></a>. </div> <div class="section" id="s-std:setting-TIME_ZONE"> <h3><code class="docutils literal notranslate">TIME_ZONE</code><a class="headerlink" href="#std:setting-TIME_ZONE" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'America/Chicago'</code> A string representing the time zone for this installation. See the <a class="reference external" href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">list of time zones</a>. <div class="admonition note"> Note Since Django was first released with the <a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a> set to <code class="docutils literal notranslate">'America/Chicago'</code>, the global setting (used if nothing is defined in your project’s <code class="docutils literal notranslate">settings.py</code>) remains <code class="docutils literal notranslate">'America/Chicago'</code> for backwards compatibility. New project templates default to <code class="docutils literal notranslate">'UTC'</code>. </div> Note that this isn’t necessarily the time zone of the server. For example, one server may serve multiple Django-powered sites, each with a separate time zone setting. When <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a> is <code class="docutils literal notranslate">False</code>, this is the time zone in which Django will store all datetimes. When <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a> is <code class="docutils literal notranslate">True</code>, this is the default time zone that Django will use to display datetimes in templates and to interpret datetimes entered in forms. On Unix environments (where <a class="reference external" href="https://docs.python.org/3/library/time.html#time.tzset" title="(in Python v3.9)"><code class="xref py py-func docutils literal notranslate">time.tzset()</code></a> is implemented), Django sets the <code class="docutils literal notranslate">os.environ['TZ']</code> variable to the time zone you specify in the <a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a> setting. Thus, all your views and models will automatically operate in this time zone. However, Django won’t set the <code class="docutils literal notranslate">TZ</code> environment variable if you’re using the manual configuration option as described in <a class="reference internal" href="../../topics/settings/#settings-without-django-settings-module">manually configuring settings</a>. If Django doesn’t set the <code class="docutils literal notranslate">TZ</code> environment variable, it’s up to you to ensure your processes are running in the correct environment. <div class="admonition note"> Note Django cannot reliably use alternate time zones in a Windows environment. If you’re running Django on Windows, <a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a> must be set to match the system time zone. </div> </div> <div class="section" id="s-use-i18n"> <h3><code class="docutils literal notranslate">USE_I18N</code><a class="headerlink" href="#use-i18n" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">True</code> A boolean that specifies whether Django’s translation system should be enabled. This provides a way to turn it off, for performance. If this is set to <code class="docutils literal notranslate">False</code>, Django will make some optimizations so as not to load the translation machinery. See also <a class="reference internal" href="#std:setting-LANGUAGE_CODE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_CODE</code></a>, <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> and <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a>. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> includes <code class="docutils literal notranslate">USE_I18N = True</code> for convenience. </div> </div> <div class="section" id="s-use-l10n"> <h3><code class="docutils literal notranslate">USE_L10N</code><a class="headerlink" href="#use-l10n" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that specifies if localized formatting of data will be enabled by default or not. If this is set to <code class="docutils literal notranslate">True</code>, e.g. Django will display numbers and dates using the format of the current locale. See also <a class="reference internal" href="#std:setting-LANGUAGE_CODE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_CODE</code></a>, <a class="reference internal" href="#std:setting-USE_I18N"><code class="xref std std-setting docutils literal notranslate">USE_I18N</code></a> and <a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a>. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> includes <code class="docutils literal notranslate">USE_L10N = True</code> for convenience. </div> </div> <div class="section" id="s-use-thousand-separator"> <h3><code class="docutils literal notranslate">USE_THOUSAND_SEPARATOR</code><a class="headerlink" href="#use-thousand-separator" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that specifies whether to display numbers using a thousand separator. When set to <code class="docutils literal notranslate">True</code> and <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is also <code class="docutils literal notranslate">True</code>, Django will format numbers using the <a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a> and <a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a> settings. These settings may also be dictated by the locale, which takes precedence. See also <a class="reference internal" href="#std:setting-DECIMAL_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">DECIMAL_SEPARATOR</code></a>, <a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a> and <a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a>. </div> <div class="section" id="s-use-tz"> <h3><code class="docutils literal notranslate">USE_TZ</code><a class="headerlink" href="#use-tz" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that specifies if datetimes will be timezone-aware by default or not. If this is set to <code class="docutils literal notranslate">True</code>, Django will use timezone-aware datetimes internally. Otherwise, Django will use naive datetimes in local time. See also <a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a>, <a class="reference internal" href="#std:setting-USE_I18N"><code class="xref std std-setting docutils literal notranslate">USE_I18N</code></a> and <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a>. <div class="admonition note"> Note The default <code class="file docutils literal notranslate">settings.py</code> file created by <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> includes <code class="docutils literal notranslate">USE_TZ = True</code> for convenience. </div> </div> <div class="section" id="s-use-x-forwarded-host"> <h3><code class="docutils literal notranslate">USE_X_FORWARDED_HOST</code><a class="headerlink" href="#use-x-forwarded-host" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that specifies whether to use the <code class="docutils literal notranslate">X-Forwarded-Host</code> header in preference to the <code class="docutils literal notranslate">Host</code> header. This should only be enabled if a proxy which sets this header is in use. This setting takes priority over <a class="reference internal" href="#std:setting-USE_X_FORWARDED_PORT"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_PORT</code></a>. Per <a class="rfc reference external" href="https://tools.ietf.org/html/rfc7239.html#section-5.3">RFC 7239#section-5.3</a>, the <code class="docutils literal notranslate">X-Forwarded-Host</code> header can include the port number, in which case you shouldn’t use <a class="reference internal" href="#std:setting-USE_X_FORWARDED_PORT"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_PORT</code></a>. </div> <div class="section" id="s-use-x-forwarded-port"> <h3><code class="docutils literal notranslate">USE_X_FORWARDED_PORT</code><a class="headerlink" href="#use-x-forwarded-port" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> A boolean that specifies whether to use the <code class="docutils literal notranslate">X-Forwarded-Port</code> header in preference to the <code class="docutils literal notranslate">SERVER_PORT</code> <code class="docutils literal notranslate">META</code> variable. This should only be enabled if a proxy which sets this header is in use. <a class="reference internal" href="#std:setting-USE_X_FORWARDED_HOST"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_HOST</code></a> takes priority over this setting. </div> <div class="section" id="s-wsgi-application"> <h3><code class="docutils literal notranslate">WSGI_APPLICATION</code><a class="headerlink" href="#wsgi-application" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The full Python path of the WSGI application object that Django’s built-in servers (e.g. <a class="reference internal" href="../django-admin/#django-admin-runserver"><code class="xref std std-djadmin docutils literal notranslate">runserver</code></a>) will use. The <a class="reference internal" href="../django-admin/#django-admin-startproject"><code class="xref std std-djadmin docutils literal notranslate">django-admin startproject</code></a> management command will create a standard <code class="docutils literal notranslate">wsgi.py</code> file with an <code class="docutils literal notranslate">application</code> callable in it, and point this setting to that <code class="docutils literal notranslate">application</code>. If not set, the return value of <code class="docutils literal notranslate">django.core.wsgi.get_wsgi_application()</code> will be used. In this case, the behavior of <a class="reference internal" href="../django-admin/#django-admin-runserver"><code class="xref std std-djadmin docutils literal notranslate">runserver</code></a> will be identical to previous Django versions. </div> <div class="section" id="s-year-month-format"> <h3><code class="docutils literal notranslate">YEAR_MONTH_FORMAT</code><a class="headerlink" href="#year-month-format" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'F Y'</code> The default formatting to use for date fields on Django admin change-list pages – and, possibly, by other parts of the system – in cases when only the year and month are displayed. For example, when a Django admin change-list page is being filtered by a date drilldown, the header for a given month displays the month and the year. Different locales have different formats. For example, U.S. English would say “January 2006,” whereas another locale might say “2006/January.” Note that if <a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a> is set to <code class="docutils literal notranslate">True</code>, then the corresponding locale-dictated format has higher precedence and will be applied. See <a class="reference internal" href="../templates/builtins/#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate">allowed date format strings</code></a>. See also <a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a>, <a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a>, <a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a> and <a class="reference internal" href="#std:setting-MONTH_DAY_FORMAT"><code class="xref std std-setting docutils literal notranslate">MONTH_DAY_FORMAT</code></a>. </div> <div class="section" id="s-x-frame-options"> <h3><code class="docutils literal notranslate">X_FRAME_OPTIONS</code><a class="headerlink" href="#x-frame-options" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'DENY'</code> The default value for the X-Frame-Options header used by <a class="reference internal" href="../middleware/#django.middleware.clickjacking.XFrameOptionsMiddleware" title="django.middleware.clickjacking.XFrameOptionsMiddleware"><code class="xref py py-class docutils literal notranslate">XFrameOptionsMiddleware</code></a>. See the <a class="reference internal" href="../clickjacking/">clickjacking protection</a> documentation. <div class="versionchanged"> Changed in Django 3.0: In older versions, the default value is <code class="docutils literal notranslate">SAMEORIGIN</code>. </div> </div> </div> <div class="section" id="s-auth"> <h2><a class="toc-backref" href="#id13">Auth</a><a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h2> Settings for <a class="reference internal" href="../../topics/auth/#module-django.contrib.auth" title="django.contrib.auth: Django's authentication framework."><code class="xref py py-mod docutils literal notranslate">django.contrib.auth</code></a>. <div class="section" id="s-authentication-backends"> <h3><code class="docutils literal notranslate">AUTHENTICATION_BACKENDS</code><a class="headerlink" href="#authentication-backends" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">['django.contrib.auth.backends.ModelBackend']</code> A list of authentication backend classes (as strings) to use when attempting to authenticate a user. See the <a class="reference internal" href="../../topics/auth/customizing/#authentication-backends">authentication backends documentation</a> for details. </div> <div class="section" id="s-auth-user-model"> <h3><code class="docutils literal notranslate">AUTH_USER_MODEL</code><a class="headerlink" href="#auth-user-model" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'auth.User'</code> The model to use to represent a User. See <a class="reference internal" href="../../topics/auth/customizing/#auth-custom-user">Substituting a custom User model</a>. <div class="admonition warning"> Warning You cannot change the AUTH_USER_MODEL setting during the lifetime of a project (i.e. once you have made and migrated models that depend on it) without serious effort. It is intended to be set at the project start, and the model it refers to must be available in the first migration of the app that it lives in. See <a class="reference internal" href="../../topics/auth/customizing/#auth-custom-user">Substituting a custom User model</a> for more details. </div> </div> <div class="section" id="s-login-redirect-url"> <h3><code class="docutils literal notranslate">LOGIN_REDIRECT_URL</code><a class="headerlink" href="#login-redirect-url" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'/accounts/profile/'</code> The URL or <a class="reference internal" href="../../topics/http/urls/#naming-url-patterns">named URL pattern</a> where requests are redirected after login when the <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.views.LoginView" title="django.contrib.auth.views.LoginView"><code class="xref py py-class docutils literal notranslate">LoginView</code></a> doesn’t get a <code class="docutils literal notranslate">next</code> GET parameter. </div> <div class="section" id="s-login-url"> <h3><code class="docutils literal notranslate">LOGIN_URL</code><a class="headerlink" href="#login-url" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'/accounts/login/'</code> The URL or <a class="reference internal" href="../../topics/http/urls/#naming-url-patterns">named URL pattern</a> where requests are redirected for login when using the <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.decorators.login_required" title="django.contrib.auth.decorators.login_required"><code class="xref py py-func docutils literal notranslate">login_required()</code></a> decorator, <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.mixins.LoginRequiredMixin" title="django.contrib.auth.mixins.LoginRequiredMixin"><code class="xref py py-class docutils literal notranslate">LoginRequiredMixin</code></a>, or <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.mixins.AccessMixin" title="django.contrib.auth.mixins.AccessMixin"><code class="xref py py-class docutils literal notranslate">AccessMixin</code></a>. </div> <div class="section" id="s-logout-redirect-url"> <h3><code class="docutils literal notranslate">LOGOUT_REDIRECT_URL</code><a class="headerlink" href="#logout-redirect-url" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The URL or <a class="reference internal" href="../../topics/http/urls/#naming-url-patterns">named URL pattern</a> where requests are redirected after logout if <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.views.LogoutView" title="django.contrib.auth.views.LogoutView"><code class="xref py py-class docutils literal notranslate">LogoutView</code></a> doesn’t have a <code class="docutils literal notranslate">next_page</code> attribute. If <code class="docutils literal notranslate">None</code>, no redirect will be performed and the logout view will be rendered. </div> <div class="section" id="s-password-reset-timeout-days"> <h3><code class="docutils literal notranslate">PASSWORD_RESET_TIMEOUT_DAYS</code><a class="headerlink" href="#password-reset-timeout-days" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">3</code> The minimum number of days a password reset link is valid for. Depending on when the link is generated, it will be valid for up to a day longer. Used by the <a class="reference internal" href="../../topics/auth/default/#django.contrib.auth.views.PasswordResetConfirmView" title="django.contrib.auth.views.PasswordResetConfirmView"><code class="xref py py-class docutils literal notranslate">PasswordResetConfirmView</code></a>. </div> <div class="section" id="s-password-hashers"> <h3><code class="docutils literal notranslate">PASSWORD_HASHERS</code><a class="headerlink" href="#password-hashers" title="Permalink to this headline">¶</a></h3> See <a class="reference internal" href="../../topics/auth/passwords/#auth-password-storage">How Django stores passwords</a>. Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ 'django.contrib.auth.hashers.PBKDF2PasswordHasher', 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher', 'django.contrib.auth.hashers.Argon2PasswordHasher', 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher', ] </pre></div> </div> </div> <div class="section" id="s-auth-password-validators"> <h3><code class="docutils literal notranslate">AUTH_PASSWORD_VALIDATORS</code><a class="headerlink" href="#auth-password-validators" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) The list of validators that are used to check the strength of user’s passwords. See <a class="reference internal" href="../../topics/auth/passwords/#password-validation">Password validation</a> for more details. By default, no validation is performed and all passwords are accepted. </div> </div> <div class="section" id="s-messages"> <h2><a class="toc-backref" href="#id14">Messages</a><a class="headerlink" href="#messages" title="Permalink to this headline">¶</a></h2> Settings for <a class="reference internal" href="../contrib/messages/#module-django.contrib.messages" title="django.contrib.messages: Provides cookie- and session-based temporary message storage."><code class="xref py py-mod docutils literal notranslate">django.contrib.messages</code></a>. <div class="section" id="s-message-level"> <h3><code class="docutils literal notranslate">MESSAGE_LEVEL</code><a class="headerlink" href="#message-level" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">messages.INFO</code> Sets the minimum message level that will be recorded by the messages framework. See <a class="reference internal" href="../contrib/messages/#message-level">message levels</a> for more details. <div class="admonition-important admonition"> Important If you override <code class="docutils literal notranslate">MESSAGE_LEVEL</code> in your settings file and rely on any of the built-in constants, you must import the constants module directly to avoid the potential for circular imports, e.g.: <div class="highlight-default notranslate"><div class="highlight"><pre>from django.contrib.messages import constants as message_constants MESSAGE_LEVEL = message_constants.DEBUG </pre></div> </div> If desired, you may specify the numeric values for the constants directly according to the values in the above <a class="reference internal" href="../contrib/messages/#message-level-constants">constants table</a>. </div> </div> <div class="section" id="s-message-storage"> <h3><code class="docutils literal notranslate">MESSAGE_STORAGE</code><a class="headerlink" href="#message-storage" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.contrib.messages.storage.fallback.FallbackStorage'</code> Controls where Django stores message data. Valid values are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.contrib.messages.storage.fallback.FallbackStorage'</code></li> <li><code class="docutils literal notranslate">'django.contrib.messages.storage.session.SessionStorage'</code></li> <li><code class="docutils literal notranslate">'django.contrib.messages.storage.cookie.CookieStorage'</code></li> </ul> See <a class="reference internal" href="../contrib/messages/#message-storage-backends">message storage backends</a> for more details. The backends that use cookies – <a class="reference internal" href="../contrib/messages/#django.contrib.messages.storage.cookie.CookieStorage" title="django.contrib.messages.storage.cookie.CookieStorage"><code class="xref py py-class docutils literal notranslate">CookieStorage</code></a> and <a class="reference internal" href="../contrib/messages/#django.contrib.messages.storage.fallback.FallbackStorage" title="django.contrib.messages.storage.fallback.FallbackStorage"><code class="xref py py-class docutils literal notranslate">FallbackStorage</code></a> – use the value of <a class="reference internal" href="#std:setting-SESSION_COOKIE_DOMAIN"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_DOMAIN</code></a>, <a class="reference internal" href="#std:setting-SESSION_COOKIE_SECURE"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_SECURE</code></a> and <a class="reference internal" href="#std:setting-SESSION_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal notranslate">SESSION_COOKIE_HTTPONLY</code></a> when setting their cookies. </div> <div class="section" id="s-message-tags"> <h3><code class="docutils literal notranslate">MESSAGE_TAGS</code><a class="headerlink" href="#message-tags" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>{ messages.DEBUG: 'debug', messages.INFO: 'info', messages.SUCCESS: 'success', messages.WARNING: 'warning', messages.ERROR: 'error', } </pre></div> </div> This sets the mapping of message level to message tag, which is typically rendered as a CSS class in HTML. If you specify a value, it will extend the default. This means you only have to specify those values which you need to override. See <a class="reference internal" href="../contrib/messages/#message-displaying">Displaying messages</a> above for more details. <div class="admonition-important admonition"> Important If you override <code class="docutils literal notranslate">MESSAGE_TAGS</code> in your settings file and rely on any of the built-in constants, you must import the <code class="docutils literal notranslate">constants</code> module directly to avoid the potential for circular imports, e.g.: <div class="highlight-default notranslate"><div class="highlight"><pre>from django.contrib.messages import constants as message_constants MESSAGE_TAGS = {message_constants.INFO: ''} </pre></div> </div> If desired, you may specify the numeric values for the constants directly according to the values in the above <a class="reference internal" href="../contrib/messages/#message-level-constants">constants table</a>. </div> </div> </div> <div class="section" id="s-sessions"> <h2><a class="toc-backref" href="#id15">Sessions</a><a class="headerlink" href="#sessions" title="Permalink to this headline">¶</a></h2> Settings for <a class="reference internal" href="../../topics/http/sessions/#module-django.contrib.sessions" title="django.contrib.sessions: Provides session management for Django projects."><code class="xref py py-mod docutils literal notranslate">django.contrib.sessions</code></a>. <div class="section" id="s-session-cache-alias"> <h3><code class="docutils literal notranslate">SESSION_CACHE_ALIAS</code><a class="headerlink" href="#session-cache-alias" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'default'</code> If you’re using <a class="reference internal" href="../../topics/http/sessions/#cached-sessions-backend">cache-based session storage</a>, this selects the cache to use. </div> <div class="section" id="s-session-cookie-age"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_AGE</code><a class="headerlink" href="#session-cookie-age" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">1209600</code> (2 weeks, in seconds) The age of session cookies, in seconds. </div> <div class="section" id="s-session-cookie-domain"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_DOMAIN</code><a class="headerlink" href="#session-cookie-domain" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The domain to use for session cookies. Set this to a string such as <code class="docutils literal notranslate">"example.com"</code> for cross-domain cookies, or use <code class="docutils literal notranslate">None</code> for a standard domain cookie. Be cautious when updating this setting on a production site. If you update this setting to enable cross-domain cookies on a site that previously used standard domain cookies, existing user cookies will be set to the old domain. This may result in them being unable to log in as long as these cookies persist. This setting also affects cookies set by <a class="reference internal" href="../contrib/messages/#module-django.contrib.messages" title="django.contrib.messages: Provides cookie- and session-based temporary message storage."><code class="xref py py-mod docutils literal notranslate">django.contrib.messages</code></a>. </div> <div class="section" id="s-session-cookie-httponly"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_HTTPONLY</code><a class="headerlink" href="#session-cookie-httponly" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">True</code> Whether to use <code class="docutils literal notranslate">HttpOnly</code> flag on the session cookie. If this is set to <code class="docutils literal notranslate">True</code>, client-side JavaScript will not be able to access the session cookie. <a class="reference external" href="https://owasp.org/www-community/HttpOnly">HttpOnly</a> is a flag included in a Set-Cookie HTTP response header. It’s part of the <a class="rfc reference external" href="https://tools.ietf.org/html/rfc6265.html#section-4.1.2.6">RFC 6265#section-4.1.2.6</a> standard for cookies and can be a useful way to mitigate the risk of a client-side script accessing the protected cookie data. This makes it less trivial for an attacker to escalate a cross-site scripting vulnerability into full hijacking of a user’s session. There aren’t many good reasons for turning this off. Your code shouldn’t read session cookies from JavaScript. </div> <div class="section" id="s-session-cookie-name"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_NAME</code><a class="headerlink" href="#session-cookie-name" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'sessionid'</code> The name of the cookie to use for sessions. This can be whatever you want (as long as it’s different from the other cookie names in your application). </div> <div class="section" id="s-session-cookie-path"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_PATH</code><a class="headerlink" href="#session-cookie-path" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'/'</code> The path set on the session cookie. This should either match the URL path of your Django installation or be parent of that path. This is useful if you have multiple Django instances running under the same hostname. They can use different cookie paths, and each instance will only see its own session cookie. </div> <div class="section" id="s-session-cookie-samesite"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_SAMESITE</code><a class="headerlink" href="#session-cookie-samesite" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'Lax'</code> The value of the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite">SameSite</a> flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible. Possible values for the setting are: <ul> <li><code class="docutils literal notranslate">'Strict'</code>: prevents the cookie from being sent by the browser to the target site in all cross-site browsing context, even when following a regular link. For example, for a GitHub-like website this would mean that if a logged-in user follows a link to a private GitHub project posted on a corporate discussion forum or email, GitHub will not receive the session cookie and the user won’t be able to access the project. A bank website, however, most likely doesn’t want to allow any transactional pages to be linked from external sites so the <code class="docutils literal notranslate">'Strict'</code> flag would be appropriate. </li> <li><code class="docutils literal notranslate">'Lax'</code> (default): provides a balance between security and usability for websites that want to maintain user’s logged-in session after the user arrives from an external link. In the GitHub scenario, the session cookie would be allowed when following a regular link from an external website and be blocked in CSRF-prone request methods (e.g. <code class="docutils literal notranslate">POST</code>). </li> <li><code class="docutils literal notranslate">None</code>: disables the flag. </li> </ul> </div> <div class="section" id="s-session-cookie-secure"> <h3><code class="docutils literal notranslate">SESSION_COOKIE_SECURE</code><a class="headerlink" href="#session-cookie-secure" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to use a secure cookie for the session cookie. If this is set to <code class="docutils literal notranslate">True</code>, the cookie will be marked as “secure”, which means browsers may ensure that the cookie is only sent under an HTTPS connection. Leaving this setting off isn’t a good idea because an attacker could capture an unencrypted session cookie with a packet sniffer and use the cookie to hijack the user’s session. </div> <div class="section" id="s-session-engine"> <h3><code class="docutils literal notranslate">SESSION_ENGINE</code><a class="headerlink" href="#session-engine" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.contrib.sessions.backends.db'</code> Controls where Django stores session data. Included engines are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.contrib.sessions.backends.db'</code></li> <li><code class="docutils literal notranslate">'django.contrib.sessions.backends.file'</code></li> <li><code class="docutils literal notranslate">'django.contrib.sessions.backends.cache'</code></li> <li><code class="docutils literal notranslate">'django.contrib.sessions.backends.cached_db'</code></li> <li><code class="docutils literal notranslate">'django.contrib.sessions.backends.signed_cookies'</code></li> </ul> See <a class="reference internal" href="../../topics/http/sessions/#configuring-sessions">Configuring the session engine</a> for more details. </div> <div class="section" id="s-session-expire-at-browser-close"> <h3><code class="docutils literal notranslate">SESSION_EXPIRE_AT_BROWSER_CLOSE</code><a class="headerlink" href="#session-expire-at-browser-close" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to expire the session when the user closes their browser. See <a class="reference internal" href="../../topics/http/sessions/#browser-length-vs-persistent-sessions">Browser-length sessions vs. persistent sessions</a>. </div> <div class="section" id="s-session-file-path"> <h3><code class="docutils literal notranslate">SESSION_FILE_PATH</code><a class="headerlink" href="#session-file-path" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> If you’re using file-based session storage, this sets the directory in which Django will store session data. When the default value (<code class="docutils literal notranslate">None</code>) is used, Django will use the standard temporary directory for the system. </div> <div class="section" id="s-session-save-every-request"> <h3><code class="docutils literal notranslate">SESSION_SAVE_EVERY_REQUEST</code><a class="headerlink" href="#session-save-every-request" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">False</code> Whether to save the session data on every request. If this is <code class="docutils literal notranslate">False</code> (default), then the session data will only be saved if it has been modified – that is, if any of its dictionary values have been assigned or deleted. Empty sessions won’t be created, even if this setting is active. </div> <div class="section" id="s-session-serializer"> <h3><code class="docutils literal notranslate">SESSION_SERIALIZER</code><a class="headerlink" href="#session-serializer" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.contrib.sessions.serializers.JSONSerializer'</code> Full import path of a serializer class to use for serializing session data. Included serializers are: <ul class="simple"> <li><code class="docutils literal notranslate">'django.contrib.sessions.serializers.PickleSerializer'</code></li> <li><code class="docutils literal notranslate">'django.contrib.sessions.serializers.JSONSerializer'</code></li> </ul> See <a class="reference internal" href="../../topics/http/sessions/#session-serialization">Session serialization</a> for details, including a warning regarding possible remote code execution when using <a class="reference internal" href="../../topics/http/sessions/#django.contrib.sessions.serializers.PickleSerializer" title="django.contrib.sessions.serializers.PickleSerializer"><code class="xref py py-class docutils literal notranslate">PickleSerializer</code></a>. </div> </div> <div class="section" id="s-sites"> <h2><a class="toc-backref" href="#id16">Sites</a><a class="headerlink" href="#sites" title="Permalink to this headline">¶</a></h2> Settings for <a class="reference internal" href="../contrib/sites/#module-django.contrib.sites" title="django.contrib.sites: Lets you operate multiple websites from the same database and Django project"><code class="xref py py-mod docutils literal notranslate">django.contrib.sites</code></a>. <div class="section" id="s-site-id"> <h3><code class="docutils literal notranslate">SITE_ID</code><a class="headerlink" href="#site-id" title="Permalink to this headline">¶</a></h3> Default: Not defined The ID, as an integer, of the current site in the <code class="docutils literal notranslate">django_site</code> database table. This is used so that application data can hook into specific sites and a single database can manage content for multiple sites. </div> </div> <div class="section" id="s-static-files"> <h2><a class="toc-backref" href="#id17">Static Files</a><a class="headerlink" href="#static-files" title="Permalink to this headline">¶</a></h2> Settings for <a class="reference internal" href="../contrib/staticfiles/#module-django.contrib.staticfiles" title="django.contrib.staticfiles: An app for handling static files."><code class="xref py py-mod docutils literal notranslate">django.contrib.staticfiles</code></a>. <div class="section" id="s-static-root"> <h3><code class="docutils literal notranslate">STATIC_ROOT</code><a class="headerlink" href="#static-root" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> The absolute path to the directory where <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> will collect static files for deployment. Example: <code class="docutils literal notranslate">"/var/www/example.com/static/"</code> If the <a class="reference internal" href="../contrib/staticfiles/">staticfiles</a> contrib app is enabled (as in the default project template), the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> management command will collect static files into this directory. See the how-to on <a class="reference internal" href="../../howto/static-files/">managing static files</a> for more details about usage. <div class="admonition warning"> Warning This should be an initially empty destination directory for collecting your static files from their permanent locations into one directory for ease of deployment; it is not a place to store your static files permanently. You should do that in directories that will be found by <a class="reference internal" href="../contrib/staticfiles/">staticfiles</a>’s <a class="reference internal" href="#std:setting-STATICFILES_FINDERS"><code class="xref std std-setting docutils literal notranslate">finders</code></a>, which by default, are <code class="docutils literal notranslate">'static/'</code> app sub-directories and any directories you include in <a class="reference internal" href="#std:setting-STATICFILES_DIRS"><code class="xref std std-setting docutils literal notranslate">STATICFILES_DIRS</code></a>). </div> </div> <div class="section" id="s-static-url"> <h3><code class="docutils literal notranslate">STATIC_URL</code><a class="headerlink" href="#static-url" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">None</code> URL to use when referring to static files located in <a class="reference internal" href="#std:setting-STATIC_ROOT"><code class="xref std std-setting docutils literal notranslate">STATIC_ROOT</code></a>. Example: <code class="docutils literal notranslate">"/static/"</code> or <code class="docutils literal notranslate">"http://static.example.com/"</code> If not <code class="docutils literal notranslate">None</code>, this will be used as the base path for <a class="reference internal" href="../../topics/forms/media/#form-asset-paths">asset definitions</a> (the <code class="docutils literal notranslate">Media</code> class) and the <a class="reference internal" href="../contrib/staticfiles/">staticfiles app</a>. It must end in a slash if set to a non-empty value. You may need to <a class="reference internal" href="../../howto/static-files/#serving-static-files-in-development">configure these files to be served in development</a> and will definitely need to do so <a class="reference internal" href="../../howto/static-files/deployment/">in production</a>. </div> <div class="section" id="s-staticfiles-dirs"> <h3><code class="docutils literal notranslate">STATICFILES_DIRS</code><a class="headerlink" href="#staticfiles-dirs" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">[]</code> (Empty list) This setting defines the additional locations the staticfiles app will traverse if the <code class="docutils literal notranslate">FileSystemFinder</code> finder is enabled, e.g. if you use the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> or <a class="reference internal" href="../contrib/staticfiles/#django-admin-findstatic"><code class="xref std std-djadmin docutils literal notranslate">findstatic</code></a> management command or use the static file serving view. This should be set to a list of strings that contain full paths to your additional files directory(ies) e.g.: <div class="highlight-default notranslate"><div class="highlight"><pre>STATICFILES_DIRS = [ "/home/special.polls.com/polls/static", "/home/polls.com/polls/static", "/opt/webfiles/common", ] </pre></div> </div> Note that these paths should use Unix-style forward slashes, even on Windows (e.g. <code class="docutils literal notranslate">"C:/Users/user/mysite/extra_static_content"</code>). <div class="section" id="s-prefixes-optional"> <h4>Prefixes (optional)<a class="headerlink" href="#prefixes-optional" title="Permalink to this headline">¶</a></h4> In case you want to refer to files in one of the locations with an additional namespace, you can optionally provide a prefix as <code class="docutils literal notranslate">(prefix, path)</code> tuples, e.g.: <div class="highlight-default notranslate"><div class="highlight"><pre>STATICFILES_DIRS = [ # ... ("downloads", "/opt/webfiles/stats"), ] </pre></div> </div> For example, assuming you have <a class="reference internal" href="#std:setting-STATIC_URL"><code class="xref std std-setting docutils literal notranslate">STATIC_URL</code></a> set to <code class="docutils literal notranslate">'/static/'</code>, the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> management command would collect the “stats” files in a <code class="docutils literal notranslate">'downloads'</code> subdirectory of <a class="reference internal" href="#std:setting-STATIC_ROOT"><code class="xref std std-setting docutils literal notranslate">STATIC_ROOT</code></a>. This would allow you to refer to the local file <code class="docutils literal notranslate">'/opt/webfiles/stats/polls_20101022.tar.gz'</code> with <code class="docutils literal notranslate">'/static/downloads/polls_20101022.tar.gz'</code> in your templates, e.g.: <div class="highlight-html+django notranslate"><div class="highlight"><pre><a href="{% static "downloads/polls_20101022.tar.gz" %}"> </pre></div> </div> </div> </div> <div class="section" id="s-staticfiles-storage"> <h3><code class="docutils literal notranslate">STATICFILES_STORAGE</code><a class="headerlink" href="#staticfiles-storage" title="Permalink to this headline">¶</a></h3> Default: <code class="docutils literal notranslate">'django.contrib.staticfiles.storage.StaticFilesStorage'</code> The file storage engine to use when collecting static files with the <a class="reference internal" href="../contrib/staticfiles/#django-admin-collectstatic"><code class="xref std std-djadmin docutils literal notranslate">collectstatic</code></a> management command. A ready-to-use instance of the storage backend defined in this setting can be found at <code class="docutils literal notranslate">django.contrib.staticfiles.storage.staticfiles_storage</code>. For an example, see <a class="reference internal" href="../../howto/static-files/deployment/#staticfiles-from-cdn">Serving static files from a cloud service or CDN</a>. </div> <div class="section" id="s-staticfiles-finders"> <h3><code class="docutils literal notranslate">STATICFILES_FINDERS</code><a class="headerlink" href="#staticfiles-finders" title="Permalink to this headline">¶</a></h3> Default: <div class="highlight-default notranslate"><div class="highlight"><pre>[ 'django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder', ] </pre></div> </div> The list of finder backends that know how to find static files in various locations. The default will find files stored in the <a class="reference internal" href="#std:setting-STATICFILES_DIRS"><code class="xref std std-setting docutils literal notranslate">STATICFILES_DIRS</code></a> setting (using <code class="docutils literal notranslate">django.contrib.staticfiles.finders.FileSystemFinder</code>) and in a <code class="docutils literal notranslate">static</code> subdirectory of each app (using <code class="docutils literal notranslate">django.contrib.staticfiles.finders.AppDirectoriesFinder</code>). If multiple files with the same name are present, the first file that is found will be used. One finder is disabled by default: <code class="docutils literal notranslate">django.contrib.staticfiles.finders.DefaultStorageFinder</code>. If added to your <a class="reference internal" href="#std:setting-STATICFILES_FINDERS"><code class="xref std std-setting docutils literal notranslate">STATICFILES_FINDERS</code></a> setting, it will look for static files in the default file storage as defined by the <a class="reference internal" href="#std:setting-DEFAULT_FILE_STORAGE"><code class="xref std std-setting docutils literal notranslate">DEFAULT_FILE_STORAGE</code></a> setting. <div class="admonition note"> Note When using the <code class="docutils literal notranslate">AppDirectoriesFinder</code> finder, make sure your apps can be found by staticfiles by adding the app to the <a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a> setting of your site. </div> Static file finders are currently considered a private interface, and this interface is thus undocumented. </div> </div> <div class="section" id="s-core-settings-topical-index"> <h2><a class="toc-backref" href="#id18">Core Settings Topical Index</a><a class="headerlink" href="#core-settings-topical-index" title="Permalink to this headline">¶</a></h2> <div class="section" id="s-cache"> <h3>Cache<a class="headerlink" href="#cache" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-CACHES"><code class="xref std std-setting docutils literal notranslate">CACHES</code></a></li> <li><a class="reference internal" href="#std:setting-CACHE_MIDDLEWARE_ALIAS"><code class="xref std std-setting docutils literal notranslate">CACHE_MIDDLEWARE_ALIAS</code></a></li> <li><a class="reference internal" href="#std:setting-CACHE_MIDDLEWARE_KEY_PREFIX"><code class="xref std std-setting docutils literal notranslate">CACHE_MIDDLEWARE_KEY_PREFIX</code></a></li> <li><a class="reference internal" href="#std:setting-CACHE_MIDDLEWARE_SECONDS"><code class="xref std std-setting docutils literal notranslate">CACHE_MIDDLEWARE_SECONDS</code></a></li> </ul> </div> <div class="section" id="s-database"> <h3>Database<a class="headerlink" href="#database" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DATABASES"><code class="xref std std-setting docutils literal notranslate">DATABASES</code></a></li> <li><a class="reference internal" href="#std:setting-DATABASE_ROUTERS"><code class="xref std std-setting docutils literal notranslate">DATABASE_ROUTERS</code></a></li> <li><a class="reference internal" href="#std:setting-DEFAULT_INDEX_TABLESPACE"><code class="xref std std-setting docutils literal notranslate">DEFAULT_INDEX_TABLESPACE</code></a></li> <li><a class="reference internal" href="#std:setting-DEFAULT_TABLESPACE"><code class="xref std std-setting docutils literal notranslate">DEFAULT_TABLESPACE</code></a></li> </ul> </div> <div class="section" id="s-debugging"> <h3>Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate">DEBUG</code></a></li> <li><a class="reference internal" href="#std:setting-DEBUG_PROPAGATE_EXCEPTIONS"><code class="xref std std-setting docutils literal notranslate">DEBUG_PROPAGATE_EXCEPTIONS</code></a></li> </ul> </div> <div class="section" id="s-email"> <h3>Email<a class="headerlink" href="#email" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-ADMINS"><code class="xref std std-setting docutils literal notranslate">ADMINS</code></a></li> <li><a class="reference internal" href="#std:setting-DEFAULT_CHARSET"><code class="xref std std-setting docutils literal notranslate">DEFAULT_CHARSET</code></a></li> <li><a class="reference internal" href="#std:setting-DEFAULT_FROM_EMAIL"><code class="xref std std-setting docutils literal notranslate">DEFAULT_FROM_EMAIL</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_BACKEND"><code class="xref std std-setting docutils literal notranslate">EMAIL_BACKEND</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_FILE_PATH"><code class="xref std std-setting docutils literal notranslate">EMAIL_FILE_PATH</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_HOST"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_HOST_PASSWORD"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST_PASSWORD</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_HOST_USER"><code class="xref std std-setting docutils literal notranslate">EMAIL_HOST_USER</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_PORT"><code class="xref std std-setting docutils literal notranslate">EMAIL_PORT</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_SSL_CERTFILE"><code class="xref std std-setting docutils literal notranslate">EMAIL_SSL_CERTFILE</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_SSL_KEYFILE"><code class="xref std std-setting docutils literal notranslate">EMAIL_SSL_KEYFILE</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_SUBJECT_PREFIX"><code class="xref std std-setting docutils literal notranslate">EMAIL_SUBJECT_PREFIX</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_TIMEOUT"><code class="xref std std-setting docutils literal notranslate">EMAIL_TIMEOUT</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_USE_LOCALTIME"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_LOCALTIME</code></a></li> <li><a class="reference internal" href="#std:setting-EMAIL_USE_TLS"><code class="xref std std-setting docutils literal notranslate">EMAIL_USE_TLS</code></a></li> <li><a class="reference internal" href="#std:setting-MANAGERS"><code class="xref std std-setting docutils literal notranslate">MANAGERS</code></a></li> <li><a class="reference internal" href="#std:setting-SERVER_EMAIL"><code class="xref std std-setting docutils literal notranslate">SERVER_EMAIL</code></a></li> </ul> </div> <div class="section" id="s-error-reporting"> <h3>Error reporting<a class="headerlink" href="#error-reporting" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DEFAULT_EXCEPTION_REPORTER_FILTER"><code class="xref std std-setting docutils literal notranslate">DEFAULT_EXCEPTION_REPORTER_FILTER</code></a></li> <li><a class="reference internal" href="#std:setting-IGNORABLE_404_URLS"><code class="xref std std-setting docutils literal notranslate">IGNORABLE_404_URLS</code></a></li> <li><a class="reference internal" href="#std:setting-MANAGERS"><code class="xref std std-setting docutils literal notranslate">MANAGERS</code></a></li> <li><a class="reference internal" href="#std:setting-SILENCED_SYSTEM_CHECKS"><code class="xref std std-setting docutils literal notranslate">SILENCED_SYSTEM_CHECKS</code></a></li> </ul> </div> <div class="section" id="s-file-uploads"> <h3>File uploads<a class="headerlink" href="#file-uploads" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DEFAULT_FILE_STORAGE"><code class="xref std std-setting docutils literal notranslate">DEFAULT_FILE_STORAGE</code></a></li> <li><a class="reference internal" href="#std:setting-FILE_UPLOAD_HANDLERS"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_HANDLERS</code></a></li> <li><a class="reference internal" href="#std:setting-FILE_UPLOAD_MAX_MEMORY_SIZE"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_MAX_MEMORY_SIZE</code></a></li> <li><a class="reference internal" href="#std:setting-FILE_UPLOAD_PERMISSIONS"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_PERMISSIONS</code></a></li> <li><a class="reference internal" href="#std:setting-FILE_UPLOAD_TEMP_DIR"><code class="xref std std-setting docutils literal notranslate">FILE_UPLOAD_TEMP_DIR</code></a></li> <li><a class="reference internal" href="#std:setting-MEDIA_ROOT"><code class="xref std std-setting docutils literal notranslate">MEDIA_ROOT</code></a></li> <li><a class="reference internal" href="#std:setting-MEDIA_URL"><code class="xref std std-setting docutils literal notranslate">MEDIA_URL</code></a></li> </ul> </div> <div class="section" id="s-forms"> <h3>Forms<a class="headerlink" href="#forms" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-FORM_RENDERER"><code class="xref std std-setting docutils literal notranslate">FORM_RENDERER</code></a></li> </ul> </div> <div class="section" id="s-globalization-i18n-l10n"> <h3>Globalization (<code class="docutils literal notranslate">i18n</code>/<code class="docutils literal notranslate">l10n</code>)<a class="headerlink" href="#globalization-i18n-l10n" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-DATE_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATE_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">DATETIME_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-DATETIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">DATETIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-DECIMAL_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">DECIMAL_SEPARATOR</code></a></li> <li><a class="reference internal" href="#std:setting-FIRST_DAY_OF_WEEK"><code class="xref std std-setting docutils literal notranslate">FIRST_DAY_OF_WEEK</code></a></li> <li><a class="reference internal" href="#std:setting-FORMAT_MODULE_PATH"><code class="xref std std-setting docutils literal notranslate">FORMAT_MODULE_PATH</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_CODE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_CODE</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_AGE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_AGE</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_DOMAIN"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_DOMAIN</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_HTTPONLY"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_HTTPONLY</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_NAME"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_NAME</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_PATH"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_PATH</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_SAMESITE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_SAMESITE</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGE_COOKIE_SECURE"><code class="xref std std-setting docutils literal notranslate">LANGUAGE_COOKIE_SECURE</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGES"><code class="xref std std-setting docutils literal notranslate">LANGUAGES</code></a></li> <li><a class="reference internal" href="#std:setting-LANGUAGES_BIDI"><code class="xref std std-setting docutils literal notranslate">LANGUAGES_BIDI</code></a></li> <li><a class="reference internal" href="#std:setting-LOCALE_PATHS"><code class="xref std std-setting docutils literal notranslate">LOCALE_PATHS</code></a></li> <li><a class="reference internal" href="#std:setting-MONTH_DAY_FORMAT"><code class="xref std std-setting docutils literal notranslate">MONTH_DAY_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-NUMBER_GROUPING"><code class="xref std std-setting docutils literal notranslate">NUMBER_GROUPING</code></a></li> <li><a class="reference internal" href="#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">SHORT_DATETIME_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">THOUSAND_SEPARATOR</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate">TIME_FORMAT</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_INPUT_FORMATS"><code class="xref std std-setting docutils literal notranslate">TIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_ZONE"><code class="xref std std-setting docutils literal notranslate">TIME_ZONE</code></a></li> <li><a class="reference internal" href="#std:setting-USE_I18N"><code class="xref std std-setting docutils literal notranslate">USE_I18N</code></a></li> <li><a class="reference internal" href="#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate">USE_L10N</code></a></li> <li><a class="reference internal" href="#std:setting-USE_THOUSAND_SEPARATOR"><code class="xref std std-setting docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a></li> <li><a class="reference internal" href="#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate">USE_TZ</code></a></li> <li><a class="reference internal" href="#std:setting-YEAR_MONTH_FORMAT"><code class="xref std std-setting docutils literal notranslate">YEAR_MONTH_FORMAT</code></a></li> </ul> </div> <div class="section" id="s-http"> <h3>HTTP<a class="headerlink" href="#http" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DATA_UPLOAD_MAX_MEMORY_SIZE"><code class="xref std std-setting docutils literal notranslate">DATA_UPLOAD_MAX_MEMORY_SIZE</code></a></li> <li><a class="reference internal" href="#std:setting-DATA_UPLOAD_MAX_NUMBER_FIELDS"><code class="xref std std-setting docutils literal notranslate">DATA_UPLOAD_MAX_NUMBER_FIELDS</code></a></li> <li><a class="reference internal" href="#std:setting-DEFAULT_CHARSET"><code class="xref std std-setting docutils literal notranslate">DEFAULT_CHARSET</code></a></li> <li><a class="reference internal" href="#std:setting-DISALLOWED_USER_AGENTS"><code class="xref std std-setting docutils literal notranslate">DISALLOWED_USER_AGENTS</code></a></li> <li><a class="reference internal" href="#std:setting-FORCE_SCRIPT_NAME"><code class="xref std std-setting docutils literal notranslate">FORCE_SCRIPT_NAME</code></a></li> <li><a class="reference internal" href="#std:setting-INTERNAL_IPS"><code class="xref std std-setting docutils literal notranslate">INTERNAL_IPS</code></a></li> <li><a class="reference internal" href="#std:setting-MIDDLEWARE"><code class="xref std std-setting docutils literal notranslate">MIDDLEWARE</code></a></li> <li>Security<ul> <li><a class="reference internal" href="#std:setting-SECURE_BROWSER_XSS_FILTER"><code class="xref std std-setting docutils literal notranslate">SECURE_BROWSER_XSS_FILTER</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_CONTENT_TYPE_NOSNIFF"><code class="xref std std-setting docutils literal notranslate">SECURE_CONTENT_TYPE_NOSNIFF</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_HSTS_INCLUDE_SUBDOMAINS"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_INCLUDE_SUBDOMAINS</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_HSTS_PRELOAD"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_PRELOAD</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_HSTS_SECONDS"><code class="xref std std-setting docutils literal notranslate">SECURE_HSTS_SECONDS</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_PROXY_SSL_HEADER"><code class="xref std std-setting docutils literal notranslate">SECURE_PROXY_SSL_HEADER</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_REDIRECT_EXEMPT"><code class="xref std std-setting docutils literal notranslate">SECURE_REDIRECT_EXEMPT</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_REFERRER_POLICY"><code class="xref std std-setting docutils literal notranslate">SECURE_REFERRER_POLICY</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_SSL_HOST"><code class="xref std std-setting docutils literal notranslate">SECURE_SSL_HOST</code></a></li> <li><a class="reference internal" href="#std:setting-SECURE_SSL_REDIRECT"><code class="xref std std-setting docutils literal notranslate">SECURE_SSL_REDIRECT</code></a></li> </ul> </li> <li><a class="reference internal" href="#std:setting-SIGNING_BACKEND"><code class="xref std std-setting docutils literal notranslate">SIGNING_BACKEND</code></a></li> <li><a class="reference internal" href="#std:setting-USE_X_FORWARDED_HOST"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_HOST</code></a></li> <li><a class="reference internal" href="#std:setting-USE_X_FORWARDED_PORT"><code class="xref std std-setting docutils literal notranslate">USE_X_FORWARDED_PORT</code></a></li> <li><a class="reference internal" href="#std:setting-WSGI_APPLICATION"><code class="xref std std-setting docutils literal notranslate">WSGI_APPLICATION</code></a></li> </ul> </div> <div class="section" id="s-id10"> <h3>Logging<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-LOGGING"><code class="xref std std-setting docutils literal notranslate">LOGGING</code></a></li> <li><a class="reference internal" href="#std:setting-LOGGING_CONFIG"><code class="xref std std-setting docutils literal notranslate">LOGGING_CONFIG</code></a></li> </ul> </div> <div class="section" id="s-models"> <h3>Models<a class="headerlink" href="#models" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-ABSOLUTE_URL_OVERRIDES"><code class="xref std std-setting docutils literal notranslate">ABSOLUTE_URL_OVERRIDES</code></a></li> <li><a class="reference internal" href="#std:setting-FIXTURE_DIRS"><code class="xref std std-setting docutils literal notranslate">FIXTURE_DIRS</code></a></li> <li><a class="reference internal" href="#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate">INSTALLED_APPS</code></a></li> </ul> </div> <div class="section" id="s-security"> <h3>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li>Cross Site Request Forgery Protection<ul> <li><a class="reference internal" href="#std:setting-CSRF_COOKIE_DOMAIN"><code class="xref std std-setting docutils literal notranslate">CSRF_COOKIE_DOMAIN</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_COOKIE_NAME"><code class="xref std std-setting docutils literal notranslate">CSRF_COOKIE_NAME</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_COOKIE_PATH"><code class="xref std std-setting docutils literal notranslate">CSRF_COOKIE_PATH</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_COOKIE_SAMESITE"><code class="xref std std-setting docutils literal notranslate">CSRF_COOKIE_SAMESITE</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_COOKIE_SECURE"><code class="xref std std-setting docutils literal notranslate">CSRF_COOKIE_SECURE</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_FAILURE_VIEW"><code class="xref std std-setting docutils literal notranslate">CSRF_FAILURE_VIEW</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_HEADER_NAME"><code class="xref std std-setting docutils literal notranslate">CSRF_HEADER_NAME</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_TRUSTED_ORIGINS"><code class="xref std std-setting docutils literal notranslate">CSRF_TRUSTED_ORIGINS</code></a></li> <li><a class="reference internal" href="#std:setting-CSRF_USE_SESSIONS"><code class="xref std std-setting docutils literal notranslate">CSRF_USE_SESSIONS</code></a></li> </ul> </li> <li><a class="reference internal" href="#std:setting-SECRET_KEY"><code class="xref std std-setting docutils literal notranslate">SECRET_KEY</code></a></li> <li><a class="reference internal" href="#std:setting-X_FRAME_OPTIONS"><code class="xref std std-setting docutils literal notranslate">X_FRAME_OPTIONS</code></a></li> </ul> </div> <div class="section" id="s-serialization"> <h3>Serialization<a class="headerlink" href="#serialization" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-DEFAULT_CHARSET"><code class="xref std std-setting docutils literal notranslate">DEFAULT_CHARSET</code></a></li> <li><a class="reference internal" href="#std:setting-SERIALIZATION_MODULES"><code class="xref std std-setting docutils literal notranslate">SERIALIZATION_MODULES</code></a></li> </ul> </div> <div class="section" id="s-id11"> <h3>Templates<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-TEMPLATES"><code class="xref std std-setting docutils literal notranslate">TEMPLATES</code></a></li> </ul> </div> <div class="section" id="s-testing"> <h3>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li>Database: <a class="reference internal" href="#std:setting-DATABASE-TEST"><code class="xref std std-setting docutils literal notranslate">TEST</code></a></li> <li><a class="reference internal" href="#std:setting-TEST_NON_SERIALIZED_APPS"><code class="xref std std-setting docutils literal notranslate">TEST_NON_SERIALIZED_APPS</code></a></li> <li><a class="reference internal" href="#std:setting-TEST_RUNNER"><code class="xref std std-setting docutils literal notranslate">TEST_RUNNER</code></a></li> </ul> </div> <div class="section" id="s-urls"> <h3>URLs<a class="headerlink" href="#urls" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li><a class="reference internal" href="#std:setting-APPEND_SLASH"><code class="xref std std-setting docutils literal notranslate">APPEND_SLASH</code></a></li> <li><a class="reference internal" href="#std:setting-PREPEND_WWW"><code class="xref std std-setting docutils literal notranslate">PREPEND_WWW</code></a></li> <li><a class="reference internal" href="#std:setting-ROOT_URLCONF"><code class="xref std std-setting docutils literal notranslate">ROOT_URLCONF</code></a></li> </ul> </div> </div> </div> </div> <div class="browse-horizontal"> <div class="left"><a rel="prev" href="../schema-editor/"> <code class="docutils literal notranslate">SchemaEditor</code></a></div> <div class="right"><a rel="next" href="../signals/">Signals </a></div> </div> <a href="#top" class="backtotop"> Back to Top</a> </div> <h1 class="visuallyhidden">Additional Information</h1> <div role="complementary"> <div class="fundraising-sidebar"> <h2>Support Django!</h2> <div class="small-heart"> <img src="https://static.djangoproject.com/img/fundraising-heart.cd6bb84ffd33.svg" alt="Support Django!" /> </div> <div class="small-cta"> <ul class="list-links-small"> <li><a href="https://www.djangoproject.com/fundraising/"> Ramana Varanasi donated to the Django Software Foundation to support Django development. Donate today! </a></li> </ul> </div> </div> <h2>Contents</h2> <ul> <li><a class="reference internal" href="#">Settings</a><ul> <li><a class="reference internal" href="#core-settings">Core Settings</a><ul> <li><a class="reference internal" href="#absolute-url-overrides"><code class="docutils literal notranslate">ABSOLUTE_URL_OVERRIDES</code></a></li> <li><a class="reference internal" href="#admins"><code class="docutils literal notranslate">ADMINS</code></a></li> <li><a class="reference internal" href="#allowed-hosts"><code class="docutils literal notranslate">ALLOWED_HOSTS</code></a></li> <li><a class="reference internal" href="#append-slash"><code class="docutils literal notranslate">APPEND_SLASH</code></a></li> <li><a class="reference internal" href="#caches"><code class="docutils literal notranslate">CACHES</code></a><ul> <li><a class="reference internal" href="#backend"><code class="docutils literal notranslate">BACKEND</code></a></li> <li><a class="reference internal" href="#key-function"><code class="docutils literal notranslate">KEY_FUNCTION</code></a></li> <li><a class="reference internal" href="#key-prefix"><code class="docutils literal notranslate">KEY_PREFIX</code></a></li> <li><a class="reference internal" href="#location"><code class="docutils literal notranslate">LOCATION</code></a></li> <li><a class="reference internal" href="#options"><code class="docutils literal notranslate">OPTIONS</code></a></li> <li><a class="reference internal" href="#timeout"><code class="docutils literal notranslate">TIMEOUT</code></a></li> <li><a class="reference internal" href="#version"><code class="docutils literal notranslate">VERSION</code></a></li> </ul> </li> <li><a class="reference internal" href="#cache-middleware-alias"><code class="docutils literal notranslate">CACHE_MIDDLEWARE_ALIAS</code></a></li> <li><a class="reference internal" href="#cache-middleware-key-prefix"><code class="docutils literal notranslate">CACHE_MIDDLEWARE_KEY_PREFIX</code></a></li> <li><a class="reference internal" href="#cache-middleware-seconds"><code class="docutils literal notranslate">CACHE_MIDDLEWARE_SECONDS</code></a></li> <li><a class="reference internal" href="#csrf-cookie-age"><code class="docutils literal notranslate">CSRF_COOKIE_AGE</code></a></li> <li><a class="reference internal" href="#csrf-cookie-domain"><code class="docutils literal notranslate">CSRF_COOKIE_DOMAIN</code></a></li> <li><a class="reference internal" href="#csrf-cookie-httponly"><code class="docutils literal notranslate">CSRF_COOKIE_HTTPONLY</code></a></li> <li><a class="reference internal" href="#csrf-cookie-name"><code class="docutils literal notranslate">CSRF_COOKIE_NAME</code></a></li> <li><a class="reference internal" href="#csrf-cookie-path"><code class="docutils literal notranslate">CSRF_COOKIE_PATH</code></a></li> <li><a class="reference internal" href="#csrf-cookie-samesite"><code class="docutils literal notranslate">CSRF_COOKIE_SAMESITE</code></a></li> <li><a class="reference internal" href="#csrf-cookie-secure"><code class="docutils literal notranslate">CSRF_COOKIE_SECURE</code></a></li> <li><a class="reference internal" href="#csrf-use-sessions"><code class="docutils literal notranslate">CSRF_USE_SESSIONS</code></a></li> <li><a class="reference internal" href="#csrf-failure-view"><code class="docutils literal notranslate">CSRF_FAILURE_VIEW</code></a></li> <li><a class="reference internal" href="#csrf-header-name"><code class="docutils literal notranslate">CSRF_HEADER_NAME</code></a></li> <li><a class="reference internal" href="#csrf-trusted-origins"><code class="docutils literal notranslate">CSRF_TRUSTED_ORIGINS</code></a></li> <li><a class="reference internal" href="#databases"><code class="docutils literal notranslate">DATABASES</code></a><ul> <li><a class="reference internal" href="#atomic-requests"><code class="docutils literal notranslate">ATOMIC_REQUESTS</code></a></li> <li><a class="reference internal" href="#autocommit"><code class="docutils literal notranslate">AUTOCOMMIT</code></a></li> <li><a class="reference internal" href="#engine"><code class="docutils literal notranslate">ENGINE</code></a></li> <li><a class="reference internal" href="#host"><code class="docutils literal notranslate">HOST</code></a></li> <li><a class="reference internal" href="#name"><code class="docutils literal notranslate">NAME</code></a></li> <li><a class="reference internal" href="#conn-max-age"><code class="docutils literal notranslate">CONN_MAX_AGE</code></a></li> <li><a class="reference internal" href="#std:setting-OPTIONS"><code class="docutils literal notranslate">OPTIONS</code></a></li> <li><a class="reference internal" href="#password"><code class="docutils literal notranslate">PASSWORD</code></a></li> <li><a class="reference internal" href="#port"><code class="docutils literal notranslate">PORT</code></a></li> <li><a class="reference internal" href="#time-zone"><code class="docutils literal notranslate">TIME_ZONE</code></a></li> <li><a class="reference internal" href="#disable-server-side-cursors"><code class="docutils literal notranslate">DISABLE_SERVER_SIDE_CURSORS</code></a></li> <li><a class="reference internal" href="#user"><code class="docutils literal notranslate">USER</code></a></li> <li><a class="reference internal" href="#test"><code class="docutils literal notranslate">TEST</code></a><ul> <li><a class="reference internal" href="#charset"><code class="docutils literal notranslate">CHARSET</code></a></li> <li><a class="reference internal" href="#collation"><code class="docutils literal notranslate">COLLATION</code></a></li> <li><a class="reference internal" href="#dependencies"><code class="docutils literal notranslate">DEPENDENCIES</code></a></li> <li><a class="reference internal" href="#mirror"><code class="docutils literal notranslate">MIRROR</code></a></li> <li><a class="reference internal" href="#std:setting-TEST_NAME"><code class="docutils literal notranslate">NAME</code></a></li> <li><a class="reference internal" href="#serialize"><code class="docutils literal notranslate">SERIALIZE</code></a></li> <li><a class="reference internal" href="#template"><code class="docutils literal notranslate">TEMPLATE</code></a></li> <li><a class="reference internal" href="#create-db"><code class="docutils literal notranslate">CREATE_DB</code></a></li> <li><a class="reference internal" href="#create-user"><code class="docutils literal notranslate">CREATE_USER</code></a></li> <li><a class="reference internal" href="#std:setting-TEST_USER"><code class="docutils literal notranslate">USER</code></a></li> <li><a class="reference internal" href="#std:setting-TEST_PASSWD"><code class="docutils literal notranslate">PASSWORD</code></a></li> <li><a class="reference internal" href="#oracle-managed-files"><code class="docutils literal notranslate">ORACLE_MANAGED_FILES</code></a></li> <li><a class="reference internal" href="#tblspace"><code class="docutils literal notranslate">TBLSPACE</code></a></li> <li><a class="reference internal" href="#tblspace-tmp"><code class="docutils literal notranslate">TBLSPACE_TMP</code></a></li> <li><a class="reference internal" href="#datafile"><code class="docutils literal notranslate">DATAFILE</code></a></li> <li><a class="reference internal" href="#datafile-tmp"><code class="docutils literal notranslate">DATAFILE_TMP</code></a></li> <li><a class="reference internal" href="#datafile-maxsize"><code class="docutils literal notranslate">DATAFILE_MAXSIZE</code></a></li> <li><a class="reference internal" href="#datafile-tmp-maxsize"><code class="docutils literal notranslate">DATAFILE_TMP_MAXSIZE</code></a></li> <li><a class="reference internal" href="#datafile-size"><code class="docutils literal notranslate">DATAFILE_SIZE</code></a></li> <li><a class="reference internal" href="#datafile-tmp-size"><code class="docutils literal notranslate">DATAFILE_TMP_SIZE</code></a></li> <li><a class="reference internal" href="#datafile-extsize"><code class="docutils literal notranslate">DATAFILE_EXTSIZE</code></a></li> <li><a class="reference internal" href="#datafile-tmp-extsize"><code class="docutils literal notranslate">DATAFILE_TMP_EXTSIZE</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#data-upload-max-memory-size">DATA_UPLOAD_MAX_MEMORY_SIZE</a></li> <li><a class="reference internal" href="#data-upload-max-number-fields">DATA_UPLOAD_MAX_NUMBER_FIELDS</a></li> <li><a class="reference internal" href="#database-routers"><code class="docutils literal notranslate">DATABASE_ROUTERS</code></a></li> <li><a class="reference internal" href="#date-format"><code class="docutils literal notranslate">DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#date-input-formats"><code class="docutils literal notranslate">DATE_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#datetime-format"><code class="docutils literal notranslate">DATETIME_FORMAT</code></a></li> <li><a class="reference internal" href="#datetime-input-formats"><code class="docutils literal notranslate">DATETIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#debug"><code class="docutils literal notranslate">DEBUG</code></a></li> <li><a class="reference internal" href="#debug-propagate-exceptions"><code class="docutils literal notranslate">DEBUG_PROPAGATE_EXCEPTIONS</code></a></li> <li><a class="reference internal" href="#decimal-separator"><code class="docutils literal notranslate">DECIMAL_SEPARATOR</code></a></li> <li><a class="reference internal" href="#default-charset"><code class="docutils literal notranslate">DEFAULT_CHARSET</code></a></li> <li><a class="reference internal" href="#default-exception-reporter-filter"><code class="docutils literal notranslate">DEFAULT_EXCEPTION_REPORTER_FILTER</code></a></li> <li><a class="reference internal" href="#default-file-storage"><code class="docutils literal notranslate">DEFAULT_FILE_STORAGE</code></a></li> <li><a class="reference internal" href="#default-from-email"><code class="docutils literal notranslate">DEFAULT_FROM_EMAIL</code></a></li> <li><a class="reference internal" href="#default-index-tablespace"><code class="docutils literal notranslate">DEFAULT_INDEX_TABLESPACE</code></a></li> <li><a class="reference internal" href="#default-tablespace"><code class="docutils literal notranslate">DEFAULT_TABLESPACE</code></a></li> <li><a class="reference internal" href="#disallowed-user-agents"><code class="docutils literal notranslate">DISALLOWED_USER_AGENTS</code></a></li> <li><a class="reference internal" href="#email-backend"><code class="docutils literal notranslate">EMAIL_BACKEND</code></a></li> <li><a class="reference internal" href="#email-file-path"><code class="docutils literal notranslate">EMAIL_FILE_PATH</code></a></li> <li><a class="reference internal" href="#email-host"><code class="docutils literal notranslate">EMAIL_HOST</code></a></li> <li><a class="reference internal" href="#email-host-password"><code class="docutils literal notranslate">EMAIL_HOST_PASSWORD</code></a></li> <li><a class="reference internal" href="#email-host-user"><code class="docutils literal notranslate">EMAIL_HOST_USER</code></a></li> <li><a class="reference internal" href="#email-port"><code class="docutils literal notranslate">EMAIL_PORT</code></a></li> <li><a class="reference internal" href="#email-subject-prefix"><code class="docutils literal notranslate">EMAIL_SUBJECT_PREFIX</code></a></li> <li><a class="reference internal" href="#email-use-localtime"><code class="docutils literal notranslate">EMAIL_USE_LOCALTIME</code></a></li> <li><a class="reference internal" href="#email-use-tls"><code class="docutils literal notranslate">EMAIL_USE_TLS</code></a></li> <li><a class="reference internal" href="#email-use-ssl"><code class="docutils literal notranslate">EMAIL_USE_SSL</code></a></li> <li><a class="reference internal" href="#email-ssl-certfile"><code class="docutils literal notranslate">EMAIL_SSL_CERTFILE</code></a></li> <li><a class="reference internal" href="#email-ssl-keyfile"><code class="docutils literal notranslate">EMAIL_SSL_KEYFILE</code></a></li> <li><a class="reference internal" href="#email-timeout"><code class="docutils literal notranslate">EMAIL_TIMEOUT</code></a></li> <li><a class="reference internal" href="#file-charset"><code class="docutils literal notranslate">FILE_CHARSET</code></a></li> <li><a class="reference internal" href="#file-upload-handlers"><code class="docutils literal notranslate">FILE_UPLOAD_HANDLERS</code></a></li> <li><a class="reference internal" href="#file-upload-max-memory-size"><code class="docutils literal notranslate">FILE_UPLOAD_MAX_MEMORY_SIZE</code></a></li> <li><a class="reference internal" href="#file-upload-directory-permissions"><code class="docutils literal notranslate">FILE_UPLOAD_DIRECTORY_PERMISSIONS</code></a></li> <li><a class="reference internal" href="#file-upload-permissions"><code class="docutils literal notranslate">FILE_UPLOAD_PERMISSIONS</code></a></li> <li><a class="reference internal" href="#file-upload-temp-dir"><code class="docutils literal notranslate">FILE_UPLOAD_TEMP_DIR</code></a></li> <li><a class="reference internal" href="#first-day-of-week"><code class="docutils literal notranslate">FIRST_DAY_OF_WEEK</code></a></li> <li><a class="reference internal" href="#fixture-dirs"><code class="docutils literal notranslate">FIXTURE_DIRS</code></a></li> <li><a class="reference internal" href="#force-script-name"><code class="docutils literal notranslate">FORCE_SCRIPT_NAME</code></a></li> <li><a class="reference internal" href="#form-renderer"><code class="docutils literal notranslate">FORM_RENDERER</code></a></li> <li><a class="reference internal" href="#format-module-path"><code class="docutils literal notranslate">FORMAT_MODULE_PATH</code></a></li> <li><a class="reference internal" href="#ignorable-404-urls"><code class="docutils literal notranslate">IGNORABLE_404_URLS</code></a></li> <li><a class="reference internal" href="#installed-apps"><code class="docutils literal notranslate">INSTALLED_APPS</code></a></li> <li><a class="reference internal" href="#internal-ips"><code class="docutils literal notranslate">INTERNAL_IPS</code></a></li> <li><a class="reference internal" href="#language-code"><code class="docutils literal notranslate">LANGUAGE_CODE</code></a></li> <li><a class="reference internal" href="#language-cookie-age"><code class="docutils literal notranslate">LANGUAGE_COOKIE_AGE</code></a></li> <li><a class="reference internal" href="#language-cookie-domain"><code class="docutils literal notranslate">LANGUAGE_COOKIE_DOMAIN</code></a></li> <li><a class="reference internal" href="#language-cookie-httponly"><code class="docutils literal notranslate">LANGUAGE_COOKIE_HTTPONLY</code></a></li> <li><a class="reference internal" href="#language-cookie-name"><code class="docutils literal notranslate">LANGUAGE_COOKIE_NAME</code></a></li> <li><a class="reference internal" href="#language-cookie-path"><code class="docutils literal notranslate">LANGUAGE_COOKIE_PATH</code></a></li> <li><a class="reference internal" href="#language-cookie-samesite"><code class="docutils literal notranslate">LANGUAGE_COOKIE_SAMESITE</code></a></li> <li><a class="reference internal" href="#language-cookie-secure"><code class="docutils literal notranslate">LANGUAGE_COOKIE_SECURE</code></a></li> <li><a class="reference internal" href="#languages"><code class="docutils literal notranslate">LANGUAGES</code></a></li> <li><a class="reference internal" href="#languages-bidi"><code class="docutils literal notranslate">LANGUAGES_BIDI</code></a></li> <li><a class="reference internal" href="#locale-paths"><code class="docutils literal notranslate">LOCALE_PATHS</code></a></li> <li><a class="reference internal" href="#logging"><code class="docutils literal notranslate">LOGGING</code></a></li> <li><a class="reference internal" href="#logging-config"><code class="docutils literal notranslate">LOGGING_CONFIG</code></a></li> <li><a class="reference internal" href="#managers"><code class="docutils literal notranslate">MANAGERS</code></a></li> <li><a class="reference internal" href="#media-root"><code class="docutils literal notranslate">MEDIA_ROOT</code></a></li> <li><a class="reference internal" href="#media-url"><code class="docutils literal notranslate">MEDIA_URL</code></a></li> <li><a class="reference internal" href="#middleware"><code class="docutils literal notranslate">MIDDLEWARE</code></a></li> <li><a class="reference internal" href="#migration-modules"><code class="docutils literal notranslate">MIGRATION_MODULES</code></a></li> <li><a class="reference internal" href="#month-day-format"><code class="docutils literal notranslate">MONTH_DAY_FORMAT</code></a></li> <li><a class="reference internal" href="#number-grouping"><code class="docutils literal notranslate">NUMBER_GROUPING</code></a></li> <li><a class="reference internal" href="#prepend-www"><code class="docutils literal notranslate">PREPEND_WWW</code></a></li> <li><a class="reference internal" href="#root-urlconf"><code class="docutils literal notranslate">ROOT_URLCONF</code></a></li> <li><a class="reference internal" href="#secret-key"><code class="docutils literal notranslate">SECRET_KEY</code></a></li> <li><a class="reference internal" href="#secure-browser-xss-filter"><code class="docutils literal notranslate">SECURE_BROWSER_XSS_FILTER</code></a></li> <li><a class="reference internal" href="#secure-content-type-nosniff"><code class="docutils literal notranslate">SECURE_CONTENT_TYPE_NOSNIFF</code></a></li> <li><a class="reference internal" href="#secure-hsts-include-subdomains"><code class="docutils literal notranslate">SECURE_HSTS_INCLUDE_SUBDOMAINS</code></a></li> <li><a class="reference internal" href="#secure-hsts-preload"><code class="docutils literal notranslate">SECURE_HSTS_PRELOAD</code></a></li> <li><a class="reference internal" href="#secure-hsts-seconds"><code class="docutils literal notranslate">SECURE_HSTS_SECONDS</code></a></li> <li><a class="reference internal" href="#secure-proxy-ssl-header"><code class="docutils literal notranslate">SECURE_PROXY_SSL_HEADER</code></a></li> <li><a class="reference internal" href="#secure-redirect-exempt"><code class="docutils literal notranslate">SECURE_REDIRECT_EXEMPT</code></a></li> <li><a class="reference internal" href="#secure-referrer-policy"><code class="docutils literal notranslate">SECURE_REFERRER_POLICY</code></a></li> <li><a class="reference internal" href="#secure-ssl-host"><code class="docutils literal notranslate">SECURE_SSL_HOST</code></a></li> <li><a class="reference internal" href="#secure-ssl-redirect"><code class="docutils literal notranslate">SECURE_SSL_REDIRECT</code></a></li> <li><a class="reference internal" href="#serialization-modules"><code class="docutils literal notranslate">SERIALIZATION_MODULES</code></a></li> <li><a class="reference internal" href="#server-email"><code class="docutils literal notranslate">SERVER_EMAIL</code></a></li> <li><a class="reference internal" href="#short-date-format"><code class="docutils literal notranslate">SHORT_DATE_FORMAT</code></a></li> <li><a class="reference internal" href="#short-datetime-format"><code class="docutils literal notranslate">SHORT_DATETIME_FORMAT</code></a></li> <li><a class="reference internal" href="#signing-backend"><code class="docutils literal notranslate">SIGNING_BACKEND</code></a></li> <li><a class="reference internal" href="#silenced-system-checks"><code class="docutils literal notranslate">SILENCED_SYSTEM_CHECKS</code></a></li> <li><a class="reference internal" href="#templates"><code class="docutils literal notranslate">TEMPLATES</code></a><ul> <li><a class="reference internal" href="#std:setting-TEMPLATES-BACKEND"><code class="docutils literal notranslate">BACKEND</code></a></li> <li><a class="reference internal" href="#std:setting-TEMPLATES-NAME"><code class="docutils literal notranslate">NAME</code></a></li> <li><a class="reference internal" href="#dirs"><code class="docutils literal notranslate">DIRS</code></a></li> <li><a class="reference internal" href="#app-dirs"><code class="docutils literal notranslate">APP_DIRS</code></a></li> <li><a class="reference internal" href="#std:setting-TEMPLATES-OPTIONS"><code class="docutils literal notranslate">OPTIONS</code></a></li> </ul> </li> <li><a class="reference internal" href="#test-runner"><code class="docutils literal notranslate">TEST_RUNNER</code></a></li> <li><a class="reference internal" href="#test-non-serialized-apps"><code class="docutils literal notranslate">TEST_NON_SERIALIZED_APPS</code></a></li> <li><a class="reference internal" href="#thousand-separator"><code class="docutils literal notranslate">THOUSAND_SEPARATOR</code></a></li> <li><a class="reference internal" href="#time-format"><code class="docutils literal notranslate">TIME_FORMAT</code></a></li> <li><a class="reference internal" href="#time-input-formats"><code class="docutils literal notranslate">TIME_INPUT_FORMATS</code></a></li> <li><a class="reference internal" href="#std:setting-TIME_ZONE"><code class="docutils literal notranslate">TIME_ZONE</code></a></li> <li><a class="reference internal" href="#use-i18n"><code class="docutils literal notranslate">USE_I18N</code></a></li> <li><a class="reference internal" href="#use-l10n"><code class="docutils literal notranslate">USE_L10N</code></a></li> <li><a class="reference internal" href="#use-thousand-separator"><code class="docutils literal notranslate">USE_THOUSAND_SEPARATOR</code></a></li> <li><a class="reference internal" href="#use-tz"><code class="docutils literal notranslate">USE_TZ</code></a></li> <li><a class="reference internal" href="#use-x-forwarded-host"><code class="docutils literal notranslate">USE_X_FORWARDED_HOST</code></a></li> <li><a class="reference internal" href="#use-x-forwarded-port"><code class="docutils literal notranslate">USE_X_FORWARDED_PORT</code></a></li> <li><a class="reference internal" href="#wsgi-application"><code class="docutils literal notranslate">WSGI_APPLICATION</code></a></li> <li><a class="reference internal" href="#year-month-format"><code class="docutils literal notranslate">YEAR_MONTH_FORMAT</code></a></li> <li><a class="reference internal" href="#x-frame-options"><code class="docutils literal notranslate">X_FRAME_OPTIONS</code></a></li> </ul> </li> <li><a class="reference internal" href="#auth">Auth</a><ul> <li><a class="reference internal" href="#authentication-backends"><code class="docutils literal notranslate">AUTHENTICATION_BACKENDS</code></a></li> <li><a class="reference internal" href="#auth-user-model"><code class="docutils literal notranslate">AUTH_USER_MODEL</code></a></li> <li><a class="reference internal" href="#login-redirect-url"><code class="docutils literal notranslate">LOGIN_REDIRECT_URL</code></a></li> <li><a class="reference internal" href="#login-url"><code class="docutils literal notranslate">LOGIN_URL</code></a></li> <li><a class="reference internal" href="#logout-redirect-url"><code class="docutils literal notranslate">LOGOUT_REDIRECT_URL</code></a></li> <li><a class="reference internal" href="#password-reset-timeout-days"><code class="docutils literal notranslate">PASSWORD_RESET_TIMEOUT_DAYS</code></a></li> <li><a class="reference internal" href="#password-hashers"><code class="docutils literal notranslate">PASSWORD_HASHERS</code></a></li> <li><a class="reference internal" href="#auth-password-validators"><code class="docutils literal notranslate">AUTH_PASSWORD_VALIDATORS</code></a></li> </ul> </li> <li><a class="reference internal" href="#messages">Messages</a><ul> <li><a class="reference internal" href="#message-level"><code class="docutils literal notranslate">MESSAGE_LEVEL</code></a></li> <li><a class="reference internal" href="#message-storage"><code class="docutils literal notranslate">MESSAGE_STORAGE</code></a></li> <li><a class="reference internal" href="#message-tags"><code class="docutils literal notranslate">MESSAGE_TAGS</code></a></li> </ul> </li> <li><a class="reference internal" href="#sessions">Sessions</a><ul> <li><a class="reference internal" href="#session-cache-alias"><code class="docutils literal notranslate">SESSION_CACHE_ALIAS</code></a></li> <li><a class="reference internal" href="#session-cookie-age"><code class="docutils literal notranslate">SESSION_COOKIE_AGE</code></a></li> <li><a class="reference internal" href="#session-cookie-domain"><code class="docutils literal notranslate">SESSION_COOKIE_DOMAIN</code></a></li> <li><a class="reference internal" href="#session-cookie-httponly"><code class="docutils literal notranslate">SESSION_COOKIE_HTTPONLY</code></a></li> <li><a class="reference internal" href="#session-cookie-name"><code class="docutils literal notranslate">SESSION_COOKIE_NAME</code></a></li> <li><a class="reference internal" href="#session-cookie-path"><code class="docutils literal notranslate">SESSION_COOKIE_PATH</code></a></li> <li><a class="reference internal" href="#session-cookie-samesite"><code class="docutils literal notranslate">SESSION_COOKIE_SAMESITE</code></a></li> <li><a class="reference internal" href="#session-cookie-secure"><code class="docutils literal notranslate">SESSION_COOKIE_SECURE</code></a></li> <li><a class="reference internal" href="#session-engine"><code class="docutils literal notranslate">SESSION_ENGINE</code></a></li> <li><a class="reference internal" href="#session-expire-at-browser-close"><code class="docutils literal notranslate">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a></li> <li><a class="reference internal" href="#session-file-path"><code class="docutils literal notranslate">SESSION_FILE_PATH</code></a></li> <li><a class="reference internal" href="#session-save-every-request"><code class="docutils literal notranslate">SESSION_SAVE_EVERY_REQUEST</code></a></li> <li><a class="reference internal" href="#session-serializer"><code class="docutils literal notranslate">SESSION_SERIALIZER</code></a></li> </ul> </li> <li><a class="reference internal" href="#sites">Sites</a><ul> <li><a class="reference internal" href="#site-id"><code class="docutils literal notranslate">SITE_ID</code></a></li> </ul> </li> <li><a class="reference internal" href="#static-files">Static Files</a><ul> <li><a class="reference internal" href="#static-root"><code class="docutils literal notranslate">STATIC_ROOT</code></a></li> <li><a class="reference internal" href="#static-url"><code class="docutils literal notranslate">STATIC_URL</code></a></li> <li><a class="reference internal" href="#staticfiles-dirs"><code class="docutils literal notranslate">STATICFILES_DIRS</code></a><ul> <li><a class="reference internal" href="#prefixes-optional">Prefixes (optional)</a></li> </ul> </li> <li><a class="reference internal" href="#staticfiles-storage"><code class="docutils literal notranslate">STATICFILES_STORAGE</code></a></li> <li><a class="reference internal" href="#staticfiles-finders"><code class="docutils literal notranslate">STATICFILES_FINDERS</code></a></li> </ul> </li> <li><a class="reference internal" href="#core-settings-topical-index">Core Settings Topical Index</a><ul> <li><a class="reference internal" href="#cache">Cache</a></li> <li><a class="reference internal" href="#database">Database</a></li> <li><a class="reference internal" href="#debugging">Debugging</a></li> <li><a class="reference internal" href="#email">Email</a></li> <li><a class="reference internal" href="#error-reporting">Error reporting</a></li> <li><a class="reference internal" href="#file-uploads">File uploads</a></li> <li><a class="reference internal" href="#forms">Forms</a></li> <li><a class="reference internal" href="#globalization-i18n-l10n">Globalization (<code class="docutils literal notranslate">i18n</code>/<code class="docutils literal notranslate">l10n</code>)</a></li> <li><a class="reference internal" href="#http">HTTP</a></li> <li><a class="reference internal" href="#id10">Logging</a></li> <li><a class="reference internal" href="#models">Models</a></li> <li><a class="reference internal" href="#security">Security</a></li> <li><a class="reference internal" href="#serialization">Serialization</a></li> <li><a class="reference internal" href="#id11">Templates</a></li> <li><a class="reference internal" href="#testing">Testing</a></li> <li><a class="reference internal" href="#urls">URLs</a></li> </ul> </li> </ul> </li> </ul> <h2>Browse</h2> <ul> <li>Prev: <a rel="prev" href="../schema-editor/"><code class="docutils literal notranslate">SchemaEditor</code></a></li> <li>Next: <a rel="next" href="../signals/">Signals</a></li> <li><a href="https://docs.djangoproject.com/en/3.0/contents/">Table of contents</a></li> <li><a href="https://docs.djangoproject.com/en/3.0/genindex/">General Index</a></li> <li><a href="https://docs.djangoproject.com/en/3.0/py-modindex/">Python Module Index</a></li> </ul> <h2>You are here:</h2> <ul> <li> <a href="https://docs.djangoproject.com/en/3.0/">Django 3.0 documentation</a> <ul><li><a href="../">API Reference</a> <ul><li>Settings</li></ul> </li></ul> </li> </ul> <h2 id="getting-help-sidebar">Getting help</h2> <dl class="list-links"> <dt><a href="https://docs.djangoproject.com/en/3.0/faq/">FAQ</a></dt> <dd>Try the FAQ — it's got answers to many common questions.</dd> <dt><a href="/en/stable/genindex/">Index</a>, <a href="/en/stable/py-modindex/">Module Index</a>, or <a href="/en/stable/contents/">Table of Contents</a></dt> <dd>Handy when looking for specific information.</dd> <dt><a href="https://groups.google.com/group/django-users/">django-users mailing list</a></dt> <dd>Search for information in the archives of the django-users mailing list, or post a question.</dd> <dt><a href="irc://irc.libera.chat/django">#django IRC channel</a></dt> <dd>Ask a question in the #django IRC channel, or search the IRC logs to see if it’s been asked before.</dd> <dt><a href="https://discord.gg/xcRH6mN4fa">Django Discord Server</a></dt> <dd>Join the Django Discord Community.</dd> <dt><a href="https://forum.djangoproject.com/">Official Django Forum</a></dt> <dd>Join the community on the Django Forum.</dd> <dt><a href="https://code.djangoproject.com/">Ticket tracker</a></dt> <dd>Report bugs with Django or Django documentation in our ticket tracker.</dd> </dl> <h2>Download:</h2> Offline (Django 3.0): <a href="https://media.djangoproject.com/docs/django-docs-3.0-en.zip">HTML</a> | <a href="https://media.readthedocs.org/pdf/django/3.0.x/django.pdf">PDF</a> | <a href="https://media.readthedocs.org/epub/django/3.0.x/django.epub">ePub</a> Provided by <a href="https://readthedocs.org/">Read the Docs</a>. </div> </div>  <svg xmlns="http://www.w3.org/2000/svg"> <symbol viewBox="0 0 24 24" id="icon-auto"><path d="M0 0h24v24H0z" fill="currentColor"/><path d="M12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10-4.477 10-10 10zm0-2V4a8 8 0 1 0 0 16z"/></symbol> <symbol viewBox="0 0 24 24" id="icon-moon"><path d="M0 0h24v24H0z" fill="currentColor"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol> <symbol viewBox="0 0 24 24" id="icon-sun"><path d="M0 0h24v24H0z" fill="currentColor"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol> </svg>  <div role="contentinfo"> <div class="subfooter"> <div class="container"> <h1 class="visuallyhidden">Django Links</h1> <div class="column-container"> <div class="col-learn-more"> <h2>Learn More</h2> <ul> <li><a href="https://www.djangoproject.com/start/overview/">About Django</a></li> <li><a href="https://www.djangoproject.com/start/">Getting Started with Django</a></li> <li><a href="https://docs.djangoproject.com/en/dev/internals/organization/">Team Organization</a></li> <li><a href="https://www.djangoproject.com/foundation/">Django Software Foundation</a></li> <li><a href="https://www.djangoproject.com/conduct/">Code of Conduct</a></li> <li><a href="https://www.djangoproject.com/diversity/">Diversity Statement</a></li> </ul> </div> <div class="col-get-involved"> <h2>Get Involved</h2> <ul> <li><a href="https://www.djangoproject.com/community/">Join a Group</a></li> <li><a href="https://docs.djangoproject.com/en/dev/internals/contributing/">Contribute to Django</a></li> <li><a href="https://docs.djangoproject.com/en/dev/internals/contributing/bugs-and-features/">Submit a Bug</a></li> <li><a href="https://docs.djangoproject.com/en/dev/internals/security/#reporting-security-issues">Report a Security Issue</a></li> <li><a href="https://www.djangoproject.com/foundation/individual-members/">Individual membership</a></li> </ul> </div> <div class="col-get-help"> <h2>Get Help</h2> <ul> <li><a href="https://docs.djangoproject.com/en/stable/faq/">Getting Help FAQ</a> </li> <li><a href="irc://irc.libera.chat/django">#django IRC channel</a></li> <li><a href="https://discord.gg/xcRH6mN4fa" target="_blank">Django Discord</a></li> <li><a href="https://forum.djangoproject.com/" target="_blank">Official Django Forum</a></li> </ul> </div> <div class="col-follow-us"> <h2>Follow Us</h2> <ul> <li><a href="https://github.com/django">GitHub</a></li> <li><a href="https://twitter.com/djangoproject">Twitter</a></li> <li><a href="https://fosstodon.org/@django" rel="me">Fediverse (Mastodon)</a></li> <li><a href="https://www.djangoproject.com/rss/weblog/">News RSS</a></li> <li><a href="https://groups.google.com/forum/#!forum/django-users">Django Users Mailing List</a></li> </ul> </div> <div class="col-support-us"> <h2>Support Us</h2> <ul> <li><a href="https://www.djangoproject.com/fundraising/">Sponsor Django</a></li> <li><a href="/foundation/corporate-membership/">Corporate membership</a></li> <li><a href="https://django.threadless.com/" target="_blank">Official merchandise store</a></li> <li><a href="/foundation/donate/#benevity-giving">Benevity Workplace Giving Program</a></li> </ul> </div> </div> </div> </div> <div class="footer"> <div class="container"> <div class="footer-logo"> <a class="logo" href="https://www.djangoproject.com/">Django</a> </div> <ul class="thanks"> <li> Hosting by <a class="in-kind-donors" href="https://www.djangoproject.com/fundraising/#in-kind-donors">In-kind donors</a> </li> <li class="design">Design by <a class="threespot" href="https://www.threespot.com">Threespot</a> & <a class="andrevv" href="http://andrevv.com/">andrevv</a></li> </ul> © 2005-2024 <a href="https://www.djangoproject.com/foundation/"> Django Software Foundation</a> and individual contributors. Django is a <a href="https://www.djangoproject.com/trademarks/">registered trademark</a> of the Django Software Foundation. </div> </div> </div> <script> function extless(input) { return input.replace(/(.*)\.[^.]+$/, '$1'); } var require = { shim: { 'jquery': [], 'jquery.inview': ["jquery"], 'jquery.payment': ["jquery"], 'jquery.flot': ["jquery"], 'jquery.unveil': ["jquery"], 'stripe': { exports: 'Stripe' } }, paths: { "jquery": extless("https://static.djangoproject.com/js/lib/jquery/dist/jquery.min.eb6af28969bd.js"), "jquery.inview": extless("https://static.djangoproject.com/js/lib/jquery.inview/jquery.inview.min.4edba1c65592.js"), "jquery.payment": extless("https://static.djangoproject.com/js/lib/jquery.payment/lib/jquery.payment.e99c05ca79ae.js"), "jquery.unveil": extless("https://static.djangoproject.com/js/lib/unveil/jquery.unveil.min.ac79eb277093.js"), "jquery.flot": extless("https://static.djangoproject.com/js/lib/jquery-flot/jquery.flot.min.9964206e9d7f.js"), "clipboard": extless("https://static.djangoproject.com/js/lib/clipboard/dist/clipboard.min.bd70fd596a23.js"), "mod/floating-warning": extless("https://static.djangoproject.com/js/mod/floating-warning.a21b2abd2884.js"), "mod/list-collapsing": extless("https://static.djangoproject.com/js/mod/list-collapsing.c1a08d3ef9e9.js"), "mod/list-feature": extless("https://static.djangoproject.com/js/mod/list-feature.73529480f25b.js"), "mod/mobile-menu": extless("https://static.djangoproject.com/js/mod/mobile-menu.8e7e063d3524.js"), "mod/version-switcher": extless("https://static.djangoproject.com/js/mod/version-switcher.c56ff7ed5481.js"), "mod/search-key": extless("https://static.djangoproject.com/js/mod/search-key.ae7292327b47.js"), "mod/stripe-change-card": extless("https://static.djangoproject.com/js/mod/stripe-change-card.682c710317a8.js"), "mod/switch-dark-mode": extless("https://static.djangoproject.com/js/mod/switch-dark-mode.69777ee87b91.js"), "mod/console-tabs": extless("https://static.djangoproject.com/js/mod/console-tabs.70ce882faaf3.js"), "stripe-checkout": "https://checkout.stripe.com/checkout", "stripe": "https://js.stripe.com/v3/?" // ? needed due to require.js } }; </script> <script data-main="https://static.djangoproject.com/js/main.48270eac7c0b.js" src="https://static.djangoproject.com/js/lib/require.177879fbe7dd.js"></script> <div id="outdated-warning" class="doc-floating-warning"> This document is for an insecure version of Django that is no longer supported. Please upgrade to a newer release! </div> </body> </html>