https://github.com/statsig-io/statuspage

A simple, zero-dependency, pure js/html status page based on GitHub Pages and Actions.
https://github.com/statsig-io/statuspage

availability availability-monitor statsig status-page

Last synced: 10 days ago
JSON representation

A simple, zero-dependency, pure js/html status page based on GitHub Pages and Actions.

• Host: GitHub
• URL: https://github.com/statsig-io/statuspage
• Owner: statsig-io
• License: isc
• Created: 2021-06-05T08:17:55.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T15:03:00.000Z (7 months ago)
• Last Synced: 2024-08-02T02:15:51.930Z (3 months ago)
• Topics: availability, availability-monitor, statsig, status-page
• Language: JavaScript
• Homepage:
• Size: 195 KB
• Stars: 684
• Watchers: 8
• Forks: 286
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Health Check](../../actions/workflows/health-check.yml/badge.svg)](../../actions/workflows/health-check.yml)

# Statsig's Open-Source Status Page

We tried various Status Pages out there, and built this as a fun little hobby project to make status pages as simple as possible.

## Demo

- https://status.statsig.com

## Setup instructions

1. Fork the [template repository](https://github.com/statsig-io/statuspage/).

2. Update `urls.cfg` to include your urls.

```cfg

key1=https://example.com

key2=https://statsig.com

```

3. Update `index.html` and change the title.

```html

My Status Page

Services Status

```


4. Set up GitHub Pages for your repository.

![image](https://user-images.githubusercontent.com/74588208/121419015-5f4dc200-c920-11eb-9b14-a275ef5e2a19.png)

## How does it work?

This project uses GitHub actions to wake up every hour and run a shell script (`health-check.sh`). This script runs `curl` on every url in your config and appends the result of that run to a log file and commits it to the repository. This log is then pulled dynamically from `index.html` and displayed in a easily consumable fashion. You can also run that script from your own infrastructure to update the status page more often.

## What does it not do (yet)?

1. Incident management.

2. Outage duration tracking.

3. Updating status root-cause.

## Got new ideas?

Send in a PR - we'd love to integrate your ideas.

## In case...

You are looking for a developer friendly Feature flags, and A/B experimentation service for your product, check out: https://www.statsig.com

![Statsig status page](https://user-images.githubusercontent.com/74588208/146078161-778fcb99-4a59-4e39-9fc0-abef18d5ac52.png)