mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-10 20:25:41 +00:00
41a7c830bf
- Document Docker persistence in /data volume - Add PBS HTTPS requirement to FAQ troubleshooting - Clarify data directory usage for encryption keys - Update file location documentation for Docker vs standard installs
85 lines
No EOL
2.4 KiB
Markdown
85 lines
No EOL
2.4 KiB
Markdown
# FAQ
|
|
|
|
## Installation
|
|
|
|
### What's the easiest way to install?
|
|
```bash
|
|
bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/pulse.sh)"
|
|
```
|
|
|
|
### System requirements?
|
|
- 1 vCPU, 512MB RAM (1GB recommended), 1GB disk
|
|
- Network access to Proxmox API
|
|
|
|
## Configuration
|
|
|
|
### How do I add a node?
|
|
**Auto-discovery (Easiest)**: Settings → Nodes → Click "Setup Script" on discovered node → Run on Proxmox
|
|
**Manual**: Settings → Nodes → Add Node → Enter credentials → Save
|
|
|
|
### How do I change the port?
|
|
Systemd: `sudo systemctl edit pulse-backend`, add `Environment="FRONTEND_PORT=8080"`, restart
|
|
Docker: Use `-e FRONTEND_PORT=8080` in your run command
|
|
|
|
### What permissions needed?
|
|
- PVE: `PVEAuditor` minimum
|
|
- PBS: `DatastoreReader` minimum
|
|
|
|
### API tokens vs passwords?
|
|
API tokens are more secure. Create in Proxmox: Datacenter → Permissions → API Tokens
|
|
|
|
### Where are settings stored?
|
|
See [Configuration Guide](CONFIGURATION.md) for details
|
|
|
|
### How do I backup my configuration?
|
|
Settings → Security → Export Configuration (requires API token or ALLOW_UNPROTECTED_EXPORT=true)
|
|
|
|
### Can Pulse detect Proxmox clusters?
|
|
Yes! When you add one cluster node, Pulse automatically discovers and monitors all nodes
|
|
|
|
## Troubleshooting
|
|
|
|
### No data showing?
|
|
- Check Proxmox API is reachable (port 8006/8007)
|
|
- Verify credentials
|
|
- Check logs: `journalctl -u pulse -f`
|
|
|
|
### Connection refused?
|
|
- Check port 7655 is open
|
|
- Verify Pulse is running: `systemctl status pulse`
|
|
|
|
### PBS connection issues?
|
|
- PBS requires HTTPS (not HTTP) - use `https://your-pbs:8007`
|
|
- Default PBS port is 8007 (not 8006)
|
|
- Check firewall allows port 8007
|
|
|
|
### Invalid credentials?
|
|
- Check username includes realm (@pam, @pve)
|
|
- Verify API token not expired
|
|
- Confirm user has required permissions
|
|
|
|
### High memory usage?
|
|
Reduce `metricsRetentionDays` in settings and restart
|
|
|
|
## Features
|
|
|
|
### Multiple clusters?
|
|
Yes, add multiple nodes in Settings
|
|
|
|
### PBS push mode?
|
|
Yes, use PBS agent for isolated servers. See [PBS Agent docs](PBS-AGENT.md)
|
|
|
|
### Webhook providers?
|
|
Discord, Slack, Gotify, Telegram, ntfy.sh, Teams, generic JSON
|
|
|
|
### Works with reverse proxy?
|
|
Yes, ensure WebSocket support is enabled
|
|
|
|
## Updates
|
|
|
|
### How to update?
|
|
- **Docker**: Pull latest image, recreate container
|
|
- **Manual**: Settings → System → Check for Updates
|
|
|
|
### Will updates break config?
|
|
No, configuration is preserved |