https://github.com/szuecs/stashboard

An open-source status dashboard running on App Engine
https://github.com/szuecs/stashboard

Last synced: 3 months ago
JSON representation

An open-source status dashboard running on App Engine

• Host: GitHub
• URL: https://github.com/szuecs/stashboard
• Owner: szuecs
• License: mit
• Fork: true (twilio/stashboard)
• Created: 2011-05-17T06:13:36.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-05-17T06:22:52.000Z (over 13 years ago)
• Last Synced: 2023-04-13T13:26:09.651Z (over 1 year ago)
• Language: Python
• Homepage: stashboard.org
• Size: 5.19 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stashboard

## About

Stashboard was written by Twilio to provide status information on our phone, SMS, and Communication APIs. We open sourced the code and to provide a generic status page designed to be customized by any hosted services company to provide customers up-to-date status information. The code can be downloaded, customized with your logo, and run on any Google App Engine account.

## Installation

First, install the App Engine SDK for Python.

Next, download and extract Stashboard to your computer.

### Run Locally

Open the SDK, choose File > Add Existing Application..., select the stashboard folder you downloaded above and choose a port. Press Run and navigate to http://localhost:{port} to see your Stashboard installation.

### Deploy to AppSpot

Before you can deploy Stashboard, you will need to create an application on App Engine.

Once your application is registered, open app.yaml in the Stashboard directory and change application-id to the name of your newly created application.

Hit the 'Deploy' button, wait a couple of seconds, and then naviagate to http://{app-name}.appspot.com to enjoy your new status dashboard

## Basic View

By default, Stashboard exposes a rich client, utilizing AJAX and jQuery. If instead you just want a basic read only view, change the `rich_client` attribute to `False` in `config.py`.

## REST API

Full documentation of the REST API can be found at 

## Community

All Stashboard development and discussion happens in the [Stashboard google group](https://groups.google.com/forum/#!forum/stashboard)

To keep up to date, you can follow [@stashboard](http://twitter.com/stashboard) on Twitter or join the [#stashboard](irc://irc.freenode.net/stashboard) channel on freenode

## Future

Future plans include RSS feeds, Web Hook integration, and a richer support for different status page views.