
 分類：

Django（129）


目錄(?)[+]

轉自：http://blog.csdn.net/feng88724/article/details/7221973

作者:	Django 團隊
譯者:	[email protected]
翻譯開始日期:	2006-04-04
翻譯完成日期:	2006-04-04
修訂日期:	2006-05-06
原文版本:	2789

Django settings 文件包含你的 Django 安裝的所有配置信息．本文檔解釋了 settings 如何工作及共有哪些選項可用．

基本設置

一個 settings 文件就是一個擁有一些模塊級變量的 Python 模塊．

下面是幾個 settings 的例子:

DEBUG = False
DEFAULT_FROM_EMAIL = '[email protected]'
TEMPLATE_DIRS = ('/home/templates/mike', '/home/templates/john')

由於一個 settings 文件就是一個 python 模塊, 所以必須遵守以下規則:

不允許有 Python 語法錯誤．
通過使用正常的 Python 語法，可以動態設置 settings ．舉例來說:
MY_SETTING = [str(i) for i in range(30)]
可以從其它 settings 文件中導入值.

設置

使用 Django 時, 你必須告訴它你使用的是哪個 settings . 要做到這一點，使用環境變量 DJANGO_SETTINGS_MODULE.

DJANGO_SETTINGS_MODULE 的值是一個 Python 路徑, 舉例來說 "mysite.settings". 注意 settings 模塊應該在 Python import 搜索路徑中.

django-admin.py 應用程序

使用 django-admin.py 時, 你可以一次性設定環境變量, 也可以在運行該程序時每次顯式的將 settings 模塊顯式的傳遞給它.

例子 (Unix Bash shell):

export DJANGO_SETTINGS_MODULE=mysite.settings
django-admin.py runserver

例子 (Windows shell):

set DJANGO_SETTINGS_MODULE=mysite.settings
django-admin.py runserver

使用 --settings 命令行參數手工指定 settings

django-admin.py runserver --settings=mysite.settings

默認 settings

如果不需要, Django settings 文件可以不必定義任何 settings. 因爲每個設置都有默認值. 這些默認值定義在 django/conf/global_settings.py.

下面是 Django 使用 settings 的法則:

從 global_settings.py 載入默認設置.
從指定的 settings 文件載入用戶設置, 需要時覆蓋掉默認設置.

注意一個用戶 settings 文件不必t 導入 global_settings, 這是多餘的.

查看你改變了哪些設置

有一個簡單的辦法可以查看你修改了哪些設置.命令 python manage.py diffsettings 顯示當前 settings 文件與 Django 默認設置的不同之處.

參閱 diffsettings documentation.

在你的代碼中使用 settings

通過從模塊 django.conf.settings 導入你需要的變量, 你的代碼可以訪問這個變量. 例子:

from django.conf.settings import DEBUG

if DEBUG:
    # Do something

注意一定不要從 global_settings 或你自己的 settings 模塊導入設置變量到你的代碼. django.conf.settings 概括了默認設置和站點自定義設置的概念,它提供了一個統一的接口用於用戶代碼訪問, 也降低了用戶代碼與用戶設置的耦合程度.

在運行時修改 settings

不應該在程序運行時修改 settings. 舉例來說, 不要在一個 view 中做這樣的事:

from django.conf.settings import DEBUG

DEBUG = True   # Don't do this!

你只應該在你的 settings 文件中設置 settings, 記住,這是原則.

安全性

由於 settings 文件包含敏感信息,象數據庫密碼等.你應該非常小心的設置它的訪問權限. 舉例來說, 你可以只允許你和 WEB 服務器用戶閱讀該文件.在一個共享主機環境時,這一點格外重要.

可用選項

下面是所有可用選項的列表及它們的默認值(按字母順序排列).

ABSOLUTE_URL_OVERRIDES

默認值: {} (空字典)

一個字典映射 "app_label.module_name" 字符串到一個函數, 該函數接受一個model對象作爲參數並返回它的 URL. 這是在一個安裝上覆蓋 get_absolute_url() 方法的一種方式. 例子:

ABSOLUTE_URL_OVERRIDES = {
    'blogs.blogs': lambda o: "/blogs/%s/" % o.slug,
    'news.stories': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),
}

ADMIN_FOR

默認值: () (空的tuple)

用於 admin-site settings 模塊, 若當前站點是 admin ,它則是一個由 settings 模塊組成的 tuple (類似 'foo.bar.baz' 這樣的格式).

admin 站點在 models, views,及 template tags 的自動內省的文檔中使用該設置.

ADMIN_MEDIA_PREFIX

默認值: '/media/'

The URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a trailing slash.

ADMINS

默認值: () (空的 tuple)

一個2-元素tuple的 tuple. 列出了有權接收代碼錯誤提示的人. 當 DEBUG=False 時,一個 view 引發了異常, Django 會將詳細異常信息用電子郵件的方式發送給這些人. 該tuple的每個成員應該是這種格式: (Full name, e-mail address). 例子:

(('John', '[email protected]'), ('Mary', '[email protected]'))

ALLOWED_INCLUDE_ROOTS

默認值: () (空的 tuple)

一個字符串tuple, 只有以列表中的元素爲前綴的模板Django纔可以以``{% ssi %}`` 形式訪問 . 出於安全考慮, 在不應該訪問時,即使是模板的作者也不能訪問這些文件.

舉例來說, 若 ALLOWED_INCLUDE_ROOTS 是 ('/home/html', '/var/www'), 那麼 {% ssi /home/html/foo.txt %} 可以正常工作不過 {% ssi /etc/passwd %} 卻不能.

APPEND_SLASH

默認值: True

是否給URL添加一個結尾的斜線. 只有安裝了 CommonMiddleware 之後,該選項才起作用. (參閱 middleware 文檔). 參閱 PREPEND_WWW.

CACHE_BACKEND

默認值: 'simple://'

後端使用的 cache . 參閱 cache docs.

CACHE_MIDDLEWARE_KEY_PREFIX

默認值: '' (空的字符串)

cache 中間件使用的cache key 前綴. 參閱 cache docs.

DATABASE_ENGINE

默認值: 'postgresql'

後端使用的數據庫引擎: 'postgresql', 'MySQL', 'sqlite3' 或 'ado_mssql' 中的任意一個.

