From 3cd537808fb5b5055d6c3d028f45955a1a30db4e Mon Sep 17 00:00:00 2001
From: Louis Lam <louislam@users.noreply.github.com>
Date: Wed, 30 Oct 2024 01:07:47 +0800
Subject: [PATCH 1/4] WIP
---
README.md | 4 ++--
compose.yaml | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 1b4c885d0..244bbddaa 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Sponsore
### 🐳 Docker
```bash
-docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
+docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:2
```
Uptime Kuma is now running on <http://0.0.0.0:3001>.
@@ -64,7 +64,7 @@ Requirements:
- ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
- ❌ Replit / Heroku
- [Node.js](https://nodejs.org/en/download/) 18 / 20.4
-- [npm](https://docs.npmjs.com/cli/) 9
+- [npm](https://docs.npmjs.com/cli/) >= 9
- [Git](https://git-scm.com/downloads)
- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background
diff --git a/compose.yaml b/compose.yaml
index 004705a63..914e8603d 100644
--- a/compose.yaml
+++ b/compose.yaml
@@ -1,9 +1,9 @@
services:
uptime-kuma:
- image: louislam/uptime-kuma:1
+ image: louislam/uptime-kuma:2
+ restart: unless-stopped
volumes:
- ./data:/app/data
ports:
# <Host Port>:<Container Port>
- - 3001:3001
- restart: unless-stopped
+ - "3001:3001"
From f09830a75e0dd4493d08f0ecb39ac5299c80600d Mon Sep 17 00:00:00 2001
From: Louis Lam <louislam@users.noreply.github.com>
Date: Wed, 30 Oct 2024 01:13:43 +0800
Subject: [PATCH 2/4] WIP
---
README.md | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 244bbddaa..dd91fee38 100644
--- a/README.md
+++ b/README.md
@@ -37,10 +37,13 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Sponsore
## 🔧 How to Install
-### 🐳 Docker
+### 🐳 Docker Compose
```bash
-docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:2
+mkdir uptime-kuma
+cd uptime-kuma
+curl -o compose.yaml https://raw.githubusercontent.com/louislam/uptime-kuma/master/compose.yaml
+docker compose up -d
```
Uptime Kuma is now running on <http://0.0.0.0:3001>.
@@ -48,6 +51,14 @@ Uptime Kuma is now running on <http://0.0.0.0:3001>.
> [!WARNING]
> File Systems like **NFS** (Network File System) are **NOT** supported. Please map to a local directory or volume.
+### 🐳 Docker Command
+
+```bash
+docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:2
+```
+
+Uptime Kuma is now running on <http://0.0.0.0:3001>.
+
> [!NOTE]
> If you want to limit exposure to localhost (without exposing port for other users or to use a [reverse proxy](https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy)), you can expose the port like this:
>
From b376aa329955661af063436438d1c936c3501798 Mon Sep 17 00:00:00 2001
From: Louis Lam <louislam@users.noreply.github.com>
Date: Wed, 30 Oct 2024 01:16:47 +0800
Subject: [PATCH 3/4] WIP
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index dd91fee38..71106994c 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,7 @@ Requirements:
- ✅ Major Linux distros such as Debian, Ubuntu, CentOS, Fedora and ArchLinux etc.
- ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
- ❌ Replit / Heroku
-- [Node.js](https://nodejs.org/en/download/) 18 / 20.4
+- [Node.js](https://nodejs.org/en/download/) >= 18 or >= 20.4
- [npm](https://docs.npmjs.com/cli/) >= 9
- [Git](https://git-scm.com/downloads)
- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background
From d81bf8aaf9d884c64c9d15a57e70e1bd16d755b0 Mon Sep 17 00:00:00 2001
From: Louis Lam <louislam@users.noreply.github.com>
Date: Sat, 9 Nov 2024 23:46:16 +0800
Subject: [PATCH 4/4] Remove the npm requirement, as all newer versions came
with npm versions >= 9
---
README.md | 1 -
1 file changed, 1 deletion(-)
diff --git a/README.md b/README.md
index 71106994c..163254d7c 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,6 @@ Requirements:
- ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
- ❌ Replit / Heroku
- [Node.js](https://nodejs.org/en/download/) >= 18 or >= 20.4
-- [npm](https://docs.npmjs.com/cli/) >= 9
- [Git](https://git-scm.com/downloads)
- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background