Missing images are built automatically. Force a rebuild after source or
dependency changes:
python3 p-bitm.py up --build
Open the configured dashboard URL, which defaults to:
https://127.0.0.1:8443/
On the first successful start, the CLI displays the initial administrator
credentials after confirming that the account was persisted. Change the
password after signing in.
A fresh deployment opens on the campaigns list with no campaigns yet.
Verify the deployment
python3 p-bitm.py statuspython3 p-bitm.py doctor
Do not prepare a campaign until the required control-plane services are
healthy and doctor reports no failures.
Prepare campaign resources
Create and review the reusable resources in this order:
target list;
landing page;
for a Complete campaign, an email template and SMTP profile;
optional plugins and modules;
campaign.
Choose Complete for a scheduled email-delivery window. Choose Standalone for
an immediate, non-scheduled campaign without email or SMTP delivery resources.Use only approved test recipients and infrastructure. The
campaign guide explains the wizard and lifecycle.
Stop the complete runtime
python3 p-bitm.py down
This is a terminal shutdown: active, paused, and scheduled campaigns are marked
completed, and all app-owned campaign, browser, and egress containers are
removed. Running up later starts only the control plane; it does not resume
those campaigns.
Last modified on August 28, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"P-BitM","description":"Documentation for P-BitM, a containerized platform for controlled browser-in-the-middle security assessments.","colors":{"primary":"#C4472D","light":"#F06A48","dark":"#C4472D"},"logo":{"light":"https://mintcdn.com/p-bitm-2269ecee/7kTH8dbJH_Bjkkly/assets/p-bitm-logo-v2.png?fit=max\u0026auto=format\u0026n=7kTH8dbJH_Bjkkly\u0026q=85\u0026s=d3ca32f4c4d69cc5a63ce1fe724c0249","dark":"https://mintcdn.com/p-bitm-2269ecee/7kTH8dbJH_Bjkkly/assets/p-bitm-logo-v2.png?fit=max\u0026auto=format\u0026n=7kTH8dbJH_Bjkkly\u0026q=85\u0026s=d3ca32f4c4d69cc5a63ce1fe724c0249","href":"/"},"favicon":"https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/favicon.png?fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=f5b864b87c3f17f785362f7c29a6e3d3","appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://github.com/P-BitM-Framework/P-BitM-Docs/blob/main/CONTRIBUTING.md","label":"Contribute"}],"primary":{"type":"github","href":"https://github.com/P-BitM-Framework/P-BitM"}},"footer":{"socials":{"github":"https://github.com/P-BitM-Framework"},"links":[{"header":"Get started","items":[{"label":"Overview","href":"/getting-started/overview"},{"label":"Requirements","href":"/getting-started/requirements"},{"label":"Quick start","href":"/getting-started/quick-start"}]},{"header":"Operate","items":[{"label":"Campaigns","href":"/user-guide/campaigns"},{"label":"Live sessions","href":"/user-guide/live-sessions"},{"label":"Troubleshooting","href":"/administration/troubleshooting"}]},{"header":"Project","items":[{"label":"P-BitM repository","href":"https://github.com/P-BitM-Framework/P-BitM"},{"label":"Documentation repository","href":"https://github.com/P-BitM-Framework/P-BitM-Docs"},{"label":"Credits","href":"/legal/credits"}]},{"header":"Security","items":[{"label":"Authorized use","href":"/security/authorized-use"},{"label":"Deployment hardening","href":"/security/deployment-hardening"},{"label":"Report a vulnerability","href":"/security/reporting-vulnerabilities"}]}]},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":false},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The requested P-BitM documentation page does not exist or has moved."}},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"Source code","icon":"github","href":"https://github.com/P-BitM-Framework/P-BitM"},{"anchor":"Documentation repo","icon":"file-text","href":"https://github.com/P-BitM-Framework/P-BitM-Docs"},{"anchor":"Authorized use","icon":"shield-check","href":"/security/authorized-use"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"p-bitm-2269ecee","hasAudioNarration":false,"actualSubdomain":"p-bitm-2269ecee","customDomains":[],"gitSource":{"type":"github","owner":"p-bitm-framework","repo":"p-bitm-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aa2dd681594efca37a7c436","collectionId":"10da7d16-fb1f-46b8-b23f-d81448ac4682","liveDeploymentHistoryId":"6aa2dd681594efca37a7c436","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aa2dd681594efca37a7c436","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"P-BitM","count":40},{"language":"default","tag":"User guide","count":10},{"language":"default","tag":"Administration","count":8},{"language":"default","tag":"Development","count":7},{"language":"default","tag":"Concepts","count":6},{"language":"default","tag":"Reference","count":6},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Application","count":4},{"language":"default","tag":"Campaign resources","count":4},{"language":"default","tag":"Operations","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--pbitm-orange-light:#f06a48;--pbitm-teal:#00a6a6}#navbar a:has(>.nav-logo){display:inline-flex!important;align-items:center!important;gap:.8rem;flex-shrink:0}#navbar .nav-logo{width:3.5rem!important;max-width:3.5rem!important;height:3.5rem!important;max-height:3.5rem!important;object-fit:contain!important}#navbar a:has(>.nav-logo)::after{color:#18181b;content:\"Persistent Browser-In-The-Middle\";font-size:.95rem;font-weight:750;letter-spacing:.01em;line-height:1.15;white-space:nowrap}.dark #navbar a:has(>.nav-logo)::after{color:#f8fafc}@media (max-width:639px){#navbar a:has(>.nav-logo)::after{display:none}}#footer img[src*=p-bitm-logo],advanced-footer img[src*=p-bitm-logo],footer img[src*=p-bitm-logo]{width:7rem!important;max-width:7rem!important;height:auto!important;max-height:none!important;object-fit:contain!important}.pbitm-hero{position:relative;isolation:isolate;overflow:hidden}.pbitm-hero::after,.pbitm-hero::before{position:absolute;z-index:-1;border-radius:50%;content:\"\";filter:blur(90px);opacity:.5}.pbitm-hero::before{top:-12%;left:8%;width:24rem;height:24rem;background:var(--pbitm-teal)}.pbitm-hero::after{top:-18%;right:6%;width:28rem;height:28rem;background:var(--pbitm-orange-light)}.pbitm-hero-logo{filter:drop-shadow(0 22px 34px rgb(0 0 0/34%))}.pbitm-kicker{color:#86f7ed;letter-spacing:.12em;text-transform:uppercase}html[data-current-path=\"/\"] #footer{margin-top:0}"}],"page":{"pagePath":"getting-started/quick-start","slug":"/getting-started/quick-start","pageMetadata":{"title":"Quick start","description":"Start P-BitM, verify the deployment, and prepare your first authorized campaign.","href":"/getting-started/quick-start"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Frame,OptimizedImage,Step,Steps,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`These steps assume `,_jsx(_components.a,{href:`/getting-started/installation`,children:`installation`}),` and setup are\ncomplete.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Use P-BitM only on systems you own or where you have explicit written\nauthorization. `,_jsx(_components.a,{href:`/security/authorized-use`,children:`Review the authorized-use policy`}),`.`]})}),`\n`,_jsxs(Steps,{titleSize:`h2`,children:[_jsxs(Step,{title:`Start the stack`,icon:`play`,id:`start-the-stack`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` p-bitm.py`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` up`})]}),`\n`]})})}),_jsx(_components.p,{children:`Missing images are built automatically. Force a rebuild after source or\ndependency changes:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` p-bitm.py`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` up`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --build`})]}),`\n`]})})}),_jsx(_components.p,{children:`Open the configured dashboard URL, which defaults to:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://127.0.0.1:8443/`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:`On the first successful start, the CLI displays the initial administrator\ncredentials after confirming that the account was persisted. Change the\npassword after signing in.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=b72126282f8e658811206325fed2a1f3`,alt:`P-BitM administrator sign-in screen`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`1800`,height:`1800`,\"data-path\":`assets/screenshots/getting-started/login.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=280\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=e7b50ee7d23816cbad49c609f63c4a2b 280w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=560\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=bbc84b9d99f94aa82ddf89e2f6cf687a 560w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=840\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=7544d41aca7f620e227b0c2704316058 840w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=1100\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=003acb1ee4b62f41d4de3e26e0704b8b 1100w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=1650\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=3925f524371a92b07af8f055154ed8fd 1650w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/login.png?w=2500\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=21e6022b4a222518739887480160bbeb 2500w`})}),_jsx(_components.p,{children:`A fresh deployment opens on the campaigns list with no campaigns yet.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=94761bf90cb88804d78ecda46e9182be`,alt:`P-BitM dashboard showing an empty campaigns list`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`1910`,height:`1910`,\"data-path\":`assets/screenshots/getting-started/dashboard-empty.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=280\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=f365cff66e3469ab3762081873f84321 280w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=560\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=e611fdf668e73954ad13c649805b062c 560w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=840\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=1a9f725dcfb28cf53806765a33213eb9 840w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=1100\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=05b4781202c8268ce5750937a39cea5d 1100w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=1650\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=a6e7a2e74743c461b2c5e29be4807483 1650w, https://mintcdn.com/p-bitm-2269ecee/9BS4YJCQtZV5PBjE/assets/screenshots/getting-started/dashboard-empty.png?w=2500\u0026fit=max\u0026auto=format\u0026n=9BS4YJCQtZV5PBjE\u0026q=85\u0026s=68161ff64da44a1bbbff0a44f844f2e4 2500w`})})]}),_jsxs(Step,{title:`Verify the deployment`,icon:`badge-check`,id:`verify-the-deployment`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` p-bitm.py`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` status`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` p-bitm.py`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` doctor`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`Do not prepare a campaign until the required control-plane services are\nhealthy and `,_jsx(_components.code,{children:`doctor`}),` reports no failures.`]})]}),_jsxs(Step,{title:`Prepare campaign resources`,icon:`list-checks`,id:`prepare-campaign-resources`,children:[_jsx(_components.p,{children:`Create and review the reusable resources in this order:`}),_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`target list;`}),`\n`,_jsx(_components.li,{children:`landing page;`}),`\n`,_jsx(_components.li,{children:`for a Complete campaign, an email template and SMTP profile;`}),`\n`,_jsx(_components.li,{children:`optional plugins and modules;`}),`\n`,_jsx(_components.li,{children:`campaign.`}),`\n`]}),_jsx(_components.p,{children:`Choose Complete for a scheduled email-delivery window. Choose Standalone for\nan immediate, non-scheduled campaign without email or SMTP delivery resources.`}),_jsxs(_components.p,{children:[`Use only approved test recipients and infrastructure. The\n`,_jsx(_components.a,{href:`/user-guide/campaigns`,children:`campaign guide`}),` explains the wizard and lifecycle.`]})]}),_jsxs(Step,{title:`Stop the complete runtime`,icon:`square`,id:`stop-the-complete-runtime`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` p-bitm.py`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` down`})]}),`\n`]})})}),_jsx(Warning,{children:_jsxs(_components.p,{children:[`This is a terminal shutdown: active, paused, and scheduled campaigns are marked\ncompleted, and all app-owned campaign, browser, and egress containers are\nremoved. Running `,_jsx(_components.code,{children:`up`}),` later starts only the control plane; it does not resume\nthose campaigns.`]})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Quick start","description":"Start P-BitM, verify the deployment, and prepare your first authorized campaign.","href":"/getting-started/quick-start"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Start the stack","slug":"start-the-stack","depth":2,"children":[]},{"title":"Verify the deployment","slug":"verify-the-deployment","depth":2,"children":[]},{"title":"Prepare campaign resources","slug":"prepare-campaign-resources","depth":2,"children":[]},{"title":"Stop the complete runtime","slug":"stop-the-complete-runtime","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"p-bitm-2269ecee","siteName":"P-BitM","title":"Quick start - P-BitM","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-26T13:39:43.344Z","gitLastModified":"2026-08-28T14:21:56.000Z","originalFileLocation":"getting-started/quick-start.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\">\u003cmeta data-mint-head name=\"application-name\" content=\"P-BitM\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quick start - P-BitM\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"P-BitM\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://p-bitm-2269ecee.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Quick+start\u0026amp;description=Start+P-BitM%2C+verify+the+deployment%2C+and+prepare+your+first+authorized+campaign.\u0026amp;theme=830e90918d8f47e49f7ca0e6\u0026amp;signature=7be8c032d1843ddb74b69af82d0f30a6ce0bf5a4bed46e4453567203cec3e840\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Quick start - P-BitM\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://p-bitm-2269ecee.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Quick+start\u0026amp;description=Start+P-BitM%2C+verify+the+deployment%2C+and+prepare+your+first+authorized+campaign.\u0026amp;theme=830e90918d8f47e49f7ca0e6\u0026amp;signature=7be8c032d1843ddb74b69af82d0f30a6ce0bf5a4bed46e4453567203cec3e840\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/p-bitm-2269ecee/KPlCWvMofCJY6GWk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"P-BitM\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C4472D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/quick-start.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://p-bitm-2269ecee.mintlify.app/#organization\",\"name\":\"P-BitM\",\"url\":\"https://p-bitm-2269ecee.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/p-bitm-2269ecee/7kTH8dbJH_Bjkkly/assets/p-bitm-logo-v2.png?fit=max\u0026auto=format\u0026n=7kTH8dbJH_Bjkkly\u0026q=85\u0026s=d3ca32f4c4d69cc5a63ce1fe724c0249\"}},{\"@type\":\"WebSite\",\"@id\":\"https://p-bitm-2269ecee.mintlify.app#website\",\"name\":\"P-BitM\",\"url\":\"https://p-bitm-2269ecee.mintlify.app\",\"publisher\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start#webpage\",\"url\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start\",\"name\":\"Quick start\",\"description\":\"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\",\"dateModified\":\"2026-08-28T14:21:56.000Z\",\"isPartOf\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get started\",\"item\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quick start\",\"item\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start#article\",\"headline\":\"Quick start\",\"name\":\"Quick start\",\"description\":\"Start P-BitM, verify the deployment, and prepare your first authorized campaign.\",\"url\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start\",\"mainEntityOfPage\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app/getting-started/quick-start#webpage\"},\"dateModified\":\"2026-08-28T14:21:56.000Z\",\"publisher\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://p-bitm-2269ecee.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"P-BitM\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"P-BitM","nav":{"global":{"anchors":[{"anchor":"Source code","icon":"github","href":"https://github.com/P-BitM-Framework/P-BitM"},{"anchor":"Documentation repo","icon":"file-text","href":"https://github.com/P-BitM-Framework/P-BitM-Docs"},{"anchor":"Authorized use","icon":"shield-check","href":"/security/authorized-use"}]},"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"P-BitM","icon":"fish-symbol","groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"Overview","href":"/getting-started/overview"},{"title":"Requirements","href":"/getting-started/requirements"},{"title":"Installation","href":"/getting-started/installation"},{"title":"Initial configuration","description":"Configure P-BitM before starting the control plane and campaign workloads.","href":"/getting-started/configuration"},{"title":"Quick start","href":"/getting-started/quick-start"}]},{"group":"Video demos","icon":"clapperboard","pages":[{"title":"Video demos","description":"Short, controlled demonstrations of P-BitM workflows and extensions.","href":"/video-demos"}]},{"group":"User guide","icon":"panel-top","pages":[{"title":"Campaigns","href":"/user-guide/campaigns"},{"group":"Campaign resources","icon":"folders","pages":[{"title":"Target lists","href":"/user-guide/target-lists"},{"title":"Email templates","href":"/user-guide/email-templates"},{"title":"SMTP profiles","href":"/user-guide/smtp-profiles"},{"title":"Landing pages","href":"/user-guide/landing-pages"}]},{"group":"Sessions and evidence","icon":"monitor-up","pages":[{"title":"Live sessions","href":"/user-guide/live-sessions"},{"title":"Actions and evidence","href":"/user-guide/actions-and-evidence"},{"title":"Exports","href":"/user-guide/exports"}]},{"group":"Extensions","icon":"blocks","pages":[{"title":"Plugins","href":"/user-guide/plugins"},{"title":"Modules","href":"/user-guide/modules"}]}]},{"group":"Concepts","icon":"network","pages":[{"title":"Architecture","href":"/concepts/architecture"},{"title":"Campaign lifecycle","href":"/concepts/campaign-lifecycle"},{"title":"Request flow","href":"/concepts/request-flow"},{"title":"Session containers","href":"/concepts/session-containers"},{"title":"Storage and database","href":"/concepts/storage-and-database"},{"title":"Security model","href":"/concepts/security-model"}]},{"group":"Security","icon":"shield-check","pages":[{"title":"Authorized use","href":"/security/authorized-use"},{"title":"Deployment hardening","href":"/security/deployment-hardening"},{"title":"Reporting vulnerabilities","href":"/security/reporting-vulnerabilities"}]},{"group":"Administration","icon":"settings","pages":[{"title":"Deployment","href":"/administration/deployment"},{"title":"Team and roles","href":"/administration/users-and-roles"},{"group":"Configuration","icon":"sliders-horizontal","pages":[{"title":"Environment variables","href":"/administration/environment-variables"},{"title":"Networking and TLS","href":"/administration/networking-and-tls"},{"title":"Storage and backups","href":"/administration/storage-and-backups"}]},{"group":"Operations","icon":"wrench","pages":[{"title":"Maintenance","href":"/administration/maintenance"},{"title":"Doctor","href":"/administration/doctor"},{"title":"Troubleshooting","href":"/administration/troubleshooting"}]}]},{"group":"Development","icon":"code-xml","pages":[{"title":"Development setup","href":"/development/setup"},{"title":"Creating and contributing attack vectors","href":"/development/attack-vectors"},{"group":"Application","icon":"boxes","pages":[{"title":"Admin backend","href":"/development/backend"},{"title":"Campaign backend","href":"/development/campaign-backend"},{"title":"Frontend","href":"/development/frontend"},{"title":"Database","href":"/development/database"}]},{"title":"Testing","href":"/development/testing"}]}]},{"tab":"Reference","icon":"book-open","pages":[{"title":"Reference","href":"/reference/cli"}]}]},"title":"Quick start - P-BitM","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-CIbhtp2j.js","DynamicMarkdown-CtpgKJwj.js","zoom-image-lightbox-CVZVK4hN.js","lightbox-handle-r17bVUz3.js"]}