From ca0137b43789515b1ce835f5a38f576958a2b8d9 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 21 Jan 2019 10:56:48 -0500 Subject: [PATCH] Docs: SECRET_KEY is now randomly generated if it's not set Update docs to reflect that in https://review.openstack.org/#/c/631011/ we made SECRET_KEY optional to launching ara-server by randomizing a key if none are supplied by the configuration. Change-Id: I469663082ed6071db250c8152430ea1e8d61b500 --- doc/source/configuring.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/source/configuring.rst b/doc/source/configuring.rst index 03e45a9..c81d6cd 100644 --- a/doc/source/configuring.rst +++ b/doc/source/configuring.rst @@ -40,7 +40,7 @@ For more details, click on the configuration parameters. +--------------------------------+------------------------------------------------------+------------------------------------------+ | ARA_DEBUG_ | Django's DEBUG_ setting | ``false`` | +--------------------------------+------------------------------------------------------+------------------------------------------+ -| ARA_SECRET_KEY_ (**Required**) | Django's SECRET_KEY_ setting | ``None`` | +| ARA_SECRET_KEY_ | Django's SECRET_KEY_ setting | Randomized token, see ARA_SECRET_KEY_ | +--------------------------------+------------------------------------------------------+------------------------------------------+ | ARA_DATABASE_ENGINE_ | Django's ENGINE_ database setting | ``django.db.backends.sqlite3`` | +--------------------------------+------------------------------------------------------+------------------------------------------+ @@ -249,11 +249,14 @@ ARA_SECRET_KEY - **Configuration file variable**: ``SECRET_KEY`` - **Provided by**: Django's SECRET_KEY_ - **Type**: ``string`` -- **Default**: ``None`` (**Must be set**) +- **Default**: Randomized with ``django.utils.crypto.get_random_string()`` A secret key for a particular Django installation. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value. +If it is not set, a random token will be generated and persisted in the +default configuration file. + ARA_STATIC_ROOT ~~~~~~~~~~~~~~~