Getting Started
Agent Installation

Agent Installation

The Inishi agent is a lightweight service that runs in your network and communicates with your devices. This guide covers all installation methods.

Security Model

Before installing, understand our security approach:

  • Outbound-only connections — The agent connects to Inishi's cloud; no inbound firewall ports needed
  • Credentials stay local — Device credentials are encrypted and stored on the agent, never uploaded to the cloud
  • Read-only by default — Start with diagnostic commands only, add write access when you're ready

Installation Methods

Docker (Recommended)

The fastest way to get started. Requires Docker installed on a Linux host with network access to your devices.

docker run -d \
  --name inishi-agent \
  --network host \
  --restart unless-stopped \
  -v ~/.inishi:/root/.inishi \
  ghcr.io/inishi-prod/agent:latest

Options explained:

FlagPurpose
--network hostAllows agent to reach devices on your network
--restart unless-stoppedAuto-restart on reboot
-v ~/.inishi:/root/.inishiPersist credentials and config

Check agent logs for registration token:

docker logs inishi-agent

Look for a line like:

Registration token: ag-xxxx-xxxx-xxxx

Binary Installation

Download a standalone binary for systems without Docker.

# Download latest release
curl -L https://github.com/inishi-prod/agent/releases/latest/download/inishi-agent-linux-amd64 -o inishi-agent
 
# Make executable
chmod +x inishi-agent
 
# Run
./inishi-agent

Python Installation (Development)

For development or when you need to customize the agent.

# Clone the repository
git clone https://github.com/inishi-prod/agent.git
cd agent
 
# Create virtual environment
python3 -m venv venv
source venv/bin/activate
 
# Install dependencies
pip install -r requirements.txt
 
# Run
python agent_grpc.py

Registration

After the agent is running, register it with Inishi:

  1. Copy the registration token from agent logs
  2. Go to Agents in the Inishi app
  3. Click Register Agent
  4. Paste the token and give the agent a name
  5. Assign it to a site
⚠️

Registration tokens expire after 1 hour. If yours has expired, restart the agent to generate a new one.

Network Requirements

The agent needs to reach:

DestinationPortPurpose
api.inishi.ai443 (HTTPS)API communication
Your network devices22 (SSH)Device management

Auto-Updates

The Docker agent auto-updates hourly via Watchtower. To pin a specific version:

docker run -d \
  --name inishi-agent \
  --network host \
  ghcr.io/inishi-prod/agent:2.1.0  # Specific version

Troubleshooting

Agent is offline

  1. Check that the container is running: docker ps | grep inishi
  2. Check logs: docker logs inishi-agent
  3. Verify network connectivity: curl -I https://api.inishi.ai/health

Device connection failures

  1. Verify SSH access from the agent's host: ssh admin@device-ip
  2. Check that the correct driver is selected in Inishi
  3. Verify credentials are correct

Registration token not appearing

  1. Wait 30 seconds — the token is generated on startup
  2. Check logs for errors: docker logs inishi-agent
  3. Ensure the agent can reach api.inishi.ai

Next Steps