Infra-Mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-21 05:34:42 -05:00
Code Issues Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
72 Commits 31 Branches 117 Tags 103 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
763d7f2683
Go to file
Philipp Dormann 763d7f2683
Merge branch 'louislam:master' into master
2021-07-12 12:01:00 +02: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 Merge branch 'louislam:master' into master 2021-07-12 12:01:00 +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
dockerfile 🐳 move Dockerfile to base node:alpine image 2021-07-12 00:28:11 +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-lock.json implement discord 2021-07-10 11:38:00 +08:00
package.json ⏫ dependency bump + version pin 2021-07-12 00:25:22 +02:00
README.md Update README.md 2021-07-12 11:42:36 +08:00
vite.config.js add telegram notification 2021-07-09 14:14:03 +08:00
yarn.lock ⏫ dependency bump + version pin 2021-07-12 00:25:22 +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 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

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

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

One-click Deploy to DigitalOcean

Deploy to DO

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