mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-23 18:06:14 +03:00
Code Issues Projects Releases Packages Wiki Activity
A fancy self-hosted monitoring tool
1580 commits 30 branches 115 tags 62 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
Find a file
Louis Lam cb43ecb46e Merge branch 'master' into background-jobs 
# Conflicts:
#	package-lock.json
#	package.json
#	src/languages/en.js
2021-10-16 15:06:59 +08:00
.github Fix some of markdownlint warnings 2021-10-13 02:01:34 +02:00
config move jest config files to config dir 2021-10-13 02:53:59 +08:00
data init 2021-06-25 21:55:49 +08:00
db feat(http-requests): add support for methods, body and headers for http 2021-10-02 16:48:27 +02:00
docker move dockerfile, docker-compose.yml to docker folder 2021-10-13 02:32:02 +08:00
extra [test] update 2021-10-16 13:02:04 +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 Merge branch 'master' into background-jobs 2021-10-16 15:06:59 +08:00
src Merge branch 'master' into background-jobs 2021-10-16 15:06:59 +08:00
test [test] jest please 2021-10-16 14:54:45 +08:00
.dockerignore Merge branch 'no-need-build' 2021-10-10 16:34:13 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js setup jest-puppeteer 2021-10-03 18:16:55 +08:00
.gitignore ignore .env 2021-10-07 14:34:30 +08:00
.stylelintrc manual fix stylelint 2021-08-25 12:25:19 +08:00
babel.config.js move jest config files to config dir 2021-10-13 02:53:59 +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 Fix some of markdownlint warnings 2021-10-13 02:01:34 +02:00
ecosystem.config.js Create PM2 Config file 2021-10-11 15:22:52 +03: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 Fix encoding problem of ping result for non-English Windows 2021-10-14 00:22:49 +08:00
package.json Merge branch 'master' into background-jobs 2021-10-16 15:06:59 +08:00
README.md Fix some of markdownlint warnings 2021-10-13 02:01:34 +02:00
SECURITY.md Update SECURITY.md 2021-10-15 19:44:29 +08:00
tsconfig.json set newLine to LF for ts compiler 2021-10-13 22:31:36 +08: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 10 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.

# Update your npm to the latest version
npm install npm -g

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

Light Mode:

Status Page:

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.