2021-07-01 04:00:23 -05:00
# Uptime Kuma
2021-07-11 03:08:47 -05:00
< div align = "center" width = "100%" >
< img src = "./public/icon.svg" width = "128" alt = "" / >
< / div >
2021-07-11 01:20:31 -05:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-07-11 05:32:04 -05:00
< img src = "https://louislam.net/uptimekuma/1.jpg" width = "512" alt = "" / >
2021-07-01 04:00:23 -05:00
# Features
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
2021-07-11 01:20:31 -05:00
* Notifications via Webhook, Telegram, Discord and email (SMTP).
2021-07-01 04:00:23 -05:00
* 20 seconds interval.
# How to Use
2021-07-11 03:02:06 -05:00
### Docker
2021-07-11 05:32:04 -05:00
```bash
2021-07-11 03:02:06 -05:00
docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma
```
2021-07-01 04:00:23 -05:00
2021-07-11 03:02:06 -05:00
Browse to http://localhost:3001 after started.
2021-07-01 04:00:23 -05:00
2021-07-11 05:34:29 -05:00
### Without Docker
Required Tools: Node.js >= 14, git and pm2.
2021-07-11 05:32:04 -05:00
```bash
2021-07-11 05:44:47 -05:00
git clone https://github.com/louislam/uptime-kuma.git
2021-07-11 03:02:06 -05:00
cd uptime-kuma
2021-07-11 05:51:53 -05:00
npm run setup
2021-07-11 03:02:06 -05:00
2021-07-11 05:32:04 -05:00
# Option 1. Try it
2021-07-11 03:02:06 -05:00
npm run start-server
2021-07-11 05:32:04 -05:00
# (Recommanded)
# Option 2. Run in background using PM2
2021-07-11 03:02:06 -05:00
# Install PM2 if you don't have: npm install pm2 -g
2021-07-11 06:08:36 -05:00
pm2 start npm --name uptime-kuma -- run start-server
2021-07-11 03:02:06 -05:00
```
Browse to http://localhost:3001 after started.
### One-click Deploy to DigitalOcean
2021-07-11 07:46:09 -05:00
[![Deploy to DO ](https://www.deploytodo.com/do-btn-blue.svg )](https://cloud.digitalocean.com/apps/new?repo=https://github.com/louislam/uptime-kuma/tree/master& refcode=e2c7eb658434)
2021-07-01 04:00:23 -05:00
2021-07-11 05:32:04 -05:00
# More Screenshots
2021-07-11 07:12:37 -05:00
Settings Page:
2021-07-11 05:32:04 -05:00
< img src = "https://louislam.net/uptimekuma/2.jpg" width = "400" alt = "" / >
2021-07-11 07:12:37 -05:00
Telegram Notification Sample:
< img src = "https://louislam.net/uptimekuma/3.jpg" width = "400" alt = "" / >
2021-07-11 05:32:04 -05:00
2021-07-01 04:00:23 -05:00
# Motivation
2021-07-11 01:20:31 -05:00
* 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.
2021-07-01 04:00:23 -05:00
* 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 ⭐.