cookiecutter-django/docs/settings.rst

.. _settings:

Settings
==========

This project relies extensively on environment settings which **will not work with Apache/mod_wsgi setups**. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.

For configuration purposes, the following table maps environment variables to their Django setting and project settings:


======================================= =========================== ============================================== ======================================================================
Environment Variable                    Django Setting              Development Default                            Production Default
======================================= =========================== ============================================== ======================================================================
DJANGO_READ_DOT_ENV_FILE                READ_DOT_ENV_FILE           False                                          False
======================================= =========================== ============================================== ======================================================================


======================================= =========================== ============================================== ======================================================================
Environment Variable                    Django Setting              Development Default                            Production Default
======================================= =========================== ============================================== ======================================================================
DJANGO_ADMIN_URL                        n/a                         'admin/'                                       raises error
DJANGO_CACHES                           CACHES (default)            locmem                                         redis
DJANGO_DATABASES                        DATABASES (default)         See code                                       See code
DJANGO_DEBUG                            DEBUG                       True                                           False
DJANGO_SECRET_KEY                       SECRET_KEY                  !!!SET DJANGO_SECRET_KEY!!!                    raises error
DJANGO_SECURE_BROWSER_XSS_FILTER        SECURE_BROWSER_XSS_FILTER   n/a                                            True
DJANGO_SECURE_SSL_REDIRECT              SECURE_SSL_REDIRECT         n/a                                            True
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF      SECURE_CONTENT_TYPE_NOSNIFF n/a                                            True
DJANGO_SECURE_FRAME_DENY                SECURE_FRAME_DENY           n/a                                            True
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_DEFAULT_FROM_EMAIL               DEFAULT_FROM_EMAIL          n/a                                            "your_project_name <noreply@your_domain_name>"
DJANGO_SERVER_EMAIL                     SERVER_EMAIL                n/a                                            "your_project_name <noreply@your_domain_name>"
DJANGO_EMAIL_SUBJECT_PREFIX             EMAIL_SUBJECT_PREFIX        n/a                                            "[your_project_name] "
DJANGO_ALLOWED_HOSTS                    ALLOWED_HOSTS               ['*']                                          ['your_domain_name']
======================================= =========================== ============================================== ======================================================================

The following table lists settings and their defaults for third-party applications, which may or may not be part of your project:

======================================= =========================== ============================================== ======================================================================
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
SENTRY_DSN                              SENTRY_DSN                  n/a                                            raises error
DJANGO_SENTRY_CLIENT                    SENTRY_CLIENT               n/a                                            raven.contrib.django.raven_compat.DjangoClient
DJANGO_SENTRY_LOG_LEVEL                 SENTRY_LOG_LEVEL            n/a                                            logging.INFO
MAILGUN_API_KEY                         MAILGUN_ACCESS_KEY          n/a                                            raises error
MAILGUN_DOMAIN                          MAILGUN_SENDER_DOMAIN       n/a                                            raises error
NEW_RELIC_APP_NAME                      NEW_RELIC_APP_NAME          n/a                                            raises error
NEW_RELIC_LICENSE_KEY                   NEW_RELIC_LICENSE_KEY       n/a                                            raises error
======================================= =========================== ============================================== ======================================================================

--------------------------
Other Environment Settings
--------------------------

DJANGO_ACCOUNT_ALLOW_REGISTRATION (=True)
    Allow enable or disable user registration through `django-allauth` without disabling other characteristics like authentication and account management. (Django Setting: ACCOUNT_ALLOW_REGISTRATION)
