diff options
| author | 0livd <0livd@users.noreply.github.com> | 2017-06-27 00:16:32 +0200 |
|---|---|---|
| committer | Alexis Metaireau <alexis@notmyidea.org> | 2017-06-27 00:16:32 +0200 |
| commit | a8360854489d060367cc17ef7933c867228a88e1 (patch) | |
| tree | a2b8973f131e2db12497fd937c63664dce73ed09 /docs | |
| parent | db296489568259a38bc614a1fcc4b504a2ffc983 (diff) | |
| download | ihatemoney-mirror-a8360854489d060367cc17ef7933c867228a88e1.zip ihatemoney-mirror-a8360854489d060367cc17ef7933c867228a88e1.tar.gz ihatemoney-mirror-a8360854489d060367cc17ef7933c867228a88e1.tar.bz2 | |
Use a hashed password for ADMIN_PASSWORD (#236)
* Use a hashed password for ADMIN_PASSWORD
A generate_password_hash manage.py command is provided
Fixes #233
* Print a console warning for users using a clear text ADMIN_PASSWORD
* Reword ADMIN_PASSWORD doc
* Update changelog
* Update CHANGELOG.rst
- say it out loud
- bump to 2.0 (that's the logic of semantic versioning while introducing breaking changes)
* Bump to 2.0 (breaking change)
* Update hashed password warning message
* Mention the generate password hash in the Changelog
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.rst | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 785ccc6..3cd143d 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -72,21 +72,23 @@ ihatemoney relies on a configuration file. If you run the application for the first time, you will need to take a few moments to configure the application properly. -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ -| Setting name | Default | What does it do? | -+============================+===========================+=============================================================================+ -| SQLALCHEMY_DATABASE_URI | ``sqlite:///budget.db`` | Specifies the type of backend to use and its location. More information | -| | | on the format used can be found on `the SQLAlchemy documentation`. | -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ -| SECRET_KEY | ``tralala`` | The secret key used to encrypt the cookies. **This needs to be changed**. | -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ -| MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email adress to use when sending | -| | "budget@notmyidea.org")`` | emails. | -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ -| ACTIVATE_DEMO_PROJECT | ``True`` | If set to `True`, a demo project will be available on the frontpage. | -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ -| ADMIN_PASSWORD | ``""`` | If not empty, the specified password must be entered to create new projects | -+----------------------------+---------------------------+-----------------------------------------------------------------------------+ ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ +| Setting name | Default | What does it do? | ++============================+===========================+========================================================================================+ +| SQLALCHEMY_DATABASE_URI | ``sqlite:///budget.db`` | Specifies the type of backend to use and its location. More information | +| | | on the format used can be found on `the SQLAlchemy documentation`. | ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ +| SECRET_KEY | ``tralala`` | The secret key used to encrypt the cookies. **This needs to be changed**. | ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ +| MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email adress to use when sending | +| | "budget@notmyidea.org")`` | emails. | ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ +| ACTIVATE_DEMO_PROJECT | ``True`` | If set to `True`, a demo project will be available on the frontpage. | ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ +| | ``""`` | If not empty, the specified password must be entered to create new projects. | +| ADMIN_PASSWORD | | To generate the proper password HASH, use ``./budget/manage.py generate_password_hash``| +| | | and copy its output into the value of *ADMIN_PASSWORD*. | ++----------------------------+---------------------------+----------------------------------------------------------------------------------------+ .. _`the SQLAlechemy documentation`: http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls |