Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Stashboard, now with less vendor lock-in.

branch: master

Merge pull request #14 from fly/run_locally

document running locally
latest commit fe157c1eff
Jon Chen fly authored December 22, 2013
Octocat-spinner-32 board Quick fix July 19, 2011
Octocat-spinner-32 settings remove lingering epio references December 15, 2013
Octocat-spinner-32 static Timezone July 13, 2011
Octocat-spinner-32 templates Timezone July 13, 2011
Octocat-spinner-32 .gitignore remove epio stuff December 14, 2013
Octocat-spinner-32 LICENSE Initial commit June 22, 2011
Octocat-spinner-32 README.md document running locally fixes bfirsh/whiskerboard#1 December 16, 2013
Octocat-spinner-32 __init__.py Initial commit June 22, 2011
Octocat-spinner-32 fabfile.py remove epio stuff December 14, 2013
Octocat-spinner-32 manage.py Initial commit June 22, 2011
Octocat-spinner-32 requirements.txt remove epio stuff December 14, 2013
Octocat-spinner-32 urls.py Added feed June 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.