mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-23 23:04:04 +00:00

A fancy self-hosted monitoring tool

docker hacktoberfest monitor monitoring responsive self-hosted selfhosted single-page-app socket-io uptime uptime-monitoring webapp websocket

Find a file

LouisLam a9d19ae06a support json for keyword type		2021-07-12 10:52:41 +08:00
.do	the docker image to DO is not working at all, try git method	2021-07-11 22:12:14 +08:00
data	init	2021-06-25 21:55:49 +08:00
db	add setup page	2021-07-11 13:47:57 +08:00
public	add a icon	2021-06-27 17:31:39 +08:00
server	support json for keyword type	2021-07-12 10:52:41 +08:00
src	support json for keyword type	2021-07-12 10:52:41 +08:00
.dockerignore	prepare for docker	2021-07-11 14:20:31 +08:00
.editorconfig	fix	2021-07-11 21:18:00 +08:00
.gitignore	init	2021-06-24 21:42:23 +08:00
dockerfile	prepare for docker	2021-07-11 14:20:31 +08:00
index.html	add a icon	2021-06-27 17:31:39 +08:00
LICENSE	Create LICENSE	2021-07-11 16:02:45 +08:00
package-lock.json	implement discord	2021-07-10 11:38:00 +08:00
package.json	add back arm/v7 for build-docker	2021-07-12 01:18:02 +08:00
README.md	Update README.md	2021-07-11 23:41:21 +08:00
vite.config.js	add telegram notification	2021-07-09 14:14:03 +08:00

README.md

Uptime Kuma

It is a self-hosted monitoring tool like "Uptime Robot".

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 run -d --restart=always -p 3001:3001 louislam/uptime-kuma

Browse to http://localhost:3001 after started.

Change Port and Volume

docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data louislam/uptime-kuma

Without Docker

Required Tools: Node.js >= 14, git and pm2.

git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup

# Option 1. Try it
npm run start-server

# (Recommanded) 
# Option 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm --name uptime-kuma -- run start-server

Browse to http://localhost:3001 after started.

One-click Deploy to DigitalOcean

More Screenshots

Settings Page:

Telegram Notification Sample:

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 ⭐.