Library of Env Settings - lightningkite/cookiecutter-django GitHub Wiki
This will function as a library of Env settings. If you are going to add something new to pull from the Env, please check here to see if a match exists. If it does, please use the one listed here. If not, then please add it to this library. This is designed to be a living document, so please feel free to make edits.
Category | Env Setting | Type | Description |
---|---|---|---|
Django | DJANGO_DEBUG |
bool | Sets whether or not DEBUG is true |
Django | DJANGO_SECRET_KEY |
string | The secret key that Django will use |
Django | DJANGO_DB_ENGINE |
string | The engine that Django will use for the default database |
Django | DJANGO_DATABASE_NAME |
string | The name of the database that Django will use for the default database |
Django | DJANGO_DATABASE_USER |
string | The name of the user that Django will use for the default database |
Django | DJANGO_DATABASE_PASSWORD |
string | The password of the user that Django will use for the default database |
Django | DJANGO_DB_HOST |
string | The hostname of the database that Django will use for the default database |
Redis | DJANGO_REDIS_URL |
string | The full url (including protocol and database) for Django to use as a cache |
Sentry | DJANGO_SENTRY_DSN |
string | The dsn to be used with Sentry for reporting |
Sentry | DJANGO_SENTRY_CLIENT |
string | The client class (dotted notation) for Sentry |
Sentry | DJANGO_SENTRY_LOG_LEVEL |
int | The level of message that Sentry will report. This may be just for Celery on some projects. Use logging.INFO , logging.DEBUG , etc. |
DJANGO_DEFAULT_FROM_EMAIL |
string | The default email that Django will use for sending emails from | |
DJANGO_EMAIL_SUBJECT_PREFIX |
string | A string that Django will prefix all email subjects that it sends | |
DJANGO_SERVER_EMAIL |
string | The email address that Django will use to send error messages to ADMINS and MANAGERS |
|
Mailgun | DJANGO_MAILGUN_API_KEY |
string | The api key for Mailgun |
Mailgun | DJANGO_MAILGUN_SENDER_DOMAIN |
string | The sender domain for Mailgun |
AWS | DJANGO_AWS_ACCESS_KEY_ID |
string | The AWS access key id to use for Django Storages and other AWS uses |
AWS | DJANGO_AWS_SECRET_ACCESS_KEY |
string | The AWS secret access key to use for Django Storages and other AWS uses |
S3 | DJANGO_AWS_STORAGE_BUCKET_NAME |
string | The S3 bucket for Django Storages |
Q | Q_CLUSTER_WORKERS |
int | The number of workers available per each Q Cluster |
Q | Q_CLUSTER_WORKER_RECYCLE_TASK_COUNT |
int | The number of tasks that a worker can do before the worker is recycled |
Q | Q_CLUSTER_SECONDS_BEFORE_RETRY |
int | The number of seconds the cluster will wait for a task to finish before retrying the task |
Q | Q_CLUSTER_SUCCESSFUL_SAVE_LIMIT |
int | The number of successful tasks that can be saved (0 for unlimited, -1 for none) |
Q | Q_CLUSTER_RUN_SYNC |
bool | Whether or not any tasks should be run synchronously or asynchronously |
Q | Q_CLUSTER_CATCH_UP |
bool | Whether or not the cluster should try to catch up when the cluster was down for a while and is started back up |
Elasticsearch | ELASTICSEARCH_HOST |
string | The hostname of Elasticsearch |