Installation Wizard

Select your deployment scenario to get personalized installation instructions.

Choose Your Hardware

Raspberry Pi 4/5

Guardian Tier - 1.5GB RAM minimum

Travel security hotspot
Home network protection
Personal privacy gateway

Intel N100/N200 Mini PC

Fortress Tier - 4GB RAM minimum

Small business edge router
VLAN network segmentation
Full IDS/IPS stack

Server / Cloud VM

Nexus Tier - 16GB RAM minimum

ML model training
Regional threat aggregation
ClickHouse analytics

IoT Gateway

Sentinel Tier - 256MB RAM minimum

DSM validator
LTE gateway protection
Minimal footprint

System Requirements

Supported Operating Systems

OS	Version	Status
Ubuntu	22.04 LTS, 24.04 LTS	Fully Supported
Debian	11 (Bullseye), 12 (Bookworm)	Fully Supported
Raspberry Pi OS	Bookworm (64-bit)	Fully Supported

Hardware Requirements by Tier

Tier	CPU	RAM	Storage	Network
Sentinel	1 core	256MB	4GB	100Mbps
Guardian	2 cores	1.5GB	16GB	1Gbps
Fortress	4 cores	4GB	64GB	2.5Gbps
Nexus	8+ cores	16GB+	256GB	10Gbps

Kernel Requirements

Version	XDP Support	Features
Linux 4.8+	Basic	Generic XDP mode
Linux 5.4+	Full	Native XDP, better performance
Linux 5.10+	Optimal	Advanced eBPF, full feature set

Check your kernel version:

uname -r

Installation Methods

The interactive bootstrap installer handles everything automatically:

cd Scripts/autonomous/install/
sudo ./hookprobe-bootstrap.sh

What it does:

Detects your environment
Installs all dependencies
Deploys systemd services
Runs initial provisioning
Starts monitoring agent

For advanced users who need more control:

# 1. Install dependencies
sudo apt install -y podman openvswitch-switch nftables python3-pip

# 2. Install Python dependencies
pip3 install -r requirements.txt

# 3. Create directories
sudo mkdir -p /opt/hookprobe/{scripts,agent,xdp,config,data}
sudo mkdir -p /var/log/hookprobe
sudo mkdir -p /etc/hookprobe

# 4. Copy files
sudo cp -r Scripts/autonomous/install/* /opt/hookprobe/scripts/
sudo cp -r Scripts/autonomous/qsecbit/* /opt/hookprobe/agent/

# 5. Install systemd units
sudo cp Scripts/autonomous/install/systemd/*.service /etc/systemd/system/
sudo cp Scripts/autonomous/install/systemd/*.timer /etc/systemd/system/

# 6. Enable and start
sudo systemctl daemon-reload
sudo systemctl start hookprobe-provision.service
sudo systemctl enable --now hookprobe-agent.service

# Future: Pull and run
podman pull ghcr.io/hookprobe/hookprobe:latest
podman run -d --name hookprobe hookprobe:latest

Tier-Specific Installation

Sentinel (IoT Validator)

sudo ./install.sh --tier sentinel

Minimal installation for constrained devices:

DSM validation only
Health monitoring
Low memory footprint

Guardian (Travel Companion)

sudo ./install.sh --tier guardian

Full portable security:

WiFi hotspot creation
L2-L7 threat detection
dnsXai DNS protection
Web dashboard

Fortress (Business Edge)

sudo ./install.sh --tier fortress --enable-aiochi --enable-lte

Advanced edge router:

VLAN segmentation
OpenFlow SDN
NAPSE IDS/NSM/IPS engine
Local ML inference

Nexus (ML Brain)

sudo ./install.sh --tier nexus --enable-gpu --enable-ha

Heavy compute workloads:

ClickHouse analytics
GPU-accelerated ML
High availability mode
Fleet management

Post-Installation Checklist

After installation, verify your deployment:

hookprobe-ctl status shows all services running
hookprobe-ctl health returns healthy
Web dashboard is accessible
QSecBit score is displaying (should be GREEN)
Logs show no errors: hookprobe-ctl logs

Firewall Configuration

If running a firewall, allow HookProbe ports:

# UFW (Ubuntu)
sudo ufw allow 8888/tcp  # Agent health check

# For Guardian WiFi hotspot
sudo ufw allow 67/udp    # DHCP
sudo ufw allow 53/udp    # DNS

Next Steps

Configuration

Customize network interfaces, XDP settings, and QSecBit thresholds. Configure HookProbe →

CLI Reference

Full documentation for the hookprobe-ctl management tool. View CLI Docs →