Skip to content
HeartBeatAgents

Installation FAQ

View as Markdown

Platform support, the Docker requirement, and license activation.

What platforms are supported?

macOS 12+ (Apple Silicon and Intel), Windows 10+, and Ubuntu 20.04+/Debian 11+/Fedora 36+ or equivalent on Linux (x64 and arm64). Full detail on System Requirements.

Why does it need Docker?

Docker provides the container isolation each agent's execution environment runs inside: the same isolation model described in Security. It's a hard requirement, not an optional extra, on every platform.

I paid for a plan: how do I activate it?

After payment, a magic link is sent to your email to sign in and activate your license. No password to set or remember.

Can I install it on a server instead of a desktop?

Yes. See Self-Hosting for the Docker-image deployment path, including how to verify image signatures before running one on infrastructure you're responsible for.

Does every team member need their own Docker install?

Not necessarily, but not because the desktop app can point itself at someone else's server; it can't, it always runs its own local Docker stack. Instead, a team can self-host one shared instance (see Self-Hosting) on a server, and team members reach that shared instance through an ordinary web browser at its URL, with no Docker and no desktop app needed on their own machines at all.

How do I verify a download hasn't been tampered with?

Every installer ships a SHA-256 checksum. Self-hosted Docker images are additionally signed with cosign via GitHub OIDC.

Installation isn't working: now what?

See Troubleshooting for known issues, starting with anything Docker-related. Most first-run failures trace back to Docker Desktop not running yet.