# Uptime Kuma <a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/stars/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/pulls/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/v/louislam/uptime-kuma/latest?label=docker%20image%20ver." /></a> <a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/last-commit/louislam/uptime-kuma" /></a> <div align="center" width="100%"> <img src="./public/icon.svg" width="128" alt="" /> </div> It is a self-hosted monitoring tool like "Uptime Robot". <img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" /> ## β 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. ```bash curl -o kuma_install.sh https://raw.githubusercontent.com/louislam/uptime-kuma/master/install.sh && sudo bash kuma_install.sh ``` ### π³ Docker ```bash 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](kubernetes/README.md) ### 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: <img src="https://user-images.githubusercontent.com/1336778/128710166-908f8d88-9256-43f3-9c49-bfc2c56011d2.png" width="400" alt="" /> Settings Page: <img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" /> Telegram Notification Sample: <img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" /> ## 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.