You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -52,15 +53,71 @@ A lightweight monitoring application for Proxmox VE that displays real-time stat
52
53
-[Support](#-support)
53
54
-[Troubleshooting](#-troubleshooting)
54
55
55
-
## 🚀 Quick Start (Docker Compose)
56
+
## 🚀 Quick Start (Docker Compose - Recommended)
56
57
57
-
This is the fastest way to get Pulse running.
58
+
This is the **easiest and recommended**way to run Pulse using the pre-built image from Docker Hub.
58
59
59
-
1.**Get Files:** Clone the repository (`git clone https://github.com/rcourtman/Pulse.git && cd Pulse`) or download `docker-compose.yml` and `.env.example` manually.
1.**Create a Directory:** Make a directory on your Docker host where Pulse configuration will live:
67
+
```bash
68
+
mkdir pulse-config
69
+
cd pulse-config
70
+
```
71
+
2. **Create `.env` file:** Create a file named `.env`in this directory and add your Proxmox connection details. See [Configuration](#️-configuration) for details and required permissions. Minimally, you need:
72
+
```env
73
+
# .env file
74
+
PROXMOX_HOST=https://your-proxmox-ip:8006
75
+
PROXMOX_TOKEN_ID=your_user@pam!your_token_id
76
+
PROXMOX_TOKEN_SECRET=your_secret_uuid_here
77
+
# Optional: Set to true if using self-signed certs
78
+
# PROXMOX_ALLOW_SELF_SIGNED_CERTS=true
79
+
# Optional: Add PBS details if desired
80
+
# PBS_HOST=https://your-pbs-ip:8007
81
+
# PBS_NODE_NAME=your-pbs-node-hostname # Important! See config docs.
82
+
# PBS_TOKEN_ID=pbs_user@pbs!token_id
83
+
# PBS_TOKEN_SECRET=pbs_secret_uuid_here
84
+
# PBS_ALLOW_SELF_SIGNED_CERTS=true
85
+
```
86
+
3. **Create `docker-compose.yml` file:** Create a file named `docker-compose.yml`in the same directory with the following content:
87
+
```yaml
88
+
# docker-compose.yml
89
+
services:
90
+
pulse-server:
91
+
image: rcourtman/pulse:latest # Pulls the latest pre-built image
92
+
container_name: pulse
93
+
restart: unless-stopped
94
+
ports:
95
+
# Map host port 7655 to container port 7655
96
+
# Change the left side (e.g., "8081:7655") if 7655 is busy on your host
97
+
- "7655:7655"
98
+
env_file:
99
+
- .env # Load environment variables from .env file
100
+
# Optional: Uncomment to map a volume for potential future config/log persistence
101
+
# volumes:
102
+
# - ./data:/data
103
+
```
104
+
4. **Run:** Start the container:
105
+
```bash
106
+
docker compose up -d
107
+
```
108
+
5. **Access:** Open your browser to `http://<your-docker-host-ip>:7655`.
109
+
110
+
---
111
+
112
+
## 🚀 Development Setup (Docker Compose)
113
+
114
+
Use this method if you have cloned the repository and want to build and run the application from the localsource code.
3.**Edit `.env`:** Fill in your primary Proxmox API details (`PROXMOX_HOST`, `PROXMOX_TOKEN_ID`, `PROXMOX_TOKEN_SECRET`). See [Creating a Proxmox API Token](#creating-a-proxmox-api-token) if you don't have one.
62
-
4.**Run:**`docker compose up -d`
63
-
5.**Access:** Open your browser to `http://<your-host-ip>:7655`.
118
+
3. **Edit `.env`:** Fill in your primary Proxmox API details (`PROXMOX_HOST`, `PROXMOX_TOKEN_ID`, `PROXMOX_TOKEN_SECRET`). See [Configuration](#️-configuration) for details.
119
+
4. **Run:**`docker compose up --build -d` (The included `docker-compose.yml` uses the `build:` context by default).
120
+
5. **Access:** Open your browser to `http://localhost:7655` (or your host IP if Docker runs remotely).
64
121
65
122
## 🛠️ Configuration
66
123
@@ -205,18 +262,26 @@ If monitoring PBS, create a token within the PBS interface.
205
262
206
263
Choose one of the following methods to deploy Pulse.
207
264
208
-
### Running with Docker Compose
265
+
### Docker Compose
209
266
210
-
Using Docker Compose is the recommended way formost users.
267
+
Refer to the [Quick Start](#-quick-start-docker-compose---recommended) or [Development Setup](#-development-setup-docker-compose) sections above for Docker Compose instructions.
0 commit comments