.. _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 " DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "your_project_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_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) ------------ KDL Settings ------------ `ActiveCollab Digger`_ ---------------------- ======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default ======================================= =========================== ============================================== ====================================================================== AC_DIGGER_COMPANY_ID AC_COMPANY_ID n/a raises error AC_DIGGER_PROJECT_ID AC_PROJECT_ID n/a raises error AC_DIGGER_USER_ID AC_USER n/a raises error AC_DIGGER_API_TOKEN AC_TOKEN n/a raises error ======================================= =========================== ============================================== ====================================================================== .. _`ActiveCollab Digger`: https://github.com/kingsdigitallab/django-activecollab-digger `LDAP Authentication`_ ---------------------- These settings are only used in a production environment. ======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default ======================================= =========================== ============================================== ====================================================================== LDAP_SERVER_URI AUTH_LDAP_SERVER_URI n/a "ldap://ldap1.cch.kcl.ac.uk" LDAP_BIND_DN AUTH_LDAP_BIND_DN n/a "" LDAP_BIND_PASSWORD AUTH_LDAP_BIND_PASSWORD n/a "" LDAP_BASE_DC LDAP_BASE_DC n/a "dc=dighum,dc=kcl,dc=ac,dc=uk" LDAP_BASE_GROUP LDAP_BASE_GROUP n/a "kdl-staff" LDAP_FIRST_NAME_FIELD AUTH_LDAP_USER_ATTR_MAP n/a "givenName" LDAP_LAST_NAME_FIELD AUTH_LDAP_USER_ATTR_MAP n/a "sn" LDAP_EMAIL_FIELD AUTH_LDAP_USER_ATTR_MAP n/a "mail" ======================================= =========================== ============================================== ====================================================================== .. _`LDAP Authentication`: https://django-auth-ldap.readthedocs.io/ Elasticsearch_ -------------- ======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default ======================================= =========================== ============================================== ====================================================================== DISCOVERY_TYPE n/a single-node single-node ======================================= =========================== ============================================== ====================================================================== Kibana_ ^^^^^^^ ======================================= =========================== ============================================== ====================================================================== Environment Variable Django Setting Development Default Production Default ======================================= =========================== ============================================== ====================================================================== SERVER_NAME n/a kibana kibana SERVER_HOST n/a 0 0 ELASTICSEARCH_HOSTS n/a http://elasticsearch:9200 http://elasticsearch:9200 ======================================= =========================== ============================================== ====================================================================== .. _Elasticsearch: https://www.elastic.co/products/elasticsearch .. _Kibana: https://www.elastic.co/guide/en/kibana/7.x/index.html