mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-02-18 00:17:39 +01:00
f527e6ebd0
Fixes #1091 - addresses all three documentation issues reported: 1. Binary path: Changed from /usr/local/bin/pulse-agent (which doesn't exist in the main image) to /opt/pulse/bin/pulse-agent-linux-amd64 2. PULSE_AGENT_ID: Added to example and documented why it's required for DaemonSets (prevents token conflicts when all pods share one API token) 3. Resource visibility flags: Added PULSE_KUBE_INCLUDE_ALL_PODS and PULSE_KUBE_INCLUDE_ALL_DEPLOYMENTS to example, with explanation of the default behavior (show only problematic resources) Also added tolerations, resource requests/limits, and ARM64 note.
📚 Pulse Documentation
Welcome to the Pulse documentation portal. Here you'll find everything you need to install, configure, and master Pulse.
🚀 Getting Started
- Installation Guide Step-by-step guides for Docker, Kubernetes, and bare metal.
- Configuration
Learn how to configure authentication, notifications (Email, Discord, etc.), and system settings. - Deployment Models
Where config lives, how updates work, and what differs per deployment. - Migration Guide
Moving to a new server? Here's how to export and import your data safely. - Upgrade to v5
Practical upgrade guidance and post-upgrade checks. - FAQ
Common questions and quick answers.
🛠️ Deployment & Operations
- Docker Guide – Advanced Docker & Compose configurations.
- Kubernetes – Helm charts, ingress, and HA setups.
- Reverse Proxy – Nginx, Caddy, Traefik, and Cloudflare Tunnel recipes.
- Troubleshooting – Deep dive into common issues and logs.
🔐 Security
- Security Policy – The core security model (Encryption, Auth, API Scopes).
- Proxy Auth – Authentik/Authelia/Cloudflare proxy authentication configuration.
✨ New in 5.0
- Pulse AI – Optional assistant for chat, patrol findings, alert analysis, and execution workflows.
- Metrics History – Persistent metrics storage with configurable retention.
- Mail Gateway – Proxmox Mail Gateway (PMG) monitoring.
- Auto Updates – One-click updates for supported deployments.
- Kubernetes – Helm deployment (ingress, persistence, HA patterns).
🚀 Pulse Pro
Pulse Pro unlocks LLM-backed AI Patrol — automated background monitoring that spots issues before they become incidents.
- Learn more at pulserelay.pro
- AI Patrol deep dive
- Pulse Pro technical overview
- What you actually get: LLM-backed patrol analysis, alert-triggered deep dives, Kubernetes AI analysis, and optional auto-fix workflows.
- Technical highlights: correlation across nodes/VMs/backups/containers, trend-based capacity predictions, and findings you can resolve/suppress.
- Scheduling: 10 minutes to 7 days (default 6 hours).
- Agent Profiles (Pro): centralized agent configuration profiles. See Centralized Agent Management.
📡 Monitoring & Agents
- Unified Agent – Single binary for host, Docker, and Kubernetes monitoring.
- Centralized Agent Management (Pro) – Agent profiles and remote config.
- Proxmox Backup Server – PBS integration, direct API vs PVE passthrough, token setup.
- VM Disk Monitoring – Enabling QEMU Guest Agent for disk stats.
- Temperature Monitoring – Agent-based temperature monitoring (
pulse-agent --enable-proxmox). Sensor proxy is deprecated in v5. - Webhooks – Custom notification payloads.
💻 Development
- API Reference – Complete REST API documentation.
- Architecture – System design and component interaction.
- Contributing – How to contribute to Pulse.
Found a bug or have a suggestion?
