ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-27 16:54:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
A fancy self-hosted monitoring tool
93 commits 30 branches 115 tags 66 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
Find a file
Philipp Dormann 010302395f
clean, multistage Dockerfile
2021-07-12 22:11:47 +02: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 Merge remote-tracking branch 'theguydanish/master' 2021-07-12 21:58:13 +02:00
src Merge remote-tracking branch 'theguydanish/master' 2021-07-12 21:58:13 +02: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
docker-compose.debug.yml 🐳 Docker 2021-07-12 21:50:39 +02:00
docker-compose.yml 🐳 Docker 2021-07-12 21:50:39 +02:00
Dockerfile clean, multistage Dockerfile 2021-07-12 22:11:47 +02: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.json ⏫ dependency bumps 2021-07-12 22:09:27 +02:00
README.md README: add sample docker-compose link 2021-07-12 21:53:49 +02:00
vite.config.js add telegram notification 2021-07-09 14:14:03 +08:00
yarn.lock ⏫ dependency bumps 2021-07-12 22:09:27 +02: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-compose

see sample docker-compose.yml

Manual

# Create a volume
docker volume create uptime-kuma

# Start the container
docker run -d --restart=always -p 50013:50013 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma

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

Change Port and Volume

docker run -d --restart=always -p <YOUR_PORT>:50013 -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:50013 after started.

One-click Deploy to DigitalOcean

Deploy to DO

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

git fetch --all
git checkout 1.0.1 --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 ⭐.