uptime-kuma/README.md

152 lines
4.8 KiB
Markdown
Raw Normal View History

2021-07-01 02:00:23 -07:00
# Uptime Kuma
2021-07-13 10:39:04 -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>
2021-07-13 10:36:25 -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-07-11 03:32:04 -07:00
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
2021-08-08 09:24:30 -07:00
## Features
2021-07-01 02:00:23 -07:00
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
2021-07-30 00:04:52 -07:00
* Notifications via Webhook, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP) and more by Apprise.
2021-07-01 02:00:23 -07:00
* 20 seconds interval.
2021-08-08 09:24:30 -07:00
## How to Use
2021-07-01 02:00:23 -07:00
2021-08-08 09:24:30 -07:00
### Docker
2021-07-14 02:10:51 -07:00
2021-07-11 03:32:04 -07:00
```bash
2021-07-12 05:08:51 -07:00
# Create a volume
docker volume create uptime-kuma
# Start the container
2021-07-19 05:18:27 -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-01 02:00:23 -07:00
2021-07-11 08:41:21 -07:00
Browse to http://localhost:3001 after started.
2021-07-11 08:41:04 -07:00
Change Port and Volume
```bash
2021-07-19 05:18:27 -07:00
docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1
2021-07-11 08:41:04 -07:00
```
2021-08-08 23:47:10 -07:00
### Without Docker (x86/x64 only)
2021-07-11 03:34:29 -07:00
2021-07-30 00:04:52 -07:00
Required Tools: Node.js >= 14, git and pm2.
2021-07-11 03:34:29 -07:00
2021-08-08 23:47:10 -07:00
(**Not recommanded for ARM CPU users.** Since there is no prebuilt for node-sqlite3, it is hard to get it running)
2021-07-11 03:32:04 -07:00
```bash
2021-07-11 03:44:47 -07:00
git clone https://github.com/louislam/uptime-kuma.git
2021-07-11 01:02:06 -07:00
cd uptime-kuma
2021-07-11 03:51:53 -07:00
npm run setup
2021-07-11 01:02:06 -07:00
2021-07-11 03:32:04 -07:00
# Option 1. Try it
2021-07-11 01:02:06 -07:00
npm run start-server
2021-08-08 09:24:30 -07:00
# (Recommended)
2021-07-11 03:32:04 -07:00
# Option 2. Run in background using PM2
2021-07-11 01:02:06 -07:00
# Install PM2 if you don't have: npm install pm2 -g
2021-07-11 04:08:36 -07:00
pm2 start npm --name uptime-kuma -- run start-server
2021-07-11 01:02:06 -07:00
2021-07-12 03:59:48 -07:00
# Listen to different port or hostname
pm2 start npm --name uptime-kuma -- run start-server -- --port=80 --hostname=0.0.0.0
2021-07-11 01:02:06 -07:00
```
2021-08-08 08:51:23 -07:00
More useful commands if you have installed.
```bash
pm2 start uptime-kuma
pm2 restart uptime-kuma
pm2 stop uptime-kuma
```
2021-07-11 01:02:06 -07:00
Browse to http://localhost:3001 after started.
2021-08-08 09:24:30 -07:00
### (Optional) One more step for Reverse Proxy
2021-07-31 09:15:33 -07:00
2021-07-31 09:23:40 -07:00
This is optional for someone who want to do reverse proxy.
Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more headers **"Upgrade"** and **"Connection"** in order to reverse proxy WebSocket.
2021-07-31 09:15:33 -07:00
Please read wiki for more info:
https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy
2021-08-08 09:24:30 -07:00
### One-click Deploy
2021-07-11 01:02:06 -07:00
2021-07-30 00:04:52 -07:00
<!---
Abort. Heroku instance killed the server.js if idle, stupid.
2021-08-03 22:59:42 -07:00
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/louislam/uptime-kuma/tree/1.0.10)
2021-07-30 00:04:52 -07:00
-->
2021-07-01 02:00:23 -07:00
2021-07-30 00:04:52 -07:00
[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/louislam/uptime-kuma/tree/master&refcode=e2c7eb658434)
2021-07-11 03:32:04 -07:00
2021-08-08 09:24:30 -07:00
## How to Update
2021-07-12 03:59:48 -07:00
### Docker
Re-pull the latest docker image and create another container with the same volume.
2021-08-04 00:19:06 -07:00
For someone who used my "How-to-use" commands to install Uptime Kuma, you can update by this:
2021-08-08 09:24:30 -07:00
2021-08-04 00:19:06 -07:00
```bash
2021-08-08 23:11:26 -07:00
docker pull louislam/uptime-kuma:1
2021-08-04 00:19:06 -07:00
docker stop uptime-kuma
docker rm uptime-kuma
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
```
2021-07-13 10:48:55 -07:00
PS: For every new release, it takes some time to build the docker image, please be patient if it is not available yet.
2021-07-12 03:59:48 -07:00
### Without Docker
```bash
git fetch --all
2021-08-03 22:59:42 -07:00
git checkout 1.0.10 --force
2021-07-12 03:59:48 -07:00
npm install
npm run build
pm2 restart uptime-kuma
```
2021-08-08 09:24:30 -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-07-20 05:27:15 -07:00
https://github.com/louislam/uptime-kuma/milestones
2021-08-08 09:24:30 -07:00
## More Screenshots
2021-07-11 03:32:04 -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
2021-07-30 00:04:52 -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 one is statping. Unfortunately, it is not stable and unmaintained.
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-08-08 09:24:30 -07:00
## Contribute
2021-07-18 09:34:48 -07:00
2021-07-19 22:04:21 -07:00
If you want to report a bug or request a new feature. Free feel to open a new issue.
2021-07-18 09:34:48 -07:00
2021-07-31 20:11:04 -07: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 09:34:48 -07:00
2021-07-18 09:40:10 -07: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.