Skip to content
Breeze RMM

Agent Installation

The Breeze agent is a single Go binary (~8 MB) with no runtime dependencies. It runs as a system service and communicates with your Breeze server over HTTPS/WSS.

Supported Platforms

PlatformArchitectureBinary
Linuxamd64breeze-agent-linux-amd64
Linuxarm64breeze-agent-linux-arm64
macOSamd64 (Intel)breeze-agent-darwin-amd64
macOSarm64 (Apple Silicon)breeze-agent-darwin-arm64
Windowsamd64breeze-agent-windows-amd64.exe

Quick Install

Terminal window
# Download the agent
curl -fsSL -o breeze-agent \
  https://breeze.yourdomain.com/api/v1/agents/download/linux/amd64
chmod +x breeze-agent


# Enroll with your enrollment key
sudo ./breeze-agent enroll YOUR_ENROLLMENT_KEY \
  --server https://breeze.yourdomain.com \
  --enrollment-secret YOUR_ENROLLMENT_SECRET


# Install as a systemd service
sudo cp breeze-agent /usr/local/bin/breeze-agent
sudo systemctl enable breeze-agent
sudo systemctl start breeze-agent

What Enrollment Does

During enrollment, the agent:

  1. Collects system information (hostname, OS, architecture, hardware details)
  2. Sends an enrollment request with the enrollment key and secret
  3. Receives a unique brz_ bearer token, device ID, org ID, and site ID
  4. Stores configuration in a YAML file with 0600 permissions (owner-only)
  5. Creates the config directory with 0700 permissions

Verifying Installation

Terminal window
# Check service status
sudo systemctl status breeze-agent   # Linux
sudo launchctl list | grep breeze    # macOS
Get-Service BreezeAgent              # Windows (PowerShell)


# Check agent version
breeze-agent version


# Check enrollment status
breeze-agent status


# View agent logs
sudo journalctl -u breeze-agent -f                    # Linux
sudo tail -f /Library/Logs/Breeze/agent.log            # macOS
Get-Content "$env:ProgramData\Breeze\logs\agent.log"   # Windows

The device should appear in your Breeze dashboard within 60 seconds of enrollment.

Configuration File

After enrollment, the agent stores its configuration at:

OSPath
Linux/etc/breeze/agent.yaml
macOS/Library/Application Support/Breeze/agent.yaml
WindowsC:\ProgramData\Breeze\agent.yaml
agent_id: "uuid-..."
server_url: "https://breeze.yourdomain.com"
auth_token: "brz_..."
org_id: "uuid-..."
site_id: "uuid-..."
heartbeat_interval_seconds: 60
metrics_interval_seconds: 30
enabled_collectors:
  - hardware
  - software
  - metrics
  - network

Service Management

Terminal window
sudo systemctl start breeze-agent    # Start
sudo systemctl stop breeze-agent     # Stop
sudo systemctl restart breeze-agent  # Restart
sudo systemctl enable breeze-agent   # Enable on boot
sudo systemctl disable breeze-agent  # Disable on boot