Quickstart

This puts one network on one board. It takes about ten minutes, most of it spent choosing the machine the agent will run on.

1. Create an account and an organization.

   Register at www.infrality.io/register. Agents belong to an organization, not to a person, so create one from the dashboard if you only have your personal space. You are its owner.

2. Create a board.

   In the organization, create a board for the network you are about to sweep — “Head office LAN”, for instance. The agent will draw onto it.

3. Create an API key.

   In the organization’s API keys section, create a key. It is shown once: copy it now. By default it is bound to the first agent that uses it and refused to every other — see API keys.

4. Install the agent on a machine inside the network.

   Something that stays on: a server, a VM, a mini PC, a Raspberry Pi.

   Linux or macOS

   curl -fsSL https://www.infrality.io/agent/install.sh | sudo bash

   Then put the key and the board in its configuration and start it. The details, for every platform, are in Install the agent and Connect it.

5. Sweep.

   The agent registers, shows as online in the organization’s Agents, and waits. Press Scan on it. Hosts appear on the board as each one is identified; the sweep of a /24 usually ends within a minute or two.

Nothing is scanned until somebody asks

An agent fresh out of the installer connects and waits. It sweeps only when somebody presses Scan, or once a repeat interval has been set on it. Installing it never starts traffic on its own.

What to do with the board next

• Name and describe the machines the sweep could not name: what the agent discovers explains where names come from.
• Bring in what a sweep cannot see — cloud, containers, virtual machines — from files your tools already export: Import into a board.
• Invite the people who keep the network and decide what they may change: members and how access works.
• Set the agent to sweep on its own, every day for instance: driving the agent from the dashboard.