settings.txt 102 KB

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