tinystatus/README.md

44 lines
1 KiB
Markdown
Raw Normal View History

2021-03-27 22:27:40 +00:00
# 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
2021-06-03 20:31:26 +00:00
* Tiny (~1kb) optimized result page
2021-03-27 22:27:40 +00:00
* 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
2021-03-30 19:47:39 +00:00
* Edit the checks file `checks.csv`
* To add incidents or maintenance, edit `incidents.txt`
2021-03-27 22:27:40 +00:00
* Generate status page `./tinystatus > index.html`
* Serve the page with your favorite web server
2021-03-29 18:55:23 +00:00
## Configuration file
2021-03-30 19:47:39 +00:00
The syntax of `checks.csv` file is:
2021-03-29 18:55:23 +00:00
```
2021-03-30 19:47:39 +00:00
Command, Expected Code, Status Text, Host to check
2021-03-29 18:55:23 +00:00
```
Command can be:
* `http` - Check http status
* `ping` - Check ping status
* `port` - Check open port status
2021-06-03 20:31:26 +00:00
There are also `http4`, `http6`, `ping4`, `ping6`, `port4`, `port6` for IPv4 or IPv6 only check.
2021-03-30 19:47:39 +00:00
Note: `port4` and `port6` require OpenBSD `nc` binary.
2021-06-03 20:31:26 +00:00