mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-04-28 19:41:17 +00:00
8ad02ce048
- FAQ.md: Replace LXC installer one-liner with Docker quick start - MIGRATION.md: Replace LXC mention with Kubernetes - README.md: Remove "Proxmox LXC" from installation methods list The install.sh script is a unified agent installer, not an LXC container creator. Pulse server installation is via Docker, Kubernetes helm, or manual systemd setup.
51 lines
2.1 KiB
Markdown
51 lines
2.1 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.
|
||
- **[Migration Guide](MIGRATION.md)**
|
||
Moving to a new server? Here's how to export and import your data safely.
|
||
- **[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).
|
||
|
||
## 📡 Monitoring & Agents
|
||
|
||
- **[Unified Agent](UNIFIED_AGENT.md)** – Single binary for Host and Docker monitoring.
|
||
- **[VM Disk Monitoring](VM_DISK_MONITORING.md)** – Enabling QEMU Guest Agent for disk stats.
|
||
- **[Temperature Monitoring](TEMPERATURE_MONITORING.md)** – Setting up hardware sensors.
|
||
- **[Webhooks](WEBHOOKS.md)** – Custom notification payloads.
|
||
|
||
## 💻 Development
|
||
|
||
- **[API Reference](API.md)** – Complete REST API documentation.
|
||
- **[Dev Quick Start](../DEV-QUICK-START.md)** – Hot-reload workflow for contributors.
|
||
- **[Architecture](../ARCHITECTURE.md)** – System design and component interaction.
|
||
- **[Contributing](../CONTRIBUTING.md)** – How to contribute to Pulse.
|
||
- **[Mock Mode](development/MOCK_MODE.md)** – Developing without real infrastructure.
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
<p>Found a bug or have a suggestion?</p>
|
||
<a href="https://github.com/rcourtman/Pulse/issues">
|
||
<img src="https://img.shields.io/badge/GitHub-Issues-green" alt="GitHub Issues" />
|
||
</a>
|
||
</div>
|