mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-02-18 00:17:39 +01:00
74 lines
3.6 KiB
Markdown
74 lines
3.6 KiB
Markdown
# 📚 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](INSTALL.md)**
|
||
Step-by-step guides for Docker, Kubernetes, and bare metal.
|
||
- **[Configuration](CONFIGURATION.md)**
|
||
Learn how to configure authentication, notifications (Email, Discord, etc.), and system settings.
|
||
- **[Deployment Models](DEPLOYMENT_MODELS.md)**
|
||
Where config lives, how updates work, and what differs per deployment.
|
||
- **[Migration Guide](MIGRATION.md)**
|
||
Moving to a new server? Here's how to export and import your data safely.
|
||
- **[Upgrade to v5](UPGRADE_v5.md)**
|
||
Practical upgrade guidance and post-upgrade checks.
|
||
- **[FAQ](FAQ.md)**
|
||
Common questions and quick answers.
|
||
|
||
## 🛠️ Deployment & Operations
|
||
|
||
- **[Docker Guide](DOCKER.md)** – Advanced Docker & Compose configurations.
|
||
- **[Kubernetes](KUBERNETES.md)** – Helm charts, ingress, and HA setups.
|
||
- **[Reverse Proxy](REVERSE_PROXY.md)** – Nginx, Caddy, Traefik, and Cloudflare Tunnel recipes.
|
||
- **[Troubleshooting](TROUBLESHOOTING.md)** – Deep dive into common issues and logs.
|
||
|
||
## 🔐 Security
|
||
|
||
- **[Security Policy](../SECURITY.md)** – The core security model (Encryption, Auth, API Scopes).
|
||
- **[Proxy Auth](PROXY_AUTH.md)** – Authentik/Authelia/Cloudflare proxy authentication configuration.
|
||
|
||
## ✨ New in 5.0
|
||
|
||
- **[Pulse AI](AI.md)** – Optional assistant for chat, patrol findings, alert analysis, and execution workflows.
|
||
- **[Metrics History](METRICS_HISTORY.md)** – Persistent metrics storage with configurable retention.
|
||
- **[Mail Gateway](MAIL_GATEWAY.md)** – Proxmox Mail Gateway (PMG) monitoring.
|
||
- **[Auto Updates](AUTO_UPDATE.md)** – One-click updates for supported deployments.
|
||
- **[Kubernetes](KUBERNETES.md)** – 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](https://pulserelay.pro)**
|
||
- **[AI Patrol deep dive](AI.md)**
|
||
- **[Pulse Pro technical overview](PULSE_PRO.md)**
|
||
- **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](CENTRALIZED_MANAGEMENT.md).
|
||
|
||
## 📡 Monitoring & Agents
|
||
|
||
- **[Unified Agent](UNIFIED_AGENT.md)** – Single binary for host, Docker, and Kubernetes monitoring.
|
||
- **[Centralized Agent Management (Pro)](CENTRALIZED_MANAGEMENT.md)** – Agent profiles and remote config.
|
||
- **[Proxmox Backup Server](PBS.md)** – PBS integration, direct API vs PVE passthrough, token setup.
|
||
- **[VM Disk Monitoring](VM_DISK_MONITORING.md)** – Enabling QEMU Guest Agent for disk stats.
|
||
- **[Temperature Monitoring](TEMPERATURE_MONITORING.md)** – Agent-based temperature monitoring (`pulse-agent --enable-proxmox`). Sensor proxy has been removed.
|
||
- **[Webhooks](WEBHOOKS.md)** – Custom notification payloads.
|
||
|
||
## 💻 Development
|
||
|
||
- **[API Reference](API.md)** – Complete REST API documentation.
|
||
- **[Architecture](../ARCHITECTURE.md)** – System design and component interaction.
|
||
- **[Contributing](../CONTRIBUTING.md)** – How to contribute to Pulse.
|
||
|
||
---
|
||
|
||
Found a bug or have a suggestion?
|
||
|
||
[](https://github.com/rcourtman/Pulse/issues)
|