rcourtman
b8a0f87e6b
Rebuilds #2432 as one commit on current main. Its branch conflicted with the Tailwind 4 move (#2443) in StackedDiskBar.tsx and DockerTasksTable.tsx; the resolution keeps this change and main's class renames (rounded-sm to rounded-xs). The eight original commits' reasons follow. Read PBS datastore status in the storage vocabulary: The PBS poller reports a datastore as "available", or "unavailable" when PBS returns an error for it. The datastore adapter mapped that string through the generic status mapper, which only knows online, offline and warning, so every healthy PBS datastore showed as "Unknown" in the Storage tab and an unavailable one was not flagged. PVE storage already maps the same vocabulary through its own storage mapper. Share that mapping so a PBS datastore reads online or offline like any other storage. Carry shared PBS storage as one cluster row in the mock estate: The mock emitted each cluster's two shared PBS storages once per node, each with its own usage figure. The real poller folds a shared storage into one cluster-scoped entry, which users asked for in issue 1049, so the demo's Storage tab contradicted the shipped behaviour: ten rows of "west-backup-primary" with different usage and growth on a five-node estate, and a hundred on the public demo. The fixture now carries the merged shape: one row per store with the reporting nodes listed and a cluster-scoped id, offline only when no cluster node is online. Name Proxmox storage types and shared hosts as operators know them: The Storage tab title-cased any storage type it did not map, so the default local-lvm on every Proxmox install read "Lvmthin" and an NFS share read "Nfs". Those types now carry the names the Proxmox UI uses: LVM-Thin, LVM, NFS, SMB/CIFS, iSCSI, ZFS, BTRFS, GlusterFS and ESXi. A storage the poller merged across the cluster showed the synthetic node marker "cluster" as its host. It now reads "Shared", with the reporting node count when the storage lists its nodes. Carry PMG metadata on REST-mapped resources: The Mail Gateway table reads resource.pmg. The REST-to-Resource mapper set every other provider facet at the top level but kept pmg only under platformData, so a row sourced from the REST snapshot rendered every PMG column (version, nodes, mail in, spam, virus, quarantine, queue, deferred) as a dash. The websocket snapshot carries pmg at the top level, so the table filled in only when a websocket row happened to replace the REST row; on a fresh load the two transports race, and about half the loads stayed blank for good. The mapper now carries pmg like the other facets, and a test pins it. Label multi-disk hosts with their fullest disk in Bars mode: A host with more than one agent-reported disk draws its Disk cell as one micro-bar per disk and no figure, while a single-disk host shows a percentage and Trends mode shows one for every host. Bars is the default view, and most Proxmox nodes have at least local-zfs beside a data pool, so the question "which node is running out of space?" had no at-a-glance answer for the rows that matter most; the column's own sort key was a number the cell never showed. The cell now carries the fullest disk's usage beside the micro-bars. Every bar keeps equal weight and no disk is named in the row; the mount and the per-disk breakdown stay in the title and the tooltip. Carry source status, action readiness and technology on REST rows: The same race that blanked the Mail Gateway table applies to three more fields the API returns: sourceStatus, actionReadiness and technology. The REST mapper set sourceStatus only under platformData and dropped the other two, while websocket rows carry all three at the top level. Docker container lifecycle actions read sourceStatus and actionReadiness to decide refusals, storage rows read sourceStatus for freshness, and search suggestions and the assistant context read technology, so whichever transport won a fresh load decided whether those consumers saw the data. The mapper now carries all three, the REST type declares the two it omitted, and the PMG mapping test pins them. Fit the Docker containers table and read Swarm state as words: On a 1280-1536px laptop window the containers table clipped its short values: the engine read "docker 2…", host names lost their tail, and the Update control itself was cut off, while the percentage-only CPU and memory bars had room to spare. The compact widths now give those columns their share. On a phone the row dropped to "runni…" with an unreadable Restarts header beside a wrapped Update button; the phone row now keeps container, state, CPU, memory and Update, and the restart count stays in the row expansion until mobile width. The images table on a phone showed "Not c…" for the update verdict and a clipped host; it keeps image, size and update check there and defers host and consumers to the expansion. Swarm services showed the rollout state as the raw token "rollback_started" and Swarm tasks showed a raw RFC3339 stamp with microseconds as their start time. The state reads as words and the start as an age, with the raw values in the title. Keep demo Docker container names unique per host: The demo scenario reused its curated container profiles for a second round on hosts with more containers than profiles, so a host showed two running "customer-portal" rows and every image's "used by" list read "customer-portal, customer-portal". Docker refuses two containers with one name on a host, so the duplicates read as a bug to anyone evaluating the demo. A reused profile now takes a numbered suffix. Contract-Neutral: Storage type labels, shared-host label, REST mapper carrying fields websocket rows already carry, Bars-mode disk label and Docker column fits are presentation and mapping only; owning unified-resources and storage-recovery clauses updated; no frontend-primitives primitive, API or runtime boundary change
Pulse
Real-time Proxmox, Docker and Kubernetes monitoring that finds what needs attention.
Pulse is a self-hosted monitoring workspace for Proxmox, Docker, Kubernetes, TrueNAS, physical and virtual machines, and early-access VMware vSphere environments. It combines live infrastructure state, history, alerts, recovery visibility, and scheduled health checks without requiring a conventional enterprise monitoring stack.
Why Pulse
- It watches between visits. Alerts and Pulse Patrol find failed backups, capacity pressure, restart loops, unhealthy containers, clock drift, and other problems that dashboards cannot surface when nobody is looking.
- It keeps each platform familiar. Proxmox, Docker, Kubernetes, TrueNAS, vSphere, and machines have dedicated views, backed by one shared resource model for search, alerts, history, and investigation.
- It stays operator-controlled. Credentials are encrypted at rest, API tokens are scoped, agent commands are disabled by default, and governed fixes require the configured policy and approval path.
Platform coverage
| Platform | Coverage |
|---|---|
| Proxmox VE, PBS, and PMG | Nodes, guests, storage, backups, replication, Ceph, mail gateways, and alerts |
| Docker and Podman | Hosts, containers, Compose projects, Swarm services, health, images, and updates |
| Kubernetes | Clusters, nodes, workloads, pods, services, storage, and events through the unified agent |
| TrueNAS SCALE and CORE | Pools, datasets, disks, snapshots, replication tasks, apps, VMs, and alerts |
| Linux, Windows, and macOS machines | Host health, filesystems, networking, temperatures, RAID, and availability through the unified agent |
| VMware vSphere | Early-access inventory, hosts, clusters, VMs, datastores, networks, snapshots, and recovery context; validate against your own vCenter before production use |
Platform pages keep storage and recovery information beside the infrastructure it belongs to. Alerts, Actions, and Patrol remain cross-platform views.
Patrol: monitoring that does rounds
Pulse Patrol runs scheduled checks across the current state and recent history of your infrastructure. Community installations can use a local model or their own AI provider for watch-only analysis. Pulse Pro adds investigation and policy-bound fixes with approval, verification, and an audit trail.
Pulse also includes an interactive Assistant and an MCP adapter for external clients such as Claude Code and OpenCode. Both sit on top of the same scoped inventory, metrics, alert, storage, and governed-action contracts.
Quick start
Choose an exact version from the latest release and keep that version pinned during installation.
Docker
docker run -d \
--name pulse \
-p 7655:7655 \
-v pulse_data:/data \
-e PULSE_DEPLOYMENT_METHOD=docker_run \
--restart unless-stopped \
rcourtman/pulse:vX.Y.Z
Open http://<your-ip>:7655 and follow the bootstrap-token setup. Docker host
monitoring is provided by the unified agent; the Pulse server container does
not need the Docker socket.
Proxmox LXC, Linux, and Kubernetes
The installer is signed. Verify install.sh against the pinned
pulse-installer key before running it:
export PULSE_VERSION=vX.Y.Z
curl -fsSLO "https://github.com/rcourtman/Pulse/releases/download/${PULSE_VERSION}/install.sh" &&
curl -fsSLO "https://github.com/rcourtman/Pulse/releases/download/${PULSE_VERSION}/install.sh.sshsig" &&
ssh-keygen -Y verify \
-f <(printf '%s\n' 'pulse-installer namespaces="pulse-install" ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMZd/DaH+BldzOkq1A8KVTcFk73nAyrE8aJOyf7i00jm pulse-installer') \
-I pulse-installer \
-n pulse-install \
-s install.sh.sshsig < install.sh &&
bash install.sh --version "${PULSE_VERSION}"
Paste the whole block: installation stops if either download or signature verification fails. Do not run the final command separately to bypass a failure.
The GitHub installer installs the Pulse server. Install and upgrade agents (including v5-to-v6 agent upgrades) with the per-host command generated under Settings → Infrastructure → Install on a host.
Do you need an agent?
Often not. Proxmox VE, PBS, and PMG are monitored through the Proxmox API with a read-only token, so nothing runs on the host and the generated setup script creates a privilege-separated monitoring user. Install the unified agent only where you want data the platform API cannot provide, such as host SMART health, temperatures, Docker hosts, or standalone machines.
The agent is operator-controlled by design. Command execution is off by
default, the local listener binds to localhost, and generated systemd units
ship hardened. On Linux, the installer's --least-privilege profile runs the
service as a dedicated non-root user, with optional scoped sudo grants for
the few collectors that need elevation. The
agent security model documents exactly what the
agent can and cannot do at each privilege level.
Important
GitHub release assets and
rcourtman/pulseimages are Community builds. Relay, Pro, and eligible legacy customers should use the private image or Linux archive provided by the Pulse download portal. Replacing a private Pro runtime with a public Community build removes its private runtime hooks.
Editions
- Community — self-hosted monitoring, seven days of metric history, core SSO, update alerts, and Patrol with your own provider or local model.
- Pro — Community plus Patrol investigation, governed fixes, ninety days of history, centralized agent profiles, RBAC, audit logging, and reporting.
- MSP — for managed service providers: one Pulse Account running many client workspaces, each with an isolated Pulse runtime — separate dashboards, alerts, users, audit history, and reports. Free sixty-day two-client evaluation at Pulse for MSPs.
Relay is no longer sold. Existing Relay subscribers receive Pro features at their current price for as long as their subscription continues. Existing paired phones keep working until 31 March 2027. Relay connects the app, not the web UI. Use your own VPN or tunnel for remote web access. For phone alerts, add an ntfy, Gotify or Pushover destination and open Pulse in your phone's browser.
Core self-hosted monitoring is not gated by monitored-system or child-resource volume. See the runtime-aligned capability reference and current plans for details.
Documentation
- Install and deployment
- Production deployment and security
- Upgrade from Pulse v5
- Releases and update channels
- Configuration
- Platform and agent guides
- Pulse Intelligence
- Security and privacy
- Code signing policy
- Troubleshooting
- API reference and architecture
Localized getting started guides: Deutsch · Español
Development
Pulse uses Go 1.26 and a SolidJS/TypeScript frontend. The managed development
runtime starts the frontend at http://127.0.0.1:5173 and proxies API and
WebSocket traffic to the backend on port 7655.
npm ci
npm --prefix frontend-modern ci
npm run dev
Useful checks:
go test ./...
npm --prefix frontend-modern test
npm --prefix frontend-modern run type-check
python3 scripts/check_public_docs.py
See CONTRIBUTING.md before investing in a code change. Pulse uses an issue-first contribution process and does not normally accept unsolicited pull requests.
Community and support
- Ask questions in GitHub Discussions.
- Report reproducible bugs through GitHub Issues.
- Home Assistant users can use the community-maintained Pulse add-ons.
- If Pulse is useful to you, support its development through GitHub Sponsors or Ko-fi.
License
Everything in this repository is licensed under the MIT License. There is no dual licensing and no commercial or source-available code here.
Pulse Pro is a separate commercial product, built from private sources and distributed through pulserelay.pro. Its use is governed by the Terms of Service, which apply to that product only, not to anything in this repository.