mudhorn/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-27 14:39:51 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
560 commits 31 branches 117 tags 70 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
Find a file
Carl Sander 22047fe932 removed doubled names of ressources
2021-08-19 11:50:05 +00: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 install.sh - check docker is running 2021-08-19 12:47:11 +08:00
kubernetes removed doubled names of ressources 2021-08-19 11:50:05 +00:00
public control search engine visibility 2021-08-09 18:16:27 +08:00
server Added Line Messenger Notification Service 2021-08-17 13:41:36 +02:00
src Fix: Reduce chart padding on mobile 2021-08-18 17:04:13 +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 improve space-before-function-paren 2021-08-10 21:59:15 +08:00
.gitignore add retries for pinging function 2021-07-19 18:23:06 +02:00
.stylelintrc minor 2021-08-16 20:40:16 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-08-01 00:35:47 +08:00
CONTRIBUTING.md Create CONTRIBUTING.md 2021-08-01 00:29:30 +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 update to 1.1.0 2021-08-09 21:03:30 +08:00
index.html also change meta tag theme-color 2021-08-13 00:23:40 +08:00
install.sh install.sh - check docker is running 2021-08-19 12:47:11 +08:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json wip: implementing install script 2021-08-19 02:04:49 +08:00
package.json wip: implementing install script 2021-08-19 02:04:49 +08:00
README.md fixed README 2021-08-19 09:55:43 +00:00
SECURITY.md Create SECURITY.md 2021-08-19 17:32:57 +08:00
tsconfig.json code re-use and eslint 2021-08-09 13:49:37 +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

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

If you want to change port and volume, or need to browse via a reserve proxy, please read wiki.

💪🏻 Without Docker (Recommended for x86/x64 only)

Required Tools: Node.js >= 14, git and pm2.

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