https://github.com/jayfk/statuspage

A statuspage generator that lets you host your statuspage for free on Github.
https://github.com/jayfk/statuspage

generator monitoring statuspage

Last synced: about 2 months ago
JSON representation

A statuspage generator that lets you host your statuspage for free on Github.

• Host: GitHub
• URL: https://github.com/jayfk/statuspage
• Owner: jayfk
• License: mit
• Created: 2016-02-26T10:47:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-15T03:21:27.000Z (almost 2 years ago)
• Last Synced: 2024-07-26T20:27:26.838Z (about 2 months ago)
• Topics: generator, monitoring, statuspage
• Language: Python
• Homepage: https://corestatus.io
• Size: 1.62 MB
• Stars: 3,894
• Watchers: 39
• Forks: 186
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-status-pages - Corestats - *(Discontinued / Un-Supported)* (Opensource)
• starred-awesome - statuspage - A statuspage generator that lets you host your statuspage for free on Github. (Python)

README

        
*We are currently alpha-testing a fully automated statuspage GitHub app. Check out [corestatus.io](https://corestatus.io/) if you like to test it out.*

# Statuspage

[![ci](https://github.com/jayfk/statuspage/actions/workflows/ci.yml/badge.svg)](https://github.com/jayfk/statuspage/actions/workflows/ci.yml)

[![codecov.io](https://codecov.io/github/jayfk/statuspage/coverage.svg?branch=master)](https://codecov.io/github/jayfk/statuspage?branch=master)

A statuspage generator that lets you host your statuspage for free on GitHub. Uses

issues to display incidents and labels for severity.

## Demo

![DEMO](https://github.com/jayfk/statuspage/blob/master/demo.gif)

See a real status page generated by this here [demo site](https://jayfk.github.io/statuspage-demo/)

## Quickstart

Install statuspage with pip:

    pip install statuspage

*There are also binaries for macOS and Linux available, see [installation](docs/installation.md) for more.*

Now, create an GitHub API token:

- Go to your [Personal Access tokens](https://github.com/settings/tokens) page.

- Click on `Generate new token`.

- Make sure to check the `public_repo` and `write:repo_hook` scope.

- Copy the token somewhere safe, you won't be able to see it again once you leave the page.

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 update` command filled with all the details you need to update your page.

## Create an issue

To create a new issue, go to your newly created repo and click on `New Issue`.

- Click on the cog icon next to labels on the right.

- Choose the affected systems (black labels)

- Choose a severity label (major outage, degraded performance, investigating)

- Fill in the title, leave a comment and click on `Submit new issue`.

![Add New Issue](docs/new_issue.png)

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 `statuspage update` again.

## Adding and removing systems

In order to add or remove a system, run:

    statuspage add_system --token= --name= --system=

    statuspage remove_system --token= --name= --system=

## Upgrading from previous versions

First, install the latest version with pip, or grab the latest [binary](docs/installation.md):

    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

The generated status page is translated via JavaScript on the client side using [webL10n](https://github.com/fabi1cazenave/webL10n). It detects the visitors preferred language and translates all strings automatically.

Translations are available for the following languages:

- en

- bg

- de

- kr

- nl

- pt

- es

- ru

- fr

- pl

- zh-HK

- zh-TW

- zh-CN

- it

- fur

- vn

Want to add a translation? Open `translations.ini` and add it. Pull requests welcome!

## Customizing

Want to change styles, the logo, or the footer? Check out [customizing](docs/customizing.md).

## Options

Want to create a status page for an organisation, or a private one? See [options](docs/options.md).