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
======================================= =========================== ============================================== ======================================================================
DATABASE_URL                            DATABASES                   auto w/ Docker; postgres://project_slug w/o    raises error
DJANGO_ADMIN_URL                        n/a                         'admin/'                                       raises error
DJANGO_DEBUG                            DEBUG                       True                                           False
DJANGO_SECRET_KEY                       SECRET_KEY                  auto-generated                                 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
======================================= =========================== ============================================== ======================================================================
CELERY_BROKER_URL                       CELERY_BROKER_URL           auto w/ Docker; raises error w/o               raises error
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_AWS_S3_REGION_NAME               AWS_S3_REGION_NAME          n/a                                            None
DJANGO_AWS_S3_CUSTOM_DOMAIN             AWS_S3_CUSTOM_DOMAIN        n/a                                            None
DJANGO_AWS_S3_MAX_MEMORY_SIZE           AWS_S3_MAX_MEMORY_SIZE      n/a                                            100_000_000
DJANGO_GCP_STORAGE_BUCKET_NAME          GS_BUCKET_NAME              n/a                                            raises error
GOOGLE_APPLICATION_CREDENTIALS          n/a                         n/a                                            raises error
SENTRY_DSN                              SENTRY_DSN                  n/a                                            raises error
SENTRY_ENVIRONMENT                      n/a                         n/a                                            production
SENTRY_TRACES_SAMPLE_RATE               n/a                         n/a                                            0.0
DJANGO_SENTRY_LOG_LEVEL                 SENTRY_LOG_LEVEL            n/a                                            logging.INFO
MAILGUN_API_KEY                         MAILGUN_API_KEY             n/a                                            raises error
MAILGUN_DOMAIN                          MAILGUN_SENDER_DOMAIN       n/a                                            raises error
MAILGUN_API_URL                         n/a                         n/a                                            "https://api.mailgun.net/v3"
MAILJET_API_KEY                         MAILJET_API_KEY             n/a                                            raises error
MAILJET_SECRET_KEY                      MAILJET_SECRET_KEY          n/a                                            raises error
MAILJET_API_URL                         n/a                         n/a                                            "https://api.mailjet.com/v3"
MANDRILL_API_KEY                        MANDRILL_API_KEY            n/a                                            raises error
MANDRILL_API_URL                        n/a                         n/a                                            "https://mandrillapp.com/api/1.0"
POSTMARK_SERVER_TOKEN                   POSTMARK_SERVER_TOKEN       n/a                                            raises error
POSTMARK_API_URL                        n/a                         n/a                                            "https://api.postmarkapp.com/"
SENDGRID_API_KEY                        SENDGRID_API_KEY            n/a                                            raises error
SENDGRID_GENERATE_MESSAGE_ID            True                        n/a                                            raises error
SENDGRID_MERGE_FIELD_FORMAT             None                        n/a                                            raises error
SENDGRID_API_URL                        n/a                         n/a                                            "https://api.sendgrid.com/v3/"
SENDINBLUE_API_KEY                      SENDINBLUE_API_KEY          n/a                                            raises error
SENDINBLUE_API_URL                      n/a                         n/a                                            "https://api.sendinblue.com/v3/"
SPARKPOST_API_KEY                       SPARKPOST_API_KEY           n/a                                            raises error
SPARKPOST_API_URL                       n/a                         n/a                                            "https://api.sparkpost.com/api/v1"
======================================= =========================== ============================================== ======================================================================

