Skip to content
Stashboard, now with less vendor lock-in.
Python CSS
Latest commit fe157c1 Dec 22, 2013 Jon Chen Merge pull request #14 from fly/run_locally
document running locally
Failed to load latest commit information.
board Quick fix Jul 19, 2011
settings remove lingering epio references Dec 15, 2013
static Timezone Jul 13, 2011
templates Timezone Jul 13, 2011
.gitignore remove epio stuff Dec 14, 2013
LICENSE Initial commit Jun 22, 2011
README.md document running locally fixes bfirsh/whiskerboard#1 Dec 16, 2013
__init__.py Initial commit Jun 22, 2011
fabfile.py remove epio stuff Dec 14, 2013
manage.py Initial commit Jun 22, 2011
requirements.txt remove epio stuff Dec 14, 2013
urls.py Added feed Jun 22, 2011

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', 'your_email@example.com'),
)

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.

Something went wrong with that request. Please try again.