mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-04-28 11:30:15 +00:00
fd39196166
- Refactor specialized docs for conciseness and clarity - Rename files to UPPER_CASE.md convention - Verify accuracy against codebase - Fix broken links |
||
|---|---|---|
| .. | ||
| api | ||
| development | ||
| images | ||
| monitoring | ||
| operations | ||
| security | ||
| API.md | ||
| CONFIGURATION.md | ||
| DOCKER.md | ||
| DOCKER_MONITORING.md | ||
| FAQ.md | ||
| HOST_AGENT.md | ||
| INSTALL.md | ||
| KUBERNETES.md | ||
| MIGRATION.md | ||
| OIDC.md | ||
| PROXY_AUTH.md | ||
| PROXY_CONTROL_PLANE.md | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| SCRIPT_LIBRARY.md | ||
| SECURITY.md | ||
| SECURITY_AUDIT_2025-11-07.md | ||
| SECURITY_CHANGELOG.md | ||
| TEMPERATURE_MONITORING.md | ||
| TROUBLESHOOTING.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 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.
- Troubleshooting – Deep dive into common issues and logs.
🔐 Security
- Security Policy – The core security model (Encryption, Auth, API Scopes).
📡 Monitoring & Agents
- Docker Monitoring – Docker/Podman agent installation.
- Host Agent – Host agent installers for Linux, macOS, Windows.
- 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?
