cabot/conf/production.env.example

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

# Used for pointing links back in alerts etc.
WWW_HTTP_HOST=cabot.example.com
# Probable values: http, https
WWW_SCHEME=http

## 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

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

## Django admin email, 'from' address for email alerts
ADMIN_EMAIL=you@example.com
CABOT_FROM_EMAIL=noreply@example.com

## Django settings
CELERY_BROKER_URL=redis://:yourredispassword@localhost:6379/1
# Create a random string of mixed case alphanumeric characters, > 40 chars.
# https://www.browserling.com/tools/random-string is a site that can do this
DJANGO_SECRET_KEY=CREATE_A_KEY

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

# Graphite stats are evaluated through a time period to identify transient
# failures. This setting determines how many minutes back a test should
# evaluate.
# If not defined, evaluate 'now through 10 minutes ago' (-10minute)
# GRAPHITE_FROM=-10minute

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

## Email plugin integration
EMAIL_HOST=smtp.example.com
# SMTP authentication settings. To disable SMTP authentication, comment out
#  both EMAIL_USER and EMAIL_PASSWORD.
EMAIL_USER=smtp_username
EMAIL_PASSWORD=smtp_password

# Typical SMTP port 587 configuration
EMAIL_PORT=587
EMAIL_USE_TLS=1
EMAIL_USE_SSL=0

# Typical SMTP port 25 configuration (with no SSL/TLS)
# EMAIL_PORT=587
# EMAIL_USE_TLS=0
# EMAIL_USE_SSL=0

## Hipchat plugin integration
HIPCHAT_ALERT_ROOM=room_name_or_id
HIPCHAT_API_KEY=your_hipchat_api_key

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

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

## 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_FILTER="(uid=%(user)s)"
AUTH_LDAP_USER_SEARCH="ou=People,dc=example,dc=com"

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

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

## Database settings
DATABASE_URL=postgres://cabot:cabot@localhost:5432/index
DJANGO_SETTINGS_MODULE=cabot.settings

DEBUG=False
LOG_FILE=/dev/null

## Cabot localhost operating port (point a reverse proxy to here or use Caddy)
PORT=5000

VENV=/home/ubuntu/venv
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Cabot UI URL setup`
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=/`

Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`# Used for pointing links back in alerts etc.`
			`WWW_HTTP_HOST=cabot.example.com`
Add additional settings to production.env.example 2017-04-29 06:39:13 -07:00			`# Probable values: http, https`
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`WWW_SCHEME=http`

			`## Local time zone for this installation. Choices can be found here:`
move time zone setting to conf file 2014-07-14 10:47:33 +02:00			`# 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
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## URL of calendar to synchronise rota with`
			`CALENDAR_ICAL_URL=http://www.google.com/calendar/ical/example.ics`

			`## Django admin email, 'from' address for email alerts`
Clean repo 2014-01-05 17:24:04 +00:00			`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
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Django settings`
Update example key - fixes #209 2015-11-07 17:09:17 +00:00			`CELERY_BROKER_URL=redis://:yourredispassword@localhost:6379/1`
Add additional settings to production.env.example 2017-04-29 06:39:13 -07:00			`# Create a random string of mixed case alphanumeric characters, > 40 chars.`
			`# https://www.browserling.com/tools/random-string is a site that can do this`
			`DJANGO_SECRET_KEY=CREATE_A_KEY`
Clean repo 2014-01-05 17:24:04 +00:00
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Graphite server settings`
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`

Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`# Graphite stats are evaluated through a time period to identify transient`
			`# failures. This setting determines how many minutes back a test should`
			`# evaluate.`
			`# If not defined, evaluate 'now through 10 minutes ago' (-10minute)`
Now from parameter can be defined in settings file 2014-08-07 09:42:04 +02:00			`# GRAPHITE_FROM=-10minute`

Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## User-Agent string used for Cabot HTTP checks`
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			`HTTP_USER_AGENT=Cabot`

Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Email plugin integration`
			`EMAIL_HOST=smtp.example.com`
			`# SMTP authentication settings. To disable SMTP authentication, comment out`
			`# both EMAIL_USER and EMAIL_PASSWORD.`
			`EMAIL_USER=smtp_username`
			`EMAIL_PASSWORD=smtp_password`
Clean repo 2014-01-05 17:24:04 +00:00
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`# Typical SMTP port 587 configuration`
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_PORT=587`
			`EMAIL_USE_TLS=1`
Disable SMTP SSL when TLS is enabled in example config 2017-05-02 05:18:11 -07:00			`EMAIL_USE_SSL=0`
Clean repo 2014-01-05 17:24:04 +00:00
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`# Typical SMTP port 25 configuration (with no SSL/TLS)`
			`# EMAIL_PORT=587`
			`# EMAIL_USE_TLS=0`
			`# EMAIL_USE_SSL=0`

			`## Hipchat plugin integration`
			`HIPCHAT_ALERT_ROOM=room_name_or_id`
			`HIPCHAT_API_KEY=your_hipchat_api_key`

			`## Twilio plugin integration (for SMS and telephone alerts)`
Clean repo 2014-01-05 17:24:04 +00:00			`TWILIO_ACCOUNT_SID=your_account_sid`
			`TWILIO_AUTH_TOKEN=your_auth_token`
			`TWILIO_OUTGOING_NUMBER=+14155551234`

Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Jenkins integration`
			`JENKINS_API=https://jenkins.example.com/`
			`JENKINS_USER=username`
			`JENKINS_PASS=password`
Add support for authentication with LDAP - add necessary dependencies 2015-05-10 21:40:39 -04:00
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`## Use for LDAP authentication`
Add support for authentication with LDAP - add necessary dependencies 2015-05-10 21:40:39 -04:00			`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=""`
Allow user filter for LDAP to be configure 2017-04-03 21:13:19 -04:00			`AUTH_LDAP_USER_FILTER="(uid=%(user)s)"`
Add support for authentication with LDAP - add necessary dependencies 2015-05-10 21:40:39 -04:00			`AUTH_LDAP_USER_SEARCH="ou=People,dc=example,dc=com"`
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00
			`###########################################################################`
			`## You shouldn't need to change anything below this line #`
			`###########################################################################`

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

			`## Database settings`
			`DATABASE_URL=postgres://cabot:cabot@localhost:5432/index`
			`DJANGO_SETTINGS_MODULE=cabot.settings`

Add additional settings to production.env.example 2017-04-29 06:39:13 -07:00			`DEBUG=False`
Update production.env.example documentation and ordering 2017-04-29 06:17:39 -07:00			`LOG_FILE=/dev/null`

			`## Cabot localhost operating port (point a reverse proxy to here or use Caddy)`
			`PORT=5000`

			`VENV=/home/ubuntu/venv`