ClimWeb Documentation
Environment Variables¶
Variable |
Description |
Required |
Default |
More Details |
|---|---|---|---|---|
CMS_DB_USER |
CMS Database user |
YES |
||
CMS_DB_NAME |
CMS Database name |
YES |
||
CMS_DB_PASSWORD |
CMS Database password. |
YES |
||
CMS_DB_VOLUME |
Mounted docker volume path for persisting database data |
YES |
||
CMS_SITE_NAME |
The human-readable name of your Wagtail installation which welcomes users upon login to the Wagtail admin. |
YES |
||
CMS_ADMIN_URL_PATH |
Base Path to admin pages. Do not use |
YES |
||
CMS_DEBUG |
A boolean that turns on/off debug mode. Never deploy a site into production with DEBUG turned on |
NO |
False |
|
CMS_PORT |
Port to run cms |
YES |
80 |
|
CMS_BASE_URL |
This is the base URL used by the Wagtail admin site. It is typically used for generating URLs to include in notification emails. |
NO |
||
CMS_DEFAULT_LANGUAGE_CODE |
The language code for the CMS. Availabe codes are |
NO |
en |
|
CSRF_TRUSTED_ORIGINS |
This variable can be set when CMS_PORT is not 80 e.g if CMS_PORT=8000, CSRF_TRUSTED_ORIGINS would be the following: http://{YOUR_IP_ADDRESS}:8000, http://{YOUR_IP_ADDRESS}, http://localhost:8000 and http://127.0.0.1:8000 |
NO |
||
TIME_ZONE |
A string representing the time zone for this installation. See the list of time zones. Set this to your country timezone |
NO |
UTC |
|
SECRET_KEY |
A secret key for a particular Django installation. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value. Django will refuse to start if SECRET_KEY is not set |
YES |
You can use this online tool https://djecrety.ir to generate the key and paste |
|
ALLOWED_HOSTS |
A list of strings representing the host/domain names that this Django site can serve. This is a security measure to prevent HTTP Host header attacks, which are possible even under many seemingly-safe web server configurations. |
YES |
||
SMTP_EMAIL_HOST |
The host to use for sending email |
NO |
||
SMTP_EMAIL_PORT |
Port to use for the SMTP server defined in |
NO |
25 |
|
SMTP_EMAIL_USE_TLS |
Whether to use a TLS (secure) connection when talking to the SMTP server. This is used for explicit TLS connections, generally on port 587 |
NO |
True |
|
SMTP_EMAIL_HOST_USER |
Username to use for the SMTP server defined in |
NO |
||
SMTP_EMAIL_HOST_PASSWORD |
Password to use for the SMTP server defined in |
NO |
||
CMS_ADMINS |
A list of all the people who get code error notifications, in format |
NO |
||
DEFAULT_FROM_EMAIL |
Default email address to use for various automated correspondence from the site manager(s) |
NO |
||
RECAPTCHA_PUBLIC_KEY |
Google Recaptcha Public Key. https://www.google.com/recaptcha/about/ will need a Google account for RECAPTCHA_PRIVATE_KEY and RECAPTCHA_PUBLIC_KEY creation |
NO |
||
RECAPTCHA_PRIVATE_KEY |
Google Recaptcha Private Key |
NO |
||
CMS_NUM_OF_WORKERS |
Gunicorn number of workers. Recommended value should be |
YES |
||
CMS_STATIC_VOLUME |
Mounted docker volume path for persisting CMS static files |
YES |
./climeb/static |
|
CMS_MEDIA_VOLUME |
Mounted docker volume path for persisting CMS media files |
YES |
./climeb/media |
|
CMS_UPGRADE_HOOK_URL |
Webhook url to your server that triggers a cms upgrade script |
NO |
||
BACKUP_VOLUME |
Mounted docker volume path for persisting Backup dp and media files |
YES |
./climeb/backup |
|
WAGTAIL_NEWSLETTER_MAILCHIMP_API_KEY |
When using the default Mailchimp backend, this setting specifies the API key. An API key can be obtained from the Mailchimp website. |
NO |
||
WAGTAIL_NEWSLETTER_FROM_NAME |
When sending a newsletter, this value will appear as the email sender’s name. |
NO |
||
WAGTAIL_NEWSLETTER_REPLY_TO |
When sending a newsletter, this value will appear as the email sender’s address. Be sure to configure your email domain to allow the newsletter service to send emails on behalf of this address, otherwise they will likely be marked as spam. |
NO |