Skip to content

Installation

Jump to bottom
Stephen edited this page Feb 27, 2026 · 2 revisions

Installation

Prerequisites

Requirement Version Purpose
Docker 20.10+ Container orchestration
Docker Compose v2+ Multi-service deployment
Go 1.22+ Build the CLI binary (or use pre-built release)
Python 3.10+ Orchestrator & dashboard (runs inside Docker)

Test mode requires only Docker. Go is only needed if building from source.

Installation Options

Option A: Pre-built Binary

Download from GitHub Releases:

chmod +x labyrinth
./labyrinth --install        # Installs to ~/.local/bin

Option B: Build from Source

git clone https://github.com/DaxxSec/labyrinth.git
cd labyrinth
./scripts/install.sh

The install script will:

  1. Check for Go (install it if missing, with your permission)
  2. Build the CLI binary from source
  3. Install labyrinth to ~/.local/bin
  4. Update your shell PATH

Option C: Shell Script Only

If you just want to deploy without the CLI binary:

git clone https://github.com/DaxxSec/labyrinth.git
cd labyrinth
./deploy.sh -t

First Deployment

labyrinth deploy -t              # Deploy a test environment

This will:

  1. Run preflight checks (Docker, ports, images)
  2. Build all Docker images
  3. Start the Docker Compose stack
  4. Register the environment in ~/.labyrinth/environments/

Your portal trap is now live:

Service Address Purpose
SSH Portal Trap localhost:2222 Point offensive agents here
HTTP Portal Trap localhost:8080 Web-based attack surface
Web Dashboard http://localhost:9000 Real-time web dashboard
TUI Dashboard labyrinth tui Terminal monitoring dashboard

Verify Installation

Before your first real deployment, run the end-to-end smoke test. It builds the CLI, deploys the full stack, exercises every bait endpoint, verifies forensic capture, and tears down cleanly:

./scripts/smoke-test.sh

All 22 checks should pass. If any fail, check the output — common issues are Docker not running or ports already in use.

After that, you can check environment status at any time:

labyrinth status               # Check environment health
labyrinth list                 # List registered environments
labyrinth tui                  # Launch TUI monitoring

Uninstall / Teardown

labyrinth teardown labyrinth-test    # Tear down specific env
labyrinth teardown --all             # Tear down everything

The CLI binary can be removed from ~/.local/bin/labyrinth.

Next Steps

Project LABYRINTH

Home

Getting Started

Architecture

Layers

Operations

Clone this wiki locally