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

Update README.md

pull/6/head
Louis Lam 2021-07-11 18:32:04 +08:00 committed by GitHub
parent 52c0c95a0b
commit 25732914fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -6,6 +6,8 @@
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.
@ -16,22 +18,23 @@ 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
```
```bash
git clone git@github.com:louislam/uptime-kuma.git
cd uptime-kuma
npm run install
# 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
@ -43,6 +46,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.