How to Install Vigil on macOS

Vigil is a lightweight monitoring tool for servers and websites. It allows you to configure checks to monitor your system and notify you in case of any issues. Here's how you can install Vigil on macOS.

Prerequisites

Before you begin, ensure that you have the following:

  • A macOS computer with internet access.
  • Xcode Command Line Tools installed. You can check by opening Terminal and typing xcode-select -p. If it returns a path, you have it installed. If not, run xcode-select --install to install it.
  • Rust programming language installed. You can install Rust by running the command curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh in your Terminal.

Installation Steps

  1. Open Terminal on your macOS computer.
  2. Run the command cargo install vigil-server to install Vigil.
  3. Wait for the installation to complete.
  4. Once the installation is complete, run vigil-server -V in Terminal to check the version of the installed Vigil.

Configuration

Once you have installed Vigil, you need to configure it to monitor your system. Here's how:

  1. Create a new file called config.toml in your preferred directory. You can do this by running the command touch config.toml in Terminal.
  2. Open config.toml in your preferred text editor and add the following configuration:
[http]
bind_addr = "127.0.0.1:9090"

[[checks]]
name = "Vigil Server"
type = "http"
url = "http://127.0.0.1:9090"
interval = "30s"
timeout = "10s"

This configuration will create a HTTP check that monitors the Vigil server itself.

  1. Save the config.toml file.
  2. You can start the Vigil server by running the command vigil-server --config path/to/config.toml in Terminal, replacing path/to/config.toml with the actual path to your config.toml.
  3. You can now view the status of your checks and receive notifications by visiting http://localhost:9090 in your web browser.

Congratulations! You have installed and configured Vigil on your macOS computer. You can now use it to monitor your system and receive notifications in case of any issues.