Before you begin

Use an existing account in your configured application. IronAgents is in active development; access is arranged with the deployment administrator. Public self-service onboarding and production email delivery are not available yet. An owner or operator can add devices; a viewer can inspect them.

Choose a supported pilot platform: Windows 11 x64, Ubuntu 26.04 Server or Desktop, or the tested Apple silicon macOS environment. See the platform instructions before installation. Packages are development releases with signing limitations.

Create the device record

  1. Open the application and select the intended organization. An organization is an isolated workspace; a site is a grouping inside it.
  2. Add a machine with a recognizable name and the correct operating system. Assign its site deliberately because site policies can change its effective rules.
  3. Copy the single-use enrollment code. It expires after 15 minutes. Keep it out of chat, tickets, screenshots and shell history.
  4. Open your platform's download page from the application. Use that deployment's current, verified installation instructions.
  5. Enter the enrollment code at the installer's hidden prompt or the companion's Setup / enroll flow.

A hostname and the display name you choose are separate fields. Use distinct names so another operator can recognize the machine.

Confirm the result

Look for Connected in the companion and Checking in in the portal, with a recent received timestamp. A process marked running is not enough: the server must accept a check-in. CPU can need a second sample after startup; missing initial CPU is not a failed enrollment.

A record with no accepted check-in stays Waiting for first check-in. It does not create an offline incident. If enrollment succeeded but confirmation is pending, inspect the network and local agent status before creating another identity.

Protect continuity

Create VM templates before enrollment. Never clone or copy an enrolled agent's private state into another machine. Each device needs its own record and credential. Normal upgrades preserve identity and history; they do not require enrollment again.

If a code expires, issue a new one for the correct platform. If the server revokes a device credential, retries cannot repair it; an administrator must review the device lifecycle. Removing local files alone does not revoke the server credential.

Deployment addresses

Public examples use https://app.example.com as a placeholder. Replace it with the administrator-provided HTTPS application origin. Installation packages and one-time commands come from that application, not this documentation website. Do not substitute an unverified download host or disable certificate validation.