Quick Start Guide
Get Inishi running in under 10 minutes. This guide walks you through the essential setup to start managing your network devices.
Understanding the Architecture
Inishi uses a Site-First architecture where everything is organized around physical or logical locations:
YOUR ORGANIZATION
│
┌───────────────┼───────────────┐
▼ ▼ ▼
┌──────┐ ┌──────┐ ┌──────┐
│ SITE │ │ SITE │ │ SITE │
│ NYC │ │ LA │ │ EU │
└──┬───┘ └──┬───┘ └──┬───┘
│ │ │
┌──▼───┐ ┌──▼───┐ ┌──▼───┐
│AGENT │ │AGENT │ │AGENT │
└──┬───┘ └──┬───┘ └──┬───┘
│ │ │
┌──────┼──────┐ │ ┌────┼────┐
▼ ▼ ▼ ▼ ▼ ▼
Router Switch FW Router Switch SwitchKey Concepts
| Concept | Description |
|---|---|
| Site | A physical location, customer network, or logical grouping (e.g., "Main Office", "Customer ABC") |
| Agent | A lightweight service running on-premises that communicates with your devices. Each site needs at least one agent. |
| Device | A network device (router, switch, firewall) that the agent can manage |
Quick Start (3 Steps)
Step 1: Create a Site
Sites are the foundation of Inishi. Create one for each location or customer you manage.
- Go to Sites in the sidebar
- Click Add Site
- Enter a name (e.g., "Main Office", "Customer ABC")
- Select an Agent to assign (or register one first — see Step 2)
- Click Add Site
Step 2: Register an Agent
Agents run on your network and communicate with devices on your behalf.
- Go to Agents in the sidebar
- Click How to Install for installation instructions
- Run the install command on a machine in your network:
docker run -d --network host ghcr.io/inishi-prod/agent:latest- Copy the registration token shown in the agent logs
- Click Register Agent and paste the token
- Assign the agent to your site (if not done in Step 1)
The agent makes outbound-only connections to Inishi's cloud. No inbound firewall ports required.
Step 3: Add Devices
Now you're ready to add network devices to manage.
- Go to Devices in the sidebar
- Click Add Device
- Enter the device details:
- IP Address: The device's management IP
- Driver: The platform type (Cisco IOS, Juniper, etc.)
- Site: Which site this device belongs to
- Add credentials (optional but recommended for testing)
- Click Add Device
Use the Discover button to automatically scan for devices on your network!
You're Ready!
Go to the Command Terminal and ask questions about your network in plain English:
- "Show me the interfaces on all routers"
- "What devices are in the NYC site?"
- "Run show ip route on router-01"
Next Steps
- Agent Installation Details — Docker, binary, or Python installation options
- Adding Devices — Bulk import and discovery
- Your First Commands — Example queries to get started