DATABASE_HOST

默認值: '' (空的字符串)

數據庫所在的主機. 空的字符串意味着 localhost. SQLite 不需要該項. 如果你使用 mysql 並且該選項的值以一個斜線 ('/') 開始, MySQL 則通過一個 Unix socket 連接到指定的 socket. 比如:

DATABASE_HOST = '/var/run/mysql'

如果你使用 MySQL 並且該選項的值不是以斜線開始, 那麼該選項的值就是主機的名字.

DATABASE_NAME

默認值: '' (空的字符串)

要使用的數據庫名字. 對 SQLite, 它必須是一個數據庫文件的全路徑名字.

DATABASE_PASSWORD

默認值: '' (空的字符串)

連接數據庫需要的密碼. SQLite 不需要該項.

DATABASE_PORT

默認值: '' (空的字符串)

連接數據庫所需的數據庫端口. 空的字符串表示默認端口. SQLite 不需要該項.

DATABASE_USER

默認值: '' (空的字符串)

連接數據庫時所需要的用戶名. SQLite 不需要該項.

DATE_FORMAT

默認值: 'N j, Y' (舉例來說 Feb. 4, 2003)

在 Django admin change-list 頁對日期字段使用的默認日期格式, 系統中的其它部分也可能使用該格式. 參閱 allowed date format strings.

參閱 DATETIME_FORMAT 和 TIME_FORMAT.

DATETIME_FORMAT

默認值: 'N j, Y, P' (舉例來說 Feb. 4, 2003, 4 p.m.)

在 Django admin change-list 頁對日期時間字段使用的默認日期時間格式, 系統中的其它部分也可能使用該格式. 參閱 allowed date format strings.

參閱 DATE_FORMAT 和 TIME_FORMAT.

DEFAULT_CHARSET

默認值: 'utf-8'

如果一個 MIME 類型沒有人爲指定, 對所有 HttpResponse 對象將應用該默認字符集. 使用 DEFAULT_CONTENT_TYPE 來構建 Content-Type 頭.

DEFAULT_CONTENT_TYPE

默認值: 'text/html'

如果一個 MIME 類型沒有人爲指定, 對所有 HttpResponse 對象將應用該默認 content type. 使用 DEFAULT_CHARSET 來構建 Content-Type 頭.

DEFAULT_FROM_EMAIL

默認值: 'webmaster@localhost'

用於發送(站點自動生成的)管理郵件的默認 e-mail 郵箱.

DISALLOWED_USER_AGENTS

默認值: () (空的 tuple)

一個編譯的正則表達式對象列表,用於表示一些用戶代理字符串.這些用戶代理將被禁止訪問系統中的任何頁面. 使用這個對付頁面機器人或網絡爬蟲.只有安裝 CommonMiddleware 後這個選項纔有用(參閱 middleware 文檔).

EMAIL_HOST

默認值: 'localhost'

用來發送 e-mail 的主機. 參閱 EMAIL_PORT.

EMAIL_HOST_PASSWORD

默認值: '' (空的字符串)

EMAIL_HOST 中定義的 SMTP 服務器使用的密碼. 如果爲空, Django 不會嘗試進行認證.

參閱 EMAIL_HOST_USER.

EMAIL_HOST_USER

默認值: '' (空的字符串)

EMAIL_HOST 中定義的 SMTP 服務器使用的用戶名. 如果爲空, Django 不會嘗試進行認證.

參閱 EMAIL_HOST_PASSWORD.

EMAIL_PORT

默認值: 25

EMAIL_HOST 中指定的SMTP 服務器所使用的端口號.

EMAIL_SUBJECT_PREFIX

默認值: '[Django] '

django.core.mail.mail_admins 或 django.core.mail.mail_managers 發送的郵件的主題前綴.

ENABLE_PSYCO

默認值: False

如果允許 Psyco, 將使用Pscyo優化 Python 代碼. 需要 Psyco 模塊.

IGNORABLE_404_ENDS

默認值: ('mail.pl', 'mailform.pl', 'mail.cgi', 'mailform.cgi', 'favicon.ico', '.PHP')

參閱 IGNORABLE_404_STARTS.

IGNORABLE_404_STARTS

默認值: ('/cgi-bin/', '/_vti_bin', '/_vti_inf')

一個字符串 tuple . 以該tuple中元素爲開頭的 URL 應該被 404 e-mailer 忽略. 參閱 SEND_BROKEN_LINK_EMAILS 和 IGNORABLE_404_ENDS.

INSTALLED_APPS

默認值: () (空的 tuple)

一個字符串tuple ,內容是本 Django 安裝中的所有應用. 每個字符串應該是一個包含Django應用程序的Python包的路徑全稱, django-admin.py startapp 會自動往其中添加內容.

INTERNAL_IPS

默認值: () (空的 tuple)

一個 ip 地址的 tuple(字符串形式), 它:

當 DEBUG 爲 True 時,參閱調試務註解
接收 X 頭(若 XViewMiddleware 已安裝), (參閱 middleware 文檔)

JING_PATH

默認值: '/usr/bin/jing'

"Jing" 執行文件路徑全名. Jing 是一個 RELAX NG 校驗器, Django 使用它對你的 model 的 XMLField 進行驗證. 參閱 http://www.thaiopensource.com/relaxng/jing.html .

LANGUAGE_CODE

默認值: 'en-us'

表示默認語言的一個字符串. 必須是標準語言格式. 舉例來說, U.S. English 就是 "en-us". 參閱 internationalization docs.

LANGUAGES

默認值: 一個 tuple (內容爲所有可用語言). 目前它的值是:

LANGUAGES = (
    ('bn', _('Bengali')),
    ('cs', _('Czech')),
    ('cy', _('Welsh')),
    ('da', _('Danish')),
    ('de', _('German')),
    ('en', _('English')),
    ('es', _('Spanish')),
    ('fr', _('French')),
    ('gl', _('Galician')),
    ('is', _('Icelandic')),
    ('it', _('Italian')),
    ('no', _('Norwegian')),
    ('pt-br', _('Brazilian')),
    ('ro', _('Romanian')),
    ('ru', _('Russian')),
    ('sk', _('Slovak')),
    ('sr', _('Serbian')),
    ('sv', _('Swedish')),
    ('zh-cn', _('Simplified Chinese')),
)

