An open-source Status Page site for your projects, big or small!
Check out the example status-page!
- An open-source staticly-built status-page, built from the designs of popular status pages you see around the web.
- Generated entirely from a config file, so you can edit the file in git or directly on GitHub & have an external service build your site for you!
- Inspired by well-thought out products like StatusPage.io, Sorry™ & other quick-start open-source tools like slatedocs/slate.
Most of the time you launch a status page up to communicate down-time & scheduled maintainence to your customers and/or users. Maybe your product is key to their workflow, and you want to let them know when it'll be unavailable and thus should plan accordingly. Perhaps you get a flurry of messages when your blog goes down & you just want a place to keep your readers informed. You could be a startup bank, a cloud infrastructure provider, a website monitoring service or a university - regardless, you want a dedicated channel to let your users know that you're aware of the problem & you're on it.
There are plenty of hosted status page solutions out there. One of the best is Atlassian's StatusPage, however (in my humble opinion) their pricing is far to high for a static status page, especially for open-source projects or products just launching. They justify their pricing & have excellent features focused around incident management, team management, notifications, webhooks, API access & Single Sign-On. But if you just want a simple status page why isn't their a free alternative? If they offered a free plan with 1 user, no subscribing features, no metrics, basic customisation & incident management, this project would evaporate overnight. Update: StatusPage now offer a Free plan with a reasonable set of features! See the Pricing page for more details.
This has been designed to generate new repositories using the master branch as a template. So to get started click Use this template to setup your own status-page repository.
You can run this site locally using 🐋 Docker to test changes before deploying:
$ git clone [email protected]:YOURUSERNAME/status-page.git status-page
$ cd status-page/
$ docker run --rm -v $PWD:/srv/jekyll -p 4000:4000 -it jekyll/minimal jekyll serve- This will run a HTTP server at https://localhost:4000 for you to view your status-page. Any changes you make will automatically cause the process to rebuild the site.
- If you choose to run this page under a base-url (e.g.
/status-page) be sure to set your_config.yml'sbaseurl: Right now it's set to blank.- And when running a local HTTP server using the method above, note the change in
Server addressto include thebaseurltoo.
- And when running a local HTTP server using the method above, note the change in
- See later on for deployment ideas to GitHub Pages & other cloud providers.
The config file is stored at ./_data/status.yml. The default file is setup to use all the features, so be sure to edit this file to your liking. Use it to make announcements, & most importantly write up incidents!
Control the look & feel of your status page.
icon: /img/font-awesome-svg/solid/stream.svg
title: Status Page
# Site description, shown on the homepage. Markdown supported.
description: >
An example of an open-source statically-built
[status-page](https://github.com/someimportantcompany/status-page).Set the relevant levels & colours for your status messages.
# Set as few or many levels as you like - the order matters here!
levels:
success: # The first is also the default level
color: '#28A745'
label: Operational
warning: # No label defaults to a capitalised key
color: '#FFC107'
# label: Warning
error:
color: '#DC3545'Set the overall tone of your status page.
# Use a single line to push out a single message with the default level.
status: Everything looks OK from here!
# The above is a shortcut for this:
status:
message: Everything looks OK from here!
# Optionally define a level to set the card's colour
status:
level: warning
message: >
There appears to be a backlog of items building in the queue.
We're looking into the cause, and will update you with more information
when we have it.
# Manually set classes & styles
status:
class: bg-dark text-white
message: Happy halloween! 🎃
# Or, omit this entirely to not have a top-level status message.Set top-level components of your product.
# The order matters for components
# Each component requires a name, optionally an icon
components:
platform:
name: Platform
icon: /img/font-awesome-svg/brands/pied-piper-square.svg
# Set a level color/label for each component
components:
platform:
name: Pied Piper
icon: /img/font-awesome-svg/brands/pied-piper-square.svg
level: error
label: Offline
platform:
name: Pied Piper
icon: /img/font-awesome-svg/brands/pied-piper-square.svg
color: yellow
label: No- Order matter here!
Build groups of components to better detail the status of your product or dependencies. All components in groups have the same properties as the components above.
# The order matters for groups & their components
groups:
services:
name: Decentralized Services
icon: /img/font-awesome-svg/brands/pied-piper-pp.svg
components:
compression:
name: Compression Engine
encryption:
name: Encryption Engine
payments:
name: Payments Processor
aws:
name: Amazon Web Services
components:
ecs:
name: Elastic Container Service
rds:
name: Relational Database Service
es:
name: Elasticsearch ServiceThe big one! Write up incidents either after the fact or as-and-when they happen, entirely up to you.
incidents:
# All incidents must have at minimum a timestamp to be shown.
- title: Initial release!
timestamp: 2020-03-12
# Incidents can just have a body, if this is just a message you're pushing out to your audience.
- title: Payments from Nationwide may be delayed
body: >
We’ve noticed that FPS payments to and from Nationwide are taking a while to
arrive due to a service disruption at Nationwide. Don’t worry, your payments should still
arrive eventually. Unless your payment has been returned to your account, please don't try
to send it again. We will continue to monitor.
timestamp: 2020-02-28 19:09
# Since incidents often have updates, the timestamp can be on the updates too.
- title: Event Processing Delays/Errors
updates:
- timestamp: 2020-01-31 17:54
body: > # Markdown is supported here
**Resolved** - Our engineering team has confirmed resolution of the issue affecting Droplet
creates and event processing across all regions. All systems should be operating normally
at this time. If you continue to experience any problems, then please open a ticket with
our support team. We apologize for any inconvenience, and we appreciate your patience
throughout this process.
- timestamp: 2020-01-31 17:07
body: >
**Monitoring** - Our engineering team has identified the cause of issues affecting Droplet
creates and event processing, and functionality should be fully restored at this time. Our
team is now monitoring the situation for any further issues. We apologize for the
inconvenience and will share an update once we have confirmed that the issue is resolved.
- timestamp: 2020-01-31 16:54
body: >
**Investigating** - Our engineering team is investigating an issue affecting Droplet
creates and event processing across all regions. During this time, users may experience
intermittent errors or delays while working with resources, such as creating or destroying
Droplets. We apologize for the inconvenience and will share an update once we have more
information.Being built upon Jekyll, this project is immediately designed to be deployed onto GitHub Pages. Having said that, the final build output is a static website, so you are free to deploy your status-page anywhere you like. The Jekyll documentation covers manual deployments, automated deployments & 3rd party deployments including Netlify.
If you choose to deploy with GitHub Pages, be sure to enable it in your repository settings, and build from the master branch.
If you choose not to use a custom domain, e.g. status.someimportantcompany.com, and instead want to run this project under a folder, e.g. someimportantcompany.github.io/status-page, be sure to change Jekyll's baseurl setting to your top-level folder:
# someimportantcompany.github.io/status-page
baseurl: /status-page
# jdrydn.github.io/status
baseurl: /statusSee Jekyll's configuration for more information on the baseurl property.
- 1.1.0 Added a
current.jsonfile which will trigger a refresh when the status page is next built 💪 - 1.0.0 Initial release 🎉