Skip to content

officeluv/staticus

 
 

Repository files navigation

Staticus

A static status page, designed to be blazingly fast and quick enough to update.

  • Runs on GitHub pages (jekyll)
  • Supports multiple status channels (e.g. Apps and Data)
  • Supports 'scheduled maintenance' posts
  • Supports uptime history (of configurable length)

Usage

To update the system status page (homepage), just create a new post in _posts/.

Staticus uses a couple custom frontmatter fields:

  • action denotes the type of status message. (incident-error or incident-warning or resolved)

Staticus also looks at the tags frontmatter to determine the appropriate channel for the update. You can update multiple channels with the same post. Define your channels in _data/tags.yml.

  • Any tag with system: true will be treated as a top-level system channel.
  • Any tag with scheduled: true will be treated as a scheduled channel.
    • These are shown at the top of the status page.

To run on GitHub Pages:

  • Fork the repository
  • Update the _posts and _data respectively
  • Update the CSS styling (optional)
  • Update the CNAME file
  • Push it up!

Example Frontmatter

---
layout: post
title: First bad things happening
date: 2017-01-01 11:11
action: incident-error
tags: [data, apps]
---

Installation

# clone or download the repo
$ bundle install
$ jekyll serve

Preview

Screenshot

Releases

No releases published

Packages

No packages published

Languages

  • HTML 58.9%
  • Ruby 23.6%
  • CSS 17.5%