mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-02-19 07:50:43 +01:00
dfe960deb4
Related to #617 This fixes a misconfiguration scenario where Docker containers could attempt direct SSH connections (producing [preauth] log spam) instead of using the sensor proxy. Changes: - Fix container detection to check PULSE_DOCKER=true in addition to system.InContainer() heuristics (both temperature.go and config_handlers.go) - Upgrade temperature collection log from Error to Warn with actionable guidance about mounting the proxy socket - Add Info log when dev mode override is active so operators understand the security posture - Add troubleshooting section to docs for SSH [preauth] logs from containers The container detection was inconsistent - monitor.go checked both flags but temperature.go and config_handlers.go only checked InContainer(). Now all locations consistently check PULSE_DOCKER || InContainer().
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.