mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-10 02:25:56 +00:00
rcourtman
11a8aa3b2f
A reverse-proxy deployment that set PROXY_AUTH_ROLE_HEADER without also setting PROXY_AUTH_ADMIN_ROLE granted every proxy-authenticated user full administrator access. CheckProxyAuth only evaluated roles when both values were non-empty, so the half-configuration skipped role gating entirely and returned isAdmin=true. docs/PROXY_AUTH.md has always documented an `admin` default for that variable, but the Config struct's envconfig `default` tags are legacy and never applied (config.go), so nothing ever populated it. CheckProxyAuth is the single admin verdict all 20+ proxy-auth gates consume, so the fail-open reached every one of them. Verified on a scratch instance with PROXY_AUTH_ROLE_HEADER set and no admin role: a request carrying only `X-Proxy-Roles: user` received HTTP 200 and the full admin payload from GET /api/system/settings, HTTP 200 from POST /api/system/settings/update, and proxyAuthIsAdmin=true from /api/security/status. All three now return 403 / false, while `X-Proxy-Roles: admin` still passes. Resolve the documented default in both layers that can produce the verdict: config load populates ProxyAuthAdminRole when proxy auth is configured, and CheckProxyAuth now keys role gating on the role header alone, resolving an empty admin role through config.DefaultProxyAuthAdminRole. Configuring a role header is the operator's signal that admin access is role-gated; leaving the admin role unset must not switch that off. Deployments that intentionally treat every proxied user as an admin are unaffected: that is still expressed by leaving the role header unset.
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.
- 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
- 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.