Skip to content

sijis/whiskerboard

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Quick start guide

Clone the repo, load sample data and run a server.

$ git clone git@github.com:sijis/whiskerboard.git
$ cd whiskerboard
$ sudo pip install -r requirements.txt
$ Add a "SECRET_KEY = 'EnterABunchOfRandomCharactersHere'" to settings/base.py
    (Alternatively, use http://www.miniwebtool.com/django-secret-key-generator/ to create a secret key!)
$ ./manage.py syncdb
$ ./manage.py migrate
$ ./manage.py loaddata board/migrations/0001_initial_data.json
$ ./manage.py runserver

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.

API Documentation

Visit the wiki page on details about the API.

You may also find useful the whiskerboard-tools repository for interacting with the whiskerboard api.

About

A django based status board with an API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 62.0%
  • CSS 22.3%
  • HTML 15.7%