mudhorn/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-09 23:24:07 -08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
736 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 9d41da4aa2
Merge pull request #311 from xinac721/master 
Chinese Translation (from zh-CN.js)
2021-09-02 15:59:06 +08:00
.github Create FUNDING.yml 2021-08-29 03:28:40 +08:00
data init 2021-06-25 21:55:49 +08:00
db Update patch7.sql 2021-08-29 18:58:05 +08:00
extra update language files 2021-09-01 20:10:54 +08:00
kubernetes changed domain names to example.com 2021-08-20 06:21:59 +00:00
public control search engine visibility 2021-08-09 18:16:27 +08:00
server revert back to node-sqlite3 2021-09-01 15:02:04 +08:00
src Chinese Translation (from zh-CN.js) 2021-09-02 15:34:46 +08:00
test/test_install_script wip: implementing install script 2021-08-19 02:04:49 +08:00
.dockerignore update .dockerignore 2021-08-03 20:42:32 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js no declare vars with comma, one line only one statement 2021-08-31 22:08:05 +08:00
.gitignore add retries for pinging function 2021-07-19 18:23:06 +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 revert back to node-sqlite3, as better-sqlite3 causes a lot of installation problems 2021-09-01 14:33:00 +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 revert back to node-sqlite3, as better-sqlite3 causes a lot of installation problems 2021-09-01 14:33:00 +08:00
package.json add language file preparation script 2021-09-01 17:08:27 +08:00
README.md Update README.md 2021-09-02 02:11:44 +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".

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

Contribute

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

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.