Skip to content

Commit

Permalink
Remove ENV config value as it's bad practice
Browse files Browse the repository at this point in the history
  • Loading branch information
EpocDotFr committed May 3, 2018
1 parent 48ce8c2 commit 4257605
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,8 @@ Copy the `config.example.py` file to `config.py` and fill in the configuration p
Available configuration parameters are:

- `SECRET_KEY` Set this to a complex random value
- `ENV` Either `production` or `development` (debug mode enabled in this last)

More informations on the three above can be found [here](http://flask.pocoo.org/docs/0.12/config/#builtin-configuration-values).
More informations about Flask config values can be found [here](http://flask.pocoo.org/docs/1.0/config/#builtin-configuration-values).

- `TITLE` If set to a string, will be used to replace the default app title (which is "Web Todo.txt")
- `USERS` The credentials required to access the app. You can specify multiple ones. **It is highly recommended to serve Web Todo.txt through HTTPS** because it uses [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication)
Expand Down Expand Up @@ -169,7 +168,7 @@ The `WebDav` storage backend has two special features:
and `webdav_password` or, if omitted, from the current user.

With these features there are several multi-user-scenarios possible:
* You can have predefined users in the `USERS` dict that share one and the same todo file (no user
* You can have predefined users in the `USERS` dict that share one and the same todo file (no user
placeholder, dav credentials given in the storage config and `DictAuth`).
* You can have predefined users in the `USERS` dict which each has its own todo.txt file on the same
storage (filename with user placeholder, dav credentials given in the storage config and `DictAuth`)
Expand Down
1 change: 0 additions & 1 deletion config.example.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
SECRET_KEY = 'secretkeyhere'
ENV = 'production'
USERS = {'username': 'password'}
FORCE_LANGUAGE = None
DEFAULT_LANGUAGE = 'en'
Expand Down

0 comments on commit 4257605

Please sign in to comment.