recordsansible/ara
Code Issues Proposed changes

Docs: SECRET_KEY is now randomly generated if it's not set

Browse Source 
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
This commit is contained in:
David Moreau Simard 2019-01-21 10:56:48 -05:00
parent 47dc0ad989
commit ca0137b437
No known key found for this signature in database
GPG Key ID: CBEB466764A9E621
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/configuring.rst
View File

@ -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
~~~~~~~~~~~~~~~