> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pwnbook.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Pwnbook is a pentest management platform built for security teams. Manage engagements, collaborate on findings, model threats, automate recon, and generate reports — all in one place.

## What is Pwnbook?

Pwnbook is a comprehensive security operations platform designed to streamline the full lifecycle of a penetration test. From scoping and target discovery through exploitation, documentation, and final reporting, Pwnbook gives your team a unified workspace that replaces a scattered collection of spreadsheets, note apps, and one-off scripts.

Whether you're running a solo assessment or coordinating a large team engagement, Pwnbook scales with you.

## Key capabilities

<CardGroup cols={2}>
  <Card title="Engagement Management" icon="folder-open" href="/concepts/engagements">
    Organize every pentest as a self-contained engagement with its own targets, tasks, notes, and findings.
  </Card>

  <Card title="Threat Modeling" icon="diagram-project" href="/features/threat-modeling">
    Build interactive threat models with a visual canvas. Map assets, threats, and attack vectors directly to your engagement.
  </Card>

  <Card title="Automated Recon" icon="radar" href="/features/recon">
    Add targets and let the recon worker enumerate subdomains, open ports, and services automatically. Deploy network agents for internal scanning.
  </Card>

  <Card title="API Testing" icon="terminal" href="/features/api-testing">
    Execute HTTP requests against targets, save templates, share community scripts, and review full execution history.
  </Card>

  <Card title="Wiki & Notes" icon="book" href="/features/wiki">
    Collaborative markdown wiki pages per engagement. Share findings externally with time-limited share links.
  </Card>

  <Card title="Report Generation" icon="file-lines" href="/features/reports">
    Generate polished pentest reports from customizable templates. Build executive dashboards with drag-and-drop tiles.
  </Card>

  <Card title="AI Security Assistant" icon="robot" href="/features/ai-chat">
    Chat with an AI assistant that understands your engagement context. Powered by Anthropic or OpenAI depending on your configuration.
  </Card>

  <Card title="Architecture Modeling" icon="sitemap" href="/features/architecture">
    Map application components, data flows, and routes. Identify component-level risks and import infrastructure from cloud providers.
  </Card>
</CardGroup>

## Platform architecture

Pwnbook is composed of several services that work together:

<AccordionGroup>
  <Accordion title="Frontend" icon="browser">
    A React 18 application built with Vite, TypeScript, and shadcn/ui. Runs on port 8080 by default. Communicates with the backend API and workers over HTTP.
  </Accordion>

  <Accordion title="Backend API" icon="server">
    A Fastify (Node.js + TypeScript) API server on port 3001. Handles authentication, authorization, all business logic, and database interactions via Drizzle ORM on PostgreSQL.
  </Accordion>

  <Accordion title="Recon Worker" icon="magnifying-glass">
    A Python FastAPI service on port 8001. Handles long-running recon scans, coordinates network agents, and processes scan results asynchronously via BullMQ/Redis.
  </Accordion>

  <Accordion title="AI Worker" icon="microchip">
    A Python FastAPI service on port 8002. Proxies requests to Anthropic or OpenAI, manages conversation context, and serves the AI chat assistant.
  </Accordion>

  <Accordion title="Database & Queue" icon="database">
    PostgreSQL for persistent storage, Redis for the BullMQ job queue used by background workers.
  </Accordion>
</AccordionGroup>

## Get started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Create your account, set up an organization, and run your first engagement in minutes.
  </Card>

  <Card title="Self-Hosting" icon="server" href="/self-hosting">
    Deploy Pwnbook on your own infrastructure using Docker Compose.
  </Card>

  <Card title="Core Concepts" icon="lightbulb" href="/concepts/engagements">
    Understand how engagements, organizations, and roles work in Pwnbook.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Integrate Pwnbook into your workflows using the REST API.
  </Card>
</CardGroup>