GitXplorerGitXplorer
b

whiskerboard

public
112 stars
33 forks
6 issues

Commits

List of commits on branch master.
Unverified
fe157c1eff068c089f6948ac5cf21f5a6ff36600

Merge pull request #14 from fly/run_locally

ffly committed 11 years ago
Unverified
7969d8af2e8f22ebc87250515446436b0ffaf73e

document running locally fixes bfirsh/whiskerboard#1

bbsdlp committed 11 years ago
Unverified
7c8d7b9ba3fac83c6967f9f7334dcb09f7d86a95

remove lingering epio references

bbsdlp committed 11 years ago
Unverified
e7d8c95d57a6c5f6a1f2245b25b7b9cc294a3432

Merge pull request #12 from fly/remove_epio

ffly committed 11 years ago
Unverified
50879c2e7a19c3bcb14949d1ce0c9846ff26365d

remove epio stuff

bbsdlp committed 11 years ago
Unverified
796c4bfbb5bcb1c481a907583989cfb904f47f97

Merge pull request #11 from fly/gitignore

ffly committed 11 years ago

README

The README file for this repository.

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.