Quick Start Guide

Get the **VULNRIX** platform up and running in your local air-gapped environment in under 10 minutes.

Prerequisites

  • Docker Engine 24.0+
  • Docker Compose v2.0+
  • NVIDIA Container Toolkit (Optional, for local LLM acceleration)
  • 16GB RAM (Minimum), 32GB (Recommended)

Installation

1. Authenticate & Pull (Pro Edition)

Access the private registry using your Pro license key. (Open-Source users can skip authentication and pull from the public `vulnrix/core` repo).

export VULNRIX_LICENSE_KEY="vrx_..."
echo $VULNRIX_LICENSE_KEY | docker login registry.vulnrix.com --username vulnrix_user --password-stdin
docker pull registry.vulnrix.com/pro:latest

2. Initialize the Environment

Generate the default configuration files.

docker run --rm -v $(pwd):/app registry.vulnrix.com/pro:latest init

3. Launch the Stack

docker-compose up -d

First Mission

Once the stack is running, navigate to https://localhost:3000 and login with the default credentials printed in the initialization logs.

Defining a Target

  1. Go to Targets > New Target.
  2. Enter the URL or IP range (e.g., https://example-corp.local).
  3. Select the Scan Profile: "Deep Logic Analysis".
  4. Click Engage Agents.

The Recon Agent will immediately begin passive enumeration. You will see real-time assets appearing in the Network Graph.