https://github.com/k-cermak/uptimekumaprobe
A simple probe, for internal service health detection with API for Kuma Uptime.
https://github.com/k-cermak/uptimekumaprobe
api cli go golang monitoring monitoring-tool probe service-checker sqlite uptime uptime-check uptime-checker uptime-kuma uptime-monitor uptimekuma
Last synced: 6 days ago
JSON representation
A simple probe, for internal service health detection with API for Kuma Uptime.
- Host: GitHub
- URL: https://github.com/k-cermak/uptimekumaprobe
- Owner: K-cermak
- License: other
- Created: 2025-01-28T19:04:55.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2025-02-07T19:27:14.000Z (14 days ago)
- Last Synced: 2025-02-07T19:32:37.368Z (14 days ago)
- Topics: api, cli, go, golang, monitoring, monitoring-tool, probe, service-checker, sqlite, uptime, uptime-check, uptime-checker, uptime-kuma, uptime-monitor, uptimekuma
- Language: Go
- Homepage: https://karlosoft.com
- Size: 45.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Uptime Kuma Probe Extension
By Karel Cermak | [Karlosoft](https://karlosoft.com).
## Uptime Kuma Probe Extension
- Uptime Kuma is good at monitoring services and notifications, but it cannot connect through a VPN to the network and find out the status of internal services like Wi-Fi Access Points, Cameras and various other internal things.
- This Probe solves this - it can simply monitor devices inside the network and provide an API to the main Uptime Kuma instance. It is very simple to install, and does not affect the main Kuma Uptime in any way.
## How it works?
- Create a Linux server (ideally Ubuntu Server) in your internal network. There you will install this extension using [FAQ.md guide](FAQ.md). Then you configure the scans.
- In Uptime Kuma, you then set up a classic HTTP scan - the Probe API will return a certain response if the service works and another if it doesn't. Uptime Kuma will now get up-to-date information about the status of the service even if it does not have access to the network, but only to the API server.
## What can it do?
- Measure ICMP ping reachability with a timeout limit.
- Make an HTTP request with a timeout limit and check a certain status code and the keyword in the response.
- Simple editor for scan configuration and simple CLI interface.
- API server for the main Uptime Kuma instance.
## Can I use it without Uptime Kuma?
- Yes, you can use it as a simple monitoring tool. You can use the API to get the status of the services.
- But keep in mind that this app itself can't send notifications, nor will it ever (there is no plan to develop in this direction).
## How to start?
- You can find the installation guide in the [FAQ.md](FAQ.md) file. You can also find the uninstallation guide there and other useful information.
---
#### This project is not affiliated with Uptime Kuma. This is just a simple probe extension for monitoring tool Uptime Kuma. Developed by Karel Cermak ([email protected]).