uptime-kuma/README.md

95 lines
3.2 KiB
Markdown
Raw Normal View History

2021-07-01 09:00:23 +00:00
# Uptime Kuma
2021-07-13 17:39:04 +00:00
<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>
2021-07-13 17:36:25 +00:00
2021-07-11 08:08:47 +00:00
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
2021-07-11 06:20:31 +00:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-07-11 10:32:04 +00:00
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
2021-08-15 17:38:37 +00:00
## ⭐ Features
2021-07-01 09:00:23 +00:00
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
2021-07-30 07:04:52 +00:00
* Notifications via Webhook, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP) and more by Apprise.
2021-07-01 09:00:23 +00:00
* 20 seconds interval.
2021-08-15 17:38:37 +00:00
## 🔧 How to Install
2021-07-01 09:00:23 +00:00
2021-08-19 06:13:30 +00:00
### 🚀 Installer via cli
2021-07-14 09:10:51 +00:00
2021-08-19 06:13:30 +00:00
Interactive cli installer, supports Docker or without Docker.
2021-07-12 12:08:51 +00:00
2021-08-19 06:13:30 +00:00
```bash
curl -o kuma_install.sh https://raw.githubusercontent.com/louislam/uptime-kuma/master/install.sh && sudo bash kuma_install.sh
2021-07-11 08:02:06 +00:00
```
2021-07-11 10:34:29 +00:00
2021-08-19 06:13:30 +00:00
### 🐳 Docker
2021-07-11 10:34:29 +00:00
2021-07-11 10:32:04 +00:00
```bash
2021-08-19 06:13:30 +00:00
docker volume create uptime-kuma
2021-08-21 18:09:16 +00:00
docker run -d --restart=always -p 3001.3.11 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
2021-08-08 15:51:23 +00:00
```
2021-08-19 09:55:43 +00:00
Browse to http://localhost:3001 after started.
2021-08-19 09:50:27 +00:00
### ☸️ Kubernetes
2021-07-11 08:02:06 +00:00
2021-08-19 09:50:27 +00:00
See more [here](kubernetes/README.md)
2021-07-31 16:23:40 +00:00
2021-07-31 16:15:33 +00:00
2021-08-19 06:13:30 +00:00
### Advanced Installation
2021-07-12 10:59:48 +00:00
2021-08-19 06:13:30 +00:00
If you need more options or need to browse via a reserve proxy, please read:
2021-07-12 10:59:48 +00:00
2021-08-19 06:13:30 +00:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
2021-08-08 16:24:30 +00:00
2021-08-04 07:19:06 +00:00
2021-08-19 06:13:30 +00:00
## 🆙 How to Update
2021-07-13 17:48:55 +00:00
2021-08-19 06:13:30 +00:00
Please read:
2021-07-12 10:59:48 +00:00
2021-08-19 06:13:30 +00:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
2021-07-12 10:59:48 +00:00
2021-08-15 17:38:37 +00:00
## 🆕 What's Next?
2021-07-20 12:27:15 +00:00
2021-07-30 07:04:52 +00:00
I will mark requests/issues to the next milestone.
2021-08-19 06:13:30 +00:00
2021-07-20 12:27:15 +00:00
https://github.com/louislam/uptime-kuma/milestones
2021-08-15 17:38:37 +00:00
## 🖼 More Screenshots
2021-07-11 10:32:04 +00:00
2021-08-09 14:31:32 +00:00
Dark Mode:
<img src="https://user-images.githubusercontent.com/1336778/128710166-908f8d88-9256-43f3-9c49-bfc2c56011d2.png" width="400" alt="" />
2021-07-11 12:12:37 +00:00
Settings Page:
2021-07-11 10:32:04 +00:00
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
2021-07-11 12:12:37 +00:00
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
2021-08-08 16:24:30 +00:00
## Motivation
2021-07-01 09:00:23 +00:00
2021-07-30 07:04:52 +00:00
* 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.
2021-07-01 09:00:23 +00:00
* Want to build a fancy UI.
* Learn Vue 3 and vite.js.
2021-07-30 07:04:52 +00:00
* Show the power of Bootstrap 5.
2021-07-01 09:00:23 +00:00
* 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 ⭐.
2021-08-08 16:24:30 +00:00
## Contribute
2021-07-18 16:34:48 +00:00
2021-07-20 05:04:21 +00:00
If you want to report a bug or request a new feature. Free feel to open a new issue.
2021-07-18 16:34:48 +00:00
2021-08-01 03:11:04 +00:00
If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md
2021-07-18 16:34:48 +00:00
2021-07-18 16:40:10 +00:00
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.