Research Project: This is a free AI research project. No warranties, SLAs, or company associations. Learn more

Back to Guides
Getting Started
Beginner12 min

Edge Agent Setup & Deployment

Deploy the cross-platform edge agent with enrollment tokens, auto-update, and remote management capabilities

The BrainstormMSP Edge Agent (v1.0.11) is a lightweight Go binary that runs on Windows, Linux, and macOS. It provides 15 on-device tool categories, adaptive heartbeat, auto-update, and local autonomy for real-time endpoint management.

1

Enrollment Token

Generate an Enrollment Token

1. In BrainstormMSP, go to **Settings > Edge Agents > Enrollment**

2. Click **Generate Token**

3. Choose the target tenant (or select the default)

4. Copy the enrollment token — it is valid for 24 hours

Token Security

Each token is single-use and tenant-scoped

Tokens expire after 24 hours if unused

Revoking a token does not affect already-enrolled agents

The agent authenticates via WebSocket with the token on first connect

2

Platform Installation

Windows

1. Download `edge-agent.exe` from the BrainstormMSP portal or DO Spaces

2. Run as Administrator:

edge-agent.exe install --token YOUR_ENROLLMENT_TOKEN --server wss://brainstormmsp.ai/ws/edge

3. The agent installs as a Windows Service and starts automatically

Linux

1. Download the Linux binary

2. Install with:

sudo ./edge-agent install --token YOUR_ENROLLMENT_TOKEN --server wss://brainstormmsp.ai/ws/edge

3. Runs as a systemd service

macOS

1. Download the macOS binary or use the .pkg installer

2. Install with:

sudo ./edge-agent install --token YOUR_ENROLLMENT_TOKEN --server wss://brainstormmsp.ai/ws/edge

3. Runs as a launchd daemon

3

Auto-Update

How Auto-Update Works

The edge agent checks for updates on a configurable interval:

1. Agent queries the update server for the latest version

2. Compares current version (e.g., 1.0.11) with latest

3. If newer: downloads binary, verifies SHA-256 checksum, and restarts

4. Rollback: if the new binary fails health checks, reverts to previous version

Version Management

Current version: **1.0.11**

Version is reported in every heartbeat

View agent versions in **Settings > Edge Agents**

Force-update from the UI by clicking **Update Agent**

Self-Healing

If the agent process crashes:

Windows: Service Control Manager auto-restarts

Linux: systemd RestartSec=5 policy

macOS: launchd KeepAlive directive

4

Troubleshooting

Agent Not Connecting

1. Verify the enrollment token hasn't expired

2. Check network connectivity to brainstormmsp.ai:443

3. Ensure WebSocket connections aren't blocked by firewall

4. Check agent logs:

- Windows: `C:\ProgramData\BrainstormMSP\edge-agent.log`

- Linux: `/var/log/brainstormmsp/edge-agent.log`

- macOS: `/var/log/brainstormmsp/edge-agent.log`

Agent Shows Offline

Agents that miss 3 consecutive heartbeats are marked offline

The adaptive heartbeat adjusts from 30s (active) to 5min (idle)

Check the `last_heartbeat` timestamp in the agent detail view

Common Issues

**Port blocked**: WebSocket requires outbound 443/TCP

**Proxy**: Set `HTTPS_PROXY` environment variable before install

**Permissions**: Agent needs admin/root to manage services and collect telemetry

Completed!

You've completed the Edge Agent Setup & Deployment guide. Ready to continue learning?