一個2-元素tuple<格式爲 (語言代碼, 語言名稱)>的 tuple. 該設置用於選擇可用語言.參閱 internationalization docs 瞭解細節.

通常這個默認值就足夠了.除非你打算減少提供的語言數目,否則沒必要修改這個設置.

MANAGERS

默認值: ADMINS (不論 ADMINS 是否已經設置)

一個和 ADMINS 同樣格式的 tuple , 當 SEND_BROKEN_LINK_EMAILS=True 時, 這些人有權接收死鏈接通知信息.

MEDIA_ROOT

默認值: '' (空的字符串)

一個絕對路徑, 用於保存媒體文件. 例子: "/home/media/media.lawrence.com/" 參閱 MEDIA_URL.

MEDIA_URL

默認值: '' (空的字符串)

處理媒體服務的URL(媒體文件來自 MEDIA_ROOT). 如: "http://media.lawrence.com"

MIDDLEWARE_CLASSES

默認值:

("django.contrib.sessions.middleware.SessionMiddleware",
 "django.contrib.auth.middleware.AuthenticationMiddleware",
 "django.middleware.common.CommonMiddleware",
 "django.middleware.doc.XViewMiddleware")

一個django 用到的中間件 class 名稱的 tuple. 參閱 middleware 文檔.

PREPEND_WWW

默認值: False

是否爲沒有 "www." 前綴的域名添加 "www." 前綴. 當且僅當安裝有 CommonMiddleware 後該選項纔有效. (參閱 middleware 文檔).參閱 APPEND_SLASH.

ROOT_URLCONF

默認值: Not defined

一個字符串,表示你的根 URLconf 的模塊名. 舉例來說:"mydjangoapps.urls". 參閱 Django如何處理一個請求.

SECRET_KEY

默認值: '' (空的字符串)

一個密碼. 用於爲密碼哈希算法提供一個種子.將其設置爲一個隨機字符串 -- 越長越好. django-admin.py startproject 會自動給你創建一個.

SEND_BROKEN_LINK_EMAILS

默認值: False

當有人從一個有效Django-powered頁面訪問另一個Django-powered頁面時發現404錯誤(也就是發現一個死鏈接)時, 是否發送一封郵件給 MANAGERS. 當且僅當安裝有 CommonMiddleware 時該選項纔有效(參閱`middleware 文檔`_). 參閱 IGNORABLE_404_STARTS `` 和 IGNORABLE_404_ENDS``.

SERVER_EMAIL

默認值: 'root@localhost'

用來發送錯誤信息的郵件地址, 比如發送給 ADMINS 和 MANAGERS 的郵件.

SESSION_COOKIE_AGE

默認值: 1209600 (2周, 以秒計)

session cookies 的生命週期, 以秒計. 參閱 session docs.

SESSION_COOKIE_DOMAIN

默認值: None

session cookies 有效的域. 將其值設置爲類似 ".lawrence.com" 這樣 cookie 就可以跨域生效, 或者使用 None 作爲一個標準的域 cookie. 參閱 session docs.

SESSION_COOKIE_NAME

默認值: 'sessionid'

session 使用的cookie 名字. 參閱 session docs.

SESSION_SAVE_EVERY_REQUEST

默認值: False

是否每次請求都保存session. 參閱 session docs.

SITE_ID

默認值: Not defined

是一個整數, 表示 django_site 表中的當前站點. 當一個數據包含多個站點數據時，你的程序可以據此 ID 訪問特定站點的數據．

TEMPLATE_CONTEXT_PROCESSORS

默認值:

("django.core.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n")

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.

TEMPLATE_DEBUG

默認值: False

一個布爾值,用來開關模板調試模式.若設置爲 True, 如果有任何 TemplateSyntaxError,一個詳細的錯誤報告信息頁將被顯示給你.這個報告包括有關的模板片斷,相應的行會自動高亮.

注意 Django 僅在 DEBUG 爲 True 時顯示這個信息頁面.

參閱 DEBUG.

TEMPLATE_DIRS

默認值: () (空的 tuple)

模板源文件目錄列表,按搜索順序. 注意要使用 Unix-風格的前置斜線(即'/'), 即便是在 Windows 上.

參閱 template documentation.

TEMPLATE_LOADERS

默認值: ('django.template.loaders.filesystem.load_template_source',)

一個元素爲可調用對象(字符串形式的)的 tuple. 這些對象知道如何導入 templates 從各種源中. 參閱 template documentation.

TEMPLATE_STRING_IF_INVALID

默認值: '' (空的字符串)

輸出文本, 作爲一個字符串. 模板系統將會在出錯 (比如說拼錯了) 時使用該變量. 參閱 How invalid variables are handled.

TIME_FORMAT

默認值: 'P' (舉例來說 4 p.m.)

Django admin change-list 使用的默認時間格式. 有可能系統的其它部分也使用該格式. 參閱 allowed date format strings.

參閱 DATE_FORMAT 和 DATETIME_FORMAT.

TIME_ZONE

默認值: 'America/Chicago' (我們可以用 'Asia/Shanghai PRC' )

一個表示當前時區的字符串. 參閱選擇項列表.

Django 據此設置轉換所有的日期/時間 -- 並不考慮服務器的時區設置. 舉例來說, 一臺服務器可以服務多個 Django-powered 站點,每個站點使用一個獨立的時區設置.

USE_ETAGS

默認值: False

一個布爾值.指定是否輸出 "Etag" 頭. 這個選項可以節省網絡帶寬,但損失性能. 只有安裝 CommonMiddleware 後這個選項纔有用(參閱 middleware 文檔)

創建你自己的 settings

你可以爲自己的Django 應用程序創建自定義 settings. 只需要你遵守以下慣例:

設置名稱全部大寫.
如果某項設置是一個序列,優先使用 tuple.這完全是基於性能考慮.
不要爲已經存的一個設置重新發明一個名字.

官方文檔：https://docs.djangoproject.com/en/dev/ref/settings/

Settings

Warning

Be careful when you override settings, especially when the default value is a non-empty tuple or dictionary, such as MIDDLEWARE_CLASSES and TEMPLATE_CONTEXT_PROCESSORS. Make sure you keep the components required by the features of Django you wish to use.

