mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-04-26 10:31:17 +00:00
| .. | ||
| api | ||
| architecture | ||
| images | ||
| monitoring | ||
| operations | ||
| releases | ||
| security | ||
| AGENT_SECURITY.md | ||
| AI.md | ||
| API.md | ||
| AUTO_UPDATE.md | ||
| CENTRALIZED_MANAGEMENT.md | ||
| CONFIGURATION.md | ||
| DEPLOYMENT_MODELS.md | ||
| DOCKER.md | ||
| EVAL.md | ||
| FAQ.md | ||
| INSTALL.md | ||
| KUBERNETES.md | ||
| MAIL_GATEWAY.md | ||
| METRICS_HISTORY.md | ||
| MIGRATION.md | ||
| MULTI_TENANT.md | ||
| OIDC.md | ||
| PBS.md | ||
| PROXY_AUTH.md | ||
| PULSE_PRO.md | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| SCRIPT_LIBRARY.md | ||
| SECURITY.md | ||
| TEMPERATURE_MONITORING.md | ||
| TROUBLESHOOTING.md | ||
| UNIFIED_AGENT.md | ||
| UPGRADE_v5.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| ZFS_MONITORING.md | ||
📚 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 Auto-Fix and advanced AI analysis — Pulse Patrol is available to all with BYOK.
- Learn more at pulserelay.pro
- AI Patrol deep dive
- Pulse Pro technical overview
- What you actually get: Auto-fix + autonomous mode, alert-triggered deep dives, Kubernetes AI analysis, reporting, and agent profiles.
- 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 has been removed. - 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?
