A statuspage generator that lets you host your statuspage for free on Github.
We are currently alpha-testing a fully automated statuspage GitHub app. Check out corestatus.io if you like to test it out.
A statuspage generator that lets you host your statuspage for free on GitHub. Uses issues to display incidents and labels for severity.
See a real status page generated by this here demo site
Install statuspage with pip:
pip install statuspage
There are also binaries for macOS and Linux available, see installation for more.
Now, create an GitHub API token:
Generate new token.
To create a new status page, run:
statuspage create --token=
You'll be prompted for a repo name and the systems you want to show a status for.
Name: mystatuspage Systems, eg (Website,API): Website, CDN, API
Please note: This will generate a new repo under that name. Make sure it doesn't exist already.
The command takes a couple of seconds to run. Once ready, it will output links to the issue tracker and your new status page.
Create new issues at https://github.com//mystatuspage/issues Visit your new status page at https://.github.com/mystatuspage/
The generator will then print the
statuspage updatecommand filled with all the details you need to update your page.
To create a new issue, go to your newly created repo and click on
Submit new issue.
Now, update your status page. Go back to your commandline and type:
statuspage update --token= Name: mystatuspage
If you change the issue (eg. when you add a new label, create a comment or close the issue), you'll need to run
In order to add or remove a system, run:
statuspage add_system --token= --name= --system= statuspage remove_system --token= --name= --system=
First, install the latest version with pip, or grab the latest binary:
pip install statuspage --upgrade
Updating your page to the latest version is now as simple as running:
statuspage upgrade --token= --name=
followed by an update:
statuspage update --token= --name=
Translations are available for the following languages:
Want to add a translation? Open
translations.iniand add it. Pull requests welcome!
Want to change styles, the logo, or the footer? Check out customizing.
Want to create a status page for an organisation, or a private one? See options.