Skip to content

Installation Guide

Vasilis edited this page Mar 23, 2026 · 3 revisions

Installation Guide

OctapusPrime can be deployed via Docker (recommended) or bare-metal. Docker is the fastest path — one command installs every dependency including all 40+ security tools and the WiFi/aircrack-ng suite.


Option A — Docker (Recommended)

1. Install Docker

curl -fsSL https://get.docker.com | sudo sh
sudo usermod -aG docker $USER
sudo apt install -y docker-compose-plugin

2. Clone & Build

git clone https://github.com/Slayingripper/OctapusPrime.git
cd OctapusPrime
sudo docker compose up --build -d

The container runs with network_mode: host, privileged: true, and NET_ADMIN + NET_RAW capabilities — required for WiFi monitor mode, deauth, and GPIO access.

3. Verify

sudo docker compose logs -f
curl http://localhost:8080

4. Persistent Data

Host path Container path Purpose
./logs/ /opt/octapusprime/bin/logs Execution logs
./scenarios/ /opt/octapusprime/scenarios Saved scenario files

WiFi state and settings persist inside the container. Back them up with:

sudo docker cp octapus:/opt/octapusprime/settings.json .
sudo docker cp octapus:/opt/octapusprime/bin/webapp/handshakes/ ./handshakes-backup/

Option B — Bare-Metal

1. System Packages

sudo apt update && sudo apt upgrade -y
sudo apt install -y python3 python3-pip python3-venv python3-dev \
  git curl wget build-essential libssl-dev libffi-dev libpcap-dev \
  aircrack-ng wireless-tools iw

2. Security Tools

sudo apt install -y nmap masscan zmap amass subfinder
sudo apt install -y gobuster ffuf feroxbuster nikto whatweb sqlmap
sudo apt install -y testssl.sh sslscan trivy
sudo apt install -y hydra john hashcat
sudo apt install -y enum4linux nbtscan smbclient ldap-utils snmp

3. Clone & Install Python Dependencies

git clone https://github.com/Slayingripper/OctapusPrime.git
cd OctapusPrime
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

4. Run

source venv/bin/activate
python3 bin/webapp/server.py

Web UI available at http://localhost:8080.

5. Systemd Service (Production)

Create /etc/systemd/system/octapus-web.service:

[Unit]
Description=OctapusPrime Web Service
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/path/to/OctapusPrime
ExecStart=/path/to/OctapusPrime/venv/bin/python bin/webapp/server.py
Restart=always
RestartSec=3

[Install]
WantedBy=multi-user.target

Then enable and start:

sudo systemctl daemon-reload
sudo systemctl enable --now octapus-web.service

WiFi Adapter Setup

The WiFi Pwn module requires a wireless adapter that supports monitor mode.

Recommended Adapters

Chipset Driver Example Adapter
Atheros AR9271 ath9k_htl Alfa AWUS036NHA
Realtek RTL8812AU 8812au Alfa AWUS036ACH
Ralink RT3070 rt2800usb Alfa AWUS036NH

Verify Adapter

iw dev
sudo airmon-ng start wlan0
sudo airmon-ng stop wlan0mon

Inside Docker, USB adapters are automatically accessible thanks to privileged: true and network_mode: host.


Next Steps

Clone this wiki locally