settings.txt 100 KB

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