amanaryan / uptime-kuma

A fancy self-hosted monitoring tool

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Uptime Kuma

It is a self-hosted monitoring tool like "Uptime Robot".

⭐ Features

πŸ”§ 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.

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

About

A fancy self-hosted monitoring tool

License:MIT License


Languages

Language:JavaScript 50.1%Language:Vue 44.1%Language:Shell 2.1%Language:SCSS 2.0%Language:TypeScript 1.0%Language:Dockerfile 0.4%Language:HTML 0.2%Language:PowerShell 0.1%