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:latestOptions explained:
| Flag | Purpose |
|---|---|
--network host | Allows agent to reach devices on your network |
--restart unless-stopped | Auto-restart on reboot |
-v ~/.inishi:/root/.inishi | Persist credentials and config |
Check agent logs for registration token:
docker logs inishi-agentLook for a line like:
Registration token: ag-xxxx-xxxx-xxxxBinary 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-agentPython 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.pyRegistration
After the agent is running, register it with Inishi:
- Copy the registration token from agent logs
- Go to Agents in the Inishi app
- Click Register Agent
- Paste the token and give the agent a name
- 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:
| Destination | Port | Purpose |
|---|---|---|
api.inishi.ai | 443 (HTTPS) | API communication |
| Your network devices | 22 (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 versionTroubleshooting
Agent is offline
- Check that the container is running:
docker ps | grep inishi - Check logs:
docker logs inishi-agent - Verify network connectivity:
curl -I https://api.inishi.ai/health
Device connection failures
- Verify SSH access from the agent's host:
ssh admin@device-ip - Check that the correct driver is selected in Inishi
- Verify credentials are correct
Registration token not appearing
- Wait 30 seconds — the token is generated on startup
- Check logs for errors:
docker logs inishi-agent - Ensure the agent can reach
api.inishi.ai
Next Steps
- Adding Devices — Connect your network equipment
- Your First Commands — Start querying your network