uptime-kuma/README.md

174 lines
5.9 KiB
Markdown
Raw Normal View History

2021-07-01 02:00:23 -07:00
# Uptime Kuma
2021-10-26 19:11:08 -07: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> <a target="_blank" href="https://opencollective.com/uptime-kuma"><img src="https://opencollective.com/uptime-kuma/total/badge.svg?label=Open%20Collective%20Backers&color=brightgreen" /></a>
[![GitHub Sponsors](https://img.shields.io/github/sponsors/louislam?label=GitHub%20Sponsors)](https://github.com/sponsors/louislam)
2021-09-30 11:38:41 -07:00
2021-07-11 01:08:47 -07:00
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
2021-07-10 23:20:31 -07:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-10-07 07:33:39 -07:00
<img src="https://uptime.kuma.pet/img/dark.jpg" width="700" alt="" />
2021-07-11 03:32:04 -07:00
2021-09-02 11:55:36 -07:00
## 🥔 Live Demo
Try it!
https://demo.uptime.kuma.pet
2021-12-02 02:09:27 -08:00
It is a temporary live demo, all data will be deleted after 10 minutes. The server is located in Tokyo, so if you live far from there, it may affect your experience. I suggest that you should install and try it out for the best demo experience.
2021-09-02 11:55:36 -07:00
2021-09-03 00:16:54 -07:00
VPS is sponsored by Uptime Kuma sponsors on [Open Collective](https://opencollective.com/uptime-kuma)! Thank you so much!
2021-09-02 11:55:36 -07:00
2021-08-15 10:38:37 -07:00
## ⭐ Features
2021-07-01 02:00:23 -07:00
* Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server / Docker Containers.
2021-07-01 02:00:23 -07:00
* Fancy, Reactive, Fast UI/UX.
2022-04-22 00:59:34 -07:00
* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications).
* 20 second intervals.
2021-09-07 02:44:51 -07:00
* [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/languages)
2022-04-23 10:29:34 -07:00
* Multiple Status Pages
* Map Status Page to Domain
2021-10-11 04:40:51 -07:00
* Ping Chart
2021-10-11 20:15:02 -07:00
* Certificate Info
2022-04-23 10:29:34 -07:00
* Proxy Support
* 2FA available
2021-07-01 02:00:23 -07:00
2021-08-15 10:38:37 -07:00
## 🔧 How to Install
2021-07-01 02:00:23 -07:00
2021-08-30 06:56:33 -07:00
### 🐳 Docker
2021-07-12 05:08:51 -07:00
2021-08-18 23:13:30 -07:00
```bash
2021-08-30 06:56:33 -07:00
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
2021-07-11 01:02:06 -07:00
```
2021-07-11 03:34:29 -07:00
2021-12-07 23:25:43 -08:00
⚠️ Please use a **local volume** only. Other types such as NFS are not supported.
Browse to http://localhost:3001 after starting.
2021-08-30 06:56:33 -07:00
2021-10-26 09:07:17 -07:00
### 💪🏻 Non-Docker
2021-08-30 06:56:33 -07:00
2022-04-05 22:18:12 -07:00
Required Tools:
- [Node.js](https://nodejs.org/en/download/) >= 14
- [Git](https://git-scm.com/downloads)
- [pm2](https://pm2.keymetrics.io/) - For run in background
2021-07-11 03:34:29 -07:00
2021-07-11 03:32:04 -07:00
```bash
2021-09-24 07:38:54 -07:00
# Update your npm to the latest version
npm install npm -g
2021-08-30 06:56:33 -07: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
2022-03-22 20:17:23 -07:00
# Install PM2 if you don't have it:
npm install pm2 -g && pm2 install pm2-logrotate
# Start Server
2021-08-30 06:56:33 -07:00
pm2 start server/server.js --name uptime-kuma
2022-03-22 20:17:23 -07:00
2022-04-05 22:18:12 -07:00
```
Browse to http://localhost:3001 after starting.
More useful PM2 Commands
```bash
2022-03-22 20:17:23 -07:00
# If you want to see the current console output
pm2 monit
2021-08-08 08:51:23 -07:00
2022-04-05 22:18:12 -07:00
# If you want to add it to startup
pm2 save && pm2 startup
```
2021-08-19 02:55:43 -07:00
2021-08-18 23:13:30 -07:00
### Advanced Installation
2021-07-12 03:59:48 -07:00
2021-12-01 01:43:58 -08:00
If you need more options or need to browse via a reverse proxy, please read:
2021-07-12 03:59:48 -07:00
2021-08-18 23:13:30 -07:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
2021-08-08 09:24:30 -07:00
2021-08-18 23:13:30 -07:00
## 🆙 How to Update
2021-07-13 10:48:55 -07:00
2021-08-18 23:13:30 -07:00
Please read:
2021-07-12 03:59:48 -07:00
2021-08-18 23:13:30 -07:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
2021-07-12 03:59:48 -07:00
2021-08-15 10:38:37 -07:00
## 🆕 What's Next?
2021-07-20 05:27:15 -07:00
2021-07-30 00:04:52 -07:00
I will mark requests/issues to the next milestone.
2021-08-18 23:13:30 -07:00
2021-07-20 05:27:15 -07:00
https://github.com/louislam/uptime-kuma/milestones
2021-09-01 11:11:44 -07:00
Project Plan:
https://github.com/louislam/uptime-kuma/projects/1
2021-12-14 10:46:13 -08:00
## ❤️ Sponsors
Thank you so much! (GitHub Sponsors will be updated manually. OpenCollective sponsors will be updated automatically, the list will be cached by GitHub though. It may need some time to be updated)
2022-04-01 08:22:15 -07:00
<img src="https://uptime.kuma.pet/sponsors?v=6" alt />
2021-12-14 10:46:13 -08:00
2021-08-15 10:38:37 -07:00
## 🖼 More Screenshots
2021-07-11 03:32:04 -07:00
2021-10-07 07:33:39 -07:00
Light Mode:
2021-08-09 07:31:32 -07:00
2021-10-07 07:33:39 -07:00
<img src="https://uptime.kuma.pet/img/light.jpg" width="512" alt="" />
Status Page:
2021-10-09 01:54:26 -07:00
<img src="https://user-images.githubusercontent.com/1336778/134628766-a3fe0981-0926-4285-ab46-891a21c3e4cb.png" width="512" alt="" />
2021-08-09 07:31:32 -07:00
2021-07-11 05:12:37 -07:00
Settings Page:
2021-07-11 03:32:04 -07:00
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
2021-07-11 05:12:37 -07:00
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
2021-08-08 09:24:30 -07:00
## Motivation
2021-07-01 02:00:23 -07: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 no longer maintained.
2021-07-01 02:00:23 -07:00
* Want to build a fancy UI.
* Learn Vue 3 and vite.js.
2021-07-30 00:04:52 -07:00
* Show the power of Bootstrap 5.
2021-07-01 02:00:23 -07: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-09-09 03:01:15 -07:00
## 🗣️ Discussion
2021-09-16 09:48:04 -07:00
### Issues Page
2021-10-12 17:01:34 -07:00
2021-12-02 02:09:27 -08:00
You can discuss or ask for help in [issues](https://github.com/louislam/uptime-kuma/issues).
2021-09-09 03:01:15 -07:00
2021-09-16 09:48:04 -07:00
### Subreddit
2021-10-12 17:01:34 -07:00
2022-07-09 03:25:41 -07:00
My Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam).
You can mention me if you ask a question on Reddit.
[r/Uptime kuma](https://www.reddit.com/r/UptimeKuma/)
2021-09-09 03:01:15 -07:00
2021-08-08 09:24:30 -07:00
## Contribute
2021-07-18 09:34:48 -07:00
2022-04-23 10:29:34 -07:00
### Beta Version
2021-07-18 09:34:48 -07:00
2022-04-18 04:15:50 -07:00
Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases
### Bug Reports / Feature Requests
2022-04-27 11:10:47 -07:00
If you want to report a bug or request a new feature, feel free to open a [new issue](https://github.com/louislam/uptime-kuma/issues).
2021-07-18 09:34:48 -07:00
2022-04-20 19:22:18 -07:00
### Translations
2021-12-02 02:09:27 -08:00
If you want to translate Uptime Kuma into your language, please read: https://github.com/louislam/uptime-kuma/tree/master/src/languages
2021-09-09 03:02:58 -07:00
2022-04-18 04:15:50 -07:00
Feel free to correct my grammar in this README, source code, or wiki, as my mother language is not English and my grammar is not that great.
2021-07-18 09:34:48 -07:00
2022-04-20 19:22:18 -07:00
### Pull Requests
2022-04-18 04:15:50 -07: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