mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-11 14:00:29 +00:00
rcourtman
ac328e1eee
Forty-two percent of paying installs never get Patrol running, and the support and issue evidence says the wall is model choice and cost: a prospect asked which models Pulse recommends before trying, a Pro customer picked Flash-Lite to save money and Patrol then could not file verdicts, and a mispriced Opus row tripped the 20 USD budget so the circuit breaker disabled Patrol with nothing but a log line (#1789). Answer both questions at the point of choice. The Patrol and shared default model pickers pin guided models in a "Suggested for Patrol" section with recommended / suggested / caution markers and a one-line reason: the Ollama preflight blessing is the only recommended entry, Gemini Flash-Lite the only caution, and cloud starting points are labelled price-driven and unqualified until this install's own readiness pass upgrades them to "Verified on this install". A server-computed cost preview sits under the model choice: monthly estimate from Pulse's price table, the schedule, and the install's own median full run once three priced runs exist (a measured 104,528-in / 4,491-out run otherwise), with the assumption stated and a token explained once, plus 30-day spend against budget. Each schedule preset is priced in the Schedule select. When a per-token model is picked while the schedule is still the 6-hour default, the cost model proposes the slowest preset that keeps scheduled runs under half the budget (20 USD reference when none is set) and says what the slower check costs in detection delay; a schedule the install already chose is never changed. A used-up budget is now a spending decision, not a provider fault: the budget refusal is a typed sentinel with the figures, classified as the budget_exhausted cause, excluded from circuit-breaker accounting, and promoted into the Patrol block state, so the Patrol page shows "Patrol paused" with the spend and limit and a "Raise the cost budget" action instead of "Check Patrol model".
Pulse documentation
Start here for installation, platform setup, security, operations, and Pulse Intelligence. Commands, configuration keys, image names, API fields, and product identifiers remain untranslated in localized guides.
Start here
- Install Pulse — signed Proxmox/Linux installation, Docker, Docker Compose, Kubernetes, and first-run setup.
- Production deployment and security — least-privilege Proxmox setup, root-agent boundaries, discovery, supply-chain verification, plan limits, scale evidence, and a rollout checklist.
- Upgrade from Pulse v5 — migration prerequisites, rollback, agent continuity, and post-upgrade checks.
- Configure Pulse — authentication, notifications, discovery, retention, and system settings.
- Deployment models — data locations, lifecycle, and differences between supported deployment paths.
- Troubleshooting and FAQ — common failures, diagnostics, and operator questions.
Localized getting started guides: Deutsch · Español
Platforms and agents
- Proxmox Backup Server
- Proxmox Mail Gateway
- Docker and Podman
- Kubernetes and Helm
- TrueNAS SCALE and CORE
- Unified Agent
- Agent security
- VM disk monitoring
- ZFS monitoring
- Temperature monitoring
VMware vSphere support is early access. Current builds expose dedicated vSphere inventory and recovery context, but operators should validate the integration against their own vCenter before production use.
Monitoring and operations
- Metrics history
- Recovery data
- Webhooks
- Automatic updates
- Centralized agent management (Pro)
- Operational trust model
- Current product screenshots
Pulse Intelligence
- Assistant, Patrol, and external-agent overview
- Patrol modes and safety
- Assistant safety model
- External agent HTTP and MCP substrate
Patrol watch-only analysis is available on Community with a local model or the operator's own provider. Investigation and governed fixes require the relevant Pulse Pro capabilities.
Security, privacy, and access
- Production deployment and security
- Security review scope
- Authentication and credential storage review packet
- Security guide
- Privacy and telemetry disclosure
- OIDC and SSO
- Proxy authentication
- Role-based access control (Pro)
- Audit logging (Pro)
- Reverse proxy configuration
- Code-signing policy
Plans and managed access
- Community, Relay, and Pro capabilities
- Relay and Pulse Mobile handoff
- Multi-tenant organizations (Enterprise/custom)
- Provider-hosted MSP operations (request-assisted)
Pulse Cloud is not generally available. Ordinary self-hosted Pulse remains the primary installation path; MSP and Enterprise access are explicit commercial paths rather than defaults in self-hosted setup.
Development and reference
Detailed design notes and dated migration specifications may remain in this directory for maintainers, but they are not operator setup guides unless they are linked from the sections above.
Previous versions and migrations
- Upgrade from v4 to v5
- Retired unified-navigation migration — historical context only; current Pulse uses platform-shaped navigation.
- Move a Pulse installation
Found a bug? Use the issue forms. For setup questions, use GitHub Discussions.