vrr/Pulse

mirror of https://github.com/rcourtman/Pulse.git synced 2026-05-08 09:53:25 +00:00

Pulse Monitor 586d09caf1 docs: remove fluff and simplify all documentation

- README reduced from 256 to 188 lines
- FAQ reduced from 133 to 66 lines
- PBS-AGENT simplified to essentials only
- Removed marketing language, obvious advice, redundant sections
- Focused on practical information users actually need

2025-08-06 21:50:09 +00:00

1.6 KiB

Raw Blame History

FAQ

Installation

What's the easiest way to install?

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?

Settings → Nodes → Add Node → Enter credentials → Save

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

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

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

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

1.6 KiB Raw Blame History

FAQ