diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index d96b35adc..eb7ae0094 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -13,16 +13,15 @@ Settings For configuration purposes, the following table maps the '{{cookiecutter.project_name}}' environment variables to their Django setting: -======================================= =========================== ============================================== =========================================== +======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default -======================================= =========================== ============================================== =========================================== +======================================= =========================== ============================================== ====================================================================== DJANGO_AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID n/a raises error DJANGO_AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY n/a raises error DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a raises error DJANGO_CACHES CACHES (default) locmem memcached DJANGO_DATABASES DATABASES (default) See code See code DJANGO_DEBUG DEBUG True False -DJANGO_EMAIL_BACKEND EMAIL_BACKEND django.core.mail.backends.console.EmailBackend django.core.mail.backends.smtp.EmailBackend DJANGO_SECRET_KEY SECRET_KEY CHANGEME!!! raises error DJANGO_SECURE_BROWSER_XSS_FILTER SECURE_BROWSER_XSS_FILTER n/a True DJANGO_SECURE_SSL_REDIRECT SECURE_SSL_REDIRECT n/a True @@ -31,7 +30,14 @@ DJANGO_SECURE_FRAME_DENY SECURE_FRAME_DENY n/a DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS HSTS_INCLUDE_SUBDOMAINS n/a True DJANGO_SESSION_COOKIE_HTTPONLY SESSION_COOKIE_HTTPONLY n/a True DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a False -======================================= =========================== ============================================== =========================================== +DJANGO_EMAIL_BACKEND EMAIL_BACKEND django.core.mail.backends.console.EmailBackend django.core.mail.backends.smtp.EmailBackend +DJANGO_EMAIL_HOST EMAIL_HOST localhost smtp.sendgrid.com +EMAIL_PORT EMAIL_PORT 1025 587 +SENDGRID_USERNAME EMAIL_HOST_USER n/a raises error +SENDGRID_PASSWORD EMAIL_HOST_PASSWORD n/a raises error +DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "{{cookiecutter.project_name}} " +EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[{{cookiecutter.project_name}}] " +======================================= =========================== ============================================== ====================================================================== * TODO: Add vendor-added settings in another table @@ -109,6 +115,9 @@ Run these commands to deploy the project to Heroku: heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE + heroku config:set SENDGRID_USERNAME=YOUR_SENDGRID_USERNAME + heroku config:set SENDGRID_PASSWORD=YOUR_SENDGRID_PASSWORD + git push heroku master heroku run python manage.py migrate heroku run python manage.py check --deploy