Git Product home page Git Product logo

staticus's Introduction

Staticus

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

  • 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

Examples

These sites are using Staticus:

Preview

Screenshot

staticus's People

Contributors

joshbeckman avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

staticus's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.