From 72fcb3fd33c9c6dcdc0dc5e46a41e503b9e41bb8 Mon Sep 17 00:00:00 2001 From: "courtmanr@gmail.com" Date: Mon, 3 Mar 2025 20:38:10 +0000 Subject: [PATCH] docs: add Docker Compose deployment instructions to README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index ddc82cbcd..2e1e99465 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,19 @@ docker run -d \ open http://localhost:7654 # or visit in your browser ``` +### 🐳 Docker Compose +```bash +# 1. Create your .env file with ProxMox configuration +cp .env.example .env +nano .env # or use your preferred editor + +# 2. Run with Docker Compose +docker-compose up -d + +# 3. Access the application +open http://localhost:7654 # or visit in your browser +``` + The Docker image is optimized for production use: - Minimal image size with multi-stage builds - Runs as non-root user for security @@ -64,6 +77,19 @@ docker run -d -p 7654:7654 --env-file .env --name pulse-app --restart unless-sto docker run -d -p 7654:7654 --env-file .env --name pulse-app --restart unless-stopped rcourtman/pulse:1.0.15 ``` +#### Docker Compose Tips +```bash +# View logs +docker-compose logs + +# Restart the application +docker-compose restart + +# Update to latest version +docker-compose pull +docker-compose up -d +``` + ## Features - Real-time monitoring of ProxMox nodes, VMs, and containers