Fix ALLOWED_HOSTS (#1164) 2017-07-30 15:43:01 +03:00			`.. _settings:`

Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`Settings`
			`==========`

			`This project relies extensively on environment settings which will not work with Apache/mod_wsgi setups. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.`

add DJANGO_READ_DOT_ENV_FILE to settings docs 2017-01-09 22:02:53 +03:00			`For configuration purposes, the following table maps environment variables to their Django setting and project settings:`


			`======================================= =========================== ============================================== ======================================================================`
			`Environment Variable Django Setting Development Default Production Default`
			`======================================= =========================== ============================================== ======================================================================`
			`DJANGO_READ_DOT_ENV_FILE READ_DOT_ENV_FILE False False`
			`======================================= =========================== ============================================== ======================================================================`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00

			`======================================= =========================== ============================================== ======================================================================`
			`Environment Variable Django Setting Development Default Production Default`
			`======================================= =========================== ============================================== ======================================================================`
Migrate to Django2 path urls (#1637) * Change users urls to Django 2 paths * Change config urls to Django 2 paths * Change admin url setting to Django 2 path syntax * Replace more admin urls * Add myself to contributors.rst 2018-05-14 10:09:24 +03:00			`DJANGO_ADMIN_URL n/a 'admin/' raises error`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`DJANGO_CACHES CACHES (default) locmem redis`
			`DJANGO_DATABASES DATABASES (default) See code See code`
			`DJANGO_DEBUG DEBUG True False`
Refactor _gen_project hooks (#1490) Fix ./hooks/pre_gen_project.py asking user to select an option once only + prettify output * Fix pre_gen hook not really exiting when it should * Refactor & prettify ./hooks/post_gen_project.py * Ensure same POSTGRES_USER is set across environments + get rid of env.example in favor of pre-generated .env. 2018-02-07 22:52:52 +03:00			`DJANGO_SECRET_KEY SECRET_KEY !!!SET DJANGO_SECRET_KEY!!! raises error`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`DJANGO_SECURE_BROWSER_XSS_FILTER SECURE_BROWSER_XSS_FILTER n/a True`
			`DJANGO_SECURE_SSL_REDIRECT SECURE_SSL_REDIRECT n/a True`
			`DJANGO_SECURE_CONTENT_TYPE_NOSNIFF SECURE_CONTENT_TYPE_NOSNIFF n/a True`
			`DJANGO_SECURE_FRAME_DENY SECURE_FRAME_DENY n/a True`
			`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_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "your_project_name <noreply@your_domain_name>"`
			`DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "your_project_name <noreply@your_domain_name>"`
			`DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[your_project_name] "`
fixing error in settings 2015-11-16 21:24:21 +03:00			`DJANGO_ALLOWED_HOSTS ALLOWED_HOSTS ['*'] ['your_domain_name']`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`======================================= =========================== ============================================== ======================================================================`

Update settings.rst 2016-02-16 21:07:20 +03:00			`The following table lists settings and their defaults for third-party applications, which may or may not be part of your project:`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00
			`======================================= =========================== ============================================== ======================================================================`
			`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`
Rename DJANGO_SENTRY_DSN env to SENTRY_DSN (#1663) Rationale: so that Heroku auto-provisioned Sentry addon, with its SENTRY_DSN config var is being connected to out-of-box 2018-05-27 22:36:13 +03:00			`SENTRY_DSN SENTRY_DSN n/a raises error`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`DJANGO_SENTRY_CLIENT SENTRY_CLIENT n/a raven.contrib.django.raven_compat.DjangoClient`
			`DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO`
Simplify Mailgun settings When creating a Mailgun add-on on Heroku, the app gets some environment variables by default: MAILGUN_API_KEY MAILGUN_DOMAIN However, the cookiecutter names do not match and requires a manual step from the user deploying. It's used elsewhere but shouldn't harm the other deployment methods to rename these variables. While updating the docs I noticed a variable that appear unused DJANGO_MAILGUN_SERVER_NAME so this removes it from the documentation. 2018-03-05 20:56:45 +03:00			`MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error`
			`MAILGUN_DOMAIN MAILGUN_SENDER_DOMAIN n/a raises error`
fixed new relic app name The app name wasn't displayed correctly on the new relic dashboard. Although `NEW_RELIC_APP_NAME` was set in `production.py`, the variable was not loaded before the newrelic agent was called. Since the new relic agent is loaded at a very low level, NEW_RELIC_APP_NAME has to be set before django settings are imported. 2016-01-26 19:04:59 +03:00			`NEW_RELIC_APP_NAME NEW_RELIC_APP_NAME n/a raises error`
added NEW_RELIC_LICENSE_KEY to environment variables 2015-11-07 22:20:19 +03:00			`NEW_RELIC_LICENSE_KEY NEW_RELIC_LICENSE_KEY n/a raises error`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`======================================= =========================== ============================================== ======================================================================`
[IMP] django-allauth configuration: Allow enable or disable user registration using ACCOUNT_ALLOW_REGISTRATION setting. 2015-12-05 22:12:53 +03:00
Update settings.rst 2016-02-16 21:07:20 +03:00			`--------------------------`
			`Other Environment Settings`
			`--------------------------`
[IMP] django-allauth configuration: Allow enable or disable user registration using ACCOUNT_ALLOW_REGISTRATION setting. 2015-12-05 22:12:53 +03:00
Update settings.rst 2016-02-16 21:07:20 +03:00			`DJANGO_ACCOUNT_ALLOW_REGISTRATION (=True)`
			Allow enable or disable user registration through `django-allauth` without disabling other characteristics like authentication and account management. (Django Setting: ACCOUNT_ALLOW_REGISTRATION)