From 124e79bce978ce29f0de681267b62b7d0d3d4429 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 20 Oct 2025 20:40:14 +0800 Subject: [PATCH] Prepare README.md for 2.0.0 (#5276) --- README.md | 18 ++++++++++++++---- compose.yaml | 6 +++--- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e4f121765..fdec8e2cf 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:1 +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 . @@ -48,6 +51,14 @@ Uptime Kuma is now running on . > [!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 . + > [!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: > @@ -64,8 +75,7 @@ Requirements: - ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher - ❌ FreeBSD / OpenBSD / NetBSD - ❌ Replit / Heroku -- [Node.js](https://nodejs.org/en/download/) 18 / 20.4 -- [npm](https://docs.npmjs.com/cli/) 9 +- [Node.js](https://nodejs.org/en/download/) >= 18 or >= 20.4 - [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: # : - - 3001:3001 - restart: unless-stopped + - "3001:3001"