vrr/Pulse
2
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-05-08 18:21:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
Pulse/docs/FAQ.md
Pulse Monitor 0bd956a9db docs: update documentation for security changes and API improvements 
Documentation Updates:
- Fix CORS documentation to reflect new secure defaults (no CORS by default)
- Add API token management endpoints to API.md
- Document CORS configuration in SECURITY.md
- Update environment variable documentation with defaults
- Add authentication variables (PULSE_PASSWORD, API_TOKEN, etc.)
- Add troubleshooting for CORS and authentication issues
- Remove outdated references to ALLOWED_ORIGINS=*
- Clarify that CORS defaults to same-origin only

All documentation now accurately reflects:
- Security improvements from recent audit
- New API token management features
- Correct CORS behavior and configuration
- Complete environment variable reference
2025-08-13 19:56:21 +00:00

2.8 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?

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 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

CORS errors in browser?

  • By default, Pulse only allows same-origin requests
  • Set ALLOWED_ORIGINS environment variable for cross-origin access
  • Example: ALLOWED_ORIGINS=https://app.example.com
  • Never use * in production

Authentication issues?

  • Password auth: Check PULSE_PASSWORD environment variable
  • API token: Verify API_TOKEN is set correctly
  • Session expired: Log in again via web UI
  • Account locked: Wait 15 minutes after 5 failed attempts

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