references/INDEX.md

GitHub

Ludus Documentation Reference Index

This index provides a categorized guide to all Ludus documentation references. Use this to locate the appropriate document for a given topic.

Core Concepts

Document Description When to Reference
Introduction What Ludus is, system requirements, getting started overview Understanding Ludus basics, checking hardware requirements
Range Configuration Full range config YAML format with all fields documented Writing or modifying range configuration files
Range Config Schema Detailed JSON schema reference for all config properties, types, and constraints Validating config values, understanding field constraints and enums
CLI Reference Complete Ludus CLI command reference Looking up CLI commands, flags, and usage patterns
API Reference Full REST API endpoint documentation Interacting with Ludus programmatically, understanding API capabilities

Quick Start Guides

Document Description When to Reference
Install Ludus Server installation on Debian 12/13 or Proxmox 8/9 First-time Ludus server setup
Create a User Creating users, setting API keys, getting Proxmox credentials Initial user setup after install
Build Templates Building VM templates from ISOs Setting up base VM templates
Deploy a Range Deploying ranges, WireGuard setup, accessing VMs Deploying and accessing a range for the first time
Testing Mode Entering/exiting testing mode, allowing domains and IPs Using testing mode for safe tool/technique testing
Local CLI Setup Installing CLI on local machine, WireGuard, SSH tunnels Setting up remote Ludus management

Infrastructure & Networking

Document Description When to Reference
Networking Network architecture, VLANs, firewall rules, testing mode, packet capture Understanding Ludus networking, writing firewall rules
DNS AdGuard Home DNS, query logs, DNS rewrites, custom filtering DNS configuration and troubleshooting
Templates Template overview, builtin/custom templates, performance tuning Creating or modifying VM templates
Storage Storage types (Directory, LVM-thin, ZFS, Ceph), adding storage Storage configuration and planning

Range Management

Document Description When to Reference
Roles Using Ansible roles, role_vars, community role catalog Adding automation roles to VMs
Deploy Tags All deploy tags with meanings, common use cases Partial deployments, redeploying specific components
Snapshots Creating, reverting, and managing VM snapshots Snapshot management outside of testing mode
Sharing Sharing ranges between users, workshops, multi-range setups Collaborative range access
File Share SMB file share server setup and usage Sharing files between ranges
Nexus Cache Chocolatey/NuGet package caching Speeding up deployments, avoiding rate limits
Passwords Default credentials for all VM types Logging into VMs, changing domain passwords

Deployment Options

Document Description When to Reference
Bare Metal Recommended hardware, mini PC options, purchase links Choosing and buying hardware for Ludus
Proxmox Installing on existing Proxmox 8/9 servers Adding Ludus to existing Proxmox infrastructure
Azure Azure nested virtualization setup, ARM templates Cloud deployment on Azure
Google Cloud GCP deployment via gcloud CLI and Terraform Cloud deployment on GCP
Hyper-V Hyper-V VM setup for Ludus Running Ludus in Hyper-V
VMware Fusion VMware Fusion setup (Intel Macs only) Running Ludus in VMware Fusion

Environment Guides

Document Description When to Reference
Basic AD Network Default AD config: DC, Win11 workstation, Kali Simple Active Directory lab setup
GOAD Game of Active Directory deployment Complex multi-domain AD lab
GOAD NHA GOAD NHA variant NHA-specific GOAD configuration
GOAD SCCM GOAD SCCM variant SCCM-specific GOAD configuration
SCCM Lab Full SCCM/ConfigMgr environment SCCM attack and defense lab
ADCS Lab Active Directory Certificate Services with ESC1-15 Certificate services attack paths
Elastic Security Elastic Security server with endpoint agents EDR/SIEM lab with Elastic
Splunk Attack Range Splunk Enterprise with attack simulation Splunk-based detection lab
Malware Lab Malware analysis lab with xz backdoor (CVE-2024-3094) Malware analysis and reverse engineering
Pivot Lab Network pivoting lab with walkthroughs for multiple tools Practicing network pivoting techniques
Vulhub Vulhub vulnerable environments Running Vulhub containers in Ludus
Workshops Conference workshop configs (SANS, BarbHack, leHACK, NetExec) Reproducing workshop environments

Administration & Security

Document Description When to Reference
Admin Notes Promoting/demoting users, forcing testing mode off, resource calculation Ludus server administration tasks
Security External access hardening, SSH access, malicious user mitigations Securing a Ludus deployment
Updating Updating server and client on all platforms Keeping Ludus up to date

Enterprise Features

Document Description When to Reference
Enterprise Feature comparison, KMS, anti-sandbox, outbound WireGuard, private roles Enterprise-specific features and licensing

Development

Document Description When to Reference
Developers Contributing guide, building from source, Ansible role development, CI/CD Contributing to Ludus or developing custom roles

Troubleshooting

Document Description When to Reference
Troubleshooting All troubleshooting topics: Proxmox, templates, network, Ansible, WireGuard, Kali, Flare-VM, KasmVNC, client, API keys, packer cache, uninstall Diagnosing and fixing issues