Core settings

Here’s a list of settings available in Django core and their default values. Settings provided by contrib apps are listed below, followed by a topical index of the core settings.

ABSOLUTE_URL_OVERRIDES

Default: {} (Empty dictionary)

A dictionary mapping "app_label.model_name" strings to functions that take 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 = {
    'blogs.weblog': lambda o: "/blogs/%s/" % o.slug,
    'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),
}


Note that the model name used in this setting should be all lower-case, regardless of the case of the actual model class name.

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 email these people with the full exception information. Each member of the tuple should be a tuple of (Full name, email address). Example:


(('John', '[email protected]'), ('Mary', '[email protected]'))


Note that Django will email all of these people whenever an error happens. See Error reporting for more information.

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 seemingly-safe web server configurations.

Values in this list can be fully qualified names (e.g. 'www.example.com'), in which case they will be matched against the request’sHost 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 MIDDLEWARE_CLASSES).

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
]


If the Host header (or X-Forwarded-Host if USE_X_FORWARDED_HOST is enabled) does not match any value in this list, thedjango.http.HttpRequest.get_host() method will raise SuspiciousOperation.

When 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 get_host(); if your code accesses the Host header directly from request.META you are bypassing this security protection.

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.

APPEND_SLASH

Default: True

When set to True, if the request URL does not match any of the patterns in the URLconf and it doesn’t end in a slash, an HTTP redirect is issued to the same URL with a slash appended. Note that the redirect may cause any data submitted in a POST request to be lost.

The APPEND_SLASH setting is only used if CommonMiddleware is installed (see Middleware). See also PREPEND_WWW.

CACHES

Default:


{
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
    }
}


A dictionary containing the settings for all caches to be used with Django. It is a nested dictionary whose contents maps cache aliases to a dictionary containing the options for an individual cache.

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

BACKEND

Default: '' (Empty string)

The cache backend to use. The built-in cache backends are:

'django.core.cache.backends.db.DatabaseCache'
'django.core.cache.backends.dummy.DummyCache'
'django.core.cache.backends.filebased.FileBasedCache'
'django.core.cache.backends.locmem.LocMemCache'
'django.core.cache.backends.memcached.MemcachedCache'
'django.core.cache.backends.memcached.PyLibMCCache'

You can use a cache backend that doesn’t ship with Django by setting BACKEND to a fully-qualified path of a cache 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.

KEY_FUNCTION

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):
    return ':'.join([key_prefix, str(version), key])

You may use any key function you want, as long as it has the same argument signature.

See the cache documentation for more information.

KEY_PREFIX

Default: '' (Empty string)

A string that will be automatically included (prepended by default) to all cache keys used by the Django server.

See the cache documentation for more information.

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',
    }
}


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 Cache Backends documentation. For more information, consult your backend module’s own documentation.

TIMEOUT

Default: 300

The number of seconds before a cache entry is considered stale.

VERSION

Default: 1

The default version number for cache keys generated by the Django server.

See the cache documentation for more information.

CACHE_MIDDLEWARE_ALIAS

Default: default

The cache connection to use for the cache middleware.

CACHE_MIDDLEWARE_ANONYMOUS_ONLY

Default: False

Deprecated in Django 1.6:

Deprecated since version 1.6: This setting was largely ineffective because of using cookies for sessions and CSRF. See theDjango 1.6 release notes for more information.

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.

CACHE_MIDDLEWARE_KEY_PREFIX

Default: '' (Empty string)

The cache key prefix that the cache middleware should use.

See Django’s cache framework.

CACHE_MIDDLEWARE_SECONDS

Default: 600

The default number of seconds to cache a page when the caching middleware or cache_page() decorator is used.

See Django’s cache framework.

CSRF_FAILURE_VIEW

Default: 'django.views.csrf.csrf_failure'

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 Cross Site Request Forgery protection.

DATABASES

Default: {} (Empty dictionary)

A dictionary containing the settings for all databases to be used with Django. It is a nested dictionary whose contents maps database aliases to a dictionary containing the options for an individual database.

The 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': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'mydatabase'
    }
}


For other database backends, or more complex SQLite configurations, other options will be required. The following inner options are available.

ATOMIC_REQUESTS

New in Django Development version.

Default: False

Set this to True to wrap each HTTP request in a transaction on this database. See Tying transactions to HTTP requests.

AUTOCOMMIT

New in Django Development version.

Default: True

Set this to False if you want to disable Django’s transaction management and implement your own.

ENGINE

Default: '' (Empty string)

The database backend to use. The built-in database backends are:

'django.db.backends.postgresql_psycopg2'
'django.db.backends.mysql'
'django.db.backends.sqlite3'
'django.db.backends.oracle'

You can use a database backend that doesn’t ship with Django by setting ENGINE to a fully-qualified path (i.e.mypackage.backends.whatever). Writing a whole new database backend from scratch is left as an exercise to the reader; see the other backends for examples.

HOST

Default: '' (Empty string)

Which host to use when connecting to the database. An empty string means localhost. Not used with SQLite.

If this value starts with a forward slash ('/') and you’re using MySQL, MySQL will connect via a Unix socket to the specified socket. For example:

"HOST": '/var/run/mysql'

If you’re using MySQL and this value doesn’t start with a forward slash, then this value is assumed to be the host.

