Skip to content

Commit

Permalink
Add bold to readme, start of faq
Browse files Browse the repository at this point in the history
  • Loading branch information
K-cermak committed Feb 8, 2025
1 parent 1da9b88 commit e118fb1
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 10 deletions.
73 changes: 72 additions & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
@@ -1 +1,72 @@
# TODO
# FaQ Guide
- [Installation](#installation)
- [Editor](#editor)
- [Creating a scan, setup cron](#creating-a-scan-setup-cron)
- [API, Reverse proxy](#api-reverse-proxy)
- [Connect to Uptime Kuma](#connect-to-uptime-kuma)
- [All commands](#all-commands)
- [Uninstallation](#uninstallation)

<br>

## Installation
- Ideally, create a virtual server or specify the physical hardware where the service will run. Recommended requirements are 1 GB RAM and 1 CPU core and 1 GB free space for the database (more if you have a large number of scans or want to keep records for a longer number of days).
- We recommend using Ubuntu Server in the latest LTS release, but it is not a problem to use other distributions - it is just that this project has not been tested on them. The distribution must necessarily support systemctl.

<br>

- First, install Git and clone the repository.

```
sudo apt update
sudo apt install git
git clone https://github.com/K-cermak/UptimeKumaProbe
```

- Open the `UptimeKumaProbe` directory and run the installation script. App will be installed in `/opt/kprobe` directory, API is installed as a service and will start on boot.

```
cd UptimeKumaProbe/scripts
sudo ./install.sh
```

- If the last command fails, try run: `chmod +x install.sh`.

> [!NOTE]
> You can now remove the `UptimeKumaProbe` directory.







## Editor

## Creating a scan, setup cron

## API, Reverse proxy

## Connect to Uptime Kuma

## All commands

## Uninstallation

- 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
```


- Run the uninstall script:

```
cd UptimeKumaProbe/scripts
sudo ./uninstall.sh
```

- If the last command fails, try run:
```chmod +x uninstall.sh```
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,34 @@ 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. 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.
- <b>Uptime Kuma is good at monitoring services and notifications, but it cannot connect through a VPN to the network</b> and find out the status of internal services like Wi-Fi Access Points, Cameras and various other internal things.
- <b>This Probe solves this</b> - it can simply <b>monitor devices inside the network and provide an API to the main Uptime Kuma instance</b>. It is very <b>simple to install</b>, and does not affect the main Kuma Uptime in any way.

<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.
- In Uptime Kuma, you then set up a <b>classic HTTP scan</b> - 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 <b>status of the service even if it does not have access to the network</b>, but only to the API server.

<br>


## 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
- Measure <b>ICMP ping</b> reachability with a timeout limit.
- Make an <b>HTTP request</b> with a timeout limit and check a <b>certain status code</b> and the <b>keyword in the response</b>.
- Simple <b>editor for scan configuration</b> and simple <b>CLI interface</b>.
- <b>API server</b> for the main Uptime Kuma instance.

<br>

## 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.
- Yes, you can use it as a <b>simple monitoring tool</b>. 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).

<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.
- You can find the <b>installation guide<b> in the [FAQ.md](FAQ.md) file. You can also find the uninstallation guide there and other useful information.


<br>
Expand Down

0 comments on commit e118fb1

Please sign in to comment.