2021-07-01 11:00:23 +02:00
# Uptime Kuma
2021-07-11 08:20:31 +02:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-07-01 11:00:23 +02:00
# Features
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
2021-07-11 08:20:31 +02:00
* Notifications via Webhook, Telegram, Discord and email (SMTP).
2021-07-01 11:00:23 +02:00
* 20 seconds interval.
# How to Use
2021-07-11 10:02:06 +02:00
### Docker
```
docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma
```
2021-07-01 11:00:23 +02:00
2021-07-11 10:02:06 +02:00
Browse to http://localhost:3001 after started.
2021-07-01 11:00:23 +02:00
2021-07-11 10:02:06 +02:00
### Node.js >= 14 + GIT
```
git clone git@github.com:louislam/uptime-kuma.git
cd uptime-kuma
2021-07-11 12:51:53 +02:00
npm run setup
2021-07-11 10:02:06 +02:00
# 1. Try it
npm run start-server
# 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm -- run start-server
```
Browse to http://localhost:3001 after started.
### One-click Deploy to DigitalOcean
Coming Soon
2021-07-01 11:00:23 +02:00
# Motivation
2021-07-11 08:20:31 +02: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 11:00:23 +02: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 ⭐.