If you’re using PostgreSQL, by default (empty 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 HOST to ‘localhost’ or ‘127.0.0.1’ (‘host’ lines inpg_hba.conf). On Windows, you should always define HOST, as UNIX domain sockets are not available.

NAME

Default: '' (Empty string)

The name of the database to use. For SQLite, it’s the full path to the database file. When specifying the path, always use forward slashes, even on Windows (e.g. C:/homes/user/mysite/sqlite3.db).

CONN_MAX_AGE

New in Django Development version.

Default: 0

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.

OPTIONS

Default: {} (Empty dictionary)

Extra parameters to use when connecting to the database. Available parameters vary depending on your database backend.

Some information on available parameters can be found in the Database Backends documentation. For more information, consult your backend module’s own documentation.

PASSWORD

Default: '' (Empty string)

The password to use when connecting to the database. Not used with SQLite.

PORT

Default: '' (Empty string)

The port to use when connecting to the database. An empty string means the default port. Not used with SQLite.

USER

Default: '' (Empty string)

The username to use when connecting to the database. Not used with SQLite.

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.

Supported for the PostgreSQL (postgresql_psycopg2) and MySQL (mysql) backends.

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.

Only supported for the mysql backend (see the MySQL manual for details).

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 controlling the creation order of test databasesfor details.

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 ontesting master/slave configurations for details.

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.

See The test database.

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.

TEST_USER

Default: None

This is an oracle-specific setting.

The username to use when connecting to the Oracle database that will be used when running tests. If not provided, Django will use 'test_' + USER.

TEST_USER_CREATE

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.

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.

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.

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

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 automatic database routing in multi database configurations.

DATE_FORMAT

Default: 'N j, Y' (e.g. Feb. 4, 2003)

The default formatting to use for displaying date fields in any part of the system. Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead. See allowed date format strings.

DATE_INPUT_FORMATS

Default:


(
    '%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'
)


A tuple of formats that will be accepted when inputting data on a date field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s datetime module syntax, not the format strings from the date Django template tag.

When USE_L10N is True, the locale-dictated format has higher precedence and will be applied instead.

DATETIME_FORMAT

Default: 'N j, Y, P' (e.g. Feb. 4, 2003, 4 p.m.)

The default formatting to use for displaying datetime fields in any part of the system. Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead. See allowed date format strings.

DATETIME_INPUT_FORMATS

Default:


(
    '%Y-%m-%d %H:%M:%S',     # '2006-10-25 14:30:59'
    '%Y-%m-%d %H:%M:%S.%f',  # '2006-10-25 14:30:59.000200'
    '%Y-%m-%d %H:%M',        # '2006-10-25 14:30'
    '%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'
)


A tuple of formats that will be accepted when inputting data on a datetime field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s datetime module syntax, not the format strings from the date Django template tag.

When USE_L10N is True, the locale-dictated format has higher precedence and will be applied instead.

DEBUG

Default: False

A boolean that turns on/off debug mode.

Never deploy a site into production with DEBUG turned on.

Did you catch that? NEVER deploy a site into production with DEBUG turned on.

One of the main features of debug mode is the display of detailed error pages. If your app raises an exception when DEBUG isTrue, 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).

As a security measure, Django will not include settings that might be sensitive (or offensive), such as SECRET_KEY orPROFANITIES_LIST. Specifically, it will exclude any setting whose name includes any of the following:

'API'
'KEY'
'PASS'
'PROFANITIES_LIST'
'SECRET'
'SIGNATURE'
'TOKEN'

Note that these are partial matches. 'PASS' will also match PASSWORD, just as 'TOKEN' will also match TOKENIZED and so on.

Still, note that there are always going to be sections of your debug output that are inappropriate for public consumption. File paths, configuration options and the like all give attackers extra information about your server.

It is also important to remember that when running with DEBUG turned on, Django will remember every SQL query it executes. This is useful when you’re debugging, but it’ll rapidly consume memory on a production server.

Finally, if DEBUG is False, you also need to properly set the ALLOWED_HOSTS setting. Failing to do so will result in all requests being returned as “Bad Request (400)”.

DEBUG_PROPAGATE_EXCEPTIONS

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.

DECIMAL_SEPARATOR

Default: '.' (Dot)

Default decimal separator used when formatting decimal numbers.

Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead.

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.

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.

DEFAULT_EXCEPTION_REPORTER_FILTER

Default: django.views.debug.SafeExceptionReporterFilter

Default exception reporter filter class to be used if none has been assigned to the HttpRequest instance yet. See Filtering error reports.

DEFAULT_FILE_STORAGE

Default: django.core.files.storage.FileSystemStorage

Default file storage class to be used for any file-related operations that don’t specify a particular storage system. SeeManaging files.

DEFAULT_FROM_EMAIL

Default: 'webmaster@localhost'

Default email address to use for various automated correspondence from the site manager(s).

DEFAULT_INDEX_TABLESPACE

Default: '' (Empty string)

Default tablespace to use for indexes on fields that don’t specify one, if the backend supports it (see Tablespaces).

DEFAULT_TABLESPACE

Default: '' (Empty string)

Default tablespace to use for models that don’t specify one, if the backend supports it (see Tablespaces).

DISALLOWED_USER_AGENTS

Default: () (Empty tuple)

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

EMAIL_BACKEND

Default: 'django.core.mail.backends.smtp.EmailBackend'

The backend to use for sending emails. For the list of available backends see Sending email.

EMAIL_FILE_PATH

Default: Not defined

The directory used by the file email backend to store output files.

EMAIL_HOST

Default: 'localhost'

The host to use for sending email.

EMAIL_HOST_PASSWORD

Default: '' (Empty string)

Password to use for the SMTP server defined in EMAIL_HOST. This setting is used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server. If either of these settings is empty, Django won’t attempt authentication.

EMAIL_HOST_USER

Default: '' (Empty string)

Username to use for the SMTP server defined in EMAIL_HOST. If empty, Django won’t attempt authentication.

EMAIL_PORT

Default: 25

Port to use for the SMTP server defined in EMAIL_HOST.

EMAIL_SUBJECT_PREFIX

Default: '[Django] '

Subject-line prefix for email messages sent with django.core.mail.mail_admins or django.core.mail.mail_managers. You’ll probably want to include the trailing space.

EMAIL_USE_TLS

Default: False

Whether to use a TLS (secure) connection when talking to the SMTP server.

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.

FILE_UPLOAD_HANDLERS

Default:


("django.core.files.uploadhandler.MemoryFileUploadHandler",
 "django.core.files.uploadhandler.TemporaryFileUploadHandler",)

A tuple of handlers to use for uploading. See Managing files for details.

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 the file system. See Managing files for details.

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.

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.

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.

See Managing files for details.

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.

FIXTURE_DIRS

Default: () (Empty tuple)

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 Providing initial data with fixtures and Fixture loading.

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.

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 aformats.py file, under the directory named as the current locale, and will use the formats defined on this file.

For example, if FORMAT_MODULE_PATH is set to mysite.formats, and current language is en (English), Django will expect a directory tree like:

mysite/
    formats/
        __init__.py
        en/
            __init__.py
            formats.py

