mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-12 10:13:46 +02: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

Go to file

Louis Lam d2ccfd5366 Update README.md		2021-07-19 00:39:07 +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	reset auto increment for new users	2021-07-13 18:21:06 +08:00
extra	Fix Docker build	2021-07-18 13:51:44 +02:00
public	Merge pull request #66 from Saibamen/resize_apple_icon	2021-07-18 13:47:50 +08:00
server	improve testing notification response	2021-07-18 20:49:46 +08:00
src	Merge pull request #76 from Saibamen/fix_remember_me	2021-07-18 19:28:48 +08:00
.dockerignore	Update .dockerignore	2021-07-17 23:31:44 +02:00
.editorconfig	update .editorconfig	2021-07-13 10:31:31 +08:00
.gitignore	init	2021-06-24 21:42:23 +08:00
docker-compose.yml	add some comments and remove traefik-network from docker-composer.yml	2021-07-13 10:28:07 +08:00
dockerfile	add apprise support	2021-07-18 18:51:58 +08:00
index.html	Add description	2021-07-17 22:53:32 +02:00
LICENSE	Create LICENSE	2021-07-11 16:02:45 +08:00
package-lock.json	add apprise support	2021-07-18 18:51:58 +08:00
package.json	Merge branch 'update_packages'	2021-07-18 22:22:19 +08:00
README.md	Update README.md	2021-07-19 00:39:07 +08:00
vite.config.js	drop ie support when build the frontend	2021-07-13 18:34:09 +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

# Create a volume
docker volume create uptime-kuma

# Start the container
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma 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 --name uptime-kuma 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

# (Recommended) 
# 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

# Listen to different port or hostname
pm2 start npm --name uptime-kuma -- run start-server -- --port=80 --hostname=0.0.0.0

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

One-click Deploy to DigitalOcean

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.

PS: For every new release, it takes some time to build the docker image, please be patient if it is not available yet.

Without Docker

git fetch --all
git checkout 1.0.5 --force
npm install
npm run build
pm2 restart uptime-kuma

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

Contribute

If you want to report a bug or request a new featue. Free feel to open a new issue.

If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/wiki/%5BDev%5D-Setup-Development-Environment

English proofread is needed too, because my grammar is not that great sadly. Feel free to correct my grammar in this Readme, source code or wiki.