README.md

asp - Ana Status Page
==================================
asp is a minimal status page generator written in Rust.
It reads service checks from a CSV file, runs them in parallel,
and outputs a static HTML page.  HTTPS uses libtls(3) from
LibreSSL.

![asp screenshot](asp.png)


Requirements
------------
- rustc (edition 2024)
- libtls (LibreSSL or LibreTLS)
- ping(8) for ICMP checks


Installation
------------
Edit Makefile to match your local setup (asp is installed into
the /usr/local/bin namespace by default).

Afterwards enter the following command to build and install asp:

    make clean install


Running asp
-----------
Create a checks.csv file:

    group,  0,    Web,       -
    http,   200,  Website,   https://example.com
    ping,   0,    DNS,       8.8.8.8
    port,   0,    SSH,       example.com 22

Generate the status page:

    asp -f checks.csv > status.html

Use with cron(8) for periodic updates:

    */5 * * * * asp -f /etc/asp/checks.csv > /var/www/status.html


Configuration
-------------
See asp(1) for the full CSV format and options:

    man asp


Download
--------
    got clone ssh://anon@ijanc.org/asp
    git clone https://git.ijanc.org/asp.git
    git clone https://git.sr.ht/~ijanc/asp
    git clone https://github.com/ijanc/asp.git


Inspired by
-----------
- tinystatus — https://github.com/bderenzo/tinystatus


License
-------
ISC — see LICENSE.