From 52c0c95a0b17d4691da08802571781a2924dbca5 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 11 Jul 2021 16:08:47 +0800 Subject: [PATCH 1/4] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3bb7919a..f6d06084 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Uptime Kuma +
+ +
+ It is a self-hosted monitoring tool like "Uptime Robot". # Features From 25732914fc0dc3fdb59971691c92c5e0a6385142 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 11 Jul 2021 18:32:04 +0800 Subject: [PATCH 2/4] Update README.md --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f6d06084..4d03ee3a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ It is a self-hosted monitoring tool like "Uptime Robot". + + # 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 + + + + # 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. From c1e5b6074e00bc297f6f678bcab8f7eaf093192a Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 11 Jul 2021 18:34:29 +0800 Subject: [PATCH 3/4] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d03ee3a..e9dbadef 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,10 @@ docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma Browse to http://localhost:3001 after started. -### Node.js >= 14 + GIT +### Without Docker + +Required Tools: Node.js >= 14, git and pm2. + ```bash git clone git@github.com:louislam/uptime-kuma.git cd uptime-kuma From ba0286907405866607fec0153abc2e88bd9a7d7f Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 11 Jul 2021 18:44:47 +0800 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9dbadef..e4bc48e2 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Browse to http://localhost:3001 after started. Required Tools: Node.js >= 14, git and pm2. ```bash -git clone git@github.com:louislam/uptime-kuma.git +git clone https://github.com/louislam/uptime-kuma.git cd uptime-kuma npm run install