Pulse/docs

📚 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 Proxmox LXC, Docker, Kubernetes, and bare metal.
• Configuration
  Learn how to configure authentication, notifications (Email, Discord, etc.), and system settings.
• Migration Guide
  Moving to a new server? Here's how to export and import your data safely.
• 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.
• Port Configuration – Changing default ports.
• Troubleshooting – Deep dive into common issues and logs.

🔐 Security

• Security Policy – The core security model (Encryption, Auth, API Scopes).
• Proxy Authentication – SSO integration with Authentik, Authelia, etc.
• Sensor Hardening – Securing the remote agents.

📡 Monitoring & Agents

• Docker Monitoring – Installing the lightweight agent for container metrics.
• Host Agent – Monitoring standalone Linux/Windows/macOS servers.
• VM Disk Monitoring – Enabling QEMU Guest Agent for disk stats.
• Temperature Monitoring – Setting up hardware sensors.
• Webhooks – Custom notification payloads.

💻 Development

• API Reference – Complete REST API documentation.
• Dev Quick Start – Hot-reload workflow for contributors.
• Contributing – How to contribute to Pulse.
• Mock Mode – Developing without real infrastructure.

---

Found a bug or have a suggestion?