Agentbeamdocs

Start here

MDM / Getting startedDevice managementOne place to understand your Apple and Windows fleet, deliver configuration, and request device actions.MDM / Getting startedSet up your workspaceRequest MDM access, check platform readiness, and get your first managed device into inventory.Agent CLI / Getting startedAgent CLI overviewUnderstand agent activity locally, scan the files your assistants use, and connect shared workspace controls when needed.Agent CLI / Getting startedCLI quickstartInstall Beam, capture a first event, and open your local activity dashboard.Agent CLI / Getting startedConnect a workspacePair your machine through the browser or an enrollment code, then verify identity and policy synchronization.
↑ ↓ to navigate · Enter to openEsc to close
Website Open dashboard
Agent CLI/Configuration
Configuration

Self-host the dashboard

Plan a licensed independent installation and connect CLI devices to its own API and browser origin.

On this page

The self-host bundle runs Dashboard v1 behind Caddy with PostgreSQL and an installation-bound license. It is independent of Beam Cloud. Use a tested release with matched dashboard and maintenance image digests, and keep deployment secrets outside source control.

Prepare the installation

Your operator needs a stable HTTPS hostname, the release images, an issued license, an installation ID, and securely generated application/bootstrap secrets. The bundle is in deploy/self-host and includes the Compose file, environment template, proxy configuration, and maintenance instructions.

Database setup and upgrades are explicit operator maintenance steps. Ordinary application startup does not change schema. Review release changes and back up an existing installation before any schema operation. The bundled application liveness endpoint does not establish schema readiness.

Bootstrap workspace access

After the operator initializes the installation, open /onboarding using the configured bootstrap email and private bootstrap token. Create the workspace, invite a second administrator, and test a lower-privilege account. Rotate the bootstrap token after setup.

Subsequent registrations require private invitation links. Protect them as credentials and verify domain and seat restrictions. Platform staff access is separate from workspace ownership.

Connect the CLI

Code
npm install -g @agent-beam/[email protected]
export BEAM_API_URL=https://beam.example.com
export BEAM_DASHBOARD_URL=https://beam.example.com
beam connect

Replace the hostname with your installation and keep both variables in the environment used by the CLI. Re-enroll devices when moving from Cloud to this independent workspace. Do not replace the local loopback collector URL with the remote hostname.

The MCP server remains a local stdio process. Its scanning tools do not automatically upload results; connecting a self-hosted dashboard does not turn it into a hosted MCP HTTP endpoint.

License, backup, and upgrades

License verification is offline and checks the installation binding, edition, expiry, and seats. Back up PostgreSQL, deployment secrets, license, and proxy identity volumes under your encryption and access policy. Test restoring to an isolated environment.

For upgrades, preserve data, review schema compatibility, deploy matching release images, apply the explicit maintenance procedure, and verify login, roles, pairing, ingestion, audit export, and revocation. Roll back images only when compatible with the resulting schema; otherwise restore matching backups and images together. Do not remove data volumes as a troubleshooting shortcut.

Verify operational requirements

The bundle does not implement enterprise SSO, SCIM, MFA, automated retention, SIEM push, or high availability. Authenticated multi-user behavior and your production storage/restore procedures require deployment acceptance. MDM services are deployed and activated separately.

Keep exploring

Explore the docs