mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-10 02:25:56 +00:00
rcourtman
f9dc2f6466
Adds complete documentation for 2025-11-07 security audit and hardening: - SECURITY_AUDIT_2025-11-07.md: Full professional audit report - 9 security issues identified and fixed (4 critical, 4 medium, 1 low) - Detailed findings, remediations, and testing - Security posture improved from B+ to A - 85%+ reduction in exploitable attack surface - SECURITY_CHANGELOG.md: Detailed changelog with migration guide - Complete implementation details for all fixes - Configuration examples - Backwards compatibility notes - New metrics and features - DEPLOYMENT_CHECKLIST.md: Step-by-step deployment guide - Pre-deployment backup procedures - Deployment steps for Docker and LXC - Verification procedures - Rollback procedures - Troubleshooting guide - Success criteria - README.md: Updated with security hardening highlights - Links to audit report - Key security features added Audit performed by Claude (Sonnet 4.5) + Codex collaboration. All implementations by Codex based on Claude specifications. 100% remediation rate (9/9 issues fixed). 17 new tests added, all passing. Related to security audit 2025-11-07.
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.
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.
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.
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.
- CONTRIBUTING-SCRIPTS.md – Expectations for installer contributors.
- script-library-guide.md – Working with shared Bash modules.
- installer-v2-rollout.md – Process for shipping major installer updates.
- 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.