vrr/Pulse
2
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-05-08 09:53:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Document new Docker public URL guidance and bundled disk helper

Browse source
This commit is contained in:
rcourtman 2025-09-29 16:47:06 +00:00
parent 8910e1e379
commit 39ba5b60ce
3 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/CONFIGURATION.md
View file

@ -217,9 +217,9 @@ These env vars override system.json values. When set, the UI will show a warning
- `ALLOWED_ORIGINS` - CORS origins (default: same-origin only)
- `LOG_LEVEL` - Log verbosity: debug/info/warn/error (default: info)
- `PULSE_PUBLIC_URL` - Full URL to access Pulse (e.g., `http://192.168.1.100:7655`)
- **Auto-detected** if not set - Pulse will try to determine its IP address automatically
- **Auto-detected** if not set (except inside Docker where detection is disabled)
- Used in webhook notifications for "View in Pulse" links
- Only set this if auto-detection uses the wrong IP (e.g., multiple network interfaces)
- Set explicitly when running in containers or whenever auto-detection picks the wrong address
- Example: `PULSE_PUBLIC_URL="http://192.168.1.100:7655"`
#### Authentication Variables (from .env file)

6
docs/DOCKER.md
View file

@ -76,7 +76,7 @@ services:
# Generate hash: docker run --rm -it rcourtman/pulse:latest pulse hash-password
PULSE_AUTH_PASS: '$$2a$$12$$...' # IMPORTANT: Use $$ in docker-compose.yml!
API_TOKEN: 'your-48-char-hex-token' # Generate: openssl rand -hex 24
# PULSE_PUBLIC_URL: 'http://192.168.1.100:7655' # Optional: For webhook notification links
# PULSE_PUBLIC_URL: 'http://192.168.1.100:7655' # Strongly recommended: external URL for webhook links
restart: unless-stopped
volumes:
@ -240,7 +240,7 @@ Common problems:
| `DISCOVERY_SUBNET` | Network to scan (rarely needed) | Auto-scans common networks |
| `CONNECTION_TIMEOUT` | Connection timeout (seconds) | `10` |
| `LOG_LEVEL` | Logging verbosity | `info` |
| `PULSE_PUBLIC_URL` | Full URL to access Pulse (for webhook links) | None |
| `PULSE_PUBLIC_URL` | Full URL to access Pulse (used in webhooks/notifications) | None (set explicitly when containerised) |
### System
| Variable | Description | Default |
@ -287,4 +287,4 @@ services:
timeout: 10s
retries: 3
# ... rest of config
```
```

8
docs/VM_DISK_MONITORING.md
View file

@ -89,13 +89,15 @@ pveum aclmod / -user pulse-monitor@pam -role PulseMonitor
Pulse includes a diagnostic script that can identify why a VM isn't showing disk usage:
```bash
# Run on your Proxmox host
# Run on your Proxmox host (latest version from GitHub)
curl -sSL https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/test-vm-disk.sh | bash
# Or if Pulse is installed locally:
# Or use the bundled copy installed with Pulse
/opt/pulse/scripts/test-vm-disk.sh
```
> **Tip:** The helper script is shipped with Pulse releases under `/opt/pulse/scripts/test-vm-disk.sh`, so you no longer need to download it manually on managed hosts.
Enter the VM ID when prompted. The script will check:
- VM running status
- Guest agent configuration
@ -174,4 +176,4 @@ With QEMU Guest Agent disk monitoring:
- **Accurate alerts** - Alert on real usage, not allocated space
- **Better planning** - See actual growth trends
- **Prevent surprises** - Know when VMs are actually running out of space
- **Optimize storage** - Identify over-provisioned VMs
- **Optimize storage** - Identify over-provisioned VMs