This repository has been archived by the owner on Apr 5, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 302
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
55 changed files
with
9,622 additions
and
4,006 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2010 Twilio Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# 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 <http://stashboard.appspot.com/documentation/rest> | ||
|
||
## Future | ||
|
||
Future plans include RSS feeds, Web Hook integration, and a richer support for different status page views. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,49 @@ | ||
# Copyright (c) 2010 Twilio Inc. | ||
# | ||
# Permission is hereby granted, free of charge, to any person obtaining a copy | ||
# of this software and associated documentation files (the "Software"), to deal | ||
# in the Software without restriction, including without limitation the rights | ||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
# copies of the Software, and to permit persons to whom the Software is | ||
# furnished to do so, subject to the following conditions: | ||
# | ||
# The above copyright notice and this permission notice shall be included in | ||
# all copies or substantial portions of the Software. | ||
# | ||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
# THE SOFTWARE. | ||
|
||
import os | ||
import logging | ||
|
||
# Stupid error | ||
from google.appengine.dist import use_library | ||
use_library('django', '1.1') | ||
|
||
APP_ROOT_DIR = os.path.abspath(os.path.dirname(__file__)) | ||
|
||
#Stashboard version | ||
VERSION = "1.0.0" | ||
VERSION = "1.1.0" | ||
|
||
# If we're debugging, turn the cache off, etc. | ||
# Set to true if we want to have our webapp print stack traces, etc | ||
DEBUG = os.environ['SERVER_SOFTWARE'].startswith('Dev') | ||
logging.info("Starting application in DEBUG mode: %s", DEBUG) | ||
|
||
# Don't change default_blog or default_page to prevent conflicts when merging # Bloog source code updates. | ||
# Do change blog or page dictionaries at the bottom of this config module. | ||
|
||
SITE = { | ||
"html_type": "text/html", | ||
"charset": "utf-8", | ||
"title": "Is My Webservice Down?", | ||
"title": "Stashboard", | ||
"author": "Kyle Conroy", | ||
# This must be the email address of a registered administrator for the | ||
# application due to mail api restrictions. | ||
"email": "kyle.j.conroy@gmail.com", | ||
"description": "A RESTful Status Tracker on top of App Engine.", | ||
"root_url": "http://ismywebservicedown.appspot.com", | ||
"master_atom_url": "/feeds/atom.xml", | ||
"root_url": "http://stashboard.appspot.com", | ||
"template_path": os.path.join(APP_ROOT_DIR, "views/default"), | ||
"rich_client": True, #If false, the website will go into a simplified read-only view | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.