documentation

Install it, run it, wire it up.

Written for the person who is about to put the agent on a production machine and wants to know exactly what it will do there. 15 pages: install, operate, reference.

get started

Install the agent

Install the BE Hub agent on Windows, Linux, macOS, OPNsense, pfSense and Teltonika routers with one line from the company's install page. What it writes, how to upgrade and how to remove it.

get started

When the install line fails

Why the Windows install command fails with a TLS error on older servers, and what to do about the other common enrolment failures: elevation, proxies, execution policy, and a machine that installs but never appears in the fleet.

get started

Companies, users and roles

How BE Hub separates customers into companies, the three roles, creating users with temporary passwords, moving machines between companies and rotating tokens.

get started

Sign in and API keys

Username and password for people, API keys for scripts, temporary passwords, lockout, sessions and password changes.

operate

Alerts and notification rules

What raises an alert, severities and grace periods, the lifecycle, and how rules route alerts to email, SMS, phone calls and webhooks per company.

operate

Custom checks

The check document, all seventeen primitives, combinators, application and API checks with local secrets, ping history, the editor, and how BE AI writes a check from a sentence.

operate

BE AI: runs, proposals and scope

What starts an investigation, what the investigator may do, budgets, proposals and approvals, conversations, the nightly pass, including and excluding machines, and costs.

operate

Remote control

Watch or take control of a Windows machine from the BE Hub console: how a session starts, where it works, what is recorded, the per-company switch, and what is deliberately not built.

operate

Releases and roll-outs

How agent releases are signed offline, published to the hub, targeted at machines, tags or companies, and how a machine updates itself.

reference

Run your own hub

Run the BE Hub console on-premise or in your own cloud: the container, the data volume, environment variables, TLS and WebSockets, backups, upgrades, and moving from hosted.

reference

Agent configuration

Every field of the agent's local configuration file: hub address, enrollment token, shell permission, secrets for checks, heartbeat interval, ping targets, update address, certificate pinning.

reference

HTTP API

Every endpoint the console uses, with authentication, company scoping, approval semantics and examples.

reference

Security model

The invariants the hub enforces in code, what the agent can and cannot do, what the hub stores about credentials, and what is not a guarantee.

get started

Trial and billing

How the free trial works, what happens when it ends, how machines are counted, adding a payment method, invoices, cancelling and what is deleted when.

reference

Data and retention

What the hub stores, for how long, where, and how to export it.

quick start

Ten machines in an afternoon.

01

Sign in as superadmin, create a company, copy its install link.

02

Run the install line on each machine (elevated PowerShell on Windows, sudo on Linux and macOS, the shell on a firewall).

03

Watch them appear in the fleet within a minute; tag them.

04

Add one notification rule: critical alerts to your phone, warnings to email.

05

Ask BE AI a question about a machine. Approve one proposal. Read the audit trail.

Put BE Hub on ten machines this week.

A pilot takes an afternoon: one install link, your own approvals, your own data. Uninstall the agent and you are out.