# P-BitM

> Documentation for P-BitM, a containerized platform for controlled browser-in-the-middle security assessments.

- [P-BitM documentation](https://p-bitm-2269ecee.mintlify.app/index.md): Documentation for P-BitM, a containerized platform for controlled Browser-in-the-Middle security assessments.
- [Overview](https://p-bitm-2269ecee.mintlify.app/getting-started/overview.md): Understand what P-BitM provides, how it is intended to be deployed, and where its trust boundaries sit.
- [Requirements](https://p-bitm-2269ecee.mintlify.app/getting-started/requirements.md): Host, Docker, Python, networking, and authorization requirements for running P-BitM.
- [Installation](https://p-bitm-2269ecee.mintlify.app/getting-started/installation.md): Install P-BitM and provision its local runtime safely.
- [Initial configuration](https://p-bitm-2269ecee.mintlify.app/getting-started/configuration.md): Configure P-BitM before starting the control plane and campaign workloads.
- [Quick start](https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start.md): Start P-BitM, verify the deployment, and prepare your first authorized campaign.
- [Video demos](https://p-bitm-2269ecee.mintlify.app/video-demos.md): Short, controlled demonstrations of P-BitM workflows and extensions.
- [Campaigns](https://p-bitm-2269ecee.mintlify.app/user-guide/campaigns.md): Create, schedule, control, and complete authorized P-BitM campaigns.
- [Target lists](https://p-bitm-2269ecee.mintlify.app/user-guide/target-lists.md): Create and manage approved campaign recipient lists.
- [Email templates](https://p-bitm-2269ecee.mintlify.app/user-guide/email-templates.md): Author reusable campaign email content and resolve recipient variables.
- [SMTP profiles](https://p-bitm-2269ecee.mintlify.app/user-guide/smtp-profiles.md): Configure and validate SMTP delivery profiles for Complete campaigns.
- [Landing pages](https://p-bitm-2269ecee.mintlify.app/user-guide/landing-pages.md): Create, import, review, and use campaign landing pages safely.
- [Live sessions](https://p-bitm-2269ecee.mintlify.app/user-guide/live-sessions.md): Understand VNC and Selkies live-session behavior and troubleshooting.
- [Actions and evidence](https://p-bitm-2269ecee.mintlify.app/user-guide/actions-and-evidence.md): Run live actions against a session and review the evidence it collects.
- [Exports](https://p-bitm-2269ecee.mintlify.app/user-guide/exports.md): Export campaign data and browser profiles for authorized evidence handling.
- [Plugins](https://p-bitm-2269ecee.mintlify.app/user-guide/plugins.md): Create, review, and assign Firefox extension packages to campaigns.
- [Modules](https://p-bitm-2269ecee.mintlify.app/user-guide/modules.md): Create, review, and execute operator-triggered module payloads.
- [Architecture](https://p-bitm-2269ecee.mintlify.app/concepts/architecture.md): Understand the P-BitM control plane, campaign services, browser sessions, and Docker boundaries.
- [Campaign lifecycle](https://p-bitm-2269ecee.mintlify.app/concepts/campaign-lifecycle.md): Follow campaign state from creation and scheduling through cleanup and recovery.
- [Request flow](https://p-bitm-2269ecee.mintlify.app/concepts/request-flow.md): Trace administrative, campaign admission, and collection requests through P-BitM.
- [Session containers](https://p-bitm-2269ecee.mintlify.app/concepts/session-containers.md): Understand browser image selection, readiness, identity, isolation, and capacity limits.
- [Storage and database](https://p-bitm-2269ecee.mintlify.app/concepts/storage-and-database.md): Understand storage ownership, layout, persistence, and retention.
- [Security model](https://p-bitm-2269ecee.mintlify.app/concepts/security-model.md): Review P-BitM trust assumptions, security controls, dependencies, and residual risks.
- [Authorized use](https://p-bitm-2269ecee.mintlify.app/security/authorized-use.md): Authorization, scope, retention, and operator responsibilities for using P-BitM.
- [Deployment hardening](https://p-bitm-2269ecee.mintlify.app/security/deployment-hardening.md): Security controls and release checks for hardening a P-BitM deployment.
- [Reporting vulnerabilities](https://p-bitm-2269ecee.mintlify.app/security/reporting-vulnerabilities.md): How to report suspected P-BitM vulnerabilities privately and safely.
- [Deployment](https://p-bitm-2269ecee.mintlify.app/administration/deployment.md): Deploy P-BitM in development or production and shut it down safely.
- [Team and roles](https://p-bitm-2269ecee.mintlify.app/administration/users-and-roles.md): Manage dashboard administrators and operators without weakening campaign ownership or account safeguards.
- [Environment variables](https://p-bitm-2269ecee.mintlify.app/administration/environment-variables.md): Reference generated runtime environment variables and their sources.
- [Networking and TLS](https://p-bitm-2269ecee.mintlify.app/administration/networking-and-tls.md): Configure dashboard exposure, campaign routing, certificates, and DNS challenges.
- [Storage and backups](https://p-bitm-2269ecee.mintlify.app/administration/storage-and-backups.md): Back up and restore P-BitM state while preserving ownership and secrets.
- [Maintenance](https://p-bitm-2269ecee.mintlify.app/administration/maintenance.md): Perform routine P-BitM updates, diagnostics, cleanup, and credential rotation.
- [Doctor](https://p-bitm-2269ecee.mintlify.app/administration/doctor.md): Use the read-only doctor command to verify deployment and release readiness.
- [Troubleshooting](https://p-bitm-2269ecee.mintlify.app/administration/troubleshooting.md): Diagnose common Docker, storage, TLS, service, session, and database problems.
- [Development setup](https://p-bitm-2269ecee.mintlify.app/development/setup.md): Prepare a supported local environment for contributing to P-BitM.
- [Creating and contributing attack vectors](https://p-bitm-2269ecee.mintlify.app/development/attack-vectors.md): Create Firefox plugins or client modules in the dashboard, then contribute reusable attack vectors using P-BitM's supported contracts.
- [Admin backend](https://p-bitm-2269ecee.mintlify.app/development/backend.md): Developer guide to the trusted FastAPI administrative control plane.
- [Campaign backend](https://p-bitm-2269ecee.mintlify.app/development/campaign-backend.md): Developer guide to the per-campaign public and private services.
- [Frontend](https://p-bitm-2269ecee.mintlify.app/development/frontend.md): Developer guide to the Vue administrative dashboard.
- [Database](https://p-bitm-2269ecee.mintlify.app/development/database.md): Developer guidance for SQLAlchemy, SQLite, timestamps, structured data, and migrations.
- [Testing](https://p-bitm-2269ecee.mintlify.app/development/testing.md): Run the P-BitM CLI, backend, frontend, static, and deployment checks.
- [CLI reference](https://p-bitm-2269ecee.mintlify.app/reference/cli.md): Complete reference for P-BitM setup, lifecycle, campaign, session, and administration commands.
- [Configuration reference](https://p-bitm-2269ecee.mintlify.app/reference/configuration.md): Reference for the operator-managed config.yaml contract.
- [Services](https://p-bitm-2269ecee.mintlify.app/reference/services.md): Reference for Compose services, dynamic workloads, ports, privileges, and health checks.
- [Module format](https://p-bitm-2269ecee.mintlify.app/reference/module-format.md): JSON schema, constraints, and runtime placeholders for P-BitM modules.
- [Plugin format](https://p-bitm-2269ecee.mintlify.app/reference/plugin-format.md): Editable and ZIP representations, validation rules, and limits for P-BitM plugins.
- [Credits and acknowledgements](https://p-bitm-2269ecee.mintlify.app/legal/credits.md): Open-source projects and community work incorporated into or influential to P-BitM.

## Optional

- [Source code](https://github.com/P-BitM-Framework/P-BitM)
- [Documentation repo](https://github.com/P-BitM-Framework/P-BitM-Docs)