Available formats are DATE_FORMAT, TIME_FORMAT, DATETIME_FORMAT, YEAR_MONTH_FORMAT, MONTH_DAY_FORMAT, SHORT_DATE_FORMAT,SHORT_DATETIME_FORMAT, FIRST_DAY_OF_WEEK, DECIMAL_SEPARATOR, THOUSAND_SEPARATOR and NUMBER_GROUPING.

IGNORABLE_404_URLS

Default: ()

List of compiled regular expression objects describing URLs that should be ignored when reporting HTTP 404 errors via email (see Error reporting). Regular expressions are matched against request's full paths (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.

This is only used if BrokenLinkEmailsMiddleware is enabled (see Middleware).

INSTALLED_APPS

Default: () (Empty tuple)

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 contains a Django application, as created by django-admin.py startapp.

App names must be unique

The application names (that is, the final dotted part of the path to the module containing models.py) defined inINSTALLED_APPS must be unique. For example, you can’t include both django.contrib.auth and myproject.auth in INSTALLED_APPS.

INTERNAL_IPS

Default: () (Empty tuple)

A tuple of IP addresses, as strings, that:

See debug comments, when DEBUG is True
Receive X headers in admindocs if the XViewMiddleware is installed (see Middleware)

LANGUAGE_CODE

Default: 'en-us'

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 also the list of language identifiers and Internationalization and localization.

LANGUAGES

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

The list is a tuple of two-tuples in the format (language code, language name) – for example, ('ja', 'Japanese'). This specifies which languages are available for language selection. See Internationalization and localization.

Generally, the default value should suffice. Only set this setting if you want to restrict language selection to a subset of the Django-provided languages.

If you define a custom 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 importdjango.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')),
)


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 usesLANGUAGES at runtime.

LOCALE_PATHS

Default: () (Empty tuple)

A tuple of directories where Django looks for translation files. See How Django discovers translations.

Example:


LOCALE_PATHS = (
    '/home/www/project/common_files/locale',
    '/var/local/translations/locale'
)


Django will look within each of these paths for the <locale_code>/LC_MESSAGES directories containing the actual translation files.

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

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 dictConfigconfiguration method by default.

If you set LOGGING_CONFIG to None, the logging configuration process will be skipped.

MANAGERS

Default: () (Empty tuple)

A tuple in the same format as ADMINS that specifies who should get broken link notifications when BrokenLinkEmailsMiddleware is enabled.

MEDIA_ROOT

Default: '' (Empty string)

Absolute filesystem path to the directory that will hold user-uploaded files.

Example: "/var/www/example.com/media/"

MEDIA_URL

Default: '' (Empty string)

URL that handles the media served from MEDIA_ROOT, used for managing stored files. It must end in a slash if set to a non-empty value.

Example: "http://media.example.com/"

MIDDLEWARE_CLASSES

Default:


('django.middleware.common.CommonMiddleware',
 'django.contrib.sessions.middleware.SessionMiddleware',
 'django.middleware.csrf.CsrfViewMiddleware',
 'django.contrib.auth.middleware.AuthenticationMiddleware',
 'django.contrib.messages.middleware.MessageMiddleware',)


A tuple of middleware classes to use. See Middleware.

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

See allowed date format strings. See also DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT and YEAR_MONTH_FORMAT.

NUMBER_GROUPING

Default: 0

Number of digits grouped together on the integer part of a number.

Common use is to display a thousand separator. If this setting is 0, then no grouping will be applied to the number. If this setting is greater than 0, then THOUSAND_SEPARATOR will be used as the separator between those groups.

Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead.

PREPEND_WWW

Default: False

Whether to prepend the “www.” subdomain to URLs that don’t have it. This is only used if CommonMiddleware is installed (seeMiddleware). See also APPEND_SLASH.

ROOT_URLCONF

Default: Not defined

A string representing the full Python import path to your root URLconf. For example: "mydjangoapps.urls". Can be overridden on a per-request basis by setting the attribute urlconf on the incoming HttpRequest object. See How Django processes a requestfor details.

SECRET_KEY

Default: '' (Empty string)

A secret key for a particular Django installation. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value.

django-admin.py startproject automatically adds a randomly-generated SECRET_KEY to each new project.

Warning

Keep this value secret.

Running Django with a known SECRET_KEY defeats many of Django’s security protections, and can lead to privilege escalation and remote code execution vulnerabilities.

Changed in Django 1.5:

Django will now refuse to start if SECRET_KEY is not set.

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 “https://”. This is important for Django’s CSRF protection, and may be used by your own code or third-party apps.

If your Django app is behind a proxy, though, the proxy may be “swallowing” 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:


SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')


Here, we’re telling Django that we trust the X-Forwarded-Proto header 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

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.

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.
Your proxy strips the X-Forwarded-Proto header from all incoming requests. In other words, if end users include that header in their requests, the proxy will discard it.
Your proxy sets the X-Forwarded-Proto header and sends it to Django, but only for requests that originally come in via HTTPS.

If any of those are not true, you should keep this setting set to None and find another way of determining HTTPS, perhaps via custom middleware.

SEND_BROKEN_LINK_EMAILS

Deprecated in Django 1.6:

Deprecated since version 1.6: Since BrokenLinkEmailsMiddleware was split from CommonMiddleware, this setting no longer serves a purpose.

Default: False

Whether to send an email to the MANAGERS each time somebody visits a Django-powered page that is 404ed with a non-empty referer (i.e., a broken link). This is only used if CommonMiddleware is installed (see Middleware). See also IGNORABLE_404_URLS andError reporting.

SERIALIZATION_MODULES

Default: Not defined.

A dictionary of modules containing serializer definitions (provided as strings), keyed by a string identifier for that serialization type. For example, to define a YAML serializer, use:


SERIALIZATION_MODULES = { 'yaml' : 'path.to.yaml_serializer' }


SERVER_EMAIL

Default: 'root@localhost'

The email address that error messages come from, such as those sent to ADMINS and MANAGERS.

SHORT_DATE_FORMAT

Default: m/d/Y (e.g. 12/31/2003)

An available formatting that can be used for displaying date fields on templates. Note that if USE_L10N is set to True, then the corresponding locale-dictated format has higher precedence and will be applied. See allowed date format strings.

