diff --git a/README.md b/README.md index a07599e..694bd05 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,16 @@ I was looking for just a simple up/down ping monitor that tells me if it's up or Simply, it pings (ICMP) a host IP or domain and displays the results in a Bootstrap styled status page. It tells you how long it's been either online, or offline, and also reports how long a host was down in a separate event page. ## requirements -You can use PIP, and the requirements.txt file +Use PIP, and the included requirements.txt file `pip install -r requirements.txt` -Or manually install the required modules `pythonping` and `dicttoxml`. +Or manually install the required modules: `pythonping` and `dicttoxml`. ## setting up hosts This script utilizes a **SQLite3** database. Download a db browser of your choice and fill in each row for each host. ## running the monitor -Simply run `ping.py`. It was developed to run as a service, so it doesn't have any console output, you can use NSSM for setting this up. +Simply run `ping.py`. It was developed to run as a service, so it does **not** have any output, you can use NSSM for setting this up. It will output the results as an XML file to wherever it is determined in the INI. ## config file @@ -24,3 +24,4 @@ The `config.ini` file included holds directory information as well as the ping i ## status page Everything in the www directory works on a web server. It will **_not_** work with the file:// protocol. +It also requires a pinch of manual effort if you change the directory settings. diff --git a/config.ini b/config.ini index 622804f..73dc36d 100644 --- a/config.ini +++ b/config.ini @@ -13,11 +13,11 @@ EventLog=www\event_log.json CheckInterval=5 [SMTP] -;Configure smtp settings for sending downtime updates -;Change to True/False to enable/disable sending emails +; Configure smtp settings for sending downtime updates +; Change to True/False to enable/disable sending emails SendUpdates=False -;Separate receiver emails with commas +; If enabled, configure this to match your server. Separate receiver emails with commas SenderEmail=from@youremail.com Receivers=itguy1@youremail.com, itguy2@youremail.com, itguy3@youremail.com Password=emailpass