mudhorn/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-10 07:34:07 -08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
1155 commits 31 branches 115 tags 54 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
Find a file
Louis Lam b3a5a5b0ba
Merge pull request #462 from Saibamen/development_server 
`start-server-dev` command. Fixes #460
2021-09-23 21:04:23 +08:00
.github Missing this 2021-09-12 19:39:28 +02:00
data init 2021-06-25 21:55:49 +08:00
db [status page] fix wrong foreign key 2021-09-22 18:50:20 +08:00
extra fix reset-password (#448) 2021-09-20 16:29:18 +08:00
kubernetes Missing this 2021-09-12 19:39:28 +02:00
public Simple "Add to Homescreen" manifest (PWA) (#411) 2021-09-16 14:42:56 +08:00
server start-server-dev. Fixes #460 2021-09-23 12:45:30 +02:00
src Merge pull request #124 from chakflying/public-dashboard 2021-09-23 16:54:07 +08:00
test test nodejs 16 2021-09-17 15:19:19 +08:00
.dockerignore Merge branch 'master' into public-dashboard 2021-09-19 15:16:13 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js [status page] many update and save group list 2021-09-19 19:04:51 +08:00
.gitignore update ignore files and delete demo db 2021-09-16 00:12:39 +08:00
.stylelintrc manual fix stylelint 2021-08-25 12:25:19 +08:00
CNAME Create CNAME 2021-08-29 19:15:40 +08:00
CODE_OF_CONDUCT.md Missing this 2021-09-12 19:44:33 +02:00
CONTRIBUTING.md Own files for i18n and router + fix some of markdown warnings 2021-09-12 19:23:51 +02:00
docker-compose.yml add some comments and remove traefik-network from docker-composer.yml 2021-07-13 10:28:07 +08:00
dockerfile no need to build sqlite and add nightly for alpine 2021-09-21 10:47:55 +08:00
dockerfile-alpine no need to build sqlite and add nightly for alpine 2021-09-21 10:47:55 +08:00
index.html Simple "Add to Homescreen" manifest (PWA) (#411) 2021-09-16 14:42:56 +08:00
install.sh fix install script 2021-09-01 14:56:19 +08:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json [status page] send uptime 2021-09-22 15:10:08 +08:00
package.json Install cross-env as dev dependency for now 2021-09-23 12:49:15 +02:00
README.md update discussion 2021-09-17 00:48:04 +08:00
SECURITY.md Update SECURITY.md 2021-09-15 01:17:33 +08:00
tsconfig.json removeComments to false 2021-09-21 00:48:26 +02:00
vite.config.js ESLint vite.config.js 2021-08-08 18:24:05 +02:00

README.md

Uptime Kuma

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

🥔 Live Demo

Try it!

https://demo.uptime.kuma.pet

It is a 5 minutes live demo, all data will be deleted after that. The server is located at Tokyo, if you live far away from here, it may affact your experience. I suggest that you should install to try it.

VPS is sponsored by Uptime Kuma sponsors on Open Collective! Thank you so much!

⭐ Features

🔧 How to Install

🐳 Docker

docker volume create uptime-kuma
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

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

💪🏻 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
node server/server.js

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

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

Advanced Installation

If you need more options or need to browse via a reserve proxy, please read:

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install

🆙 How to Update

Please read:

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update

🆕 What's Next?

I will mark requests/issues to the next milestone.

https://github.com/louislam/uptime-kuma/milestones

Project Plan:

https://github.com/louislam/uptime-kuma/projects/1

🖼 More Screenshots

Dark Mode:

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

🗣️ Discussion

Issues Page

You can discuss or ask for help in Issues.

Subreddit

My Reddit account: louislamlam You can mention me if you ask question on Reddit. https://www.reddit.com/r/UptimeKuma/

Contribute

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

If you want to translate Uptime Kuma into your langauge, please read: https://github.com/louislam/uptime-kuma/tree/master/src/languages

If you want to modify Uptime Kuma, this guideline may be useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md

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