mirror of
https://github.com/louislam/uptime-kuma.git
synced 2025-06-03 03:52:35 +02:00
128 lines
3.7 KiB
Markdown
128 lines
3.7 KiB
Markdown
# Uptime Kuma
|
|
|
|
<div align="center" width="100%">
|
|
<img src="./public/icon.svg" width="128" alt="" />
|
|
</div>
|
|
|
|
It is a self-hosted monitoring tool like "Uptime Robot".
|
|
|
|
[](https://github.com/philippdormann/uptime-kuma/actions/workflows/docker-image-tag.yml)
|
|
[](https://github.com/philippdormann/uptime-kuma/actions/workflows/docker-image-nightly.yml)
|
|
[](https://hub.docker.com/r/philippdormann/uptime/tags)
|
|
|
|
|
|
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
|
|
|
|
# Features
|
|
|
|
* Monitoring uptime for HTTP(s) / TCP / Ping.
|
|
* Fancy, Reactive, Fast UI/UX.
|
|
* Notifications via Webhook, Telegram, Discord and email (SMTP).
|
|
* 20 seconds interval.
|
|
|
|
# How to Use
|
|
|
|
## Docker
|
|
### docker-compose
|
|
see [sample docker-compose.yml](./docker-compose.yml)
|
|
|
|
### Manual
|
|
```bash
|
|
# Create a volume
|
|
docker volume create uptime
|
|
|
|
# Start the container
|
|
docker run -d --restart=always -p 50013:50013 -v uptime:/app/data --name uptime philippdormann/uptime
|
|
```
|
|
|
|
Browse to http://localhost:50013 after started.
|
|
|
|
Change Port and Volume
|
|
|
|
```bash
|
|
docker run -d --restart=always -p <YOUR_PORT>:50013 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime philippdormann/uptime
|
|
```
|
|
|
|
## Without Docker
|
|
|
|
Required Tools: Node.js >= 14, git and pm2.
|
|
|
|
```bash
|
|
git clone https://github.com/philippdormann/uptime-kuma.git uptime
|
|
cd uptime
|
|
npm run setup
|
|
|
|
# Option 1. Try it
|
|
npm run start-server
|
|
|
|
# (Recommended)
|
|
# Option 2. Run in background using PM2
|
|
# Install PM2 if you don't have: npm install pm2 -g
|
|
pm2 start npm --name uptime -- run start-server
|
|
|
|
# Listen to different port or hostname
|
|
pm2 start npm --name uptime -- run start-server -- --port=80 --hostname=0.0.0.0
|
|
|
|
```
|
|
|
|
Browse to http://localhost:50013 after started.
|
|
|
|
## Passing metrics to other platforms
|
|
|
|
If you already use [Prometheus.io](https://prometheus.io) or a platform that supports Prometheus exporter format, you can get the metrics about each monitoring target from `http://<your.installation>:<your_port>/metrics`.
|
|
|
|
Labels to filter by include:
|
|
|
|
| Label Name | Description |
|
|
---------|----------
|
|
|monitor_name| The "Friendly Name" of the monitor |
|
|
|monitor_type| The type (HTTP, keyword, TCP) of monitoring check |
|
|
|monitor_url | The URL to be monitored (HTTP, keyword)
|
|
|monitor_hostname | The Hostname to be monitored (TCP) |
|
|
|monitor_port | The port to be monitored (TCP) |
|
|
|
|
## One-click Deploy to DigitalOcean
|
|
|
|
[](https://cloud.digitalocean.com/apps/new?repo=https://github.com/philippdormann/uptime-kuma/tree/master)
|
|
|
|
Choose Cheapest Plan is enough. (US$ 5)
|
|
|
|
# How to Update
|
|
|
|
## Docker
|
|
|
|
Re-pull the latest docker image and create another container with the same volume.
|
|
|
|
## Without Docker
|
|
|
|
```bash
|
|
git fetch --all
|
|
git checkout 1.0.3 --force
|
|
npm install
|
|
npm run build
|
|
pm2 restart uptime-kuma
|
|
```
|
|
|
|
# More Screenshots
|
|
|
|
Settings Page:
|
|
|
|
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
|
|
|
|
Telegram Notification Sample:
|
|
|
|
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
|
|
|
|
|
|
# Motivation
|
|
|
|
* I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the close one is statping. Unfortunately, it is not stable and unmaintained.
|
|
* Want to build a fancy UI.
|
|
* Learn Vue 3 and vite.js.
|
|
* Show the power of Bootstrap 5.
|
|
* Try to use WebSocket with SPA instead of REST API.
|
|
* Deploy my first Docker image to Docker Hub.
|
|
|
|
|
|
If you love this project, please consider giving me a ⭐.
|
|
|