Infra-Mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-24 14:59:39 -05:00
Code Issues Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
640 Commits 31 Branches 117 Tags 107 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
bb799163e8
Go to file
Tristan bb799163e8
French Translation (from zh-HK.js)
2021-08-30 11:11:22 +02:00
.github/ISSUE_TEMPLATE Update ask-for-help.md 2021-08-17 01:32:42 +08:00
data init 2021-06-25 21:55:49 +08:00
db Feat: Implement MaxRedirects & StatusCodes 2021-08-05 19:04:38 +08:00
extra change to pm2 start server/server.js directly due to (#273) 2021-08-26 22:55:44 +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 Merge pull request #264 from antiseptikk/master 2021-08-26 23:34:07 +08:00
src French Translation (from zh-HK.js) 2021-08-30 11:11:22 +02: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 eslint: camelcase rule do not check properties, because it could be database field name 2021-08-25 01:25:57 +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
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-08-01 00:35:47 +08:00
CONTRIBUTING.md clarify pull request rule 2021-08-24 14:42:35 +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 Dockerfile: Avoid keeping npm in RAM 2021-08-26 12:53:57 +03:00
index.html also change meta tag theme-color 2021-08-13 00:23:40 +08:00
install.sh change to pm2 start server/server.js directly due to (#273) 2021-08-26 22:55:44 +08:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json update stylelint 2021-08-24 23:22:04 +08:00
package.json run stylelint for the project 2021-08-24 23:38:25 +08:00
README.md add mit license badge in readme 2021-08-24 13:38:21 +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

  • Monitoring uptime for HTTP(s) / TCP / Ping.
  • Fancy, Reactive, Fast UI/UX.
  • Notifications via Webhook, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP) and more by Apprise.
  • 20 seconds interval.

🔧 How to Install

🚀 Installer via cli

Interactive cli installer, supports Docker or without Docker.

curl -o kuma_install.sh https://raw.githubusercontent.com/louislam/uptime-kuma/master/install.sh && sudo bash kuma_install.sh

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

☸️ Kubernetes

See more here

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

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

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