SHORT_DATETIME_FORMAT

Default: m/d/Y P (e.g. 12/31/2003 4 p.m.)

An available formatting that can be used for displaying datetime fields on templates. Note that if USE_L10N is set to True, then the corresponding locale-dictated format has higher precedence and will be applied. See allowed date format strings.

See also DATE_FORMAT and SHORT_DATE_FORMAT.

SIGNING_BACKEND

Default: ‘django.core.signing.TimestampSigner’

The backend used for signing cookies and other data.

See also the Cryptographic signing documentation.

TEMPLATE_CONTEXT_PROCESSORS

Default:


("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")


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.

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 exception raised during template rendering. This report contains the relevant snippet of the template, with the appropriate line highlighted.

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.

TEMPLATE_DIRS

Default: () (Empty tuple)

List of locations of the template source files searched by django.template.loaders.filesystem.Loader, in search order.

Note that these paths should use Unix-style forward slashes, even on Windows.

See The Django template language.

TEMPLATE_LOADERS

Default:


('django.template.loaders.filesystem.Loader',
 'django.template.loaders.app_directories.Loader')

A tuple of template loader classes, specified as strings. Each Loader class knows how to import templates from a particular source. 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 The Django template language: For Python programmers.

TEMPLATE_STRING_IF_INVALID

Default: '' (Empty string)

Output, as a string, that the template system should use for invalid (e.g. misspelled) variables. See How invalid variables are handled..

TEST_RUNNER

Default: 'django.test.runner.DiscoverRunner'

The name of the class to use for starting the test suite. See Using different testing frameworks.

Changed in Django Development version:

Previously the default TEST_RUNNER was django.test.simple.DjangoTestSuiteRunner.

THOUSAND_SEPARATOR

Default: , (Comma)

Default thousand separator used when formatting numbers. This setting is used only when USE_THOUSAND_SEPARATOR is True andNUMBER_GROUPING is greater than 0.

Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead.

TIME_FORMAT

Default: 'P' (e.g. 4 p.m.)

The default formatting to use for displaying time fields in any part of the system. Note that if USE_L10N is set to True, then the locale-dictated format has higher precedence and will be applied instead. See allowed date format strings.

See also DATE_FORMAT and DATETIME_FORMAT.

TIME_INPUT_FORMATS

Default:


(
    '%H:%M:%S',     # '14:30:59'
    '%H:%M:%S.%f',  # '14:30:59.000200'
    '%H:%M',        # '14:30'
)


A tuple of formats that will be accepted when inputting data on a time field. Formats will be tried in order, using the first valid one. Note that these format strings use Python’s datetime module syntax, not the format strings from the date Django template tag.

When USE_L10N is True, the locale-dictated format has higher precedence and will be applied instead.

Changed in Django Development version:

Input format with microseconds has been added.

TIME_ZONE

Default: 'America/Chicago'

A string representing the time zone for this installation, or None. See the list of time zones.

Note

Since Django was first released with the 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'.

Note that this isn’t necessarily the time zone of the server. For example, one server may serve multiple Django-powered sites, each with a separate time zone setting.

When USE_TZ is False, this is the time zone in which Django will store all datetimes. When 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.

Django sets the os.environ['TZ'] variable to the time zone you specify in the 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:

If you’re using the manual configuration option as described in manually configuring settings, or
If you specify TIME_ZONE = None. This will cause Django to fall back to using the system timezone. However, this is discouraged when USE_TZ = True, because it makes conversions between local time and UTC less reliable.

If Django doesn’t set the TZ environment variable, it’s up to you to ensure your processes are running in the correct environment.

Note

Django cannot reliably use alternate time zones in a Windows environment. If you’re running Django on Windows, TIME_ZONE must be set to match the system time zone.

TRANSACTIONS_MANAGED

Deprecated in Django 1.6:

Deprecated since version 1.6: This setting was deprecated because its name is very misleading. Use the AUTOCOMMIT key inDATABASES entries instead.

Default: False

Set this to True if you want to disable Django’s transaction management and implement your own.

USE_ETAGS

Default: False

A boolean that specifies whether to output the “Etag” header. This saves bandwidth but slows down performance. This is used by the CommonMiddleware (see Middleware) and in the``Cache Framework`` (see Django’s cache framework).

USE_I18N

Default: True

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.

See also LANGUAGE_CODE, USE_L10N and USE_TZ.

USE_L10N

Default: False

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.

See also LANGUAGE_CODE, USE_I18N and USE_TZ.

Note

The default settings.py file created by django-admin.py startproject includes USE_L10N = True for convenience.

USE_THOUSAND_SEPARATOR

Default: False

A boolean that specifies whether to display numbers using a thousand separator. When USE_L10N is set to True and if this is also set to True, Django will use the values of THOUSAND_SEPARATOR and NUMBER_GROUPING to format numbers.

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 TIME_ZONE, USE_I18N and USE_L10N.

Note

The default settings.py file created by django-admin.py startproject includes USE_TZ = True for convenience.

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.

WSGI_APPLICATION

Default: None

The full Python path of the WSGI application object that Django’s built-in servers (e.g. runserver) will use. Thedjango-admin.py startproject management command will create a simple wsgi.py file with an application callable in it, and point this setting to that application.

If not set, the return value of django.core.wsgi.get_wsgi_application() will be used. In this case, the behavior of runserver will be identical to previous Django versions.

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

See allowed date format strings. See also DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT and MONTH_DAY_FORMAT.

X_FRAME_OPTIONS

Default: 'SAMEORIGIN'

The default value for the X-Frame-Options header used by XFrameOptionsMiddleware. See the clickjacking protectiondocumentation.

Admindocs

Settings for django.contrib.admindocs.

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 django.contrib.auth.

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 authentication backends documentation for details.

AUTH_PROFILE_MODULE

Deprecated in Django 1.5:

Deprecated since version 1.5: With the introduction of custom User models, the use of AUTH_PROFILE_MODULE to define a single profile model is no longer supported. See the Django 1.5 release notes for more information.

Default: Not defined

The site-specific user profile model used by this site. See User profiles.

AUTH_USER_MODEL

Default: ‘auth.User’

The model to use to represent a User. See Substituting a custom User model.

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 login_required() decorator, for example.

