Polish documentation: fix links, use local images, and beautify docs index
This commit is contained in:
courtmanr@gmail.com
parent
9bfc259d6b
commit
18a43ebcc4
2 changed files with 41 additions and 57 deletions
|
|
@ -19,7 +19,7 @@ Pulse is a modern, unified dashboard for your **Proxmox** and **Docker** estate.
|
||||||
|
|
||||||
Designed for homelabs, sysadmins, and MSPs who need a "single pane of glass" without the complexity of enterprise monitoring stacks.
|
Designed for homelabs, sysadmins, and MSPs who need a "single pane of glass" without the complexity of enterprise monitoring stacks.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
|
|
@ -56,7 +56,7 @@ Access the dashboard at `http://<your-ip>:7655`.
|
||||||
|
|
||||||
- **[Installation Guide](docs/INSTALL.md)**: Detailed instructions for Docker, Kubernetes, and bare metal.
|
- **[Installation Guide](docs/INSTALL.md)**: Detailed instructions for Docker, Kubernetes, and bare metal.
|
||||||
- **[Configuration](docs/CONFIGURATION.md)**: Setup authentication, notifications, and advanced settings.
|
- **[Configuration](docs/CONFIGURATION.md)**: Setup authentication, notifications, and advanced settings.
|
||||||
- **[Security](docs/SECURITY.md)**: Learn about Pulse's security model and best practices.
|
- **[Security](SECURITY.md)**: Learn about Pulse's security model and best practices.
|
||||||
- **[API Reference](docs/API.md)**: Integrate Pulse with your own tools.
|
- **[API Reference](docs/API.md)**: Integrate Pulse with your own tools.
|
||||||
- **[Troubleshooting](docs/TROUBLESHOOTING.md)**: Solutions to common issues.
|
- **[Troubleshooting](docs/TROUBLESHOOTING.md)**: Solutions to common issues.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,70 +1,54 @@
|
||||||
# Pulse Documentation Index
|
# 📚 Pulse Documentation
|
||||||
|
|
||||||
Use this index to navigate the documentation bundled with the repository. Each
|
Welcome to the Pulse documentation portal. Here you'll find everything you need to install, configure, and master Pulse.
|
||||||
section groups related guides so you can jump straight to the material you need.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Getting Started
|
## 🚀 Getting Started
|
||||||
|
|
||||||
- [INSTALL.md](INSTALL.md) – Installation guide covering script, Docker, and Helm paths.
|
- **[Installation Guide](INSTALL.md)**
|
||||||
- [FAQ.md](FAQ.md) – Common questions and troubleshooting quick answers.
|
Step-by-step guides for Proxmox LXC, Docker, Kubernetes, and bare metal.
|
||||||
- [MIGRATION.md](MIGRATION.md) – Export/import process for moving between hosts.
|
- **[Configuration](CONFIGURATION.md)**
|
||||||
- [DEV-QUICK-START.md](../DEV-QUICK-START.md) – Hot reload workflow for local development.
|
Learn how to configure authentication, notifications (Email, Discord, etc.), and system settings.
|
||||||
- **Post-install checklist**
|
- **[Migration Guide](MIGRATION.md)**
|
||||||
- [operations/audit-log-rotation.md](operations/audit-log-rotation.md) – Schedule regular sensor proxy log rotations after your first installation.
|
Moving to a new server? Here's how to export and import your data safely.
|
||||||
- [operations/sensor-proxy-log-forwarding.md](operations/sensor-proxy-log-forwarding.md) – Forward audit/proxy logs to your SIEM as soon as compliance retention is required.
|
- **[FAQ](FAQ.md)**
|
||||||
- [operations/auto-update.md](operations/auto-update.md) – Enable and verify the `pulse-update` timer before handing the system to on-call.
|
Common questions and quick answers.
|
||||||
- [operations/ADAPTIVE_POLLING_ROLLOUT.md](operations/ADAPTIVE_POLLING_ROLLOUT.md) – Plan the rollout when turning on adaptive polling beyond lab environments.
|
|
||||||
|
|
||||||
## Deployment Guides
|
## 🛠️ Deployment & Operations
|
||||||
|
|
||||||
- [DOCKER.md](DOCKER.md) – Container deployment walkthroughs and compose samples.
|
- **[Docker Guide](DOCKER.md)** – Advanced Docker & Compose configurations.
|
||||||
- [KUBERNETES.md](KUBERNETES.md) – Helm chart usage, ingress, persistence.
|
- **[Kubernetes](KUBERNETES.md)** – Helm charts, ingress, and HA setups.
|
||||||
- [REVERSE_PROXY.md](REVERSE_PROXY.md) – nginx, Caddy, Apache, Traefik, HAProxy recipes.
|
- **[Reverse Proxy](REVERSE_PROXY.md)** – Nginx, Caddy, Traefik, and Cloudflare Tunnel recipes.
|
||||||
- [DOCKER_MONITORING.md](DOCKER_MONITORING.md) – Docker/Podman agent installation.
|
- **[Port Configuration](PORT_CONFIGURATION.md)** – Changing default ports.
|
||||||
- [HOST_AGENT.md](HOST_AGENT.md) – Host agent installers for Linux, macOS, Windows.
|
- **[Troubleshooting](TROUBLESHOOTING.md)** – Deep dive into common issues and logs.
|
||||||
- [PORT_CONFIGURATION.md](PORT_CONFIGURATION.md) – Changing default ports and listeners.
|
|
||||||
|
|
||||||
## Operations & Monitoring
|
## 🔐 Security
|
||||||
|
|
||||||
- [CONFIGURATION.md](CONFIGURATION.md) – Detailed breakdown of config files and env vars.
|
- **[Security Policy](../SECURITY.md)** – The core security model (Encryption, Auth, API Scopes).
|
||||||
- [TEMPERATURE_MONITORING.md](TEMPERATURE_MONITORING.md) – Sensor proxy setup and hardening.
|
- **[Proxy Authentication](PROXY_AUTH.md)** – SSO integration with Authentik, Authelia, etc.
|
||||||
- [VM_DISK_MONITORING.md](VM_DISK_MONITORING.md) – Enabling guest-agent disk telemetry.
|
- **[Sensor Hardening](PULSE_SENSOR_PROXY_HARDENING.md)** – Securing the remote agents.
|
||||||
- [monitoring/](monitoring/) – Adaptive polling and Prometheus metric references.
|
|
||||||
- [WEBHOOKS.md](WEBHOOKS.md) – Notification providers and payload templates.
|
|
||||||
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) – Deep dive into common operational issues.
|
|
||||||
- [../cmd/pulse-sensor-proxy/README.md](../cmd/pulse-sensor-proxy/README.md) – Host-side sensor proxy installation and operations guide.
|
|
||||||
|
|
||||||
## Security
|
## 📡 Monitoring & Agents
|
||||||
|
|
||||||
- [SECURITY.md](../SECURITY.md) – Canonical security policy (root-level document).
|
- **[Docker Monitoring](DOCKER_MONITORING.md)** – Installing the lightweight agent for container metrics.
|
||||||
- [docs/security/](security/) – Sensor proxy network and hardening guidance.
|
- **[Host Agent](HOST_AGENT.md)** – Monitoring standalone Linux/Windows/macOS servers.
|
||||||
- [PROXY_AUTH.md](PROXY_AUTH.md) – Authenticating via Authentik, Authelia, etc.
|
- **[VM Disk Monitoring](VM_DISK_MONITORING.md)** – Enabling QEMU Guest Agent for disk stats.
|
||||||
- [TEMPERATURE_MONITORING_SECURITY.md](TEMPERATURE_MONITORING_SECURITY.md) – Legacy SSH considerations.
|
- **[Temperature Monitoring](TEMPERATURE_MONITORING.md)** – Setting up hardware sensors.
|
||||||
|
- **[Webhooks](WEBHOOKS.md)** – Custom notification payloads.
|
||||||
|
|
||||||
## Operations Runbooks
|
## 💻 Development
|
||||||
|
|
||||||
- [operations/sensor-proxy-config-management.md](operations/sensor-proxy-config-management.md) – Safe configuration updates using the built-in CLI, migration from inline config, and troubleshooting corruption issues.
|
- **[API Reference](API.md)** – Complete REST API documentation.
|
||||||
- [operations/audit-log-rotation.md](operations/audit-log-rotation.md) – Monthly/incident log rotation procedure that preserves the hash chain and validates scheduler health afterward.
|
- **[Dev Quick Start](../DEV-QUICK-START.md)** – Hot-reload workflow for contributors.
|
||||||
- [operations/ADAPTIVE_POLLING_ROLLOUT.md](operations/ADAPTIVE_POLLING_ROLLOUT.md) – Rollout/rollback plan for enabling adaptive polling in staging or production.
|
- **[Contributing](../CONTRIBUTING.md)** – How to contribute to Pulse.
|
||||||
- [operations/auto-update.md](operations/auto-update.md) – Lifecycle of the `pulse-update` timer/service: enablement, manual trigger, rollback, and observability.
|
- **[Mock Mode](development/MOCK_MODE.md)** – Developing without real infrastructure.
|
||||||
- [operations/sensor-proxy-log-forwarding.md](operations/sensor-proxy-log-forwarding.md) – Configure rsyslog + RELP/TLS to ship sensor proxy audit/proxy logs to centralized logging.
|
|
||||||
|
|
||||||
## Reference
|
---
|
||||||
|
|
||||||
- [API.md](API.md) – REST API overview with examples.
|
<div align="center">
|
||||||
- [api/SCHEDULER_HEALTH.md](api/SCHEDULER_HEALTH.md) – Adaptive scheduler API schema.
|
<p>Found a bug or have a suggestion?</p>
|
||||||
- [RELEASE_NOTES.md](RELEASE_NOTES.md) – Latest feature highlights and changes.
|
<a href="https://github.com/rcourtman/Pulse/issues">
|
||||||
- [SCREENSHOTS.md](SCREENSHOTS.md) – UI tour with annotated screenshots.
|
<img src="https://img.shields.io/badge/GitHub-Issues-green" alt="GitHub Issues" />
|
||||||
- [DOCKER_HUB_README.md](DOCKER_HUB_README.md) – Summarised feature list for registries.
|
</a>
|
||||||
|
</div>
|
||||||
## Development & Contribution
|
|
||||||
|
|
||||||
- [CONTRIBUTING.md](../CONTRIBUTING.md) – Repository-wide contribution guide.
|
|
||||||
- [script-library-guide.md](script-library-guide.md) – Working with shared Bash modules.
|
|
||||||
- [development/MOCK_MODE.md](development/MOCK_MODE.md) – Using mock data while developing.
|
|
||||||
- [MIGRATION_SCAFFOLDING.md](../MIGRATION_SCAFFOLDING.md) – Tracking temporary migration code.
|
|
||||||
|
|
||||||
Have an idea for a new guide? Update this index when you add documentation so
|
|
||||||
discoverability stays high.
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue