From 0cfb44788ab2235ea58d8eb6b4f536538d7ccabf Mon Sep 17 00:00:00 2001 From: axeloz Date: Fri, 8 Jan 2021 15:37:19 +0100 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2163b18..4b3a322 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,31 @@ # MONITOLITE -Monitolite is a quite old project I recently found into my archives. I developed this script years ago. +MonitoLite is a quite old project I recently found into my archives. I developed this script years ago. I figured it could be useful for others so here we are. + + +## What it does + +MonitoLite is a very simple monitoring tool developed in Perl. It supports : + * ping monitoring + * http monitoring + +It uses a SQL backend for handling the tasks and the status of the tasks. +Tested on MySQL only. + +It comes with a very straightforward dashboard written in PHP. + +I rewrote a couple of things today to make sure the script still works. + + +## Installation + + * clone this repo + * install Perl dependencies + * install PHP composer dependencies: `cd ./web && composer install` + * add tasks and contacts into the database (no backend yet) + * run the script: `perl monitolite.pl` + * check the web dashboard for results. + + + MORE INFORMATIN COMING SOON.