aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2020-09-01 15:25:52 +0100
committerrubenwardy <rw@rubenwardy.com>2020-09-01 15:26:10 +0100
commit8ec4006cc756914ad552942715bc0e8a918904d6 (patch)
tree2a2646bcc9722d7974544068256004704b742e35
parentb3fdb991d60c0f68c753c812c23c797952e9aad6 (diff)
downloadcheatdb-8ec4006cc756914ad552942715bc0e8a918904d6.tar.xz
Disable email in default config
-rw-r--r--README.md11
-rw-r--r--config.example.cfg1
2 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 55aedd9..b236c99 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ Docker is the recommended way to develop and deploy ContentDB.
2. Copy `config.example.cfg` to `config.cfg`.
3. (Optional) Set up mail in config.cfg.
+ Make sure to set `USER_ENABLE_EMAIL` to True.
4. (Optional) Set up GitHub integration
1. Make a Github OAuth Client at <https://github.com/settings/developers>:
@@ -29,19 +30,19 @@ Docker is the recommended way to develop and deploy ContentDB.
POSTGRES_DB=contentdb
FLASK_DEBUG=1
-5. Start docker images:
+6. Start docker images:
docker-compose up --build
-6. Setup database:
+7. Setup database:
./utils/run_migrations.sh
-8. (Recommended, optional) create initial data
+8. Create initial data
1. `./utils/bash.sh`
- 2. Either `python setup.py -o` or `python setup.py -t`
+ 2. Either `python setup.py -t` or `python setup.py -o`:
1. `-o` creates just the admin, and static data like tags, and licenses.
- 2. `-t` will do `-o` and also create test pacakges. (Recommended)
+ 2. `-t` will do `-o` and also create test packages. (Recommended)
9. View at <http://localhost:5123>.
The admin username is `rubenwardy` and the password is `tuckfrump`.
diff --git a/config.example.cfg b/config.example.cfg
index b3a66e9..fa46aaf 100644
--- a/config.example.cfg
+++ b/config.example.cfg
@@ -19,6 +19,7 @@ USER_ENABLE_USERNAME = True
USER_ENABLE_REGISTER = False
USER_ENABLE_CHANGE_USERNAME = False
+USER_ENABLE_EMAIL = False
MAIL_USERNAME = ""
MAIL_PASSWORD = ""
USER_EMAIL_SENDER_NAME = ""