cabot/conf/production.env.example

# Plugins to be loaded at launch
# CABOT_PLUGINS_ENABLED=cabot_alert_hipchat,cabot_alert_twilio,cabot_alert_email,cabot_alert_slack

DATABASE_URL=postgres://cabot:cabot@localhost:5432/index
DJANGO_SETTINGS_MODULE=cabot.settings
HIPCHAT_URL=https://api.hipchat.com/v1/rooms/message
LOG_FILE=/dev/null
PORT=5000
VENV=/home/ubuntu/venv

# You shouldn't need to change anything above this line

# Base path to include before generated URLs.  If not defined, uses `/`
# URL_PREFIX=/

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
TIME_ZONE=Etc/UTC

# Django admin email
ADMIN_EMAIL=you@example.com
CABOT_FROM_EMAIL=noreply@example.com

# URL of calendar to synchronise rota with
CALENDAR_ICAL_URL=http://www.google.com/calendar/ical/example.ics

# Django settings
CELERY_BROKER_URL=redis://:yourredispassword@localhost:6379/1
DJANGO_SECRET_KEY=2FL6ORhHwr5eX34pP9mMugnIOd3jzVuT45f7w430Mt5PnEwbcJgma0q8zUXNZ68A

# Hostname of your Graphite server instance (including trailing slash)
GRAPHITE_API=http://graphite.example.com/
GRAPHITE_USER=username
GRAPHITE_PASS=password

# From parameter for the graphite request. If not defined, by default take -10 minutes
# GRAPHITE_FROM=-10minute

# User-Agent string used for HTTP checks
HTTP_USER_AGENT=Cabot

# Hipchat integration
HIPCHAT_ALERT_ROOM=48052
HIPCHAT_API_KEY=your_hipchat_api_key

# Jenkins integration
JENKINS_API=https://jenkins.example.com/
JENKINS_USER=username
JENKINS_PASS=password

# SMTP settings
EMAIL_HOST=smtp.gmail.com
EMAIL_USER=********@gmail.com
EMAIL_PASSWORD=*********
EMAIL_PORT=587
EMAIL_USE_TLS=1

# Twilio integration for SMS and telephone alerts
TWILIO_ACCOUNT_SID=your_account_sid
TWILIO_AUTH_TOKEN=your_auth_token
TWILIO_OUTGOING_NUMBER=+14155551234

# Used for pointing links back in alerts etc.
WWW_HTTP_HOST=cabot.example.com
WWW_SCHEME=http

# Use for LDAP authentication
AUTH_LDAP=true
AUTH_LDAP_SERVER_URI=ldap://ldap.example.com
AUTH_LDAP_BIND_DN="cn=Manager,dc=example,dc=com"
AUTH_LDAP_BIND_PASSWORD=""
AUTH_LDAP_USER_SEARCH="ou=People,dc=example,dc=com"
Added support for alert plugins 2014-12-05 16:52:33 +00:00			`# Plugins to be loaded at launch`
In examples don't overwrite settings that match the default 2017-03-21 15:32:30 +00:00			`# CABOT_PLUGINS_ENABLED=cabot_alert_hipchat,cabot_alert_twilio,cabot_alert_email,cabot_alert_slack`
Added support for alert plugins 2014-12-05 16:52:33 +00:00
Clean repo 2014-01-05 17:24:04 +00:00			`DATABASE_URL=postgres://cabot:cabot@localhost:5432/index`
Python packaging support Can be installed from a local checkout with `pip install -e .` or directly from git: `pip install -e git+git@github.com:arachnys/cabot.git#egg=cabot` 2014-03-05 16:28:32 -06:00			`DJANGO_SETTINGS_MODULE=cabot.settings`
Clean repo 2014-01-05 17:24:04 +00:00			`HIPCHAT_URL=https://api.hipchat.com/v1/rooms/message`
			`LOG_FILE=/dev/null`
			`PORT=5000`
			`VENV=/home/ubuntu/venv`

			`# You shouldn't need to change anything above this line`
move time zone setting to conf file 2014-07-14 10:47:33 +02:00
add a URL_PREFIX environment variable this adds the ability to add a prefix to all generated URLs so placing cabot under a subdirectory of a web server is possible, such as with a reverse proxy. resolves #321 2016-04-01 01:01:20 -04:00			# Base path to include before generated URLs. If not defined, uses `/`
			`# URL_PREFIX=/`

