uptime-kuma/README.md

125 lines
3.7 KiB
Markdown
Raw Normal View History

2021-07-01 12:00:23 +03:00
# Uptime Kuma
2021-07-13 20:39:04 +03: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 20:36:25 +03:00
2021-07-11 11:08:47 +03:00
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
2021-07-11 09:20:31 +03:00
It is a self-hosted monitoring tool like "Uptime Robot".
2021-07-11 13:32:04 +03:00
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
2021-07-01 12:00:23 +03:00
# Features
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
2021-07-11 09:20:31 +03:00
* Notifications via Webhook, Telegram, Discord and email (SMTP).
2021-07-01 12:00:23 +03:00
* 20 seconds interval.
# How to Use
2021-07-11 11:02:06 +03:00
### Docker
2021-07-14 12:10:51 +03:00
2021-07-11 13:32:04 +03:00
```bash
2021-07-12 15:08:51 +03:00
# Create a volume
docker volume create uptime-kuma
# Start the container
2021-07-19 15:18:27 +03:00
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
2021-07-11 11:02:06 +03:00
```
2021-07-01 12:00:23 +03:00
2021-07-11 18:41:21 +03:00
Browse to http://localhost:3001 after started.
2021-07-11 18:41:04 +03:00
Change Port and Volume
```bash
2021-07-19 15:18:27 +03: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 18:41:04 +03:00
```
2021-07-11 13:34:29 +03:00
### Without Docker
Required Tools: Node.js >= 14, git and pm2.
2021-07-11 13:32:04 +03:00
```bash
2021-07-11 13:44:47 +03:00
git clone https://github.com/louislam/uptime-kuma.git
2021-07-11 11:02:06 +03:00
cd uptime-kuma
2021-07-11 13:51:53 +03:00
npm run setup
2021-07-11 11:02:06 +03:00
2021-07-11 13:32:04 +03:00
# Option 1. Try it
2021-07-11 11:02:06 +03:00
npm run start-server
2021-07-12 06:42:36 +03:00
# (Recommended)
2021-07-11 13:32:04 +03:00
# Option 2. Run in background using PM2
2021-07-11 11:02:06 +03:00
# Install PM2 if you don't have: npm install pm2 -g
2021-07-11 14:08:36 +03:00
pm2 start npm --name uptime-kuma -- run start-server
2021-07-11 11:02:06 +03:00
2021-07-12 13:59:48 +03: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 11:02:06 +03:00
```
Browse to http://localhost:3001 after started.
### One-click Deploy to DigitalOcean
2021-07-11 15:46:09 +03: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-01 12:00:23 +03:00
2021-07-12 15:00:12 +03:00
Choose Cheapest Plan is enough. (US$ 5)
2021-07-11 13:32:04 +03:00
2021-07-12 13:59:48 +03:00
# How to Update
### Docker
Re-pull the latest docker image and create another container with the same volume.
2021-07-13 20:48:55 +03: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 13:59:48 +03:00
### Without Docker
```bash
git fetch --all
2021-07-20 15:04:54 +03:00
git checkout 1.0.6 --force
2021-07-12 13:59:48 +03:00
npm install
npm run build
pm2 restart uptime-kuma
```
2021-07-20 15:27:34 +03:00
# What's Next?
2021-07-20 15:27:15 +03:00
I will mark requests/issues to the next milestone.
https://github.com/louislam/uptime-kuma/milestones
2021-07-11 13:32:04 +03:00
# More Screenshots
2021-07-11 15:12:37 +03:00
Settings Page:
2021-07-11 13:32:04 +03:00
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
2021-07-11 15:12:37 +03:00
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
2021-07-11 13:32:04 +03:00
2021-07-01 12:00:23 +03:00
# Motivation
2021-07-11 09:20:31 +03: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 12:00:23 +03:00
* 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 ⭐.
2021-07-18 19:34:48 +03:00
# Contribute
2021-07-20 08:04:21 +03:00
If you want to report a bug or request a new feature. Free feel to open a new issue.
2021-07-18 19:34:48 +03:00
If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/wiki/%5BDev%5D-Setup-Development-Environment
2021-07-18 19:40:10 +03: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.