mudhorn/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-28 23:19:44 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
944 commits 31 branches 117 tags 71 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
Find a file
Bert Verhelst 471333ad03 fix(util-frontend): revert typescript conversion
2021-09-12 18:56:39 +02:00
.github Update bug_report.md 2021-09-11 13:44:06 +08:00
data init 2021-06-25 21:55:49 +08:00
db add a better approach for patching db, change setting.value from varchar to TEXT, restore Database.close() to 1.2.0 2021-09-10 17:23:45 +08:00
extra add a healthcheck comment 2021-09-10 21:17:20 +08:00
kubernetes Update deployment.yml 2021-09-10 22:32:11 +08:00
public control search engine visibility 2021-08-09 18:16:27 +08:00
server add a better approach for patching db, change setting.value from varchar to TEXT, restore Database.close() to 1.2.0 2021-09-10 17:23:45 +08:00
src fix(util-frontend): revert typescript conversion 2021-09-12 18:56:39 +02:00
test/test_install_script wip: implementing install script 2021-08-19 02:04:49 +08:00
.dockerignore update .dockerignore 2021-09-09 11:41:43 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js convert notifications into modules 2021-09-07 22:42:46 +08:00
.gitignore Move timezones to npm package and convert util-frontend.js to typescript 2021-09-12 13:27:41 +02: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 Create CODE_OF_CONDUCT.md 2021-08-01 00:35:47 +08:00
CONTRIBUTING.md fix npm7 broken dependencies 2021-08-31 20:36:17 +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 change to node:14-bullseye-slim, and reduce the docker image size 2021-09-11 02:50:29 +08:00
dockerfile-alpine change to node:14-bullseye-slim, and reduce the docker image size 2021-09-11 02:50:29 +08:00
index.html also change meta tag theme-color 2021-08-13 00:23:40 +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 fix(util-frontend): revert typescript conversion 2021-09-12 18:56:39 +02:00
package.json Move timezones to npm package and convert util-frontend.js to typescript 2021-09-12 13:27:41 +02:00
README.md Update README.md 2021-09-09 22:58:31 +08:00
SECURITY.md Create SECURITY.md 2021-08-19 17:32:57 +08:00
tsconfig.json Fix: fix typescript errors 2021-08-23 11:33:24 +08: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

You can also discuss or ask for help in Issues.

Alternatively, you can discuss in my original post on reddit: https://www.reddit.com/r/selfhosted/comments/oi7dc7/uptime_kuma_a_fancy_selfhosted_monitoring_tool_an/

I think the real "Discussion" tab is hard to use, as it is reddit-like flow, I always missed new comments.

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.