vrr/Pulse

mirror of https://github.com/rcourtman/Pulse.git synced 2026-05-10 12:00:17 +00:00

History

rcourtman a92a53fb98 fix: correct show_local URL path and hide subtitle when local login hidden - Update OIDC.md docs to show correct URL path (/?show_local=true, not /login) - Hide "Enter your credentials" subtitle when local login is hidden Related to #750		2025-11-27 16:23:44 +00:00
..
api	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
development	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
images
monitoring	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
operations	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
security	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
API.md
CONFIGURATION.md	Implement UI toggle for Hide Local Login (related to issue #750 )	2025-11-25 08:14:19 +00:00
DOCKER.md
DOCKER_MONITORING.md
FAQ.md	feat: serve install scripts from GitHub releases instead of main branch	2025-11-26 08:59:59 +00:00
HOST_AGENT.md
INSTALL.md	feat: serve install scripts from GitHub releases instead of main branch	2025-11-26 08:59:59 +00:00
KUBERNETES.md
MIGRATION.md	Refactor remaining docs and standardize naming	2025-11-25 00:28:33 +00:00
OIDC.md	fix: correct show_local URL path and hide subtitle when local login hidden	2025-11-27 16:23:44 +00:00
PROXY_AUTH.md	Refactor auth and monitoring docs to be concise	2025-11-25 00:26:00 +00:00
PROXY_CONTROL_PLANE.md	Refactor remaining docs and standardize naming	2025-11-25 00:28:33 +00:00
README.md	refactor: finalize documentation overhaul	2025-11-25 00:45:20 +00:00
RELEASE_NOTES.md	feat: serve install scripts from GitHub releases instead of main branch	2025-11-26 08:59:59 +00:00
REVERSE_PROXY.md
SCREENSHOTS.md
SCRIPT_LIBRARY.md	Refactor remaining docs and standardize naming	2025-11-25 00:28:33 +00:00
SECURITY.md
SECURITY_AUDIT_2025-11-07.md
SECURITY_CHANGELOG.md
TEMPERATURE_MONITORING.md	feat: serve install scripts from GitHub releases instead of main branch	2025-11-26 08:59:59 +00:00
TROUBLESHOOTING.md
UNIFIED_AGENT.md	feat: add auto-update support for unified agent	2025-11-25 23:15:03 +00:00
VM_DISK_MONITORING.md	Refactor auth and monitoring docs to be concise	2025-11-25 00:26:00 +00:00
WEBHOOKS.md
ZFS_MONITORING.md	Refactor remaining docs and standardize naming	2025-11-25 00:28:33 +00:00

README.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?

README.md Unescape Escape