Gargoyle

A monitoring and alerting framework

Docs

Usage in your code

Check out the examples directory

Setup

1. Create a new user on the server

   sudo useradd -m -s /bin/bash gargoyle
   

2. Log in as the user

    sudo -iu gargoyle
   

3. Ensure you have the nightly rust toolchain installed and selected

    rustup default nightly
   

4. Clone this repository into /opt/gargoyle

    sudo mkdir -p /opt/gargoyle
    chown gargoyle:gargoyle /opt/gargoyle
    chmod 700 /opt/gargoyle
    git clone https://github.com/Mordinel/gargoyle.git /opt/gargoyle
    git checkout v0.1.3
    cd /opt/gargoyle
   

5. Build the example of your choice

    cargo b --release --example=web_monitor_email --features=web-monitor,email-notifier
   

6. If needed, copy the environment file to the same location as the service file defines and modify its contents

    cp web_monitor_email.env .env
    chmod 600 .env
   

7. Modify the service file to your liking and copy it into the systemd service location

    exit # to stop being the gargoyle user
    sudo cp /opt/gargoyle/web_monitor_email.service /etc/systemd/system/
    sudo systemctl daemon-reload
   

8. Enable the service in systemd

    sudo systemctl enable --now web_monitor_email.service