-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,45 @@ | ||
| # Uptime Kuma Probe Extension | ||
|
|
||
| ### TODO Text | ||
| By Karel Cermak | [Karlosoft](https://karlosoft.com). | ||
|
|
||
| <img src="https://cdn.karlosoft.com/cdn-data/ks/img/kprobe/github.png" width="700" alt="Uptime Kuma Probe Extension"> | ||
|
|
||
| ### Installation | ||
|
|
||
| ``` | ||
| sudo apt update | ||
| sudo apt install git | ||
|
|
||
| git clone https://github.com/K-cermak/UptimeKumaProbe | ||
| ## 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. You don't even need to use a VPN. | ||
| - 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. | ||
|
|
||
| cd UptimeKumaProbe/scripts | ||
| sudo ./install.sh | ||
| ``` | ||
| <br> | ||
|
|
||
| ## 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. | ||
|
|
||
| - If the last command fails, try run: | ||
| ```chmod +x install.sh``` | ||
| <br> | ||
|
|
||
| - Tip: You can now remove the `UptimeKumaProbe` directory. | ||
| - App is installed in `/opt/kprobe`, API is installed as a service and will start on boot. | ||
|
|
||
| ## 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 word in the response. | ||
| - Simple editor for scan configuration and simple CLI interface. | ||
| - API server for the main Uptime Kuma instance | ||
|
|
||
| <br> | ||
|
|
||
| ### Uninstallation | ||
| ## 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). | ||
|
|
||
| - If you have removed the `UptimeKumaProbe` directory (cloned Git repository), clone it again or download the [`uninstall.sh`](scripts/uninstall.sh) script. | ||
| ``` | ||
| git clone https://github.com/K-cermak/UptimeKumaProbe | ||
| ``` | ||
| <br> | ||
|
|
||
| ## 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. | ||
|
|
||
| - Run the uninstall script: | ||
|
|
||
| ``` | ||
| cd UptimeKumaProbe/scripts | ||
| sudo ./uninstall.sh | ||
| ``` | ||
| <br> | ||
| <br> | ||
|
|
||
| --- | ||
|
|
||
| - If the last command fails, try run: | ||
| ```chmod +x uninstall.sh``` | ||
| #### 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]). |