--------------------------
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`
Update settings page - Add a few missing settings - Remove outdated ones - Detail behaviour with URL for databases 2018-09-15 23:25:40 +03:00			`========`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00
			`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`
			`======================================= =========================== ============================================== ======================================================================`
Update settings page - Add a few missing settings - Remove outdated ones - Detail behaviour with URL for databases 2018-09-15 23:25:40 +03:00			`DATABASE_URL DATABASES auto w/ Docker; postgres://project_slug w/o raises error`
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_DEBUG DEBUG True False`
Update settings page - Add a few missing settings - Remove outdated ones - Detail behaviour with URL for databases 2018-09-15 23:25:40 +03:00			`DJANGO_SECRET_KEY SECRET_KEY auto-generated 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`
			`======================================= =========================== ============================================== ======================================================================`
Update settings page - Add a few missing settings - Remove outdated ones - Detail behaviour with URL for databases 2018-09-15 23:25:40 +03:00			`CELERY_BROKER_URL CELERY_BROKER_URL auto w/ Docker; raises error w/o raises error`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`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`
Added DJANG_AWS_S3_REGION_NAME to settings docs 2019-04-02 16:45:58 +03:00			`DJANGO_AWS_S3_REGION_NAME AWS_S3_REGION_NAME n/a None`
Add AWS_S3_CUSTOM_DOMAIN entry to settings.rst 2020-05-29 01:16:54 +03:00			`DJANGO_AWS_S3_CUSTOM_DOMAIN AWS_S3_CUSTOM_DOMAIN n/a None`
Set AWS_S3_MAX_MEMORY_SIZE (#3810) Co-authored-by: Bruno Alla <alla.brunoo@gmail.com> Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com> 2022-10-19 22:15:25 +03:00			`DJANGO_AWS_S3_MAX_MEMORY_SIZE AWS_S3_MAX_MEMORY_SIZE n/a 100_000_000`
Use GCP acronym for Google Cloud Platform 2019-05-19 02:24:29 +03:00			`DJANGO_GCP_STORAGE_BUCKET_NAME GS_BUCKET_NAME n/a raises error`
Update docs/settings.rst Documented GOOGLE_APPLICATION_CREDENTIALS env var Co-Authored-By: vladdoster <Dosterm@wit.edu> 2019-04-16 19:30:22 +03:00			`GOOGLE_APPLICATION_CREDENTIALS n/a 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`
Add environment and traces_sample_rate keyword to sentry_sdk.init 2020-08-28 11:17:34 +03:00			`SENTRY_ENVIRONMENT n/a n/a production`
			`SENTRY_TRACES_SAMPLE_RATE n/a n/a 0.0`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`DJANGO_SENTRY_LOG_LEVEL SENTRY_LOG_LEVEL n/a logging.INFO`
Update docs about settings 2019-05-27 20:16:00 +03:00			`MAILGUN_API_KEY MAILGUN_API_KEY n/a raises error`
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_DOMAIN MAILGUN_SENDER_DOMAIN n/a raises error`
Listed MAILGUN_API_URL in settings docs 2019-04-02 16:17:22 +03:00			`MAILGUN_API_URL n/a n/a "https://api.mailgun.net/v3"`
Updated mail service docs * Trying to appease the Black-linter god... 2020-02-07 04:18:49 +03:00			`MAILJET_API_KEY MAILJET_API_KEY n/a raises error`
			`MAILJET_SECRET_KEY MAILJET_SECRET_KEY n/a raises error`
			`MAILJET_API_URL n/a n/a "https://api.mailjet.com/v3"`
			`MANDRILL_API_KEY MANDRILL_API_KEY n/a raises error`
			`MANDRILL_API_URL n/a n/a "https://mandrillapp.com/api/1.0"`
			`POSTMARK_SERVER_TOKEN POSTMARK_SERVER_TOKEN n/a raises error`
			`POSTMARK_API_URL n/a n/a "https://api.postmarkapp.com/"`
			`SENDGRID_API_KEY SENDGRID_API_KEY n/a raises error`
			`SENDGRID_GENERATE_MESSAGE_ID True n/a raises error`
			`SENDGRID_MERGE_FIELD_FORMAT None n/a raises error`
			`SENDGRID_API_URL n/a n/a "https://api.sendgrid.com/v3/"`
			`SENDINBLUE_API_KEY SENDINBLUE_API_KEY n/a raises error`
			`SENDINBLUE_API_URL n/a n/a "https://api.sendinblue.com/v3/"`
			`SPARKPOST_API_KEY SPARKPOST_API_KEY n/a raises error`
			`SPARKPOST_API_URL n/a n/a "https://api.sparkpost.com/api/v1"`
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)