Configuration

Files to edit

All configuration takes place through environment variables managed by Foreman.

Production

Production configuration lives in conf/production.env. You should copy and customise the template file included as conf/production.env.example.

To change env variables on a running instance, modify conf/production.env locally and deploy your changes with fab deploy -H [email protected] (as in the 5th step of the quickstart guide).

Development

See conf/development.env.example.

Settings available

In order to use all functionality the following settings must be configured in conf/production.env. If you use fab deploy it will automatically generate an upstart service config including these:

SMTP settings

Secure TLS/SSL email backend is used.

  • SES_HOST
  • SES_USER
  • SES_PASS
  • SES_PORT

Calendar sync and team rota

  • CALENDAR_ICAL_URL
    • URL of the linked Google Calendar which contains team rota data, e.g. http://www.google.com/calendar/ical/blah%40group.calendar.google.com/

Graphite integration

These settings are required for Graphite checks.

  • GRAPHITE_API
    • URL of Graphite server, e.g. https://graphite.mycompany.com/
  • GRAPHITE_USER
  • GRAPHITE_PASS
    • username and password (basic auth) for Graphite server
  • GRAPHITE_FROM
    • Cabot by default set this parameter to -10min but if you want to set another time horizon you can put it here using the naming defined by Graphite.

Jenkins integration

Jenkins checks use settings defined in Cabot user interface. For backwards compatibility, they can be seeded from:

  • JENKINS_API
    • URL of Jenkins server, e.g. https://jenkins.mycompany.com/
  • JENKINS_USER
  • JENKINS_PASS
    • username and password for API access (basic auth)

Hipchat alerting

You must set these correctly if you want Cabot to be able to send alerts to your Hipchat room.

  • HIPCHAT_URL
    • Hipchat API URL. Set to https://api.hipchat.com/v1/rooms/message for ondemand hipchat.
  • HIPCHAT_ALERT_ROOM
    • numeric ID of the Hipchat room you want alerts sent to, e.g. 14256
  • HIPCHAT_API_KEY
    • write-only API key for Hipchat

Twilio (SMS and phone alerts) integration

These credentials are required for SMS and phone alerts.

  • TWILIO_ACCOUNT_SID
    • SID of Twilio account
  • TWILIO_AUTH_TOKEN
    • Auth token
  • TWILIO_OUTGOING_NUMBER
    • number for called ID of phone and SMS alerts, e.g. +442035551234
  • WWW_HTTP_HOST
    • FQDN of Cabot server, e.g. cabot.yourcompany.com

Using MySQL?

Cabot uses Postgresql by default but it’s easy enough to set it up with another database backend such as MySQL: https://github.com/arachnys/cabot/issues/29#issuecomment-34172620

See also JensRantil’s branch which has provisioning setup for MySQL.