DistriLab/tinystatus
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Static status page generator
13 commits 1 branch 0 tags 54 KiB
Shell 100%
Find a file
Alex Povel 11bddbb4fa Use comma-separated value text file 
CSV is a well-supported standard and makes things more
predictable/easier to see where things go.
2021-03-29 21:13:03 +02:00
checks.csv Use comma-separated value text file 2021-03-29 21:13:03 +02:00
incidents.list Initial commit 2021-03-27 23:27:40 +01:00
LICENSE Initial commit 2021-03-27 23:27:40 +01:00
README.md Use comma-separated value text file 2021-03-29 21:13:03 +02:00
tinystatus Use comma-separated value text file 2021-03-29 21:13:03 +02:00

README.md

Tinystatus

tinystatus generate an html status page via shell script.

Features

  • Parallel checks
  • HTTP, ping, port checks
  • HTTP expected status code (401, ...)
  • Minimal dependencies (curl, nc and coreutils)
  • Easy configuration and customisation
  • 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.list
  • Generate status page ./tinystatus > index.html
  • Serve the page with your favorite web server

Configuration file

The syntax of checks.list 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

There are also http4, http6, ping4, ping6, port4, port6 for IPv4 or IPv6 only check.