search

manprinsen / uptime-kuma-agent

6 stars 0 forks source link

readme

Uptime Kuma Push Agent

This repository contains scripts and instructions for setting up an Uptime Kuma Push Agent. Once you have added a push device in Uptime Kuma, you can use this repository to monitor network uptime and send results to your Uptime Kuma server. The agent is designed to run on both non-embedded systems (such as desktops and servers) and embedded systems (such as IoT devices and routers).

Project Setup and Usage for non-embedded systems

Below are instructions on how to use and deploy program.py on non-embedded systems (desktops and servers).

Prerequisites

Setting Up the Virtual Environment

  1. Create a Virtual Environment:

    python3 -m venv venv

  2. Activate the Virtual Environment:

    On macOS and Linux:

    source venv/bin/activate

    On Windows:

    .\venv\Scripts\activate

Get Source Script

Use git clone of this repository or copy program.py to your machine (non-embedded system).

Installing Dependencies

Install the required Python packages:

pip install requests pingparsing pyinstaller

Or install from requirements.txt

pip install -r requirements.txt

Testing the Script

To test the script, run the following command:

python3 program.py --isp "1.1.1.1" --base_url "https://monitoring.example.com/api/push/XXXXXX"

This example will ping the ISP server at 8.8.8.8 and send the results to the specified URL every 60 seconds.

python3 program.py --isp "8.8.8.8" --base_url "https://monitoring.example.com/api/push/XXXXXX" --interval 60

Building the Executable

To build the project into a standalone executable, use PyInstaller:

pyinstaller --onedir program.py

To build for Windows please run:

pyinstaller --onedir .\program.py --name uptime-kuma-agent_win_x64 --distpath .\release\win_x64\dist --workpath .\release\win_x64\build --specpath .\release\win_x64\

To build for Ubuntu please run:

pyinstaller --onedir program.py --name uptime-kuma-agent_linux_x64 --distpath release/linux_x64/dist --workpath release/linux_x64/build --specpath release/linux_x64

To build for Raspberry Pi please run:

pyinstaller --onedir program.py --name uptime-kuma-agent_linux_aarch64 --distpath release/linux_aarch64/dist --workpath release/linux_aarch64/build --specpath release/linux_aarch64

Deployment

Schedule executable using Windows Task Manager:

....

Schedule executable using crontab:

Use crontab to schedule the executable:

crontab -e

Enter the following line to run the script every minute:

* * * * * /root/program --isp "1.1.1.1" --base_url "https://monitoring.example.com/api/push/XXXXXX"

Schedule executable using Task Scheduler on Synology NAS:

...

Tested Systems

Project Setup and Usage on embedded systems

Below are instructions on how to use and deploy program.sh on a embedded system eg routers or IoT devices.

Prerequisites

Get Source Script

Use git clone of this repository or copy program.sh to your machine (embedded system).

Script Privileges

Run the following command to make the script executable privileges:

chmod +x program.sh

Verify Path

Open up program.sh in your editor of choice and verify that the log file path is correct. By default its /root/uptime-kuma-agent/log.txt

Testing the Script

To test the script, run the following command:

./program.sh --isp "100.0.0.1" --base_url "https://monitoring.example.com/api/push/XXXXXX"

Deployment

Use crontab to schedule the executable:

crontab -e

Enter the following line to run the script every minute:

* * * * * /root/uptime-kuma-agent/program.sh --isp "1.1.1.1" --base_url "https://monitoring.example.com/api/push/XXXXXX"

Tested Systems

Future Plans