mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-27 14:07:31 +00:00
rcourtman
fb84cdaebf
After the useRecoveryPoints trim in #2773 the TrueNAS Protection tab reads only the points. The decode still carried the endpoint's pagination meta (page, limit, total, totalPages) through normalizeRecoveryMeta, the meta field on both points response types, the hook's initialValue and several test fixtures, none of which anything reads. A whole-program checker scan over src and tests (positive control: the data member, read in the hook and a test; negative control: eight planted readers all found) showed zero reads of the normalized or transport meta. The one read of the transport meta was the decode itself, and the four RecoveryResponseMeta members were read only inside normalizeRecoveryMeta. The response is never spread, serialized or iterated, and the query layer treats the value as opaque. Remove the decode, the meta fields on RecoveryPointsResponse and RecoveryPointsTransportResponse, the initialValue meta and the meta fixtures. RecoveryResponseMeta stays: the protection postures response type still declares it. recoveryTransport.test.ts pins the new shape: the response types' keys are exactly data (a type-level pin that fails under tsc), and a backend-shaped response that includes meta decodes to the points alone. The backend response and internal/api/recovery_handlers.go are unchanged, and the contract prose now says the frontend decode carries the points alone. A before/after production build pair differs in one chunk (the TrueNAS page chunk, 387 bytes smaller) and only by the removed statements; the CSS and the other 93 files are identical apart from chunk hashes. The TrueNAS Protection tab shows the same rows, filters, search results and detail panel at desktop and phone width, and the backend still sends meta in every response. Coverage of the hook and the decode loses nothing but the removed meta statements.
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.
- Releases and update channels: choosing Stable or Preview, beta and RC expectations, and how releases are tested and promoted.
- 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.