Skip to content

Installation

Scott edited this page Dec 20, 2022 · 22 revisions

Requirements:

  • Linux
  • Perl 5.10+
  • (optional) SMTP Server (Does not do user/pass or TLS/SSL at this time)
  • (optional) Pushover, Slack, Discord, Google Chat
  • (optional) Docker/Podman <--if you want to use this, go to the Container page.

Installation:

To install extract the release with tar xvzf EasyPing_0.1.tar.gz or git clone git clone https://github.com/scotticles/EasyPing.git

  • cd EasyPing dir
  • sudo apt-get install libdev-ssl or libssl-dev depending on distribution
  • sudo apt-get install zlib1g-dev or a variant of that
  • sudo apt-get install carton
  • sudo apt-get install build-essential or make gcc should be good enough
  • carton install --deployment <-- run this after updating from git
  • if carton install --deployment had any errors, try carton install and then run carton install --deployment

alt text

Set up

  • cp easyping-example.conf easyping.conf
  • cp db/hosts-example.csv db/hosts.csv
  • edit the easyping.conf and adjust the following fields
Field Description
retry_attempts How many attempts before moving on to the next host
retry_wait How many seconds to sleep before each retry attempt
max_workers How many parallel workers do you want? (start with 3)
[SCRIPTING] ONSUCCESS_STDOUT 0 or 1, do you want output for successful scripts
[SMTP] server_address 192.168.1.10
[SMTP] server_port 25,587
[SMTP] server_type plain,tls (google is tls)
[SMTP] server_username required if using tls
[SMTP] server_password required if using tls
[SMTP[ server_domain required
[SMTP] from_address The email used for the from address

See Adding Hosts

Once the config and hosts have been created you can run the script with the following command:

  • edit easyping.cron.sh to match the paths
  • edit easyping.sh to match the paths
  • sudo chmod +x easyping.cron.sh easyping.pl easyping.sh make it executable

To run it cron

You first need to edit the easyping.cron.sh and update the two paths at the top of the file.

  • carton exec '/path/to/easyping.cron.sh' this needs to be the full path
  • carton exec ./easyping.cron.sh

To run it manual

  • /path/to/easyping.sh --help or ./easyping.sh --help <--recommended method
  • carton exec '/path/to/easyping.pl' --help
  • carton exec ./easyping.pl

alt text

This should output SUCCESS, FAIL or RECOVERED.

Clone this wiki locally