# D0pam1ne

> Documentation for D0pam1ne, the offensive-security framework by Black Hat Ethical Hacking: one self-hosted workspace for reconnaissance, manual and automated attacks, OSINT, adaptive evasion, a private local AI and client-ready reporting, built by practitioners to take an engagement from scope to signed report.

- [D0pam1ne Overview](https://docs.d0pam1ne.blackhatethicalhacking.com/introduction.md): The brain's motivation neurotransmitter: one workspace that runs the whole engagement, recon, attacks, OSINT and reporting, with adaptive evasion and a local AI.
- [Free engine and Pro](https://docs.d0pam1ne.blackhatethicalhacking.com/getting-started/editions.md): What the open-source D0pam1ne engine gives you for free, and what D0pam1ne Pro adds on top.
- [Installation](https://docs.d0pam1ne.blackhatethicalhacking.com/getting-started/installation.md): Install the D0pam1ne engine and D0pam1ne Pro on Kali or macOS.
- [First login](https://docs.d0pam1ne.blackhatethicalhacking.com/getting-started/first-login.md): Sign in, set your password and turn on two-step authentication.
- [The in-app Guide](https://docs.d0pam1ne.blackhatethicalhacking.com/getting-started/the-guide.md): A single scrollable tour of how D0pam1ne works, built into the app.
- [The Command Center](https://docs.d0pam1ne.blackhatethicalhacking.com/concepts/command-center.md): Your whole practice in one place: every client, every project, live.
- [Projects](https://docs.d0pam1ne.blackhatethicalhacking.com/concepts/projects.md): Every engagement is a project, with its own scope, recon, findings and reports.
- [Client and scope](https://docs.d0pam1ne.blackhatethicalhacking.com/concepts/scope.md): Set what is in scope with domains, wildcards, IPs, ranges and path-limited web rules. Out of scope always wins.
- [The D0pam1ne engine](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/overview.md): The open-source core: one terminal app that maps a target's whole attack surface, phase by phase, and hands the work to D0pam1ne Pro.
- [Running a recon](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/running-recon.md): From the authorization briefing to the live run screen to the per-stage summary: what a recon looks like as it happens.
- [The recon pipeline](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/recon-pipeline.md): Fifteen ordered stages, from subdomains to JavaScript secrets, each running the right tools and filing results as it goes.
- [Recon profiles](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/profiles.md): Fast, stealth, normal and deep: one choice sets the pacing, concurrency, wordlist sizes and time limits for the whole run.
- [Results and report](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/results.md): Where everything a run finds is saved: the live results browser, the one-page HTML report, and the run folder on disk.
- [The attack toolkit](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/attack-toolkit.md): Recon prepares the targets and the tested commands; you decide what to run. Nothing attacks on its own.
- [CLI reference](https://docs.d0pam1ne.blackhatethicalhacking.com/engine/cli-reference.md): Every d0pam1ne command and flag: recon, attack, projects, scope, tools, wordlists and diagnostics.
- [Recon overview](https://docs.d0pam1ne.blackhatethicalhacking.com/recon/overview.md): Map the attack surface with a curated toolchain and adjustable pacing.
- [Running recon](https://docs.d0pam1ne.blackhatethicalhacking.com/recon/running-recon.md): Watch the pipeline work through each stage in real time.
- [Evasive Mode](https://docs.d0pam1ne.blackhatethicalhacking.com/evasion/overview.md): Adaptive, per-host pacing that reacts to how the target responds, with optional Tor egress and exit-IP rotation. The brain behind staying quiet.
- [Adaptive pacing](https://docs.d0pam1ne.blackhatethicalhacking.com/evasion/pacing.md): A per-host sensor, a state machine and an AIMD rate model: how Evasive Mode reads a target and paces to the fastest rate it will tolerate.
- [Tor egress and exit rotation](https://docs.d0pam1ne.blackhatethicalhacking.com/evasion/tor.md): Route supported tools through Tor with a rotating exit IP, while payload tools stay direct and paced. How and why.
- [Hosts and services](https://docs.d0pam1ne.blackhatethicalhacking.com/data/hosts-and-services.md): Every host, port and service recon found, external and internal.
- [Attack surface graph](https://docs.d0pam1ne.blackhatethicalhacking.com/data/attack-surface.md): See how domains, hosts, services and live web connect.
- [Traffic log](https://docs.d0pam1ne.blackhatethicalhacking.com/data/traffic.md): Every URL that actually answered, deduplicated, with how it was found.
- [Issues and Needs Review](https://docs.d0pam1ne.blackhatethicalhacking.com/data/issues.md): Triage findings, confirm them with AI, and move them toward the client.
- [Out of scope](https://docs.d0pam1ne.blackhatethicalhacking.com/data/out-of-scope.md): What was seen but never probed, kept for a clean record.
- [Manual Attacks](https://docs.d0pam1ne.blackhatethicalhacking.com/attacks/manual-attacks.md): A targeted toolkit that uses recon's results as its targets.
- [Automated Attacks](https://docs.d0pam1ne.blackhatethicalhacking.com/attacks/automated-attacks.md): The whole plan, run stage by stage, hands-off.
- [Attack categories](https://docs.d0pam1ne.blackhatethicalhacking.com/attacks/categories.md): Every attack category, the recon signal that puts it in the plan, and the tools it runs.
- [The Attack Equalizer](https://docs.d0pam1ne.blackhatethicalhacking.com/attacks/attack-equalizer.md): Live traffic, signal and throughput while an attack runs.
- [OSINT](https://docs.d0pam1ne.blackhatethicalhacking.com/osint/overview.md): Map the target's public exposure before you touch it: ASNs, people, exposed assets, dorks, email security, and breach data, stage by stage.
- [Importing scans](https://docs.d0pam1ne.blackhatethicalhacking.com/import/import-scans.md): Bring existing tool output into a project.
- [Report Builder](https://docs.d0pam1ne.blackhatethicalhacking.com/reporting/report-builder.md): Pick a report type, tune the sections, brand it, and export in six formats. Only verified issues reach the client.
- [Interactive report](https://docs.d0pam1ne.blackhatethicalhacking.com/reporting/interactive-report.md): A self-contained HTML report the client can filter and sort.
- [PDF report and finding anatomy](https://docs.d0pam1ne.blackhatethicalhacking.com/reporting/pdf-report.md): The fixed-layout house document, and the full per-finding anatomy behind every issue.
- [Word export](https://docs.d0pam1ne.blackhatethicalhacking.com/reporting/word-export.md): An editable .docx copy of the report, for the team.
- [Retest reports](https://docs.d0pam1ne.blackhatethicalhacking.com/reporting/retest.md): Show the client what they fixed, in a matching branded report.
- [Local AI](https://docs.d0pam1ne.blackhatethicalhacking.com/ai/local-ai.md): An on-device model run by Ollama. Triage, drafting and the assistant run locally: no cloud, no account, no telemetry.
- [AI memory and house style](https://docs.d0pam1ne.blackhatethicalhacking.com/ai/ai-memory.md): Teach the assistant your house style and per-project context, so drafts sound like your team.
- [Vulnerability intelligence](https://docs.d0pam1ne.blackhatethicalhacking.com/vuln-intel/overview.md): Search CVEs by product, keyword or ID, with real exploitation signals.
- [Tools](https://docs.d0pam1ne.blackhatethicalhacking.com/tools/overview.md): Every tool the engine uses, with install and update from the app.
- [Tool reference](https://docs.d0pam1ne.blackhatethicalhacking.com/tools/catalog.md): Every tool D0pam1ne drives, grouped by where it runs in the flow: what it does, why it is there, and its source.
- [Wordlists](https://docs.d0pam1ne.blackhatethicalhacking.com/tools/wordlists.md): The SecLists wordlists D0pam1ne uses for discovery.
- [Team](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/team.md): Add people, set roles, and keep accounts secure.
- [Settings and company identity](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/settings.md): Your firm's name, logo and house colours, used across reports.
- [API keys](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/api-keys.md): Add the keys that unlock richer recon and OSINT sources.
- [Audit log](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/audit-log.md): Every action, who did it and when.
- [Time tracker](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/time-tracker.md): Hours per researcher, reconstructed from the audit log.
- [Backups](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/backups.md): Encrypted, passphrase-locked snapshots of everything.
- [Resources](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/resources.md): Disk, memory and growth for the D0pam1ne data folder.
- [Updates](https://docs.d0pam1ne.blackhatethicalhacking.com/admin/updates.md): Fast-forward D0pam1ne Pro and the engine to the latest release.
- [Configuration](https://docs.d0pam1ne.blackhatethicalhacking.com/reference/configuration.md): Environment variables, run.sh commands and editions for D0pam1ne Pro.
- [API reference](https://docs.d0pam1ne.blackhatethicalhacking.com/reference/api.md): D0pam1ne Pro exposes a REST API behind your login. Browse the live OpenAPI docs, or see the areas below.
- [Cheat sheet](https://docs.d0pam1ne.blackhatethicalhacking.com/reference/cheat-sheet.md): The commands you reach for most, on one page.
- [Security and safe use](https://docs.d0pam1ne.blackhatethicalhacking.com/reference/security.md): Run D0pam1ne safely: authorized testing only, locked down access, and data that never leaves your machine.
- [FAQ](https://docs.d0pam1ne.blackhatethicalhacking.com/reference/faq.md): Common questions about running D0pam1ne, the engine, the AI, editions and reporting.
- [Playt1me](https://docs.d0pam1ne.blackhatethicalhacking.com/extras/playtime.md): An arcade of toys for when a scan is running and you need a dopamine hit.
- [Help and support](https://docs.d0pam1ne.blackhatethicalhacking.com/extras/help-and-support.md): Find the Guide and docs, and report a bug with diagnostics.
- [Support the project](https://docs.d0pam1ne.blackhatethicalhacking.com/support.md): The D0pam1ne engine is free and open source. Here is how to keep it alive: star it, share it, back it, and learn with the team behind it.

## Optional

- [Contact Us](https://www.blackhatethicalhacking.com/contact_us)
- [BHEH Website](https://www.blackhatethicalhacking.com)
- [Support](https://support.blackhatethicalhacking.com)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.