README.md

Whiskerboard

Whiskerboard is a status board for websites, services and APIs, like Amazon's AWS status page.

It is heavily based on Stashboard. Unlike Stashboard, it uses vanilla Django, so you aren't stuck using Google App Engine.

Have a look at the demo: http://whiskerboard.ep.io/.

Quick start guide

It's dead quick to get a status board up and running using ep.io.

Create an application on ep.io then run these two commands, replacing myamazingboard with the name of your application:

$ pip install -r requirements.txt
$ fab app:myamazingboard deploy

You might need to install pip. If you haven't got a virtualenv, you'll need to run it as root too.

Configuration

The configuration files are located in the setting directory, with base.py being the most relevant.

You'll want to edit the following configuration options accordingly:

• DATABASES:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'whiskerboard',
        'USER': 'whiskerboard',
        'PASSWORD': 'supersekritpassword',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}

• TIME_ZONE

TIME_ZONE = 'Etc/UTC'

• ADMINS

ADMINS = (
    ('Your Name', '[email protected]'),
)

Run locally

Use the following command to run whiskerboard locally using the built in Python webserver:

$ ./manage.py runserver

Now head over to http://myamazingboard.ep.io/admin/ and login with the account you created when you deployed. You'll want to set the name of your board by clicking on "sites". Edit the single entry called "example.com" and enter a name for your board.

Back on the admin home page, click on "services" and add the things you want to report the status of (website, API etc). To change the status of a service add an event for it.