From 26144ae558382335ca80cac49dc0ef7d4d562ace Mon Sep 17 00:00:00 2001 From: rcourtman Date: Wed, 5 Nov 2025 17:44:18 +0000 Subject: [PATCH] Improve temperature proxy setup guidance for Docker deployments This addresses GitHub Discussion #605 where users were unclear about configuring the temperature proxy when running Pulse in Docker. Changes: **install-sensor-proxy.sh:** - Add Docker-specific post-install instructions when --standalone flag is used - Show required docker-compose.yml bind mount configuration - Provide verification commands for Docker deployments - Link to full documentation for troubleshooting **TEMPERATURE_MONITORING.md:** - Add prominent "Quick Start for Docker Deployments" section at the top - Move Docker instructions earlier in the document for better visibility - Provide complete 4-step setup process with verification commands These changes ensure Docker users immediately see: 1. How to install the proxy on the Proxmox host 2. What bind mount to add to docker-compose.yml 3. How to restart and verify the setup 4. Where to find detailed troubleshooting The installer now provides actionable next steps instead of just confirming installation, reducing confusion for containerized deployments. --- docs/TEMPERATURE_MONITORING.md | 52 +++++++++++++++++++++++++++++++++ scripts/install-sensor-proxy.sh | 33 +++++++++++++++++++++ 2 files changed, 85 insertions(+) diff --git a/docs/TEMPERATURE_MONITORING.md b/docs/TEMPERATURE_MONITORING.md index 24926da..d7e2807 100644 --- a/docs/TEMPERATURE_MONITORING.md +++ b/docs/TEMPERATURE_MONITORING.md @@ -12,6 +12,58 @@ Pulse can display real-time CPU and NVMe temperatures directly in your dashboard - Yellow: 60-80°C (warm) - Red: > 80°C (hot) +## Quick Start for Docker Deployments + +**Running Pulse in Docker?** Follow these steps to enable temperature monitoring: + +### 1. Install the proxy on your Proxmox host + +SSH to your **Proxmox host** (not the Docker container) and run: + +```bash +curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/install-sensor-proxy.sh | \ + bash -s -- --standalone --pulse-server http://YOUR_PULSE_IP:7655 +``` + +Replace `YOUR_PULSE_IP` with your Pulse server's IP address. + +### 2. Add bind mount to docker-compose.yml + +Add this volume to your Pulse container configuration: + +```yaml +volumes: + - pulse-data:/data + - /run/pulse-sensor-proxy:/run/pulse-sensor-proxy:rw # Add this line +``` + +### 3. Restart Pulse container + +```bash +docker-compose down && docker-compose up -d +``` + +### 4. Verify + +Check Pulse UI for temperature data, or verify the setup: + +```bash +# Verify proxy is running on host +systemctl status pulse-sensor-proxy + +# Verify socket is accessible in container +docker exec pulse ls -l /run/pulse-sensor-proxy/pulse-sensor-proxy.sock + +# Check Pulse logs +docker logs pulse | grep -i "temperature.*proxy" +``` + +You should see: `Temperature proxy detected - using secure host-side bridge` + +**Having issues?** See [Troubleshooting](#troubleshooting) below. + +--- + ## Disable Temperature Monitoring Don't need the sensor data? Open **Settings → Proxmox**, edit any node, and scroll to the **Advanced monitoring** section. The temperature toggle there controls collection for all nodes: diff --git a/scripts/install-sensor-proxy.sh b/scripts/install-sensor-proxy.sh index 039f1bb..539f17b 100755 --- a/scripts/install-sensor-proxy.sh +++ b/scripts/install-sensor-proxy.sh @@ -1401,8 +1401,41 @@ else print_info "" print_info "Temperature monitoring will use the secure host-side proxy" print_info "" + + if [[ "$STANDALONE" == true ]]; then + echo "" + echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + echo " Docker Container Configuration Required" + echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + echo "" + print_info "${YELLOW}IMPORTANT:${NC} If Pulse is running in Docker, add this bind mount to your docker-compose.yml:" + echo "" + echo " volumes:" + echo " - pulse-data:/data" + echo " - /run/pulse-sensor-proxy:/run/pulse-sensor-proxy:rw" + echo "" + print_info "Then restart your Pulse container:" + echo " docker-compose down && docker-compose up -d" + echo "" + print_info "Or if using Docker directly:" + echo " docker restart pulse" + echo "" + fi + print_info "To check proxy status:" print_info " systemctl status pulse-sensor-proxy" + + if [[ "$STANDALONE" == true ]]; then + echo "" + print_info "After restarting Pulse, verify the socket is accessible:" + print_info " docker exec pulse ls -l /run/pulse-sensor-proxy/pulse-sensor-proxy.sock" + echo "" + print_info "Check Pulse logs for temperature proxy detection:" + print_info " docker logs pulse | grep -i 'temperature.*proxy'" + echo "" + print_info "For detailed documentation, see:" + print_info " https://github.com/rcourtman/Pulse/blob/main/docs/TEMPERATURE_MONITORING.md" + fi fi exit 0