diff options
| author | Tim Graham <timograham@gmail.com> | 2016-12-28 07:36:37 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2016-12-28 07:37:21 -0500 |
| commit | 3e1be301e286b38a4f4f03c3030cae92b1153361 (patch) | |
| tree | 07aea50c528c3662b76615f0884806762c4a26aa /docs | |
| parent | f38f2032c577c484a0480f1d7aad39d495c63e33 (diff) | |
[1.10.x] Fixed #24994 -- Documented the expected type of settings.SECRET_KEY.
Backport of 9e734875fe7fb078aa4ef0e84578aa7e641f5563 from master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/settings.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index fc1f0a8883..cda859a4fa 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1988,6 +1988,10 @@ unpredictable value. :djadmin:`django-admin startproject <startproject>` automatically adds a randomly-generated ``SECRET_KEY`` to each new project. +Uses of the key shouldn't assume that it's text or bytes. Every use should go +through :func:`~django.utils.encoding.force_text` or +:func:`~django.utils.encoding.force_bytes` to convert it to the desired type. + Django will refuse to start if :setting:`SECRET_KEY` is not set. .. warning:: |