ADscanADscan Docs

System requirements

Supported platforms, privileges, and networking expectations before running ADscan.

ADscan is Linux-first. Use this checklist to make sure your jump box, lab VM, or CI runner matches what the installer expects.

Supported platforms

ComponentRequirement
Operating systemDebian-based 64-bit Linux (Kali 2024.2+, Ubuntu 22.04+, Debian 12).
PrivilegesRoot or sudo access to install dependencies, BloodHound CE, and kernel packages.
Python3.8+ (managed automatically when you install the binary or PyPI package).
Storage≥10 GB free in ~/.adscan for workspaces, wordlists, and BloodHound artifacts.
Memory / CPUMinimum 4 GB RAM / 2 vCPU. Recommended 8 GB RAM / 4 vCPU for long-running BloodHound sessions.
NetworkInternet access for downloads and Layer 3/4 reachability to the target AD environment.

Recommended baseline: Kali Linux 2024.2 or Ubuntu 22.04 LTS, 50 GB of disk, and Docker installed to run BloodHound CE locally.

Optional dependencies

  • Docker Engine & Compose – needed only when adscan install provisions BloodHound CE.
  • Wordlists – bundled wordlists are installed automatically; drop your own files under ~/.adscan/wordlists.
  • External tooling – RustHound, Impacket, hashcat, and additional collectors are orchestrated automatically by adscan install (see the public README for the latest list).

Running in a container or GitHub-hosted runner? ADscan will gracefully skip Docker-only steps. If Docker isn’t available, install only the modules you need (for example adscan install --only rusthound) and handle BloodHound CE on a host with full privileges.

Validate your environment

# Verify binary version and dependency health
adscan --version
adscan check

# Confirm Docker availability before installing BHCE
docker info

Warnings emitted by print_warning highlight missing Docker daemons or containerized execution. Switch to adscan install --only rusthound when Docker cannot run.

Persistence & networking tips

  • Workspaces live in ~/.adscan/workspaces. Keep enough free disk and back up before rotating runners.
  • Allow outbound SMB/LDAP/RPC to the target domain plus HTTPS to github.com, pypi.org, docker.io, and release mirrors.

Meeting these baselines prevents surprise installer failures and unlocks the full ADscan LITE/PRO workflow.