README.md

Watchtower

Monitors your site and posts downtime to Slack.

What is this?

A simple Node package which checks the status of links on your site, and posts any outages to Slack. This is heavily based upon the Linkey gem written by @daveblooman.

Screenshot

Install

npm install watchtower-js

Usage

First create a config.yaml (see section below), then:

var watchtower  = require("watchtower-js");
var config_path = "/path/to/config.yaml";

new watchtower(config_path).start();

or run from the command-line:

watchtower /path/to/config.yaml

Config

slack_webhook_url: "https://hooks.slack.com/services/****/****/********"
slack_channel: "#general"

max_concurrent: 5

sites:
  - name: "BBC"
    base: "http://bbc.co.uk"
    endpoints:
      - "/news"
      - "/music"
      - "/batman"
  - name: "Guardian"
    base: "http://theguardian.com"
    endpoints:
      - "/uk/sport"
      - "/football"

Note - the slack parameters are optional.

Tests

npm install && npm install -g mocha

APP_ENV=test mocha tests/

Licence

The MIT License (MIT)

Copyright (c) 2015 Charlie Revett