uptime-kuma/README.md

117 lines
3.9 KiB
Markdown
Raw Normal View History

2021-07-01 05:00:23 -04:00
# Uptime Kuma
2021-07-13 13:39:04 -04: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 13:36:25 -04:00
2021-07-11 04:08:47 -04:00
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
2021-07-11 02:20:31 -04:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-07-11 06:32:04 -04:00
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
2021-09-02 14:55:36 -04:00
## 🥔 Live Demo
Try it!
https://demo.uptime.kuma.pet
It is a 5 minutes live demo, all data will be deleted after that. The server is located at Tokyo, if you live far away from here, it may affact your experience. I suggest that you should install to try it.
2021-09-03 03:16:54 -04:00
VPS is sponsored by Uptime Kuma sponsors on [Open Collective](https://opencollective.com/uptime-kuma)! Thank you so much!
2021-09-02 14:55:36 -04:00
2021-08-15 13:38:37 -04:00
## ⭐ Features
2021-07-01 05:00:23 -04:00
2021-08-28 00:32:35 -04:00
* Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record.
2021-07-01 05:00:23 -04:00
* Fancy, Reactive, Fast UI/UX.
2021-08-28 07:10:32 -04:00
* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [70+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/issues/284).
2021-07-01 05:00:23 -04:00
* 20 seconds interval.
2021-09-07 05:44:51 -04:00
* [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/languages)
2021-07-01 05:00:23 -04:00
2021-08-15 13:38:37 -04:00
## 🔧 How to Install
2021-07-01 05:00:23 -04:00
2021-08-30 09:56:33 -04:00
### 🐳 Docker
2021-07-12 08:08:51 -04:00
2021-08-19 02:13:30 -04:00
```bash
2021-08-30 09:56:33 -04:00
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
2021-07-11 04:02:06 -04:00
```
2021-07-11 06:34:29 -04:00
2021-08-30 09:56:33 -04:00
Browse to http://localhost:3001 after started.
### 💪🏻 Without Docker
Required Tools: Node.js >= 14, git and pm2.
2021-07-11 06:34:29 -04:00
2021-07-11 06:32:04 -04:00
```bash
2021-08-30 09:56:33 -04:00
git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup
# Option 1. Try it
node server/server.js
# (Recommended) Option 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start server/server.js --name uptime-kuma
2021-08-08 11:51:23 -04:00
```
2021-08-19 05:55:43 -04:00
Browse to http://localhost:3001 after started.
2021-08-19 02:13:30 -04:00
### Advanced Installation
2021-07-12 06:59:48 -04:00
2021-08-19 02:13:30 -04:00
If you need more options or need to browse via a reserve proxy, please read:
2021-07-12 06:59:48 -04:00
2021-08-19 02:13:30 -04:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
2021-08-08 12:24:30 -04:00
2021-08-04 03:19:06 -04:00
2021-08-19 02:13:30 -04:00
## 🆙 How to Update
2021-07-13 13:48:55 -04:00
2021-08-19 02:13:30 -04:00
Please read:
2021-07-12 06:59:48 -04:00
2021-08-19 02:13:30 -04:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
2021-07-12 06:59:48 -04:00
2021-08-15 13:38:37 -04:00
## 🆕 What's Next?
2021-07-20 08:27:15 -04:00
2021-07-30 03:04:52 -04:00
I will mark requests/issues to the next milestone.
2021-08-19 02:13:30 -04:00
2021-07-20 08:27:15 -04:00
https://github.com/louislam/uptime-kuma/milestones
2021-09-01 14:11:44 -04:00
Project Plan:
https://github.com/louislam/uptime-kuma/projects/1
2021-08-15 13:38:37 -04:00
## 🖼 More Screenshots
2021-07-11 06:32:04 -04:00
2021-08-09 10:31:32 -04:00
Dark Mode:
<img src="https://user-images.githubusercontent.com/1336778/128710166-908f8d88-9256-43f3-9c49-bfc2c56011d2.png" width="400" alt="" />
2021-07-11 08:12:37 -04:00
Settings Page:
2021-07-11 06:32:04 -04:00
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
2021-07-11 08:12:37 -04:00
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
2021-08-08 12:24:30 -04:00
## Motivation
2021-07-01 05:00:23 -04:00
2021-08-28 07:10:32 -04: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 ones is statping. Unfortunately, it is not stable and unmaintained.
2021-07-01 05:00:23 -04:00
* Want to build a fancy UI.
* Learn Vue 3 and vite.js.
2021-07-30 03:04:52 -04:00
* Show the power of Bootstrap 5.
2021-07-01 05:00:23 -04: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 12:24:30 -04:00
## Contribute
2021-07-18 12:34:48 -04:00
2021-07-20 01:04:21 -04:00
If you want to report a bug or request a new feature. Free feel to open a new issue.
2021-07-18 12:34:48 -04:00
2021-08-28 07:10:32 -04:00
If you want to modify Uptime Kuma, this guideline may be useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md
2021-07-18 12:34:48 -04:00
2021-08-28 07:10:32 -04: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.