2009-12-26 03:44:21 +00:00
|
|
|
========
|
|
|
|
Settings
|
|
|
|
========
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
:local:
|
|
|
|
:depth: 1
|
|
|
|
|
2012-02-20 19:08:22 +00:00
|
|
|
.. warning::
|
|
|
|
|
|
|
|
Be careful when you override settings, especially when the default value
|
2012-03-02 17:16:52 +00:00
|
|
|
is a non-empty tuple or dictionary, such as :setting:`MIDDLEWARE_CLASSES`
|
|
|
|
and :setting:`TEMPLATE_CONTEXT_PROCESSORS`. Make sure you keep the
|
|
|
|
components required by the features of Django you wish to use.
|
2012-02-20 19:08:22 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Core settings
|
|
|
|
=============
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Here's a list of settings available in Django core and their default values.
|
|
|
|
Settings provided by contrib apps are listed below, followed by a topical index
|
|
|
|
of the core settings.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: ABSOLUTE_URL_OVERRIDES
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
ABSOLUTE_URL_OVERRIDES
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
Default: ``{}`` (Empty dictionary)
|
|
|
|
|
2007-01-03 22:37:05 +00:00
|
|
|
A dictionary mapping ``"app_label.model_name"`` strings to functions that take
|
2005-10-17 04:53:03 +00:00
|
|
|
a model object and return its URL. This is a way of overriding
|
|
|
|
``get_absolute_url()`` methods on a per-installation basis. Example::
|
|
|
|
|
|
|
|
ABSOLUTE_URL_OVERRIDES = {
|
2007-03-07 12:23:01 +00:00
|
|
|
'blogs.weblog': lambda o: "/blogs/%s/" % o.slug,
|
|
|
|
'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),
|
2005-10-17 04:53:03 +00:00
|
|
|
}
|
|
|
|
|
2007-03-07 12:23:01 +00:00
|
|
|
Note that the model name used in this setting should be all lower-case, regardless
|
|
|
|
of the case of the actual model class name.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: ADMINS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
ADMINS
|
|
|
|
------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
|
|
|
A tuple that lists people who get code error notifications. When
|
2011-04-01 16:10:22 +00:00
|
|
|
``DEBUG=False`` and a view raises an exception, Django will email these people
|
2005-10-17 04:53:03 +00:00
|
|
|
with the full exception information. Each member of the tuple should be a tuple
|
2011-04-01 16:10:22 +00:00
|
|
|
of (Full name, email address). Example::
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
(('John', 'john@example.com'), ('Mary', 'mary@example.com'))
|
|
|
|
|
2011-04-01 16:10:22 +00:00
|
|
|
Note that Django will email *all* of these people whenever an error happens.
|
2010-08-19 19:27:44 +00:00
|
|
|
See :doc:`/howto/error-reporting` for more information.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-02-09 17:17:01 +00:00
|
|
|
.. setting:: ALLOWED_HOSTS
|
|
|
|
|
|
|
|
ALLOWED_HOSTS
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``[]`` (Empty list)
|
|
|
|
|
|
|
|
A list of strings representing the host/domain names that this Django site can
|
|
|
|
serve. This is a security measure to prevent an attacker from poisoning caches
|
|
|
|
and password reset emails with links to malicious hosts by submitting requests
|
|
|
|
with a fake HTTP ``Host`` header, which is possible even under many
|
2013-04-29 17:40:03 +00:00
|
|
|
seemingly-safe web server configurations.
|
2013-02-09 17:17:01 +00:00
|
|
|
|
|
|
|
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`` header
|
|
|
|
exactly (case-insensitive, not including port). A value beginning with a period
|
|
|
|
can 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 are
|
|
|
|
responsible to provide your own validation of the ``Host`` header (perhaps in a
|
|
|
|
middleware; if so this middleware must be listed first in
|
|
|
|
:setting:`MIDDLEWARE_CLASSES`).
|
|
|
|
|
2013-05-01 18:13:09 +00:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
If you want to also allow the `fully qualified domain name (FQDN)`_, which
|
|
|
|
some browsers can send in the Host header, you must explicitly add another
|
|
|
|
ALLOWED_HOSTS entry that includes a trailing period. This entry can also be
|
|
|
|
a subdomain wildcard::
|
|
|
|
|
|
|
|
ALLOWED_HOSTS = [
|
|
|
|
'.example.com', # Allow domain and subdomains
|
|
|
|
'.example.com.', # Also allow FQDN and subdomains
|
|
|
|
]
|
|
|
|
|
|
|
|
.. _`fully qualified domain name (FQDN)`: http://en.wikipedia.org/wiki/Fully_qualified_domain_name
|
|
|
|
|
2013-02-09 17:17:01 +00:00
|
|
|
If the ``Host`` header (or ``X-Forwarded-Host`` if
|
|
|
|
:setting:`USE_X_FORWARDED_HOST` is enabled) does not match any value in this
|
|
|
|
list, the :meth:`django.http.HttpRequest.get_host()` method will raise
|
|
|
|
:exc:`~django.core.exceptions.SuspiciousOperation`.
|
|
|
|
|
|
|
|
When :setting:`DEBUG` is ``True`` or when running tests, host validation is
|
|
|
|
disabled; any host will be accepted. Thus it's usually only necessary to set it
|
|
|
|
in production.
|
|
|
|
|
|
|
|
This validation only applies via :meth:`~django.http.HttpRequest.get_host()`;
|
|
|
|
if your code accesses the ``Host`` header directly from ``request.META`` you
|
|
|
|
are bypassing this security protection.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: ALLOWED_INCLUDE_ROOTS
|
2007-02-26 21:18:31 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
ALLOWED_INCLUDE_ROOTS
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
|
|
|
A tuple of strings representing allowed prefixes for the ``{% ssi %}`` template
|
|
|
|
tag. This is a security measure, so that template authors can't access files
|
|
|
|
that they shouldn't be accessing.
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
For example, if :setting:`ALLOWED_INCLUDE_ROOTS` is ``('/home/html', '/var/www')``,
|
2005-10-17 04:53:03 +00:00
|
|
|
then ``{% ssi /home/html/foo.txt %}`` would work, but ``{% ssi /etc/passwd %}``
|
|
|
|
wouldn't.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: APPEND_SLASH
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
APPEND_SLASH
|
|
|
|
------------
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
2010-10-23 14:52:01 +00:00
|
|
|
When set to ``True``, if the request URL does not match any of the patterns
|
2010-10-10 06:36:38 +00:00
|
|
|
in the URLconf and it doesn't end in a slash, an HTTP redirect is issued to the
|
2010-10-23 14:52:01 +00:00
|
|
|
same URL with a slash appended. Note that the redirect may cause any data
|
2010-10-10 06:36:38 +00:00
|
|
|
submitted in a POST request to be lost.
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
The :setting:`APPEND_SLASH` setting is only used if
|
2010-10-10 06:36:38 +00:00
|
|
|
:class:`~django.middleware.common.CommonMiddleware` is installed
|
|
|
|
(see :doc:`/topics/http/middleware`). See also :setting:`PREPEND_WWW`.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
.. setting:: CACHES
|
2007-12-01 20:45:05 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
CACHES
|
|
|
|
------
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
Default::
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
{
|
|
|
|
'default': {
|
|
|
|
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
|
|
|
|
}
|
|
|
|
}
|
2010-11-19 15:39:35 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
A dictionary containing the settings for all caches to be used with
|
|
|
|
Django. It is a nested dictionary whose contents maps cache aliases
|
|
|
|
to a dictionary containing the options for an individual cache.
|
2010-11-19 15:39:35 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
The :setting:`CACHES` setting must configure a ``default`` cache;
|
|
|
|
any number of additional caches may also be specified. If you
|
|
|
|
are using a cache backend other than the local memory cache, or
|
|
|
|
you need to define multiple caches, other options will be required.
|
|
|
|
The following cache options are available.
|
|
|
|
|
|
|
|
.. setting:: CACHES-BACKEND
|
|
|
|
|
|
|
|
BACKEND
|
|
|
|
~~~~~~~
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The cache backend to use. The built-in cache backends are:
|
|
|
|
|
2011-10-14 00:12:01 +00:00
|
|
|
* ``'django.core.cache.backends.db.DatabaseCache'``
|
|
|
|
* ``'django.core.cache.backends.dummy.DummyCache'``
|
|
|
|
* ``'django.core.cache.backends.filebased.FileBasedCache'``
|
|
|
|
* ``'django.core.cache.backends.locmem.LocMemCache'``
|
|
|
|
* ``'django.core.cache.backends.memcached.MemcachedCache'``
|
|
|
|
* ``'django.core.cache.backends.memcached.PyLibMCCache'``
|
2010-12-21 15:19:19 +00:00
|
|
|
|
|
|
|
You can use a cache backend that doesn't ship with Django by setting
|
2012-12-25 08:40:08 +00:00
|
|
|
:setting:`BACKEND <CACHES-BACKEND>` to a fully-qualified path of a cache
|
2010-12-21 15:19:19 +00:00
|
|
|
backend class (i.e. ``mypackage.backends.whatever.WhateverCache``).
|
|
|
|
Writing a whole new cache backend from scratch is left as an exercise
|
|
|
|
to the reader; see the other backends for examples.
|
|
|
|
|
|
|
|
.. setting:: CACHES-KEY_FUNCTION
|
|
|
|
|
|
|
|
KEY_FUNCTION
|
|
|
|
~~~~~~~~~~~~
|
2010-11-19 15:39:35 +00:00
|
|
|
|
|
|
|
A string containing a dotted path to a function that defines how to
|
|
|
|
compose a prefix, version and key into a final cache key. The default
|
|
|
|
implementation is equivalent to the function::
|
|
|
|
|
|
|
|
def make_key(key, key_prefix, version):
|
2012-08-28 18:59:56 +00:00
|
|
|
return ':'.join([key_prefix, str(version), key])
|
2010-11-19 15:39:35 +00:00
|
|
|
|
|
|
|
You may use any key function you want, as long as it has the same
|
|
|
|
argument signature.
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See the :ref:`cache documentation <cache_key_transformation>` for more
|
|
|
|
information.
|
2010-11-19 15:39:35 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
.. setting:: CACHES-KEY_PREFIX
|
2010-11-26 13:38:39 +00:00
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
KEY_PREFIX
|
|
|
|
~~~~~~~~~~
|
2010-11-26 13:38:39 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
A string that will be automatically included (prepended by default) to
|
|
|
|
all cache keys used by the Django server.
|
|
|
|
|
|
|
|
See the :ref:`cache documentation <cache_key_prefixing>` for more information.
|
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
.. setting:: CACHES-LOCATION
|
|
|
|
|
|
|
|
LOCATION
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The location of the cache to use. This might be the directory for a
|
|
|
|
file system cache, a host and port for a memcache server, or simply an
|
|
|
|
identifying name 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 parameters
|
|
|
|
vary depending on your cache backend.
|
|
|
|
|
|
|
|
Some information on available parameters can be found in the
|
|
|
|
:doc:`Cache Backends </topics/cache>` 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.
|
|
|
|
|
|
|
|
.. 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 cache middleware.
|
|
|
|
|
2010-08-23 08:07:35 +00:00
|
|
|
.. setting:: CACHE_MIDDLEWARE_ANONYMOUS_ONLY
|
|
|
|
|
|
|
|
CACHE_MIDDLEWARE_ANONYMOUS_ONLY
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
2013-05-18 14:10:14 +00:00
|
|
|
.. deprecated:: 1.6
|
|
|
|
|
|
|
|
This setting was largely ineffective because of using cookies for sessions
|
|
|
|
and CSRF. See the :doc:`Django 1.6 release notes</releases/1.6>` for more
|
|
|
|
information.
|
|
|
|
|
2010-08-23 08:07:35 +00:00
|
|
|
If the value of this setting is ``True``, only anonymous requests (i.e., not
|
|
|
|
those made by a logged-in user) will be cached. Otherwise, the middleware
|
|
|
|
caches every page that doesn't have GET or POST parameters.
|
|
|
|
|
|
|
|
If you set the value of this setting to ``True``, you should make sure you've
|
|
|
|
activated ``AuthenticationMiddleware``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: CACHE_MIDDLEWARE_KEY_PREFIX
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
CACHE_MIDDLEWARE_KEY_PREFIX
|
2007-07-05 11:08:40 +00:00
|
|
|
---------------------------
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2010-11-22 06:15:02 +00:00
|
|
|
The cache key prefix that the cache middleware should use.
|
|
|
|
|
|
|
|
See :doc:`/topics/cache`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: CACHE_MIDDLEWARE_SECONDS
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2007-07-05 11:08:40 +00:00
|
|
|
CACHE_MIDDLEWARE_SECONDS
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
Default: ``600``
|
|
|
|
|
|
|
|
The default number of seconds to cache a page when the caching middleware or
|
|
|
|
``cache_page()`` decorator is used.
|
|
|
|
|
2010-11-22 06:15:02 +00:00
|
|
|
See :doc:`/topics/cache`.
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. _settings-csrf:
|
|
|
|
|
Fixed #9977 - CsrfMiddleware gets template tag added, session dependency removed, and turned on by default.
This is a large change to CSRF protection for Django. It includes:
* removing the dependency on the session framework.
* deprecating CsrfResponseMiddleware, and replacing with a core template tag.
* turning on CSRF protection by default by adding CsrfViewMiddleware to
the default value of MIDDLEWARE_CLASSES.
* protecting all contrib apps (whatever is in settings.py)
using a decorator.
For existing users of the CSRF functionality, it should be a seamless update,
but please note that it includes DEPRECATION of features in Django 1.1,
and there are upgrade steps which are detailed in the docs.
Many thanks to 'Glenn' and 'bthomas', who did a lot of the thinking and work
on the patch, and to lots of other people including Simon Willison and
Russell Keith-Magee who refined the ideas.
Details of the rationale for these changes is found here:
http://code.djangoproject.com/wiki/CsrfProtection
As of this commit, the CSRF code is mainly in 'contrib'. The code will be
moved to core in a separate commit, to make the changeset as readable as
possible.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11660 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-10-26 23:23:07 +00:00
|
|
|
.. setting:: CSRF_COOKIE_DOMAIN
|
|
|
|
|
|
|
|
CSRF_COOKIE_DOMAIN
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The domain to be used when setting the CSRF cookie. This can be useful for
|
2011-08-13 11:58:19 +00:00
|
|
|
easily allowing cross-subdomain requests to be excluded from the normal cross
|
2011-05-09 22:59:52 +00:00
|
|
|
site request forgery protection. It should be set to a string such as
|
2012-06-07 09:50:20 +00:00
|
|
|
``".example.com"`` to allow a POST request from a form on one subdomain to be
|
2013-01-12 23:44:53 +00:00
|
|
|
accepted by a view served from another subdomain.
|
Fixed #9977 - CsrfMiddleware gets template tag added, session dependency removed, and turned on by default.
This is a large change to CSRF protection for Django. It includes:
* removing the dependency on the session framework.
* deprecating CsrfResponseMiddleware, and replacing with a core template tag.
* turning on CSRF protection by default by adding CsrfViewMiddleware to
the default value of MIDDLEWARE_CLASSES.
* protecting all contrib apps (whatever is in settings.py)
using a decorator.
For existing users of the CSRF functionality, it should be a seamless update,
but please note that it includes DEPRECATION of features in Django 1.1,
and there are upgrade steps which are detailed in the docs.
Many thanks to 'Glenn' and 'bthomas', who did a lot of the thinking and work
on the patch, and to lots of other people including Simon Willison and
Russell Keith-Magee who refined the ideas.
Details of the rationale for these changes is found here:
http://code.djangoproject.com/wiki/CsrfProtection
As of this commit, the CSRF code is mainly in 'contrib'. The code will be
moved to core in a separate commit, to make the changeset as readable as
possible.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11660 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-10-26 23:23:07 +00:00
|
|
|
|
2011-05-09 22:59:52 +00:00
|
|
|
Please note that the presence of this setting does not imply that Django's CSRF
|
|
|
|
protection is safe from cross-subdomain attacks by default - please see the
|
|
|
|
:ref:`CSRF limitations <csrf-limitations>` section.
|
|
|
|
|
2013-02-07 08:48:08 +00:00
|
|
|
.. setting:: CSRF_COOKIE_HTTPONLY
|
|
|
|
|
|
|
|
CSRF_COOKIE_HTTPONLY
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
2013-06-05 16:55:50 +00:00
|
|
|
Whether to use ``HttpOnly`` flag on the CSRF cookie. If this is set to
|
|
|
|
``True``, client-side JavaScript will not to be able to access the CSRF cookie.
|
|
|
|
See :setting:`SESSION_COOKIE_HTTPONLY` for details on ``HttpOnly``.
|
2013-02-07 08:48:08 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
.. setting:: CSRF_COOKIE_NAME
|
|
|
|
|
|
|
|
CSRF_COOKIE_NAME
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``'csrftoken'``
|
|
|
|
|
|
|
|
The name of the cookie to use for the CSRF authentication token. This can be whatever you
|
2010-08-19 19:27:44 +00:00
|
|
|
want. See :doc:`/ref/contrib/csrf`.
|
2010-08-07 02:43:14 +00:00
|
|
|
|
2011-05-09 23:00:22 +00:00
|
|
|
.. setting:: CSRF_COOKIE_PATH
|
|
|
|
|
|
|
|
CSRF_COOKIE_PATH
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``'/'``
|
|
|
|
|
|
|
|
The path set on the CSRF cookie. This should either match the URL path of your
|
|
|
|
Django installation or be a parent of that path.
|
|
|
|
|
|
|
|
This is useful if you have multiple Django instances running under the same
|
|
|
|
hostname. They can use different cookie paths, and each instance will only see
|
|
|
|
its own CSRF cookie.
|
|
|
|
|
|
|
|
.. 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 the
|
|
|
|
cookie is only sent under an HTTPS connection.
|
|
|
|
|
Fixed #9977 - CsrfMiddleware gets template tag added, session dependency removed, and turned on by default.
This is a large change to CSRF protection for Django. It includes:
* removing the dependency on the session framework.
* deprecating CsrfResponseMiddleware, and replacing with a core template tag.
* turning on CSRF protection by default by adding CsrfViewMiddleware to
the default value of MIDDLEWARE_CLASSES.
* protecting all contrib apps (whatever is in settings.py)
using a decorator.
For existing users of the CSRF functionality, it should be a seamless update,
but please note that it includes DEPRECATION of features in Django 1.1,
and there are upgrade steps which are detailed in the docs.
Many thanks to 'Glenn' and 'bthomas', who did a lot of the thinking and work
on the patch, and to lots of other people including Simon Willison and
Russell Keith-Magee who refined the ideas.
Details of the rationale for these changes is found here:
http://code.djangoproject.com/wiki/CsrfProtection
As of this commit, the CSRF code is mainly in 'contrib'. The code will be
moved to core in a separate commit, to make the changeset as readable as
possible.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11660 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-10-26 23:23:07 +00:00
|
|
|
.. setting:: CSRF_FAILURE_VIEW
|
|
|
|
|
|
|
|
CSRF_FAILURE_VIEW
|
|
|
|
-----------------
|
|
|
|
|
2009-10-27 00:36:34 +00:00
|
|
|
Default: ``'django.views.csrf.csrf_failure'``
|
Fixed #9977 - CsrfMiddleware gets template tag added, session dependency removed, and turned on by default.
This is a large change to CSRF protection for Django. It includes:
* removing the dependency on the session framework.
* deprecating CsrfResponseMiddleware, and replacing with a core template tag.
* turning on CSRF protection by default by adding CsrfViewMiddleware to
the default value of MIDDLEWARE_CLASSES.
* protecting all contrib apps (whatever is in settings.py)
using a decorator.
For existing users of the CSRF functionality, it should be a seamless update,
but please note that it includes DEPRECATION of features in Django 1.1,
and there are upgrade steps which are detailed in the docs.
Many thanks to 'Glenn' and 'bthomas', who did a lot of the thinking and work
on the patch, and to lots of other people including Simon Willison and
Russell Keith-Magee who refined the ideas.
Details of the rationale for these changes is found here:
http://code.djangoproject.com/wiki/CsrfProtection
As of this commit, the CSRF code is mainly in 'contrib'. The code will be
moved to core in a separate commit, to make the changeset as readable as
possible.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11660 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-10-26 23:23:07 +00:00
|
|
|
|
|
|
|
A dotted path to the view function to be used when an incoming request
|
|
|
|
is rejected by the CSRF protection. The function should have this signature::
|
|
|
|
|
|
|
|
def csrf_failure(request, reason="")
|
|
|
|
|
|
|
|
where ``reason`` is a short message (intended for developers or logging, not for
|
|
|
|
end users) indicating the reason the request was rejected. See
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/ref/contrib/csrf`.
|
Fixed #9977 - CsrfMiddleware gets template tag added, session dependency removed, and turned on by default.
This is a large change to CSRF protection for Django. It includes:
* removing the dependency on the session framework.
* deprecating CsrfResponseMiddleware, and replacing with a core template tag.
* turning on CSRF protection by default by adding CsrfViewMiddleware to
the default value of MIDDLEWARE_CLASSES.
* protecting all contrib apps (whatever is in settings.py)
using a decorator.
For existing users of the CSRF functionality, it should be a seamless update,
but please note that it includes DEPRECATION of features in Django 1.1,
and there are upgrade steps which are detailed in the docs.
Many thanks to 'Glenn' and 'bthomas', who did a lot of the thinking and work
on the patch, and to lots of other people including Simon Willison and
Russell Keith-Magee who refined the ideas.
Details of the rationale for these changes is found here:
http://code.djangoproject.com/wiki/CsrfProtection
As of this commit, the CSRF code is mainly in 'contrib'. The code will be
moved to core in a separate commit, to make the changeset as readable as
possible.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11660 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-10-26 23:23:07 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: DATABASES
|
|
|
|
|
|
|
|
DATABASES
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``{}`` (Empty dictionary)
|
|
|
|
|
|
|
|
A dictionary containing the settings for all databases to be used with
|
2010-08-23 13:50:28 +00:00
|
|
|
Django. It is a nested dictionary whose contents maps database aliases
|
2009-12-22 15:18:51 +00:00
|
|
|
to 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 using
|
|
|
|
SQLite. This can be configured using the following::
|
|
|
|
|
|
|
|
DATABASES = {
|
|
|
|
'default': {
|
2009-12-28 13:13:04 +00:00
|
|
|
'ENGINE': 'django.db.backends.sqlite3',
|
2009-12-22 15:18:51 +00:00
|
|
|
'NAME': 'mydatabase'
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
For other database backends, or more complex SQLite configurations, other options
|
|
|
|
will be required. The following inner options are available.
|
|
|
|
|
2013-03-06 10:12:24 +00:00
|
|
|
.. setting:: DATABASE-ATOMIC_REQUESTS
|
|
|
|
|
|
|
|
ATOMIC_REQUESTS
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
Set this to ``True`` to wrap each HTTP request in a transaction on this
|
|
|
|
database. See :ref:`tying-transactions-to-http-requests`.
|
|
|
|
|
|
|
|
.. setting:: DATABASE-AUTOCOMMIT
|
|
|
|
|
|
|
|
AUTOCOMMIT
|
|
|
|
~~~~~~~~~~
|
|
|
|
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
|
|
|
Set this to ``False`` if you want to :ref:`disable Django's transaction
|
|
|
|
management <deactivate-transaction-management>` and implement your own.
|
|
|
|
|
2010-12-21 15:19:19 +00:00
|
|
|
.. setting:: DATABASE-ENGINE
|
2009-12-22 15:18:51 +00:00
|
|
|
|
|
|
|
ENGINE
|
|
|
|
~~~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2007-02-28 19:28:30 +00:00
|
|
|
Default: ``''`` (Empty string)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
The database backend to use. The built-in database backends are:
|
|
|
|
|
2011-10-14 00:12:01 +00:00
|
|
|
* ``'django.db.backends.postgresql_psycopg2'``
|
|
|
|
* ``'django.db.backends.mysql'``
|
|
|
|
* ``'django.db.backends.sqlite3'``
|
|
|
|
* ``'django.db.backends.oracle'``
|
2007-09-15 19:25:20 +00:00
|
|
|
|
2008-11-15 05:51:25 +00:00
|
|
|
You can use a database backend that doesn't ship with Django by setting
|
2009-12-22 15:18:51 +00:00
|
|
|
``ENGINE`` to a fully-qualified path (i.e.
|
2007-09-15 19:25:20 +00:00
|
|
|
``mypackage.backends.whatever``). Writing a whole new database backend from
|
2007-09-15 22:39:51 +00:00
|
|
|
scratch is left as an exercise to the reader; see the other backends for
|
|
|
|
examples.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: HOST
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
HOST
|
|
|
|
~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
Which host to use when connecting to the database. An empty string means
|
|
|
|
localhost. Not used with SQLite.
|
|
|
|
|
2006-05-02 01:31:56 +00:00
|
|
|
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::
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
"HOST": '/var/run/mysql'
|
2006-05-02 01:31:56 +00:00
|
|
|
|
|
|
|
If you're using MySQL and this value *doesn't* start with a forward slash, then
|
|
|
|
this value is assumed to be the host.
|
|
|
|
|
2012-12-11 21:30:07 +00:00
|
|
|
If you're using PostgreSQL, by default (empty :setting:`HOST`), the connection
|
|
|
|
to the database is done through UNIX domain sockets ('local' lines in
|
|
|
|
``pg_hba.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 sockets
|
|
|
|
are not available.
|
2007-05-27 11:33:57 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: NAME
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
NAME
|
|
|
|
~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The name of the database to use. For SQLite, it's the full path to the database
|
2009-06-18 13:33:18 +00:00
|
|
|
file. When specifying the path, always use forward slashes, even on Windows
|
2008-09-22 11:10:39 +00:00
|
|
|
(e.g. ``C:/homes/user/mysite/sqlite3.db``).
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-02-18 10:37:26 +00:00
|
|
|
.. setting:: CONN_MAX_AGE
|
|
|
|
|
|
|
|
CONN_MAX_AGE
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
|
2013-05-09 13:42:14 +00:00
|
|
|
Default: ``0``
|
2013-02-18 10:37:26 +00:00
|
|
|
|
|
|
|
The lifetime of a database connection, in seconds. Use ``0`` to close database
|
|
|
|
connections at the end of each request — Django's historical behavior — and
|
|
|
|
``None`` for unlimited persistent connections.
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: OPTIONS
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
OPTIONS
|
|
|
|
~~~~~~~
|
2006-11-07 05:17:38 +00:00
|
|
|
|
|
|
|
Default: ``{}`` (Empty dictionary)
|
|
|
|
|
2010-10-10 07:58:50 +00:00
|
|
|
Extra parameters to use when connecting to the database. Available parameters
|
|
|
|
vary depending on your database backend.
|
|
|
|
|
|
|
|
Some information on available parameters can be found in the
|
|
|
|
:doc:`Database Backends </ref/databases>` documentation. For more information,
|
|
|
|
consult your backend module's own documentation.
|
2006-11-07 05:17:38 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: PASSWORD
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
PASSWORD
|
|
|
|
~~~~~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The password to use when connecting to the database. Not used with SQLite.
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: PORT
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
PORT
|
|
|
|
~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The port to use when connecting to the database. An empty string means the
|
|
|
|
default port. Not used with SQLite.
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: USER
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
USER
|
|
|
|
~~~~
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The username to use when connecting to the database. Not used with SQLite.
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: TEST_CHARSET
|
|
|
|
|
|
|
|
TEST_CHARSET
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The character set encoding used to create the test database. The value of this
|
|
|
|
string is passed directly through to the database, so its format is
|
|
|
|
backend-specific.
|
|
|
|
|
2011-04-17 20:45:06 +00:00
|
|
|
Supported for the PostgreSQL_ (``postgresql_psycopg2``) and MySQL_ (``mysql``)
|
|
|
|
backends.
|
2009-12-22 15:18:51 +00:00
|
|
|
|
2013-03-17 10:45:45 +00:00
|
|
|
.. _PostgreSQL: http://www.postgresql.org/docs/current/static/multibyte.html
|
2009-12-26 06:37:26 +00:00
|
|
|
.. _MySQL: http://dev.mysql.com/doc/refman/5.0/en/charset-database.html
|
2009-12-22 15:18:51 +00:00
|
|
|
|
|
|
|
.. setting:: TEST_COLLATION
|
|
|
|
|
|
|
|
TEST_COLLATION
|
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The collation order to use when creating the test database. This value is
|
|
|
|
passed directly to the backend, so its format is backend-specific.
|
|
|
|
|
2009-12-26 06:37:26 +00:00
|
|
|
Only supported for the ``mysql`` backend (see the `MySQL manual`_ for details).
|
2009-12-22 15:18:51 +00:00
|
|
|
|
2009-12-26 06:37:26 +00:00
|
|
|
.. _MySQL manual: MySQL_
|
2009-12-22 15:18:51 +00:00
|
|
|
|
2010-12-05 01:03:39 +00:00
|
|
|
.. setting:: TEST_DEPENDENCIES
|
|
|
|
|
|
|
|
TEST_DEPENDENCIES
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``['default']``, for all databases other than ``default``,
|
|
|
|
which has no dependencies.
|
|
|
|
|
|
|
|
The creation-order dependencies of the database. See the documentation
|
|
|
|
on :ref:`controlling the creation order of test databases
|
|
|
|
<topics-testing-creation-dependencies>` for details.
|
|
|
|
|
2010-01-25 12:05:38 +00:00
|
|
|
.. setting:: TEST_MIRROR
|
|
|
|
|
|
|
|
TEST_MIRROR
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The alias of the database that this database should mirror during
|
|
|
|
testing.
|
|
|
|
|
|
|
|
This setting exists to allow for testing of master/slave
|
|
|
|
configurations of multiple databases. See the documentation on
|
|
|
|
:ref:`testing master/slave configurations
|
|
|
|
<topics-testing-masterslave>` for details.
|
|
|
|
|
2009-12-22 15:18:51 +00:00
|
|
|
.. setting:: TEST_NAME
|
|
|
|
|
|
|
|
TEST_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, the
|
|
|
|
tests will use a memory resident database. For all other database engines the
|
|
|
|
test database will use the name ``'test_' + DATABASE_NAME``.
|
|
|
|
|
2012-12-22 00:59:06 +00:00
|
|
|
See :ref:`the-test-database`.
|
2009-12-22 15:18:51 +00:00
|
|
|
|
2011-08-22 06:35:52 +00:00
|
|
|
.. setting:: TEST_CREATE
|
|
|
|
|
|
|
|
TEST_CREATE
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
If it is set to ``False``, the test tablespaces won't be automatically created
|
|
|
|
at the beginning of the tests and dropped at the end.
|
|
|
|
|
2010-08-23 08:07:35 +00:00
|
|
|
.. setting:: TEST_USER
|
|
|
|
|
|
|
|
TEST_USER
|
|
|
|
~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
The username to use when connecting to the Oracle database that will be used
|
2011-08-22 06:35:52 +00:00
|
|
|
when running tests. If not provided, Django will use ``'test_' + USER``.
|
|
|
|
|
2011-09-02 03:47:49 +00:00
|
|
|
.. setting:: TEST_USER_CREATE
|
2011-08-22 06:35:52 +00:00
|
|
|
|
2011-09-02 03:47:49 +00:00
|
|
|
TEST_USER_CREATE
|
2011-08-22 06:35:52 +00:00
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
If it is set to ``False``, the test user won't be automatically created at the
|
|
|
|
beginning of the tests and dropped at the end.
|
|
|
|
|
|
|
|
.. setting:: TEST_PASSWD
|
|
|
|
|
|
|
|
TEST_PASSWD
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
The password to use when connecting to the Oracle database that will be used
|
|
|
|
when running tests. If not provided, Django will use a hardcoded default value.
|
|
|
|
|
|
|
|
.. setting:: TEST_TBLSPACE
|
|
|
|
|
|
|
|
TEST_TBLSPACE
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
The name of the tablespace that will be used when running tests. If not
|
|
|
|
provided, Django will use ``'test_' + NAME``.
|
|
|
|
|
|
|
|
.. setting:: TEST_TBLSPACE_TMP
|
|
|
|
|
|
|
|
TEST_TBLSPACE_TMP
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
This is an Oracle-specific setting.
|
|
|
|
|
|
|
|
The name of the temporary tablespace that will be used when running tests. If
|
|
|
|
not provided, Django will use ``'test_' + NAME + '_temp'``.
|
2010-01-22 14:30:06 +00:00
|
|
|
|
|
|
|
.. setting:: DATABASE_ROUTERS
|
|
|
|
|
|
|
|
DATABASE_ROUTERS
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``[]`` (Empty list)
|
|
|
|
|
|
|
|
The list of routers that will be used to determine which database
|
|
|
|
to use when performing a database queries.
|
|
|
|
|
|
|
|
See the documentation on :ref:`automatic database routing in multi
|
|
|
|
database configurations <topics-db-multi-db-routing>`.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATE_FORMAT
|
|
|
|
|
2005-11-06 23:49:03 +00:00
|
|
|
DATE_FORMAT
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Default: ``'N j, Y'`` (e.g. ``Feb. 4, 2003``)
|
|
|
|
|
2010-02-26 17:05:52 +00:00
|
|
|
The default formatting to use for displaying date fields in any part of the
|
2010-05-09 04:23:43 +00:00
|
|
|
system. Note that if :setting:`USE_L10N` is set to ``True``, then the
|
2010-02-26 17:05:52 +00:00
|
|
|
locale-dictated format has higher precedence and will be applied instead. See
|
2010-10-23 14:52:01 +00:00
|
|
|
:tfilter:`allowed date format strings <date>`.
|
2010-02-26 17:05:52 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
|
|
|
.. setting:: DATE_INPUT_FORMATS
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
DATE_INPUT_FORMATS
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default::
|
|
|
|
|
2013-02-04 20:06:38 +00:00
|
|
|
(
|
|
|
|
'%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', # '2006-10-25', '10/25/2006', '10/25/06'
|
|
|
|
'%b %d %Y', '%b %d, %Y', # 'Oct 25 2006', 'Oct 25, 2006'
|
|
|
|
'%d %b %Y', '%d %b, %Y', # '25 Oct 2006', '25 Oct, 2006'
|
|
|
|
'%B %d %Y', '%B %d, %Y', # 'October 25 2006', 'October 25, 2006'
|
|
|
|
'%d %B %Y', '%d %B, %Y', # '25 October 2006', '25 October, 2006'
|
|
|
|
)
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2012-02-19 08:00:06 +00:00
|
|
|
A tuple of formats that will be accepted when inputting data on a date field.
|
2012-03-02 17:16:52 +00:00
|
|
|
Formats will be tried in order, using the first valid one. Note that these
|
|
|
|
format strings use Python's datetime_ module syntax, not the format strings
|
|
|
|
from the ``date`` Django template tag.
|
2012-02-19 08:00:06 +00:00
|
|
|
|
|
|
|
When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
|
|
|
|
precedence and will be applied instead.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATETIME_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2010-06-07 03:08:33 +00:00
|
|
|
.. _datetime: http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATETIME_FORMAT
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2005-11-06 23:49:03 +00:00
|
|
|
DATETIME_FORMAT
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: ``'N j, Y, P'`` (e.g. ``Feb. 4, 2003, 4 p.m.``)
|
|
|
|
|
2010-02-26 17:05:52 +00:00
|
|
|
The default formatting to use for displaying datetime fields in any part of the
|
2010-05-09 04:23:43 +00:00
|
|
|
system. Note that if :setting:`USE_L10N` is set to ``True``, then the
|
2010-02-26 17:05:52 +00:00
|
|
|
locale-dictated format has higher precedence and will be applied instead. See
|
2010-10-23 14:52:01 +00:00
|
|
|
:tfilter:`allowed date format strings <date>`.
|
2010-02-26 17:05:52 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: DATETIME_INPUT_FORMATS
|
|
|
|
|
|
|
|
DATETIME_INPUT_FORMATS
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
Default::
|
|
|
|
|
2013-02-04 20:06:38 +00:00
|
|
|
(
|
|
|
|
'%Y-%m-%d %H:%M:%S', # '2006-10-25 14:30:59'
|
|
|
|
'%Y-%m-%d %H:%M:%S.%f', # '2006-10-25 14:30:59.000200'
|
|
|
|
'%Y-%m-%d %H:%M', # '2006-10-25 14:30'
|
|
|
|
'%Y-%m-%d', # '2006-10-25'
|
|
|
|
'%m/%d/%Y %H:%M:%S', # '10/25/2006 14:30:59'
|
|
|
|
'%m/%d/%Y %H:%M:%S.%f', # '10/25/2006 14:30:59.000200'
|
|
|
|
'%m/%d/%Y %H:%M', # '10/25/2006 14:30'
|
|
|
|
'%m/%d/%Y', # '10/25/2006'
|
|
|
|
'%m/%d/%y %H:%M:%S', # '10/25/06 14:30:59'
|
|
|
|
'%m/%d/%y %H:%M:%S.%f', # '10/25/06 14:30:59.000200'
|
|
|
|
'%m/%d/%y %H:%M', # '10/25/06 14:30'
|
|
|
|
'%m/%d/%y', # '10/25/06'
|
|
|
|
)
|
2009-12-22 17:58:49 +00:00
|
|
|
|
|
|
|
A tuple of formats that will be accepted when inputting data on a datetime
|
2012-03-02 17:16:52 +00:00
|
|
|
field. Formats will be tried in order, using the first valid one. Note that
|
|
|
|
these format strings use Python's datetime_ module syntax, not the format
|
|
|
|
strings from the ``date`` Django template tag.
|
2012-02-19 08:00:06 +00:00
|
|
|
|
|
|
|
When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
|
|
|
|
precedence and will be applied instead.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATE_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2010-06-07 03:08:33 +00:00
|
|
|
.. _datetime: http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEBUG
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DEBUG
|
|
|
|
-----
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
A boolean that turns on/off debug mode.
|
|
|
|
|
2012-02-17 20:04:11 +00:00
|
|
|
Never deploy a site into production with :setting:`DEBUG` turned on.
|
|
|
|
|
|
|
|
Did you catch that? 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.
|
2012-08-16 00:13:28 +00:00
|
|
|
If your app raises an exception when :setting:`DEBUG` is ``True``, Django will
|
|
|
|
display a detailed traceback, including a lot of metadata about your
|
|
|
|
environment, such as all the currently defined Django settings (from
|
|
|
|
``settings.py``).
|
2012-02-17 20:04:11 +00:00
|
|
|
|
|
|
|
As a security measure, Django will *not* include settings that might be
|
2012-08-16 00:13:28 +00:00
|
|
|
sensitive (or offensive), such as :setting:`SECRET_KEY` or
|
|
|
|
:setting:`PROFANITIES_LIST`. Specifically, it will exclude any setting whose
|
|
|
|
name includes any of the following:
|
2012-02-17 20:04:11 +00:00
|
|
|
|
2013-01-11 19:15:17 +00:00
|
|
|
* ``'API'``
|
|
|
|
* ``'KEY'``
|
|
|
|
* ``'PASS'``
|
|
|
|
* ``'PROFANITIES_LIST'``
|
|
|
|
* ``'SECRET'``
|
|
|
|
* ``'SIGNATURE'``
|
|
|
|
* ``'TOKEN'``
|
2012-02-09 18:58:45 +00:00
|
|
|
|
2012-02-17 20:04:11 +00:00
|
|
|
Note that these are *partial* matches. ``'PASS'`` will also match PASSWORD,
|
|
|
|
just as ``'TOKEN'`` will also match TOKENIZED and so on.
|
2012-02-09 18:58:45 +00:00
|
|
|
|
|
|
|
Still, note that there are always going to be sections of your debug output
|
|
|
|
that are inappropriate for public consumption. File paths, configuration
|
2012-02-17 20:04:11 +00:00
|
|
|
options and the like all give attackers extra information about your server.
|
2008-06-19 12:13:43 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
It is also important to remember that when running with :setting:`DEBUG`
|
|
|
|
turned on, Django will remember every SQL query it executes. This is useful
|
2012-02-17 20:04:11 +00:00
|
|
|
when you're debugging, but it'll rapidly consume memory on a production server.
|
2007-02-26 21:22:21 +00:00
|
|
|
|
2013-06-09 19:05:15 +00:00
|
|
|
Finally, if :setting:`DEBUG` is ``False``, you also need to properly set
|
|
|
|
the :setting:`ALLOWED_HOSTS` setting. Failing to do so will result in all
|
|
|
|
requests being returned as "Bad Request (400)".
|
|
|
|
|
2012-05-03 15:42:56 +00:00
|
|
|
.. _django/views/debug.py: https://github.com/django/django/blob/master/django/views/debug.py
|
2008-09-07 23:08:01 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: DEBUG_PROPAGATE_EXCEPTIONS
|
|
|
|
|
2008-05-16 23:24:36 +00:00
|
|
|
DEBUG_PROPAGATE_EXCEPTIONS
|
2008-05-17 00:05:13 +00:00
|
|
|
--------------------------
|
2008-05-16 23:24:36 +00:00
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
If set to True, Django's normal exception handling of view functions
|
|
|
|
will be suppressed, and exceptions will propagate upwards. This can
|
|
|
|
be useful for some test setups, and should never be used on a live
|
|
|
|
site.
|
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: DECIMAL_SEPARATOR
|
|
|
|
|
|
|
|
DECIMAL_SEPARATOR
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Default: ``'.'`` (Dot)
|
|
|
|
|
|
|
|
Default decimal separator used when formatting decimal numbers.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2011-09-18 07:50:50 +00:00
|
|
|
Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
|
2011-09-08 13:25:17 +00:00
|
|
|
format has higher precedence and will be applied instead.
|
|
|
|
|
|
|
|
See also :setting:`NUMBER_GROUPING`, :setting:`THOUSAND_SEPARATOR` and
|
|
|
|
:setting:`USE_THOUSAND_SEPARATOR`.
|
|
|
|
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEFAULT_CHARSET
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DEFAULT_CHARSET
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: ``'utf-8'``
|
|
|
|
|
|
|
|
Default charset to use for all ``HttpResponse`` objects, if a MIME type isn't
|
2011-05-29 17:41:04 +00:00
|
|
|
manually specified. Used with :setting:`DEFAULT_CONTENT_TYPE` to construct the
|
2005-10-17 04:53:03 +00:00
|
|
|
``Content-Type`` header.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEFAULT_CONTENT_TYPE
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DEFAULT_CONTENT_TYPE
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``'text/html'``
|
|
|
|
|
|
|
|
Default content type to use for all ``HttpResponse`` objects, if a MIME type
|
2011-05-29 17:41:04 +00:00
|
|
|
isn't manually specified. Used with :setting:`DEFAULT_CHARSET` to construct
|
|
|
|
the ``Content-Type`` header.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2011-06-08 22:18:46 +00:00
|
|
|
.. 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 to
|
2012-12-25 08:40:08 +00:00
|
|
|
the :class:`~django.http.HttpRequest` instance yet.
|
2011-06-08 22:18:46 +00:00
|
|
|
See :ref:`Filtering error reports<filtering-error-reports>`.
|
|
|
|
|
2010-08-23 08:07:35 +00:00
|
|
|
.. setting:: DEFAULT_FILE_STORAGE
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2008-08-08 20:59:02 +00:00
|
|
|
DEFAULT_FILE_STORAGE
|
|
|
|
--------------------
|
|
|
|
|
2010-12-05 06:45:34 +00:00
|
|
|
Default: :class:`django.core.files.storage.FileSystemStorage`
|
2008-08-08 20:59:02 +00:00
|
|
|
|
|
|
|
Default file storage class to be used for any file-related operations that don't
|
2010-08-19 19:27:44 +00:00
|
|
|
specify a particular storage system. See :doc:`/topics/files`.
|
2008-08-08 20:59:02 +00:00
|
|
|
|
2010-08-23 08:07:35 +00:00
|
|
|
.. setting:: DEFAULT_FROM_EMAIL
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DEFAULT_FROM_EMAIL
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``'webmaster@localhost'``
|
|
|
|
|
2011-04-01 16:10:22 +00:00
|
|
|
Default email address to use for various automated correspondence from the
|
2005-10-17 04:53:03 +00:00
|
|
|
site manager(s).
|
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
.. setting:: DEFAULT_INDEX_TABLESPACE
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
DEFAULT_INDEX_TABLESPACE
|
|
|
|
------------------------
|
2007-12-01 19:23:49 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
Default tablespace to use for indexes on fields that don't specify
|
2011-10-14 21:49:43 +00:00
|
|
|
one, if the backend supports it (see :doc:`/topics/db/tablespaces`).
|
2007-12-01 19:23:49 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
.. setting:: DEFAULT_TABLESPACE
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
DEFAULT_TABLESPACE
|
|
|
|
------------------
|
2007-12-01 19:23:49 +00:00
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
Default tablespace to use for models that don't specify one, if the
|
2011-10-14 21:49:43 +00:00
|
|
|
backend supports it (see :doc:`/topics/db/tablespaces`).
|
2007-12-01 19:23:49 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DISALLOWED_USER_AGENTS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DISALLOWED_USER_AGENTS
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
List of compiled regular expression objects representing User-Agent strings that
|
|
|
|
are not allowed to visit any page, systemwide. Use this for bad robots/crawlers.
|
|
|
|
This is only used if ``CommonMiddleware`` is installed (see
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/topics/http/middleware`).
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2009-11-03 12:53:26 +00:00
|
|
|
.. setting:: EMAIL_BACKEND
|
|
|
|
|
|
|
|
EMAIL_BACKEND
|
|
|
|
-------------
|
|
|
|
|
2010-06-02 17:57:10 +00:00
|
|
|
Default: ``'django.core.mail.backends.smtp.EmailBackend'``
|
2009-11-03 12:53:26 +00:00
|
|
|
|
|
|
|
The backend to use for sending emails. For the list of available backends see
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/topics/email`.
|
2009-11-03 12:53:26 +00:00
|
|
|
|
|
|
|
.. setting:: EMAIL_FILE_PATH
|
|
|
|
|
|
|
|
EMAIL_FILE_PATH
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
|
|
|
The directory used by the ``file`` email backend to store output files.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_HOST
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
EMAIL_HOST
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``'localhost'``
|
|
|
|
|
2011-04-01 16:10:22 +00:00
|
|
|
The host to use for sending email.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`EMAIL_PORT`.
|
2006-04-11 03:23:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_HOST_PASSWORD
|
|
|
|
|
2006-03-22 19:47:15 +00:00
|
|
|
EMAIL_HOST_PASSWORD
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Password to use for the SMTP server defined in :setting:`EMAIL_HOST`. This
|
|
|
|
setting is used in conjunction with :setting:`EMAIL_HOST_USER` when
|
|
|
|
authenticating to the SMTP server. If either of these settings is empty,
|
|
|
|
Django won't attempt authentication.
|
2006-03-22 19:47:15 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`EMAIL_HOST_USER`.
|
2006-03-22 19:47:15 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_HOST_USER
|
|
|
|
|
2006-03-22 19:47:15 +00:00
|
|
|
EMAIL_HOST_USER
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Username to use for the SMTP server defined in :setting:`EMAIL_HOST`.
|
|
|
|
If empty, Django won't attempt authentication.
|
2006-03-22 19:47:15 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`EMAIL_HOST_PASSWORD`.
|
2006-03-22 19:47:15 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_PORT
|
|
|
|
|
2006-04-11 03:23:03 +00:00
|
|
|
EMAIL_PORT
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``25``
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Port to use for the SMTP server defined in :setting:`EMAIL_HOST`.
|
2006-04-11 03:23:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_SUBJECT_PREFIX
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
EMAIL_SUBJECT_PREFIX
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``'[Django] '``
|
|
|
|
|
2011-04-01 16:10:22 +00:00
|
|
|
Subject-line prefix for email messages sent with ``django.core.mail.mail_admins``
|
2005-10-17 04:53:03 +00:00
|
|
|
or ``django.core.mail.mail_managers``. You'll probably want to include the
|
|
|
|
trailing space.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_USE_TLS
|
|
|
|
|
2007-05-03 13:35:02 +00:00
|
|
|
EMAIL_USE_TLS
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
Whether to use a TLS (secure) connection when talking to the SMTP server.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: FILE_CHARSET
|
|
|
|
|
Merged Unicode branch into trunk (r4952:5608). This should be fully
backwards compatible for all practical purposes.
Fixed #2391, #2489, #2996, #3322, #3344, #3370, #3406, #3432, #3454, #3492, #3582, #3690, #3878, #3891, #3937, #4039, #4141, #4227, #4286, #4291, #4300, #4452, #4702
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5609 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-07-04 12:11:04 +00:00
|
|
|
FILE_CHARSET
|
|
|
|
------------
|
|
|
|
|
|
|
|
Default: ``'utf-8'``
|
|
|
|
|
|
|
|
The character encoding used to decode any files read from disk. This includes
|
|
|
|
template files and initial SQL data files.
|
|
|
|
|
2008-08-27 22:21:14 +00:00
|
|
|
.. setting:: FILE_UPLOAD_HANDLERS
|
|
|
|
|
2008-07-01 15:10:51 +00:00
|
|
|
FILE_UPLOAD_HANDLERS
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default::
|
|
|
|
|
2008-07-30 03:19:31 +00:00
|
|
|
("django.core.files.uploadhandler.MemoryFileUploadHandler",
|
|
|
|
"django.core.files.uploadhandler.TemporaryFileUploadHandler",)
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
A tuple of handlers to use for uploading. See :doc:`/topics/files` for details.
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2008-08-27 22:21:14 +00:00
|
|
|
.. setting:: FILE_UPLOAD_MAX_MEMORY_SIZE
|
|
|
|
|
2008-07-01 15:10:51 +00:00
|
|
|
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 to
|
2010-08-19 19:27:44 +00:00
|
|
|
the file system. See :doc:`/topics/files` for details.
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2008-08-27 22:21:14 +00:00
|
|
|
.. setting:: FILE_UPLOAD_PERMISSIONS
|
|
|
|
|
|
|
|
FILE_UPLOAD_PERMISSIONS
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The numeric mode (i.e. ``0644``) to set newly uploaded files to. For
|
2011-09-04 21:17:30 +00:00
|
|
|
more information about what these modes mean, see the documentation for
|
|
|
|
:func:`os.chmod`.
|
2008-08-27 22:21:14 +00:00
|
|
|
|
|
|
|
If this isn't given or is ``None``, you'll get operating-system
|
|
|
|
dependent behavior. On most platforms, temporary files will have a mode
|
|
|
|
of ``0600``, and files saved from memory will be saved using the
|
|
|
|
system's standard umask.
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
|
|
**Always prefix the mode with a 0.**
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2008-08-27 22:21:14 +00:00
|
|
|
If you're not familiar with file modes, please note that the leading
|
|
|
|
``0`` is very important: it indicates an octal number, which is the
|
|
|
|
way that modes must be specified. If you try to use ``644``, you'll
|
|
|
|
get totally incorrect behavior.
|
|
|
|
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
.. setting:: FILE_UPLOAD_TEMP_DIR
|
|
|
|
|
|
|
|
FILE_UPLOAD_TEMP_DIR
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The directory to store data temporarily while uploading files. If ``None``,
|
|
|
|
Django will use the standard temporary directory for the operating system. For
|
|
|
|
example, this will default to '/tmp' on \*nix-style operating systems.
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See :doc:`/topics/files` for details.
|
2010-08-07 02:43:14 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: FIRST_DAY_OF_WEEK
|
|
|
|
|
|
|
|
FIRST_DAY_OF_WEEK
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Default: ``0`` (Sunday)
|
|
|
|
|
|
|
|
Number representing the first day of the week. This is especially useful
|
|
|
|
when displaying a calendar. This value is only used when not using
|
|
|
|
format internationalization, or when a format cannot be found for the
|
|
|
|
current locale.
|
|
|
|
|
|
|
|
The value must be an integer from 0 to 6, where 0 means Sunday, 1 means
|
|
|
|
Monday and so on.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: FIXTURE_DIRS
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2007-03-01 13:11:08 +00:00
|
|
|
FIXTURE_DIRS
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
2012-02-19 09:02:52 +00:00
|
|
|
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`.
|
2007-03-01 13:11:08 +00:00
|
|
|
|
2012-12-25 08:40:08 +00:00
|
|
|
.. setting:: FORCE_SCRIPT_NAME
|
|
|
|
|
2008-07-21 07:57:10 +00:00
|
|
|
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 override
|
|
|
|
the server-provided value of ``SCRIPT_NAME``, which may be a rewritten version
|
|
|
|
of the preferred value or not supplied at all.
|
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: FORMAT_MODULE_PATH
|
|
|
|
|
|
|
|
FORMAT_MODULE_PATH
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
A full Python path to a Python package that contains format definitions for
|
|
|
|
project locales. If not ``None``, Django will check for a ``formats.py``
|
|
|
|
file, under the directory named as the current locale, and will use the
|
|
|
|
formats defined on this file.
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
For example, if :setting:`FORMAT_MODULE_PATH` is set to ``mysite.formats``,
|
|
|
|
and current language is ``en`` (English), Django will expect a directory tree
|
2009-12-22 17:58:49 +00:00
|
|
|
like::
|
|
|
|
|
|
|
|
mysite/
|
|
|
|
formats/
|
|
|
|
__init__.py
|
|
|
|
en/
|
|
|
|
__init__.py
|
|
|
|
formats.py
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Available formats are :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT`,
|
|
|
|
:setting:`DATETIME_FORMAT`, :setting:`YEAR_MONTH_FORMAT`,
|
|
|
|
:setting:`MONTH_DAY_FORMAT`, :setting:`SHORT_DATE_FORMAT`,
|
|
|
|
:setting:`SHORT_DATETIME_FORMAT`, :setting:`FIRST_DAY_OF_WEEK`,
|
|
|
|
:setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and
|
|
|
|
:setting:`NUMBER_GROUPING`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-05-05 20:49:26 +00:00
|
|
|
.. setting:: IGNORABLE_404_URLS
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2011-05-05 20:49:26 +00:00
|
|
|
IGNORABLE_404_URLS
|
2005-10-17 04:53:03 +00:00
|
|
|
------------------
|
|
|
|
|
2011-05-05 20:49:26 +00:00
|
|
|
Default: ``()``
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2011-05-05 20:49:26 +00:00
|
|
|
List of compiled regular expression objects describing URLs that should be
|
|
|
|
ignored when reporting HTTP 404 errors via email (see
|
2012-12-07 16:39:36 +00:00
|
|
|
:doc:`/howto/error-reporting`). Regular expressions are matched against
|
|
|
|
:meth:`request's full paths <django.http.HttpRequest.get_full_path>` (including
|
|
|
|
query string, if any). Use this if your site does not provide a commonly
|
|
|
|
requested file such as ``favicon.ico`` or ``robots.txt``, or if it gets
|
|
|
|
hammered by script kiddies.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-01 21:28:48 +00:00
|
|
|
This is only used if
|
|
|
|
:class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled (see
|
|
|
|
:doc:`/topics/http/middleware`).
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: INSTALLED_APPS
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2005-11-11 03:25:52 +00:00
|
|
|
INSTALLED_APPS
|
|
|
|
--------------
|
|
|
|
|
2005-11-11 22:56:18 +00:00
|
|
|
Default: ``()`` (Empty tuple)
|
2005-11-11 03:25:52 +00:00
|
|
|
|
|
|
|
A tuple of strings designating all applications that are enabled in this Django
|
|
|
|
installation. Each string should be a full Python path to a Python package that
|
2008-08-23 22:25:40 +00:00
|
|
|
contains a Django application, as created by :djadmin:`django-admin.py startapp
|
|
|
|
<startapp>`.
|
2005-11-11 03:25:52 +00:00
|
|
|
|
2010-05-10 14:04:16 +00:00
|
|
|
.. admonition:: App names must be unique
|
|
|
|
|
|
|
|
The application names (that is, the final dotted part of the
|
|
|
|
path to the module containing ``models.py``) defined in
|
|
|
|
:setting:`INSTALLED_APPS` *must* be unique. For example, you can't
|
|
|
|
include both ``django.contrib.auth`` and ``myproject.auth`` in
|
|
|
|
INSTALLED_APPS.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: INTERNAL_IPS
|
2005-11-11 03:25:52 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
INTERNAL_IPS
|
|
|
|
------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
|
|
|
A tuple of IP addresses, as strings, that:
|
|
|
|
|
2011-10-14 00:12:01 +00:00
|
|
|
* See debug comments, when :setting:`DEBUG` is ``True``
|
2013-05-18 15:43:21 +00:00
|
|
|
* Receive X headers in admindocs if the ``XViewMiddleware`` is installed (see
|
2011-10-14 00:12:01 +00:00
|
|
|
:doc:`/topics/http/middleware`)
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: LANGUAGE_CODE
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
LANGUAGE_CODE
|
|
|
|
-------------
|
|
|
|
|
2005-11-06 22:22:02 +00:00
|
|
|
Default: ``'en-us'``
|
2005-10-17 04:53:03 +00:00
|
|
|
|
Simplified default project template.
Squashed commit of:
commit 508ec9144b35c50794708225b496bde1eb5e60aa
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 22:50:55 2013 +0100
Tweaked default settings file.
* Explained why BASE_DIR exists.
* Added a link to the database configuration options, and put it in its
own section.
* Moved sensitive settings that must be changed for production at the
top.
commit 6515fd2f1aa73a86dc8dbd2ccf512ddb6b140d57
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 14:35:21 2013 +0100
Documented the simplified app & project templates in the changelog.
commit 2c5b576c2ea91d84273a019b3d0b3b8b4da72f23
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:59:27 2013 +0100
Minor fixes in tutorials 5 and 6.
commit 55a51531be8104f21b3cca3f6bf70b0a7139a041
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:51:11 2013 +0100
Updated tutorial 2 for the new project template.
commit 29ddae87bdaecff12dd31b16b000c01efbde9e20
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:58:54 2013 +0100
Updated tutorial 1 for the new project template.
commit 0ecb9f6e2514cfd26a678a280d471433375101a3
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:29:13 2013 +0100
Adjusted the default URLconf detection to account for the admin.
It's now enabled by default.
commit 5fb4da0d3d09dac28dd94e3fde92b9d4335c0565
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 10:36:55 2013 +0100
Added security warnings for the most sensitive settings.
commit 718d84bd8ac4a42fb4b28ec93965de32680f091e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:24:06 2013 +0100
Used an absolute path for the SQLite database.
This ensures the settings file works regardless of which directory
django-admin.py / manage.py is invoked from.
BASE_DIR got a +1 from a BDFL and another core dev. It doesn't involve
the concept of a "Django project"; it's just a convenient way to express
relative paths within the source code repository for non-Python files.
Thanks Jacob Kaplan-Moss for the suggestion.
commit 1b559b4bcda622e10909b68fe5cab90db6727dd9
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:22:40 2013 +0100
Removed STATIC_ROOT from the default settings template.
It isn't necessary in development, and it confuses beginners to no end.
Thanks Carl Meyer for the suggestion.
commit a55f141a500bb7c9a1bc259bbe1954c13b199671
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:21:43 2013 +0100
Removed MEDIA_ROOT/URL from default settings template.
Many sites will never deal with user-uploaded files, and MEDIA_ROOT is
complicated to explain.
Thanks Carl Meyer for the suggestion.
commit 44bf2f2441420fd9429ee9fe1f7207f92dd87e70
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:22:09 2013 +0100
Removed logging config.
This configuration is applied regardless of the value of LOGGING;
duplicating it in LOGGING is confusing.
commit eac747e848eaed65fd5f6f254f0a7559d856f88f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:05:31 2013 +0100
Enabled the locale middleware by default.
USE_I18N is True by default, and doesn't work well without
LocaleMiddleware.
commit d806c62b2d00826dc2688c84b092627b8d571cab
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:03:16 2013 +0100
Enabled clickjacking protection by default.
commit 99152c30e6a15003f0b6737dc78e87adf462aacb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:01:48 2013 +0100
Reorganized settings in logical sections, and trimmed comments.
commit d37ffdfcb24b7e0ec7cc113d07190f65fb12fb8a
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:54:11 2013 +0100
Avoided misleading TEMPLATE_DEBUG = DEBUG.
According to the docs TEMPLATE_DEBUG works only when DEBUG = True.
commit 15d9478d3a9850e85841e7cf09cf83050371c6bf
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:46:25 2013 +0100
Removed STATICFILES_FINDERS/TEMPLATE_LOADERS from default settings file.
Only developers with special needs ever need to change these settings.
commit 574da0eb5bfb4570883756914b4dbd7e20e1f61e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:45:01 2013 +0100
Removed STATICFILES/TEMPLATES_DIRS from default settings file.
The current best practice is to put static files and templates in
applications, for easier testing and deployment.
commit 8cb18dbe56629aa1be74718a07e7cc66b4f9c9f0
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:24:16 2013 +0100
Removed settings related to email reporting from default settings file.
While handy for small scale projects, it isn't exactly a best practice.
commit 8ecbfcb3638058f0c49922540f874a7d802d864f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 18:54:43 2013 +0100
Documented how to enable the sites framework.
commit 23fc91a6fa67d91ddd9d71b1c3e0dc26bdad9841
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:28:59 2013 +0100
Disabled the sites framework by default.
RequestSite does the job for single-domain websites.
commit c4d82eb8afc0eb8568bf9c4d12644272415e3960
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 00:08:33 2013 +0100
Added a default admin.py to the application template.
Thanks Ryan D Hiebert for the suggestion.
commit 4071dc771e5c44b1c5ebb9beecefb164ae465e22
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:59:49 2013 +0100
Enabled the admin by default.
Everyone uses the admin.
commit c807a31f8d89e7e7fd97380e3023f7983a8b6fcb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:57:05 2013 +0100
Removed admindocs from default project template.
commit 09e4ce0e652a97da1a9e285046a91c8ad7a9189c
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:32:52 2013 +0100
Added links to the settings documentation.
commit 5b8f5eaef364eb790fcde6f9e86f7d266074cca8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 11:06:54 2013 +0100
Used a significant example for URLconf includes.
commit 908e91d6fcee2a3cb51ca26ecdf12a6a24e69ef8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:22:31 2013 +0100
Moved code comments about WSGI to docs, and rewrote said docs.
commit 50417e51996146f891d08ca8b74dcc736a581932
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 15:51:50 2013 +0100
Normalized the default application template.
Removed the default test that 1 + 1 = 2, because it's been committed
way too many times, in too many projects.
Added an import of `render` for views, because the first view will
often be:
def home(request):
return render(request, "mysite/home.html")
2013-01-28 14:51:50 +00:00
|
|
|
A string representing the language code for this installation. This should be
|
|
|
|
in standard :term:`language format<language code>`. For example, U.S. English
|
|
|
|
is ``"en-us"``. See also the `list of language identifiers`_ and
|
|
|
|
:doc:`/topics/i18n/index`.
|
|
|
|
|
|
|
|
.. _list of language identifiers: http://www.i18nguy.com/unicode/language-identifiers.html
|
2005-11-06 22:22:02 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: LANGUAGE_COOKIE_NAME
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-02-29 18:38:44 +00:00
|
|
|
LANGUAGE_COOKIE_NAME
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``'django_language'``
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
The name of the cookie to use for the language cookie. This can be whatever
|
|
|
|
you want (but should be different from :setting:`SESSION_COOKIE_NAME`). See
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/topics/i18n/index`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: LANGUAGES
|
2008-02-29 18:38:44 +00:00
|
|
|
|
2005-11-12 21:36:38 +00:00
|
|
|
LANGUAGES
|
|
|
|
---------
|
|
|
|
|
2007-05-01 02:13:34 +00:00
|
|
|
Default: A tuple of all available languages. This list is continually growing
|
|
|
|
and including a copy here would inevitably become rapidly out of date. You can
|
|
|
|
see the current list of translated languages by looking in
|
|
|
|
``django/conf/global_settings.py`` (or view the `online source`_).
|
|
|
|
|
2012-05-03 15:42:56 +00:00
|
|
|
.. _online source: https://github.com/django/django/blob/master/django/conf/global_settings.py
|
2007-05-01 02:13:34 +00:00
|
|
|
|
2013-04-29 17:40:03 +00:00
|
|
|
The list is a tuple of two-tuples in the format
|
|
|
|
(:term:`language code<language code>`, ``language name``) -- for example,
|
|
|
|
``('ja', 'Japanese')``.
|
2010-02-16 12:12:53 +00:00
|
|
|
This specifies which languages are available for language selection. See
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/topics/i18n/index`.
|
2005-11-13 00:19:16 +00:00
|
|
|
|
|
|
|
Generally, the default value should suffice. Only set this setting if you want
|
|
|
|
to restrict language selection to a subset of the Django-provided languages.
|
2005-11-12 21:36:38 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
If you define a custom :setting:`LANGUAGES` setting, it's OK to mark the
|
|
|
|
languages as translation strings (as in the default value referred to above)
|
|
|
|
-- but use a "dummy" ``gettext()`` function, not the one in
|
|
|
|
``django.utils.translation``. You should *never* import
|
|
|
|
``django.utils.translation`` from within your settings file, because that
|
|
|
|
module in itself depends on the settings, and that would cause a circular
|
|
|
|
import.
|
2006-07-11 02:49:56 +00:00
|
|
|
|
|
|
|
The solution is to use a "dummy" ``gettext()`` function. Here's a sample
|
|
|
|
settings file::
|
|
|
|
|
|
|
|
gettext = lambda s: s
|
|
|
|
|
|
|
|
LANGUAGES = (
|
|
|
|
('de', gettext('German')),
|
|
|
|
('en', gettext('English')),
|
|
|
|
)
|
|
|
|
|
2008-07-06 06:39:44 +00:00
|
|
|
With this arrangement, ``django-admin.py makemessages`` will still find and
|
|
|
|
mark these strings for translation, but the translation won't happen at
|
|
|
|
runtime -- so you'll have to remember to wrap the languages in the *real*
|
2011-05-29 17:41:04 +00:00
|
|
|
``gettext()`` in any code that uses :setting:`LANGUAGES` at runtime.
|
2006-07-11 02:49:56 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: LOCALE_PATHS
|
|
|
|
|
2007-10-19 03:18:15 +00:00
|
|
|
LOCALE_PATHS
|
|
|
|
------------
|
|
|
|
|
2007-10-19 06:53:30 +00:00
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
2007-11-19 05:59:58 +00:00
|
|
|
A tuple of directories where Django looks for translation files.
|
2011-10-22 17:17:57 +00:00
|
|
|
See :ref:`how-django-discovers-translations`.
|
2007-10-19 03:18:15 +00:00
|
|
|
|
2011-02-07 18:48:40 +00:00
|
|
|
Example::
|
|
|
|
|
|
|
|
LOCALE_PATHS = (
|
|
|
|
'/home/www/project/common_files/locale',
|
|
|
|
'/var/local/translations/locale'
|
|
|
|
)
|
|
|
|
|
2012-12-03 15:46:48 +00:00
|
|
|
Django will look within each of these paths for the ``<locale_code>/LC_MESSAGES``
|
|
|
|
directories containing the actual translation files.
|
2011-02-07 18:48:40 +00:00
|
|
|
|
2010-10-05 00:11:41 +00:00
|
|
|
.. setting:: LOGGING
|
2007-10-19 03:18:15 +00:00
|
|
|
|
2010-10-04 15:12:39 +00:00
|
|
|
LOGGING
|
|
|
|
-------
|
|
|
|
|
|
|
|
Default: A logging configuration dictionary.
|
|
|
|
|
|
|
|
A data structure containing configuration information. The contents of
|
|
|
|
this data structure will be passed as the argument to the
|
|
|
|
configuration method described in :setting:`LOGGING_CONFIG`.
|
|
|
|
|
|
|
|
The default logging configuration passes HTTP 500 server errors to an
|
|
|
|
email log handler; all other log messages are given to a NullHandler.
|
|
|
|
|
2010-10-05 00:11:41 +00:00
|
|
|
.. setting:: LOGGING_CONFIG
|
2010-10-04 15:12:39 +00:00
|
|
|
|
|
|
|
LOGGING_CONFIG
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Default: ``'django.utils.log.dictConfig'``
|
|
|
|
|
|
|
|
A path to a callable that will be used to configure logging in the
|
|
|
|
Django project. Points at a instance of Python's `dictConfig`_
|
|
|
|
configuration method by default.
|
|
|
|
|
|
|
|
If you set :setting:`LOGGING_CONFIG` to ``None``, the logging
|
|
|
|
configuration process will be skipped.
|
|
|
|
|
2011-04-24 23:53:24 +00:00
|
|
|
.. _dictConfig: http://docs.python.org/library/logging.config.html#configuration-dictionary-schema
|
2010-10-04 15:12:39 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MANAGERS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MANAGERS
|
|
|
|
--------
|
|
|
|
|
2006-10-24 16:38:48 +00:00
|
|
|
Default: ``()`` (Empty tuple)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
A tuple in the same format as :setting:`ADMINS` that specifies who should get
|
2013-01-01 21:28:48 +00:00
|
|
|
broken link notifications when
|
|
|
|
:class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MEDIA_ROOT
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MEDIA_ROOT
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2012-08-25 12:25:34 +00:00
|
|
|
Absolute filesystem path to the directory that will hold :doc:`user-uploaded
|
|
|
|
files </topics/files>`.
|
2010-11-11 21:43:49 +00:00
|
|
|
|
2012-06-07 09:50:20 +00:00
|
|
|
Example: ``"/var/www/example.com/media/"``
|
2010-11-11 21:43:49 +00:00
|
|
|
|
|
|
|
See also :setting:`MEDIA_URL`.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MEDIA_URL
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MEDIA_URL
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2010-11-11 21:43:49 +00:00
|
|
|
URL that handles the media served from :setting:`MEDIA_ROOT`, used
|
2012-09-19 20:39:14 +00:00
|
|
|
for :doc:`managing stored files </topics/files>`. It must end in a slash if set
|
|
|
|
to a non-empty value.
|
2010-11-11 21:43:49 +00:00
|
|
|
|
2012-06-07 09:50:20 +00:00
|
|
|
Example: ``"http://media.example.com/"``
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2010-11-11 21:43:49 +00:00
|
|
|
.. setting:: MIDDLEWARE_CLASSES
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MIDDLEWARE_CLASSES
|
|
|
|
------------------
|
|
|
|
|
2005-11-09 17:39:18 +00:00
|
|
|
Default::
|
|
|
|
|
2009-03-23 23:20:40 +00:00
|
|
|
('django.middleware.common.CommonMiddleware',
|
|
|
|
'django.contrib.sessions.middleware.SessionMiddleware',
|
2009-10-27 00:36:34 +00:00
|
|
|
'django.middleware.csrf.CsrfViewMiddleware',
|
2009-12-09 16:57:23 +00:00
|
|
|
'django.contrib.auth.middleware.AuthenticationMiddleware',
|
|
|
|
'django.contrib.messages.middleware.MessageMiddleware',)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
A tuple of middleware classes to use. See :doc:`/topics/http/middleware`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: MONTH_DAY_FORMAT
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2006-06-02 04:20:32 +00:00
|
|
|
MONTH_DAY_FORMAT
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``'F j'``
|
|
|
|
|
|
|
|
The default formatting to use for date fields on Django admin change-list
|
|
|
|
pages -- and, possibly, by other parts of the system -- in cases when only the
|
|
|
|
month and day are displayed.
|
|
|
|
|
|
|
|
For example, when a Django admin change-list page is being filtered by a date
|
|
|
|
drilldown, the header for a given day displays the day and month. Different
|
|
|
|
locales have different formats. For example, U.S. English would say
|
|
|
|
"January 1," whereas Spanish might say "1 Enero."
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See :tfilter:`allowed date format strings <date>`. See also
|
|
|
|
:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`,
|
|
|
|
:setting:`TIME_FORMAT` and :setting:`YEAR_MONTH_FORMAT`.
|
2006-06-02 04:20:32 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: NUMBER_GROUPING
|
|
|
|
|
|
|
|
NUMBER_GROUPING
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``0``
|
|
|
|
|
2011-09-08 13:25:17 +00:00
|
|
|
Number of digits grouped together on the integer part of a number.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-09-08 13:25:17 +00:00
|
|
|
Common use is to display a thousand separator. If this setting is ``0``, then
|
|
|
|
no grouping will be applied to the number. If this setting is greater than
|
|
|
|
``0``, then :setting:`THOUSAND_SEPARATOR` will be used as the separator between
|
|
|
|
those groups.
|
|
|
|
|
2011-09-18 07:50:50 +00:00
|
|
|
Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
|
2011-09-08 13:25:17 +00:00
|
|
|
format has higher precedence and will be applied instead.
|
|
|
|
|
|
|
|
See also :setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and
|
|
|
|
:setting:`USE_THOUSAND_SEPARATOR`.
|
2010-11-02 11:53:01 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: PREPEND_WWW
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
PREPEND_WWW
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
Whether to prepend the "www." subdomain to URLs that don't have it. This is only
|
2010-10-10 06:36:38 +00:00
|
|
|
used if :class:`~django.middleware.common.CommonMiddleware` is installed
|
|
|
|
(see :doc:`/topics/http/middleware`). See also :setting:`APPEND_SLASH`.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-09-17 07:59:05 +00:00
|
|
|
.. setting:: ROOT_URLCONF
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2006-01-12 04:41:40 +00:00
|
|
|
ROOT_URLCONF
|
|
|
|
------------
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
|
|
|
A string representing the full Python import path to your root URLconf. For example:
|
2008-03-18 20:58:39 +00:00
|
|
|
``"mydjangoapps.urls"``. Can be overridden on a per-request basis by
|
|
|
|
setting the attribute ``urlconf`` on the incoming ``HttpRequest``
|
2008-08-23 22:25:40 +00:00
|
|
|
object. See :ref:`how-django-processes-a-request` for details.
|
2006-01-12 04:41:40 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: SECRET_KEY
|
2006-01-12 04:41:40 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
SECRET_KEY
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2012-08-13 12:10:40 +00:00
|
|
|
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.py startproject <startproject>` automatically adds a
|
|
|
|
randomly-generated ``SECRET_KEY`` to each new project.
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
|
|
**Keep this value secret.**
|
|
|
|
|
|
|
|
Running Django with a known :setting:`SECRET_KEY` defeats many of Django's
|
|
|
|
security protections, and can lead to privilege escalation and remote code
|
|
|
|
execution vulnerabilities.
|
|
|
|
|
|
|
|
.. versionchanged:: 1.5
|
2013-03-25 05:53:48 +00:00
|
|
|
|
2012-08-13 12:10:40 +00:00
|
|
|
Django will now refuse to start if :setting:`SECRET_KEY` is not set.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2011-12-30 21:13:08 +00:00
|
|
|
.. setting:: SECURE_PROXY_SSL_HEADER
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2011-12-16 22:06:06 +00:00
|
|
|
SECURE_PROXY_SSL_HEADER
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
A tuple representing a HTTP header/value combination that signifies a request
|
|
|
|
is secure. This controls the behavior of the request object's ``is_secure()``
|
|
|
|
method.
|
|
|
|
|
|
|
|
This takes some explanation. By default, ``is_secure()`` is able to determine
|
|
|
|
whether a request is secure by looking at whether the requested URL uses
|
2012-06-04 19:39:57 +00:00
|
|
|
"https://". This is important for Django's CSRF protection, and may be used
|
|
|
|
by your own code or third-party apps.
|
2011-12-16 22:06:06 +00:00
|
|
|
|
|
|
|
If your Django app is behind a proxy, though, the proxy may be "swallowing" the
|
|
|
|
fact that a request is HTTPS, using a non-HTTPS connection between the proxy
|
|
|
|
and Django. In this case, ``is_secure()`` would always return ``False`` -- even
|
|
|
|
for requests that were made via HTTPS by the end user.
|
|
|
|
|
|
|
|
In this situation, you'll want to configure your proxy to set a custom HTTP
|
|
|
|
header that tells Django whether the request came in via HTTPS, and you'll want
|
|
|
|
to set ``SECURE_PROXY_SSL_HEADER`` so that Django knows what header to look
|
|
|
|
for.
|
|
|
|
|
|
|
|
You'll need to set a tuple with two elements -- the name of the header to look
|
|
|
|
for and the required value. For example::
|
|
|
|
|
2012-11-06 10:16:01 +00:00
|
|
|
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
|
2011-12-16 22:06:06 +00:00
|
|
|
|
2012-11-06 10:16:01 +00:00
|
|
|
Here, we're telling Django that we trust the ``X-Forwarded-Proto`` header
|
2011-12-16 22:06:06 +00:00
|
|
|
that comes from our proxy, and any time its value is ``'https'``, then the
|
|
|
|
request is guaranteed to be secure (i.e., it originally came in via HTTPS).
|
|
|
|
Obviously, you should *only* set this setting if you control your proxy or
|
|
|
|
have some other guarantee that it sets/strips this header appropriately.
|
|
|
|
|
|
|
|
Note that the header needs to be in the format as used by ``request.META`` --
|
|
|
|
all caps and likely starting with ``HTTP_``. (Remember, Django automatically
|
|
|
|
adds ``'HTTP_'`` to the start of x-header names before making the header
|
|
|
|
available in ``request.META``.)
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
2012-11-06 10:16:01 +00:00
|
|
|
**You will probably open security holes in your site if you set this
|
|
|
|
without knowing what you're doing. And if you fail to set it when you
|
|
|
|
should. Seriously.**
|
2011-12-16 22:06:06 +00:00
|
|
|
|
|
|
|
Make sure ALL of the following are true before setting this (assuming the
|
|
|
|
values from the example above):
|
|
|
|
|
|
|
|
* Your Django app is behind a proxy.
|
2012-11-06 10:16:01 +00:00
|
|
|
* Your proxy strips the ``X-Forwarded-Proto`` header from all incoming
|
2011-12-16 22:06:06 +00:00
|
|
|
requests. In other words, if end users include that header in their
|
|
|
|
requests, the proxy will discard it.
|
2012-11-06 10:16:01 +00:00
|
|
|
* Your proxy sets the ``X-Forwarded-Proto`` header and sends it to Django,
|
2011-12-16 22:06:06 +00:00
|
|
|
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.
|
|
|
|
|
2011-12-30 21:13:08 +00:00
|
|
|
.. setting:: SEND_BROKEN_LINK_EMAILS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
SEND_BROKEN_LINK_EMAILS
|
|
|
|
-----------------------
|
|
|
|
|
2013-01-01 21:28:48 +00:00
|
|
|
.. deprecated:: 1.6
|
|
|
|
Since :class:`~django.middleware.common.BrokenLinkEmailsMiddleware`
|
|
|
|
was split from :class:`~django.middleware.common.CommonMiddleware`,
|
|
|
|
this setting no longer serves a purpose.
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
Default: ``False``
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Whether to send an email to the :setting:`MANAGERS` each time somebody visits
|
|
|
|
a Django-powered page that is 404ed with a non-empty referer (i.e., a broken
|
2008-08-23 22:25:40 +00:00
|
|
|
link). This is only used if ``CommonMiddleware`` is installed (see
|
2011-05-29 17:41:04 +00:00
|
|
|
:doc:`/topics/http/middleware`). See also :setting:`IGNORABLE_404_URLS` and
|
2011-05-05 20:49:26 +00:00
|
|
|
:doc:`/howto/error-reporting`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: SERIALIZATION_MODULES
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2007-03-01 13:11:08 +00:00
|
|
|
SERIALIZATION_MODULES
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
Default: Not defined.
|
|
|
|
|
2007-10-20 05:13:56 +00:00
|
|
|
A dictionary of modules containing serializer definitions (provided as
|
|
|
|
strings), keyed by a string identifier for that serialization type. For
|
2007-03-01 13:11:08 +00:00
|
|
|
example, to define a YAML serializer, use::
|
|
|
|
|
|
|
|
SERIALIZATION_MODULES = { 'yaml' : 'path.to.yaml_serializer' }
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: SERVER_EMAIL
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
SERVER_EMAIL
|
|
|
|
------------
|
|
|
|
|
|
|
|
Default: ``'root@localhost'``
|
|
|
|
|
2011-04-01 16:10:22 +00:00
|
|
|
The email address that error messages come from, such as those sent to
|
2011-05-29 17:41:04 +00:00
|
|
|
:setting:`ADMINS` and :setting:`MANAGERS`.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: SHORT_DATE_FORMAT
|
2007-09-15 21:29:14 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
SHORT_DATE_FORMAT
|
|
|
|
-----------------
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default: ``m/d/Y`` (e.g. ``12/31/2003``)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
An available formatting that can be used for displaying date fields on
|
|
|
|
templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
|
|
|
|
corresponding locale-dictated format has higher precedence and will be applied.
|
|
|
|
See :tfilter:`allowed date format strings <date>`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: SHORT_DATETIME_FORMAT
|
|
|
|
|
|
|
|
SHORT_DATETIME_FORMAT
|
2005-10-17 04:53:03 +00:00
|
|
|
---------------------
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default: ``m/d/Y P`` (e.g. ``12/31/2003 4 p.m.``)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
An available formatting that can be used for displaying datetime fields on
|
|
|
|
templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
|
|
|
|
corresponding locale-dictated format has higher precedence and will be applied.
|
|
|
|
See :tfilter:`allowed date format strings <date>`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: SIGNING_BACKEND
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
SIGNING_BACKEND
|
|
|
|
---------------
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default: 'django.core.signing.TimestampSigner'
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
The backend used for signing cookies and other data.
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See also the :doc:`/topics/signing` documentation.
|
2010-11-26 13:30:50 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: TEMPLATE_CONTEXT_PROCESSORS
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
TEMPLATE_CONTEXT_PROCESSORS
|
|
|
|
---------------------------
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default::
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
("django.contrib.auth.context_processors.auth",
|
|
|
|
"django.core.context_processors.debug",
|
|
|
|
"django.core.context_processors.i18n",
|
|
|
|
"django.core.context_processors.media",
|
|
|
|
"django.core.context_processors.static",
|
|
|
|
"django.core.context_processors.tz",
|
|
|
|
"django.contrib.messages.context_processors.messages")
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
A tuple of callables that are used to populate the context in ``RequestContext``.
|
|
|
|
These callables take a request object as their argument and return a dictionary
|
|
|
|
of items to be merged into the context.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: TEMPLATE_DEBUG
|
2007-10-20 05:13:56 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
TEMPLATE_DEBUG
|
|
|
|
--------------
|
2007-10-20 05:13:56 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default: ``False``
|
2007-11-30 05:22:35 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
A boolean that turns on/off template debug mode. If this is ``True``, the fancy
|
|
|
|
error page will display a detailed report for any exception raised during
|
|
|
|
template rendering. This report contains the relevant snippet of the template,
|
|
|
|
with the appropriate line highlighted.
|
2007-10-20 05:13:56 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Note that Django only displays fancy error pages if :setting:`DEBUG` is ``True``, so
|
|
|
|
you'll want to set that to take advantage of this setting.
|
2012-10-30 20:59:23 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See also :setting:`DEBUG`.
|
2012-10-30 20:59:23 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: TEMPLATE_DIRS
|
2012-10-30 20:59:23 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
TEMPLATE_DIRS
|
|
|
|
-------------
|
2012-10-30 20:59:23 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Default: ``()`` (Empty tuple)
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
List of locations of the template source files searched by
|
|
|
|
:class:`django.template.loaders.filesystem.Loader`, in search order.
|
2006-08-12 06:02:28 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
Note that these paths should use Unix-style forward slashes, even on Windows.
|
2006-08-12 06:02:28 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
See :doc:`/topics/templates`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: TEMPLATE_LOADERS
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
TEMPLATE_LOADERS
|
|
|
|
----------------
|
|
|
|
|
2008-08-27 05:57:27 +00:00
|
|
|
Default::
|
2008-06-17 13:37:31 +00:00
|
|
|
|
2009-12-14 12:08:23 +00:00
|
|
|
('django.template.loaders.filesystem.Loader',
|
|
|
|
'django.template.loaders.app_directories.Loader')
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2009-12-14 12:08:23 +00:00
|
|
|
A tuple of template loader classes, specified as strings. Each ``Loader`` class
|
2010-03-06 11:10:25 +00:00
|
|
|
knows how to import templates from a particular source. Optionally, a tuple can be
|
2009-12-14 12:08:23 +00:00
|
|
|
used instead of a string. The first item in the tuple should be the ``Loader``'s
|
|
|
|
module, subsequent items are passed to the ``Loader`` during initialization. See
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`/ref/templates/api`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: TEMPLATE_STRING_IF_INVALID
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2006-02-09 00:31:51 +00:00
|
|
|
TEMPLATE_STRING_IF_INVALID
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
Output, as a string, that the template system should use for invalid (e.g.
|
2008-08-23 22:25:40 +00:00
|
|
|
misspelled) variables. See :ref:`invalid-template-variables`..
|
2006-02-09 00:31:51 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEST_RUNNER
|
2006-09-01 13:33:26 +00:00
|
|
|
|
2007-05-29 12:42:08 +00:00
|
|
|
TEST_RUNNER
|
|
|
|
-----------
|
|
|
|
|
2013-05-11 03:08:45 +00:00
|
|
|
Default: ``'django.test.runner.DiscoverRunner'``
|
2007-05-29 12:42:08 +00:00
|
|
|
|
2010-01-18 23:53:08 +00:00
|
|
|
The name of the class to use for starting the test suite. See
|
2012-12-22 00:59:06 +00:00
|
|
|
:ref:`other-testing-frameworks`.
|
2007-05-29 12:42:08 +00:00
|
|
|
|
2013-05-11 03:08:45 +00:00
|
|
|
.. versionchanged:: 1.6
|
|
|
|
|
|
|
|
Previously the default ``TEST_RUNNER`` was
|
|
|
|
``django.test.simple.DjangoTestSuiteRunner``.
|
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: THOUSAND_SEPARATOR
|
|
|
|
|
|
|
|
THOUSAND_SEPARATOR
|
|
|
|
------------------
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Default: ``,`` (Comma)
|
2009-12-22 17:58:49 +00:00
|
|
|
|
|
|
|
Default thousand separator used when formatting numbers. This setting is
|
2011-09-08 13:25:17 +00:00
|
|
|
used only when :setting:`USE_THOUSAND_SEPARATOR` is ``True`` and
|
|
|
|
:setting:`NUMBER_GROUPING` is greater than ``0``.
|
|
|
|
|
2011-09-18 07:50:50 +00:00
|
|
|
Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
|
2011-09-08 13:25:17 +00:00
|
|
|
format has higher precedence and will be applied instead.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2010-11-16 21:33:48 +00:00
|
|
|
See also :setting:`NUMBER_GROUPING`, :setting:`DECIMAL_SEPARATOR` and
|
|
|
|
:setting:`USE_THOUSAND_SEPARATOR`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TIME_FORMAT
|
|
|
|
|
2005-11-06 23:49:03 +00:00
|
|
|
TIME_FORMAT
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Default: ``'P'`` (e.g. ``4 p.m.``)
|
|
|
|
|
2010-02-26 17:05:52 +00:00
|
|
|
The default formatting to use for displaying time fields in any part of the
|
2010-05-09 04:23:43 +00:00
|
|
|
system. Note that if :setting:`USE_L10N` is set to ``True``, then the
|
2010-02-26 17:05:52 +00:00
|
|
|
locale-dictated format has higher precedence and will be applied instead. See
|
2010-10-23 14:52:01 +00:00
|
|
|
:tfilter:`allowed date format strings <date>`.
|
2010-02-26 17:05:52 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATE_FORMAT` and :setting:`DATETIME_FORMAT`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
|
|
|
.. setting:: TIME_INPUT_FORMATS
|
|
|
|
|
|
|
|
TIME_INPUT_FORMATS
|
|
|
|
------------------
|
|
|
|
|
2013-02-04 20:06:38 +00:00
|
|
|
Default::
|
|
|
|
|
|
|
|
(
|
|
|
|
'%H:%M:%S', # '14:30:59'
|
2013-03-02 17:01:24 +00:00
|
|
|
'%H:%M:%S.%f', # '14:30:59.000200'
|
2013-02-04 20:06:38 +00:00
|
|
|
'%H:%M', # '14:30'
|
|
|
|
)
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2012-02-19 08:00:06 +00:00
|
|
|
A tuple of formats that will be accepted when inputting data on a time field.
|
2012-03-02 17:16:52 +00:00
|
|
|
Formats will be tried in order, using the first valid one. Note that these
|
|
|
|
format strings use Python's datetime_ module syntax, not the format strings
|
|
|
|
from the ``date`` Django template tag.
|
2012-02-19 08:00:06 +00:00
|
|
|
|
|
|
|
When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
|
|
|
|
precedence and will be applied instead.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See also :setting:`DATE_INPUT_FORMATS` and :setting:`DATETIME_INPUT_FORMATS`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2013-03-02 17:01:24 +00:00
|
|
|
.. versionchanged:: 1.6
|
|
|
|
|
2013-03-25 05:53:48 +00:00
|
|
|
Input format with microseconds has been added.
|
2013-03-02 17:01:24 +00:00
|
|
|
|
2010-06-07 03:08:33 +00:00
|
|
|
.. _datetime: http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TIME_ZONE
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
TIME_ZONE
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``'America/Chicago'``
|
|
|
|
|
Simplified default project template.
Squashed commit of:
commit 508ec9144b35c50794708225b496bde1eb5e60aa
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 22:50:55 2013 +0100
Tweaked default settings file.
* Explained why BASE_DIR exists.
* Added a link to the database configuration options, and put it in its
own section.
* Moved sensitive settings that must be changed for production at the
top.
commit 6515fd2f1aa73a86dc8dbd2ccf512ddb6b140d57
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 14:35:21 2013 +0100
Documented the simplified app & project templates in the changelog.
commit 2c5b576c2ea91d84273a019b3d0b3b8b4da72f23
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:59:27 2013 +0100
Minor fixes in tutorials 5 and 6.
commit 55a51531be8104f21b3cca3f6bf70b0a7139a041
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:51:11 2013 +0100
Updated tutorial 2 for the new project template.
commit 29ddae87bdaecff12dd31b16b000c01efbde9e20
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:58:54 2013 +0100
Updated tutorial 1 for the new project template.
commit 0ecb9f6e2514cfd26a678a280d471433375101a3
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:29:13 2013 +0100
Adjusted the default URLconf detection to account for the admin.
It's now enabled by default.
commit 5fb4da0d3d09dac28dd94e3fde92b9d4335c0565
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 10:36:55 2013 +0100
Added security warnings for the most sensitive settings.
commit 718d84bd8ac4a42fb4b28ec93965de32680f091e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:24:06 2013 +0100
Used an absolute path for the SQLite database.
This ensures the settings file works regardless of which directory
django-admin.py / manage.py is invoked from.
BASE_DIR got a +1 from a BDFL and another core dev. It doesn't involve
the concept of a "Django project"; it's just a convenient way to express
relative paths within the source code repository for non-Python files.
Thanks Jacob Kaplan-Moss for the suggestion.
commit 1b559b4bcda622e10909b68fe5cab90db6727dd9
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:22:40 2013 +0100
Removed STATIC_ROOT from the default settings template.
It isn't necessary in development, and it confuses beginners to no end.
Thanks Carl Meyer for the suggestion.
commit a55f141a500bb7c9a1bc259bbe1954c13b199671
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:21:43 2013 +0100
Removed MEDIA_ROOT/URL from default settings template.
Many sites will never deal with user-uploaded files, and MEDIA_ROOT is
complicated to explain.
Thanks Carl Meyer for the suggestion.
commit 44bf2f2441420fd9429ee9fe1f7207f92dd87e70
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:22:09 2013 +0100
Removed logging config.
This configuration is applied regardless of the value of LOGGING;
duplicating it in LOGGING is confusing.
commit eac747e848eaed65fd5f6f254f0a7559d856f88f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:05:31 2013 +0100
Enabled the locale middleware by default.
USE_I18N is True by default, and doesn't work well without
LocaleMiddleware.
commit d806c62b2d00826dc2688c84b092627b8d571cab
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:03:16 2013 +0100
Enabled clickjacking protection by default.
commit 99152c30e6a15003f0b6737dc78e87adf462aacb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:01:48 2013 +0100
Reorganized settings in logical sections, and trimmed comments.
commit d37ffdfcb24b7e0ec7cc113d07190f65fb12fb8a
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:54:11 2013 +0100
Avoided misleading TEMPLATE_DEBUG = DEBUG.
According to the docs TEMPLATE_DEBUG works only when DEBUG = True.
commit 15d9478d3a9850e85841e7cf09cf83050371c6bf
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:46:25 2013 +0100
Removed STATICFILES_FINDERS/TEMPLATE_LOADERS from default settings file.
Only developers with special needs ever need to change these settings.
commit 574da0eb5bfb4570883756914b4dbd7e20e1f61e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:45:01 2013 +0100
Removed STATICFILES/TEMPLATES_DIRS from default settings file.
The current best practice is to put static files and templates in
applications, for easier testing and deployment.
commit 8cb18dbe56629aa1be74718a07e7cc66b4f9c9f0
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:24:16 2013 +0100
Removed settings related to email reporting from default settings file.
While handy for small scale projects, it isn't exactly a best practice.
commit 8ecbfcb3638058f0c49922540f874a7d802d864f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 18:54:43 2013 +0100
Documented how to enable the sites framework.
commit 23fc91a6fa67d91ddd9d71b1c3e0dc26bdad9841
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:28:59 2013 +0100
Disabled the sites framework by default.
RequestSite does the job for single-domain websites.
commit c4d82eb8afc0eb8568bf9c4d12644272415e3960
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 00:08:33 2013 +0100
Added a default admin.py to the application template.
Thanks Ryan D Hiebert for the suggestion.
commit 4071dc771e5c44b1c5ebb9beecefb164ae465e22
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:59:49 2013 +0100
Enabled the admin by default.
Everyone uses the admin.
commit c807a31f8d89e7e7fd97380e3023f7983a8b6fcb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:57:05 2013 +0100
Removed admindocs from default project template.
commit 09e4ce0e652a97da1a9e285046a91c8ad7a9189c
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:32:52 2013 +0100
Added links to the settings documentation.
commit 5b8f5eaef364eb790fcde6f9e86f7d266074cca8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 11:06:54 2013 +0100
Used a significant example for URLconf includes.
commit 908e91d6fcee2a3cb51ca26ecdf12a6a24e69ef8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:22:31 2013 +0100
Moved code comments about WSGI to docs, and rewrote said docs.
commit 50417e51996146f891d08ca8b74dcc736a581932
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 15:51:50 2013 +0100
Normalized the default application template.
Removed the default test that 1 + 1 = 2, because it's been committed
way too many times, in too many projects.
Added an import of `render` for views, because the first view will
often be:
def home(request):
return render(request, "mysite/home.html")
2013-01-28 14:51:50 +00:00
|
|
|
A string representing the time zone for this installation, or ``None``. See
|
|
|
|
the `list of time zones`_.
|
2010-02-26 15:33:27 +00:00
|
|
|
|
2013-02-10 17:58:42 +00:00
|
|
|
.. note::
|
|
|
|
Since Django was first released with the :setting:`TIME_ZONE` set to
|
|
|
|
``'America/Chicago'``, the global setting (used if nothing is defined in
|
|
|
|
your project's ``settings.py``) remains ``'America/Chicago'`` for backwards
|
|
|
|
compatibility. New project templates default to ``'UTC'``.
|
|
|
|
|
2012-02-22 21:13:36 +00:00
|
|
|
Note that this isn't necessarily the time zone of the server. For example, one
|
2011-11-18 13:01:06 +00:00
|
|
|
server may serve multiple Django-powered sites, each with a separate time zone
|
|
|
|
setting.
|
|
|
|
|
2012-02-22 21:13:36 +00:00
|
|
|
When :setting:`USE_TZ` is ``False``, this is the time zone in which Django
|
|
|
|
will store all datetimes. When :setting:`USE_TZ` is ``True``, this is the
|
|
|
|
default time zone that Django will use to display datetimes in templates and
|
|
|
|
to interpret datetimes entered in forms.
|
2010-02-26 15:33:27 +00:00
|
|
|
|
2011-11-18 13:01:06 +00:00
|
|
|
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 will
|
|
|
|
automatically operate in this time zone. However, Django won't set the ``TZ``
|
|
|
|
environment variable under the following conditions:
|
2010-02-26 15:33:27 +00:00
|
|
|
|
2011-10-14 00:12:01 +00:00
|
|
|
* If you're using the manual configuration option as described in
|
|
|
|
:ref:`manually configuring settings
|
|
|
|
<settings-without-django-settings-module>`, or
|
2010-02-26 15:33:27 +00:00
|
|
|
|
2012-03-26 14:17:13 +00:00
|
|
|
* If you specify ``TIME_ZONE = None``. This will cause Django to fall back to
|
|
|
|
using the system timezone. However, this is discouraged when :setting:`USE_TZ
|
|
|
|
= True <USE_TZ>`, because it makes conversions between local time and UTC
|
|
|
|
less reliable.
|
2010-02-26 15:33:27 +00:00
|
|
|
|
|
|
|
If Django doesn't set the ``TZ`` environment variable, it's up to you
|
|
|
|
to ensure your processes are running in the correct environment.
|
2006-07-12 07:40:28 +00:00
|
|
|
|
2012-02-22 21:13:36 +00:00
|
|
|
.. 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 to
|
|
|
|
match the system time zone.
|
2010-02-26 15:33:27 +00:00
|
|
|
|
Simplified default project template.
Squashed commit of:
commit 508ec9144b35c50794708225b496bde1eb5e60aa
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 22:50:55 2013 +0100
Tweaked default settings file.
* Explained why BASE_DIR exists.
* Added a link to the database configuration options, and put it in its
own section.
* Moved sensitive settings that must be changed for production at the
top.
commit 6515fd2f1aa73a86dc8dbd2ccf512ddb6b140d57
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 14:35:21 2013 +0100
Documented the simplified app & project templates in the changelog.
commit 2c5b576c2ea91d84273a019b3d0b3b8b4da72f23
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:59:27 2013 +0100
Minor fixes in tutorials 5 and 6.
commit 55a51531be8104f21b3cca3f6bf70b0a7139a041
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 13:51:11 2013 +0100
Updated tutorial 2 for the new project template.
commit 29ddae87bdaecff12dd31b16b000c01efbde9e20
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:58:54 2013 +0100
Updated tutorial 1 for the new project template.
commit 0ecb9f6e2514cfd26a678a280d471433375101a3
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 11:29:13 2013 +0100
Adjusted the default URLconf detection to account for the admin.
It's now enabled by default.
commit 5fb4da0d3d09dac28dd94e3fde92b9d4335c0565
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 10:36:55 2013 +0100
Added security warnings for the most sensitive settings.
commit 718d84bd8ac4a42fb4b28ec93965de32680f091e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:24:06 2013 +0100
Used an absolute path for the SQLite database.
This ensures the settings file works regardless of which directory
django-admin.py / manage.py is invoked from.
BASE_DIR got a +1 from a BDFL and another core dev. It doesn't involve
the concept of a "Django project"; it's just a convenient way to express
relative paths within the source code repository for non-Python files.
Thanks Jacob Kaplan-Moss for the suggestion.
commit 1b559b4bcda622e10909b68fe5cab90db6727dd9
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:22:40 2013 +0100
Removed STATIC_ROOT from the default settings template.
It isn't necessary in development, and it confuses beginners to no end.
Thanks Carl Meyer for the suggestion.
commit a55f141a500bb7c9a1bc259bbe1954c13b199671
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 23:21:43 2013 +0100
Removed MEDIA_ROOT/URL from default settings template.
Many sites will never deal with user-uploaded files, and MEDIA_ROOT is
complicated to explain.
Thanks Carl Meyer for the suggestion.
commit 44bf2f2441420fd9429ee9fe1f7207f92dd87e70
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:22:09 2013 +0100
Removed logging config.
This configuration is applied regardless of the value of LOGGING;
duplicating it in LOGGING is confusing.
commit eac747e848eaed65fd5f6f254f0a7559d856f88f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:05:31 2013 +0100
Enabled the locale middleware by default.
USE_I18N is True by default, and doesn't work well without
LocaleMiddleware.
commit d806c62b2d00826dc2688c84b092627b8d571cab
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:03:16 2013 +0100
Enabled clickjacking protection by default.
commit 99152c30e6a15003f0b6737dc78e87adf462aacb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 22:01:48 2013 +0100
Reorganized settings in logical sections, and trimmed comments.
commit d37ffdfcb24b7e0ec7cc113d07190f65fb12fb8a
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:54:11 2013 +0100
Avoided misleading TEMPLATE_DEBUG = DEBUG.
According to the docs TEMPLATE_DEBUG works only when DEBUG = True.
commit 15d9478d3a9850e85841e7cf09cf83050371c6bf
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:46:25 2013 +0100
Removed STATICFILES_FINDERS/TEMPLATE_LOADERS from default settings file.
Only developers with special needs ever need to change these settings.
commit 574da0eb5bfb4570883756914b4dbd7e20e1f61e
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:45:01 2013 +0100
Removed STATICFILES/TEMPLATES_DIRS from default settings file.
The current best practice is to put static files and templates in
applications, for easier testing and deployment.
commit 8cb18dbe56629aa1be74718a07e7cc66b4f9c9f0
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:24:16 2013 +0100
Removed settings related to email reporting from default settings file.
While handy for small scale projects, it isn't exactly a best practice.
commit 8ecbfcb3638058f0c49922540f874a7d802d864f
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 18:54:43 2013 +0100
Documented how to enable the sites framework.
commit 23fc91a6fa67d91ddd9d71b1c3e0dc26bdad9841
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:28:59 2013 +0100
Disabled the sites framework by default.
RequestSite does the job for single-domain websites.
commit c4d82eb8afc0eb8568bf9c4d12644272415e3960
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Tue Jan 29 00:08:33 2013 +0100
Added a default admin.py to the application template.
Thanks Ryan D Hiebert for the suggestion.
commit 4071dc771e5c44b1c5ebb9beecefb164ae465e22
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:59:49 2013 +0100
Enabled the admin by default.
Everyone uses the admin.
commit c807a31f8d89e7e7fd97380e3023f7983a8b6fcb
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 10:57:05 2013 +0100
Removed admindocs from default project template.
commit 09e4ce0e652a97da1a9e285046a91c8ad7a9189c
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:32:52 2013 +0100
Added links to the settings documentation.
commit 5b8f5eaef364eb790fcde6f9e86f7d266074cca8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 11:06:54 2013 +0100
Used a significant example for URLconf includes.
commit 908e91d6fcee2a3cb51ca26ecdf12a6a24e69ef8
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 16:22:31 2013 +0100
Moved code comments about WSGI to docs, and rewrote said docs.
commit 50417e51996146f891d08ca8b74dcc736a581932
Author: Aymeric Augustin <aymeric.augustin@m4x.org>
Date: Mon Jan 28 15:51:50 2013 +0100
Normalized the default application template.
Removed the default test that 1 + 1 = 2, because it's been committed
way too many times, in too many projects.
Added an import of `render` for views, because the first view will
often be:
def home(request):
return render(request, "mysite/home.html")
2013-01-28 14:51:50 +00:00
|
|
|
.. _list of time zones: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2012-02-22 21:13:36 +00:00
|
|
|
.. _pytz: http://pytz.sourceforge.net/
|
|
|
|
|
2012-12-14 20:15:48 +00:00
|
|
|
.. setting:: TRANSACTIONS_MANAGED
|
|
|
|
|
|
|
|
TRANSACTIONS_MANAGED
|
|
|
|
--------------------
|
|
|
|
|
2013-03-06 10:12:24 +00:00
|
|
|
.. deprecated:: 1.6
|
|
|
|
|
|
|
|
This setting was deprecated because its name is very misleading. Use the
|
|
|
|
:setting:`AUTOCOMMIT <DATABASE-AUTOCOMMIT>` key in :setting:`DATABASES`
|
|
|
|
entries instead.
|
|
|
|
|
2012-12-14 20:15:48 +00:00
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
Set this to ``True`` if you want to :ref:`disable Django's transaction
|
|
|
|
management <deactivate-transaction-management>` and implement your own.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: USE_ETAGS
|
2006-11-07 02:20:08 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
USE_ETAGS
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
A boolean that specifies whether to output the "Etag" header. This saves
|
2010-12-12 22:57:17 +00:00
|
|
|
bandwidth but slows down performance. This is used by the ``CommonMiddleware``
|
|
|
|
(see :doc:`/topics/http/middleware`) and in the``Cache Framework``
|
|
|
|
(see :doc:`/topics/cache`).
|
2008-08-23 22:25:40 +00:00
|
|
|
|
2010-08-07 02:43:14 +00:00
|
|
|
.. setting:: USE_I18N
|
|
|
|
|
|
|
|
USE_I18N
|
|
|
|
--------
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
2011-10-22 17:17:57 +00:00
|
|
|
A boolean that specifies whether Django's translation system should be enabled.
|
|
|
|
This provides an easy way to turn it off, for performance. If this is set to
|
|
|
|
``False``, Django will make some optimizations so as not to load the
|
|
|
|
translation machinery.
|
2010-08-07 02:43:14 +00:00
|
|
|
|
2011-11-18 13:01:06 +00:00
|
|
|
See also :setting:`LANGUAGE_CODE`, :setting:`USE_L10N` and :setting:`USE_TZ`.
|
2010-08-07 02:43:14 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: USE_L10N
|
|
|
|
|
|
|
|
USE_L10N
|
|
|
|
--------
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Default: ``False``
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-10-22 17:17:57 +00:00
|
|
|
A boolean that specifies if localized formatting of data will be enabled by
|
|
|
|
default or not. If this is set to ``True``, e.g. Django will display numbers and
|
|
|
|
dates using the format of the current locale.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-11-18 13:01:06 +00:00
|
|
|
See also :setting:`LANGUAGE_CODE`, :setting:`USE_I18N` and :setting:`USE_TZ`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-07-12 00:08:37 +00:00
|
|
|
.. note::
|
2011-09-16 18:06:42 +00:00
|
|
|
|
|
|
|
The default :file:`settings.py` file created by :djadmin:`django-admin.py
|
|
|
|
startproject <startproject>` includes ``USE_L10N = True`` for convenience.
|
2011-07-12 00:08:37 +00:00
|
|
|
|
2009-12-22 17:58:49 +00:00
|
|
|
.. setting:: USE_THOUSAND_SEPARATOR
|
|
|
|
|
|
|
|
USE_THOUSAND_SEPARATOR
|
|
|
|
----------------------
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
Default: ``False``
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-08-13 11:58:19 +00:00
|
|
|
A boolean that specifies whether to display numbers using a thousand separator.
|
2011-09-08 13:25:17 +00:00
|
|
|
When :setting:`USE_L10N` is set to ``True`` and if this is also set to
|
|
|
|
``True``, Django will use the values of :setting:`THOUSAND_SEPARATOR` and
|
|
|
|
:setting:`NUMBER_GROUPING` to format numbers.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-09-08 13:25:17 +00:00
|
|
|
See also :setting:`DECIMAL_SEPARATOR`, :setting:`NUMBER_GROUPING` and
|
|
|
|
:setting:`THOUSAND_SEPARATOR`.
|
2009-12-22 17:58:49 +00:00
|
|
|
|
2011-11-18 13:01:06 +00:00
|
|
|
.. setting:: USE_TZ
|
|
|
|
|
|
|
|
USE_TZ
|
|
|
|
------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
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.
|
|
|
|
Otherwise, Django will use naive datetimes in local time.
|
|
|
|
|
|
|
|
See also :setting:`TIME_ZONE`, :setting:`USE_I18N` and :setting:`USE_L10N`.
|
|
|
|
|
|
|
|
.. note::
|
2011-11-18 15:00:08 +00:00
|
|
|
|
2011-11-18 13:01:06 +00:00
|
|
|
The default :file:`settings.py` file created by
|
|
|
|
:djadmin:`django-admin.py startproject <startproject>` includes
|
|
|
|
``USE_TZ = True`` for convenience.
|
|
|
|
|
2011-09-10 00:46:38 +00:00
|
|
|
.. setting:: USE_X_FORWARDED_HOST
|
|
|
|
|
|
|
|
USE_X_FORWARDED_HOST
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
A boolean that specifies whether to use the X-Forwarded-Host header in
|
|
|
|
preference to the Host header. This should only be enabled if a proxy
|
|
|
|
which sets this header is in use.
|
|
|
|
|
2011-10-22 04:30:10 +00:00
|
|
|
.. setting:: WSGI_APPLICATION
|
|
|
|
|
|
|
|
WSGI_APPLICATION
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The full Python path of the WSGI application object that Django's built-in
|
|
|
|
servers (e.g. :djadmin:`runserver`) will use. The :djadmin:`django-admin.py
|
|
|
|
startproject <startproject>` management command will create a simple
|
|
|
|
``wsgi.py`` file with an ``application`` callable in it, and point this setting
|
|
|
|
to that ``application``.
|
|
|
|
|
2013-01-01 13:12:42 +00:00
|
|
|
If not set, the return value of ``django.core.wsgi.get_wsgi_application()``
|
2011-10-22 04:30:10 +00:00
|
|
|
will be used. In this case, the behavior of :djadmin:`runserver` will be
|
|
|
|
identical to previous Django versions.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: YEAR_MONTH_FORMAT
|
|
|
|
|
2006-06-02 04:20:32 +00:00
|
|
|
YEAR_MONTH_FORMAT
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Default: ``'F Y'``
|
|
|
|
|
|
|
|
The default formatting to use for date fields on Django admin change-list
|
|
|
|
pages -- and, possibly, by other parts of the system -- in cases when only the
|
|
|
|
year and month are displayed.
|
|
|
|
|
|
|
|
For example, when a Django admin change-list page is being filtered by a date
|
|
|
|
drilldown, the header for a given month displays the month and the year.
|
|
|
|
Different locales have different formats. For example, U.S. English would say
|
|
|
|
"January 2006," whereas another locale might say "2006/January."
|
|
|
|
|
2011-05-29 17:41:04 +00:00
|
|
|
See :tfilter:`allowed date format strings <date>`. See also
|
|
|
|
:setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT`
|
|
|
|
and :setting:`MONTH_DAY_FORMAT`.
|
2009-12-22 15:18:51 +00:00
|
|
|
|
2011-05-30 22:27:47 +00:00
|
|
|
.. setting:: X_FRAME_OPTIONS
|
|
|
|
|
|
|
|
X_FRAME_OPTIONS
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: ``'SAMEORIGIN'``
|
|
|
|
|
|
|
|
The default value for the X-Frame-Options header used by
|
|
|
|
:class:`~django.middleware.clickjacking.XFrameOptionsMiddleware`. See the
|
|
|
|
:doc:`clickjacking protection </ref/clickjacking/>` documentation.
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
Admindocs
|
|
|
|
=========
|
|
|
|
|
|
|
|
Settings for :mod:`django.contrib.admindocs`.
|
|
|
|
|
|
|
|
.. setting:: ADMIN_FOR
|
|
|
|
|
|
|
|
ADMIN_FOR
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
|
|
|
Used for admin-site settings modules, this should be a tuple of settings
|
|
|
|
modules (in the format ``'foo.bar.baz'``) for which this site is an admin.
|
|
|
|
|
|
|
|
The admin site uses this in its automatically-introspected documentation of
|
|
|
|
models, views and template tags.
|
|
|
|
|
|
|
|
|
|
|
|
Auth
|
|
|
|
====
|
|
|
|
|
|
|
|
Settings for :mod:`django.contrib.auth`.
|
|
|
|
|
|
|
|
.. setting:: AUTHENTICATION_BACKENDS
|
|
|
|
|
|
|
|
AUTHENTICATION_BACKENDS
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``('django.contrib.auth.backends.ModelBackend',)``
|
|
|
|
|
|
|
|
A tuple of authentication backend classes (as strings) to use when attempting to
|
|
|
|
authenticate a user. See the :ref:`authentication backends documentation
|
|
|
|
<authentication-backends>` for details.
|
2009-12-22 15:18:51 +00:00
|
|
|
|
Fixed #3011 -- Added swappable auth.User models.
Thanks to the many people that contributed to the development and review of
this patch, including (but not limited to) Jacob Kaplan-Moss, Anssi
Kääriäinen, Ramiro Morales, Preston Holmes, Josh Ourisman, Thomas Sutton,
and Roger Barnes, as well as the many, many people who have contributed to
the design discussion around this ticket over many years.
Squashed commit of the following:
commit d84749a0f034a0a6906d20df047086b1219040d0
Merge: 531e771 7c11b1a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Wed Sep 26 18:37:04 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit 531e7715da545f930c49919a19e954d41c59b446
Merge: 29d1abb 1f84b04
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Wed Sep 26 07:09:23 2012 +0800
Merged recent trunk changes.
commit 29d1abbe351fd5da855fe5ce09e24227d90ddc91
Merge: 8a527dd 54c81a1
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Sep 24 07:49:46 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit 8a527dda13c9bec955b1f7e8db5822d1d9b32a01
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Sep 24 07:48:05 2012 +0800
Ensure sequences are reset correctly in the presence of swapped models.
commit e2b6e22f298eb986d74d28b8d9906f37f5ff8eb8
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 23 17:53:05 2012 +0800
Modifications to the handling and docs for auth forms.
commit 98aba856b534620aea9091f824b442b47d2fdb3c
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 23 15:28:57 2012 +0800
Improved error handling and docs for get_user_model()
commit 0229209c844f06dfeb33b0b8eeec000c127695b6
Merge: 6494bf9 8599f64
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 23 14:50:11 2012 +0800
Merged recent Django trunk changes.
commit 6494bf91f2ddaaabec3ec017f2e3131937c35517
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Sep 17 21:38:44 2012 +0800
Improved validation of swappable model settings.
commit 5a04cde342cc860384eb844cfda5af55204564ad
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Sep 17 07:15:14 2012 +0800
Removed some unused imports.
commit ffd535e4136dc54f084b6ac467e81444696e1c8a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 20:31:28 2012 +0800
Corrected attribute access on for get_by_natural_key
commit 913e1ac84c3d9c7c58a9b3bdbbb15ebccd8a8c0a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 20:12:34 2012 +0800
Added test for proxy model safeguards on swappable models.
commit 280bf19e94d0d534d0e51bae485c1842558f4ff4
Merge: dbb3900 935a863
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 18:16:49 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit dbb3900775a99df8b6cb1d7063cf364eab55621a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 18:09:27 2012 +0800
Fixes for Python 3 compatibility.
commit dfd72131d8664615e245aa0f95b82604ba6b3821
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 15:54:30 2012 +0800
Added protection against proxying swapped models.
commit abcb027190e53613e7f1734e77ee185b2587de31
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 15:11:10 2012 +0800
Cleanup and documentation of AbstractUser base class.
commit a9491a87763e307f0eb0dc246f54ac865a6ffb34
Merge: fd8bb4e 08bcb4a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 14:46:49 2012 +0800
Merge commit '08bcb4aec1ed154cefc631b8510ee13e9af0c19d' into t3011
commit fd8bb4e3e498a92d7a8b340f0684d5f088aa4c92
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 14:20:14 2012 +0800
Documentation improvements coming from community review.
commit b550a6d06d016ab6a0198c4cb2dffe9cceabe8a5
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 13:52:47 2012 +0800
Refactored skipIfCustomUser into the contrib.auth tests.
commit 52a02f11107c3f0d711742b8ca65b75175b79d6a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 13:46:10 2012 +0800
Refactored common 'get' pattern into manager method.
commit b441a6bbc7d6065175715cb09316b9f13268171b
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 16 13:41:33 2012 +0800
Added note about backwards incompatible change to admin login messages.
commit 08bcb4aec1ed154cefc631b8510ee13e9af0c19d
Author: Anssi Kääriäinen <akaariai@gmail.com>
Date: Sat Sep 15 18:30:33 2012 +0300
Splitted User to AbstractUser and User
commit d9f5e5addbad5e1a01f67e7358e4f5091c3cad81
Author: Anssi Kääriäinen <akaariai@gmail.com>
Date: Sat Sep 15 18:30:02 2012 +0300
Reworked REQUIRED_FIELDS + create_user() interaction
commit 579f152e4a6e06671e1ac1e59e2b43cf4d764bf4
Merge: 9184972 93e6733
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 15 20:18:37 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit 918497218c58227f5032873ff97261627b2ceab2
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 15 20:18:19 2012 +0800
Deprecate AUTH_PROFILE_MODULE and get_profile().
commit 334cdfc1bb6a6794791497cdefda843bca2ea57a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 15 20:00:12 2012 +0800
Added release notes for new swappable User feature.
commit 5d7bb22e8d913b51aba1c3360e7af8b01b6c0ab6
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 15 19:59:49 2012 +0800
Ensure swapped models can't be queried.
commit 57ac6e3d32605a67581e875b37ec5b2284711a32
Merge: f2ec915 abfba3b
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 15 14:31:54 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit f2ec915b20f81c8afeaa3df25f80689712f720f8
Merge: 1952656 5e99a3d
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 9 08:29:51 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit 19526563b54fa300785c49cfb625c0c6158ced67
Merge: 2c5e833 c4aa26a
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 9 08:22:26 2012 +0800
Merge recent changes from master.
commit 2c5e833a30bef4305d55eacc0703533152f5c427
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 9 07:53:46 2012 +0800
Corrected admin_views tests following removal of the email fallback on admin logins.
commit 20d1892491839d6ef21f37db4ca136935c2076bf
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sun Sep 9 01:00:37 2012 +0800
Added conditional skips for all tests dependent on the default User model
commit 40ea8b888284775481fc1eaadeff267dbd7e3dfa
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 8 23:47:02 2012 +0800
Added documentation for REQUIRED_FIELDS in custom auth.
commit e6aaf659708cf6491f5485d3edfa616cb9214cc0
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Sat Sep 8 23:20:02 2012 +0800
Added first draft of custom User docs.
Thanks to Greg Turner for the initial text.
commit 75118bd242eec87649da2859e8c50a199a8a1dca
Author: Thomas Sutton <me@thomas-sutton.id.au>
Date: Mon Aug 20 11:17:26 2012 +0800
Admin app should not allow username discovery
The admin app login form should not allow users to discover the username
associated with an email address.
commit d088b3af58dad7449fc58493193a327725c57c22
Author: Thomas Sutton <me@thomas-sutton.id.au>
Date: Mon Aug 20 10:32:13 2012 +0800
Admin app login form should use swapped user model
commit 7e82e83d67ee0871a72e1a3a723afdd214fcefc3
Merge: e29c010 39aa890
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Fri Sep 7 23:45:03 2012 +0800
Merged master changes.
commit e29c010beb96ca07697c4e3e0c0d5d3ffdc4c0a3
Merge: 8e3fd70 30bdf22
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Aug 20 13:12:57 2012 +0800
Merge remote-tracking branch 'django/master' into t3011
commit 8e3fd703d02c31a4c3ac9f51f5011d03c0bd47f6
Merge: 507bb50 26e0ba0
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Aug 20 13:09:09 2012 +0800
Merged recent changes from trunk.
commit 507bb50a9291bfcdcfa1198f9fea21d4e3b1e762
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Jun 4 20:41:37 2012 +0800
Modified auth app so that login with alternate auth app is possible.
commit dabe3628362ab7a4a6c9686dd874803baa997eaa
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Jun 4 20:10:51 2012 +0800
Modified auth management commands to handle custom user definitions.
commit 7cc0baf89d490c92ef3f1dc909b8090191a1294b
Author: Russell Keith-Magee <russell@keith-magee.com>
Date: Mon Jun 4 14:17:28 2012 +0800
Added model Meta option for swappable models, and made auth.User a swappable model
2012-09-26 10:48:09 +00:00
|
|
|
.. setting:: AUTH_PROFILE_MODULE
|
|
|
|
|
|
|
|
AUTH_PROFILE_MODULE
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. deprecated:: 1.5
|
|
|
|
With the introduction of :ref:`custom User models <auth-custom-user>`,
|
|
|
|
the use of :setting:`AUTH_PROFILE_MODULE` to define a single profile
|
|
|
|
model is no longer supported. See the
|
|
|
|
:doc:`Django 1.5 release notes</releases/1.5>` for more information.
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
|
|
|
The site-specific user profile model used by this site. See
|
2012-12-28 19:00:11 +00:00
|
|
|
:ref:`User profiles <auth-profiles>`.
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
.. setting:: AUTH_USER_MODEL
|
|
|
|
|
|
|
|
AUTH_USER_MODEL
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Default: 'auth.User'
|
|
|
|
|
|
|
|
The model to use to represent a User. See :ref:`auth-custom-user`.
|
|
|
|
|
|
|
|
.. setting:: LOGIN_REDIRECT_URL
|
|
|
|
|
|
|
|
LOGIN_REDIRECT_URL
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``'/accounts/profile/'``
|
|
|
|
|
|
|
|
The URL where requests are redirected after login when the
|
|
|
|
``contrib.auth.login`` view gets no ``next`` parameter.
|
|
|
|
|
|
|
|
This is used by the :func:`~django.contrib.auth.decorators.login_required`
|
|
|
|
decorator, for example.
|
|
|
|
|
|
|
|
.. versionchanged:: 1.5
|
|
|
|
|
2013-03-25 05:53:48 +00:00
|
|
|
This setting now also accepts view function names and
|
|
|
|
:ref:`named URL patterns <naming-url-patterns>` which can be used to reduce
|
|
|
|
configuration duplication since you no longer have to define the URL in two
|
|
|
|
places (``settings`` and URLconf).
|
|
|
|
For backward compatibility reasons the default remains unchanged.
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
.. setting:: LOGIN_URL
|
|
|
|
|
|
|
|
LOGIN_URL
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``'/accounts/login/'``
|
|
|
|
|
|
|
|
The URL where requests are redirected for login, especially when using the
|
|
|
|
:func:`~django.contrib.auth.decorators.login_required` decorator.
|
|
|
|
|
|
|
|
.. versionchanged:: 1.5
|
|
|
|
|
2013-03-25 05:53:48 +00:00
|
|
|
This setting now also accepts view function names and
|
|
|
|
:ref:`named URL patterns <naming-url-patterns>` which can be used to reduce
|
|
|
|
configuration duplication since you no longer have to define the URL in two
|
|
|
|
places (``settings`` and URLconf).
|
|
|
|
For backward compatibility reasons the default remains unchanged.
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
.. setting:: LOGOUT_URL
|
|
|
|
|
|
|
|
LOGOUT_URL
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``'/accounts/logout/'``
|
|
|
|
|
|
|
|
LOGIN_URL counterpart.
|
|
|
|
|
|
|
|
.. setting:: PASSWORD_RESET_TIMEOUT_DAYS
|
|
|
|
|
|
|
|
PASSWORD_RESET_TIMEOUT_DAYS
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
Default: ``3``
|
|
|
|
|
|
|
|
The number of days a password reset link is valid for. Used by the
|
|
|
|
:mod:`django.contrib.auth` password reset mechanism.
|
|
|
|
|
|
|
|
.. 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.BCryptPasswordHasher',
|
|
|
|
'django.contrib.auth.hashers.SHA1PasswordHasher',
|
|
|
|
'django.contrib.auth.hashers.MD5PasswordHasher',
|
|
|
|
'django.contrib.auth.hashers.UnsaltedMD5PasswordHasher',
|
|
|
|
'django.contrib.auth.hashers.CryptPasswordHasher',)
|
|
|
|
|
|
|
|
|
|
|
|
.. _settings-comments:
|
|
|
|
|
|
|
|
Comments
|
|
|
|
========
|
|
|
|
|
|
|
|
Settings for :mod:`django.contrib.comments`.
|
|
|
|
|
|
|
|
.. setting:: COMMENTS_HIDE_REMOVED
|
|
|
|
|
|
|
|
COMMENTS_HIDE_REMOVED
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
If ``True`` (default), removed comments will be excluded from comment
|
|
|
|
lists/counts (as taken from template tags). Otherwise, the template author is
|
|
|
|
responsible for some sort of a "this comment has been removed by the site staff"
|
|
|
|
message.
|
|
|
|
|
|
|
|
.. setting:: COMMENT_MAX_LENGTH
|
|
|
|
|
|
|
|
COMMENT_MAX_LENGTH
|
|
|
|
------------------
|
|
|
|
|
|
|
|
The maximum length of the comment field, in characters. Comments longer than
|
|
|
|
this will be rejected. Defaults to 3000.
|
|
|
|
|
|
|
|
.. setting:: COMMENTS_APP
|
|
|
|
|
|
|
|
COMMENTS_APP
|
|
|
|
------------
|
|
|
|
|
|
|
|
An app which provides :doc:`customization of the comments framework
|
|
|
|
</ref/contrib/comments/custom>`. Use the same dotted-string notation
|
|
|
|
as in :setting:`INSTALLED_APPS`. Your custom :setting:`COMMENTS_APP`
|
|
|
|
must also be listed in :setting:`INSTALLED_APPS`.
|
|
|
|
|
|
|
|
.. setting:: PROFANITIES_LIST
|
|
|
|
|
|
|
|
PROFANITIES_LIST
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
|
|
|
A tuple of profanities, as strings, that will be forbidden in comments when
|
|
|
|
``COMMENTS_ALLOW_PROFANITIES`` is ``False``.
|
|
|
|
|
|
|
|
|
|
|
|
.. _settings-messages:
|
|
|
|
|
|
|
|
Messages
|
|
|
|
========
|
|
|
|
|
|
|
|
Settings for :mod:`django.contrib.messages`.
|
|
|
|
|
|
|
|
.. setting:: MESSAGE_LEVEL
|
|
|
|
|
|
|
|
MESSAGE_LEVEL
|
|
|
|
-------------
|
|
|
|
|
2013-03-22 09:50:45 +00:00
|
|
|
Default: ``messages.INFO``
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
Sets the minimum message level that will be recorded by the messages
|
|
|
|
framework. See :ref:`message levels <message-level>` for more details.
|
|
|
|
|
|
|
|
.. admonition:: Important
|
|
|
|
|
|
|
|
If you override ``MESSAGE_LEVEL`` in your settings file and rely on any of
|
|
|
|
the built-in constants, you must import the constants module directly to
|
|
|
|
avoid the potential for circular imports, e.g.::
|
|
|
|
|
|
|
|
from django.contrib.messages import constants as message_constants
|
|
|
|
MESSAGE_LEVEL = message_constants.DEBUG
|
|
|
|
|
|
|
|
If desired, you may specify the numeric values for the constants directly
|
|
|
|
according 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.
|
|
|
|
|
2013-05-20 20:50:54 +00:00
|
|
|
The backends that use cookies -- ``CookieStorage`` and ``FallbackStorage`` --
|
|
|
|
use the value of :setting:`SESSION_COOKIE_DOMAIN` when setting their cookies.
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. 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 typically
|
|
|
|
rendered as a CSS class in HTML. If you specify a value, it will extend
|
|
|
|
the default. This means you only have to specify those values which you need
|
|
|
|
to override. See :ref:`message-displaying` above for more details.
|
|
|
|
|
|
|
|
.. admonition:: Important
|
|
|
|
|
|
|
|
If you override ``MESSAGE_TAGS`` in your settings file and rely on any of
|
|
|
|
the built-in constants, you must import the ``constants`` module directly to
|
|
|
|
avoid the potential for circular imports, e.g.::
|
|
|
|
|
|
|
|
from django.contrib.messages import constants as message_constants
|
|
|
|
MESSAGE_TAGS = {message_constants.INFO: ''}
|
|
|
|
|
|
|
|
If desired, you may specify the numeric values for the constants directly
|
|
|
|
according 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"`` (note the leading dot!) for cross-domain cookies, or use
|
|
|
|
``None`` for a standard domain cookie.
|
|
|
|
|
2013-03-19 02:18:35 +00:00
|
|
|
Be cautious when updating this setting on a production site. If you update
|
|
|
|
this setting to enable cross-domain cookies on a site that previously used
|
|
|
|
standard domain cookies, existing user cookies will be set to the old
|
|
|
|
domain. This may result in them being unable to log in as long as these cookies
|
|
|
|
persist.
|
|
|
|
|
2013-01-12 23:44:53 +00:00
|
|
|
.. setting:: SESSION_COOKIE_HTTPONLY
|
|
|
|
|
|
|
|
SESSION_COOKIE_HTTPONLY
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
2013-06-05 16:55:50 +00:00
|
|
|
Whether to use ``HTTPOnly`` flag on the session cookie. If this is set to
|
2013-01-12 23:44:53 +00:00
|
|
|
``True``, client-side JavaScript will not to be able to access the
|
|
|
|
session cookie.
|
|
|
|
|
|
|
|
HTTPOnly_ is a flag included in a Set-Cookie HTTP response header. It
|
|
|
|
is not part of the :rfc:`2109` standard for cookies, and it isn't honored
|
|
|
|
consistently by all browsers. However, when it is honored, it can be a
|
|
|
|
useful way to mitigate the risk of client side script accessing the
|
|
|
|
protected cookie data.
|
|
|
|
|
|
|
|
.. _HTTPOnly: https://www.owasp.org/index.php/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 (but
|
|
|
|
should be different from :setting:`LANGUAGE_COOKIE_NAME`).
|
|
|
|
|
|
|
|
.. setting:: SESSION_COOKIE_PATH
|
|
|
|
|
|
|
|
SESSION_COOKIE_PATH
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
Default: ``'/'``
|
|
|
|
|
|
|
|
The path set on the session cookie. This should either match the URL path of your
|
|
|
|
Django installation or be parent of that path.
|
|
|
|
|
|
|
|
This is useful if you have multiple Django instances running under the same
|
|
|
|
hostname. They can use different cookie paths, and each instance will only see
|
|
|
|
its own session cookie.
|
|
|
|
|
|
|
|
.. 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 may
|
|
|
|
ensure that the cookie is only sent under an HTTPS connection.
|
|
|
|
|
|
|
|
.. setting:: SESSION_ENGINE
|
|
|
|
|
|
|
|
SESSION_ENGINE
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Default: ``django.contrib.sessions.backends.db``
|
|
|
|
|
|
|
|
Controls where Django stores session data. Valid values 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 his or her browser. See
|
2013-04-04 16:12:12 +00:00
|
|
|
:ref:`browser-length-vs-persistent-sessions`.
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
.. setting:: SESSION_FILE_PATH
|
|
|
|
|
|
|
|
SESSION_FILE_PATH
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
If you're using file-based session storage, this sets the directory in
|
|
|
|
which Django will store session data. When the default value (``None``) is
|
|
|
|
used, 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.
|
|
|
|
|
|
|
|
|
|
|
|
Sites
|
|
|
|
=====
|
|
|
|
|
|
|
|
Settings for :mod:`django.contrib.sites`.
|
|
|
|
|
|
|
|
.. setting:: SITE_ID
|
|
|
|
|
|
|
|
SITE_ID
|
|
|
|
-------
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
|
|
|
The ID, as an integer, of the current site in the ``django_site`` database
|
|
|
|
table. This is used so that application data can hook into specific sites
|
|
|
|
and 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: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The absolute path to the directory where :djadmin:`collectstatic` will collect
|
|
|
|
static files for deployment.
|
|
|
|
|
|
|
|
Example: ``"/var/www/example.com/static/"``
|
|
|
|
|
|
|
|
If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled
|
|
|
|
(default) the :djadmin:`collectstatic` management command will collect static
|
|
|
|
files into this directory. See the howto on :doc:`managing static
|
2013-03-07 19:15:39 +00:00
|
|
|
files</howto/static-files/index>` for more details about usage.
|
2013-01-12 23:44:53 +00:00
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
|
|
This should be an (initially empty) destination directory for collecting
|
|
|
|
your static files from their permanent locations into one directory for
|
|
|
|
ease of deployment; it is **not** a place to store your static files
|
|
|
|
permanently. You should do that in directories that will be found by
|
|
|
|
: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:`media definitions<form-media-paths>` and the
|
|
|
|
:doc:`staticfiles app</ref/contrib/staticfiles>`.
|
|
|
|
|
|
|
|
It must end in a slash if set to a non-empty value.
|
|
|
|
|
|
|
|
.. setting:: STATICFILES_DIRS
|
|
|
|
|
|
|
|
STATICFILES_DIRS
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``[]``
|
|
|
|
|
|
|
|
This setting defines the additional locations the staticfiles app will traverse
|
|
|
|
if the ``FileSystemFinder`` finder is enabled, e.g. if you use the
|
|
|
|
:djadmin:`collectstatic` or :djadmin:`findstatic` management command or use the
|
|
|
|
static file serving view.
|
|
|
|
|
|
|
|
This should be set to a list or tuple of strings that contain full paths to
|
|
|
|
your additional files directory(ies) e.g.::
|
|
|
|
|
|
|
|
STATICFILES_DIRS = (
|
|
|
|
"/home/special.polls.com/polls/static",
|
|
|
|
"/home/polls.com/polls/static",
|
|
|
|
"/opt/webfiles/common",
|
|
|
|
)
|
|
|
|
|
|
|
|
Prefixes (optional)
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
In case you want to refer to files in one of the locations with an additional
|
|
|
|
namespace, you can **optionally** provide a prefix as ``(prefix, path)``
|
|
|
|
tuples, e.g.::
|
|
|
|
|
|
|
|
STATICFILES_DIRS = (
|
|
|
|
# ...
|
|
|
|
("downloads", "/opt/webfiles/stats"),
|
|
|
|
)
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
Assuming you have :setting:`STATIC_URL` set ``'/static/'``, the
|
|
|
|
:djadmin:`collectstatic` management command would collect the "stats" files
|
|
|
|
in 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_URL }}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 setting
|
|
|
|
can 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 in
|
|
|
|
various 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``)
|
|
|
|
|
|
|
|
One finder is disabled by default:
|
|
|
|
``django.contrib.staticfiles.finders.DefaultStorageFinder``. If added to
|
|
|
|
your :setting:`STATICFILES_FINDERS` setting, it will look for static files in
|
|
|
|
the default file storage as defined by the :setting:`DEFAULT_FILE_STORAGE`
|
|
|
|
setting.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
When using the ``AppDirectoriesFinder`` finder, make sure your apps
|
|
|
|
can be found by staticfiles. Simply add the app to the
|
|
|
|
:setting:`INSTALLED_APPS` setting of your site.
|
|
|
|
|
|
|
|
Static file finders are currently considered a private interface, and this
|
|
|
|
interface is thus undocumented.
|
|
|
|
|
|
|
|
Core Settings Topical Index
|
|
|
|
===========================
|
|
|
|
|
|
|
|
Cache
|
|
|
|
-----
|
|
|
|
* :setting:`CACHES`
|
|
|
|
* :setting:`CACHE_MIDDLEWARE_ALIAS`
|
|
|
|
* :setting:`CACHE_MIDDLEWARE_ANONYMOUS_ONLY`
|
|
|
|
* :setting:`CACHE_MIDDLEWARE_KEY_PREFIX`
|
|
|
|
* :setting:`CACHE_MIDDLEWARE_SECONDS`
|
|
|
|
|
|
|
|
Database
|
|
|
|
--------
|
|
|
|
* :setting:`DATABASES`
|
|
|
|
* :setting:`DATABASE_ROUTERS`
|
|
|
|
* :setting:`DEFAULT_INDEX_TABLESPACE`
|
|
|
|
* :setting:`DEFAULT_TABLESPACE`
|
|
|
|
* :setting:`TRANSACTIONS_MANAGED`
|
|
|
|
|
|
|
|
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_SUBJECT_PREFIX`
|
|
|
|
* :setting:`EMAIL_USE_TLS`
|
|
|
|
* :setting:`MANAGERS`
|
|
|
|
* :setting:`SEND_BROKEN_LINK_EMAILS`
|
|
|
|
* :setting:`SERVER_EMAIL`
|
|
|
|
|
|
|
|
Error reporting
|
|
|
|
---------------
|
|
|
|
* :setting:`DEFAULT_EXCEPTION_REPORTER_FILTER`
|
|
|
|
* :setting:`IGNORABLE_404_URLS`
|
|
|
|
* :setting:`MANAGERS`
|
|
|
|
* :setting:`SEND_BROKEN_LINK_EMAILS`
|
|
|
|
|
|
|
|
File uploads
|
|
|
|
------------
|
|
|
|
* :setting:`DEFAULT_FILE_STORAGE`
|
|
|
|
* :setting:`FILE_CHARSET`
|
|
|
|
* :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`
|
|
|
|
|
|
|
|
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_NAME`
|
|
|
|
* :setting:`LANGUAGES`
|
|
|
|
* :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:`DEFAULT_CHARSET`
|
|
|
|
* :setting:`DEFAULT_CONTENT_TYPE`
|
|
|
|
* :setting:`DISALLOWED_USER_AGENTS`
|
|
|
|
* :setting:`FORCE_SCRIPT_NAME`
|
|
|
|
* :setting:`INTERNAL_IPS`
|
|
|
|
* :setting:`MIDDLEWARE_CLASSES`
|
|
|
|
* :setting:`SECURE_PROXY_SSL_HEADER`
|
|
|
|
* :setting:`SIGNING_BACKEND`
|
|
|
|
* :setting:`USE_ETAGS`
|
|
|
|
* :setting:`USE_X_FORWARDED_HOST`
|
|
|
|
* :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_SECURE`
|
|
|
|
* :setting:`CSRF_FAILURE_VIEW`
|
|
|
|
|
|
|
|
* :setting:`SECRET_KEY`
|
|
|
|
* :setting:`X_FRAME_OPTIONS`
|
|
|
|
|
|
|
|
Serialization
|
|
|
|
-------------
|
|
|
|
* :setting:`DEFAULT_CHARSET`
|
|
|
|
* :setting:`SERIALIZATION_MODULES`
|
|
|
|
|
|
|
|
Templates
|
|
|
|
---------
|
|
|
|
* :setting:`ALLOWED_INCLUDE_ROOTS`
|
|
|
|
* :setting:`TEMPLATE_CONTEXT_PROCESSORS`
|
|
|
|
* :setting:`TEMPLATE_DEBUG`
|
|
|
|
* :setting:`TEMPLATE_DIRS`
|
|
|
|
* :setting:`TEMPLATE_LOADERS`
|
|
|
|
* :setting:`TEMPLATE_STRING_IF_INVALID`
|
|
|
|
|
|
|
|
Testing
|
|
|
|
-------
|
|
|
|
* Database
|
|
|
|
|
|
|
|
* :setting:`TEST_CHARSET`
|
|
|
|
* :setting:`TEST_COLLATION`
|
|
|
|
* :setting:`TEST_DEPENDENCIES`
|
|
|
|
* :setting:`TEST_MIRROR`
|
|
|
|
* :setting:`TEST_NAME`
|
|
|
|
* :setting:`TEST_CREATE`
|
|
|
|
* :setting:`TEST_USER`
|
|
|
|
* :setting:`TEST_USER_CREATE`
|
|
|
|
* :setting:`TEST_PASSWD`
|
|
|
|
* :setting:`TEST_TBLSPACE`
|
|
|
|
* :setting:`TEST_TBLSPACE_TMP`
|
|
|
|
|
|
|
|
* :setting:`TEST_RUNNER`
|
|
|
|
|
|
|
|
URLs
|
|
|
|
----
|
|
|
|
* :setting:`APPEND_SLASH`
|
|
|
|
* :setting:`PREPEND_WWW`
|
|
|
|
* :setting:`ROOT_URLCONF`
|