pulse/docs

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.

Need help with a failure? Read the safe reporting guidance before sharing evidence. A second reproduction or diagnostics export is not required; keep the original evidence if another attempt could interrupt workloads or send duplicate notifications. GitHub reports and attachments are public: review them locally and keep credentials and private details out.

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

• REST API
• Architecture
• Contributing
• Release notes index
• Development transparency disclosure

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.