You've already forked uptime-kuma
							
							
				mirror of
				https://github.com/louislam/uptime-kuma.git
				synced 2025-10-30 23:58:13 +02:00 
			
		
		
		
	Prepare README.md for 2.0.0 (#5276)
This commit is contained in:
		
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								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 <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: | ||||
| > | ||||
| @@ -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 | ||||
|  | ||||
|   | ||||
| @@ -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" | ||||
|   | ||||
		Reference in New Issue
	
	Block a user