2008-08-23 22:25:40 +00:00
|
|
|
.. _ref-settings:
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
Available settings
|
|
|
|
==================
|
|
|
|
|
|
|
|
Here's a full list of all available settings, in alphabetical order, and their
|
|
|
|
default values.
|
|
|
|
|
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:: ADMIN_FOR
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
ADMIN_FOR
|
|
|
|
---------
|
|
|
|
|
2007-10-19 06:53:30 +00:00
|
|
|
Default: ``()`` (Empty tuple)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2006-05-02 01:31:56 +00:00
|
|
|
The admin site uses this in its automatically-introspected documentation of
|
|
|
|
models, views and template tags.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: ADMIN_MEDIA_PREFIX
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
ADMIN_MEDIA_PREFIX
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``'/media/'``
|
|
|
|
|
2008-03-18 22:36:30 +00:00
|
|
|
The URL prefix for admin media -- CSS, JavaScript and images used by
|
|
|
|
the Django administrative interface. Make sure to use a trailing
|
|
|
|
slash, and to have this be different from the ``MEDIA_URL`` setting
|
|
|
|
(since the same URL cannot be mapped onto two different sets of
|
|
|
|
files).
|
2005-10-17 04:53:03 +00:00
|
|
|
|
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
|
|
|
|
``DEBUG=False`` and a view raises an exception, Django will e-mail these people
|
|
|
|
with the full exception information. Each member of the tuple should be a tuple
|
|
|
|
of (Full name, e-mail address). Example::
|
|
|
|
|
|
|
|
(('John', 'john@example.com'), ('Mary', 'mary@example.com'))
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
Note that Django will e-mail *all* of these people whenever an error happens.
|
|
|
|
See :ref:`howto-error-reporting` for more information.
|
|
|
|
|
|
|
|
.. 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.
|
|
|
|
|
|
|
|
For example, if ``ALLOWED_INCLUDE_ROOTS`` is ``('/home/html', '/var/www')``,
|
|
|
|
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``
|
|
|
|
|
|
|
|
Whether to append trailing slashes to URLs. This is only used if
|
2008-08-23 22:25:40 +00:00
|
|
|
``CommonMiddleware`` is installed (see :ref:`topics-http-middleware`). See also
|
2005-10-17 04:53:03 +00:00
|
|
|
``PREPEND_WWW``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: AUTHENTICATION_BACKENDS
|
|
|
|
|
2007-12-01 17:27:44 +00:00
|
|
|
AUTHENTICATION_BACKENDS
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``('django.contrib.auth.backends.ModelBackend',)``
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
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.
|
2007-12-01 17:27:44 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: AUTH_PROFILE_MODULE
|
2007-12-01 17:27:44 +00:00
|
|
|
|
2007-12-01 20:45:05 +00:00
|
|
|
AUTH_PROFILE_MODULE
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
The site-specific user profile model used by this site. See
|
|
|
|
:ref:`auth-profiles`.
|
2007-12-01 20:45:05 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: CACHE_BACKEND
|
2007-12-01 20:45:05 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
CACHE_BACKEND
|
|
|
|
-------------
|
|
|
|
|
2008-07-18 23:46:10 +00:00
|
|
|
Default: ``'locmem://'``
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
The cache backend to use. See :ref:`topics-cache`.
|
|
|
|
|
|
|
|
.. 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)
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
The cache key prefix that the cache middleware should use. See
|
|
|
|
:ref:`topics-cache`.
|
|
|
|
|
|
|
|
.. 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.
|
|
|
|
|
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_NAME
|
|
|
|
|
|
|
|
CSRF_COOKIE_NAME
|
|
|
|
----------------
|
2009-10-27 01:10:20 +00:00
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
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
|
|
|
Default: ``'csrftoken'``
|
|
|
|
|
|
|
|
The name of the cookie to use for the CSRF authentication token. This can be whatever you
|
|
|
|
want. See :ref:`ref-contrib-csrf`.
|
|
|
|
|
|
|
|
.. setting:: CSRF_COOKIE_DOMAIN
|
|
|
|
|
|
|
|
CSRF_COOKIE_DOMAIN
|
|
|
|
------------------
|
|
|
|
|
2009-10-27 01:10:20 +00:00
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
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
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The domain to be used when setting the CSRF cookie. This can be useful for
|
|
|
|
allowing cross-subdomain requests to be exluded from the normal cross site
|
|
|
|
request forgery protection. It should be set to a string such as
|
|
|
|
``".lawrence.com"`` to allow a POST request from a form on one subdomain to be
|
|
|
|
accepted by accepted by a view served from another subdomain.
|
|
|
|
|
|
|
|
.. setting:: CSRF_FAILURE_VIEW
|
|
|
|
|
|
|
|
CSRF_FAILURE_VIEW
|
|
|
|
-----------------
|
|
|
|
|
2009-10-27 01:10:20 +00:00
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
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
|
|
|
|
:ref:`ref-contrib-csrf`.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_ENGINE
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_ENGINE
|
|
|
|
---------------
|
|
|
|
|
2007-02-28 19:28:30 +00:00
|
|
|
Default: ``''`` (Empty string)
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-11-15 05:51:25 +00:00
|
|
|
The database backend to use. The built-in database backends are
|
2008-07-18 17:38:53 +00:00
|
|
|
``'postgresql_psycopg2'``, ``'postgresql'``, ``'mysql'``, ``'sqlite3'``, and
|
|
|
|
``'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
|
|
|
|
``DATABASE_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
|
|
|
|
2008-11-15 05:51:25 +00:00
|
|
|
.. versionadded:: 1.0
|
|
|
|
Support for external database backends is new in 1.0.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_HOST
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_HOST
|
|
|
|
-------------
|
|
|
|
|
|
|
|
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::
|
|
|
|
|
|
|
|
DATABASE_HOST = '/var/run/mysql'
|
|
|
|
|
|
|
|
If you're using MySQL and this value *doesn't* start with a forward slash, then
|
|
|
|
this value is assumed to be the host.
|
|
|
|
|
2007-05-27 11:33:57 +00:00
|
|
|
If you're using PostgreSQL, an empty string means to use a Unix domain socket
|
|
|
|
for the connection, rather than a network connection to localhost. If you
|
2008-08-23 22:25:40 +00:00
|
|
|
explicitly need to use a TCP/IP connection on the local machine with
|
2007-05-27 11:33:57 +00:00
|
|
|
PostgreSQL, specify ``localhost`` here.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_NAME
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_NAME
|
|
|
|
-------------
|
|
|
|
|
|
|
|
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
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_OPTIONS
|
|
|
|
|
2006-11-07 05:17:38 +00:00
|
|
|
DATABASE_OPTIONS
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Default: ``{}`` (Empty dictionary)
|
|
|
|
|
|
|
|
Extra parameters to use when connecting to the database. Consult backend
|
|
|
|
module's document for available keywords.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_PASSWORD
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_PASSWORD
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The password to use when connecting to the database. Not used with SQLite.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_PORT
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_PORT
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The port to use when connecting to the database. An empty string means the
|
|
|
|
default port. Not used with SQLite.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DATABASE_USER
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DATABASE_USER
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
The username to use when connecting to the database. Not used with SQLite.
|
|
|
|
|
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``)
|
|
|
|
|
|
|
|
The default formatting to use for date fields on Django admin change-list
|
|
|
|
pages -- and, possibly, by other parts of the system. See
|
2008-08-23 22:25:40 +00:00
|
|
|
:ttag:`allowed date format strings <now>`.
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2007-09-14 16:40:42 +00:00
|
|
|
See also ``DATETIME_FORMAT``, ``TIME_FORMAT``, ``YEAR_MONTH_FORMAT``
|
|
|
|
and ``MONTH_DAY_FORMAT``.
|
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.``)
|
|
|
|
|
|
|
|
The default formatting to use for datetime fields on Django admin change-list
|
|
|
|
pages -- and, possibly, by other parts of the system. See
|
2008-08-23 22:25:40 +00:00
|
|
|
:ttag:`allowed date format strings <now>`.
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2007-09-14 16:40:42 +00:00
|
|
|
See also ``DATE_FORMAT``, ``DATETIME_FORMAT``, ``TIME_FORMAT``,
|
|
|
|
``YEAR_MONTH_FORMAT`` and ``MONTH_DAY_FORMAT``.
|
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.
|
|
|
|
|
2008-09-07 23:08:01 +00:00
|
|
|
If you define custom settings, `django/views/debug.py`_ has a ``HIDDEN_SETTINGS``
|
2007-09-14 16:40:42 +00:00
|
|
|
regular expression which will hide from the DEBUG view anything that contains
|
|
|
|
``'SECRET'``, ``'PASSWORD'``, or ``'PROFANITIES'``. This allows untrusted users to
|
2007-02-26 21:22:21 +00:00
|
|
|
be able to give backtraces without seeing sensitive (or offensive) settings.
|
|
|
|
|
|
|
|
Still, note that there are always going to be sections of your debug output that
|
2007-09-20 23:56:54 +00:00
|
|
|
are inappropriate for public consumption. File paths, configuration options, and
|
2008-08-23 22:25:40 +00:00
|
|
|
the like all give attackers extra information about your server.
|
2008-06-19 12:13:43 +00:00
|
|
|
|
|
|
|
It is also important to remember that when running with ``DEBUG`` turned on, Django
|
|
|
|
will remember every SQL query it executes. This is useful when you are debugging,
|
|
|
|
but on a production server, it will rapidly consume memory.
|
|
|
|
|
|
|
|
Never deploy a site into production with ``DEBUG`` turned on.
|
2007-02-26 21:22:21 +00:00
|
|
|
|
2008-09-07 23:08:01 +00:00
|
|
|
.. _django/views/debug.py: http://code.djangoproject.com/browser/django/trunk/django/views/debug.py
|
|
|
|
|
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
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2008-06-12 03:36:48 +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.
|
|
|
|
|
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
|
|
|
|
manually specified. Used with ``DEFAULT_CONTENT_TYPE`` to construct the
|
|
|
|
``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
|
|
|
|
isn't manually specified. Used with ``DEFAULT_CHARSET`` to construct the
|
|
|
|
``Content-Type`` header.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEFAULT_FROM_EMAIL
|
|
|
|
|
2008-08-08 20:59:02 +00:00
|
|
|
DEFAULT_FILE_STORAGE
|
|
|
|
--------------------
|
|
|
|
|
2009-06-18 13:33:18 +00:00
|
|
|
Default: ``'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
|
2008-08-23 22:25:40 +00:00
|
|
|
specify a particular storage system. See :ref:`topics-files`.
|
2008-08-08 20:59:02 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
DEFAULT_FROM_EMAIL
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``'webmaster@localhost'``
|
|
|
|
|
|
|
|
Default e-mail address to use for various automated correspondence from the
|
|
|
|
site manager(s).
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEFAULT_TABLESPACE
|
|
|
|
|
2007-12-01 19:23:49 +00:00
|
|
|
DEFAULT_TABLESPACE
|
|
|
|
------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-12-04 06:13:56 +00:00
|
|
|
|
2007-12-01 19:23:49 +00:00
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2007-12-04 06:13:56 +00:00
|
|
|
Default tablespace to use for models that don't specify one, if the
|
2007-12-01 19:23:49 +00:00
|
|
|
backend supports it.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: DEFAULT_INDEX_TABLESPACE
|
|
|
|
|
2007-12-01 19:23:49 +00:00
|
|
|
DEFAULT_INDEX_TABLESPACE
|
|
|
|
------------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-12-04 06:13:56 +00:00
|
|
|
|
2007-12-01 19:23:49 +00:00
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
2007-12-04 06:13:56 +00:00
|
|
|
Default tablespace to use for indexes on fields that don't specify
|
2007-12-01 19:23:49 +00:00
|
|
|
one, if the backend supports it.
|
|
|
|
|
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
|
|
|
|
:ref:`topics-http-middleware`).
|
|
|
|
|
2009-11-03 12:53:26 +00:00
|
|
|
.. setting:: EMAIL_BACKEND
|
|
|
|
|
|
|
|
EMAIL_BACKEND
|
|
|
|
-------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
2009-11-04 05:51:13 +00:00
|
|
|
Default: ``'django.core.mail.backends.smtp'``
|
2009-11-03 12:53:26 +00:00
|
|
|
|
|
|
|
The backend to use for sending emails. For the list of available backends see
|
|
|
|
:ref:`topics-email`.
|
|
|
|
|
|
|
|
.. setting:: EMAIL_FILE_PATH
|
|
|
|
|
|
|
|
EMAIL_FILE_PATH
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
|
|
|
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'``
|
|
|
|
|
|
|
|
The host to use for sending e-mail.
|
|
|
|
|
2006-04-11 03:23:03 +00:00
|
|
|
See also ``EMAIL_PORT``.
|
|
|
|
|
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)
|
|
|
|
|
2007-04-27 14:25:05 +00:00
|
|
|
Password to use for the SMTP server defined in ``EMAIL_HOST``. This setting is
|
2007-04-28 04:08:31 +00:00
|
|
|
used in conjunction with ``EMAIL_HOST_USER`` when authenticating to the SMTP
|
|
|
|
server. If either of these settings is empty, Django won't attempt
|
2008-08-23 22:25:40 +00:00
|
|
|
authentication.
|
2006-03-22 19:47:15 +00:00
|
|
|
|
|
|
|
See also ``EMAIL_HOST_USER``.
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
Username to use for the SMTP server defined in ``EMAIL_HOST``. If empty,
|
|
|
|
Django won't attempt authentication.
|
|
|
|
|
|
|
|
See also ``EMAIL_HOST_PASSWORD``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: EMAIL_PORT
|
|
|
|
|
2006-04-11 03:23:03 +00:00
|
|
|
EMAIL_PORT
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``25``
|
|
|
|
|
|
|
|
Port to use for the SMTP server defined in ``EMAIL_HOST``.
|
|
|
|
|
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] '``
|
|
|
|
|
|
|
|
Subject-line prefix for e-mail messages sent with ``django.core.mail.mail_admins``
|
|
|
|
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
|
|
|
|
-------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-05-03 17:52:38 +00:00
|
|
|
|
2007-05-03 13:35:02 +00:00
|
|
|
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
|
|
|
|
------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
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
|
|
|
|
|
|
|
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
|
|
|
|
--------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2008-07-01 15:10:51 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
A tuple of handlers to use for uploading. See :ref:`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
|
|
|
|
---------------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2008-07-01 15:10:51 +00:00
|
|
|
|
|
|
|
Default: ``2621440`` (i.e. 2.5 MB).
|
|
|
|
|
|
|
|
The maximum size (in bytes) that an upload will be before it gets streamed to
|
2008-08-23 22:25:40 +00:00
|
|
|
the file system. See :ref:`topics-files` for details.
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2008-08-27 22:21:14 +00:00
|
|
|
.. setting:: FILE_UPLOAD_TEMP_DIR
|
|
|
|
|
2008-07-01 15:10:51 +00:00
|
|
|
FILE_UPLOAD_TEMP_DIR
|
|
|
|
--------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2008-07-01 15:10:51 +00:00
|
|
|
|
|
|
|
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
|
2008-07-30 03:19:31 +00:00
|
|
|
example, this will default to '/tmp' on \*nix-style operating systems.
|
2008-07-01 15:10:51 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`topics-files` for details.
|
|
|
|
|
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
|
|
|
|
more information about what these modes mean, see the `documentation for
|
|
|
|
os.chmod`_
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
.. _documentation for os.chmod: http://docs.python.org/lib/os-file-dir.html
|
2008-08-27 22:21:14 +00:00
|
|
|
|
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)
|
|
|
|
|
|
|
|
List of locations of the fixture data files, in search order. Note that
|
2007-10-20 05:13:56 +00:00
|
|
|
these paths should use Unix-style forward slashes, even on Windows. See
|
2008-08-23 22:25:40 +00:00
|
|
|
:ref:`topics-testing`.
|
2007-03-01 13:11:08 +00:00
|
|
|
|
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.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: IGNORABLE_404_ENDS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
IGNORABLE_404_ENDS
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``('mail.pl', 'mailform.pl', 'mail.cgi', 'mailform.cgi', 'favicon.ico', '.php')``
|
|
|
|
|
2007-02-26 21:33:04 +00:00
|
|
|
See also ``IGNORABLE_404_STARTS`` and ``Error reporting via e-mail``.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: IGNORABLE_404_STARTS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
IGNORABLE_404_STARTS
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
Default: ``('/cgi-bin/', '/_vti_bin', '/_vti_inf')``
|
|
|
|
|
|
|
|
A tuple of strings that specify beginnings of URLs that should be ignored by
|
2007-02-26 21:18:31 +00:00
|
|
|
the 404 e-mailer. See ``SEND_BROKEN_LINK_EMAILS``, ``IGNORABLE_404_ENDS`` and
|
2008-08-23 22:25:40 +00:00
|
|
|
the :ref:`howto-error-reporting`.
|
|
|
|
|
|
|
|
.. 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
|
|
|
|
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:
|
|
|
|
|
|
|
|
* See debug comments, when ``DEBUG`` is ``True``
|
2008-08-23 22:25:40 +00:00
|
|
|
* Receive X headers if the ``XViewMiddleware`` is installed (see
|
|
|
|
:ref:`topics-http-middleware`)
|
|
|
|
|
|
|
|
.. 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
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
A string representing the language code for this installation. This should be in
|
|
|
|
standard language format. For example, U.S. English is ``"en-us"``. See
|
|
|
|
:ref:`topics-i18n`.
|
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
|
|
|
|
--------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2008-03-13 20:26:08 +00:00
|
|
|
|
2008-02-29 18:38:44 +00:00
|
|
|
Default: ``'django_language'``
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
The name of the cookie to use for the language cookie. This can be whatever you
|
|
|
|
want (but should be different from ``SESSION_COOKIE_NAME``). See
|
|
|
|
:ref:`topics-i18n`.
|
|
|
|
|
|
|
|
.. 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`_).
|
|
|
|
|
|
|
|
.. _online source: http://code.djangoproject.com/browser/django/trunk/django/conf/global_settings.py
|
|
|
|
|
|
|
|
The list is a tuple of two-tuples in the format (language code, language
|
|
|
|
name) -- for example, ``('ja', 'Japanese')``. This specifies which languages
|
2008-08-23 22:25:40 +00:00
|
|
|
are available for language selection. See :ref:`topics-i18n`.
|
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
|
|
|
|
2006-07-11 02:49:56 +00:00
|
|
|
If you define a custom ``LANGUAGES`` setting, it's OK to mark the languages as
|
|
|
|
translation strings (as in the default value displayed 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.
|
|
|
|
|
|
|
|
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*
|
|
|
|
``gettext()`` in any code that uses ``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.
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`translations-in-your-own-projects`.
|
2007-10-19 03:18:15 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: LOGIN_REDIRECT_URL
|
2007-10-19 03:18:15 +00:00
|
|
|
|
2007-04-26 14:51:50 +00:00
|
|
|
LOGIN_REDIRECT_URL
|
|
|
|
------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-04-26 14:51:50 +00:00
|
|
|
|
|
|
|
Default: ``'/accounts/profile/'``
|
|
|
|
|
|
|
|
The URL where requests are redirected after login when the
|
|
|
|
``contrib.auth.login`` view gets no ``next`` parameter.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
This is used by the :func:`~django.contrib.auth.decorators.login_required`
|
|
|
|
decorator, for example.
|
|
|
|
|
|
|
|
.. setting:: LOGIN_URL
|
2007-04-26 14:51:50 +00:00
|
|
|
|
2007-04-25 08:49:57 +00:00
|
|
|
LOGIN_URL
|
|
|
|
---------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-04-26 14:51:50 +00:00
|
|
|
|
2007-04-25 08:49:57 +00:00
|
|
|
Default: ``'/accounts/login/'``
|
|
|
|
|
|
|
|
The URL where requests are redirected for login, specially when using the
|
2008-08-23 22:25:40 +00:00
|
|
|
:func:`~django.contrib.auth.decorators.login_required` decorator.
|
|
|
|
|
|
|
|
.. setting:: LOGOUT_URL
|
2007-04-25 08:49:57 +00:00
|
|
|
|
|
|
|
LOGOUT_URL
|
|
|
|
----------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-04-26 14:51:50 +00:00
|
|
|
|
2007-04-25 08:49:57 +00:00
|
|
|
Default: ``'/accounts/logout/'``
|
|
|
|
|
|
|
|
LOGIN_URL counterpart.
|
|
|
|
|
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
|
|
|
|
|
|
|
A tuple in the same format as ``ADMINS`` that specifies who should get
|
|
|
|
broken-link notifications when ``SEND_BROKEN_LINK_EMAILS=True``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MEDIA_ROOT
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MEDIA_ROOT
|
|
|
|
----------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
Absolute path to the directory that holds media for this installation.
|
|
|
|
Example: ``"/home/media/media.lawrence.com/"`` See also ``MEDIA_URL``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MEDIA_URL
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
MEDIA_URL
|
|
|
|
---------
|
|
|
|
|
|
|
|
Default: ``''`` (Empty string)
|
|
|
|
|
|
|
|
URL that handles the media served from ``MEDIA_ROOT``.
|
|
|
|
Example: ``"http://media.lawrence.com"``
|
|
|
|
|
2007-01-23 02:30:55 +00:00
|
|
|
Note that this should have a trailing slash if it has a path component.
|
|
|
|
|
|
|
|
Good: ``"http://www.example.com/static/"``
|
|
|
|
Bad: ``"http://www.example.com/static"``
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: MIDDLEWARE_CLASSES
|
|
|
|
|
2009-12-09 16:57:23 +00:00
|
|
|
MESSAGE_LEVEL
|
|
|
|
-------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
|
|
|
Default: `messages.INFO`
|
|
|
|
|
2009-12-14 12:08:23 +00:00
|
|
|
Sets the minimum message level that will be recorded by the messages
|
2009-12-09 16:57:23 +00:00
|
|
|
framework. See the :ref:`messages documentation <ref-contrib-messages>` for
|
|
|
|
more details.
|
|
|
|
|
|
|
|
MESSAGE_STORAGE
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
|
|
|
Default: ``'django.contrib.messages.storage.user_messages.LegacyFallbackStorage'``
|
|
|
|
|
|
|
|
Controls where Django stores message data. See the
|
|
|
|
:ref:`messages documentation <ref-contrib-messages>` for more details.
|
|
|
|
|
|
|
|
MESSAGE_TAGS
|
|
|
|
------------
|
|
|
|
|
|
|
|
.. versionadded:: 1.2
|
|
|
|
|
|
|
|
Default::
|
|
|
|
|
|
|
|
{messages.DEBUG: 'debug',
|
|
|
|
messages.INFO: 'info',
|
|
|
|
messages.SUCCESS: 'success',
|
|
|
|
messages.WARNING: 'warning',
|
|
|
|
messages.ERROR: 'error',}
|
|
|
|
|
|
|
|
Sets the mapping of message levels to message tags. See the
|
|
|
|
:ref:`messages documentation <ref-contrib-messages>` for more details.
|
|
|
|
|
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
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
A tuple of middleware classes to use. See :ref:`topics-http-middleware`.
|
|
|
|
|
2009-12-09 16:57:23 +00:00
|
|
|
.. versionchanged:: 1.2
|
|
|
|
``'django.contrib.messages.middleware.MessageMiddleware'`` was added to the
|
|
|
|
default. For more information, see the :ref:`messages documentation
|
|
|
|
<ref-contrib-messages>`.
|
|
|
|
|
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."
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ttag:`allowed date format strings <now>`. See also ``DATE_FORMAT``,
|
2007-09-14 16:40:42 +00:00
|
|
|
``DATETIME_FORMAT``, ``TIME_FORMAT`` and ``YEAR_MONTH_FORMAT``.
|
2006-06-02 04:20:32 +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
|
|
|
|
used if ``CommonMiddleware`` is installed (see :ref:`topics-http-middleware`).
|
2005-10-17 13:20:59 +00:00
|
|
|
See also ``APPEND_SLASH``.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: PROFANITIES_LIST
|
|
|
|
|
2006-09-22 02:48:19 +00:00
|
|
|
PROFANITIES_LIST
|
|
|
|
----------------
|
|
|
|
|
2006-09-25 17:38:35 +00:00
|
|
|
A tuple of profanities, as strings, that will trigger a validation error when
|
|
|
|
the ``hasNoProfanities`` validator is called.
|
|
|
|
|
|
|
|
We don't list the default values here, because that would be profane. To see
|
2008-09-07 23:08:01 +00:00
|
|
|
the default values, see the file `django/conf/global_settings.py`_.
|
2006-09-22 02:48:19 +00:00
|
|
|
|
2008-09-07 23:08:01 +00:00
|
|
|
.. _django/conf/global_settings.py: http://code.djangoproject.com/browser/django/trunk/django/conf/global_settings.py
|
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)
|
|
|
|
|
|
|
|
A secret key for this particular Django installation. Used to provide a seed in
|
|
|
|
secret-key hashing algorithms. Set this to a random string -- the longer, the
|
|
|
|
better. ``django-admin.py startproject`` creates one automatically.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: SEND_BROKEN_LINK_EMAILS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
SEND_BROKEN_LINK_EMAILS
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
Whether to send an e-mail to the ``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
|
|
|
|
:ref:`topics-http-middleware`. See also ``IGNORABLE_404_STARTS``,
|
|
|
|
``IGNORABLE_404_ENDS`` and :ref:`howto-error-reporting`.
|
|
|
|
|
|
|
|
.. 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'``
|
|
|
|
|
|
|
|
The e-mail address that error messages come from, such as those sent to
|
|
|
|
``ADMINS`` and ``MANAGERS``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: SESSION_ENGINE
|
|
|
|
|
2007-09-15 21:29:14 +00:00
|
|
|
SESSION_ENGINE
|
|
|
|
--------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-09-15 21:29:14 +00:00
|
|
|
|
|
|
|
Default: ``django.contrib.sessions.backends.db``
|
|
|
|
|
|
|
|
Controls where Django stores session data. Valid values are:
|
|
|
|
|
2007-10-20 05:13:56 +00:00
|
|
|
* ``'django.contrib.sessions.backends.db'``
|
|
|
|
* ``'django.contrib.sessions.backends.file'``
|
2007-09-15 21:29:14 +00:00
|
|
|
* ``'django.contrib.sessions.backends.cache'``
|
2007-10-20 05:13:56 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_COOKIE_AGE
|
2007-09-15 21:29:14 +00:00
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
SESSION_COOKIE_AGE
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``1209600`` (2 weeks, in seconds)
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
The age of session cookies, in seconds. See :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_COOKIE_DOMAIN
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
SESSION_COOKIE_DOMAIN
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The domain to use for session cookies. Set this to a string such as
|
|
|
|
``".lawrence.com"`` for cross-domain cookies, or use ``None`` for a standard
|
2008-08-23 22:25:40 +00:00
|
|
|
domain cookie. See the :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_COOKIE_NAME
|
2005-10-17 04:53:03 +00:00
|
|
|
|
|
|
|
SESSION_COOKIE_NAME
|
|
|
|
-------------------
|
|
|
|
|
2006-01-11 00:11:29 +00:00
|
|
|
Default: ``'sessionid'``
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2008-02-29 18:38:44 +00:00
|
|
|
The name of the cookie to use for sessions. This can be whatever you want (but
|
2008-08-23 22:25:40 +00:00
|
|
|
should be different from ``LANGUAGE_COOKIE_NAME``). See the :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_COOKIE_PATH
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2007-10-20 05:13:56 +00:00
|
|
|
SESSION_COOKIE_PATH
|
|
|
|
-------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-10-20 06:30:44 +00:00
|
|
|
|
2007-10-20 05:13:56 +00:00
|
|
|
Default: ``'/'``
|
|
|
|
|
2007-11-30 05:22:35 +00:00
|
|
|
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.
|
2007-10-20 05:13:56 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: SESSION_COOKIE_SECURE
|
|
|
|
|
2006-08-12 06:02:28 +00:00
|
|
|
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.
|
2008-08-23 22:25:40 +00:00
|
|
|
See the :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_EXPIRE_AT_BROWSER_CLOSE
|
2006-08-12 06:02:28 +00:00
|
|
|
|
2006-06-01 22:25:06 +00:00
|
|
|
SESSION_EXPIRE_AT_BROWSER_CLOSE
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
Whether to expire the session when the user closes his or her browser.
|
2008-08-23 22:25:40 +00:00
|
|
|
See the :ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SESSION_FILE_PATH
|
2006-06-01 22:25:06 +00:00
|
|
|
|
2007-09-15 21:29:14 +00:00
|
|
|
SESSION_FILE_PATH
|
|
|
|
-----------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-09-15 21:29:14 +00:00
|
|
|
|
2008-08-27 05:57:10 +00:00
|
|
|
Default: ``None``
|
2007-09-15 21:29:14 +00:00
|
|
|
|
|
|
|
If you're using file-based session storage, this sets the directory in
|
2008-08-27 05:57:10 +00:00
|
|
|
which Django will store session data. See :ref:`topics-http-sessions`. When
|
|
|
|
the default value (``None``) is used, Django will use the standard temporary
|
|
|
|
directory for the system.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
.. setting:: SESSION_SAVE_EVERY_REQUEST
|
2007-09-15 21:29:14 +00:00
|
|
|
|
2005-11-20 17:16:13 +00:00
|
|
|
SESSION_SAVE_EVERY_REQUEST
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
Whether to save the session data on every request. See
|
|
|
|
:ref:`topics-http-sessions`.
|
|
|
|
|
|
|
|
.. setting:: SITE_ID
|
2005-11-20 17:16:13 +00:00
|
|
|
|
2005-11-11 03:50:21 +00:00
|
|
|
SITE_ID
|
|
|
|
-------
|
|
|
|
|
|
|
|
Default: Not defined
|
|
|
|
|
2006-05-02 01:31:56 +00:00
|
|
|
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 site(s)
|
|
|
|
and a single database can manage content for multiple sites.
|
2005-11-11 03:50:21 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`ref-contrib-sites`.
|
2006-05-22 04:48:44 +00:00
|
|
|
|
2007-01-24 20:08:47 +00:00
|
|
|
.. _site framework docs: ../sites/
|
2006-05-22 04:48:44 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEMPLATE_CONTEXT_PROCESSORS
|
|
|
|
|
2005-12-24 04:39:59 +00:00
|
|
|
TEMPLATE_CONTEXT_PROCESSORS
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
Default::
|
|
|
|
|
|
|
|
("django.core.context_processors.auth",
|
|
|
|
"django.core.context_processors.debug",
|
2007-05-29 11:09:24 +00:00
|
|
|
"django.core.context_processors.i18n",
|
2009-12-09 16:57:23 +00:00
|
|
|
"django.core.context_processors.media",
|
|
|
|
"django.contrib.messages.context_processors.messages")
|
2005-12-24 04:39:59 +00:00
|
|
|
|
2006-05-02 01:31:56 +00:00
|
|
|
A tuple of callables that are used to populate the context in ``RequestContext``.
|
2005-12-24 04:39:59 +00:00
|
|
|
These callables take a request object as their argument and return a dictionary
|
|
|
|
of items to be merged into the context.
|
|
|
|
|
2009-12-09 16:57:23 +00:00
|
|
|
.. versionchanged:: 1.2
|
|
|
|
``"django.contrib.messages.context_processors.messages"`` was added to the
|
|
|
|
default. For more information, see the :ref:`messages documentation
|
|
|
|
<ref-contrib-messages>`.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEMPLATE_DEBUG
|
|
|
|
|
2005-11-23 23:29:25 +00:00
|
|
|
TEMPLATE_DEBUG
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
A boolean that turns on/off template debug mode. If this is ``True``, the fancy
|
|
|
|
error page will display a detailed report for any ``TemplateSyntaxError``. This
|
|
|
|
report contains the relevant snippet of the template, with the appropriate line
|
|
|
|
highlighted.
|
|
|
|
|
2006-05-02 01:31:56 +00:00
|
|
|
Note that Django only displays fancy error pages if ``DEBUG`` is ``True``, so
|
|
|
|
you'll want to set that to take advantage of this setting.
|
2005-11-23 23:29:25 +00:00
|
|
|
|
2007-09-14 16:40:42 +00:00
|
|
|
See also ``DEBUG``.
|
2005-11-23 23:29:25 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEMPLATE_DIRS
|
|
|
|
|
2005-10-17 04:53:03 +00:00
|
|
|
TEMPLATE_DIRS
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Default: ``()`` (Empty tuple)
|
|
|
|
|
2005-12-31 01:46:04 +00:00
|
|
|
List of locations of the template source files, in search order. Note that
|
|
|
|
these paths should use Unix-style forward slashes, even on Windows.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`topics-templates`..
|
|
|
|
|
|
|
|
.. 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
|
|
|
|
knows how to import templates from a particular sources. Optionally, a tuple can be
|
|
|
|
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
|
|
|
|
:ref:`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_DATABASE_CHARSET
|
2006-02-09 00:31:51 +00:00
|
|
|
|
2007-05-29 12:42:08 +00:00
|
|
|
TEST_DATABASE_CHARSET
|
|
|
|
---------------------
|
2006-08-31 14:29:47 +00:00
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2006-08-31 14:29:47 +00:00
|
|
|
|
2007-05-29 12:42:08 +00:00
|
|
|
Default: ``None``
|
2006-08-31 14:29:47 +00:00
|
|
|
|
2007-05-29 12:42:08 +00:00
|
|
|
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.
|
|
|
|
|
2008-07-18 17:38:53 +00:00
|
|
|
Supported for the PostgreSQL_ (``postgresql``, ``postgresql_psycopg2``) and MySQL_ (``mysql``) backends.
|
2007-05-29 12:42:08 +00:00
|
|
|
|
|
|
|
.. _PostgreSQL: http://www.postgresql.org/docs/8.2/static/multibyte.html
|
|
|
|
.. _MySQL: http://www.mysql.org/doc/refman/5.0/en/charset-database.html
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEST_DATABASE_COLLATION
|
|
|
|
|
2007-05-29 12:42:08 +00:00
|
|
|
TEST_DATABASE_COLLATION
|
|
|
|
------------------------
|
|
|
|
|
2008-09-02 03:40:42 +00:00
|
|
|
.. versionadded:: 1.0
|
2007-05-29 12:42:08 +00:00
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
|
|
|
The collation order to use when creating the test database. This value is
|
2007-06-01 17:04:36 +00:00
|
|
|
passed directly to the backend, so its format is backend-specific.
|
2007-05-29 12:42:08 +00:00
|
|
|
|
2008-07-18 17:38:53 +00:00
|
|
|
Only supported for the ``mysql`` backend (see `section 10.3.2`_ of the MySQL
|
|
|
|
manual for details).
|
2007-05-29 12:42:08 +00:00
|
|
|
|
|
|
|
.. _section 10.3.2: http://www.mysql.org/doc/refman/5.0/en/charset-database.html
|
2006-08-31 14:29:47 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. setting:: TEST_DATABASE_NAME
|
|
|
|
|
2006-09-01 13:33:26 +00:00
|
|
|
TEST_DATABASE_NAME
|
|
|
|
------------------
|
|
|
|
|
|
|
|
Default: ``None``
|
|
|
|
|
2007-12-17 08:50:50 +00:00
|
|
|
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_' + settings.DATABASE_NAME``.
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ref:`topics-testing`.
|
2006-09-01 13:33:26 +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
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Default: ``'django.test.simple.run_tests'``
|
|
|
|
|
|
|
|
The name of the method to use for starting the test suite. See
|
2008-08-23 22:25:40 +00:00
|
|
|
:ref:`topics-testing`.
|
2007-05-29 12:42:08 +00:00
|
|
|
|
|
|
|
.. _Testing Django Applications: ../testing/
|
|
|
|
|
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.``)
|
|
|
|
|
|
|
|
The default formatting to use for time fields on Django admin change-list
|
|
|
|
pages -- and, possibly, by other parts of the system. See
|
2008-08-23 22:25:40 +00:00
|
|
|
:ttag:`allowed date format strings <now>`.
|
2005-11-06 23:49:03 +00:00
|
|
|
|
2007-09-14 16:40:42 +00:00
|
|
|
See also ``DATE_FORMAT``, ``DATETIME_FORMAT``, ``TIME_FORMAT``,
|
|
|
|
``YEAR_MONTH_FORMAT`` and ``MONTH_DAY_FORMAT``.
|
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'``
|
|
|
|
|
2005-11-21 00:27:48 +00:00
|
|
|
A string representing the time zone for this installation. `See available choices`_.
|
2006-07-07 22:39:43 +00:00
|
|
|
(Note that list of available choices lists more than one on the same line;
|
|
|
|
you'll want to use just one of the choices for a given time zone. For instance,
|
|
|
|
one line says ``'Europe/London GB GB-Eire'``, but you should use the first bit
|
|
|
|
of that -- ``'Europe/London'`` -- as your ``TIME_ZONE`` setting.)
|
2005-11-21 00:27:48 +00:00
|
|
|
|
|
|
|
Note that this is the time zone to which Django will convert all dates/times --
|
|
|
|
not necessarily the timezone of the server. For example, one server may serve
|
|
|
|
multiple Django-powered sites, each with a separate time-zone setting.
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2006-07-13 03:52:41 +00:00
|
|
|
Normally, Django sets the ``os.environ['TZ']`` variable to the time zone you
|
2008-08-23 22:25:40 +00:00
|
|
|
specify in the ``TIME_ZONE`` setting. Thus, all your views and models will
|
2008-10-06 11:18:30 +00:00
|
|
|
automatically operate in the correct time zone. However, if you're manually
|
|
|
|
:ref:`manually configuring settings
|
|
|
|
<settings-without-django-settings-module>`, Django will *not* touch the ``TZ``
|
2006-07-13 03:52:41 +00:00
|
|
|
environment variable, and it'll be up to you to ensure your processes are
|
|
|
|
running in the correct environment.
|
2006-07-12 07:40:28 +00:00
|
|
|
|
2007-02-12 00:10:09 +00:00
|
|
|
.. note::
|
|
|
|
Django cannot reliably use alternate time zones in a Windows environment.
|
2007-02-12 17:10:09 +00:00
|
|
|
If you're running Django on Windows, this variable must be set to match the
|
2007-02-12 00:10:09 +00:00
|
|
|
system timezone.
|
2009-06-18 13:33:18 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. _See available choices: http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
|
|
|
|
|
|
|
|
.. setting:: URL_VALIDATOR_USER_AGENT
|
2007-02-12 00:10:09 +00:00
|
|
|
|
2006-11-07 02:20:08 +00:00
|
|
|
URL_VALIDATOR_USER_AGENT
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
Default: ``Django/<version> (http://www.djangoproject.com/)``
|
|
|
|
|
|
|
|
The string to use as the ``User-Agent`` header when checking to see if URLs
|
2008-08-23 22:25:40 +00:00
|
|
|
exist (see the ``verify_exists`` option on :class:`~django.db.models.URLField`).
|
2006-11-07 02:20:08 +00:00
|
|
|
|
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
|
|
|
|
bandwidth but slows down performance. This is only used if ``CommonMiddleware``
|
2008-08-23 22:25:40 +00:00
|
|
|
is installed (see :ref:`topics-http-middleware`).
|
|
|
|
|
|
|
|
.. setting:: USE_I18N
|
2005-10-17 04:53:03 +00:00
|
|
|
|
2006-07-01 03:09:14 +00:00
|
|
|
USE_I18N
|
|
|
|
--------
|
|
|
|
|
|
|
|
Default: ``True``
|
|
|
|
|
|
|
|
A boolean that specifies whether Django's internationalization system should be
|
|
|
|
enabled. This provides an easy way to turn it off, for performance. If this is
|
2006-07-07 22:29:02 +00:00
|
|
|
set to ``False``, Django will make some optimizations so as not to load the
|
2006-07-01 03:09:14 +00:00
|
|
|
internationalization machinery.
|
|
|
|
|
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."
|
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
See :ttag:`allowed date format strings <now>`. See also ``DATE_FORMAT``,
|
2007-09-14 16:40:42 +00:00
|
|
|
``DATETIME_FORMAT``, ``TIME_FORMAT`` and ``MONTH_DAY_FORMAT``.
|