From f3660a0cece42f1d76f23dfed082a96297d5c096 Mon Sep 17 00:00:00 2001 From: Joppe Koers Date: Tue, 6 Dec 2022 18:43:28 +0100 Subject: [PATCH 1/5] Fix spelling in README --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 55a6ec504..90c8ad75b 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,17 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Use the ## ⭐ Features -* Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server / Docker Containers. -* Fancy, Reactive, Fast UI/UX. -* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications). -* 20 second intervals. +* Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server / Docker Containers +* Fancy, Reactive, Fast UI/UX +* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications) +* 20 second intervals * [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/languages) -* Multiple Status Pages -* Map Status Page to Domain -* Ping Chart -* Certificate Info -* Proxy Support -* 2FA available +* Multiple status pages +* Map status pages to specific domains +* Ping chart +* Certificate info +* Proxy support +* 2FA support ## 🔧 How to Install @@ -44,14 +44,14 @@ docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name upti ⚠️ Please use a **local volume** only. Other types such as NFS are not supported. -Browse to http://localhost:3001 after starting. +Kuma is now running on http://localhost:3001 ### 💪🏻 Non-Docker Required Tools: - [Node.js](https://nodejs.org/en/download/) >= 14 - [Git](https://git-scm.com/downloads) -- [pm2](https://pm2.keymetrics.io/) - For run in background +- [pm2](https://pm2.keymetrics.io/) - For running kuma in the background ```bash # Update your npm to the latest version @@ -73,7 +73,7 @@ pm2 start server/server.js --name uptime-kuma ``` -Browse to http://localhost:3001 after starting. +Kuma is now running on http://localhost:3001 More useful PM2 Commands From f8c7da7995528c453335a8f6814e81bdea8e17ac Mon Sep 17 00:00:00 2001 From: Joppe Koers Date: Tue, 6 Dec 2022 18:44:16 +0100 Subject: [PATCH 2/5] Add docker-compose to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 90c8ad75b..6d10cf2a8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,20 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Use the docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1 ``` +### 🐳 Docker Compose +```yaml +version: "3" + +services: + uptime-kuma: + image: louislam/uptime-kuma:1 + restart: always + ports: + - "3001:3001" + volumes: + - uptime-kuma:/app/data +``` + ⚠️ Please use a **local volume** only. Other types such as NFS are not supported. Kuma is now running on http://localhost:3001 From 3ea67110538a60ed0cd316a38e4ec9bf5efa93ae Mon Sep 17 00:00:00 2001 From: Joppe Koers Date: Thu, 15 Dec 2022 23:03:06 +0100 Subject: [PATCH 3/5] Remove docker compose again --- README.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/README.md b/README.md index 6d10cf2a8..90c8ad75b 100644 --- a/README.md +++ b/README.md @@ -42,20 +42,6 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Use the docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1 ``` -### 🐳 Docker Compose -```yaml -version: "3" - -services: - uptime-kuma: - image: louislam/uptime-kuma:1 - restart: always - ports: - - "3001:3001" - volumes: - - uptime-kuma:/app/data -``` - ⚠️ Please use a **local volume** only. Other types such as NFS are not supported. Kuma is now running on http://localhost:3001 From 2d3fd738e4691dfc03d06be3cffae9e2f55aa00f Mon Sep 17 00:00:00 2001 From: Joppe Koers Date: Tue, 3 Jan 2023 15:37:32 +0100 Subject: [PATCH 4/5] Fix small spelling mistake --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90c8ad75b..9b8100154 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Kuma is now running on http://localhost:3001 Required Tools: - [Node.js](https://nodejs.org/en/download/) >= 14 - [Git](https://git-scm.com/downloads) -- [pm2](https://pm2.keymetrics.io/) - For running kuma in the background +- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background ```bash # Update your npm to the latest version From 4ebf5a5f0736f648b87db0bf0c2fcfe250258671 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 5 Jan 2023 21:03:28 +0800 Subject: [PATCH 5/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9b8100154..1f26da8bf 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name upti ⚠️ Please use a **local volume** only. Other types such as NFS are not supported. -Kuma is now running on http://localhost:3001 +Uptime Kuma is now running on http://localhost:3001 ### 💪🏻 Non-Docker @@ -73,7 +73,7 @@ pm2 start server/server.js --name uptime-kuma ``` -Kuma is now running on http://localhost:3001 +Uptime Kuma is now running on http://localhost:3001 More useful PM2 Commands