settings.txt 101 KB

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