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. [The docs themselves live at your docs URL; this page is the index.]

start

Install the agent

Windows, Linux, macOS, OPNsense and pfSense, OpenWrt and Teltonika. What the install line does, where files go, how to remove it.

start

Companies, users and roles

Superadmin, company admin, operator. Creating a company, the install link, moving a machine, rotating a token.

start

Sign in and API keys

Passwords and sessions for people; API keys for scripts and the release publisher.

operate

Alerts and notification rules

What raises an alert, grace periods, severities, routing by tag and kind, email, SMS, phone call and webhook set-up.

operate

Custom checks

The fifteen primitives, combinators, the document format, and how BE AI writes one from a sentence.

operate

BE AI: runs, proposals, scope

Recipes, budgets, the nightly pass, including and excluding machines, daily caps, costs and usage.

operate

Releases and roll-outs

Signing, publishing, targets, states, release notes.

reference

Run your own hub

On-premise or in your cloud: the container, the data volume, environment variables, backups, upgrades, moving from hosted to self-hosted.

reference

Agent configuration

agent.json fields, allow_shell, sample interval, ping targets, certificate pinning.

reference

HTTP API

Every endpoint the console uses, scoped by company, with examples.

reference

Security model

The invariants, what is enforced where, and what is not guaranteed.

reference

Data and retention

Tables, what is kept for how long, exporting.

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.