settings.txt 98 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383
  1. ========
  2. Settings
  3. ========
  4. .. contents::
  5. :local:
  6. :depth: 1
  7. .. warning::
  8. Be careful when you override settings, especially when the default value
  9. is a non-empty list or dictionary, such as :setting:`MIDDLEWARE_CLASSES`
  10. and :setting:`STATICFILES_FINDERS`. Make sure you keep the components
  11. required by the features of Django you wish to use.
  12. Core Settings
  13. =============
  14. Here's a list of settings available in Django core and their default values.
  15. Settings provided by contrib apps are listed below, followed by a topical index
  16. of the core settings. For introductory material, see the :doc:`settings topic
  17. guide </topics/settings>`.
  18. .. setting:: ABSOLUTE_URL_OVERRIDES
  19. ABSOLUTE_URL_OVERRIDES
  20. ----------------------
  21. Default: ``{}`` (Empty dictionary)
  22. A dictionary mapping ``"app_label.model_name"`` strings to functions that take
  23. a model object and return its URL. This is a way of inserting or overriding
  24. ``get_absolute_url()`` methods on a per-installation basis. Example::
  25. ABSOLUTE_URL_OVERRIDES = {
  26. 'blogs.weblog': lambda o: "/blogs/%s/" % o.slug,
  27. 'news.story': lambda o: "/stories/%s/%s/" % (o.pub_year, o.slug),
  28. }
  29. Note that the model name used in this setting should be all lower-case, regardless
  30. of the case of the actual model class name.
  31. .. setting:: ADMINS
  32. ADMINS
  33. ------
  34. Default: ``[]`` (Empty list)
  35. A list of all the people who get code error notifications. When
  36. ``DEBUG=False`` and a view raises an exception, Django will email these people
  37. with the full exception information. Each item in the list should be a tuple
  38. of (Full name, email address). Example::
  39. [('John', 'john@example.com'), ('Mary', 'mary@example.com')]
  40. Note that Django will email *all* of these people whenever an error happens.
  41. See :doc:`/howto/error-reporting` for more information.
  42. .. setting:: ALLOWED_HOSTS
  43. ALLOWED_HOSTS
  44. -------------
  45. Default: ``[]`` (Empty list)
  46. A list of strings representing the host/domain names that this Django site can
  47. serve. This is a security measure to prevent an attacker from poisoning caches
  48. and triggering password reset emails with links to malicious hosts by submitting
  49. requests with a fake HTTP ``Host`` header, which is possible even under many
  50. seemingly-safe web server configurations.
  51. Values in this list can be fully qualified names (e.g. ``'www.example.com'``),
  52. in which case they will be matched against the request's ``Host`` header
  53. exactly (case-insensitive, not including port). A value beginning with a period
  54. can be used as a subdomain wildcard: ``'.example.com'`` will match
  55. ``example.com``, ``www.example.com``, and any other subdomain of
  56. ``example.com``. A value of ``'*'`` will match anything; in this case you are
  57. responsible to provide your own validation of the ``Host`` header (perhaps in a
  58. middleware; if so this middleware must be listed first in
  59. :setting:`MIDDLEWARE_CLASSES`).
  60. Django also allows the `fully qualified domain name (FQDN)`_ of any entries.
  61. Some browsers include a trailing dot in the ``Host`` header which Django
  62. strips when performing host validation.
  63. .. _`fully qualified domain name (FQDN)`: http://en.wikipedia.org/wiki/Fully_qualified_domain_name
  64. If the ``Host`` header (or ``X-Forwarded-Host`` if
  65. :setting:`USE_X_FORWARDED_HOST` is enabled) does not match any value in this
  66. list, the :meth:`django.http.HttpRequest.get_host()` method will raise
  67. :exc:`~django.core.exceptions.SuspiciousOperation`.
  68. When :setting:`DEBUG` is ``True`` or when running tests, host validation is
  69. disabled; any host will be accepted. Thus it's usually only necessary to set it
  70. in production.
  71. This validation only applies via :meth:`~django.http.HttpRequest.get_host()`;
  72. if your code accesses the ``Host`` header directly from ``request.META`` you
  73. are bypassing this security protection.
  74. .. setting:: ALLOWED_INCLUDE_ROOTS
  75. ALLOWED_INCLUDE_ROOTS
  76. ---------------------
  77. Default: ``[]`` (Empty list)
  78. .. deprecated:: 1.8
  79. This setting, along with the :ttag:`ssi` template tag, is deprecated and
  80. will be removed in Django 1.10.
  81. .. versionchanged:: 1.8
  82. You can also set the ``'allowed_include_roots'`` option in the
  83. :setting:`OPTIONS <TEMPLATES-OPTIONS>` of a ``DjangoTemplates`` backend
  84. instead.
  85. A list of strings representing allowed prefixes for the ``{% ssi %}`` template
  86. tag. This is a security measure, so that template authors can't access files
  87. that they shouldn't be accessing.
  88. For example, if :setting:`ALLOWED_INCLUDE_ROOTS` is ``['/home/html', '/var/www']``,
  89. then ``{% ssi /home/html/foo.txt %}`` would work, but ``{% ssi /etc/passwd %}``
  90. wouldn't.
  91. .. setting:: APPEND_SLASH
  92. APPEND_SLASH
  93. ------------
  94. Default: ``True``
  95. When set to ``True``, if the request URL does not match any of the patterns
  96. in the URLconf and it doesn't end in a slash, an HTTP redirect is issued to the
  97. same URL with a slash appended. Note that the redirect may cause any data
  98. submitted in a POST request to be lost.
  99. The :setting:`APPEND_SLASH` setting is only used if
  100. :class:`~django.middleware.common.CommonMiddleware` is installed
  101. (see :doc:`/topics/http/middleware`). See also :setting:`PREPEND_WWW`.
  102. .. setting:: CACHES
  103. CACHES
  104. ------
  105. Default::
  106. {
  107. 'default': {
  108. 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
  109. }
  110. }
  111. A dictionary containing the settings for all caches to be used with
  112. Django. It is a nested dictionary whose contents maps cache aliases
  113. to a dictionary containing the options for an individual cache.
  114. The :setting:`CACHES` setting must configure a ``default`` cache;
  115. any number of additional caches may also be specified. If you
  116. are using a cache backend other than the local memory cache, or
  117. you need to define multiple caches, other options will be required.
  118. The following cache options are available.
  119. .. setting:: CACHES-BACKEND
  120. BACKEND
  121. ~~~~~~~
  122. Default: ``''`` (Empty string)
  123. The cache backend to use. The built-in cache backends are:
  124. * ``'django.core.cache.backends.db.DatabaseCache'``
  125. * ``'django.core.cache.backends.dummy.DummyCache'``
  126. * ``'django.core.cache.backends.filebased.FileBasedCache'``
  127. * ``'django.core.cache.backends.locmem.LocMemCache'``
  128. * ``'django.core.cache.backends.memcached.MemcachedCache'``
  129. * ``'django.core.cache.backends.memcached.PyLibMCCache'``
  130. You can use a cache backend that doesn't ship with Django by setting
  131. :setting:`BACKEND <CACHES-BACKEND>` to a fully-qualified path of a cache
  132. backend class (i.e. ``mypackage.backends.whatever.WhateverCache``).
  133. .. setting:: CACHES-KEY_FUNCTION
  134. KEY_FUNCTION
  135. ~~~~~~~~~~~~
  136. A string containing a dotted path to a function (or any callable) that defines how to
  137. compose a prefix, version and key into a final cache key. The default
  138. implementation is equivalent to the function::
  139. def make_key(key, key_prefix, version):
  140. return ':'.join([key_prefix, str(version), key])
  141. You may use any key function you want, as long as it has the same
  142. argument signature.
  143. See the :ref:`cache documentation <cache_key_transformation>` for more
  144. information.
  145. .. setting:: CACHES-KEY_PREFIX
  146. KEY_PREFIX
  147. ~~~~~~~~~~
  148. Default: ``''`` (Empty string)
  149. A string that will be automatically included (prepended by default) to
  150. all cache keys used by the Django server.
  151. See the :ref:`cache documentation <cache_key_prefixing>` for more information.
  152. .. setting:: CACHES-LOCATION
  153. LOCATION
  154. ~~~~~~~~
  155. Default: ``''`` (Empty string)
  156. The location of the cache to use. This might be the directory for a
  157. file system cache, a host and port for a memcache server, or simply an
  158. identifying name for a local memory cache. e.g.::
  159. CACHES = {
  160. 'default': {
  161. 'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
  162. 'LOCATION': '/var/tmp/django_cache',
  163. }
  164. }
  165. .. setting:: CACHES-OPTIONS
  166. OPTIONS
  167. ~~~~~~~
  168. Default: None
  169. Extra parameters to pass to the cache backend. Available parameters
  170. vary depending on your cache backend.
  171. Some information on available parameters can be found in the
  172. :doc:`Cache Backends </topics/cache>` documentation. For more information,
  173. consult your backend module's own documentation.
  174. .. setting:: CACHES-TIMEOUT
  175. TIMEOUT
  176. ~~~~~~~
  177. Default: 300
  178. The number of seconds before a cache entry is considered stale. If the value of
  179. this settings is ``None``, cache entries will not expire.
  180. .. setting:: CACHES-VERSION
  181. VERSION
  182. ~~~~~~~
  183. Default: ``1``
  184. The default version number for cache keys generated by the Django server.
  185. See the :ref:`cache documentation <cache_versioning>` for more information.
  186. .. setting:: CACHE_MIDDLEWARE_ALIAS
  187. CACHE_MIDDLEWARE_ALIAS
  188. ----------------------
  189. Default: ``default``
  190. The cache connection to use for the :ref:`cache middleware
  191. <the-per-site-cache>`.
  192. .. setting:: CACHE_MIDDLEWARE_KEY_PREFIX
  193. CACHE_MIDDLEWARE_KEY_PREFIX
  194. ---------------------------
  195. Default: ``''`` (Empty string)
  196. A string which will be prefixed to the cache keys generated by the :ref:`cache
  197. middleware <the-per-site-cache>`. This prefix is combined with the
  198. :setting:`KEY_PREFIX <CACHES-KEY_PREFIX>` setting; it does not replace it.
  199. See :doc:`/topics/cache`.
  200. .. setting:: CACHE_MIDDLEWARE_SECONDS
  201. CACHE_MIDDLEWARE_SECONDS
  202. ------------------------
  203. Default: ``600``
  204. The default number of seconds to cache a page for the :ref:`cache middleware
  205. <the-per-site-cache>`.
  206. See :doc:`/topics/cache`.
  207. .. _settings-csrf:
  208. .. setting:: CSRF_COOKIE_AGE
  209. CSRF_COOKIE_AGE
  210. ---------------
  211. Default: ``31449600`` (approximately 1 year, in seconds)
  212. The age of CSRF cookies, in seconds.
  213. The reason for setting a long-lived expiration time is to avoid problems in
  214. the case of a user closing a browser or bookmarking a page and then loading
  215. that page from a browser cache. Without persistent cookies, the form submission
  216. would fail in this case.
  217. Some browsers (specifically Internet Explorer) can disallow the use of
  218. persistent cookies or can have the indexes to the cookie jar corrupted on disk,
  219. thereby causing CSRF protection checks to (sometimes intermittently) fail.
  220. Change this setting to ``None`` to use session-based CSRF cookies, which
  221. keep the cookies in-memory instead of on persistent storage.
  222. .. setting:: CSRF_COOKIE_DOMAIN
  223. CSRF_COOKIE_DOMAIN
  224. ------------------
  225. Default: ``None``
  226. The domain to be used when setting the CSRF cookie. This can be useful for
  227. easily allowing cross-subdomain requests to be excluded from the normal cross
  228. site request forgery protection. It should be set to a string such as
  229. ``".example.com"`` to allow a POST request from a form on one subdomain to be
  230. accepted by a view served from another subdomain.
  231. Please note that the presence of this setting does not imply that Django's CSRF
  232. protection is safe from cross-subdomain attacks by default - please see the
  233. :ref:`CSRF limitations <csrf-limitations>` section.
  234. .. setting:: CSRF_COOKIE_HTTPONLY
  235. CSRF_COOKIE_HTTPONLY
  236. --------------------
  237. Default: ``False``
  238. Whether to use ``HttpOnly`` flag on the CSRF cookie. If this is set to
  239. ``True``, client-side JavaScript will not to be able to access the CSRF cookie.
  240. This can help prevent malicious JavaScript from bypassing CSRF protection. If
  241. you enable this and need to send the value of the CSRF token with Ajax requests,
  242. your JavaScript will need to pull the value from a hidden CSRF token form input
  243. on the page instead of from the cookie.
  244. See :setting:`SESSION_COOKIE_HTTPONLY` for details on ``HttpOnly``.
  245. .. setting:: CSRF_COOKIE_NAME
  246. CSRF_COOKIE_NAME
  247. ----------------
  248. Default: ``'csrftoken'``
  249. The name of the cookie to use for the CSRF authentication token. This can be
  250. whatever you want. See :doc:`/ref/csrf`.
  251. .. setting:: CSRF_COOKIE_PATH
  252. CSRF_COOKIE_PATH
  253. ----------------
  254. Default: ``'/'``
  255. The path set on the CSRF cookie. This should either match the URL path of your
  256. Django installation or be a parent of that path.
  257. This is useful if you have multiple Django instances running under the same
  258. hostname. They can use different cookie paths, and each instance will only see
  259. its own CSRF cookie.
  260. .. setting:: CSRF_COOKIE_SECURE
  261. CSRF_COOKIE_SECURE
  262. ------------------
  263. Default: ``False``
  264. Whether to use a secure cookie for the CSRF cookie. If this is set to ``True``,
  265. the cookie will be marked as "secure," which means browsers may ensure that the
  266. cookie is only sent with an HTTPS connection.
  267. .. setting:: CSRF_FAILURE_VIEW
  268. CSRF_FAILURE_VIEW
  269. -----------------
  270. Default: ``'django.views.csrf.csrf_failure'``
  271. A dotted path to the view function to be used when an incoming request
  272. is rejected by the CSRF protection. The function should have this signature::
  273. def csrf_failure(request, reason=""):
  274. ...
  275. where ``reason`` is a short message (intended for developers or logging, not for
  276. end users) indicating the reason the request was rejected. See
  277. :doc:`/ref/csrf`.
  278. .. setting:: CSRF_HEADER_NAME
  279. CSRF_HEADER_NAME
  280. ----------------
  281. .. versionadded:: 1.9
  282. Default: ``'HTTP_X_CSRFTOKEN'``
  283. The name of the request header used for CSRF authentication.
  284. As with other HTTP headers in ``request.META``, the header name received from
  285. the server is normalized by converting all characters to uppercase, replacing
  286. any hyphens with underscores, and adding an ``'HTTP_'`` prefix to the name.
  287. For example, if your client sends a ``'X-XSRF-TOKEN'`` header, the setting
  288. should be ``'HTTP_X_XSRF_TOKEN'``.
  289. .. setting:: DATABASES
  290. DATABASES
  291. ---------
  292. Default: ``{}`` (Empty dictionary)
  293. A dictionary containing the settings for all databases to be used with
  294. Django. It is a nested dictionary whose contents map a database alias
  295. to a dictionary containing the options for an individual database.
  296. The :setting:`DATABASES` setting must configure a ``default`` database;
  297. any number of additional databases may also be specified.
  298. The simplest possible settings file is for a single-database setup using
  299. SQLite. This can be configured using the following::
  300. DATABASES = {
  301. 'default': {
  302. 'ENGINE': 'django.db.backends.sqlite3',
  303. 'NAME': 'mydatabase',
  304. }
  305. }
  306. When connecting to other database backends, such as MySQL, Oracle, or
  307. PostgreSQL, additional connection parameters will be required. See
  308. the :setting:`ENGINE <DATABASE-ENGINE>` setting below on how to specify
  309. other database types. This example is for PostgreSQL::
  310. DATABASES = {
  311. 'default': {
  312. 'ENGINE': 'django.db.backends.postgresql_psycopg2',
  313. 'NAME': 'mydatabase',
  314. 'USER': 'mydatabaseuser',
  315. 'PASSWORD': 'mypassword',
  316. 'HOST': '127.0.0.1',
  317. 'PORT': '5432',
  318. }
  319. }
  320. The following inner options that may be required for more complex
  321. configurations are available:
  322. .. setting:: DATABASE-ATOMIC_REQUESTS
  323. ATOMIC_REQUESTS
  324. ~~~~~~~~~~~~~~~
  325. Default: ``False``
  326. Set this to ``True`` to wrap each HTTP request in a transaction on this
  327. database. See :ref:`tying-transactions-to-http-requests`.
  328. .. setting:: DATABASE-AUTOCOMMIT
  329. AUTOCOMMIT
  330. ~~~~~~~~~~
  331. Default: ``True``
  332. Set this to ``False`` if you want to :ref:`disable Django's transaction
  333. management <deactivate-transaction-management>` and implement your own.
  334. .. setting:: DATABASE-ENGINE
  335. ENGINE
  336. ~~~~~~
  337. Default: ``''`` (Empty string)
  338. The database backend to use. The built-in database backends are:
  339. * ``'django.db.backends.postgresql_psycopg2'``
  340. * ``'django.db.backends.mysql'``
  341. * ``'django.db.backends.sqlite3'``
  342. * ``'django.db.backends.oracle'``
  343. You can use a database backend that doesn't ship with Django by setting
  344. ``ENGINE`` to a fully-qualified path (i.e.
  345. ``mypackage.backends.whatever``).
  346. .. setting:: HOST
  347. HOST
  348. ~~~~
  349. Default: ``''`` (Empty string)
  350. Which host to use when connecting to the database. An empty string means
  351. localhost. Not used with SQLite.
  352. If this value starts with a forward slash (``'/'``) and you're using MySQL,
  353. MySQL will connect via a Unix socket to the specified socket. For example::
  354. "HOST": '/var/run/mysql'
  355. If you're using MySQL and this value *doesn't* start with a forward slash, then
  356. this value is assumed to be the host.
  357. If you're using PostgreSQL, by default (empty :setting:`HOST`), the connection
  358. to the database is done through UNIX domain sockets ('local' lines in
  359. ``pg_hba.conf``). If your UNIX domain socket is not in the standard location,
  360. use the same value of ``unix_socket_directory`` from ``postgresql.conf``.
  361. If you want to connect through TCP sockets, set :setting:`HOST` to 'localhost'
  362. or '127.0.0.1' ('host' lines in ``pg_hba.conf``).
  363. On Windows, you should always define :setting:`HOST`, as UNIX domain sockets
  364. are not available.
  365. .. setting:: NAME
  366. NAME
  367. ~~~~
  368. Default: ``''`` (Empty string)
  369. The name of the database to use. For SQLite, it's the full path to the database
  370. file. When specifying the path, always use forward slashes, even on Windows
  371. (e.g. ``C:/homes/user/mysite/sqlite3.db``).
  372. .. setting:: CONN_MAX_AGE
  373. CONN_MAX_AGE
  374. ~~~~~~~~~~~~
  375. Default: ``0``
  376. The lifetime of a database connection, in seconds. Use ``0`` to close database
  377. connections at the end of each request — Django's historical behavior — and
  378. ``None`` for unlimited persistent connections.
  379. .. setting:: OPTIONS
  380. OPTIONS
  381. ~~~~~~~
  382. Default: ``{}`` (Empty dictionary)
  383. Extra parameters to use when connecting to the database. Available parameters
  384. vary depending on your database backend.
  385. Some information on available parameters can be found in the
  386. :doc:`Database Backends </ref/databases>` documentation. For more information,
  387. consult your backend module's own documentation.
  388. .. setting:: PASSWORD
  389. PASSWORD
  390. ~~~~~~~~
  391. Default: ``''`` (Empty string)
  392. The password to use when connecting to the database. Not used with SQLite.
  393. .. setting:: PORT
  394. PORT
  395. ~~~~
  396. Default: ``''`` (Empty string)
  397. The port to use when connecting to the database. An empty string means the
  398. default port. Not used with SQLite.
  399. .. setting:: DATABASE-TIME_ZONE
  400. TIME_ZONE
  401. ~~~~~~~~~
  402. .. versionadded:: 1.9
  403. Default: ``None``
  404. A string representing the time zone for datetimes stored in this database
  405. (assuming that it doesn't support time zones) or ``None``. The same values are
  406. accepted as in the general :setting:`TIME_ZONE` setting.
  407. This allows interacting with third-party databases that store datetimes in
  408. local time rather than UTC. To avoid issues around DST changes, you shouldn't
  409. set this option for databases managed by Django.
  410. Setting this option requires installing pytz_.
  411. When :setting:`USE_TZ` is ``True`` and the database doesn't support time zones
  412. (e.g. SQLite, MySQL, Oracle), Django reads and writes datetimes in local time
  413. according to this option if it is set and in UTC if it isn't.
  414. When :setting:`USE_TZ` is ``True`` and the database supports time zones (e.g.
  415. PostgreSQL), it is an error to set this option.
  416. .. versionchanged:: 1.9
  417. Before Django 1.9, the PostgreSQL database backend accepted an
  418. undocumented ``TIME_ZONE`` option, which caused data corruption.
  419. When :setting:`USE_TZ` is ``False``, it is an error to set this option.
  420. .. _pytz: http://pytz.sourceforge.net/
  421. .. setting:: USER
  422. USER
  423. ~~~~
  424. Default: ``''`` (Empty string)
  425. The username to use when connecting to the database. Not used with SQLite.
  426. .. setting:: DATABASE-TEST
  427. TEST
  428. ~~~~
  429. Default: ``{}``
  430. A dictionary of settings for test databases; for more details about the
  431. creation and use of test databases, see :ref:`the-test-database`. The
  432. following entries are available:
  433. .. setting:: TEST_CHARSET
  434. CHARSET
  435. ^^^^^^^
  436. Default: ``None``
  437. The character set encoding used to create the test database. The value of this
  438. string is passed directly through to the database, so its format is
  439. backend-specific.
  440. Supported for the PostgreSQL_ (``postgresql_psycopg2``) and MySQL_ (``mysql``)
  441. backends.
  442. .. _PostgreSQL: http://www.postgresql.org/docs/current/static/multibyte.html
  443. .. _MySQL: http://dev.mysql.com/doc/refman/5.6/en/charset-database.html
  444. .. setting:: TEST_COLLATION
  445. COLLATION
  446. ^^^^^^^^^
  447. Default: ``None``
  448. The collation order to use when creating the test database. This value is
  449. passed directly to the backend, so its format is backend-specific.
  450. Only supported for the ``mysql`` backend (see the `MySQL manual`_ for details).
  451. .. _MySQL manual: MySQL_
  452. .. setting:: TEST_DEPENDENCIES
  453. DEPENDENCIES
  454. ^^^^^^^^^^^^
  455. Default: ``['default']``, for all databases other than ``default``,
  456. which has no dependencies.
  457. The creation-order dependencies of the database. See the documentation
  458. on :ref:`controlling the creation order of test databases
  459. <topics-testing-creation-dependencies>` for details.
  460. .. setting:: TEST_MIRROR
  461. MIRROR
  462. ^^^^^^
  463. Default: ``None``
  464. The alias of the database that this database should mirror during
  465. testing.
  466. This setting exists to allow for testing of primary/replica
  467. (referred to as master/slave by some databases)
  468. configurations of multiple databases. See the documentation on
  469. :ref:`testing primary/replica configurations
  470. <topics-testing-primaryreplica>` for details.
  471. .. setting:: TEST_NAME
  472. NAME
  473. ^^^^
  474. Default: ``None``
  475. The name of database to use when running the test suite.
  476. If the default value (``None``) is used with the SQLite database engine, the
  477. tests will use a memory resident database. For all other database engines the
  478. test database will use the name ``'test_' + DATABASE_NAME``.
  479. See :ref:`the-test-database`.
  480. .. setting:: TEST_SERIALIZE
  481. SERIALIZE
  482. ^^^^^^^^^
  483. Boolean value to control whether or not the default test runner serializes the
  484. database into an in-memory JSON string before running tests (used to restore
  485. the database state between tests if you don't have transactions). You can set
  486. this to ``False`` to speed up creation time if you don't have any test classes
  487. with :ref:`serialized_rollback=True <test-case-serialized-rollback>`.
  488. .. setting:: TEST_CREATE
  489. CREATE_DB
  490. ^^^^^^^^^
  491. Default: ``True``
  492. This is an Oracle-specific setting.
  493. If it is set to ``False``, the test tablespaces won't be automatically created
  494. at the beginning of the tests or dropped at the end.
  495. .. setting:: TEST_USER_CREATE
  496. CREATE_USER
  497. ^^^^^^^^^^^
  498. Default: ``True``
  499. This is an Oracle-specific setting.
  500. If it is set to ``False``, the test user won't be automatically created at the
  501. beginning of the tests and dropped at the end.
  502. .. setting:: TEST_USER
  503. USER
  504. ^^^^
  505. Default: ``None``
  506. This is an Oracle-specific setting.
  507. The username to use when connecting to the Oracle database that will be used
  508. when running tests. If not provided, Django will use ``'test_' + USER``.
  509. .. setting:: TEST_PASSWD
  510. PASSWORD
  511. ^^^^^^^^
  512. Default: ``None``
  513. This is an Oracle-specific setting.
  514. The password to use when connecting to the Oracle database that will be used
  515. when running tests. If not provided, Django will use a hardcoded default value.
  516. .. setting:: TEST_TBLSPACE
  517. TBLSPACE
  518. ^^^^^^^^
  519. Default: ``None``
  520. This is an Oracle-specific setting.
  521. The name of the tablespace that will be used when running tests. If not
  522. provided, Django will use ``'test_' + USER``.
  523. .. versionchanged:: 1.8
  524. Previously Django used ``'test_' + NAME`` if not provided.
  525. .. setting:: TEST_TBLSPACE_TMP
  526. TBLSPACE_TMP
  527. ^^^^^^^^^^^^
  528. Default: ``None``
  529. This is an Oracle-specific setting.
  530. The name of the temporary tablespace that will be used when running tests. If
  531. not provided, Django will use ``'test_' + USER + '_temp'``.
  532. .. versionchanged:: 1.8
  533. Previously Django used ``'test_' + NAME + '_temp'`` if not provided.
  534. .. setting:: DATAFILE
  535. DATAFILE
  536. ^^^^^^^^
  537. .. versionadded:: 1.8
  538. Default: ``None``
  539. This is an Oracle-specific setting.
  540. The name of the datafile to use for the TBLSPACE. If not provided, Django will
  541. use ``TBLSPACE + '.dbf'``.
  542. .. setting:: DATAFILE_TMP
  543. DATAFILE_TMP
  544. ^^^^^^^^^^^^
  545. .. versionadded:: 1.8
  546. Default: ``None``
  547. This is an Oracle-specific setting.
  548. The name of the datafile to use for the TBLSPACE_TMP. If not provided, Django
  549. will use ``TBLSPACE_TMP + '.dbf'``.
  550. .. setting:: DATAFILE_MAXSIZE
  551. DATAFILE_MAXSIZE
  552. ^^^^^^^^^^^^^^^^
  553. .. versionadded:: 1.8
  554. Default: ``'500M'``
  555. .. versionchanged:: 1.8
  556. The previous value was 200M and was not user customizable.
  557. This is an Oracle-specific setting.
  558. The maximum size that the DATAFILE is allowed to grow to.
  559. .. setting:: DATAFILE_TMP_MAXSIZE
  560. DATAFILE_TMP_MAXSIZE
  561. ^^^^^^^^^^^^^^^^^^^^
  562. .. versionadded:: 1.8
  563. Default: ``'500M'``
  564. .. versionchanged:: 1.8
  565. The previous value was 200M and was not user customizable.
  566. This is an Oracle-specific setting.
  567. The maximum size that the DATAFILE_TMP is allowed to grow to.
  568. .. setting:: DATABASE_ROUTERS
  569. DATABASE_ROUTERS
  570. ----------------
  571. Default: ``[]`` (Empty list)
  572. The list of routers that will be used to determine which database
  573. to use when performing a database query.
  574. See the documentation on :ref:`automatic database routing in multi
  575. database configurations <topics-db-multi-db-routing>`.
  576. .. setting:: DATE_FORMAT
  577. DATE_FORMAT
  578. -----------
  579. Default: ``'N j, Y'`` (e.g. ``Feb. 4, 2003``)
  580. The default formatting to use for displaying date fields in any part of the
  581. system. Note that if :setting:`USE_L10N` is set to ``True``, then the
  582. locale-dictated format has higher precedence and will be applied instead. See
  583. :tfilter:`allowed date format strings <date>`.
  584. See also :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
  585. .. setting:: DATE_INPUT_FORMATS
  586. DATE_INPUT_FORMATS
  587. ------------------
  588. Default::
  589. [
  590. '%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', # '2006-10-25', '10/25/2006', '10/25/06'
  591. '%b %d %Y', '%b %d, %Y', # 'Oct 25 2006', 'Oct 25, 2006'
  592. '%d %b %Y', '%d %b, %Y', # '25 Oct 2006', '25 Oct, 2006'
  593. '%B %d %Y', '%B %d, %Y', # 'October 25 2006', 'October 25, 2006'
  594. '%d %B %Y', '%d %B, %Y', # '25 October 2006', '25 October, 2006'
  595. ]
  596. A list of formats that will be accepted when inputting data on a date field.
  597. Formats will be tried in order, using the first valid one. Note that these
  598. format strings use Python's datetime_ module syntax, not the format strings
  599. from the ``date`` Django template tag.
  600. When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
  601. precedence and will be applied instead.
  602. See also :setting:`DATETIME_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
  603. .. _datetime: https://docs.python.org/library/datetime.html#strftime-strptime-behavior
  604. .. setting:: DATETIME_FORMAT
  605. DATETIME_FORMAT
  606. ---------------
  607. Default: ``'N j, Y, P'`` (e.g. ``Feb. 4, 2003, 4 p.m.``)
  608. The default formatting to use for displaying datetime fields in any part of the
  609. system. Note that if :setting:`USE_L10N` is set to ``True``, then the
  610. locale-dictated format has higher precedence and will be applied instead. See
  611. :tfilter:`allowed date format strings <date>`.
  612. See also :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
  613. .. setting:: DATETIME_INPUT_FORMATS
  614. DATETIME_INPUT_FORMATS
  615. ----------------------
  616. Default::
  617. [
  618. '%Y-%m-%d %H:%M:%S', # '2006-10-25 14:30:59'
  619. '%Y-%m-%d %H:%M:%S.%f', # '2006-10-25 14:30:59.000200'
  620. '%Y-%m-%d %H:%M', # '2006-10-25 14:30'
  621. '%Y-%m-%d', # '2006-10-25'
  622. '%m/%d/%Y %H:%M:%S', # '10/25/2006 14:30:59'
  623. '%m/%d/%Y %H:%M:%S.%f', # '10/25/2006 14:30:59.000200'
  624. '%m/%d/%Y %H:%M', # '10/25/2006 14:30'
  625. '%m/%d/%Y', # '10/25/2006'
  626. '%m/%d/%y %H:%M:%S', # '10/25/06 14:30:59'
  627. '%m/%d/%y %H:%M:%S.%f', # '10/25/06 14:30:59.000200'
  628. '%m/%d/%y %H:%M', # '10/25/06 14:30'
  629. '%m/%d/%y', # '10/25/06'
  630. ]
  631. A list of formats that will be accepted when inputting data on a datetime
  632. field. Formats will be tried in order, using the first valid one. Note that
  633. these format strings use Python's datetime_ module syntax, not the format
  634. strings from the ``date`` Django template tag.
  635. When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
  636. precedence and will be applied instead.
  637. See also :setting:`DATE_INPUT_FORMATS` and :setting:`TIME_INPUT_FORMATS`.
  638. .. _datetime: https://docs.python.org/library/datetime.html#strftime-strptime-behavior
  639. .. setting:: DEBUG
  640. DEBUG
  641. -----
  642. Default: ``False``
  643. A boolean that turns on/off debug mode.
  644. Never deploy a site into production with :setting:`DEBUG` turned on.
  645. Did you catch that? NEVER deploy a site into production with :setting:`DEBUG`
  646. turned on.
  647. One of the main features of debug mode is the display of detailed error pages.
  648. If your app raises an exception when :setting:`DEBUG` is ``True``, Django will
  649. display a detailed traceback, including a lot of metadata about your
  650. environment, such as all the currently defined Django settings (from
  651. ``settings.py``).
  652. As a security measure, Django will *not* include settings that might be
  653. sensitive (or offensive), such as :setting:`SECRET_KEY`. Specifically, it will
  654. exclude any setting whose name includes any of the following:
  655. * ``'API'``
  656. * ``'KEY'``
  657. * ``'PASS'``
  658. * ``'SECRET'``
  659. * ``'SIGNATURE'``
  660. * ``'TOKEN'``
  661. Note that these are *partial* matches. ``'PASS'`` will also match PASSWORD,
  662. just as ``'TOKEN'`` will also match TOKENIZED and so on.
  663. Still, note that there are always going to be sections of your debug output
  664. that are inappropriate for public consumption. File paths, configuration
  665. options and the like all give attackers extra information about your server.
  666. It is also important to remember that when running with :setting:`DEBUG`
  667. turned on, Django will remember every SQL query it executes. This is useful
  668. when you're debugging, but it'll rapidly consume memory on a production server.
  669. Finally, if :setting:`DEBUG` is ``False``, you also need to properly set
  670. the :setting:`ALLOWED_HOSTS` setting. Failing to do so will result in all
  671. requests being returned as "Bad Request (400)".
  672. .. note::
  673. The default :file:`settings.py` file created by :djadmin:`django-admin
  674. startproject <startproject>` sets ``DEBUG = True`` for convenience.
  675. .. _django/views/debug.py: https://github.com/django/django/blob/master/django/views/debug.py
  676. .. setting:: DEBUG_PROPAGATE_EXCEPTIONS
  677. DEBUG_PROPAGATE_EXCEPTIONS
  678. --------------------------
  679. Default: ``False``
  680. If set to True, Django's normal exception handling of view functions
  681. will be suppressed, and exceptions will propagate upwards. This can
  682. be useful for some test setups, and should never be used on a live
  683. site.
  684. .. setting:: DECIMAL_SEPARATOR
  685. DECIMAL_SEPARATOR
  686. -----------------
  687. Default: ``'.'`` (Dot)
  688. Default decimal separator used when formatting decimal numbers.
  689. Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
  690. format has higher precedence and will be applied instead.
  691. See also :setting:`NUMBER_GROUPING`, :setting:`THOUSAND_SEPARATOR` and
  692. :setting:`USE_THOUSAND_SEPARATOR`.
  693. .. setting:: DEFAULT_CHARSET
  694. DEFAULT_CHARSET
  695. ---------------
  696. Default: ``'utf-8'``
  697. Default charset to use for all ``HttpResponse`` objects, if a MIME type isn't
  698. manually specified. Used with :setting:`DEFAULT_CONTENT_TYPE` to construct the
  699. ``Content-Type`` header.
  700. .. setting:: DEFAULT_CONTENT_TYPE
  701. DEFAULT_CONTENT_TYPE
  702. --------------------
  703. Default: ``'text/html'``
  704. Default content type to use for all ``HttpResponse`` objects, if a MIME type
  705. isn't manually specified. Used with :setting:`DEFAULT_CHARSET` to construct
  706. the ``Content-Type`` header.
  707. .. setting:: DEFAULT_EXCEPTION_REPORTER_FILTER
  708. DEFAULT_EXCEPTION_REPORTER_FILTER
  709. ---------------------------------
  710. Default: :class:`django.views.debug.SafeExceptionReporterFilter`
  711. Default exception reporter filter class to be used if none has been assigned to
  712. the :class:`~django.http.HttpRequest` instance yet.
  713. See :ref:`Filtering error reports<filtering-error-reports>`.
  714. .. setting:: DEFAULT_FILE_STORAGE
  715. DEFAULT_FILE_STORAGE
  716. --------------------
  717. Default: :class:`django.core.files.storage.FileSystemStorage`
  718. Default file storage class to be used for any file-related operations that don't
  719. specify a particular storage system. See :doc:`/topics/files`.
  720. .. setting:: DEFAULT_FROM_EMAIL
  721. DEFAULT_FROM_EMAIL
  722. ------------------
  723. Default: ``'webmaster@localhost'``
  724. Default email address to use for various automated correspondence from the
  725. site manager(s). This doesn't include error messages sent to :setting:`ADMINS`
  726. and :setting:`MANAGERS`; for that, see :setting:`SERVER_EMAIL`.
  727. .. setting:: DEFAULT_INDEX_TABLESPACE
  728. DEFAULT_INDEX_TABLESPACE
  729. ------------------------
  730. Default: ``''`` (Empty string)
  731. Default tablespace to use for indexes on fields that don't specify
  732. one, if the backend supports it (see :doc:`/topics/db/tablespaces`).
  733. .. setting:: DEFAULT_TABLESPACE
  734. DEFAULT_TABLESPACE
  735. ------------------
  736. Default: ``''`` (Empty string)
  737. Default tablespace to use for models that don't specify one, if the
  738. backend supports it (see :doc:`/topics/db/tablespaces`).
  739. .. setting:: DISALLOWED_USER_AGENTS
  740. DISALLOWED_USER_AGENTS
  741. ----------------------
  742. Default: ``[]`` (Empty list)
  743. List of compiled regular expression objects representing User-Agent strings that
  744. are not allowed to visit any page, systemwide. Use this for bad robots/crawlers.
  745. This is only used if ``CommonMiddleware`` is installed (see
  746. :doc:`/topics/http/middleware`).
  747. .. setting:: EMAIL_BACKEND
  748. EMAIL_BACKEND
  749. -------------
  750. Default: ``'django.core.mail.backends.smtp.EmailBackend'``
  751. The backend to use for sending emails. For the list of available backends see
  752. :doc:`/topics/email`.
  753. .. setting:: EMAIL_FILE_PATH
  754. EMAIL_FILE_PATH
  755. ---------------
  756. Default: Not defined
  757. The directory used by the ``file`` email backend to store output files.
  758. .. setting:: EMAIL_HOST
  759. EMAIL_HOST
  760. ----------
  761. Default: ``'localhost'``
  762. The host to use for sending email.
  763. See also :setting:`EMAIL_PORT`.
  764. .. setting:: EMAIL_HOST_PASSWORD
  765. EMAIL_HOST_PASSWORD
  766. -------------------
  767. Default: ``''`` (Empty string)
  768. Password to use for the SMTP server defined in :setting:`EMAIL_HOST`. This
  769. setting is used in conjunction with :setting:`EMAIL_HOST_USER` when
  770. authenticating to the SMTP server. If either of these settings is empty,
  771. Django won't attempt authentication.
  772. See also :setting:`EMAIL_HOST_USER`.
  773. .. setting:: EMAIL_HOST_USER
  774. EMAIL_HOST_USER
  775. ---------------
  776. Default: ``''`` (Empty string)
  777. Username to use for the SMTP server defined in :setting:`EMAIL_HOST`.
  778. If empty, Django won't attempt authentication.
  779. See also :setting:`EMAIL_HOST_PASSWORD`.
  780. .. setting:: EMAIL_PORT
  781. EMAIL_PORT
  782. ----------
  783. Default: ``25``
  784. Port to use for the SMTP server defined in :setting:`EMAIL_HOST`.
  785. .. setting:: EMAIL_SUBJECT_PREFIX
  786. EMAIL_SUBJECT_PREFIX
  787. --------------------
  788. Default: ``'[Django] '``
  789. Subject-line prefix for email messages sent with ``django.core.mail.mail_admins``
  790. or ``django.core.mail.mail_managers``. You'll probably want to include the
  791. trailing space.
  792. .. setting:: EMAIL_USE_TLS
  793. EMAIL_USE_TLS
  794. -------------
  795. Default: ``False``
  796. Whether to use a TLS (secure) connection when talking to the SMTP server.
  797. This is used for explicit TLS connections, generally on port 587. If you are
  798. experiencing hanging connections, see the implicit TLS setting
  799. :setting:`EMAIL_USE_SSL`.
  800. .. setting:: EMAIL_USE_SSL
  801. EMAIL_USE_SSL
  802. -------------
  803. Default: ``False``
  804. Whether to use an implicit TLS (secure) connection when talking to the SMTP
  805. server. In most email documentation this type of TLS connection is referred
  806. to as SSL. It is generally used on port 465. If you are experiencing problems,
  807. see the explicit TLS setting :setting:`EMAIL_USE_TLS`.
  808. Note that :setting:`EMAIL_USE_TLS`/:setting:`EMAIL_USE_SSL` are mutually
  809. exclusive, so only set one of those settings to ``True``.
  810. .. setting:: EMAIL_SSL_CERTFILE
  811. EMAIL_SSL_CERTFILE
  812. ------------------
  813. .. versionadded:: 1.8
  814. Default: ``None``
  815. If :setting:`EMAIL_USE_SSL` or :setting:`EMAIL_USE_TLS` is ``True``, you can
  816. optionally specify the path to a PEM-formatted certificate chain file to use
  817. for the SSL connection.
  818. .. setting:: EMAIL_SSL_KEYFILE
  819. EMAIL_SSL_KEYFILE
  820. -----------------
  821. .. versionadded:: 1.8
  822. Default: ``None``
  823. If :setting:`EMAIL_USE_SSL` or :setting:`EMAIL_USE_TLS` is ``True``, you can
  824. optionally specify the path to a PEM-formatted private key file to use for the
  825. SSL connection.
  826. Note that setting :setting:`EMAIL_SSL_CERTFILE` and :setting:`EMAIL_SSL_KEYFILE`
  827. doesn't result in any certificate checking. They're passed to the underlying SSL
  828. connection. Please refer to the documentation of Python's
  829. :func:`python:ssl.wrap_socket` function for details on how the certificate chain
  830. file and private key file are handled.
  831. .. setting:: EMAIL_TIMEOUT
  832. EMAIL_TIMEOUT
  833. -------------
  834. .. versionadded:: 1.8
  835. Default: ``None``
  836. Specifies a timeout in seconds for blocking operations like the connection
  837. attempt.
  838. .. setting:: FILE_CHARSET
  839. FILE_CHARSET
  840. ------------
  841. Default: ``'utf-8'``
  842. The character encoding used to decode any files read from disk. This includes
  843. template files and initial SQL data files.
  844. .. setting:: FILE_UPLOAD_HANDLERS
  845. FILE_UPLOAD_HANDLERS
  846. --------------------
  847. Default::
  848. ["django.core.files.uploadhandler.MemoryFileUploadHandler",
  849. "django.core.files.uploadhandler.TemporaryFileUploadHandler"]
  850. A list of handlers to use for uploading. Changing this setting allows complete
  851. customization -- even replacement -- of Django's upload process.
  852. See :doc:`/topics/files` for details.
  853. .. setting:: FILE_UPLOAD_MAX_MEMORY_SIZE
  854. FILE_UPLOAD_MAX_MEMORY_SIZE
  855. ---------------------------
  856. Default: ``2621440`` (i.e. 2.5 MB).
  857. The maximum size (in bytes) that an upload will be before it gets streamed to
  858. the file system. See :doc:`/topics/files` for details.
  859. .. setting:: FILE_UPLOAD_DIRECTORY_PERMISSIONS
  860. FILE_UPLOAD_DIRECTORY_PERMISSIONS
  861. ---------------------------------
  862. Default: ``None``
  863. The numeric mode to apply to directories created in the process of uploading
  864. files.
  865. This setting also determines the default permissions for collected static
  866. directories when using the :djadmin:`collectstatic` management command. See
  867. :djadmin:`collectstatic` for details on overriding it.
  868. This value mirrors the functionality and caveats of the
  869. :setting:`FILE_UPLOAD_PERMISSIONS` setting.
  870. .. setting:: FILE_UPLOAD_PERMISSIONS
  871. FILE_UPLOAD_PERMISSIONS
  872. -----------------------
  873. Default: ``None``
  874. The numeric mode (i.e. ``0o644``) to set newly uploaded files to. For
  875. more information about what these modes mean, see the documentation for
  876. :func:`os.chmod`.
  877. If this isn't given or is ``None``, you'll get operating-system
  878. dependent behavior. On most platforms, temporary files will have a mode
  879. of ``0o600``, and files saved from memory will be saved using the
  880. system's standard umask.
  881. For security reasons, these permissions aren't applied to the temporary files
  882. that are stored in :setting:`FILE_UPLOAD_TEMP_DIR`.
  883. This setting also determines the default permissions for collected static files
  884. when using the :djadmin:`collectstatic` management command. See
  885. :djadmin:`collectstatic` for details on overriding it.
  886. .. warning::
  887. **Always prefix the mode with a 0.**
  888. If you're not familiar with file modes, please note that the leading
  889. ``0`` is very important: it indicates an octal number, which is the
  890. way that modes must be specified. If you try to use ``644``, you'll
  891. get totally incorrect behavior.
  892. .. setting:: FILE_UPLOAD_TEMP_DIR
  893. FILE_UPLOAD_TEMP_DIR
  894. --------------------
  895. Default: ``None``
  896. The directory to store data to (typically files larger than
  897. :setting:`FILE_UPLOAD_MAX_MEMORY_SIZE`) temporarily while uploading files.
  898. If ``None``, Django will use the standard temporary directory for the operating
  899. system. For example, this will default to ``/tmp`` on \*nix-style operating
  900. systems.
  901. See :doc:`/topics/files` for details.
  902. .. setting:: FIRST_DAY_OF_WEEK
  903. FIRST_DAY_OF_WEEK
  904. -----------------
  905. Default: ``0`` (Sunday)
  906. A number representing the first day of the week. This is especially useful
  907. when displaying a calendar. This value is only used when not using
  908. format internationalization, or when a format cannot be found for the
  909. current locale.
  910. The value must be an integer from 0 to 6, where 0 means Sunday, 1 means
  911. Monday and so on.
  912. .. setting:: FIXTURE_DIRS
  913. FIXTURE_DIRS
  914. -------------
  915. Default: ``[]`` (Empty list)
  916. List of directories searched for fixture files, in addition to the
  917. ``fixtures`` directory of each application, in search order.
  918. Note that these paths should use Unix-style forward slashes, even on Windows.
  919. See :ref:`initial-data-via-fixtures` and :ref:`topics-testing-fixtures`.
  920. .. setting:: FORCE_SCRIPT_NAME
  921. FORCE_SCRIPT_NAME
  922. ------------------
  923. Default: ``None``
  924. If not ``None``, this will be used as the value of the ``SCRIPT_NAME``
  925. environment variable in any HTTP request. This setting can be used to override
  926. the server-provided value of ``SCRIPT_NAME``, which may be a rewritten version
  927. of the preferred value or not supplied at all.
  928. .. setting:: FORMAT_MODULE_PATH
  929. FORMAT_MODULE_PATH
  930. ------------------
  931. Default: ``None``
  932. A full Python path to a Python package that contains format definitions for
  933. project locales. If not ``None``, Django will check for a ``formats.py``
  934. file, under the directory named as the current locale, and will use the
  935. formats defined in this file.
  936. For example, if :setting:`FORMAT_MODULE_PATH` is set to ``mysite.formats``,
  937. and current language is ``en`` (English), Django will expect a directory tree
  938. like::
  939. mysite/
  940. formats/
  941. __init__.py
  942. en/
  943. __init__.py
  944. formats.py
  945. .. versionchanged:: 1.8
  946. You can also set this setting to a list of Python paths, for example::
  947. FORMAT_MODULE_PATH = [
  948. 'mysite.formats',
  949. 'some_app.formats',
  950. ]
  951. When Django searches for a certain format, it will go through all given
  952. Python paths until it finds a module that actually defines the given
  953. format. This means that formats defined in packages farther up in the list
  954. will take precedence over the same formats in packages farther down.
  955. Available formats are :setting:`DATE_FORMAT`, :setting:`TIME_FORMAT`,
  956. :setting:`DATETIME_FORMAT`, :setting:`YEAR_MONTH_FORMAT`,
  957. :setting:`MONTH_DAY_FORMAT`, :setting:`SHORT_DATE_FORMAT`,
  958. :setting:`SHORT_DATETIME_FORMAT`, :setting:`FIRST_DAY_OF_WEEK`,
  959. :setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and
  960. :setting:`NUMBER_GROUPING`.
  961. .. setting:: IGNORABLE_404_URLS
  962. IGNORABLE_404_URLS
  963. ------------------
  964. Default: ``[]`` (Empty list)
  965. List of compiled regular expression objects describing URLs that should be
  966. ignored when reporting HTTP 404 errors via email (see
  967. :doc:`/howto/error-reporting`). Regular expressions are matched against
  968. :meth:`request's full paths <django.http.HttpRequest.get_full_path>` (including
  969. query string, if any). Use this if your site does not provide a commonly
  970. requested file such as ``favicon.ico`` or ``robots.txt``, or if it gets
  971. hammered by script kiddies.
  972. This is only used if
  973. :class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled (see
  974. :doc:`/topics/http/middleware`).
  975. .. setting:: INSTALLED_APPS
  976. INSTALLED_APPS
  977. --------------
  978. Default: ``[]`` (Empty list)
  979. A list of strings designating all applications that are enabled in this
  980. Django installation. Each string should be a dotted Python path to:
  981. * an application configuration class, or
  982. * a package containing an application.
  983. :doc:`Learn more about application configurations </ref/applications>`.
  984. .. admonition:: Use the application registry for introspection
  985. Your code should never access :setting:`INSTALLED_APPS` directly. Use
  986. :attr:`django.apps.apps` instead.
  987. .. admonition:: Application names and labels must be unique in
  988. :setting:`INSTALLED_APPS`
  989. Application :attr:`names <django.apps.AppConfig.name>` — the dotted Python
  990. path to the application package — must be unique. There is no way to
  991. include the same application twice, short of duplicating its code under
  992. another name.
  993. Application :attr:`labels <django.apps.AppConfig.label>` — by default the
  994. final part of the name — must be unique too. For example, you can't
  995. include both ``django.contrib.auth`` and ``myproject.auth``. However, you
  996. can relabel an application with a custom configuration that defines a
  997. different :attr:`~django.apps.AppConfig.label`.
  998. These rules apply regardless of whether :setting:`INSTALLED_APPS`
  999. references application configuration classes or application packages.
  1000. When several applications provide different versions of the same resource
  1001. (template, static file, management command, translation), the application
  1002. listed first in :setting:`INSTALLED_APPS` has precedence.
  1003. .. setting:: INTERNAL_IPS
  1004. INTERNAL_IPS
  1005. ------------
  1006. Default: ``[]`` (Empty list)
  1007. A list of IP addresses, as strings, that:
  1008. * See debug comments, when :setting:`DEBUG` is ``True``
  1009. * Receive X headers in admindocs if the ``XViewMiddleware`` is installed (see
  1010. :doc:`/ref/contrib/admin/admindocs`)
  1011. .. setting:: LANGUAGE_CODE
  1012. LANGUAGE_CODE
  1013. -------------
  1014. Default: ``'en-us'``
  1015. A string representing the language code for this installation. This should be in
  1016. standard :term:`language ID format <language code>`. For example, U.S. English
  1017. is ``"en-us"``. See also the `list of language identifiers`_ and
  1018. :doc:`/topics/i18n/index`.
  1019. :setting:`USE_I18N` must be active for this setting to have any effect.
  1020. It serves two purposes:
  1021. * If the locale middleware isn't in use, it decides which translation is served
  1022. to all users.
  1023. * If the locale middleware is active, it provides a fallback language in case the
  1024. user's preferred language can't be determined or is not supported by the Web
  1025. site. It also provides the fallback translation when a translation for a
  1026. given literal doesn't exist for the user's preferred language.
  1027. .. versionchanged:: 1.8
  1028. The fallback for translation literals was added.
  1029. See :ref:`how-django-discovers-language-preference` for more details.
  1030. .. _list of language identifiers: http://www.i18nguy.com/unicode/language-identifiers.html
  1031. .. setting:: LANGUAGE_COOKIE_AGE
  1032. LANGUAGE_COOKIE_AGE
  1033. -------------------
  1034. Default: ``None`` (expires at browser close)
  1035. The age of the language cookie, in seconds.
  1036. .. setting:: LANGUAGE_COOKIE_DOMAIN
  1037. LANGUAGE_COOKIE_DOMAIN
  1038. ----------------------
  1039. Default: ``None``
  1040. The domain to use for the language cookie. Set this to a string such as
  1041. ``".example.com"`` (note the leading dot!) for cross-domain cookies, or use
  1042. ``None`` for a standard domain cookie.
  1043. Be cautious when updating this setting on a production site. If you update
  1044. this setting to enable cross-domain cookies on a site that previously used
  1045. standard domain cookies, existing user cookies that have the old domain
  1046. will not be updated. This will result in site users being unable to switch
  1047. the language as long as these cookies persist. The only safe and reliable
  1048. option to perform the switch is to change the language cookie name
  1049. permanently (via the :setting:`LANGUAGE_COOKIE_NAME` setting) and to add
  1050. a middleware that copies the value from the old cookie to a new one and then
  1051. deletes the old one.
  1052. .. setting:: LANGUAGE_COOKIE_NAME
  1053. LANGUAGE_COOKIE_NAME
  1054. --------------------
  1055. Default: ``'django_language'``
  1056. The name of the cookie to use for the language cookie. This can be whatever
  1057. you want (but should be different from :setting:`SESSION_COOKIE_NAME`). See
  1058. :doc:`/topics/i18n/index`.
  1059. .. setting:: LANGUAGE_COOKIE_PATH
  1060. LANGUAGE_COOKIE_PATH
  1061. --------------------
  1062. Default: ``/``
  1063. The path set on the language cookie. This should either match the URL path of your
  1064. Django installation or be a parent of that path.
  1065. This is useful if you have multiple Django instances running under the same
  1066. hostname. They can use different cookie paths and each instance will only see
  1067. its own language cookie.
  1068. Be cautious when updating this setting on a production site. If you update this
  1069. setting to use a deeper path than it previously used, existing user cookies that
  1070. have the old path will not be updated. This will result in site users being
  1071. unable to switch the language as long as these cookies persist. The only safe
  1072. and reliable option to perform the switch is to change the language cookie name
  1073. permanently (via the :setting:`LANGUAGE_COOKIE_NAME` setting), and to add
  1074. a middleware that copies the value from the old cookie to a new one and then
  1075. deletes the one.
  1076. .. setting:: LANGUAGES
  1077. LANGUAGES
  1078. ---------
  1079. Default: A list of all available languages. This list is continually growing
  1080. and including a copy here would inevitably become rapidly out of date. You can
  1081. see the current list of translated languages by looking in
  1082. ``django/conf/global_settings.py`` (or view the `online source`_).
  1083. .. _online source: https://github.com/django/django/blob/master/django/conf/global_settings.py
  1084. The list is a list of two-tuples in the format
  1085. (:term:`language code<language code>`, ``language name``) -- for example,
  1086. ``('ja', 'Japanese')``.
  1087. This specifies which languages are available for language selection. See
  1088. :doc:`/topics/i18n/index`.
  1089. Generally, the default value should suffice. Only set this setting if you want
  1090. to restrict language selection to a subset of the Django-provided languages.
  1091. If you define a custom :setting:`LANGUAGES` setting, you can mark the
  1092. language names as translation strings using the
  1093. :func:`~django.utils.translation.ugettext_lazy` function.
  1094. Here's a sample settings file::
  1095. from django.utils.translation import ugettext_lazy as _
  1096. LANGUAGES = [
  1097. ('de', _('German')),
  1098. ('en', _('English')),
  1099. ]
  1100. .. setting:: LOCALE_PATHS
  1101. LOCALE_PATHS
  1102. ------------
  1103. Default: ``[]`` (Empty list)
  1104. A list of directories where Django looks for translation files.
  1105. See :ref:`how-django-discovers-translations`.
  1106. Example::
  1107. LOCALE_PATHS = [
  1108. '/home/www/project/common_files/locale',
  1109. '/var/local/translations/locale',
  1110. ]
  1111. Django will look within each of these paths for the ``<locale_code>/LC_MESSAGES``
  1112. directories containing the actual translation files.
  1113. .. setting:: LOGGING
  1114. LOGGING
  1115. -------
  1116. Default: A logging configuration dictionary.
  1117. A data structure containing configuration information. The contents of
  1118. this data structure will be passed as the argument to the
  1119. configuration method described in :setting:`LOGGING_CONFIG`.
  1120. Among other things, the default logging configuration passes HTTP 500 server
  1121. errors to an email log handler when :setting:`DEBUG` is ``False``. See also
  1122. :ref:`configuring-logging`.
  1123. You can see the default logging configuration by looking in
  1124. ``django/utils/log.py`` (or view the `online source`__).
  1125. __ https://github.com/django/django/blob/master/django/utils/log.py
  1126. .. setting:: LOGGING_CONFIG
  1127. LOGGING_CONFIG
  1128. --------------
  1129. Default: ``'logging.config.dictConfig'``
  1130. A path to a callable that will be used to configure logging in the
  1131. Django project. Points at a instance of Python's `dictConfig`_
  1132. configuration method by default.
  1133. If you set :setting:`LOGGING_CONFIG` to ``None``, the logging
  1134. configuration process will be skipped.
  1135. .. _dictConfig: https://docs.python.org/library/logging.config.html#configuration-dictionary-schema
  1136. .. setting:: MANAGERS
  1137. MANAGERS
  1138. --------
  1139. Default: ``[]`` (Empty list)
  1140. A list in the same format as :setting:`ADMINS` that specifies who should get
  1141. broken link notifications when
  1142. :class:`~django.middleware.common.BrokenLinkEmailsMiddleware` is enabled.
  1143. .. setting:: MEDIA_ROOT
  1144. MEDIA_ROOT
  1145. ----------
  1146. Default: ``''`` (Empty string)
  1147. Absolute filesystem path to the directory that will hold :doc:`user-uploaded
  1148. files </topics/files>`.
  1149. Example: ``"/var/www/example.com/media/"``
  1150. See also :setting:`MEDIA_URL`.
  1151. .. warning::
  1152. :setting:`MEDIA_ROOT` and :setting:`STATIC_ROOT` must have different
  1153. values. Before :setting:`STATIC_ROOT` was introduced, it was common to
  1154. rely or fallback on :setting:`MEDIA_ROOT` to also serve static files;
  1155. however, since this can have serious security implications, there is a
  1156. validation check to prevent it.
  1157. .. setting:: MEDIA_URL
  1158. MEDIA_URL
  1159. ---------
  1160. Default: ``''`` (Empty string)
  1161. URL that handles the media served from :setting:`MEDIA_ROOT`, used
  1162. for :doc:`managing stored files </topics/files>`. It must end in a slash if set
  1163. to a non-empty value. You will need to :ref:`configure these files to be served
  1164. <serving-uploaded-files-in-development>` in both development and production
  1165. environments.
  1166. If you want to use ``{{ MEDIA_URL }}`` in your templates, add
  1167. ``'django.template.context_processors.media'`` in the ``'context_processors'``
  1168. option of :setting:`TEMPLATES`.
  1169. Example: ``"http://media.example.com/"``
  1170. .. warning::
  1171. There are security risks if you are accepting uploaded content from
  1172. untrusted users! See the security guide's topic on
  1173. :ref:`user-uploaded-content-security` for mitigation details.
  1174. .. warning::
  1175. :setting:`MEDIA_URL` and :setting:`STATIC_URL` must have different
  1176. values. See :setting:`MEDIA_ROOT` for more details.
  1177. .. setting:: MIDDLEWARE_CLASSES
  1178. MIDDLEWARE_CLASSES
  1179. ------------------
  1180. Default::
  1181. ['django.middleware.common.CommonMiddleware',
  1182. 'django.middleware.csrf.CsrfViewMiddleware']
  1183. A list of middleware classes to use. See :doc:`/topics/http/middleware`.
  1184. .. setting:: MIGRATION_MODULES
  1185. MIGRATION_MODULES
  1186. -----------------
  1187. Default::
  1188. {} # empty dictionary
  1189. A dictionary specifying the package where migration modules can be found on a per-app basis. The default value
  1190. of this setting is an empty dictionary, but the default package name for migration modules is ``migrations``.
  1191. Example::
  1192. {'blog': 'blog.db_migrations'}
  1193. In this case, migrations pertaining to the ``blog`` app will be contained in the ``blog.db_migrations`` package.
  1194. If you provide the ``app_label`` argument, :djadmin:`makemigrations` will
  1195. automatically create the package if it doesn't already exist.
  1196. .. setting:: MONTH_DAY_FORMAT
  1197. MONTH_DAY_FORMAT
  1198. ----------------
  1199. Default: ``'F j'``
  1200. The default formatting to use for date fields on Django admin change-list
  1201. pages -- and, possibly, by other parts of the system -- in cases when only the
  1202. month and day are displayed.
  1203. For example, when a Django admin change-list page is being filtered by a date
  1204. drilldown, the header for a given day displays the day and month. Different
  1205. locales have different formats. For example, U.S. English would say
  1206. "January 1," whereas Spanish might say "1 Enero."
  1207. Note that if :setting:`USE_L10N` is set to ``True``, then the corresponding
  1208. locale-dictated format has higher precedence and will be applied.
  1209. See :tfilter:`allowed date format strings <date>`. See also
  1210. :setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`,
  1211. :setting:`TIME_FORMAT` and :setting:`YEAR_MONTH_FORMAT`.
  1212. .. setting:: NUMBER_GROUPING
  1213. NUMBER_GROUPING
  1214. ----------------
  1215. Default: ``0``
  1216. Number of digits grouped together on the integer part of a number.
  1217. Common use is to display a thousand separator. If this setting is ``0``, then
  1218. no grouping will be applied to the number. If this setting is greater than
  1219. ``0``, then :setting:`THOUSAND_SEPARATOR` will be used as the separator between
  1220. those groups.
  1221. Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
  1222. format has higher precedence and will be applied instead.
  1223. See also :setting:`DECIMAL_SEPARATOR`, :setting:`THOUSAND_SEPARATOR` and
  1224. :setting:`USE_THOUSAND_SEPARATOR`.
  1225. .. setting:: PREPEND_WWW
  1226. PREPEND_WWW
  1227. -----------
  1228. Default: ``False``
  1229. Whether to prepend the "www." subdomain to URLs that don't have it. This is only
  1230. used if :class:`~django.middleware.common.CommonMiddleware` is installed
  1231. (see :doc:`/topics/http/middleware`). See also :setting:`APPEND_SLASH`.
  1232. .. setting:: ROOT_URLCONF
  1233. ROOT_URLCONF
  1234. ------------
  1235. Default: Not defined
  1236. A string representing the full Python import path to your root URLconf. For example:
  1237. ``"mydjangoapps.urls"``. Can be overridden on a per-request basis by
  1238. setting the attribute ``urlconf`` on the incoming ``HttpRequest``
  1239. object. See :ref:`how-django-processes-a-request` for details.
  1240. .. setting:: SECRET_KEY
  1241. SECRET_KEY
  1242. ----------
  1243. Default: ``''`` (Empty string)
  1244. A secret key for a particular Django installation. This is used to provide
  1245. :doc:`cryptographic signing </topics/signing>`, and should be set to a unique,
  1246. unpredictable value.
  1247. :djadmin:`django-admin startproject <startproject>` automatically adds a
  1248. randomly-generated ``SECRET_KEY`` to each new project.
  1249. Django will refuse to start if :setting:`SECRET_KEY` is not set.
  1250. .. warning::
  1251. **Keep this value secret.**
  1252. Running Django with a known :setting:`SECRET_KEY` defeats many of Django's
  1253. security protections, and can lead to privilege escalation and remote code
  1254. execution vulnerabilities.
  1255. The secret key is used for:
  1256. * All :doc:`sessions </topics/http/sessions>` if you are using
  1257. any other session backend than ``django.contrib.sessions.backends.cache``,
  1258. or if you use
  1259. :class:`~django.contrib.auth.middleware.SessionAuthenticationMiddleware`
  1260. and are using the default
  1261. :meth:`~django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash()`.
  1262. * All :doc:`messages </ref/contrib/messages>` if you are using
  1263. :class:`~django.contrib.messages.storage.cookie.CookieStorage` or
  1264. :class:`~django.contrib.messages.storage.fallback.FallbackStorage`.
  1265. * All :func:`~django.contrib.auth.views.password_reset` tokens.
  1266. * Any usage of :doc:`cryptographic signing </topics/signing>`, unless a
  1267. different key is provided.
  1268. If you rotate your secret key, all of the above will be invalidated.
  1269. Secret keys are not used for passwords of users and key rotation will not
  1270. affect them.
  1271. .. note::
  1272. The default :file:`settings.py` file created by :djadmin:`django-admin
  1273. startproject <startproject>` creates a unique ``SECRET_KEY`` for
  1274. convenience.
  1275. .. setting:: SECURE_BROWSER_XSS_FILTER
  1276. SECURE_BROWSER_XSS_FILTER
  1277. -------------------------
  1278. .. versionadded:: 1.8
  1279. Default: ``False``
  1280. If ``True``, the :class:`~django.middleware.security.SecurityMiddleware` sets
  1281. the :ref:`x-xss-protection` header on all responses that do not already have it.
  1282. .. setting:: SECURE_CONTENT_TYPE_NOSNIFF
  1283. SECURE_CONTENT_TYPE_NOSNIFF
  1284. ---------------------------
  1285. .. versionadded:: 1.8
  1286. Default: ``False``
  1287. If ``True``, the :class:`~django.middleware.security.SecurityMiddleware`
  1288. sets the :ref:`x-content-type-options` header on all responses that do not
  1289. already have it.
  1290. .. setting:: SECURE_HSTS_INCLUDE_SUBDOMAINS
  1291. SECURE_HSTS_INCLUDE_SUBDOMAINS
  1292. ------------------------------
  1293. .. versionadded:: 1.8
  1294. Default: ``False``
  1295. If ``True``, the :class:`~django.middleware.security.SecurityMiddleware` adds
  1296. the ``includeSubDomains`` tag to the :ref:`http-strict-transport-security`
  1297. header. It has no effect unless :setting:`SECURE_HSTS_SECONDS` is set to a
  1298. non-zero value.
  1299. .. warning::
  1300. Setting this incorrectly can irreversibly (for the value of
  1301. :setting:`SECURE_HSTS_SECONDS`) break your site. Read the
  1302. :ref:`http-strict-transport-security` documentation first.
  1303. .. setting:: SECURE_HSTS_SECONDS
  1304. SECURE_HSTS_SECONDS
  1305. -------------------
  1306. .. versionadded:: 1.8
  1307. Default: ``0``
  1308. If set to a non-zero integer value, the
  1309. :class:`~django.middleware.security.SecurityMiddleware` sets the
  1310. :ref:`http-strict-transport-security` header on all responses that do not
  1311. already have it.
  1312. .. warning::
  1313. Setting this incorrectly can irreversibly (for some time) break your site.
  1314. Read the :ref:`http-strict-transport-security` documentation first.
  1315. .. setting:: SECURE_PROXY_SSL_HEADER
  1316. SECURE_PROXY_SSL_HEADER
  1317. -----------------------
  1318. Default: ``None``
  1319. A tuple representing a HTTP header/value combination that signifies a request
  1320. is secure. This controls the behavior of the request object's ``is_secure()``
  1321. method.
  1322. This takes some explanation. By default, ``is_secure()`` is able to determine
  1323. whether a request is secure by looking at whether the requested URL uses
  1324. "https://". This is important for Django's CSRF protection, and may be used
  1325. by your own code or third-party apps.
  1326. If your Django app is behind a proxy, though, the proxy may be "swallowing" the
  1327. fact that a request is HTTPS, using a non-HTTPS connection between the proxy
  1328. and Django. In this case, ``is_secure()`` would always return ``False`` -- even
  1329. for requests that were made via HTTPS by the end user.
  1330. In this situation, you'll want to configure your proxy to set a custom HTTP
  1331. header that tells Django whether the request came in via HTTPS, and you'll want
  1332. to set ``SECURE_PROXY_SSL_HEADER`` so that Django knows what header to look
  1333. for.
  1334. You'll need to set a tuple with two elements -- the name of the header to look
  1335. for and the required value. For example::
  1336. SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
  1337. Here, we're telling Django that we trust the ``X-Forwarded-Proto`` header
  1338. that comes from our proxy, and any time its value is ``'https'``, then the
  1339. request is guaranteed to be secure (i.e., it originally came in via HTTPS).
  1340. Obviously, you should *only* set this setting if you control your proxy or
  1341. have some other guarantee that it sets/strips this header appropriately.
  1342. Note that the header needs to be in the format as used by ``request.META`` --
  1343. all caps and likely starting with ``HTTP_``. (Remember, Django automatically
  1344. adds ``'HTTP_'`` to the start of x-header names before making the header
  1345. available in ``request.META``.)
  1346. .. warning::
  1347. **You will probably open security holes in your site if you set this
  1348. without knowing what you're doing. And if you fail to set it when you
  1349. should. Seriously.**
  1350. Make sure ALL of the following are true before setting this (assuming the
  1351. values from the example above):
  1352. * Your Django app is behind a proxy.
  1353. * Your proxy strips the ``X-Forwarded-Proto`` header from all incoming
  1354. requests. In other words, if end users include that header in their
  1355. requests, the proxy will discard it.
  1356. * Your proxy sets the ``X-Forwarded-Proto`` header and sends it to Django,
  1357. but only for requests that originally come in via HTTPS.
  1358. If any of those are not true, you should keep this setting set to ``None``
  1359. and find another way of determining HTTPS, perhaps via custom middleware.
  1360. .. setting:: SECURE_REDIRECT_EXEMPT
  1361. SECURE_REDIRECT_EXEMPT
  1362. ----------------------
  1363. .. versionadded:: 1.8
  1364. Default: ``[]`` (Empty list)
  1365. If a URL path matches a regular expression in this list, the request will not be
  1366. redirected to HTTPS. If :setting:`SECURE_SSL_REDIRECT` is ``False``, this
  1367. setting has no effect.
  1368. .. setting:: SECURE_SSL_HOST
  1369. SECURE_SSL_HOST
  1370. ---------------
  1371. .. versionadded:: 1.8
  1372. Default: ``None``
  1373. If a string (e.g. ``secure.example.com``), all SSL redirects will be directed
  1374. to this host rather than the originally-requested host
  1375. (e.g. ``www.example.com``). If :setting:`SECURE_SSL_REDIRECT` is ``False``, this
  1376. setting has no effect.
  1377. .. setting:: SECURE_SSL_REDIRECT
  1378. SECURE_SSL_REDIRECT
  1379. -------------------
  1380. .. versionadded:: 1.8
  1381. Default: ``False``.
  1382. If ``True``, the :class:`~django.middleware.security.SecurityMiddleware`
  1383. :ref:`redirects <ssl-redirect>` all non-HTTPS requests to HTTPS (except for
  1384. those URLs matching a regular expression listed in
  1385. :setting:`SECURE_REDIRECT_EXEMPT`).
  1386. .. note::
  1387. If turning this to ``True`` causes infinite redirects, it probably means
  1388. your site is running behind a proxy and can't tell which requests are secure
  1389. and which are not. Your proxy likely sets a header to indicate secure
  1390. requests; you can correct the problem by finding out what that header is and
  1391. configuring the :setting:`SECURE_PROXY_SSL_HEADER` setting accordingly.
  1392. .. setting:: SERIALIZATION_MODULES
  1393. SERIALIZATION_MODULES
  1394. ---------------------
  1395. Default: Not defined.
  1396. A dictionary of modules containing serializer definitions (provided as
  1397. strings), keyed by a string identifier for that serialization type. For
  1398. example, to define a YAML serializer, use::
  1399. SERIALIZATION_MODULES = {'yaml': 'path.to.yaml_serializer'}
  1400. .. setting:: SERVER_EMAIL
  1401. SERVER_EMAIL
  1402. ------------
  1403. Default: ``'root@localhost'``
  1404. The email address that error messages come from, such as those sent to
  1405. :setting:`ADMINS` and :setting:`MANAGERS`.
  1406. .. admonition:: Why are my emails sent from a different address?
  1407. This address is used only for error messages. It is *not* the address that
  1408. regular email messages sent with :meth:`~django.core.mail.send_mail()`
  1409. come from; for that, see :setting:`DEFAULT_FROM_EMAIL`.
  1410. .. setting:: SHORT_DATE_FORMAT
  1411. SHORT_DATE_FORMAT
  1412. -----------------
  1413. Default: ``m/d/Y`` (e.g. ``12/31/2003``)
  1414. An available formatting that can be used for displaying date fields on
  1415. templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
  1416. corresponding locale-dictated format has higher precedence and will be applied.
  1417. See :tfilter:`allowed date format strings <date>`.
  1418. See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATETIME_FORMAT`.
  1419. .. setting:: SHORT_DATETIME_FORMAT
  1420. SHORT_DATETIME_FORMAT
  1421. ---------------------
  1422. Default: ``m/d/Y P`` (e.g. ``12/31/2003 4 p.m.``)
  1423. An available formatting that can be used for displaying datetime fields on
  1424. templates. Note that if :setting:`USE_L10N` is set to ``True``, then the
  1425. corresponding locale-dictated format has higher precedence and will be applied.
  1426. See :tfilter:`allowed date format strings <date>`.
  1427. See also :setting:`DATE_FORMAT` and :setting:`SHORT_DATE_FORMAT`.
  1428. .. setting:: SIGNING_BACKEND
  1429. SIGNING_BACKEND
  1430. ---------------
  1431. Default: ``'django.core.signing.TimestampSigner'``
  1432. The backend used for signing cookies and other data.
  1433. See also the :doc:`/topics/signing` documentation.
  1434. .. setting:: SILENCED_SYSTEM_CHECKS
  1435. SILENCED_SYSTEM_CHECKS
  1436. ----------------------
  1437. Default: ``[]`` (Empty list)
  1438. A list of identifiers of messages generated by the system check framework
  1439. (i.e. ``["models.W001"]``) that you wish to permanently acknowledge and ignore.
  1440. Silenced warnings will no longer be output to the console; silenced errors
  1441. will still be printed, but will not prevent management commands from running.
  1442. See also the :doc:`/ref/checks` documentation.
  1443. .. setting:: TEMPLATES
  1444. TEMPLATES
  1445. ---------
  1446. .. versionadded:: 1.8
  1447. Default: ``[]`` (Empty list)
  1448. A list containing the settings for all template engines to be used with
  1449. Django. Each item of the list is a dictionary containing the options for an
  1450. individual engine.
  1451. Here's a simple setup that tells the Django template engine to load templates
  1452. from the ``templates`` subdirectory inside each installed application::
  1453. TEMPLATES = [
  1454. {
  1455. 'BACKEND': 'django.template.backends.django.DjangoTemplates',
  1456. 'APP_DIRS': True,
  1457. },
  1458. ]
  1459. The following options are available for all backends.
  1460. .. setting:: TEMPLATES-BACKEND
  1461. BACKEND
  1462. ~~~~~~~
  1463. Default: not defined
  1464. The template backend to use. The built-in template backends are:
  1465. * ``'django.template.backends.django.DjangoTemplates'``
  1466. * ``'django.template.backends.jinja2.Jinja2'``
  1467. You can use a template backend that doesn't ship with Django by setting
  1468. ``BACKEND`` to a fully-qualified path (i.e. ``'mypackage.whatever.Backend'``).
  1469. .. setting:: TEMPLATES-NAME
  1470. NAME
  1471. ~~~~
  1472. Default: see below
  1473. The alias for this particular template engine. It's an identifier that allows
  1474. selecting an engine for rendering. Aliases must be unique across all
  1475. configured template engines.
  1476. It defaults to the name of the module defining the engine class, i.e. the
  1477. next to last piece of :setting:`BACKEND <TEMPLATES-BACKEND>`, when it isn't
  1478. provided. For example if the backend is ``'mypackage.whatever.Backend'`` then
  1479. its default name is ``'whatever'``.
  1480. .. setting:: TEMPLATES-DIRS
  1481. DIRS
  1482. ~~~~
  1483. Default: ``[]`` (Empty list)
  1484. Directories where the engine should look for template source files, in search
  1485. order.
  1486. .. setting:: TEMPLATES-APP_DIRS
  1487. APP_DIRS
  1488. ~~~~~~~~
  1489. Default: ``False``
  1490. Whether the engine should look for template source files inside installed
  1491. applications.
  1492. .. note::
  1493. The default :file:`settings.py` file created by :djadmin:`django-admin
  1494. startproject <startproject>` sets ``'APP_DIRS': True``.
  1495. .. setting:: TEMPLATES-OPTIONS
  1496. OPTIONS
  1497. ~~~~~~~
  1498. Default: ``{}`` (Empty dict)
  1499. Extra parameters to pass to the template backend. Available parameters vary
  1500. depending on the template backend.
  1501. .. setting:: TEMPLATE_CONTEXT_PROCESSORS
  1502. TEMPLATE_CONTEXT_PROCESSORS
  1503. ---------------------------
  1504. Default::
  1505. ["django.contrib.auth.context_processors.auth",
  1506. "django.template.context_processors.debug",
  1507. "django.template.context_processors.i18n",
  1508. "django.template.context_processors.media",
  1509. "django.template.context_processors.static",
  1510. "django.template.context_processors.tz",
  1511. "django.contrib.messages.context_processors.messages"]
  1512. .. deprecated:: 1.8
  1513. Set the ``'context_processors'`` option in the :setting:`OPTIONS
  1514. <TEMPLATES-OPTIONS>` of a ``DjangoTemplates`` backend instead.
  1515. A list of callables that are used to populate the context in ``RequestContext``.
  1516. These callables take a request object as their argument and return a dictionary
  1517. of items to be merged into the context.
  1518. .. versionchanged:: 1.8
  1519. Built-in template context processors were moved from
  1520. ``django.core.context_processors`` to
  1521. ``django.template.context_processors`` in Django 1.8.
  1522. .. setting:: TEMPLATE_DEBUG
  1523. TEMPLATE_DEBUG
  1524. --------------
  1525. Default: ``False``
  1526. .. deprecated:: 1.8
  1527. Set the ``'debug'`` option in the :setting:`OPTIONS <TEMPLATES-OPTIONS>`
  1528. of a ``DjangoTemplates`` backend instead.
  1529. A boolean that turns on/off template debug mode. If this is ``True``, the fancy
  1530. error page will display a detailed report for any exception raised during
  1531. template rendering. This report contains the relevant snippet of the template,
  1532. with the appropriate line highlighted.
  1533. Note that Django only displays fancy error pages if :setting:`DEBUG` is ``True``, so
  1534. you'll want to set that to take advantage of this setting.
  1535. See also :setting:`DEBUG`.
  1536. .. setting:: TEMPLATE_DIRS
  1537. TEMPLATE_DIRS
  1538. -------------
  1539. Default: ``[]`` (Empty list)
  1540. .. deprecated:: 1.8
  1541. Set the :setting:`DIRS <TEMPLATES-DIRS>` option of a ``DjangoTemplates``
  1542. backend instead.
  1543. List of locations of the template source files searched by
  1544. :class:`django.template.loaders.filesystem.Loader`, in search order.
  1545. Note that these paths should use Unix-style forward slashes, even on Windows.
  1546. See :doc:`/ref/templates/language`.
  1547. .. setting:: TEMPLATE_LOADERS
  1548. TEMPLATE_LOADERS
  1549. ----------------
  1550. Default::
  1551. ['django.template.loaders.filesystem.Loader',
  1552. 'django.template.loaders.app_directories.Loader']
  1553. .. deprecated:: 1.8
  1554. Set the ``'loaders'`` option in the :setting:`OPTIONS <TEMPLATES-OPTIONS>`
  1555. of a ``DjangoTemplates`` backend instead.
  1556. A list of template loader classes, specified as strings. Each ``Loader`` class
  1557. knows how to import templates from a particular source. Optionally, a tuple can be
  1558. used instead of a string. The first item in the tuple should be the ``Loader``’s
  1559. module, subsequent items are passed to the ``Loader`` during initialization. See
  1560. :doc:`/ref/templates/api`.
  1561. .. setting:: TEMPLATE_STRING_IF_INVALID
  1562. TEMPLATE_STRING_IF_INVALID
  1563. --------------------------
  1564. Default: ``''`` (Empty string)
  1565. .. deprecated:: 1.8
  1566. Set the ``'string_if_invalid'`` option in the :setting:`OPTIONS
  1567. <TEMPLATES-OPTIONS>` of a ``DjangoTemplates`` backend instead.
  1568. Output, as a string, that the template system should use for invalid (e.g.
  1569. misspelled) variables. See :ref:`invalid-template-variables`.
  1570. .. setting:: TEST_RUNNER
  1571. TEST_RUNNER
  1572. -----------
  1573. Default: ``'django.test.runner.DiscoverRunner'``
  1574. The name of the class to use for starting the test suite. See
  1575. :ref:`other-testing-frameworks`.
  1576. .. setting:: TEST_NON_SERIALIZED_APPS
  1577. TEST_NON_SERIALIZED_APPS
  1578. ------------------------
  1579. Default: ``[]`` (Empty list)
  1580. In order to restore the database state between tests for
  1581. ``TransactionTestCase``\s and database backends without transactions, Django
  1582. will :ref:`serialize the contents of all apps <test-case-serialized-rollback>`
  1583. when it starts the test run so it can then reload from that copy before running
  1584. tests that need it.
  1585. This slows down the startup time of the test runner; if you have apps that
  1586. you know don't need this feature, you can add their full names in here (e.g.
  1587. ``'django.contrib.contenttypes'``) to exclude them from this serialization
  1588. process.
  1589. .. setting:: THOUSAND_SEPARATOR
  1590. THOUSAND_SEPARATOR
  1591. ------------------
  1592. Default: ``,`` (Comma)
  1593. Default thousand separator used when formatting numbers. This setting is
  1594. used only when :setting:`USE_THOUSAND_SEPARATOR` is ``True`` and
  1595. :setting:`NUMBER_GROUPING` is greater than ``0``.
  1596. Note that if :setting:`USE_L10N` is set to ``True``, then the locale-dictated
  1597. format has higher precedence and will be applied instead.
  1598. See also :setting:`NUMBER_GROUPING`, :setting:`DECIMAL_SEPARATOR` and
  1599. :setting:`USE_THOUSAND_SEPARATOR`.
  1600. .. setting:: TIME_FORMAT
  1601. TIME_FORMAT
  1602. -----------
  1603. Default: ``'P'`` (e.g. ``4 p.m.``)
  1604. The default formatting to use for displaying time fields in any part of the
  1605. system. Note that if :setting:`USE_L10N` is set to ``True``, then the
  1606. locale-dictated format has higher precedence and will be applied instead. See
  1607. :tfilter:`allowed date format strings <date>`.
  1608. See also :setting:`DATE_FORMAT` and :setting:`DATETIME_FORMAT`.
  1609. .. setting:: TIME_INPUT_FORMATS
  1610. TIME_INPUT_FORMATS
  1611. ------------------
  1612. Default::
  1613. [
  1614. '%H:%M:%S', # '14:30:59'
  1615. '%H:%M:%S.%f', # '14:30:59.000200'
  1616. '%H:%M', # '14:30'
  1617. ]
  1618. A list of formats that will be accepted when inputting data on a time field.
  1619. Formats will be tried in order, using the first valid one. Note that these
  1620. format strings use Python's datetime_ module syntax, not the format strings
  1621. from the ``date`` Django template tag.
  1622. When :setting:`USE_L10N` is ``True``, the locale-dictated format has higher
  1623. precedence and will be applied instead.
  1624. See also :setting:`DATE_INPUT_FORMATS` and :setting:`DATETIME_INPUT_FORMATS`.
  1625. .. _datetime: https://docs.python.org/library/datetime.html#strftime-strptime-behavior
  1626. .. setting:: TIME_ZONE
  1627. TIME_ZONE
  1628. ---------
  1629. Default: ``'America/Chicago'``
  1630. A string representing the time zone for this installation, or ``None``. See
  1631. the `list of time zones`_.
  1632. .. note::
  1633. Since Django was first released with the :setting:`TIME_ZONE` set to
  1634. ``'America/Chicago'``, the global setting (used if nothing is defined in
  1635. your project's ``settings.py``) remains ``'America/Chicago'`` for backwards
  1636. compatibility. New project templates default to ``'UTC'``.
  1637. Note that this isn't necessarily the time zone of the server. For example, one
  1638. server may serve multiple Django-powered sites, each with a separate time zone
  1639. setting.
  1640. When :setting:`USE_TZ` is ``False``, this is the time zone in which Django
  1641. will store all datetimes. When :setting:`USE_TZ` is ``True``, this is the
  1642. default time zone that Django will use to display datetimes in templates and
  1643. to interpret datetimes entered in forms.
  1644. Django sets the ``os.environ['TZ']`` variable to the time zone you specify in
  1645. the :setting:`TIME_ZONE` setting. Thus, all your views and models will
  1646. automatically operate in this time zone. However, Django won't set the ``TZ``
  1647. environment variable under the following conditions:
  1648. * If you're using the manual configuration option as described in
  1649. :ref:`manually configuring settings
  1650. <settings-without-django-settings-module>`, or
  1651. * If you specify ``TIME_ZONE = None``. This will cause Django to fall back to
  1652. using the system timezone. However, this is discouraged when :setting:`USE_TZ
  1653. = True <USE_TZ>`, because it makes conversions between local time and UTC
  1654. less reliable.
  1655. If Django doesn't set the ``TZ`` environment variable, it's up to you
  1656. to ensure your processes are running in the correct environment.
  1657. .. note::
  1658. Django cannot reliably use alternate time zones in a Windows environment.
  1659. If you're running Django on Windows, :setting:`TIME_ZONE` must be set to
  1660. match the system time zone.
  1661. .. _list of time zones: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
  1662. .. setting:: USE_ETAGS
  1663. USE_ETAGS
  1664. ---------
  1665. Default: ``False``
  1666. A boolean that specifies whether to output the "Etag" header. This saves
  1667. bandwidth but slows down performance. This is used by the ``CommonMiddleware``
  1668. (see :doc:`/topics/http/middleware`) and in the``Cache Framework``
  1669. (see :doc:`/topics/cache`).
  1670. .. setting:: USE_I18N
  1671. USE_I18N
  1672. --------
  1673. Default: ``True``
  1674. A boolean that specifies whether Django's translation system should be enabled.
  1675. This provides an easy way to turn it off, for performance. If this is set to
  1676. ``False``, Django will make some optimizations so as not to load the
  1677. translation machinery.
  1678. See also :setting:`LANGUAGE_CODE`, :setting:`USE_L10N` and :setting:`USE_TZ`.
  1679. .. note::
  1680. The default :file:`settings.py` file created by :djadmin:`django-admin
  1681. startproject <startproject>` includes ``USE_I18N = True`` for convenience.
  1682. .. setting:: USE_L10N
  1683. USE_L10N
  1684. --------
  1685. Default: ``False``
  1686. A boolean that specifies if localized formatting of data will be enabled by
  1687. default or not. If this is set to ``True``, e.g. Django will display numbers and
  1688. dates using the format of the current locale.
  1689. See also :setting:`LANGUAGE_CODE`, :setting:`USE_I18N` and :setting:`USE_TZ`.
  1690. .. note::
  1691. The default :file:`settings.py` file created by :djadmin:`django-admin
  1692. startproject <startproject>` includes ``USE_L10N = True`` for convenience.
  1693. .. setting:: USE_THOUSAND_SEPARATOR
  1694. USE_THOUSAND_SEPARATOR
  1695. ----------------------
  1696. Default: ``False``
  1697. A boolean that specifies whether to display numbers using a thousand separator.
  1698. When :setting:`USE_L10N` is set to ``True`` and if this is also set to
  1699. ``True``, Django will use the values of :setting:`THOUSAND_SEPARATOR` and
  1700. :setting:`NUMBER_GROUPING` to format numbers.
  1701. See also :setting:`DECIMAL_SEPARATOR`, :setting:`NUMBER_GROUPING` and
  1702. :setting:`THOUSAND_SEPARATOR`.
  1703. .. setting:: USE_TZ
  1704. USE_TZ
  1705. ------
  1706. Default: ``False``
  1707. A boolean that specifies if datetimes will be timezone-aware by default or not.
  1708. If this is set to ``True``, Django will use timezone-aware datetimes internally.
  1709. Otherwise, Django will use naive datetimes in local time.
  1710. See also :setting:`TIME_ZONE`, :setting:`USE_I18N` and :setting:`USE_L10N`.
  1711. .. note::
  1712. The default :file:`settings.py` file created by
  1713. :djadmin:`django-admin startproject <startproject>` includes
  1714. ``USE_TZ = True`` for convenience.
  1715. .. setting:: USE_X_FORWARDED_HOST
  1716. USE_X_FORWARDED_HOST
  1717. --------------------
  1718. Default: ``False``
  1719. A boolean that specifies whether to use the X-Forwarded-Host header in
  1720. preference to the Host header. This should only be enabled if a proxy
  1721. which sets this header is in use.
  1722. .. setting:: WSGI_APPLICATION
  1723. WSGI_APPLICATION
  1724. ----------------
  1725. Default: ``None``
  1726. The full Python path of the WSGI application object that Django's built-in
  1727. servers (e.g. :djadmin:`runserver`) will use. The :djadmin:`django-admin
  1728. startproject <startproject>` management command will create a simple
  1729. ``wsgi.py`` file with an ``application`` callable in it, and point this setting
  1730. to that ``application``.
  1731. If not set, the return value of ``django.core.wsgi.get_wsgi_application()``
  1732. will be used. In this case, the behavior of :djadmin:`runserver` will be
  1733. identical to previous Django versions.
  1734. .. setting:: YEAR_MONTH_FORMAT
  1735. YEAR_MONTH_FORMAT
  1736. -----------------
  1737. Default: ``'F Y'``
  1738. The default formatting to use for date fields on Django admin change-list
  1739. pages -- and, possibly, by other parts of the system -- in cases when only the
  1740. year and month are displayed.
  1741. For example, when a Django admin change-list page is being filtered by a date
  1742. drilldown, the header for a given month displays the month and the year.
  1743. Different locales have different formats. For example, U.S. English would say
  1744. "January 2006," whereas another locale might say "2006/January."
  1745. Note that if :setting:`USE_L10N` is set to ``True``, then the corresponding
  1746. locale-dictated format has higher precedence and will be applied.
  1747. See :tfilter:`allowed date format strings <date>`. See also
  1748. :setting:`DATE_FORMAT`, :setting:`DATETIME_FORMAT`, :setting:`TIME_FORMAT`
  1749. and :setting:`MONTH_DAY_FORMAT`.
  1750. .. setting:: X_FRAME_OPTIONS
  1751. X_FRAME_OPTIONS
  1752. ---------------
  1753. Default: ``'SAMEORIGIN'``
  1754. The default value for the X-Frame-Options header used by
  1755. :class:`~django.middleware.clickjacking.XFrameOptionsMiddleware`. See the
  1756. :doc:`clickjacking protection </ref/clickjacking/>` documentation.
  1757. Auth
  1758. ====
  1759. Settings for :mod:`django.contrib.auth`.
  1760. .. setting:: AUTHENTICATION_BACKENDS
  1761. AUTHENTICATION_BACKENDS
  1762. -----------------------
  1763. Default: ``['django.contrib.auth.backends.ModelBackend']``
  1764. A list of authentication backend classes (as strings) to use when attempting to
  1765. authenticate a user. See the :ref:`authentication backends documentation
  1766. <authentication-backends>` for details.
  1767. .. setting:: AUTH_USER_MODEL
  1768. AUTH_USER_MODEL
  1769. ---------------
  1770. Default: 'auth.User'
  1771. The model to use to represent a User. See :ref:`auth-custom-user`.
  1772. .. warning::
  1773. You cannot change the AUTH_USER_MODEL setting during the lifetime of
  1774. a project (i.e. once you have made and migrated models that depend on it)
  1775. without serious effort. It is intended to be set at the project start,
  1776. and the model it refers to must be available in the first migration of
  1777. the app that it lives in.
  1778. See :ref:`auth-custom-user` for more details.
  1779. .. setting:: LOGIN_REDIRECT_URL
  1780. LOGIN_REDIRECT_URL
  1781. ------------------
  1782. Default: ``'/accounts/profile/'``
  1783. The URL where requests are redirected after login when the
  1784. ``contrib.auth.login`` view gets no ``next`` parameter.
  1785. This is used by the :func:`~django.contrib.auth.decorators.login_required`
  1786. decorator, for example.
  1787. This setting also accepts view function names and :ref:`named URL patterns
  1788. <naming-url-patterns>` which can be used to reduce configuration duplication
  1789. since you don't have to define the URL in two places (``settings`` and URLconf).
  1790. .. setting:: LOGIN_URL
  1791. LOGIN_URL
  1792. ---------
  1793. Default: ``'/accounts/login/'``
  1794. The URL where requests are redirected for login, especially when using the
  1795. :func:`~django.contrib.auth.decorators.login_required` decorator.
  1796. This setting also accepts view function names and :ref:`named URL patterns
  1797. <naming-url-patterns>` which can be used to reduce configuration duplication
  1798. since you don't have to define the URL in two places (``settings`` and URLconf).
  1799. .. setting:: LOGOUT_URL
  1800. LOGOUT_URL
  1801. ----------
  1802. Default: ``'/accounts/logout/'``
  1803. LOGIN_URL counterpart.
  1804. .. setting:: PASSWORD_RESET_TIMEOUT_DAYS
  1805. PASSWORD_RESET_TIMEOUT_DAYS
  1806. ---------------------------
  1807. Default: ``3``
  1808. The number of days a password reset link is valid for. Used by the
  1809. :mod:`django.contrib.auth` password reset mechanism.
  1810. .. setting:: PASSWORD_HASHERS
  1811. PASSWORD_HASHERS
  1812. ----------------
  1813. See :ref:`auth_password_storage`.
  1814. Default::
  1815. ['django.contrib.auth.hashers.PBKDF2PasswordHasher',
  1816. 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
  1817. 'django.contrib.auth.hashers.BCryptPasswordHasher',
  1818. 'django.contrib.auth.hashers.SHA1PasswordHasher',
  1819. 'django.contrib.auth.hashers.MD5PasswordHasher',
  1820. 'django.contrib.auth.hashers.UnsaltedMD5PasswordHasher',
  1821. 'django.contrib.auth.hashers.CryptPasswordHasher']
  1822. .. setting:: AUTH_PASSWORD_VALIDATORS
  1823. AUTH_PASSWORD_VALIDATORS
  1824. ------------------------
  1825. .. versionadded:: 1.9
  1826. Default: ``[]`` (Empty list)
  1827. The list of validators that are used to check the strength of user's passwords.
  1828. See :ref:`password-validation` for more details. By default, no validation is
  1829. performed and all passwords are accepted.
  1830. .. _settings-messages:
  1831. Messages
  1832. ========
  1833. Settings for :mod:`django.contrib.messages`.
  1834. .. setting:: MESSAGE_LEVEL
  1835. MESSAGE_LEVEL
  1836. -------------
  1837. Default: ``messages.INFO``
  1838. Sets the minimum message level that will be recorded by the messages
  1839. framework. See :ref:`message levels <message-level>` for more details.
  1840. .. admonition:: Important
  1841. If you override ``MESSAGE_LEVEL`` in your settings file and rely on any of
  1842. the built-in constants, you must import the constants module directly to
  1843. avoid the potential for circular imports, e.g.::
  1844. from django.contrib.messages import constants as message_constants
  1845. MESSAGE_LEVEL = message_constants.DEBUG
  1846. If desired, you may specify the numeric values for the constants directly
  1847. according to the values in the above :ref:`constants table
  1848. <message-level-constants>`.
  1849. .. setting:: MESSAGE_STORAGE
  1850. MESSAGE_STORAGE
  1851. ---------------
  1852. Default: ``'django.contrib.messages.storage.fallback.FallbackStorage'``
  1853. Controls where Django stores message data. Valid values are:
  1854. * ``'django.contrib.messages.storage.fallback.FallbackStorage'``
  1855. * ``'django.contrib.messages.storage.session.SessionStorage'``
  1856. * ``'django.contrib.messages.storage.cookie.CookieStorage'``
  1857. See :ref:`message storage backends <message-storage-backends>` for more details.
  1858. The backends that use cookies --
  1859. :class:`~django.contrib.messages.storage.cookie.CookieStorage` and
  1860. :class:`~django.contrib.messages.storage.fallback.FallbackStorage` --
  1861. use the value of :setting:`SESSION_COOKIE_DOMAIN`, :setting:`SESSION_COOKIE_SECURE`
  1862. and :setting:`SESSION_COOKIE_HTTPONLY` when setting their cookies.
  1863. .. setting:: MESSAGE_TAGS
  1864. MESSAGE_TAGS
  1865. ------------
  1866. Default::
  1867. {messages.DEBUG: 'debug',
  1868. messages.INFO: 'info',
  1869. messages.SUCCESS: 'success',
  1870. messages.WARNING: 'warning',
  1871. messages.ERROR: 'error'}
  1872. This sets the mapping of message level to message tag, which is typically
  1873. rendered as a CSS class in HTML. If you specify a value, it will extend
  1874. the default. This means you only have to specify those values which you need
  1875. to override. See :ref:`message-displaying` above for more details.
  1876. .. admonition:: Important
  1877. If you override ``MESSAGE_TAGS`` in your settings file and rely on any of
  1878. the built-in constants, you must import the ``constants`` module directly to
  1879. avoid the potential for circular imports, e.g.::
  1880. from django.contrib.messages import constants as message_constants
  1881. MESSAGE_TAGS = {message_constants.INFO: ''}
  1882. If desired, you may specify the numeric values for the constants directly
  1883. according to the values in the above :ref:`constants table
  1884. <message-level-constants>`.
  1885. .. _settings-sessions:
  1886. Sessions
  1887. ========
  1888. Settings for :mod:`django.contrib.sessions`.
  1889. .. setting:: SESSION_CACHE_ALIAS
  1890. SESSION_CACHE_ALIAS
  1891. -------------------
  1892. Default: ``default``
  1893. If you're using :ref:`cache-based session storage <cached-sessions-backend>`,
  1894. this selects the cache to use.
  1895. .. setting:: SESSION_COOKIE_AGE
  1896. SESSION_COOKIE_AGE
  1897. ------------------
  1898. Default: ``1209600`` (2 weeks, in seconds)
  1899. The age of session cookies, in seconds.
  1900. .. setting:: SESSION_COOKIE_DOMAIN
  1901. SESSION_COOKIE_DOMAIN
  1902. ---------------------
  1903. Default: ``None``
  1904. The domain to use for session cookies. Set this to a string such as
  1905. ``".example.com"`` (note the leading dot!) for cross-domain cookies, or use
  1906. ``None`` for a standard domain cookie.
  1907. Be cautious when updating this setting on a production site. If you update
  1908. this setting to enable cross-domain cookies on a site that previously used
  1909. standard domain cookies, existing user cookies will be set to the old
  1910. domain. This may result in them being unable to log in as long as these cookies
  1911. persist.
  1912. This setting also affects cookies set by :mod:`django.contrib.messages`.
  1913. .. setting:: SESSION_COOKIE_HTTPONLY
  1914. SESSION_COOKIE_HTTPONLY
  1915. -----------------------
  1916. Default: ``True``
  1917. Whether to use ``HTTPOnly`` flag on the session cookie. If this is set to
  1918. ``True``, client-side JavaScript will not to be able to access the
  1919. session cookie.
  1920. HTTPOnly_ is a flag included in a Set-Cookie HTTP response header. It
  1921. is not part of the :rfc:`2109` standard for cookies, and it isn't honored
  1922. consistently by all browsers. However, when it is honored, it can be a
  1923. useful way to mitigate the risk of client side script accessing the
  1924. protected cookie data.
  1925. Turning it on makes it less trivial for an attacker to escalate a cross-site
  1926. scripting vulnerability into full hijacking of a user's session. There's not
  1927. much excuse for leaving this off, either: if your code depends on reading
  1928. session cookies from JavaScript, you're probably doing it wrong.
  1929. .. _HTTPOnly: https://www.owasp.org/index.php/HTTPOnly
  1930. .. setting:: SESSION_COOKIE_NAME
  1931. SESSION_COOKIE_NAME
  1932. -------------------
  1933. Default: ``'sessionid'``
  1934. The name of the cookie to use for sessions. This can be whatever you want (but
  1935. should be different from :setting:`LANGUAGE_COOKIE_NAME`).
  1936. .. setting:: SESSION_COOKIE_PATH
  1937. SESSION_COOKIE_PATH
  1938. -------------------
  1939. Default: ``'/'``
  1940. The path set on the session cookie. This should either match the URL path of your
  1941. Django installation or be parent of that path.
  1942. This is useful if you have multiple Django instances running under the same
  1943. hostname. They can use different cookie paths, and each instance will only see
  1944. its own session cookie.
  1945. .. setting:: SESSION_COOKIE_SECURE
  1946. SESSION_COOKIE_SECURE
  1947. ---------------------
  1948. Default: ``False``
  1949. Whether to use a secure cookie for the session cookie. If this is set to
  1950. ``True``, the cookie will be marked as "secure," which means browsers may
  1951. ensure that the cookie is only sent under an HTTPS connection.
  1952. Since it's trivial for a packet sniffer (e.g. `Firesheep`_) to hijack a user's
  1953. session if the session cookie is sent unencrypted, there's really no good
  1954. excuse to leave this off. It will prevent you from using sessions on insecure
  1955. requests and that's a good thing.
  1956. .. _Firesheep: http://codebutler.com/firesheep
  1957. .. setting:: SESSION_ENGINE
  1958. SESSION_ENGINE
  1959. --------------
  1960. Default: ``django.contrib.sessions.backends.db``
  1961. Controls where Django stores session data. Included engines are:
  1962. * ``'django.contrib.sessions.backends.db'``
  1963. * ``'django.contrib.sessions.backends.file'``
  1964. * ``'django.contrib.sessions.backends.cache'``
  1965. * ``'django.contrib.sessions.backends.cached_db'``
  1966. * ``'django.contrib.sessions.backends.signed_cookies'``
  1967. See :ref:`configuring-sessions` for more details.
  1968. .. setting:: SESSION_EXPIRE_AT_BROWSER_CLOSE
  1969. SESSION_EXPIRE_AT_BROWSER_CLOSE
  1970. -------------------------------
  1971. Default: ``False``
  1972. Whether to expire the session when the user closes their browser. See
  1973. :ref:`browser-length-vs-persistent-sessions`.
  1974. .. setting:: SESSION_FILE_PATH
  1975. SESSION_FILE_PATH
  1976. -----------------
  1977. Default: ``None``
  1978. If you're using file-based session storage, this sets the directory in
  1979. which Django will store session data. When the default value (``None``) is
  1980. used, Django will use the standard temporary directory for the system.
  1981. .. setting:: SESSION_SAVE_EVERY_REQUEST
  1982. SESSION_SAVE_EVERY_REQUEST
  1983. --------------------------
  1984. Default: ``False``
  1985. Whether to save the session data on every request. If this is ``False``
  1986. (default), then the session data will only be saved if it has been modified --
  1987. that is, if any of its dictionary values have been assigned or deleted.
  1988. .. setting:: SESSION_SERIALIZER
  1989. SESSION_SERIALIZER
  1990. ------------------
  1991. Default: ``'django.contrib.sessions.serializers.JSONSerializer'``
  1992. Full import path of a serializer class to use for serializing session data.
  1993. Included serializers are:
  1994. * ``'django.contrib.sessions.serializers.PickleSerializer'``
  1995. * ``'django.contrib.sessions.serializers.JSONSerializer'``
  1996. See :ref:`session_serialization` for details, including a warning regarding
  1997. possible remote code execution when using
  1998. :class:`~django.contrib.sessions.serializers.PickleSerializer`.
  1999. Sites
  2000. =====
  2001. Settings for :mod:`django.contrib.sites`.
  2002. .. setting:: SITE_ID
  2003. SITE_ID
  2004. -------
  2005. Default: Not defined
  2006. The ID, as an integer, of the current site in the ``django_site`` database
  2007. table. This is used so that application data can hook into specific sites
  2008. and a single database can manage content for multiple sites.
  2009. .. _settings-staticfiles:
  2010. Static Files
  2011. ============
  2012. Settings for :mod:`django.contrib.staticfiles`.
  2013. .. setting:: STATIC_ROOT
  2014. STATIC_ROOT
  2015. -----------
  2016. Default: ``None``
  2017. The absolute path to the directory where :djadmin:`collectstatic` will collect
  2018. static files for deployment.
  2019. Example: ``"/var/www/example.com/static/"``
  2020. If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled
  2021. (default) the :djadmin:`collectstatic` management command will collect static
  2022. files into this directory. See the howto on :doc:`managing static
  2023. files</howto/static-files/index>` for more details about usage.
  2024. .. warning::
  2025. This should be an initially empty destination directory for collecting
  2026. your static files from their permanent locations into one directory for
  2027. ease of deployment; it is **not** a place to store your static files
  2028. permanently. You should do that in directories that will be found by
  2029. :doc:`staticfiles</ref/contrib/staticfiles>`’s
  2030. :setting:`finders<STATICFILES_FINDERS>`, which by default, are
  2031. ``'static/'`` app sub-directories and any directories you include in
  2032. :setting:`STATICFILES_DIRS`).
  2033. .. setting:: STATIC_URL
  2034. STATIC_URL
  2035. ----------
  2036. Default: ``None``
  2037. URL to use when referring to static files located in :setting:`STATIC_ROOT`.
  2038. Example: ``"/static/"`` or ``"http://static.example.com/"``
  2039. If not ``None``, this will be used as the base path for
  2040. :ref:`asset definitions<form-asset-paths>` (the ``Media`` class) and the
  2041. :doc:`staticfiles app</ref/contrib/staticfiles>`.
  2042. It must end in a slash if set to a non-empty value.
  2043. You may need to :ref:`configure these files to be served in development
  2044. <serving-static-files-in-development>` and will definitely need to do so
  2045. :doc:`in production </howto/static-files/deployment>`.
  2046. .. setting:: STATICFILES_DIRS
  2047. STATICFILES_DIRS
  2048. ----------------
  2049. Default: ``[]`` (Empty list)
  2050. This setting defines the additional locations the staticfiles app will traverse
  2051. if the ``FileSystemFinder`` finder is enabled, e.g. if you use the
  2052. :djadmin:`collectstatic` or :djadmin:`findstatic` management command or use the
  2053. static file serving view.
  2054. This should be set to a list of strings that contain full paths to
  2055. your additional files directory(ies) e.g.::
  2056. STATICFILES_DIRS = [
  2057. "/home/special.polls.com/polls/static",
  2058. "/home/polls.com/polls/static",
  2059. "/opt/webfiles/common",
  2060. ]
  2061. Note that these paths should use Unix-style forward slashes, even on Windows
  2062. (e.g. ``"C:/Users/user/mysite/extra_static_content"``).
  2063. Prefixes (optional)
  2064. ~~~~~~~~~~~~~~~~~~~
  2065. In case you want to refer to files in one of the locations with an additional
  2066. namespace, you can **optionally** provide a prefix as ``(prefix, path)``
  2067. tuples, e.g.::
  2068. STATICFILES_DIRS = [
  2069. # ...
  2070. ("downloads", "/opt/webfiles/stats"),
  2071. ]
  2072. For example, assuming you have :setting:`STATIC_URL` set to ``'/static/'``, the
  2073. :djadmin:`collectstatic` management command would collect the "stats" files
  2074. in a ``'downloads'`` subdirectory of :setting:`STATIC_ROOT`.
  2075. This would allow you to refer to the local file
  2076. ``'/opt/webfiles/stats/polls_20101022.tar.gz'`` with
  2077. ``'/static/downloads/polls_20101022.tar.gz'`` in your templates, e.g.:
  2078. .. code-block:: html+django
  2079. <a href="{% static "downloads/polls_20101022.tar.gz" %}">
  2080. .. setting:: STATICFILES_STORAGE
  2081. STATICFILES_STORAGE
  2082. -------------------
  2083. Default: ``'django.contrib.staticfiles.storage.StaticFilesStorage'``
  2084. The file storage engine to use when collecting static files with the
  2085. :djadmin:`collectstatic` management command.
  2086. A ready-to-use instance of the storage backend defined in this setting
  2087. can be found at ``django.contrib.staticfiles.storage.staticfiles_storage``.
  2088. For an example, see :ref:`staticfiles-from-cdn`.
  2089. .. setting:: STATICFILES_FINDERS
  2090. STATICFILES_FINDERS
  2091. -------------------
  2092. Default::
  2093. ["django.contrib.staticfiles.finders.FileSystemFinder",
  2094. "django.contrib.staticfiles.finders.AppDirectoriesFinder"]
  2095. The list of finder backends that know how to find static files in
  2096. various locations.
  2097. The default will find files stored in the :setting:`STATICFILES_DIRS` setting
  2098. (using ``django.contrib.staticfiles.finders.FileSystemFinder``) and in a
  2099. ``static`` subdirectory of each app (using
  2100. ``django.contrib.staticfiles.finders.AppDirectoriesFinder``). If multiple
  2101. files with the same name are present, the first file that is found will be
  2102. used.
  2103. One finder is disabled by default:
  2104. ``django.contrib.staticfiles.finders.DefaultStorageFinder``. If added to
  2105. your :setting:`STATICFILES_FINDERS` setting, it will look for static files in
  2106. the default file storage as defined by the :setting:`DEFAULT_FILE_STORAGE`
  2107. setting.
  2108. .. note::
  2109. When using the ``AppDirectoriesFinder`` finder, make sure your apps
  2110. can be found by staticfiles. Simply add the app to the
  2111. :setting:`INSTALLED_APPS` setting of your site.
  2112. Static file finders are currently considered a private interface, and this
  2113. interface is thus undocumented.
  2114. Core Settings Topical Index
  2115. ===========================
  2116. Cache
  2117. -----
  2118. * :setting:`CACHES`
  2119. * :setting:`CACHE_MIDDLEWARE_ALIAS`
  2120. * :setting:`CACHE_MIDDLEWARE_KEY_PREFIX`
  2121. * :setting:`CACHE_MIDDLEWARE_SECONDS`
  2122. Database
  2123. --------
  2124. * :setting:`DATABASES`
  2125. * :setting:`DATABASE_ROUTERS`
  2126. * :setting:`DEFAULT_INDEX_TABLESPACE`
  2127. * :setting:`DEFAULT_TABLESPACE`
  2128. Debugging
  2129. ---------
  2130. * :setting:`DEBUG`
  2131. * :setting:`DEBUG_PROPAGATE_EXCEPTIONS`
  2132. Email
  2133. -----
  2134. * :setting:`ADMINS`
  2135. * :setting:`DEFAULT_CHARSET`
  2136. * :setting:`DEFAULT_FROM_EMAIL`
  2137. * :setting:`EMAIL_BACKEND`
  2138. * :setting:`EMAIL_FILE_PATH`
  2139. * :setting:`EMAIL_HOST`
  2140. * :setting:`EMAIL_HOST_PASSWORD`
  2141. * :setting:`EMAIL_HOST_USER`
  2142. * :setting:`EMAIL_PORT`
  2143. * :setting:`EMAIL_SSL_CERTFILE`
  2144. * :setting:`EMAIL_SSL_KEYFILE`
  2145. * :setting:`EMAIL_SUBJECT_PREFIX`
  2146. * :setting:`EMAIL_TIMEOUT`
  2147. * :setting:`EMAIL_USE_TLS`
  2148. * :setting:`MANAGERS`
  2149. * :setting:`SERVER_EMAIL`
  2150. Error reporting
  2151. ---------------
  2152. * :setting:`DEFAULT_EXCEPTION_REPORTER_FILTER`
  2153. * :setting:`IGNORABLE_404_URLS`
  2154. * :setting:`MANAGERS`
  2155. * :setting:`SILENCED_SYSTEM_CHECKS`
  2156. .. _file-upload-settings:
  2157. File uploads
  2158. ------------
  2159. * :setting:`DEFAULT_FILE_STORAGE`
  2160. * :setting:`FILE_CHARSET`
  2161. * :setting:`FILE_UPLOAD_HANDLERS`
  2162. * :setting:`FILE_UPLOAD_MAX_MEMORY_SIZE`
  2163. * :setting:`FILE_UPLOAD_PERMISSIONS`
  2164. * :setting:`FILE_UPLOAD_TEMP_DIR`
  2165. * :setting:`MEDIA_ROOT`
  2166. * :setting:`MEDIA_URL`
  2167. Globalization (i18n/l10n)
  2168. -------------------------
  2169. * :setting:`DATE_FORMAT`
  2170. * :setting:`DATE_INPUT_FORMATS`
  2171. * :setting:`DATETIME_FORMAT`
  2172. * :setting:`DATETIME_INPUT_FORMATS`
  2173. * :setting:`DECIMAL_SEPARATOR`
  2174. * :setting:`FIRST_DAY_OF_WEEK`
  2175. * :setting:`FORMAT_MODULE_PATH`
  2176. * :setting:`LANGUAGE_CODE`
  2177. * :setting:`LANGUAGE_COOKIE_AGE`
  2178. * :setting:`LANGUAGE_COOKIE_DOMAIN`
  2179. * :setting:`LANGUAGE_COOKIE_NAME`
  2180. * :setting:`LANGUAGE_COOKIE_PATH`
  2181. * :setting:`LANGUAGES`
  2182. * :setting:`LOCALE_PATHS`
  2183. * :setting:`MONTH_DAY_FORMAT`
  2184. * :setting:`NUMBER_GROUPING`
  2185. * :setting:`SHORT_DATE_FORMAT`
  2186. * :setting:`SHORT_DATETIME_FORMAT`
  2187. * :setting:`THOUSAND_SEPARATOR`
  2188. * :setting:`TIME_FORMAT`
  2189. * :setting:`TIME_INPUT_FORMATS`
  2190. * :setting:`TIME_ZONE`
  2191. * :setting:`USE_I18N`
  2192. * :setting:`USE_L10N`
  2193. * :setting:`USE_THOUSAND_SEPARATOR`
  2194. * :setting:`USE_TZ`
  2195. * :setting:`YEAR_MONTH_FORMAT`
  2196. HTTP
  2197. ----
  2198. * :setting:`DEFAULT_CHARSET`
  2199. * :setting:`DEFAULT_CONTENT_TYPE`
  2200. * :setting:`DISALLOWED_USER_AGENTS`
  2201. * :setting:`FORCE_SCRIPT_NAME`
  2202. * :setting:`INTERNAL_IPS`
  2203. * :setting:`MIDDLEWARE_CLASSES`
  2204. * Security
  2205. * :setting:`SECURE_BROWSER_XSS_FILTER`
  2206. * :setting:`SECURE_CONTENT_TYPE_NOSNIFF`
  2207. * :setting:`SECURE_HSTS_INCLUDE_SUBDOMAINS`
  2208. * :setting:`SECURE_HSTS_SECONDS`
  2209. * :setting:`SECURE_PROXY_SSL_HEADER`
  2210. * :setting:`SECURE_REDIRECT_EXEMPT`
  2211. * :setting:`SECURE_SSL_HOST`
  2212. * :setting:`SECURE_SSL_REDIRECT`
  2213. * :setting:`SIGNING_BACKEND`
  2214. * :setting:`USE_ETAGS`
  2215. * :setting:`USE_X_FORWARDED_HOST`
  2216. * :setting:`WSGI_APPLICATION`
  2217. Logging
  2218. -------
  2219. * :setting:`LOGGING`
  2220. * :setting:`LOGGING_CONFIG`
  2221. Models
  2222. ------
  2223. * :setting:`ABSOLUTE_URL_OVERRIDES`
  2224. * :setting:`FIXTURE_DIRS`
  2225. * :setting:`INSTALLED_APPS`
  2226. Security
  2227. --------
  2228. * Cross Site Request Forgery Protection
  2229. * :setting:`CSRF_COOKIE_DOMAIN`
  2230. * :setting:`CSRF_COOKIE_NAME`
  2231. * :setting:`CSRF_COOKIE_PATH`
  2232. * :setting:`CSRF_COOKIE_SECURE`
  2233. * :setting:`CSRF_FAILURE_VIEW`
  2234. * :setting:`CSRF_HEADER_NAME`
  2235. * :setting:`SECRET_KEY`
  2236. * :setting:`X_FRAME_OPTIONS`
  2237. Serialization
  2238. -------------
  2239. * :setting:`DEFAULT_CHARSET`
  2240. * :setting:`SERIALIZATION_MODULES`
  2241. Templates
  2242. ---------
  2243. * :setting:`ALLOWED_INCLUDE_ROOTS`
  2244. * :setting:`TEMPLATES`
  2245. * :setting:`TEMPLATE_CONTEXT_PROCESSORS`
  2246. * :setting:`TEMPLATE_DEBUG`
  2247. * :setting:`TEMPLATE_DIRS`
  2248. * :setting:`TEMPLATE_LOADERS`
  2249. * :setting:`TEMPLATE_STRING_IF_INVALID`
  2250. Testing
  2251. -------
  2252. * Database: :setting:`TEST <DATABASE-TEST>`
  2253. * :setting:`TEST_NON_SERIALIZED_APPS`
  2254. * :setting:`TEST_RUNNER`
  2255. URLs
  2256. ----
  2257. * :setting:`APPEND_SLASH`
  2258. * :setting:`PREPEND_WWW`
  2259. * :setting:`ROOT_URLCONF`