You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
uptime-kuma/README.md

154 lines
4.7 KiB

# Uptime Kuma
3 years ago
<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>
3 years ago
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
It is a self-hosted monitoring tool like "Uptime Robot".
3 years ago
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
# Features
* Monitoring uptime for HTTP(s) / TCP / Ping.
* Fancy, Reactive, Fast UI/UX.
3 years ago
* Notifications via Webhook, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP) and more by Apprise.
* 20 seconds interval.
# How to Use
3 years ago
## Docker
3 years ago
3 years ago
```bash
# Create a volume
docker volume create uptime-kuma
# Start the container
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
3 years ago
```
3 years ago
Browse to http://localhost:3001 after started.
3 years ago
Change Port and Volume
```bash
docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1
3 years ago
```
3 years ago
## Without Docker
3 years ago
3 years ago
Required Tools: Node.js >= 14, git and pm2.
3 years ago
3 years ago
```bash
3 years ago
git clone https://github.com/louislam/uptime-kuma.git
3 years ago
cd uptime-kuma
3 years ago
npm run setup
3 years ago
3 years ago
# Option 1. Try it
3 years ago
npm run start-server
3 years ago
# (Recommended)
3 years ago
# Option 2. Run in background using PM2
3 years ago
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm --name uptime-kuma -- run start-server
3 years ago
3 years ago
# Listen to different port or hostname
pm2 start npm --name uptime-kuma -- run start-server -- --port=80 --hostname=0.0.0.0
3 years ago
```
3 years ago
More useful commands if you have installed.
```bash
pm2 start uptime-kuma
pm2 restart uptime-kuma
pm2 stop uptime-kuma
```
3 years ago
Browse to http://localhost:3001 after started.
3 years ago
3 years ago
## (Optional) One more step for Reverse Proxy
3 years ago
3 years ago
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.
3 years ago
Please read wiki for more info:
https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy
## One-click Deploy
3 years ago
3 years ago
<!---
Abort. Heroku instance killed the server.js if idle, stupid.
3 years ago
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/louislam/uptime-kuma/tree/1.0.10)
3 years ago
-->
3 years ago
[![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)
3 years ago
3 years ago
# How to Update
### Docker
Re-pull the latest docker image and create another container with the same volume.
3 years ago
For someone who used my "How-to-use" commands to install Uptime Kuma, you can update by this:
```bash
docker pull uptime-kuma:1
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
```
3 years ago
PS: For every new release, it takes some time to build the docker image, please be patient if it is not available yet.
3 years ago
### Without Docker
```bash
git fetch --all
3 years ago
git checkout 1.0.10 --force
3 years ago
npm install
npm run build
pm2 restart uptime-kuma
```
3 years ago
# What's Next?
3 years ago
3 years ago
I will mark requests/issues to the next milestone.
3 years ago
https://github.com/louislam/uptime-kuma/milestones
3 years ago
# More Screenshots
3 years ago
Settings Page:
3 years ago
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
3 years ago
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
3 years ago
# Motivation
3 years ago
* 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.
* Want to build a fancy UI.
* Learn Vue 3 and vite.js.
3 years ago
* 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 ⭐.
3 years ago
# Contribute
3 years ago
If you want to report a bug or request a new feature. Free feel to open a new issue.
3 years ago
3 years ago
If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md
3 years ago
3 years ago
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.