========Settings========.. contents:::local::depth: 1.. warning::Be careful when you override settings, especially when the default valueis a non-empty list or dictionary, such as :setting:`STATICFILES_FINDERS`.Make sure you keep the components required by the features of Django youwish to use.Core Settings=============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 indexof the core settings. For introductory material, see the :doc:`settings topicguide </topics/settings>`... setting:: ABSOLUTE_URL_OVERRIDES``ABSOLUTE_URL_OVERRIDES``--------------------------Default: ``{}`` (Empty dictionary)A dictionary mapping ``"app_label.model_name"`` strings to functions that takea model object and return its URL. This is a way of inserting or overriding``get_absolute_url()`` methods on a per-installation basis. Example::ABSOLUTE_URL_OVERRIDES = {'blogs.blog': lambda o: "/blogs/%s/" % o.slug,'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),}The model name used in this setting should be all lowercase, regardless of thecase of the actual model class name... setting:: ADMINS``ADMINS``----------Default: ``[]`` (Empty list)A list of all the people who get code error notifications. When:setting:`DEBUG=False <DEBUG>` and :class:`~django.utils.log.AdminEmailHandler`is configured in :setting:`LOGGING` (done by default), Django emails thesepeople 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::[('John', '[email protected]'), ('Mary', '[email protected]')].. setting:: ALLOWED_HOSTS``ALLOWED_HOSTS``-----------------Default: ``[]`` (Empty list)A list of strings representing the host/domain names that this Django site canserve. This is a security measure to prevent :ref:`HTTP Host header attacks<host-headers-virtual-hosting>`, which are possible even under manyseemingly-safe web server configurations.Values in this list can be fully qualified names (e.g. ``'www.example.com'``),in which case they will be matched against the request's ``Host`` headerexactly (case-insensitive, not including port). A value beginning with a periodcan be used as a subdomain wildcard: ``'.example.com'`` will match``example.com``, ``www.example.com``, and any other subdomain of``example.com``. A value of ``'*'`` will match anything; in this case you areresponsible to provide your own validation of the ``Host`` header (perhaps in amiddleware; if so this middleware must be listed first in:setting:`MIDDLEWARE`).Django also allows the `fully qualified domain name (FQDN)`_ of any entries.Some browsers include a trailing dot in the ``Host`` header which Djangostrips when performing host validation... _`fully qualified domain name (FQDN)`: https://en.wikipedia.org/wiki/Fully_qualified_domain_nameIf the ``Host`` header (or ``X-Forwarded-Host`` if:setting:`USE_X_FORWARDED_HOST` is enabled) does not match any value in thislist, the :meth:`django.http.HttpRequest.get_host()` method will raise:exc:`~django.core.exceptions.SuspiciousOperation`.When :setting:`DEBUG` is ``True`` and ``ALLOWED_HOSTS`` is empty, the hostis validated against ``['.localhost', '127.0.0.1', '[::1]']``.``ALLOWED_HOSTS`` is also :ref:`checked when running tests<topics-testing-advanced-multiple-hosts>`.This validation only applies via :meth:`~django.http.HttpRequest.get_host()`;if your code accesses the ``Host`` header directly from ``request.META`` youare bypassing this security protection... setting:: APPEND_SLASH``APPEND_SLASH``----------------Default: ``True``When set to ``True``, if the request URL does not match any of the patternsin the URLconf and it doesn't end in a slash, an HTTP redirect is issued to thesame URL with a slash appended. Note that the redirect may cause any datasubmitted in a POST request to be lost.The :setting:`APPEND_SLASH` setting is only used if:class:`~django.middleware.common.CommonMiddleware` is installed(see :doc:`/topics/http/middleware`). See also :setting:`PREPEND_WWW`... setting:: CACHES``CACHES``----------Default::{'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',}}A dictionary containing the settings for all caches to be used withDjango. It is a nested dictionary whose contents maps cache aliasesto a dictionary containing the options for an individual cache.The :setting:`CACHES` setting must configure a ``default`` cache;any number of additional caches may also be specified. If youare using a cache backend other than the local memory cache, oryou need to define multiple caches, other options will be required.The following cache options are available... setting:: CACHES-BACKEND``BACKEND``~~~~~~~~~~~Default: ``''`` (Empty string)The cache backend to use. The built-in cache backends are:* ``'django.core.cache.backends.db.DatabaseCache'``* ``'django.core.cache.backends.dummy.DummyCache'``* ``'django.core.cache.backends.filebased.FileBasedCache'``* ``'django.core.cache.backends.locmem.LocMemCache'``* ``'django.core.cache.backends.memcached.PyMemcacheCache'``* ``'django.core.cache.backends.memcached.PyLibMCCache'``* ``'django.core.cache.backends.redis.RedisCache'``You can use a cache backend that doesn't ship with Django by setting:setting:`BACKEND <CACHES-BACKEND>` to a fully-qualified path of a cachebackend class (i.e. ``mypackage.backends.whatever.WhateverCache``)... versionchanged:: 4.0The ``RedisCache`` backend was added... setting:: CACHES-KEY_FUNCTION``KEY_FUNCTION``~~~~~~~~~~~~~~~~A string containing a dotted path to a function (or any callable) that defines how tocompose a prefix, version and key into a final cache key. The defaultimplementation is equivalent to the function::def make_key(key, key_prefix, version):return ':'.join([key_prefix, str(version), key])You may use any key function you want, as long as it has the sameargument signature.See the :ref:`cache documentation <cache_key_transformation>` for moreinformation... setting:: CACHES-KEY_PREFIX``KEY_PREFIX``~~~~~~~~~~~~~~Default: ``''`` (Empty string)A string that will be automatically included (prepended by default) toall cache keys used by the Django server.See the :ref:`cache documentation <cache_key_prefixing>` for more information... setting:: CACHES-LOCATION``LOCATION``~~~~~~~~~~~~Default: ``''`` (Empty string)The location of the cache to use. This might be the directory for afile system cache, a host and port for a memcache server, or an identifyingname for a local memory cache. e.g.::CACHES = {'default': {'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache','LOCATION': '/var/tmp/django_cache',}}.. setting:: CACHES-OPTIONS``OPTIONS``~~~~~~~~~~~Default: ``None``Extra parameters to pass to the cache backend. Available parametersvary depending on your cache backend.Some information on available parameters can be found in the:ref:`cache arguments <cache_arguments>` documentation. For more information,consult your backend module's own documentation... setting:: CACHES-TIMEOUT``TIMEOUT``~~~~~~~~~~~Default: ``300``The number of seconds before a cache entry is considered stale. If the value ofthis setting is ``None``, cache entries will not expire. A value of ``0``causes keys to immediately expire (effectively "don't cache")... setting:: CACHES-VERSION``VERSION``~~~~~~~~~~~Default: ``1``The default version number for cache keys generated by the Django server.See the :ref:`cache documentation <cache_versioning>` for more information... setting:: CACHE_MIDDLEWARE_ALIAS``CACHE_MIDDLEWARE_ALIAS``--------------------------Default: ``'default'``The cache connection to use for the :ref:`cache middleware<the-per-site-cache>`... setting:: CACHE_MIDDLEWARE_KEY_PREFIX``CACHE_MIDDLEWARE_KEY_PREFIX``-------------------------------Default: ``''`` (Empty string)A string which will be prefixed to the cache keys generated by the :ref:`cachemiddleware <the-per-site-cache>`. This prefix is combined with the:setting:`KEY_PREFIX <CACHES-KEY_PREFIX>` setting; it does not replace it.See :doc:`/topics/cache`... setting:: CACHE_MIDDLEWARE_SECONDS``CACHE_MIDDLEWARE_SECONDS``----------------------------Default: ``600``The default number of seconds to cache a page for the :ref:`cache middleware<the-per-site-cache>`.See :doc:`/topics/cache`... _settings-csrf:.. setting:: CSRF_COOKIE_AGE``CSRF_COOKIE_AGE``-------------------Default: ``31449600`` (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 inthe case of a user closing a browser or bookmarking a page and then loadingthat page from a browser cache. Without persistent cookies, the form submissionwould fail in this case.Some browsers (specifically Internet Explorer) can disallow the use ofpersistent 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 ``None`` to use session-based CSRF cookies, whichkeep the cookies in-memory instead of on persistent storage... setting:: CSRF_COOKIE_DOMAIN``CSRF_COOKIE_DOMAIN``----------------------Default: ``None``The domain to be used when setting the CSRF cookie. This can be useful foreasily allowing cross-subdomain requests to be excluded from the normal crosssite request forgery protection. It should be set to a string such as``".example.com"`` to allow a POST request from a form on one subdomain to beaccepted by a view served from another subdomain.Please note that the presence of this setting does not imply that Django's CSRFprotection is safe from cross-subdomain attacks by default - please see the:ref:`CSRF limitations <csrf-limitations>` section... setting:: CSRF_COOKIE_HTTPONLY``CSRF_COOKIE_HTTPONLY``------------------------Default: ``False``Whether to use ``HttpOnly`` flag on the CSRF cookie. If this is set to``True``, client-side JavaScript will not be able to access the CSRF cookie.Designating the CSRF cookie as ``HttpOnly`` doesn't offer any practicalprotection because CSRF is only to protect against cross-domain attacks. If anattacker can read the cookie via JavaScript, they're already on the same domainas far as the browser knows, so they can do anything they like anyway. (XSS isa much bigger hole than CSRF.)Although the setting offers little practical benefit, it's sometimes requiredby security auditors.If you enable this and need to send the value of the CSRF token with an AJAXrequest, your JavaScript must pull the value :ref:`from a hidden CSRF tokenform input <acquiring-csrf-token-from-html>` instead of :ref:`from the cookie<acquiring-csrf-token-from-cookie>`.See :setting:`SESSION_COOKIE_HTTPONLY` for details on ``HttpOnly``... setting:: CSRF_COOKIE_MASKED``CSRF_COOKIE_MASKED``----------------------.. versionadded:: 4.1Default: ``False``Whether to mask the CSRF cookie. See:ref:`release notes <csrf-cookie-masked-usage>` for usage details... deprecated:: 4.1This transitional setting is deprecated and will be removed in Django 5.0... setting:: CSRF_COOKIE_NAME``CSRF_COOKIE_NAME``--------------------Default: ``'csrftoken'``The name of the cookie to use for the CSRF authentication token. This can bewhatever you want (as long as it's different from the other cookie names inyour application). See :doc:`/ref/csrf`... setting:: CSRF_COOKIE_PATH``CSRF_COOKIE_PATH``--------------------Default: ``'/'``The path set on the CSRF cookie. This should either match the URL path of yourDjango installation or be a parent of that path.This is useful if you have multiple Django instances running under the samehostname. They can use different cookie paths, and each instance will only seeits own CSRF cookie... setting:: CSRF_COOKIE_SAMESITE``CSRF_COOKIE_SAMESITE``------------------------Default: ``'Lax'``The value of the `SameSite`_ flag on the CSRF cookie. This flag prevents thecookie from being sent in cross-site requests.See :setting:`SESSION_COOKIE_SAMESITE` for details about ``SameSite``... setting:: CSRF_COOKIE_SECURE``CSRF_COOKIE_SECURE``----------------------Default: ``False``Whether to use a secure cookie for the CSRF cookie. If this is set to ``True``,the cookie will be marked as "secure", which means browsers may ensure that thecookie is only sent with an HTTPS connection... setting:: CSRF_USE_SESSIONS``CSRF_USE_SESSIONS``---------------------Default: ``False``Whether to store the CSRF token in the user's session instead of in a cookie.It requires the use of :mod:`django.contrib.sessions`.Storing the CSRF token in a cookie (Django's default) is safe, but storing itin the session is common practice in other web frameworks and thereforesometimes demanded by security auditors.Since the :ref:`default error views <error-views>` require the CSRF token,:class:`~django.contrib.sessions.middleware.SessionMiddleware` must appear in:setting:`MIDDLEWARE` before any middleware that may raise an exception totrigger an error view (such as :exc:`~django.core.exceptions.PermissionDenied`)if you're using ``CSRF_USE_SESSIONS``. See :ref:`middleware-ordering`... setting:: CSRF_FAILURE_VIEW``CSRF_FAILURE_VIEW``---------------------Default: ``'django.views.csrf.csrf_failure'``A dotted path to the view function to be used when an incoming request isrejected by the :doc:`CSRF protection </ref/csrf>`. The function should havethis signature::def csrf_failure(request, reason=""):...where ``reason`` is a short message (intended for developers or logging, notfor end users) indicating the reason the request was rejected. It should returnan :class:`~django.http.HttpResponseForbidden`.``django.views.csrf.csrf_failure()`` accepts an additional ``template_name``parameter that defaults to ``'403_csrf.html'``. If a template with that nameexists, it will be used to render the page... setting:: CSRF_HEADER_NAME``CSRF_HEADER_NAME``--------------------Default: ``'HTTP_X_CSRFTOKEN'``The name of the request header used for CSRF authentication.As with other HTTP headers in ``request.META``, the header name received fromthe server is normalized by converting all characters to uppercase, replacingany hyphens with underscores, and adding an ``'HTTP_'`` prefix to the name.For example, if your client sends a ``'X-XSRF-TOKEN'`` header, the settingshould be ``'HTTP_X_XSRF_TOKEN'``... setting:: CSRF_TRUSTED_ORIGINS``CSRF_TRUSTED_ORIGINS``------------------------Default: ``[]`` (Empty list)A list of trusted origins for unsafe requests (e.g. ``POST``).For requests that include the ``Origin`` header, Django's CSRF protectionrequires that header match the origin present in the ``Host`` header.For a :meth:`secure <django.http.HttpRequest.is_secure>` unsaferequest that doesn't include the ``Origin`` header, the request must have a``Referer`` header that matches the origin present in the ``Host`` header.These checks prevent, for example, a ``POST`` request from``subdomain.example.com`` from succeeding against ``api.example.com``. If youneed cross-origin unsafe requests, continuing the example, add``'https://subdomain.example.com'`` to this list (and/or ``http://...`` ifrequests originate from an insecure page).The setting also supports subdomains, so you could add``'https://*.example.com'``, for example, to allow access from all subdomainsof ``example.com``... versionchanged:: 4.0The values in older versions must only include the hostname (possibly witha leading dot) and not the scheme or an asterisk.Also, ``Origin`` header checking isn't performed in older versions... setting:: DATABASES``DATABASES``-------------Default: ``{}`` (Empty dictionary)A dictionary containing the settings for all databases to be used withDjango. It is a nested dictionary whose contents map a database aliasto a dictionary containing the options for an individual database.The :setting:`DATABASES` setting must configure a ``default`` database;any number of additional databases may also be specified.The simplest possible settings file is for a single-database setup usingSQLite. This can be configured using the following::DATABASES = {'default': {'ENGINE': 'django.db.backends.sqlite3','NAME': 'mydatabase',}}When connecting to other database backends, such as MariaDB, MySQL, Oracle, orPostgreSQL, additional connection parameters will be required. Seethe :setting:`ENGINE <DATABASE-ENGINE>` setting below on how to specifyother database types. This example is for PostgreSQL::DATABASES = {'default': {'ENGINE': 'django.db.backends.postgresql','NAME': 'mydatabase','USER': 'mydatabaseuser','PASSWORD': 'mypassword','HOST': '127.0.0.1','PORT': '5432',}}The following inner options that may be required for more complexconfigurations are available:.. setting:: DATABASE-ATOMIC_REQUESTS``ATOMIC_REQUESTS``~~~~~~~~~~~~~~~~~~~Default: ``False``Set this to ``True`` to wrap each view in a transaction on this database. See:ref:`tying-transactions-to-http-requests`... setting:: DATABASE-AUTOCOMMIT``AUTOCOMMIT``~~~~~~~~~~~~~~Default: ``True``Set this to ``False`` if you want to :ref:`disable Django's transactionmanagement <deactivate-transaction-management>` and implement your own... setting:: DATABASE-ENGINE``ENGINE``~~~~~~~~~~Default: ``''`` (Empty string)The database backend to use. The built-in database backends are:* ``'django.db.backends.postgresql'``* ``'django.db.backends.mysql'``* ``'django.db.backends.sqlite3'``* ``'django.db.backends.oracle'``You can use a database backend that doesn't ship with Django by setting``ENGINE`` to a fully-qualified path (i.e. ``mypackage.backends.whatever``)... setting:: HOST``HOST``~~~~~~~~Default: ``''`` (Empty string)Which host to use when connecting to the database. An empty string meanslocalhost. Not used with SQLite.If this value starts with a forward slash (``'/'``) and you're using MySQL,MySQL will connect via a Unix socket to the specified socket. For example::"HOST": '/var/run/mysql'If you're using MySQL and this value *doesn't* start with a forward slash, thenthis value is assumed to be the host.If you're using PostgreSQL, by default (empty :setting:`HOST`), the connectionto the database is done through UNIX domain sockets ('local' lines in``pg_hba.conf``). If your UNIX domain socket is not in the standard location,use the same value of ``unix_socket_directory`` from ``postgresql.conf``.If you want to connect through TCP sockets, set :setting:`HOST` to 'localhost'or '127.0.0.1' ('host' lines in ``pg_hba.conf``).On Windows, you should always define :setting:`HOST`, as UNIX domain socketsare not available... setting:: NAME``NAME``~~~~~~~~Default: ``''`` (Empty string)The name of the database to use. For SQLite, it's the full path to the databasefile. When specifying the path, always use forward slashes, even on Windows(e.g. ``C:/homes/user/mysite/sqlite3.db``)... setting:: CONN_MAX_AGE``CONN_MAX_AGE``~~~~~~~~~~~~~~~~Default: ``0``The lifetime of a database connection, as an integer of seconds. Use ``0`` toclose database connections at the end of each request — Django's historicalbehavior — and ``None`` for unlimited :ref:`persistent database connections<persistent-database-connections>`... setting:: CONN_HEALTH_CHECKS``CONN_HEALTH_CHECKS``~~~~~~~~~~~~~~~~~~~~~~.. versionadded:: 4.1Default: ``False``If set to ``True``, existing :ref:`persistent database connections<persistent-database-connections>` will be health checked before they arereused in each request performing database access. If the health check fails,the connection will be reestablished without failing the request when theconnection is no longer usable but the database server is ready to accept andserve new connections (e.g. after database server restart closing existingconnections)... setting:: OPTIONS``OPTIONS``~~~~~~~~~~~Default: ``{}`` (Empty dictionary)Extra parameters to use when connecting to the database. Available parametersvary depending on your database backend.Some information on available parameters can be found in the:doc:`Database Backends </ref/databases>` documentation. For more information,consult your backend module's own documentation... setting:: PASSWORD``PASSWORD``~~~~~~~~~~~~Default: ``''`` (Empty string)The password to use when connecting to the database. Not used with SQLite... setting:: PORT``PORT``~~~~~~~~Default: ``''`` (Empty string)The port to use when connecting to the database. An empty string means thedefault port. Not used with SQLite... setting:: DATABASE-TIME_ZONE``TIME_ZONE``~~~~~~~~~~~~~Default: ``None``A string representing the time zone for this database connection or ``None``.This inner option of the :setting:`DATABASES` setting accepts the same valuesas the general :setting:`TIME_ZONE` setting.When :setting:`USE_TZ` is ``True`` and this option is set, reading datetimesfrom the database returns aware datetimes in this time zone instead of UTC.When :setting:`USE_TZ` is ``False``, it is an error to set this option.* If the database backend doesn't support time zones (e.g. SQLite, MySQL,Oracle), Django reads and writes datetimes in local time according to thisoption if it is set and in UTC if it isn't.Changing the connection time zone changes how datetimes are read from andwritten to the database.* If Django manages the database and you don't have a strong reason to dootherwise, you should leave this option unset. It's best to store datetimesin UTC because it avoids ambiguous or nonexistent datetimes during daylightsaving time changes. Also, receiving datetimes in UTC keeps datetimearithmetic simple — there's no need to consider potential offset changesover a DST transition.* If you're connecting to a third-party database that stores datetimes in alocal time rather than UTC, then you must set this option to theappropriate time zone. Likewise, if Django manages the database butthird-party systems connect to the same database and expect to finddatetimes in local time, then you must set this option.* If the database backend supports time zones (e.g. PostgreSQL), the``TIME_ZONE`` option is very rarely needed. It can be changed at any time;the database takes care of converting datetimes to the desired time zone.Setting the time zone of the database connection may be useful for runningraw SQL queries involving date/time functions provided by the database, suchas ``date_trunc``, because their results depend on the time zone.However, this has a downside: receiving all datetimes in local time makesdatetime arithmetic more tricky — you must account for possible offsetchanges over DST transitions.Consider converting to local time explicitly with ``AT TIME ZONE`` in raw SQLqueries instead of setting the ``TIME_ZONE`` option... setting:: DATABASE-DISABLE_SERVER_SIDE_CURSORS``DISABLE_SERVER_SIDE_CURSORS``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Default: ``False``Set this to ``True`` if you want to disable the use of server-side cursors with:meth:`.QuerySet.iterator`. :ref:`transaction-pooling-server-side-cursors`describes the use case.This is a PostgreSQL-specific setting... setting:: USER``USER``~~~~~~~~Default: ``''`` (Empty string)The username to use when connecting to the database. Not used with SQLite... setting:: DATABASE-TEST``TEST``~~~~~~~~Default: ``{}`` (Empty dictionary)A dictionary of settings for test databases; for more details about thecreation and use of test databases, see :ref:`the-test-database`.Here's an example with a test database configuration::DATABASES = {'default': {'ENGINE': 'django.db.backends.postgresql','USER': 'mydatabaseuser','NAME': 'mydatabase','TEST': {'NAME': 'mytestdatabase',},},}The following keys in the ``TEST`` dictionary are available:.. setting:: TEST_CHARSET``CHARSET``^^^^^^^^^^^Default: ``None``The character set encoding used to create the test database. The value of thisstring is passed directly through to the database, so its format isbackend-specific.Supported by the PostgreSQL_ (``postgresql``) and MySQL_ (``mysql``) backends... _PostgreSQL: https://www.postgresql.org/docs/current/multibyte.html.. _MySQL: https://dev.mysql.com/doc/refman/en/charset-charsets.html.. setting:: TEST_COLLATION``COLLATION``^^^^^^^^^^^^^Default: ``None``The collation order to use when creating the test database. This value ispassed directly to the backend, so its format is backend-specific.Only supported for the ``mysql`` backend (see the `MySQL manual`_ for details)... _MySQL manual: MySQL_.. setting:: TEST_DEPENDENCIES``DEPENDENCIES``^^^^^^^^^^^^^^^^Default: ``['default']``, for all databases other than ``default``,which has no dependencies.The creation-order dependencies of the database. See the documentationon :ref:`controlling the creation order of test databases<topics-testing-creation-dependencies>` for details... setting:: TEST_MIGRATE``MIGRATE``^^^^^^^^^^^Default: ``True``When set to ``False``, migrations won't run when creating the test database.This is similar to setting ``None`` as a value in :setting:`MIGRATION_MODULES`,but for all apps... setting:: TEST_MIRROR``MIRROR``^^^^^^^^^^Default: ``None``The alias of the database that this database should mirror duringtesting. It depends on transactions and therefore must be used within:class:`~django.test.TransactionTestCase` instead of:class:`~django.test.TestCase`.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:ref:`testing primary/replica configurations<topics-testing-primaryreplica>` for details... setting:: TEST_NAME``NAME``^^^^^^^^Default: ``None``The name of database to use when running the test suite.If the default value (``None``) is used with the SQLite database engine, thetests will use a memory resident database. For all other database engines thetest database will use the name ``'test_' + DATABASE_NAME``.See :ref:`the-test-database`... setting:: TEST_SERIALIZE``SERIALIZE``^^^^^^^^^^^^^Boolean value to control whether or not the default test runner serializes thedatabase into an in-memory JSON string before running tests (used to restorethe database state between tests if you don't have transactions). You can setthis to ``False`` to speed up creation time if you don't have any test classeswith :ref:`serialized_rollback=True <test-case-serialized-rollback>`... deprecated:: 4.0This setting is deprecated as it can be inferred from the:attr:`~django.test.TestCase.databases` with the:ref:`serialized_rollback <test-case-serialized-rollback>` option enabled... setting:: TEST_TEMPLATE``TEMPLATE``^^^^^^^^^^^^This is a PostgreSQL-specific setting.The name of a `template`_ (e.g. ``'template0'``) from which to create the testdatabase... _template: https://www.postgresql.org/docs/current/sql-createdatabase.html.. setting:: TEST_CREATE``CREATE_DB``^^^^^^^^^^^^^Default: ``True``This is an Oracle-specific setting.If it is set to ``False``, the test tablespaces won't be automatically createdat the beginning of the tests or dropped at the end... setting:: TEST_USER_CREATE``CREATE_USER``^^^^^^^^^^^^^^^Default: ``True``This is an Oracle-specific setting.If it is set to ``False``, the test user won't be automatically created at thebeginning of the tests and dropped at the end... setting:: TEST_USER``USER``^^^^^^^^Default: ``None``This is an Oracle-specific setting.The username to use when connecting to the Oracle database that will be usedwhen running tests. If not provided, Django will use ``'test_' + USER``... setting:: TEST_PASSWD``PASSWORD``^^^^^^^^^^^^Default: ``None``This is an Oracle-specific setting.The password to use when connecting to the Oracle database that will be usedwhen running tests. If not provided, Django will generate a random password... setting:: TEST_ORACLE_MANAGED_FILES``ORACLE_MANAGED_FILES``^^^^^^^^^^^^^^^^^^^^^^^^Default: ``False``This is an Oracle-specific setting.If set to ``True``, Oracle Managed Files (OMF) tablespaces will be used.:setting:`DATAFILE` and :setting:`DATAFILE_TMP` will be ignored... setting:: TEST_TBLSPACE``TBLSPACE``^^^^^^^^^^^^Default: ``None``This is an Oracle-specific setting.The name of the tablespace that will be used when running tests. If notprovided, Django will use ``'test_' + USER``... setting:: TEST_TBLSPACE_TMP``TBLSPACE_TMP``^^^^^^^^^^^^^^^^Default: ``None``This is an Oracle-specific setting.The name of the temporary tablespace that will be used when running tests. Ifnot provided, Django will use ``'test_' + USER + '_temp'``... setting:: DATAFILE``DATAFILE``^^^^^^^^^^^^Default: ``None``This is an Oracle-specific setting.The name of the datafile to use for the TBLSPACE. If not provided, Django willuse ``TBLSPACE + '.dbf'``... setting:: DATAFILE_TMP``DATAFILE_TMP``^^^^^^^^^^^^^^^^Default: ``None``This is an Oracle-specific setting.The name of the datafile to use for the TBLSPACE_TMP. If not provided, Djangowill use ``TBLSPACE_TMP + '.dbf'``... setting:: DATAFILE_MAXSIZE``DATAFILE_MAXSIZE``^^^^^^^^^^^^^^^^^^^^Default: ``'500M'``This is an Oracle-specific setting.The maximum size that the DATAFILE is allowed to grow to... setting:: DATAFILE_TMP_MAXSIZE``DATAFILE_TMP_MAXSIZE``^^^^^^^^^^^^^^^^^^^^^^^^Default: ``'500M'``This is an Oracle-specific setting.The maximum size that the DATAFILE_TMP is allowed to grow to... setting:: DATAFILE_SIZE``DATAFILE_SIZE``^^^^^^^^^^^^^^^^^Default: ``'50M'``This is an Oracle-specific setting.The initial size of the DATAFILE... setting:: DATAFILE_TMP_SIZE``DATAFILE_TMP_SIZE``^^^^^^^^^^^^^^^^^^^^^Default: ``'50M'``This is an Oracle-specific setting.The initial size of the DATAFILE_TMP... setting:: DATAFILE_EXTSIZE``DATAFILE_EXTSIZE``^^^^^^^^^^^^^^^^^^^^Default: ``'25M'``This is an Oracle-specific setting.The amount by which the DATAFILE is extended when more space is required... setting:: DATAFILE_TMP_EXTSIZE``DATAFILE_TMP_EXTSIZE``^^^^^^^^^^^^^^^^^^^^^^^^Default: ``'25M'``This is an Oracle-specific setting.The amount by which the DATAFILE_TMP is extended when more space is required... setting:: DATA_UPLOAD_MAX_MEMORY_SIZE``DATA_UPLOAD_MAX_MEMORY_SIZE``-------------------------------Default: ``2621440`` (i.e. 2.5 MB).The maximum size in bytes that a request body may be before a:exc:`~django.core.exceptions.SuspiciousOperation` (``RequestDataTooBig``) israised. The check is done when accessing ``request.body`` or ``request.POST``and is calculated against the total request size excluding any file uploaddata. You can set this to ``None`` to disable the check. Applications that areexpected to receive unusually large form posts should tune this setting.The amount of request data is correlated to the amount of memory needed toprocess the request and populate the GET and POST dictionaries. Large requestscould be used as a denial-of-service attack vector if left unchecked. Since webservers don't typically perform deep request inspection, it's not possible toperform a similar check at that level.See also :setting:`FILE_UPLOAD_MAX_MEMORY_SIZE`... setting:: DATA_UPLOAD_MAX_NUMBER_FIELDS``DATA_UPLOAD_MAX_NUMBER_FIELDS``---------------------------------Default: ``1000``The maximum number of parameters that may be received via GET or POST before a:exc:`~django.core.exceptions.SuspiciousOperation` (``TooManyFields``) israised. You can set this to ``None`` to disable the check. Applications thatare expected to receive an unusually large number of form fields should tunethis setting.The number of request parameters is correlated to the amount of time needed toprocess the request and populate the GET and POST dictionaries. Large requestscould be used as a denial-of-service attack vector if left unchecked. Since webservers don't typically perform deep request inspection, it's not possible toperform a similar check at that level... setting:: DATA_UPLOAD_MAX_NUMBER_FILES``DATA_UPLOAD_MAX_NUMBER_FILES``--------------------------------.. versionadded:: 3.2.18Default: ``100``The maximum number of files that may be received via POST in a``multipart/form-data`` encoded request before a:exc:`~django.core.exceptions.SuspiciousOperation` (``TooManyFiles``) israised. You can set this to ``None`` to disable the check. Applications thatare expected to receive an unusually large number of file fields should tunethis setting.The number of accepted files is correlated to the amount of time and memoryneeded to process the request. Large requests could be used as adenial-of-service attack vector if left unchecked. Since web servers don'ttypically perform deep request inspection, it's not possible to perform asimilar check at that level... setting:: DATABASE_ROUTERS``DATABASE_ROUTERS``--------------------Default: ``[]`` (Empty list)The list of routers that will be used to determine which databaseto use when performing a database query.See the documentation on :ref:`automatic database routing in multidatabase configurations <topics-db-multi-db-routing>`... setting:: DATE_FORMAT``DATE_FORMAT``---------------Default: ``'N j, Y'`` (e.g. ``Feb. 4, 2003``)The default formatting to use for displaying date fields in any part of thesystem. Note that if :setting:`USE_L10N` is set to ``True``, then thelocale-dictated format has higher precedence and will be applied instead. See:tfilter:`allowed date format strings <date>`.See also :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATE_FORMAT`... setting:: DATE_INPUT_FORMATS``DATE_INPUT_FORMATS``----------------------Default::['%Y-%m-%d', # '2006-10-25''%m/%d/%Y', # '10/25/2006''%m/%d/%y', # '10/25/06''%b %d %Y', # 'Oct 25 2006''%b %d, %Y', # 'Oct 25, 2006''%d %b %Y', # '25 Oct 2006''%d %b, %Y', # '25 Oct, 2006''%B %d %Y', # 'October 25 2006''%B %d, %Y', # 'October 25, 2006''%d %B %Y', # '25 October 2006''%d %B, %Y', # '25 October, 2006']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 theseformat strings use Python's :ref:`datetime module syntax<strftime-strptime-behavior>`, not the format strings from the :tfilter:`date`template filter.When :setting:`USE_L10N` is ``True``, the locale-dictated format has higherprecedence and will be applied instead.See also :setting:`DATETIME_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`... setting:: DATETIME_FORMAT``DATETIME_FORMAT``-------------------Default: ``'N j, Y, P'`` (e.g. ``Feb. 4, 2003, 4 p.m.``)The default formatting to use for displaying datetime fields in any part of thesystem. Note that if :setting:`USE_L10N` is set to ``True``, then thelocale-dictated format has higher precedence and will be applied instead. See:tfilter:`allowed date format strings <date>`.See also :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`... setting:: DATETIME_INPUT_FORMATS``DATETIME_INPUT_FORMATS``--------------------------Default::['%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''%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 %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']A list of formats that will be accepted when inputting data on a datetimefield. Formats will be tried in order, using the first valid one. Note thatthese format strings use Python's :ref:`datetime module syntax<strftime-strptime-behavior>`, not the format strings from the :tfilter:`date`template filter. Date-only formats are not included as datetime fields willautomatically try :setting:`DATE_INPUT_FORMATS` in last resort.When :setting:`USE_L10N` is ``True``, the locale-dictated format has higherprecedence and will be applied instead.See also :setting:`DATE_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`... setting:: DEBUG``DEBUG``---------Default: ``False``A boolean that turns on/off debug mode.Never deploy a site into production with :setting:`DEBUG` turned on.One of the main features of debug mode is the display of detailed error pages.If your app raises an exception when :setting:`DEBUG` is ``True``, Django willdisplay a detailed traceback, including a lot of metadata about yourenvironment, such as all the currently defined Django settings (from``settings.py``).As a security measure, Django will *not* include settings that might besensitive, such as :setting:`SECRET_KEY`. Specifically, it will exclude anysetting whose name includes any of the following:* ``'API'``* ``'KEY'``* ``'PASS'``* ``'SECRET'``* ``'SIGNATURE'``* ``'TOKEN'``Note that these are *partial* matches. ``'PASS'`` will also match PASSWORD,just as ``'TOKEN'`` will also match TOKENIZED and so on.Still, note that there are always going to be sections of your debug outputthat are inappropriate for public consumption. File paths, configurationoptions and the like all give attackers extra information about your server.It is also important to remember that when running with :setting:`DEBUG`turned on, Django will remember every SQL query it executes. This is usefulwhen you're debugging, but it'll rapidly consume memory on a production server.Finally, if :setting:`DEBUG` is ``False``, you also need to properly setthe :setting:`ALLOWED_HOSTS` setting. Failing to do so will result in allrequests being returned as "Bad Request (400)"... note::The default :file:`settings.py` file created by :djadmin:`django-adminstartproject <startproject>` sets ``DEBUG = True`` for convenience... setting:: DEBUG_PROPAGATE_EXCEPTIONS``DEBUG_PROPAGATE_EXCEPTIONS``------------------------------Default: ``False``If set to ``True``, Django's exception handling of view functions(:data:`~django.conf.urls.handler500`, or the debug view if :setting:`DEBUG`is ``True``) and logging of 500 responses (:ref:`django-request-logger`) isskipped and exceptions propagate upward.This can be useful for some test setups. It shouldn't be used on a live siteunless you want your web server (instead of Django) to generate "InternalServer Error" responses. In that case, make sure your server doesn't show thestack trace or other sensitive information in the response... setting:: DECIMAL_SEPARATOR``DECIMAL_SEPARATOR``---------------------Default: ``'.'`` (Dot)Default decimal separator used when formatting decimal numbers.Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictatedformat has higher precedence and will be applied instead.See also :setting:`NUMBER_GROUPING`, :setting:`THOUSAND_SEPARATOR` and:setting:`USE_THOUSAND_SEPARATOR`... setting:: DEFAULT_AUTO_FIELD``DEFAULT_AUTO_FIELD``----------------------Default: ``'``:class:`django.db.models.AutoField`\ ``'``Default primary key field type to use for models that don't have a field with:attr:`primary_key=True <django.db.models.Field.primary_key>`... admonition:: Migrating auto-created through tablesThe value of ``DEFAULT_AUTO_FIELD`` will be respected when creating newauto-created through tables for many-to-many relationships.Unfortunately, the primary keys of existing auto-created through tablescannot currently be updated by the migrations framework.This means that if you switch the value of ``DEFAULT_AUTO_FIELD`` and thengenerate migrations, the primary keys of the related models will beupdated, as will the foreign keys from the through table, but the primarykey of the auto-created through table will not be migrated.In order to address this, you should add a:class:`~django.db.migrations.operations.RunSQL` operation to yourmigrations to perform the required ``ALTER TABLE`` step. You can check theexisting table name through ``sqlmigrate``, ``dbshell``, or with thefield’s ``remote_field.through._meta.db_table`` property.Explicitly defined through models are already handled by the migrationssystem.Allowing automatic migrations for the primary key of existing auto-createdthrough tables :ticket:`may be implemented at a later date <32674>`... setting:: DEFAULT_CHARSET``DEFAULT_CHARSET``-------------------Default: ``'utf-8'``Default charset to use for all ``HttpResponse`` objects, if a MIME type isn'tmanually specified. Used when constructing the ``Content-Type`` header... setting:: DEFAULT_EXCEPTION_REPORTER``DEFAULT_EXCEPTION_REPORTER``------------------------------Default: ``'``:class:`django.views.debug.ExceptionReporter`\ ``'``Default exception reporter class to be used if none has been assigned to the:class:`~django.http.HttpRequest` instance yet. See:ref:`custom-error-reports`... setting:: DEFAULT_EXCEPTION_REPORTER_FILTER``DEFAULT_EXCEPTION_REPORTER_FILTER``-------------------------------------Default: ``'``:class:`django.views.debug.SafeExceptionReporterFilter`\ ``'``Default exception reporter filter class to be used if none has been assigned tothe :class:`~django.http.HttpRequest` instance yet.See :ref:`Filtering error reports<filtering-error-reports>`... setting:: DEFAULT_FILE_STORAGE``DEFAULT_FILE_STORAGE``------------------------Default: ``'``:class:`django.core.files.storage.FileSystemStorage`\ ``'``Default file storage class to be used for any file-related operations that don'tspecify a particular storage system. See :doc:`/topics/files`... setting:: DEFAULT_FROM_EMAIL``DEFAULT_FROM_EMAIL``----------------------Default: ``'webmaster@localhost'``Default email address to use for various automated correspondence from thesite manager(s). This doesn't include error messages sent to :setting:`ADMINS`and :setting:`MANAGERS`; for that, see :setting:`SERVER_EMAIL`... setting:: DEFAULT_INDEX_TABLESPACE``DEFAULT_INDEX_TABLESPACE``----------------------------Default: ``''`` (Empty string)Default tablespace to use for indexes on fields that don't specifyone, if the backend supports it (see :doc:`/topics/db/tablespaces`)... setting:: DEFAULT_TABLESPACE``DEFAULT_TABLESPACE``----------------------Default: ``''`` (Empty string)Default tablespace to use for models that don't specify one, if thebackend supports it (see :doc:`/topics/db/tablespaces`)... setting:: DISALLOWED_USER_AGENTS``DISALLOWED_USER_AGENTS``--------------------------Default: ``[]`` (Empty list)List of compiled regular expression objects representing User-Agent stringsthat are not allowed to visit any page, systemwide. Use this for bots/crawlers.This is only used if ``CommonMiddleware`` is installed (see:doc:`/topics/http/middleware`)... setting:: EMAIL_BACKEND``EMAIL_BACKEND``-----------------Default: ``'``:class:`django.core.mail.backends.smtp.EmailBackend`\ ``'``The backend to use for sending emails. For the list of available backends see:doc:`/topics/email`... setting:: EMAIL_FILE_PATH``EMAIL_FILE_PATH``-------------------Default: Not definedThe directory used by the :ref:`file email backend <topic-email-file-backend>`to store output files... setting:: EMAIL_HOST``EMAIL_HOST``--------------Default: ``'localhost'``The host to use for sending email.See also :setting:`EMAIL_PORT`... setting:: EMAIL_HOST_PASSWORD``EMAIL_HOST_PASSWORD``-----------------------Default: ``''`` (Empty string)Password to use for the SMTP server defined in :setting:`EMAIL_HOST`. Thissetting is used in conjunction with :setting:`EMAIL_HOST_USER` whenauthenticating to the SMTP server. If either of these settings is empty,Django won't attempt authentication.See also :setting:`EMAIL_HOST_USER`... setting:: EMAIL_HOST_USER``EMAIL_HOST_USER``-------------------Default: ``''`` (Empty string)Username to use for the SMTP server defined in :setting:`EMAIL_HOST`.If empty, Django won't attempt authentication.See also :setting:`EMAIL_HOST_PASSWORD`... setting:: EMAIL_PORT``EMAIL_PORT``--------------Default: ``25``Port to use for the SMTP server defined in :setting:`EMAIL_HOST`... setting:: EMAIL_SUBJECT_PREFIX``EMAIL_SUBJECT_PREFIX``------------------------Default: ``'[Django] '``Subject-line prefix for email messages sent with ``django.core.mail.mail_admins``or ``django.core.mail.mail_managers``. You'll probably want to include thetrailing space... setting:: EMAIL_USE_LOCALTIME``EMAIL_USE_LOCALTIME``-----------------------Default: ``False``Whether to send the SMTP ``Date`` header of email messages in the local timezone (``True``) or in UTC (``False``)... setting:: EMAIL_USE_TLS``EMAIL_USE_TLS``-----------------Default: ``False``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 areexperiencing hanging connections, see the implicit TLS setting:setting:`EMAIL_USE_SSL`... setting:: EMAIL_USE_SSL``EMAIL_USE_SSL``-----------------Default: ``False``Whether to use an implicit TLS (secure) connection when talking to the SMTPserver. In most email documentation this type of TLS connection is referredto as SSL. It is generally used on port 465. If you are experiencing problems,see the explicit TLS setting :setting:`EMAIL_USE_TLS`.Note that :setting:`EMAIL_USE_TLS`/:setting:`EMAIL_USE_SSL` are mutuallyexclusive, so only set one of those settings to ``True``... setting:: EMAIL_SSL_CERTFILE``EMAIL_SSL_CERTFILE``----------------------Default: ``None``If :setting:`EMAIL_USE_SSL` or :setting:`EMAIL_USE_TLS` is ``True``, you canoptionally specify the path to a PEM-formatted certificate chain file to usefor the SSL connection... setting:: EMAIL_SSL_KEYFILE``EMAIL_SSL_KEYFILE``---------------------Default: ``None``If :setting:`EMAIL_USE_SSL` or :setting:`EMAIL_USE_TLS` is ``True``, you canoptionally specify the path to a PEM-formatted private key file to use for theSSL connection.Note that setting :setting:`EMAIL_SSL_CERTFILE` and :setting:`EMAIL_SSL_KEYFILE`doesn't result in any certificate checking. They're passed to the underlying SSLconnection. Please refer to the documentation of Python's:meth:`python:ssl.SSLContext.wrap_socket` function for details on how thecertificate chain file and private key file are handled... setting:: EMAIL_TIMEOUT``EMAIL_TIMEOUT``-----------------Default: ``None``Specifies a timeout in seconds for blocking operations like the connectionattempt... setting:: FILE_UPLOAD_HANDLERS``FILE_UPLOAD_HANDLERS``------------------------Default::['django.core.files.uploadhandler.MemoryFileUploadHandler','django.core.files.uploadhandler.TemporaryFileUploadHandler',]A list of handlers to use for uploading. Changing this setting allows completecustomization -- even replacement -- of Django's upload process.See :doc:`/topics/files` for details... setting:: FILE_UPLOAD_MAX_MEMORY_SIZE``FILE_UPLOAD_MAX_MEMORY_SIZE``-------------------------------Default: ``2621440`` (i.e. 2.5 MB).The maximum size (in bytes) that an upload will be before it gets streamed tothe file system. See :doc:`/topics/files` for details.See also :setting:`DATA_UPLOAD_MAX_MEMORY_SIZE`... setting:: FILE_UPLOAD_DIRECTORY_PERMISSIONS``FILE_UPLOAD_DIRECTORY_PERMISSIONS``-------------------------------------Default: ``None``The numeric mode to apply to directories created in the process of uploadingfiles.This setting also determines the default permissions for collected staticdirectories when using the :djadmin:`collectstatic` management command. See:djadmin:`collectstatic` for details on overriding it.This value mirrors the functionality and caveats of the:setting:`FILE_UPLOAD_PERMISSIONS` setting... setting:: FILE_UPLOAD_PERMISSIONS``FILE_UPLOAD_PERMISSIONS``---------------------------Default: ``0o644``The numeric mode (i.e. ``0o644``) to set newly uploaded files to. Formore information about what these modes mean, see the documentation for:func:`os.chmod`.If ``None``, you'll get operating-system dependent behavior. On most platforms,temporary files will have a mode of ``0o600``, and files saved from memory willbe saved using the system's standard umask.For security reasons, these permissions aren't applied to the temporary filesthat are stored in :setting:`FILE_UPLOAD_TEMP_DIR`.This setting also determines the default permissions for collected static fileswhen using the :djadmin:`collectstatic` management command. See:djadmin:`collectstatic` for details on overriding it... warning::**Always prefix the mode with** ``0o`` **.**If you're not familiar with file modes, please note that the ``0o`` prefixis very important: it indicates an octal number, which is the way thatmodes must be specified. If you try to use ``644``, you'll get totallyincorrect behavior... setting:: FILE_UPLOAD_TEMP_DIR``FILE_UPLOAD_TEMP_DIR``------------------------Default: ``None``The directory to store data to (typically files larger than:setting:`FILE_UPLOAD_MAX_MEMORY_SIZE`) temporarily while uploading files.If ``None``, Django will use the standard temporary directory for the operatingsystem. For example, this will default to ``/tmp`` on \*nix-style operatingsystems.See :doc:`/topics/files` for details... setting:: FIRST_DAY_OF_WEEK``FIRST_DAY_OF_WEEK``---------------------Default: ``0`` (Sunday)A number representing the first day of the week. This is especially usefulwhen displaying a calendar. This value is only used when not usingformat internationalization, or when a format cannot be found for thecurrent locale.The value must be an integer from 0 to 6, where 0 means Sunday, 1 meansMonday and so on... setting:: FIXTURE_DIRS``FIXTURE_DIRS``----------------Default: ``[]`` (Empty list)List of directories searched for fixture files, in addition to the``fixtures`` directory of each application, in search order.Note that these paths should use Unix-style forward slashes, even on Windows.See :ref:`initial-data-via-fixtures` and :ref:`topics-testing-fixtures`... setting:: FORCE_SCRIPT_NAME``FORCE_SCRIPT_NAME``---------------------Default: ``None``If not ``None``, this will be used as the value of the ``SCRIPT_NAME``environment variable in any HTTP request. This setting can be used to overridethe server-provided value of ``SCRIPT_NAME``, which may be a rewritten versionof the preferred value or not supplied at all. It is also used by:func:`django.setup()` to set the URL resolver script prefix outside of therequest/response cycle (e.g. in management commands and standalone scripts) togenerate correct URLs when ``SCRIPT_NAME`` is not ``/``... setting:: FORM_RENDERER``FORM_RENDERER``-----------------Default: ``'``:class:`django.forms.renderers.DjangoTemplates`\ ``'``The class that renders forms and form widgets. It must implement:ref:`the low-level render API <low-level-widget-render-api>`. Included formrenderers are:* ``'``:class:`django.forms.renderers.DjangoTemplates`\ ``'``* ``'``:class:`django.forms.renderers.Jinja2`\ ``'``* ``'``:class:`django.forms.renderers.TemplatesSetting`\ ``'``.. setting:: FORMAT_MODULE_PATH``FORMAT_MODULE_PATH``----------------------Default: ``None``A full Python path to a Python package that contains custom format definitionsfor project locales. If not ``None``, Django will check for a ``formats.py``file, under the directory named as the current locale, and will use theformats defined in this file.For example, if :setting:`FORMAT_MODULE_PATH` is set to ``mysite.formats``,and current language is ``en`` (English), Django will expect a directory treelike::mysite/formats/__init__.pyen/__init__.pyformats.pyYou can also set this setting to a list of Python paths, for example::FORMAT_MODULE_PATH = ['mysite.formats','some_app.formats',]When Django searches for a certain format, it will go through all given Pythonpaths until it finds a module that actually defines the given format. Thismeans that formats defined in packages farther up in the list will takeprecedence over the same formats in packages farther down.Available formats are:* :setting:`DATE_FORMAT`* :setting:`DATE_INPUT_FORMATS`* :setting:`DATETIME_FORMAT`,* :setting:`DATETIME_INPUT_FORMATS`* :setting:`DECIMAL_SEPARATOR`* :setting:`FIRST_DAY_OF_WEEK`* :setting:`MONTH_DAY_FORMAT`* :setting:`NUMBER_GROUPING`* :setting:`SHORT_DATE_FORMAT`* :setting:`SHORT_DATETIME_FORMAT`* :setting:`THOUSAND_SEPARATOR`* :setting:`TIME_FORMAT`* :setting:`TIME_INPUT_FORMATS`* :setting:`YEAR_MONTH_FORMAT`.. setting:: IGNORABLE_404_URLS``IGNORABLE_404_URLS``----------------------Default: ``[]`` (Empty list)List of compiled regular expression objects describing URLs that should beignored when reporting HTTP 404 errors via email (see:doc:`/howto/error-reporting`). Regular expressions are matched against:meth:`request's full paths <django.http.HttpRequest.get_full_path>` (includingquery string, if any). Use this if your site does not provide a commonlyrequested file such as ``favicon.ico`` or ``robots.txt``.This is only used if:class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled (see:doc:`/topics/http/middleware`)... setting:: INSTALLED_APPS``INSTALLED_APPS``------------------Default: ``[]`` (Empty list)A list of strings designating all applications that are enabled in thisDjango installation. Each string should be a dotted Python path to:* an application configuration class (preferred), or* a package containing an application.:doc:`Learn more about application configurations </ref/applications>`... admonition:: Use the application registry for introspectionYour code should never access :setting:`INSTALLED_APPS` directly. Use:attr:`django.apps.apps` instead... admonition:: Application names and labels must be unique in:setting:`INSTALLED_APPS`Application :attr:`names <django.apps.AppConfig.name>` — the dotted Pythonpath to the application package — must be unique. There is no way toinclude the same application twice, short of duplicating its code underanother name.Application :attr:`labels <django.apps.AppConfig.label>` — by default thefinal part of the name — must be unique too. For example, you can'tinclude both ``django.contrib.auth`` and ``myproject.auth``. However, youcan relabel an application with a custom configuration that defines adifferent :attr:`~django.apps.AppConfig.label`.These rules apply regardless of whether :setting:`INSTALLED_APPS`references application configuration classes or application packages.When several applications provide different versions of the same resource(template, static file, management command, translation), the applicationlisted first in :setting:`INSTALLED_APPS` has precedence... setting:: INTERNAL_IPS``INTERNAL_IPS``----------------Default: ``[]`` (Empty list)A list of IP addresses, as strings, that:* Allow the :func:`~django.template.context_processors.debug` context processorto add some variables to the template context.* Can use the :ref:`admindocs bookmarklets <admindocs-bookmarklets>` even ifnot logged in as a staff user.* Are marked as "internal" (as opposed to "EXTERNAL") in:class:`~django.utils.log.AdminEmailHandler` emails... setting:: LANGUAGE_CODE``LANGUAGE_CODE``-----------------Default: ``'en-us'``A string representing the language code for this installation. This should be instandard :term:`language ID format <language code>`. For example, U.S. Englishis ``"en-us"``. See also the `list of language identifiers`_ and:doc:`/topics/i18n/index`.:setting:`USE_I18N` must be active for this setting to have any effect.It serves two purposes:* If the locale middleware isn't in use, it decides which translation is servedto all users.* If the locale middleware is active, it provides a fallback language in case theuser's preferred language can't be determined or is not supported by thewebsite. It also provides the fallback translation when a translation for agiven literal doesn't exist for the user's preferred language.See :ref:`how-django-discovers-language-preference` for more details... _list of language identifiers: http://www.i18nguy.com/unicode/language-identifiers.html.. setting:: LANGUAGE_COOKIE_AGE``LANGUAGE_COOKIE_AGE``-----------------------Default: ``None`` (expires at browser close)The age of the language cookie, in seconds... setting:: LANGUAGE_COOKIE_DOMAIN``LANGUAGE_COOKIE_DOMAIN``--------------------------Default: ``None``The domain to use for the language cookie. Set this to a string such as``"example.com"`` for cross-domain cookies, or use ``None`` for a standarddomain cookie.Be cautious when updating this setting on a production site. If you updatethis setting to enable cross-domain cookies on a site that previously usedstandard domain cookies, existing user cookies that have the old domainwill not be updated. This will result in site users being unable to switchthe language as long as these cookies persist. The only safe and reliableoption to perform the switch is to change the language cookie namepermanently (via the :setting:`LANGUAGE_COOKIE_NAME` setting) and to adda middleware that copies the value from the old cookie to a new one and thendeletes the old one... setting:: LANGUAGE_COOKIE_HTTPONLY``LANGUAGE_COOKIE_HTTPONLY``----------------------------Default: ``False``Whether to use ``HttpOnly`` flag on the language cookie. If this is set to``True``, client-side JavaScript will not be able to access the languagecookie.See :setting:`SESSION_COOKIE_HTTPONLY` for details on ``HttpOnly``... setting:: LANGUAGE_COOKIE_NAME``LANGUAGE_COOKIE_NAME``------------------------Default: ``'django_language'``The name of the cookie to use for the language cookie. This can be whateveryou want (as long as it's different from the other cookie names in yourapplication). See :doc:`/topics/i18n/index`... setting:: LANGUAGE_COOKIE_PATH``LANGUAGE_COOKIE_PATH``------------------------Default: ``'/'``The path set on the language cookie. This should either match the URL path of yourDjango installation or be a parent of that path.This is useful if you have multiple Django instances running under the samehostname. They can use different cookie paths and each instance will only seeits own language cookie.Be cautious when updating this setting on a production site. If you update thissetting to use a deeper path than it previously used, existing user cookies thathave the old path will not be updated. This will result in site users beingunable to switch the language as long as these cookies persist. The only safeand reliable option to perform the switch is to change the language cookie namepermanently (via the :setting:`LANGUAGE_COOKIE_NAME` setting), and to adda middleware that copies the value from the old cookie to a new one and thendeletes the one... setting:: LANGUAGE_COOKIE_SAMESITE``LANGUAGE_COOKIE_SAMESITE``----------------------------Default: ``None``The value of the `SameSite`_ flag on the language cookie. This flag prevents thecookie from being sent in cross-site requests.See :setting:`SESSION_COOKIE_SAMESITE` for details about ``SameSite``... setting:: LANGUAGE_COOKIE_SECURE``LANGUAGE_COOKIE_SECURE``--------------------------Default: ``False``Whether to use a secure cookie for the language cookie. If this is set to``True``, the cookie will be marked as "secure", which means browsers mayensure that the cookie is only sent under an HTTPS connection... setting:: LANGUAGES``LANGUAGES``-------------Default: A list of all available languages. This list is continually growingand including a copy here would inevitably become rapidly out of date. You cansee the current list of translated languages by looking in:source:`django/conf/global_settings.py`.The list is a list of two-tuples in the format(:term:`language code<language code>`, ``language name``) -- for example,``('ja', 'Japanese')``.This specifies which languages are available for language selection. See:doc:`/topics/i18n/index`.Generally, the default value should suffice. Only set this setting if you wantto restrict language selection to a subset of the Django-provided languages.If you define a custom :setting:`LANGUAGES` setting, you can mark thelanguage names as translation strings using the:func:`~django.utils.translation.gettext_lazy` function.Here's a sample settings file::from django.utils.translation import gettext_lazy as _LANGUAGES = [('de', _('German')),('en', _('English')),].. setting:: LANGUAGES_BIDI``LANGUAGES_BIDI``------------------Default: A list of all language codes that are written right-to-left. You cansee the current list of these languages by looking in:source:`django/conf/global_settings.py`.The list contains :term:`language codes<language code>` for languages that arewritten right-to-left.Generally, the default value should suffice. Only set this setting if you wantto restrict language selection to a subset of the Django-provided languages.If you define a custom :setting:`LANGUAGES` setting, the list of bidirectionallanguages may contain language codes which are not enabled on a given site... setting:: LOCALE_PATHS``LOCALE_PATHS``----------------Default: ``[]`` (Empty list)A list of directories where Django looks for translation files.See :ref:`how-django-discovers-translations`.Example::LOCALE_PATHS = ['/home/www/project/common_files/locale','/var/local/translations/locale',]Django will look within each of these paths for the ``<locale_code>/LC_MESSAGES``directories containing the actual translation files... setting:: LOGGING``LOGGING``-----------Default: A logging configuration dictionary.A data structure containing configuration information. When not-empty, thecontents of this data structure will be passed as the argument to theconfiguration method described in :setting:`LOGGING_CONFIG`.Among other things, the default logging configuration passes HTTP 500 servererrors to an email log handler when :setting:`DEBUG` is ``False``. See also:ref:`configuring-logging`.You can see the default logging configuration by looking in:source:`django/utils/log.py`... setting:: LOGGING_CONFIG``LOGGING_CONFIG``------------------Default: ``'logging.config.dictConfig'``A path to a callable that will be used to configure logging in theDjango project. Points at an instance of Python's :ref:`dictConfig<logging-config-dictschema>` configuration method by default.If you set :setting:`LOGGING_CONFIG` to ``None``, the loggingconfiguration process will be skipped... setting:: MANAGERS``MANAGERS``------------Default: ``[]`` (Empty list)A list in the same format as :setting:`ADMINS` that specifies who should getbroken link notifications when:class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled... setting:: MEDIA_ROOT``MEDIA_ROOT``--------------Default: ``''`` (Empty string)Absolute filesystem path to the directory that will hold :doc:`user-uploadedfiles </topics/files>`.Example: ``"/var/www/example.com/media/"``See also :setting:`MEDIA_URL`... warning:::setting:`MEDIA_ROOT` and :setting:`STATIC_ROOT` must have differentvalues. Before :setting:`STATIC_ROOT` was introduced, it was common torely or fallback on :setting:`MEDIA_ROOT` to also serve static files;however, since this can have serious security implications, there is avalidation check to prevent it... setting:: MEDIA_URL``MEDIA_URL``-------------Default: ``''`` (Empty string)URL that handles the media served from :setting:`MEDIA_ROOT`, usedfor :doc:`managing stored files </topics/files>`. It must end in a slash if setto a non-empty value. You will need to :ref:`configure these files to be served<serving-uploaded-files-in-development>` in both development and productionenvironments.If you want to use ``{{ MEDIA_URL }}`` in your templates, add``'django.template.context_processors.media'`` in the ``'context_processors'``option of :setting:`TEMPLATES`.Example: ``"http://media.example.com/"``.. warning::There are security risks if you are accepting uploaded content fromuntrusted users! See the security guide's topic on:ref:`user-uploaded-content-security` for mitigation details... warning:::setting:`MEDIA_URL` and :setting:`STATIC_URL` must have differentvalues. See :setting:`MEDIA_ROOT` for more details... note::If :setting:`MEDIA_URL` is a relative path, then it will be prefixed by theserver-provided value of ``SCRIPT_NAME`` (or ``/`` if not set). This makesit easier to serve a Django application in a subpath without adding anextra configuration to the settings... setting:: MIDDLEWARE``MIDDLEWARE``--------------Default: ``None``A list of middleware to use. See :doc:`/topics/http/middleware`... setting:: MIGRATION_MODULES``MIGRATION_MODULES``---------------------Default: ``{}`` (Empty dictionary)A dictionary specifying the package where migration modules can be found on aper-app basis. The default value of this setting is an empty dictionary, butthe default package name for migration modules is ``migrations``.Example::{'blog': 'blog.db_migrations'}In this case, migrations pertaining to the ``blog`` app will be contained inthe ``blog.db_migrations`` package.If you provide the ``app_label`` argument, :djadmin:`makemigrations` willautomatically create the package if it doesn't already exist.When you supply ``None`` as a value for an app, Django will consider the app asan app without migrations regardless of an existing ``migrations`` submodule.This can be used, for example, in a test settings file to skip migrations whiletesting (tables will still be created for the apps' models). To disablemigrations for all apps during tests, you can set the:setting:`MIGRATE <TEST_MIGRATE>` to ``False`` instead. If``MIGRATION_MODULES`` is used in your general project settings, remember to usethe :option:`migrate --run-syncdb` option if you want to create tables for theapp... setting:: MONTH_DAY_FORMAT``MONTH_DAY_FORMAT``--------------------Default: ``'F j'``The default formatting to use for date fields on Django admin change-listpages -- and, possibly, by other parts of the system -- in cases when only themonth and day are displayed.For example, when a Django admin change-list page is being filtered by a datedrilldown, the header for a given day displays the day and month. Differentlocales have different formats. For example, U.S. English would say"January 1," whereas Spanish might say "1 Enero."Note that if :setting:`USE_L10N` is set to ``True``, then the correspondinglocale-dictated format has higher precedence and will be applied.See :tfilter:`allowed date format strings <date>`. See also:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`,:setting:`TIME_FORMAT` and :setting:`YEAR_MONTH_FORMAT`... setting:: NUMBER_GROUPING``NUMBER_GROUPING``-------------------Default: ``0``Number of digits grouped together on the integer part of a number.Common use is to display a thousand separator. If this setting is ``0``, thenno grouping will be applied to the number. If this setting is greater than``0``, then :setting:`THOUSAND_SEPARATOR` will be used as the separator betweenthose groups.Some locales use non-uniform digit grouping, e.g. ``10,00,00,000`` in``en_IN``. For this case, you can provide a sequence with the number of digitgroup sizes to be applied. The first number defines the size of the grouppreceding the decimal delimiter, and each number that follows defines the sizeof preceding groups. If the sequence is terminated with ``-1``, no furthergrouping is performed. If the sequence terminates with a ``0``, the last groupsize is used for the remainder of the number.Example tuple for ``en_IN``::NUMBER_GROUPING = (3, 2, 0)Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictatedformat has higher precedence and will be applied instead.See also :setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and:setting:`USE_THOUSAND_SEPARATOR`... setting:: PREPEND_WWW``PREPEND_WWW``---------------Default: ``False``Whether to prepend the "www." subdomain to URLs that don't have it. This is onlyused if :class:`~django.middleware.common.CommonMiddleware` is installed(see :doc:`/topics/http/middleware`). See also :setting:`APPEND_SLASH`... setting:: ROOT_URLCONF``ROOT_URLCONF``----------------Default: Not definedA string representing the full Python import path to your root URLconf, forexample ``"mydjangoapps.urls"``. Can be overridden on a per-request basis bysetting the attribute ``urlconf`` on the incoming ``HttpRequest``object. See :ref:`how-django-processes-a-request` for details... setting:: SECRET_KEY``SECRET_KEY``--------------Default: ``''`` (Empty string)A secret key for a particular Django installation. This is used to provide:doc:`cryptographic signing </topics/signing>`, and should be set to a unique,unpredictable value.:djadmin:`django-admin startproject <startproject>` automatically adds arandomly-generated ``SECRET_KEY`` to each new project.Uses of the key shouldn't assume that it's text or bytes. Every use should gothrough :func:`~django.utils.encoding.force_str` or:func:`~django.utils.encoding.force_bytes` to convert it to the desired type.Django will refuse to start if :setting:`SECRET_KEY` is not set... warning::**Keep this value secret.**Running Django with a known :setting:`SECRET_KEY` defeats many of Django'ssecurity protections, and can lead to privilege escalation and remote codeexecution vulnerabilities.The secret key is used for:* All :doc:`sessions </topics/http/sessions>` if you are usingany other session backend than ``django.contrib.sessions.backends.cache``,or are using the default:meth:`~django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash()`.* All :doc:`messages </ref/contrib/messages>` if you are using:class:`~django.contrib.messages.storage.cookie.CookieStorage` or:class:`~django.contrib.messages.storage.fallback.FallbackStorage`.* All :class:`~django.contrib.auth.views.PasswordResetView` tokens.* Any usage of :doc:`cryptographic signing </topics/signing>`, unless adifferent key is provided.When a secret key is no longer set as :setting:`SECRET_KEY` or contained within:setting:`SECRET_KEY_FALLBACKS` all of the above will be invalidated. Whenrotating your secret key, you should move the old key to:setting:`SECRET_KEY_FALLBACKS` temporarily. Secret keys are not used forpasswords of users and key rotation will not affect them... note::The default :file:`settings.py` file created by :djadmin:`django-adminstartproject <startproject>` creates a unique ``SECRET_KEY`` forconvenience... setting:: SECRET_KEY_FALLBACKS``SECRET_KEY_FALLBACKS``------------------------.. versionadded:: 4.1Default: ``[]``A list of fallback secret keys for a particular Django installation. These areused to allow rotation of the ``SECRET_KEY``.In order to rotate your secret keys, set a new ``SECRET_KEY`` and move theprevious value to the beginning of ``SECRET_KEY_FALLBACKS``. Then remove theold values from the end of the ``SECRET_KEY_FALLBACKS`` when you are ready toexpire the sessions, password reset tokens, and so on, that make use of them... note::Signing operations are computationally expensive. Having multiple old keyvalues in ``SECRET_KEY_FALLBACKS`` adds additional overhead to all checksthat don't match an earlier key.As such, fallback values should be removed after an appropriate period,allowing for key rotation.Uses of the secret key values shouldn't assume that they are text or bytes.Every use should go through :func:`~django.utils.encoding.force_str` or:func:`~django.utils.encoding.force_bytes` to convert it to the desired type... setting:: SECURE_CONTENT_TYPE_NOSNIFF``SECURE_CONTENT_TYPE_NOSNIFF``-------------------------------Default: ``True``If ``True``, the :class:`~django.middleware.security.SecurityMiddleware`sets the :ref:`x-content-type-options` header on all responses that do notalready have it... setting:: SECURE_CROSS_ORIGIN_OPENER_POLICY``SECURE_CROSS_ORIGIN_OPENER_POLICY``-------------------------------------.. versionadded:: 4.0Default: ``'same-origin'``Unless set to ``None``, the:class:`~django.middleware.security.SecurityMiddleware` sets the:ref:`cross-origin-opener-policy` header on all responses that do not alreadyhave it to the value provided... setting:: SECURE_HSTS_INCLUDE_SUBDOMAINS``SECURE_HSTS_INCLUDE_SUBDOMAINS``----------------------------------Default: ``False``If ``True``, the :class:`~django.middleware.security.SecurityMiddleware` addsthe ``includeSubDomains`` directive to the :ref:`http-strict-transport-security`header. It has no effect unless :setting:`SECURE_HSTS_SECONDS` is set to anon-zero value... warning::Setting this incorrectly can irreversibly (for the value of:setting:`SECURE_HSTS_SECONDS`) break your site. Read the:ref:`http-strict-transport-security` documentation first... setting:: SECURE_HSTS_PRELOAD``SECURE_HSTS_PRELOAD``-----------------------Default: ``False``If ``True``, the :class:`~django.middleware.security.SecurityMiddleware` addsthe ``preload`` directive to the :ref:`http-strict-transport-security`header. It has no effect unless :setting:`SECURE_HSTS_SECONDS` is set to anon-zero value... setting:: SECURE_HSTS_SECONDS``SECURE_HSTS_SECONDS``-----------------------Default: ``0``If set to a non-zero integer value, the:class:`~django.middleware.security.SecurityMiddleware` sets the:ref:`http-strict-transport-security` header on all responses that do notalready have it... warning::Setting this incorrectly can irreversibly (for some time) break your site.Read the :ref:`http-strict-transport-security` documentation first... setting:: SECURE_PROXY_SSL_HEADER``SECURE_PROXY_SSL_HEADER``---------------------------Default: ``None``A tuple representing an HTTP header/value combination that signifies a requestis secure. This controls the behavior of the request object's ``is_secure()``method.By default, ``is_secure()`` determines if a request is secure by confirmingthat a requested URL uses ``https://``. This method is important for Django'sCSRF 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-HTTPSconnection between the proxy and Django then ``is_secure()`` would alwaysreturn ``False`` -- 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``is_secure()`` would always return ``True`` -- even for requests that weremade originally via HTTP.In this situation, configure your proxy to set a custom HTTP header that tellsDjango whether the request came in via HTTPS, and set``SECURE_PROXY_SSL_HEADER`` so that Django knows what header to look for.Set a tuple with two elements -- the name of the header to look for and therequired value. For example::SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')This tells Django to trust the ``X-Forwarded-Proto`` header that comes from ourproxy and that the request is guaranteed to be secure (i.e., it originally camein via HTTPS) when:* the header value is ``'https'``, or* its initial, leftmost value is ``'https'`` in the case of a comma-separatedlist of protocols (e.g. ``'https,http,http'``)... versionchanged:: 4.1Support for a comma-separated list of protocols in the header value wasadded.You should *only* set this setting if you control your proxy or have some otherguarantee that it sets/strips this header appropriately.Note that the header needs to be in the format as used by ``request.META`` --all caps and likely starting with ``HTTP_``. (Remember, Django automaticallyadds ``'HTTP_'`` to the start of x-header names before making the headeravailable in ``request.META``.).. warning::**Modifying this setting can compromise your site's security. Ensure youfully understand your setup before changing it.**Make sure ALL of the following are true before setting this (assuming thevalues from the example above):* Your Django app is behind a proxy.* Your proxy strips the ``X-Forwarded-Proto`` header from all incomingrequests, even when it contains a comma-separated list of protocols. Inother words, if end users include that header in their requests, theproxy will discard it.* Your proxy sets the ``X-Forwarded-Proto`` header and sends it to Django,but only for requests that originally come in via HTTPS.If any of those are not true, you should keep this setting set to ``None``and find another way of determining HTTPS, perhaps via custom middleware... setting:: SECURE_REDIRECT_EXEMPT``SECURE_REDIRECT_EXEMPT``--------------------------Default: ``[]`` (Empty list)If a URL path matches a regular expression in this list, the request will not beredirected to HTTPS. The:class:`~django.middleware.security.SecurityMiddleware` strips leading slashesfrom URL paths, so patterns shouldn't include them, e.g.``SECURE_REDIRECT_EXEMPT = [r'^no-ssl/$', …]``. If:setting:`SECURE_SSL_REDIRECT` is ``False``, this setting has no effect... setting:: SECURE_REFERRER_POLICY``SECURE_REFERRER_POLICY``--------------------------Default: ``'same-origin'``If configured, the :class:`~django.middleware.security.SecurityMiddleware` setsthe :ref:`referrer-policy` header on all responses that do not already have itto the value provided... setting:: SECURE_SSL_HOST``SECURE_SSL_HOST``-------------------Default: ``None``If a string (e.g. ``secure.example.com``), all SSL redirects will be directedto this host rather than the originally-requested host(e.g. ``www.example.com``). If :setting:`SECURE_SSL_REDIRECT` is ``False``, thissetting has no effect... setting:: SECURE_SSL_REDIRECT``SECURE_SSL_REDIRECT``-----------------------Default: ``False``If ``True``, the :class:`~django.middleware.security.SecurityMiddleware`:ref:`redirects <ssl-redirect>` all non-HTTPS requests to HTTPS (except forthose URLs matching a regular expression listed in:setting:`SECURE_REDIRECT_EXEMPT`)... note::If turning this to ``True`` causes infinite redirects, it probably meansyour site is running behind a proxy and can't tell which requests are secureand which are not. Your proxy likely sets a header to indicate securerequests; you can correct the problem by finding out what that header is andconfiguring the :setting:`SECURE_PROXY_SSL_HEADER` setting accordingly... setting:: SERIALIZATION_MODULES``SERIALIZATION_MODULES``-------------------------Default: Not definedA dictionary of modules containing serializer definitions (provided asstrings), keyed by a string identifier for that serialization type. Forexample, to define a YAML serializer, use::SERIALIZATION_MODULES = {'yaml': 'path.to.yaml_serializer'}.. setting:: SERVER_EMAIL``SERVER_EMAIL``----------------Default: ``'root@localhost'``The email address that error messages come from, such as those sent to:setting:`ADMINS` and :setting:`MANAGERS`... admonition:: Why are my emails sent from a different address?This address is used only for error messages. It is *not* the address thatregular email messages sent with :meth:`~django.core.mail.send_mail()`come from; for that, see :setting:`DEFAULT_FROM_EMAIL`... setting:: SHORT_DATE_FORMAT``SHORT_DATE_FORMAT``---------------------Default: ``'m/d/Y'`` (e.g. ``12/31/2003``)An available formatting that can be used for displaying date fields ontemplates. Note that if :setting:`USE_L10N` is set to ``True``, then thecorresponding locale-dictated format has higher precedence and will be applied.See :tfilter:`allowed date format strings <date>`.See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`... setting:: SHORT_DATETIME_FORMAT``SHORT_DATETIME_FORMAT``-------------------------Default: ``'m/d/Y P'`` (e.g. ``12/31/2003 4 p.m.``)An available formatting that can be used for displaying datetime fields ontemplates. Note that if :setting:`USE_L10N` is set to ``True``, then thecorresponding locale-dictated format has higher precedence and will be applied.See :tfilter:`allowed date format strings <date>`.See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATE_FORMAT`... setting:: SIGNING_BACKEND``SIGNING_BACKEND``-------------------Default: ``'django.core.signing.TimestampSigner'``The backend used for signing cookies and other data.See also the :doc:`/topics/signing` documentation... setting:: SILENCED_SYSTEM_CHECKS``SILENCED_SYSTEM_CHECKS``--------------------------Default: ``[]`` (Empty list)A list of identifiers of messages generated by the system check framework(i.e. ``["models.W001"]``) that you wish to permanently acknowledge and ignore.Silenced checks will not be output to the console.See also the :doc:`/ref/checks` documentation... setting:: TEMPLATES``TEMPLATES``-------------Default: ``[]`` (Empty list)A list containing the settings for all template engines to be used withDjango. Each item of the list is a dictionary containing the options for anindividual engine.Here's a setup that tells the Django template engine to load templates from the``templates`` subdirectory inside each installed application::TEMPLATES = [{'BACKEND': 'django.template.backends.django.DjangoTemplates','APP_DIRS': True,},]The following options are available for all backends... setting:: TEMPLATES-BACKEND``BACKEND``~~~~~~~~~~~Default: Not definedThe template backend to use. The built-in template backends are:* ``'django.template.backends.django.DjangoTemplates'``* ``'django.template.backends.jinja2.Jinja2'``You can use a template backend that doesn't ship with Django by setting``BACKEND`` to a fully-qualified path (i.e. ``'mypackage.whatever.Backend'``)... setting:: TEMPLATES-NAME``NAME``~~~~~~~~Default: see belowThe alias for this particular template engine. It's an identifier that allowsselecting an engine for rendering. Aliases must be unique across allconfigured template engines.It defaults to the name of the module defining the engine class, i.e. thenext to last piece of :setting:`BACKEND <TEMPLATES-BACKEND>`, when it isn'tprovided. For example if the backend is ``'mypackage.whatever.Backend'`` thenits default name is ``'whatever'``... setting:: TEMPLATES-DIRS``DIRS``~~~~~~~~Default: ``[]`` (Empty list)Directories where the engine should look for template source files, in searchorder... setting:: TEMPLATES-APP_DIRS``APP_DIRS``~~~~~~~~~~~~Default: ``False``Whether the engine should look for template source files inside installedapplications... note::The default :file:`settings.py` file created by :djadmin:`django-adminstartproject <startproject>` sets ``'APP_DIRS': True``... setting:: TEMPLATES-OPTIONS``OPTIONS``~~~~~~~~~~~Default: ``{}`` (Empty dict)Extra parameters to pass to the template backend. Available parameters varydepending on the template backend. See:class:`~django.template.backends.django.DjangoTemplates` and:class:`~django.template.backends.jinja2.Jinja2` for the options of thebuilt-in backends... setting:: TEST_RUNNER``TEST_RUNNER``---------------Default: ``'django.test.runner.DiscoverRunner'``The name of the class to use for starting the test suite. See:ref:`other-testing-frameworks`... setting:: TEST_NON_SERIALIZED_APPS``TEST_NON_SERIALIZED_APPS``----------------------------Default: ``[]`` (Empty list)In order to restore the database state between tests for``TransactionTestCase``\s and database backends without transactions, Djangowill :ref:`serialize the contents of all apps <test-case-serialized-rollback>`when it starts the test run so it can then reload from that copy before runningtests that need it.This slows down the startup time of the test runner; if you have apps thatyou know don't need this feature, you can add their full names in here (e.g.``'django.contrib.contenttypes'``) to exclude them from this serializationprocess... setting:: THOUSAND_SEPARATOR``THOUSAND_SEPARATOR``----------------------Default: ``','`` (Comma)Default thousand separator used when formatting numbers. This setting isused only when :setting:`USE_THOUSAND_SEPARATOR` is ``True`` and:setting:`NUMBER_GROUPING` is greater than ``0``.Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictatedformat has higher precedence and will be applied instead.See also :setting:`NUMBER_GROUPING`, :setting:`DECIMAL_SEPARATOR` and:setting:`USE_THOUSAND_SEPARATOR`... setting:: TIME_FORMAT``TIME_FORMAT``---------------Default: ``'P'`` (e.g. ``4 p.m.``)The default formatting to use for displaying time fields in any part of thesystem. Note that if :setting:`USE_L10N` is set to ``True``, then thelocale-dictated format has higher precedence and will be applied instead. See:tfilter:`allowed date format strings <date>`.See also :setting:`DATE_FORMAT` and :setting:`DATETIME_FORMAT`... setting:: TIME_INPUT_FORMATS``TIME_INPUT_FORMATS``----------------------Default::['%H:%M:%S', # '14:30:59''%H:%M:%S.%f', # '14:30:59.000200''%H:%M', # '14:30']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 theseformat strings use Python's :ref:`datetime module syntax<strftime-strptime-behavior>`, not the format strings from the :tfilter:`date`template filter.When :setting:`USE_L10N` is ``True``, the locale-dictated format has higherprecedence and will be applied instead.See also :setting:`DATE_INPUT_FORMATS` and :setting:`DATETIME_INPUT_FORMATS`... setting:: TIME_ZONE``TIME_ZONE``-------------Default: ``'America/Chicago'``A string representing the time zone for this installation. See the `list oftime zones`_... note::Since Django was first released with the :setting:`TIME_ZONE` set to``'America/Chicago'``, the global setting (used if nothing is defined inyour project's ``settings.py``) remains ``'America/Chicago'`` for backwardscompatibility. New project templates default to ``'UTC'``.Note that this isn't necessarily the time zone of the server. For example, oneserver may serve multiple Django-powered sites, each with a separate time zonesetting.When :setting:`USE_TZ` is ``False``, this is the time zone in which Djangowill store all datetimes. When :setting:`USE_TZ` is ``True``, this is thedefault time zone that Django will use to display datetimes in templates andto interpret datetimes entered in forms.On Unix environments (where :func:`time.tzset` is implemented), Django sets the``os.environ['TZ']`` variable to the time zone you specify in the:setting:`TIME_ZONE` setting. Thus, all your views and models willautomatically operate in this time zone. However, Django won't set the ``TZ``environment variable if you're using the manual configuration option asdescribed in :ref:`manually configuring settings<settings-without-django-settings-module>`. If Django doesn't set the ``TZ``environment variable, it's up to you to ensure your processes are running inthe correct environment... note::Django cannot reliably use alternate time zones in a Windows environment.If you're running Django on Windows, :setting:`TIME_ZONE` must be set tomatch the system time zone... _list of time zones: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.. setting:: USE_DEPRECATED_PYTZ``USE_DEPRECATED_PYTZ``-----------------------.. versionadded:: 4.0Default: ``False``A boolean that specifies whether to use ``pytz``, rather than :mod:`zoneinfo`,as the default time zone implementation... deprecated:: 4.0This transitional setting is deprecated. Support for using ``pytz`` will beremoved in Django 5.0... setting:: USE_I18N``USE_I18N``------------Default: ``True``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``False``, Django will make some optimizations so as not to load thetranslation machinery.See also :setting:`LANGUAGE_CODE`, :setting:`USE_L10N` and :setting:`USE_TZ`... note::The default :file:`settings.py` file created by :djadmin:`django-adminstartproject <startproject>` includes ``USE_I18N = True`` for convenience... setting:: USE_L10N``USE_L10N``------------Default: ``True``A boolean that specifies if localized formatting of data will be enabled bydefault or not. If this is set to ``True``, e.g. Django will display numbers anddates using the format of the current locale.See also :setting:`LANGUAGE_CODE`, :setting:`USE_I18N` and :setting:`USE_TZ`... versionchanged:: 4.0In older versions, the default value is ``False``... deprecated:: 4.0This setting is deprecated. Starting with Django 5.0, localized formattingof data will always be enabled. For example Django will display numbers anddates using the format of the current locale... setting:: USE_THOUSAND_SEPARATOR``USE_THOUSAND_SEPARATOR``--------------------------Default: ``False``A boolean that specifies whether to display numbers using a thousand separator.When set to ``True`` and :setting:`USE_L10N` is also ``True``, Django willformat numbers using the :setting:`NUMBER_GROUPING` and:setting:`THOUSAND_SEPARATOR` settings. The latter two settings may also bedictated by the locale, which takes precedence.See also :setting:`DECIMAL_SEPARATOR`, :setting:`NUMBER_GROUPING` and:setting:`THOUSAND_SEPARATOR`... setting:: USE_TZ``USE_TZ``----------Default: ``False``.. note::In Django 5.0, the default value will change from ``False`` to ``True``.A boolean that specifies if datetimes will be timezone-aware by default or not.If this is set to ``True``, Django will use timezone-aware datetimes internally.When ``USE_TZ`` is False, Django will use naive datetimes in local time, exceptwhen parsing ISO 8601 formatted strings, where timezone information will alwaysbe retained if present.See also :setting:`TIME_ZONE`, :setting:`USE_I18N` and :setting:`USE_L10N`... note::The default :file:`settings.py` file created by:djadmin:`django-admin startproject <startproject>` includes``USE_TZ = True`` for convenience... setting:: USE_X_FORWARDED_HOST``USE_X_FORWARDED_HOST``------------------------Default: ``False``A boolean that specifies whether to use the ``X-Forwarded-Host`` header inpreference to the ``Host`` header. This should only be enabled if a proxywhich sets this header is in use.This setting takes priority over :setting:`USE_X_FORWARDED_PORT`. Per:rfc:`7239#section-5.3`, the ``X-Forwarded-Host`` header can include the portnumber, in which case you shouldn't use :setting:`USE_X_FORWARDED_PORT`... setting:: USE_X_FORWARDED_PORT``USE_X_FORWARDED_PORT``------------------------Default: ``False``A boolean that specifies whether to use the ``X-Forwarded-Port`` header inpreference to the ``SERVER_PORT`` ``META`` variable. This should only beenabled if a proxy which sets this header is in use.:setting:`USE_X_FORWARDED_HOST` takes priority over this setting... setting:: WSGI_APPLICATION``WSGI_APPLICATION``--------------------Default: ``None``The full Python path of the WSGI application object that Django's built-inservers (e.g. :djadmin:`runserver`) will use. The :djadmin:`django-adminstartproject <startproject>` management command will create a standard``wsgi.py`` file with an ``application`` callable in it, and point this settingto that ``application``.If not set, the return value of ``django.core.wsgi.get_wsgi_application()``will be used. In this case, the behavior of :djadmin:`runserver` will beidentical to previous Django versions... setting:: YEAR_MONTH_FORMAT``YEAR_MONTH_FORMAT``---------------------Default: ``'F Y'``The default formatting to use for date fields on Django admin change-listpages -- and, possibly, by other parts of the system -- in cases when only theyear and month are displayed.For example, when a Django admin change-list page is being filtered by a datedrilldown, 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 :setting:`USE_L10N` is set to ``True``, then the correspondinglocale-dictated format has higher precedence and will be applied.See :tfilter:`allowed date format strings <date>`. See also:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT`and :setting:`MONTH_DAY_FORMAT`... setting:: X_FRAME_OPTIONS``X_FRAME_OPTIONS``-------------------Default: ``'DENY'``The default value for the X-Frame-Options header used by:class:`~django.middleware.clickjacking.XFrameOptionsMiddleware`. See the:doc:`clickjacking protection </ref/clickjacking/>` documentation.Auth====Settings for :mod:`django.contrib.auth`... setting:: AUTHENTICATION_BACKENDS``AUTHENTICATION_BACKENDS``---------------------------Default: ``['django.contrib.auth.backends.ModelBackend']``A list of authentication backend classes (as strings) to use when attempting toauthenticate a user. See the :ref:`authentication backends documentation<authentication-backends>` for details... setting:: AUTH_USER_MODEL``AUTH_USER_MODEL``-------------------Default: ``'auth.User'``The model to use to represent a User. See :ref:`auth-custom-user`... warning::You cannot change the AUTH_USER_MODEL setting during the lifetime ofa 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 ofthe app that it lives in.See :ref:`auth-custom-user` for more details... setting:: LOGIN_REDIRECT_URL``LOGIN_REDIRECT_URL``----------------------Default: ``'/accounts/profile/'``The URL or :ref:`named URL pattern <naming-url-patterns>` where requests areredirected after login when the :class:`~django.contrib.auth.views.LoginView`doesn't get a ``next`` GET parameter... setting:: LOGIN_URL``LOGIN_URL``-------------Default: ``'/accounts/login/'``The URL or :ref:`named URL pattern <naming-url-patterns>` where requests areredirected for login when using the:func:`~django.contrib.auth.decorators.login_required` decorator,:class:`~django.contrib.auth.mixins.LoginRequiredMixin`, or:class:`~django.contrib.auth.mixins.AccessMixin`... setting:: LOGOUT_REDIRECT_URL``LOGOUT_REDIRECT_URL``-----------------------Default: ``None``The URL or :ref:`named URL pattern <naming-url-patterns>` where requests areredirected after logout if :class:`~django.contrib.auth.views.LogoutView`doesn't have a ``next_page`` attribute.If ``None``, no redirect will be performed and the logout view will berendered... setting:: PASSWORD_RESET_TIMEOUT``PASSWORD_RESET_TIMEOUT``--------------------------Default: ``259200`` (3 days, in seconds)The number of seconds a password reset link is valid for.Used by the :class:`~django.contrib.auth.views.PasswordResetConfirmView`... note::Reducing the value of this timeout doesn't make any difference to theability of an attacker to brute-force a password reset token. Tokens aredesigned to be safe from brute-forcing without any timeout.This timeout exists to protect against some unlikely attack scenarios, suchas someone gaining access to email archives that may contain old, unusedpassword reset tokens... setting:: PASSWORD_HASHERS``PASSWORD_HASHERS``--------------------See :ref:`auth_password_storage`.Default::['django.contrib.auth.hashers.PBKDF2PasswordHasher','django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher','django.contrib.auth.hashers.Argon2PasswordHasher','django.contrib.auth.hashers.BCryptSHA256PasswordHasher',].. setting:: AUTH_PASSWORD_VALIDATORS``AUTH_PASSWORD_VALIDATORS``----------------------------Default: ``[]`` (Empty list)The list of validators that are used to check the strength of user's passwords.See :ref:`password-validation` for more details. By default, no validation isperformed and all passwords are accepted... _settings-messages:Messages========Settings for :mod:`django.contrib.messages`... setting:: MESSAGE_LEVEL``MESSAGE_LEVEL``-----------------Default: ``messages.INFO``Sets the minimum message level that will be recorded by the messagesframework. See :ref:`message levels <message-level>` for more details... admonition:: ImportantIf you override ``MESSAGE_LEVEL`` in your settings file and rely on any ofthe built-in constants, you must import the constants module directly toavoid the potential for circular imports, e.g.::from django.contrib.messages import constants as message_constantsMESSAGE_LEVEL = message_constants.DEBUGIf desired, you may specify the numeric values for the constants directlyaccording to the values in the above :ref:`constants table<message-level-constants>`... setting:: MESSAGE_STORAGE``MESSAGE_STORAGE``-------------------Default: ``'django.contrib.messages.storage.fallback.FallbackStorage'``Controls where Django stores message data. Valid values are:* ``'django.contrib.messages.storage.fallback.FallbackStorage'``* ``'django.contrib.messages.storage.session.SessionStorage'``* ``'django.contrib.messages.storage.cookie.CookieStorage'``See :ref:`message storage backends <message-storage-backends>` for more details.The backends that use cookies --:class:`~django.contrib.messages.storage.cookie.CookieStorage` and:class:`~django.contrib.messages.storage.fallback.FallbackStorage` --use the value of :setting:`SESSION_COOKIE_DOMAIN`, :setting:`SESSION_COOKIE_SECURE`and :setting:`SESSION_COOKIE_HTTPONLY` when setting their cookies... setting:: MESSAGE_TAGS``MESSAGE_TAGS``----------------Default::{messages.DEBUG: 'debug',messages.INFO: 'info',messages.SUCCESS: 'success',messages.WARNING: 'warning',messages.ERROR: 'error',}This sets the mapping of message level to message tag, which is typicallyrendered as a CSS class in HTML. If you specify a value, it will extendthe default. This means you only have to specify those values which you needto override. See :ref:`message-displaying` above for more details... admonition:: ImportantIf you override ``MESSAGE_TAGS`` in your settings file and rely on any ofthe built-in constants, you must import the ``constants`` module directly toavoid the potential for circular imports, e.g.::from django.contrib.messages import constants as message_constantsMESSAGE_TAGS = {message_constants.INFO: ''}If desired, you may specify the numeric values for the constants directlyaccording to the values in the above :ref:`constants table<message-level-constants>`... _settings-sessions:Sessions========Settings for :mod:`django.contrib.sessions`... setting:: SESSION_CACHE_ALIAS``SESSION_CACHE_ALIAS``-----------------------Default: ``'default'``If you're using :ref:`cache-based session storage <cached-sessions-backend>`,this selects the cache to use... setting:: SESSION_COOKIE_AGE``SESSION_COOKIE_AGE``----------------------Default: ``1209600`` (2 weeks, in seconds)The age of session cookies, in seconds... setting:: SESSION_COOKIE_DOMAIN``SESSION_COOKIE_DOMAIN``-------------------------Default: ``None``The domain to use for session cookies. Set this to a string such as``"example.com"`` for cross-domain cookies, or use ``None`` for a standarddomain cookie.To use cross-domain cookies with :setting:`CSRF_USE_SESSIONS`, you must includea leading dot (e.g. ``".example.com"``) to accommodate the CSRF middleware'sreferer checking.Be cautious when updating this setting on a production site. If you updatethis setting to enable cross-domain cookies on a site that previously usedstandard domain cookies, existing user cookies will be set to the olddomain. This may result in them being unable to log in as long as these cookiespersist.This setting also affects cookies set by :mod:`django.contrib.messages`... setting:: SESSION_COOKIE_HTTPONLY``SESSION_COOKIE_HTTPONLY``---------------------------Default: ``True``Whether to use ``HttpOnly`` flag on the session cookie. If this is set to``True``, client-side JavaScript will not be able to access the sessioncookie.HttpOnly_ is a flag included in a Set-Cookie HTTP response header. It's part ofthe :rfc:`6265#section-4.1.2.6` standard for cookies and can be a useful way tomitigate 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 scriptingvulnerability into full hijacking of a user's session. There aren't many goodreasons for turning this off. Your code shouldn't read session cookies fromJavaScript... _HttpOnly: https://owasp.org/www-community/HttpOnly.. setting:: SESSION_COOKIE_NAME``SESSION_COOKIE_NAME``-----------------------Default: ``'sessionid'``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)... setting:: SESSION_COOKIE_PATH``SESSION_COOKIE_PATH``-----------------------Default: ``'/'``The path set on the session cookie. This should either match the URL path of yourDjango installation or be parent of that path.This is useful if you have multiple Django instances running under the samehostname. They can use different cookie paths, and each instance will only seeits own session cookie... setting:: SESSION_COOKIE_SAMESITE``SESSION_COOKIE_SAMESITE``---------------------------Default: ``'Lax'``The value of the `SameSite`_ flag on the session cookie. This flag prevents thecookie from being sent in cross-site requests thus preventing CSRF attacks andmaking some methods of stealing session cookie impossible.Possible values for the setting are:* ``'Strict'``: prevents the cookie from being sent by the browser to thetarget site in all cross-site browsing context, even when following a regularlink.For example, for a GitHub-like website this would mean that if a logged-inuser follows a link to a private GitHub project posted on a corporatediscussion forum or email, GitHub will not receive the session cookie and theuser won't be able to access the project. A bank website, however, mostlikely doesn't want to allow any transactional pages to be linked fromexternal sites so the ``'Strict'`` flag would be appropriate.* ``'Lax'`` (default): provides a balance between security and usability forwebsites that want to maintain user's logged-in session after the userarrives from an external link.In the GitHub scenario, the session cookie would be allowed when following aregular link from an external website and be blocked in CSRF-prone requestmethods (e.g. ``POST``).* ``'None'`` (string): the session cookie will be sent with all same-site andcross-site requests.* ``False``: disables the flag... note::Modern browsers provide a more secure default policy for the ``SameSite``flag and will assume ``Lax`` for cookies without an explicit value set... _SameSite: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite.. setting:: SESSION_COOKIE_SECURE``SESSION_COOKIE_SECURE``-------------------------Default: ``False``Whether to use a secure cookie for the session cookie. If this is set to``True``, the cookie will be marked as "secure", which means browsers mayensure that the cookie is only sent under an HTTPS connection.Leaving this setting off isn't a good idea because an attacker could capture anunencrypted session cookie with a packet sniffer and use the cookie to hijackthe user's session... setting:: SESSION_ENGINE``SESSION_ENGINE``------------------Default: ``'django.contrib.sessions.backends.db'``Controls where Django stores session data. Included engines are:* ``'django.contrib.sessions.backends.db'``* ``'django.contrib.sessions.backends.file'``* ``'django.contrib.sessions.backends.cache'``* ``'django.contrib.sessions.backends.cached_db'``* ``'django.contrib.sessions.backends.signed_cookies'``See :ref:`configuring-sessions` for more details... setting:: SESSION_EXPIRE_AT_BROWSER_CLOSE``SESSION_EXPIRE_AT_BROWSER_CLOSE``-----------------------------------Default: ``False``Whether to expire the session when the user closes their browser. See:ref:`browser-length-vs-persistent-sessions`... setting:: SESSION_FILE_PATH``SESSION_FILE_PATH``---------------------Default: ``None``If you're using file-based session storage, this sets the directory inwhich Django will store session data. When the default value (``None``) isused, Django will use the standard temporary directory for the system... setting:: SESSION_SAVE_EVERY_REQUEST``SESSION_SAVE_EVERY_REQUEST``------------------------------Default: ``False``Whether to save the session data on every request. If this is ``False``(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. Emptysessions won't be created, even if this setting is active... setting:: SESSION_SERIALIZER``SESSION_SERIALIZER``----------------------Default: ``'django.contrib.sessions.serializers.JSONSerializer'``Full import path of a serializer class to use for serializing session data.Included serializer is:* ``'django.contrib.sessions.serializers.JSONSerializer'``See :ref:`session_serialization` for details.Sites=====Settings for :mod:`django.contrib.sites`... setting:: SITE_ID``SITE_ID``-----------Default: Not definedThe ID, as an integer, of the current site in the ``django_site`` databasetable. This is used so that application data can hook into specific sitesand a single database can manage content for multiple sites... _settings-staticfiles:Static Files============Settings for :mod:`django.contrib.staticfiles`... setting:: STATIC_ROOT``STATIC_ROOT``---------------Default: ``None``The absolute path to the directory where :djadmin:`collectstatic` will collectstatic files for deployment.Example: ``"/var/www/example.com/static/"``If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled(as in the default project template), the :djadmin:`collectstatic` managementcommand will collect static files into this directory. See the how-to on:doc:`managing static files</howto/static-files/index>` for more details aboutusage... warning::This should be an initially empty destination directory for collectingyour static files from their permanent locations into one directory forease of deployment; it is **not** a place to store your static filespermanently. You should do that in directories that will be found by:doc:`staticfiles</ref/contrib/staticfiles>`’s:setting:`finders<STATICFILES_FINDERS>`, which by default, are``'static/'`` app sub-directories and any directories you include in:setting:`STATICFILES_DIRS`)... setting:: STATIC_URL``STATIC_URL``--------------Default: ``None``URL to use when referring to static files located in :setting:`STATIC_ROOT`.Example: ``"static/"`` or ``"http://static.example.com/"``If not ``None``, this will be used as the base path for:ref:`asset definitions<form-asset-paths>` (the ``Media`` class) and the:doc:`staticfiles app</ref/contrib/staticfiles>`.It must end in a slash if set to a non-empty value.You may need to :ref:`configure these files to be served in development<serving-static-files-in-development>` and will definitely need to do so:doc:`in production </howto/static-files/deployment>`... note::If :setting:`STATIC_URL` is a relative path, then it will be prefixed bythe server-provided value of ``SCRIPT_NAME`` (or ``/`` if not set). Thismakes it easier to serve a Django application in a subpath without addingan extra configuration to the settings... setting:: STATICFILES_DIRS``STATICFILES_DIRS``--------------------Default: ``[]`` (Empty list)This setting defines the additional locations the staticfiles app will traverseif the ``FileSystemFinder`` finder is enabled, e.g. if you use the:djadmin:`collectstatic` or :djadmin:`findstatic` management command or use thestatic file serving view.This should be set to a list of strings that contain full paths toyour additional files directory(ies) e.g.::STATICFILES_DIRS = ["/home/special.polls.com/polls/static","/home/polls.com/polls/static","/opt/webfiles/common",]Note that these paths should use Unix-style forward slashes, even on Windows(e.g. ``"C:/Users/user/mysite/extra_static_content"``)... _staticfiles-dirs-prefixes:Prefixes (optional)~~~~~~~~~~~~~~~~~~~In case you want to refer to files in one of the locations with an additionalnamespace, you can **optionally** provide a prefix as ``(prefix, path)``tuples, e.g.::STATICFILES_DIRS = [# ...("downloads", "/opt/webfiles/stats"),]For example, assuming you have :setting:`STATIC_URL` set to ``'static/'``, the:djadmin:`collectstatic` management command would collect the "stats" filesin a ``'downloads'`` subdirectory of :setting:`STATIC_ROOT`.This would allow you to refer to the local file``'/opt/webfiles/stats/polls_20101022.tar.gz'`` with``'/static/downloads/polls_20101022.tar.gz'`` in your templates, e.g.:.. code-block:: html+django<a href="{% static 'downloads/polls_20101022.tar.gz' %}">.. setting:: STATICFILES_STORAGE``STATICFILES_STORAGE``-----------------------Default: ``'django.contrib.staticfiles.storage.StaticFilesStorage'``The file storage engine to use when collecting static files with the:djadmin:`collectstatic` management command.A ready-to-use instance of the storage backend defined in this settingcan be found at ``django.contrib.staticfiles.storage.staticfiles_storage``.For an example, see :ref:`staticfiles-from-cdn`... setting:: STATICFILES_FINDERS``STATICFILES_FINDERS``-----------------------Default::['django.contrib.staticfiles.finders.FileSystemFinder','django.contrib.staticfiles.finders.AppDirectoriesFinder',]The list of finder backends that know how to find static files invarious locations.The default will find files stored in the :setting:`STATICFILES_DIRS` setting(using ``django.contrib.staticfiles.finders.FileSystemFinder``) and in a``static`` subdirectory of each app (using``django.contrib.staticfiles.finders.AppDirectoriesFinder``). If multiplefiles with the same name are present, the first file that is found will beused.One finder is disabled by default:``django.contrib.staticfiles.finders.DefaultStorageFinder``. If added toyour :setting:`STATICFILES_FINDERS` setting, it will look for static files inthe default file storage as defined by the :setting:`DEFAULT_FILE_STORAGE`setting... note::When using the ``AppDirectoriesFinder`` finder, make sure your appscan be found by staticfiles by adding the app to the:setting:`INSTALLED_APPS` setting of your site.Static file finders are currently considered a private interface, and thisinterface is thus undocumented.Core Settings Topical Index===========================Cache-----* :setting:`CACHES`* :setting:`CACHE_MIDDLEWARE_ALIAS`* :setting:`CACHE_MIDDLEWARE_KEY_PREFIX`* :setting:`CACHE_MIDDLEWARE_SECONDS`Database--------* :setting:`DATABASES`* :setting:`DATABASE_ROUTERS`* :setting:`DEFAULT_INDEX_TABLESPACE`* :setting:`DEFAULT_TABLESPACE`Debugging---------* :setting:`DEBUG`* :setting:`DEBUG_PROPAGATE_EXCEPTIONS`Email-----* :setting:`ADMINS`* :setting:`DEFAULT_CHARSET`* :setting:`DEFAULT_FROM_EMAIL`* :setting:`EMAIL_BACKEND`* :setting:`EMAIL_FILE_PATH`* :setting:`EMAIL_HOST`* :setting:`EMAIL_HOST_PASSWORD`* :setting:`EMAIL_HOST_USER`* :setting:`EMAIL_PORT`* :setting:`EMAIL_SSL_CERTFILE`* :setting:`EMAIL_SSL_KEYFILE`* :setting:`EMAIL_SUBJECT_PREFIX`* :setting:`EMAIL_TIMEOUT`* :setting:`EMAIL_USE_LOCALTIME`* :setting:`EMAIL_USE_TLS`* :setting:`MANAGERS`* :setting:`SERVER_EMAIL`Error reporting---------------* :setting:`DEFAULT_EXCEPTION_REPORTER`* :setting:`DEFAULT_EXCEPTION_REPORTER_FILTER`* :setting:`IGNORABLE_404_URLS`* :setting:`MANAGERS`* :setting:`SILENCED_SYSTEM_CHECKS`.. _file-upload-settings:File uploads------------* :setting:`DEFAULT_FILE_STORAGE`* :setting:`FILE_UPLOAD_HANDLERS`* :setting:`FILE_UPLOAD_MAX_MEMORY_SIZE`* :setting:`FILE_UPLOAD_PERMISSIONS`* :setting:`FILE_UPLOAD_TEMP_DIR`* :setting:`MEDIA_ROOT`* :setting:`MEDIA_URL`Forms-----* :setting:`FORM_RENDERER`Globalization (``i18n``/``l10n``)---------------------------------* :setting:`DATE_FORMAT`* :setting:`DATE_INPUT_FORMATS`* :setting:`DATETIME_FORMAT`* :setting:`DATETIME_INPUT_FORMATS`* :setting:`DECIMAL_SEPARATOR`* :setting:`FIRST_DAY_OF_WEEK`* :setting:`FORMAT_MODULE_PATH`* :setting:`LANGUAGE_CODE`* :setting:`LANGUAGE_COOKIE_AGE`* :setting:`LANGUAGE_COOKIE_DOMAIN`* :setting:`LANGUAGE_COOKIE_HTTPONLY`* :setting:`LANGUAGE_COOKIE_NAME`* :setting:`LANGUAGE_COOKIE_PATH`* :setting:`LANGUAGE_COOKIE_SAMESITE`* :setting:`LANGUAGE_COOKIE_SECURE`* :setting:`LANGUAGES`* :setting:`LANGUAGES_BIDI`* :setting:`LOCALE_PATHS`* :setting:`MONTH_DAY_FORMAT`* :setting:`NUMBER_GROUPING`* :setting:`SHORT_DATE_FORMAT`* :setting:`SHORT_DATETIME_FORMAT`* :setting:`THOUSAND_SEPARATOR`* :setting:`TIME_FORMAT`* :setting:`TIME_INPUT_FORMATS`* :setting:`TIME_ZONE`* :setting:`USE_I18N`* :setting:`USE_L10N`* :setting:`USE_THOUSAND_SEPARATOR`* :setting:`USE_TZ`* :setting:`YEAR_MONTH_FORMAT`HTTP----* :setting:`DATA_UPLOAD_MAX_MEMORY_SIZE`* :setting:`DATA_UPLOAD_MAX_NUMBER_FIELDS`* :setting:`DATA_UPLOAD_MAX_NUMBER_FILES`* :setting:`DEFAULT_CHARSET`* :setting:`DISALLOWED_USER_AGENTS`* :setting:`FORCE_SCRIPT_NAME`* :setting:`INTERNAL_IPS`* :setting:`MIDDLEWARE`* Security* :setting:`SECURE_CONTENT_TYPE_NOSNIFF`* :setting:`SECURE_CROSS_ORIGIN_OPENER_POLICY`* :setting:`SECURE_HSTS_INCLUDE_SUBDOMAINS`* :setting:`SECURE_HSTS_PRELOAD`* :setting:`SECURE_HSTS_SECONDS`* :setting:`SECURE_PROXY_SSL_HEADER`* :setting:`SECURE_REDIRECT_EXEMPT`* :setting:`SECURE_REFERRER_POLICY`* :setting:`SECURE_SSL_HOST`* :setting:`SECURE_SSL_REDIRECT`* :setting:`SIGNING_BACKEND`* :setting:`USE_X_FORWARDED_HOST`* :setting:`USE_X_FORWARDED_PORT`* :setting:`WSGI_APPLICATION`Logging-------* :setting:`LOGGING`* :setting:`LOGGING_CONFIG`Models------* :setting:`ABSOLUTE_URL_OVERRIDES`* :setting:`FIXTURE_DIRS`* :setting:`INSTALLED_APPS`Security--------* Cross Site Request Forgery Protection* :setting:`CSRF_COOKIE_DOMAIN`* :setting:`CSRF_COOKIE_NAME`* :setting:`CSRF_COOKIE_PATH`* :setting:`CSRF_COOKIE_SAMESITE`* :setting:`CSRF_COOKIE_SECURE`* :setting:`CSRF_FAILURE_VIEW`* :setting:`CSRF_HEADER_NAME`* :setting:`CSRF_TRUSTED_ORIGINS`* :setting:`CSRF_USE_SESSIONS`* :setting:`SECRET_KEY`* :setting:`SECRET_KEY_FALLBACKS`* :setting:`X_FRAME_OPTIONS`Serialization-------------* :setting:`DEFAULT_CHARSET`* :setting:`SERIALIZATION_MODULES`Templates---------* :setting:`TEMPLATES`Testing-------* Database: :setting:`TEST <DATABASE-TEST>`* :setting:`TEST_NON_SERIALIZED_APPS`* :setting:`TEST_RUNNER`URLs----* :setting:`APPEND_SLASH`* :setting:`PREPEND_WWW`* :setting:`ROOT_URLCONF`