Pulse/docs

Pulse Documentation Index

Use this index to navigate the documentation bundled with the repository. Each section groups related guides so you can jump straight to the material you need.

---

Getting Started

• INSTALL.md – Installation guide covering script, Docker, and Helm paths.
• FAQ.md – Common questions and troubleshooting quick answers.
• MIGRATION.md – Export/import process for moving between hosts.
• DEV-QUICK-START.md – Hot reload workflow for local development.
• Post-install checklist
  • operations/audit-log-rotation.md – Schedule regular sensor proxy log rotations after your first installation.
  • operations/sensor-proxy-log-forwarding.md – Forward audit/proxy logs to your SIEM as soon as compliance retention is required.
  • operations/auto-update.md – Enable and verify the pulse-update timer before handing the system to on-call.
  • operations/ADAPTIVE_POLLING_ROLLOUT.md – Plan the rollout when turning on adaptive polling beyond lab environments.

Deployment Guides

• DOCKER.md – Container deployment walkthroughs and compose samples.
• KUBERNETES.md – Helm chart usage, ingress, persistence.
• REVERSE_PROXY.md – nginx, Caddy, Apache, Traefik, HAProxy recipes.
• DOCKER_MONITORING.md – Docker/Podman agent installation.
• HOST_AGENT.md – Host agent installers for Linux, macOS, Windows.
• PORT_CONFIGURATION.md – Changing default ports and listeners.

Operations & Monitoring

• CONFIGURATION.md – Detailed breakdown of config files and env vars.
• TEMPERATURE_MONITORING.md – Sensor proxy setup and hardening.
• VM_DISK_MONITORING.md – Enabling guest-agent disk telemetry.
• monitoring/ – Adaptive polling and Prometheus metric references.
• WEBHOOKS.md – Notification providers and payload templates.
• TROUBLESHOOTING.md – Deep dive into common operational issues.
• ../cmd/pulse-sensor-proxy/README.md – Host-side sensor proxy installation and operations guide.

Security

• SECURITY.md – Canonical security policy (root-level document).
• docs/security/ – Sensor proxy network and hardening guidance.
• PROXY_AUTH.md – Authenticating via Authentik, Authelia, etc.
• TEMPERATURE_MONITORING_SECURITY.md – Legacy SSH considerations.

Operations Runbooks

• operations/sensor-proxy-config-management.md – Safe configuration updates using the built-in CLI, migration from inline config, and troubleshooting corruption issues.
• operations/audit-log-rotation.md – Monthly/incident log rotation procedure that preserves the hash chain and validates scheduler health afterward.
• operations/ADAPTIVE_POLLING_ROLLOUT.md – Rollout/rollback plan for enabling adaptive polling in staging or production.
• operations/auto-update.md – Lifecycle of the pulse-update timer/service: enablement, manual trigger, rollback, and observability.
• operations/sensor-proxy-log-forwarding.md – Configure rsyslog + RELP/TLS to ship sensor proxy audit/proxy logs to centralized logging.

Reference

• API.md – REST API overview with examples.
• api/SCHEDULER_HEALTH.md – Adaptive scheduler API schema.
• RELEASE_NOTES.md – Latest feature highlights and changes.
• SCREENSHOTS.md – UI tour with annotated screenshots.
• DOCKER_HUB_README.md – Summarised feature list for registries.

Development & Contribution

• CONTRIBUTING.md – Repository-wide contribution guide.
• script-library-guide.md – Working with shared Bash modules.
• development/MOCK_MODE.md – Using mock data while developing.
• 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.