Changed in Django 1.5:

This setting now also accepts view function names and named 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.

LOGIN_URL

Default: '/accounts/login/'

The URL where requests are redirected for login, especially when using the login_required() decorator.

Changed in Django 1.5:

LOGOUT_URL

Default: '/accounts/logout/'

LOGIN_URL counterpart.

PASSWORD_RESET_TIMEOUT_DAYS

Default: 3

The number of days a password reset link is valid for. Used by the django.contrib.auth password reset mechanism.

PASSWORD_HASHERS

See How Django stores passwords.

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',)


Comments

Settings for django.contrib.comments.

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.

COMMENT_MAX_LENGTH

The maximum length of the comment field, in characters. Comments longer than this will be rejected. Defaults to 3000.

COMMENTS_APP

An app which provides customization of the comments framework. Use the same dotted-string notation as in INSTALLED_APPS. Your custom COMMENTS_APP must also be listed in INSTALLED_APPS.

PROFANITIES_LIST

Default: () (Empty tuple)

A tuple of profanities, as strings, that will be forbidden in comments when COMMENTS_ALLOW_PROFANITIES is False.

Messages

Settings for django.contrib.messages.

MESSAGE_LEVEL

Default: messages.INFO

Sets the minimum message level that will be recorded by the messages framework. See message levels for more details.

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 aboveconstants table.

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 message storage backends for more details.

The backends that use cookies – CookieStorage and FallbackStorage – use the value of SESSION_COOKIE_DOMAIN when setting their cookies.

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 Displaying messages above for more details.

Important

If you override MESSAGE_TAGS in your settings file and rely on any of the built-in constants, you must import theconstants 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 aboveconstants table.

Sessions

Settings for django.contrib.sessions.

SESSION_CACHE_ALIAS

Default: default

If you’re using cache-based session storage, this selects the cache to use.

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 Configuring the session engine for more details.

SESSION_EXPIRE_AT_BROWSER_CLOSE

Default: False

Whether to expire the session when the user closes his or her browser. See Browser-length sessions vs. persistent sessions.

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.

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 django.contrib.sites.

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.

Static files

Settings for django.contrib.staticfiles.

STATIC_ROOT

Default: '' (Empty string)

The absolute path to the directory where collectstatic will collect static files for deployment.

Example: "/var/www/example.com/static/"

If the staticfiles contrib app is enabled (default) the collectstatic management command will collect static files into this directory. See the howto on managing static files for more details about usage.

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 staticfiles‘s finders, which by default, are 'static/' app sub-directories and any directories you include in STATICFILES_DIRS).

STATIC_URL

Default: None

URL to use when referring to static files located in STATIC_ROOT.

Example: "/static/" or "http://static.example.com/"

If not None, this will be used as the base path for media definitions and the staticfiles app.

It must end in a slash if set to a non-empty value.

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 collectstatic or 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 STATIC_URL set '/static/', the collectstatic management command would collect the “stats” files in a'downloads' subdirectory of 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.:


<a href="{{ STATIC_URL }}downloads/polls_20101022.tar.gz">


STATICFILES_STORAGE

Default: 'django.contrib.staticfiles.storage.StaticFilesStorage'

The file storage engine to use when collecting static files with the collectstatic management command.

A ready-to-use instance of the storage backend defined in this setting can be found atdjango.contrib.staticfiles.storage.staticfiles_storage.

For an example, see Serving static files from a cloud service or CDN.

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 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 STATICFILES_FINDERSsetting, it will look for static files in the default file storage as defined by the 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 INSTALLED_APPS setting of your site.

Static file finders are currently considered a private interface, and this interface is thus undocumented.

【Django】settings（django中settings設置）

Settings

ABSOLUTE_URL_OVERRIDES

ADMINS

ALLOWED_HOSTS

ALLOWED_INCLUDE_ROOTS

APPEND_SLASH

CACHES

BACKEND

KEY_FUNCTION

KEY_PREFIX

LOCATION

OPTIONS

TIMEOUT

VERSION

CACHE_MIDDLEWARE_ALIAS

CACHE_MIDDLEWARE_ANONYMOUS_ONLY

CACHE_MIDDLEWARE_KEY_PREFIX

CACHE_MIDDLEWARE_SECONDS

CSRF_COOKIE_DOMAIN

CSRF_COOKIE_HTTPONLY

CSRF_COOKIE_NAME

CSRF_COOKIE_PATH

CSRF_COOKIE_SECURE

CSRF_FAILURE_VIEW

DATABASES

ATOMIC_REQUESTS

AUTOCOMMIT

ENGINE

HOST

NAME

CONN_MAX_AGE

OPTIONS

PASSWORD

PORT

USER

TEST_CHARSET

TEST_COLLATION

TEST_DEPENDENCIES

TEST_MIRROR

TEST_NAME

TEST_CREATE

TEST_USER

TEST_USER_CREATE

TEST_PASSWD

TEST_TBLSPACE

TEST_TBLSPACE_TMP

DATABASE_ROUTERS

DATE_FORMAT

DATE_INPUT_FORMATS

DATETIME_FORMAT

DATETIME_INPUT_FORMATS

DEBUG

DEBUG_PROPAGATE_EXCEPTIONS

DECIMAL_SEPARATOR

DEFAULT_CHARSET

DEFAULT_CONTENT_TYPE

DEFAULT_EXCEPTION_REPORTER_FILTER

DEFAULT_FILE_STORAGE

DEFAULT_FROM_EMAIL

DEFAULT_INDEX_TABLESPACE

DEFAULT_TABLESPACE

DISALLOWED_USER_AGENTS

EMAIL_BACKEND

EMAIL_FILE_PATH

EMAIL_HOST

EMAIL_HOST_PASSWORD

EMAIL_HOST_USER

EMAIL_PORT

EMAIL_SUBJECT_PREFIX

EMAIL_USE_TLS

FILE_CHARSET

FILE_UPLOAD_HANDLERS

FILE_UPLOAD_MAX_MEMORY_SIZE

FILE_UPLOAD_PERMISSIONS

FILE_UPLOAD_TEMP_DIR

FIRST_DAY_OF_WEEK

FIXTURE_DIRS

FORCE_SCRIPT_NAME

FORMAT_MODULE_PATH