github
/
uptime-kuma
mirror of https://github.com/louislam/uptime-kuma
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

pull/6/head
LouisLam 2021-07-11 18:52:20 +08:00
parent ae6bc687a0 ba02869074
commit ecc3441444
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,7 +1,13 @@
# Uptime Kuma
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
It is a self-hosted monitoring tool like "Uptime Robot".
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
# Features
* Monitoring uptime for HTTP(s) / TCP / Ping.
@ -12,22 +18,26 @@ It is a self-hosted monitoring tool like "Uptime Robot".
# How to Use
### Docker
```
```bash
docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma
```
Browse to http://localhost:3001 after started.
### Node.js >= 14 + GIT
```
git clone git@github.com:louislam/uptime-kuma.git
### Without Docker
Required Tools: Node.js >= 14, git and pm2.
```bash
git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup
# 1. Try it
# Option 1. Try it
npm run start-server
# 2. Run in background using PM2
# (Recommanded)
# Option 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm -- run start-server
@ -39,6 +49,12 @@ Browse to http://localhost:3001 after started.
Coming Soon
# More Screenshots
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
# Motivation
* 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.