https://github.com/bderenzo/tinystatus

Static status page generator
https://github.com/bderenzo/tinystatus

Last synced: 8 days ago
JSON representation

Static status page generator

• Host: GitHub
• URL: https://github.com/bderenzo/tinystatus
• Owner: bderenzo
• License: mit
• Created: 2021-03-27T22:25:17.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-07T21:45:07.000Z (8 months ago)
• Last Synced: 2024-08-02T15:10:24.438Z (3 months ago)
• Language: Shell
• Homepage:
• Size: 13.7 KB
• Stars: 432
• Watchers: 8
• Forks: 64
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

* Tiny (~1kb) optimized result page

* Incident history (manual)

## Demo

An example site is available [here](https://lab.bdro.fr/tinystatus/).

## 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

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

Note: `port4` and `port6` require OpenBSD `nc` binary.