Development

Development

Backend (single-node)

# Install SDK first — backend imports it
pip install -e sdk/

cd backend
python -m venv .venv && source .venv/bin/activate
pip install -e .

uvicorn gloomproxy.main:app --reload --port 8000
# Proxy listening on  :8080
# API on              :8000
# WebSocket on        ws://localhost:8000/ws/events

Frontend

cd frontend
npm install
NEXT_PUBLIC_API_URL=http://localhost:8000/api \
NEXT_PUBLIC_WS_URL=ws://localhost:8000/ws/events \
npm run dev
# http://localhost:3000

Docker — single-node

docker compose up --build
# API:      http://localhost:8000
# UI:       http://localhost:3000
# Proxy:    127.0.0.1:8080

Docker — cluster mode

docker compose --profile cluster up --build

# Scale workers independently:
docker compose --profile cluster up --scale worker=4

OctoRig lab targets

Vulnerable targets for testing live in OctoRig.

cd OctoRig
./octorig.sh start 8    # Lab 8  — BreachSQL Fire Range, port 17476
./octorig.sh start 9    # Lab 9  — StingXSS range, port 17477
./octorig.sh start 12   # Lab 12 — OWASP Juice Shop, port 3000
./octorig.sh status
./octorig.sh stop all

Connect the stack to OctoRig networks:

./gloomproxy.sh --lab-net