Skip to content

ImSingee/swatchdog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swatchdog - simple watchdog!

Just... Send an HTTP request per interval to a given URL. You can use any uptime monitoring service to monitor your machine.

Download & Install

The latest version is available at GitHub Releases. It's just a single binary file, so you can download it and run it directly.

Usage

Just as simple as... No need to explain anything! Just run it with --help to see the help message.

Usage: swatchdog [OPTIONS] --url <URL>

Options:
  -u, --url <URL>
      --method <METHOD>      [default: GET]
      --interval <INTERVAL>  [default: 60s]
      --verbose
  -h, --help                 Print help
  -V, --version              Print version

The tool is tested with uptime-kuma and I personally recommend it.

Setup

Linux service

You may wish to make it start on boot. Setup a systemd service can help with this.

Create the following service (modify args in ExecStart based on your need) file.

[Unit]
Description=swatchdog

[Service]
User=nobody
Group=nobody
ExecStart=/path/to/swatchdog -u http://example.com --interval 60s

[Install]
WantedBy=multi-user.target

Save the file to /lib/systemd/system/swatchdog.service and run systemctl enable swatchdog.

MacOS Service

You may wish to make it start on boot. Setup a launchd service can help with this.

Create the following service (modify args in ProgramArguments based on your need) file.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>Label</key>
    <string>me.singee.swatchdog</string>
    <key>ProgramArguments</key>
    <array>
      <string>/path/to/your/swatchdog</string>
      <string>-u=http://example.com</string>
      <string>--interval=60s</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>KeepAlive</key>
    <true/>
    <key>StandardOutPath</key>
    <string>/Users/USERNAME/.swatchdog.log</string>
    <key>StandardErrorPath</key>
    <string>/Users/USERNAME/.swatchdog.log</string>
  </dict>
</plist>

Save the file to ~/Library/LaunchAgents/me.singee.swatchdog.plist and run launchctl load ~/Library/LaunchAgents/me.singee.swatchdog.plist.

Docker container

If you prefer docker, run this:

docker run -d --restart=unless-stopped ghcr.io/imsingee/swatchdog:latest -u=http://example.com --interval=60s

Or with a docker compose:

services:
  swatchdog:
    image: ghcr.io/imsingee/swatchdog:master
    command:
      - '-u'
      - 'http://example.com'
      - '--interval
      - '60s'
    restart: unless-stopped

License

MIT