move time zone setting to conf file 2014-07-14 10:47:33 +02:00			`# Local time zone for this installation. Choices can be found here:`
			`# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name`
correct syntax 2014-07-14 10:48:43 +02:00			`TIME_ZONE=Etc/UTC`
move time zone setting to conf file 2014-07-14 10:47:33 +02:00
Clean repo 2014-01-05 17:24:04 +00:00			`# Django admin email`
			`ADMIN_EMAIL=you@example.com`
Add configurable from email address 2014-01-05 20:26:15 +00:00			`CABOT_FROM_EMAIL=noreply@example.com`
Clean repo 2014-01-05 17:24:04 +00:00
			`# URL of calendar to synchronise rota with`
			`CALENDAR_ICAL_URL=http://www.google.com/calendar/ical/example.ics`

			`# Django settings`
Update example key - fixes #209 2015-11-07 17:09:17 +00:00			`CELERY_BROKER_URL=redis://:yourredispassword@localhost:6379/1`
Clean repo 2014-01-05 17:24:04 +00:00			`DJANGO_SECRET_KEY=2FL6ORhHwr5eX34pP9mMugnIOd3jzVuT45f7w430Mt5PnEwbcJgma0q8zUXNZ68A`

example production env tweak Only including this as it got me for a little while - a reminder that Cabot won't see your graphite server if you leave off the trailing slash. (It tries to access graphite.example.comevents instead of joining the URL together with a slash if not already present- suggest using urljoin to prevent this?) 2015-06-11 10:56:24 +01:00			`# Hostname of your Graphite server instance (including trailing slash)`
Clean repo 2014-01-05 17:24:04 +00:00			`GRAPHITE_API=http://graphite.example.com/`
			`GRAPHITE_USER=username`
			`GRAPHITE_PASS=password`

Better explanation for setting 2014-08-07 09:56:22 +02:00			`# From parameter for the graphite request. If not defined, by default take -10 minutes`
Now from parameter can be defined in settings file 2014-08-07 09:42:04 +02:00			`# GRAPHITE_FROM=-10minute`

HTTP Checks: Make User-Agent configurable. This is helpful so the service being checked can log the source of the health check requests more informatively. 2015-08-06 19:44:59 -07:00			`# User-Agent string used for HTTP checks`
			`HTTP_USER_AGENT=Cabot`

Clean repo 2014-01-05 17:24:04 +00:00			`# Hipchat integration`
			`HIPCHAT_ALERT_ROOM=48052`
			`HIPCHAT_API_KEY=your_hipchat_api_key`

			`# Jenkins integration`
			`JENKINS_API=https://jenkins.example.com/`
			`JENKINS_USER=username`
			`JENKINS_PASS=password`

			`# SMTP settings`
Update email example settings for gmail Using gmail smtp is probably more common than aws so use that as default example. Also make USE_SSL default to opposite of USE_TLS as they don't work nicely together 2017-03-02 11:26:13 +00:00			`EMAIL_HOST=smtp.gmail.com`
			`EMAIL_USER=********@gmail.com`
			`EMAIL_PASSWORD=*********`
			`EMAIL_PORT=587`
			`EMAIL_USE_TLS=1`
Clean repo 2014-01-05 17:24:04 +00:00
			`# Twilio integration for SMS and telephone alerts`
			`TWILIO_ACCOUNT_SID=your_account_sid`
			`TWILIO_AUTH_TOKEN=your_auth_token`
			`TWILIO_OUTGOING_NUMBER=+14155551234`

			`# Used for pointing links back in alerts etc.`
Allow for the scheme of alert links to be configured 2014-02-20 13:01:59 -08:00			`WWW_HTTP_HOST=cabot.example.com`
			`WWW_SCHEME=http`
Add support for authentication with LDAP - add necessary dependencies 2015-05-10 21:40:39 -04:00
			`# Use for LDAP authentication`
			`AUTH_LDAP=true`
			`AUTH_LDAP_SERVER_URI=ldap://ldap.example.com`
			`AUTH_LDAP_BIND_DN="cn=Manager,dc=example,dc=com"`
			`AUTH_LDAP_BIND_PASSWORD=""`
			`AUTH_LDAP_USER_SEARCH="ou=People,dc=example,dc=com"`