jenkins-monitor/README.md

Monitor Jenkins Status

# Jenkins Monitor

[![Build status](https://img.shields.io/wercker/ci/55fb0370ee52f86b6d055b05.svg "Build status")](https://app.wercker.com/project/bykey/6b1943c59a2f5b55beac66aa0f90d346)
[![Dependency status](https://img.shields.io/david/Starefossen/jenkins-monitor.svg "Dependency status")](https://david-dm.org/Starefossen/jenkins-monitor)
[![Join the chat](https://img.shields.io/badge/irc-join%20chat-blue.svg "Join the chat")](https://webchat.freenode.net/?channels=node-build)


Jenkins Monitoring and Alert solution build to monitor the official Node.js CI
server operated by [nodejs/build](https://github.com/nodejs/build).

![Jenkins Monitor](assets/promo.png)

## Prerequisite

* Docker >= v1.8
* Docker Compose >= 1.3

## Environment

* `CRON_INTERVAL` - how often to run checks (ex. `0 0 */1 * * *`)
* `JENKINS_URL` - Jenkins Server URL to monitor

**IRC:**

* `IRC_CHANNEL` - IRC channel to post to
* `IRC_SERVER` - IRC server to post to
* `IRC_USER` - IRC user to post as

**Gitter:**

* `GITTER_WEBHOOK_URL` - Gitter Webhook URL

**Sendgrid:**

* `SENDGRID_USERNAME` - Sengrid email notification user name
* `SENDGRID_PASSWORD` - Sendgrid email notification password
* `SENDGRID_RECIPIENTS` - Sendgrid email notification recipients (comma separated)
* `SENDGRID_SENDER` - Sendgrid email notification sender

## Test

```
docker-compose run --rm dev npm test
```

## Start

```
docker-compose run --rm dev npm start
```

## Deploy

```
./deploy.sh
```

## [MIT Licensed](https://github.com/Starefossen/jenkins-monitor/blob/master/LICENSE)