mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-19 18:44:53 +00:00
fe9c64a4d3
The shell fetched `/api/state` on every sign-in for two reasons: to learn whether the session was authenticated, and to have something to render before the socket connected. On a real estate that is 96% resources, and the fetch sat on the critical path ahead of the websocket, which could not begin connecting until it returned. Neither reason survives. The session probe is now `/api/state/summary`, which passes the same auth and monitoring-read scope checks and returns a few hundred bytes. Navigation resolves from the platform admission facet. Nothing else in the shell read the payload: `state()` had exactly three consumers, two of them navigation and one an alert-count badge that the socket supplies. `/api/state` itself is untouched. It is the recovery path for a snapshot too large for a websocket frame, which is precisely what the largest estates need, so shrinking the endpoint would have removed the escape hatch for the installs that depend on it most. The seeded bootstrap state is gone rather than left empty. Keeping it would have been actively unsafe: `runtimeStateResolved()` meant "a payload arrived", so a bootstrap that no longer carried resources would still read as resolved and navigation would classify an empty estate, hiding every platform tab. Resolution is now websocket-backed, and an empty estate is answered by the facet admitting nothing, which is a resolved answer rather than an absent one. Verified against two backends built from this change: a populated estate resolves all six tabs, lands on the Proxmox overview and renders every platform page, and an estate with zero resources shows no platform tabs in the navigation landmark and lands on the infrastructure settings page. Both issue one summary probe and zero `/api/state` requests. Known regression: the alert-count badge is empty for the sub-second window before the socket delivers alerts, where the bootstrap payload used to supply it. The alerts store is not socket-synced, so reading the badge from it would have traded a brief empty count for a lastingly stale one. Tests that pinned the old mechanism were rewritten to their subjects: the SSO and proxy-auth cases keep their auth assertions, and the empty-estate distinction now asserts the facet admitting nothing rather than a full-state payload arriving. Contracts: performance-and-scalability records that the bootstrap is estate-independent and that `/api/state` stays the recovery path rather than a bootstrap surface; cloud-paid records the tenant probe. |
||
|---|---|---|
| .. | ||
| api | ||
| architecture | ||
| i18n | ||
| images | ||
| monitoring | ||
| operations | ||
| release-control | ||
| releases | ||
| security | ||
| security-review | ||
| AGENT_SECURITY.md | ||
| AGENT_SUBSTRATE.md | ||
| AI.md | ||
| AI_AUTONOMY.md | ||
| AI_PATROL_QUALIFICATION.md | ||
| AI_TRANSPARENCY.md | ||
| API.md | ||
| ASSISTANT_ARCHITECTURE.md | ||
| ASSISTANT_SAFETY.md | ||
| AUDIT_LOGGING.md | ||
| AUTO_UPDATE.md | ||
| CANONICAL_ALERT_ENGINE_MIGRATION_2026-03-10.md | ||
| CENTRALIZED_MANAGEMENT.md | ||
| CLOUD.md | ||
| CODE_SIGNING_POLICY.md | ||
| CONFIGURATION.md | ||
| DEPLOYMENT_MODELS.md | ||
| DOCKER.md | ||
| FAQ.md | ||
| INSTALL.md | ||
| KUBERNETES.md | ||
| MAIL_GATEWAY.md | ||
| METRICS_HISTORY.md | ||
| MIGRATION.md | ||
| MIGRATION_UNIFIED_NAV.md | ||
| MSP.md | ||
| MULTI_TENANT.md | ||
| OIDC.md | ||
| OIDC_SCOPE_GROUP_AUTH_FIX_SPEC.md | ||
| OPERATIONAL_TRUST.md | ||
| PATROL_ARCHITECTURE.md | ||
| PBS.md | ||
| PRIVACY.md | ||
| PRODUCTION_SECURITY.md | ||
| PROXY_AUTH.md | ||
| PULSE_PRO.md | ||
| RBAC.md | ||
| README.md | ||
| RECOVERY.md | ||
| RELAY.md | ||
| RELEASE_NOTES.md | ||
| REPO_BOUNDARY.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| SECURITY.md | ||
| SECURITY_REVIEW.md | ||
| STORAGE_ARCHITECTURE.md | ||
| TEMPERATURE_MONITORING.md | ||
| TROUBLESHOOTING.md | ||
| TRUENAS.md | ||
| UNIFIED_AGENT.md | ||
| UNIFIED_RESOURCES.md | ||
| UPGRADE_v5.md | ||
| UPGRADE_v6.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| ZFS_MONITORING.md | ||
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.