Application settings¶
This chapter covers the configuration of the QCAT application. The pattern
`config` from the 12 factor app is widely followed, so many variables are
stored in the environment.
For easy management of environment variables, the package envdir is used.
The variables are stored in the folder `/envs`; your folder should look as
follows
envs/
├── AUTH_API_KEY
├── AUTH_API_URL
├── CACHE_URL
├── DATABASE_URL
├── DJANGO_ALLOWED_HOSTS
├── DJANGO_CONFIGURATION
├── DJANGO_DEBUG
├── DJANGO_SETTINGS_MODULE
├── DJANGO_TEMPLATE_DEBUG
└── TESTING_FIREFOX_PATH
See also
dj-database-url for the format of `DATABASE_URL`
See also
django-cache-url for the format of `CACHE_URL`
Django settings¶
Most of the settings are identical to the Django settings. Please refer to the Django documentation for further information.
Following environment variables must be set in order for django to run:
`DJANGO_CONFIGURATION`(for development: ‘DevDefaultSite’)
`DJANGO_SETTINGS_MODULE`(for develpment: ‘apps.qcat.settings’)
`DATABASE_URL`
QCAT settings¶
API_PAGE_SIZE¶
Page size of results for the API providing questionnaire details.
AUTH_API_KEY¶
AUTH_API_TOKEN¶
The API token used for the authentication.
Default: None
AUTH_API_URL¶
AUTH_API_USER¶
AUTH_LOGIN_FORM¶
ES_ANALYZERS¶
ES_HOST¶
ES_INDEX_PREFIX¶
ES_NESTED_FIELDS_LIMIT¶
ES_PORT¶
ES_QUERY_RESERVED_CHARS¶
Some charactes have special meaning to ES queries. https://www.elastic.co/guide/en/elasticsearch/reference/2.0/query-dsl-query-string-query.html#_reserved_characters
GOOGLE_MAPS_JAVASCRIPT_API_KEY¶
GOOGLE_WEBMASTER_TOOLS_KEY¶
GRAPPELLI_ADMIN_TITLE¶
GRAPPELLI_INDEX_DASHBOARD¶
HOST_STRING_DEMO¶
Used for continuous delivery (fabric).
HOST_STRING_DEV¶
Used for continuous delivery (fabric).
HOST_STRING_LIVE¶
Used for continuous delivery (fabric).
IS_ACTIVE_FEATURE_MODULE¶
Feature toggle for questionnaire-modules
IS_ACTIVE_FEATURE_SUMMARY¶
Feature toggle for summaries
IS_ACTIVE_FEATURE_WATERSHED¶
Feature toggle for questionnaire ‘watershed’
KEY_PREFIX¶
LOCALE_PATHS¶
LOGIN_URL¶
NOSE_ARGS¶
PIWIK_API_VERSION¶
PIWIK_AUTH_TOKEN¶
PIWIK_SITE_ID¶
PIWIK_URL¶
REACTIVATE_WOCAT_ACCOUNT_URL¶
An URL to which users are redirected if the login failed because their account is not yet activated. Background is that upon switching to the new WOCAT website in 2017, all existing user accounts have to be reactivated manually.
Default: https://beta.wocat.net/accounts/reactivate/
SEND_MAILS¶
SENTRY_DSN¶
See https://docs.sentry.io/clients/python/integrations/django/
SUMMARY_PDF_PATH¶
Path to folder to store/’cache’ created pdfs
TESTING_FIREFOX_PATH¶
THUMBNAIL_ALIASES¶
TOUCH_FILE_DEMO¶
Location of uwsgi-touchfile, used for continuous delivery.
TOUCH_FILE_DEV¶
Location of uwsgi-touchfile, used for continuous delivery.
TOUCH_FILE_LIVE¶
Location of uwsgi-touchfile, used for continuous delivery.
UPLOAD_IMAGE_THUMBNAIL_FORMATS¶
A dictionary specifying the different thumbnail formats for images. For every uploaded image, a thumbnail is created in each of the formats.
Example:
UPLOAD_IMAGE_THUMBNAIL_FORMATS = {
# '[NAME]': ([WIDTH], [HEIGHT])
'header': (900, 300),
'small': (200, 100),
}
UPLOAD_MAX_FILE_SIZE¶
An integer indicating the maximum file size for a single file upload. In Bytes.
UPLOAD_VALID_FILES¶
A dictionary indicating what file types are valid for upload and with which extension they shall be saved.
Example:
UPLOAD_VALID_FILES = {
# 'TYPE': Used to group different types of files
'image': (
# ('[CONTENT_TYPE]', 'FILE_EXTENSION')
('image/jpeg', 'jpg'),
('image/png', 'png'),
('image/gif', 'gif'),
),
'document': (
('application/pdf', 'pdf'),
)
}
WOCAT_IMPORT_DATABASE_URL¶
WORD_WRAP_LANGUAGES¶
List of languages to add the css-attribute: word-wrap. Use this with languages without spaces between words, such as Khmer.