gitea-mirror/Pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-02-18 00:17:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
fd39196166d90b800eb97deb7446f7ac10575bca
Pulse/docs/FAQ.md
courtmanr@gmail.com d3d06bb32c Refactor FAQ and API docs to be concise and modern
2025-11-25 00:14:22 +00:00

3.0 KiB
Raw Blame History

❓ Frequently Asked Questions

🛠️ Installation & Setup

What's the easiest way to install?

Run this one-liner on your Proxmox host:

curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/install.sh | bash

How do I add a node?

Auto-discovery (Recommended): Go to Settings → Nodes, find your node in the "Discovered" list, click "Setup Script", and run the provided command on your Proxmox host. Manual: Go to Settings → Nodes → Add Node and enter the credentials manually.

How do I change the port?

  • Systemd: sudo systemctl edit pulse, add Environment="FRONTEND_PORT=8080", restart.
  • Docker: Use -p 8080:7655 in your run command.

Why can't I change settings in the UI?

If a setting is disabled with an amber warning, it's being overridden by an environment variable (e.g., DISCOVERY_ENABLED). Remove the env var to regain UI control.

🔍 Monitoring & Metrics

Why do VMs show "-" for disk usage?

Proxmox API returns 0 for VM disk usage by default. You must install the QEMU Guest Agent inside the VM and enable it in Proxmox (VM → Options → QEMU Guest Agent). See VM Disk Monitoring for details.

Does Pulse monitor Ceph?

Yes! If Pulse detects Ceph storage, it automatically queries cluster health, OSD status, and pool usage. No extra config needed.

Can I disable alerts for specific metrics?

Yes. Go to Alerts → Thresholds and set any value to -1 to disable it. You can do this globally or per-resource (VM/Node).

How do I monitor temperature?

Pulse uses a secure sensor proxy.

  1. Install lm-sensors on your host (apt install lm-sensors && sensors-detect).
  2. Run the Pulse setup script on the node again to install the sensor proxy. See Temperature Monitoring.

🔐 Security & Access

I forgot my password. How do I reset it?

Docker:

docker exec pulse rm /data/.env
docker restart pulse
# Access UI to run setup wizard again

Systemd: Delete /etc/pulse/.env and restart the service.

How do I enable HTTPS?

Set HTTPS_ENABLED=true and provide TLS_CERT_FILE and TLS_KEY_FILE environment variables. See Configuration.

Can I use Single Sign-On (SSO)?

Yes. Pulse supports OIDC (Settings → Security → OIDC) and Proxy Auth (Authentik, Authelia). See Proxy Auth Guide.

⚠️ Troubleshooting

No data showing?

  • Check Proxmox API is reachable (port 8006).
  • Verify credentials in Settings → Nodes.
  • Check logs: journalctl -u pulse -f or docker logs -f pulse.

Connection refused?

  • Check if Pulse is running: systemctl status pulse or docker ps.
  • Verify the port (default 7655) is open on your firewall.

CORS errors?

Set ALLOWED_ORIGINS=https://your-domain.com environment variable if accessing Pulse from a different domain.

High memory usage?

Reduce METRICS_RETENTION_DAYS (default 7) via environment variable if running on very constrained hardware.