$ cd ~/inspectre && ls dist/

Download InSpectre

Pick the format that suits your setup. Docker is the recommended path; a pre-built VM appliance image is available now for VirtualBox, VMware and Proxmox. A Raspberry Pi image is coming soon.

available now

Docker

The full four-container stack (frontend · backend · probe · postgres) via Docker Compose. The recommended way to run InSpectre on any Linux host, NAS, or home server.

get from github docker hub images

available now

Virtual Machine

A self-contained qcow2 appliance with InSpectre pre-installed. Import into VirtualBox, VMware, or Proxmox and boot straight into the setup wizard. Online variant pulls containers from Docker Hub on first boot.

download vm image release notes

coming soon

Raspberry Pi

A flashable Raspberry Pi OS image with InSpectre baked in. Write it to an SD card, power on your Pi, and your network monitor is live.

coming soon

# Quick install

One command downloads InSpectre and walks you through the setup — no git clone required.

bash — interactive installer (recommended)

# Downloads and starts InSpectre interactively
curl -fsSL https://raw.githubusercontent.com/thefunkygibbon/InSpectre/main/inspectre-install.sh | bash

The installer checks all prerequisites (Docker, Docker Compose v2, curl, openssl), asks whether you're installing on x64 or Raspberry Pi and pulls the matching images, asks for an install directory, generates secure passwords and secret keys, optionally lets you set your IP range and interface, then starts the stack automatically — no git clone and no building required.

Or pull manually from Docker Hub

bash — manual Docker Hub deploy

# 1. Download the deploy compose file
curl -O https://raw.githubusercontent.com/thefunkygibbon/InSpectre/main/docker-compose.deploy.yml

# 2. Edit — change POSTGRES_PASSWORD and SECRET_KEY
#    Generate a key: openssl rand -hex 32

# 3. Start
docker compose -f docker-compose.deploy.yml up -d

# 4. Open http://localhost:3000 and complete the wizard

# docker hub images

thefunkygibbon/

inspectre-frontend

nginx + React SPA

thefunkygibbon/

inspectre-web

FastAPI backend

thefunkygibbon/

inspectre-probe

Network probe

The PostgreSQL database uses the official postgres:15-alpine image — no custom build.

Or clone from GitHub (developers / building from source)

recommended — inspectre.sh

# 1. Clone the repository
git clone https://github.com/thefunkygibbon/InSpectre.git
cd InSpectre

# 2. Bring the whole stack up
./inspectre.sh up

# 3. Open the UI and finish the setup wizard
# → http://localhost:3000

Helper commands. ./inspectre.sh up · down · rebuild · rebuild keep-data · logs — see the docs for details.

# Requirements

host

Any 64-bit Linux host with access to the network you want to monitor. The probe runs on the host network.

software

Docker Engine 24+ and the Docker Compose v2 plugin. No other dependencies to install.

network

A flat Layer-2 LAN for full ARP discovery & blocking. The probe auto-detects your interface and subnet.

roadmap — pi

Raspberry Pi image is coming.

A flashable Raspberry Pi OS image is in the works. Watch the repository to be the first to know when it lands. In the meantime, the VM appliance is ready to go.

▸ download vm image ▸ watch on github