Giter Site home page Giter Site logo

tinystatus's Introduction

Tinystatus

tinystatus generate an html status page via shell script.

Features

  • Parallel checks
  • HTTP, ping, port checks, get text
  • HTTP expected status code (401, ...)
  • Minimal dependencies (curl, nc, jq and coreutils)
  • Easy configuration and customisation
  • Tiny (~1kb) optimized result page
  • Incident history (manual)

Demo

An example site is available here.

Setup

To install tinystatus:

  • Clone the repository and go to the created directory
  • Edit the checks file checks.csv
  • To add incidents or maintenance, edit incidents.txt
  • Generate status page ./tinystatus > index.html
  • Serve the page with your favorite web server

Configuration file

The syntax of checks.csv file is:

Command, Expected Code, Status Text, Host to check

Command can be:

  • http - Check http status
  • ping - Check ping status
  • port - Check open port status
  • info - Get a simple or json format text using cURL

There are also http4, http6, ping4, ping6, port4, port6, info4, info6 for IPv4 or IPv6 only check.
Note: port4 and port6 require OpenBSD nc binary.
Note: info4 and info6 if JSON is used, then requires jq installed and a key to select the data, otherwise just fill with 0 the Expected Code column.

tinystatus's People

Contributors

bderenzo avatar alexpovel avatar null31 avatar kage1 avatar dreamsvoid avatar julianz avatar mediumfidelity avatar vbieleny avatar

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.