mkdocs.yml

site_name: APTL - Advanced Purple Team Lab
site_description: A local Docker-based purple team lab infrastructure with Wazuh SIEM, containerized victim machines, and AI-powered red team operations
site_author: APTL Team
site_url: https://brad-edwards.github.io/aptl/
repo_url: https://github.com/Brad-Edwards/aptl
repo_name: Brad-Edwards/aptl

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      # Page dates are best-effort, not a build gate: fall back to the
      # build date (instead of failing `mkdocs build --strict`) when git
      # history is unavailable for a page — uncommitted files, shallow
      # clones, and git worktrees (where plugin 1.5.x finds no logs).
      fallback_to_build_date: true
      enable_git_follow: false
      strict: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.keys
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Lab Guide:
    - Overview: getting-started/index.md
    - Prerequisites: getting-started/prerequisites.md
    - Install APTL: getting-started/installation.md
    - Run Your First Lab: getting-started/quick-start.md
  - Interfaces:
    - CLI: reference/cli.md
    - MCP: reference/mcp.md
    - Web: reference/web.md
  - Operations:
    - Deployment: deployment.md
    - Troubleshooting: troubleshooting/index.md
  - Workshop:
    - Playbook: workshop/playbook.md
    - Lab Walkthrough: workshop/walkthrough.md
  - Architecture:
    - Overview: architecture/index.md
    - Networking: architecture/networking.md
    - Enterprise Infrastructure: architecture/enterprise-infrastructure.md
    - DEP-008 Self-Contained Lab Assets Preflight: architecture/dep-008-self-contained-lab-assets-preflight.md
    - RNG-001 Ephemeral Environments Preflight: architecture/rng-001-ephemeral-environments-preflight.md
    - DEP-003 Ephemeral Lifecycle Policy Preflight: architecture/dep-003-ephemeral-lifecycle-preflight.md
    - GRC Boundary Surface Vocabulary Preflight: architecture/grc-boundary-surface-vocabulary-preflight.md
    - "Issue #851 First-Time User Documentation Preflight": architecture/issue-851-first-time-user-docs-preflight.md
    - "Issue #557 Participant Implementation Binding Preflight": architecture/issue-557-participant-implementation-binding-preflight.md
    - "Issue #821 In-Appliance Participant Workbench Preflight": architecture/issue-821-participant-workbench-preflight.md
    - "Issue #823 Versioned Disposable Lab Appliance Preflight": architecture/issue-823-versioned-disposable-appliance-preflight.md
    - "Issue #1022 Appliance Seat Delivery Preflight": architecture/issue-1022-appliance-seat-delivery-preflight.md
    - "Issue #845 RAES Hard-Rename Preflight": architecture/issue-845-raes-hard-rename-preflight.md
    - "Issue #934 APTL-To-LilRAE Rename Boundary Preflight": architecture/issue-934-rename-boundary-preflight.md
    - "Issue #592 Scenario-Pack Terminology Preflight": architecture/issue-592-scenario-pack-terminology-preflight.md
    - "Issue #591 Scenario-Pack Capture Asset Ownership Preflight": architecture/issue-591-scenario-pack-capture-asset-ownership-preflight.md
    - "Issue #866 TechVault Component Realization Preflight": architecture/issue-866-techvault-realization-contract-preflight.md
    - "Issue #874 Scenario-Bundle Realization Roots Preflight": architecture/issue-874-scenario-bundle-realization-roots-preflight.md
    - "Issue #878 Scenario Verification Plugin Seam Preflight": architecture/issue-878-scenario-verification-plugin-seam-preflight.md
    - "Issue #905 Lab Lifecycle Robustness Preflight": architecture/issue-905-lab-lifecycle-robustness-preflight.md
    - "Issue #1000 Partial Boot And Manual Release QA Preflight": architecture/issue-1000-manual-release-qa-preflight.md
    - "Issue #1002 Wazuh API TLS Warm-Up Preflight": architecture/issue-1002-wazuh-api-tls-warmup-preflight.md
    - "Issue #949 Orborus Control Authority Preflight": architecture/issue-949-orborus-control-authority-preflight.md
    - "Issue #974 Shuffle Worker Docker And Image Realization Preflight": architecture/issue-974-shuffle-worker-docker-images-preflight.md
    - "Issue #951 Fresh Env-Pack Start Preflight": architecture/issue-951-fresh-env-pack-start-preflight.md
    - "Issue #964 Backend Resource Ownership Preflight": architecture/issue-964-backend-resource-ownership-preflight.md
    - "Issue #969 Platform Safety Gates Preflight": architecture/issue-969-platform-safety-gates-preflight.md
    - "Issue #985 Owned Lab Fixture Preflight": architecture/issue-985-owned-lab-fixture-preflight.md
    - "Issue #993 Boot Realization Regressions Preflight": architecture/issue-993-boot-realization-regressions-preflight.md
    - "Issue #992 Backend Observability Ownership Preflight": architecture/issue-992-backend-observability-ownership-preflight.md
    - LilRAE Readiness Review:
      - Assessment: reviews/962-lilrae-readiness/README.md
      - Migration Inventory: reviews/962-lilrae-readiness/migration-inventory.md
      - Existing Issues: reviews/962-lilrae-readiness/backlog-disposition.md
      - Existing ADRs: reviews/962-lilrae-readiness/adr-disposition.md
      - Agent Sandboxing: reviews/962-lilrae-readiness/agent-sandboxing.md
      - Delivery Plan: reviews/962-lilrae-readiness/delivery-plan.md
      - Upstream update: reviews/962-lilrae-readiness/upstream-update.md
      - Evidence: reviews/962-lilrae-readiness/evidence/README.md
  - Components:
    - Wazuh SIEM: components/wazuh-siem.md
    - Wazuh Active Response: components/wazuh-active-response.md
    - Default Defensive Posture: components/default-defensive-posture.md
    - Victim Containers: components/victim-containers.md
    - Victim Template Guide: containers/victim-template-guide.md
    - Kali Red Team: components/kali-redteam.md
    - Reverse Engineering Container: components/reverse-engineering-container.md
    - MCP Integration: components/mcp-integration.md
    - MCP Smoke-Test Protocol: components/mcp-smoke-test-protocol.md
    - Participant Workbench: components/participant-workbench.md
    - Appliance Network Boundary: components/appliance-boundary.md
  - Scenarios:
    - Authoring Boundary: sdl/index.md
    - Curated RAES Variants: sdl/techvault-curated-variants.md
  - RAES:
    - APP-1 Appliance Boundary Materialization Preflight: raes/app-1-appliance-boundary-materialization-preflight.md
    - TechVault Static Validation Preflight: raes/techvault-static-validation-preflight.md
    - TechVault Static Validation Gate: raes/techvault-static-validation-gate.md
    - TechVault Live Validation Preflight: raes/techvault-live-validation-preflight.md
    - TechVault Live Validation Gate: raes/techvault-live-validation-gate.md
    - TechVault Curated Live Validation Preflight: raes/techvault-curated-live-validation-preflight.md
    - TechVault Curated Live Validation Gate: raes/techvault-curated-live-validation-gate.md
    - Bounded Participant Agency Readiness: raes/bounded-participant-agency-readiness.md
  - Testing:
    - Platform Pull-Request Gates: testing/platform-pr-gates.md
    - Boot Realization Coverage: testing/boot-realization-coverage.md
    - Lab Fixture Pack: testing/lab-fixture-pack.md
    - Release Candidate Manual QA: testing/smoke-test-plan.md
    - Property-Based Parser Tests: testing/property-based-parser-tests.md
  - Reference:
    - OpenSSF Best Practices Assessment: security/openssf-best-practices.md
    - Red Team Taxonomy: red-team-taxonomy.md
    - Guided Purple Participant Profile: reference/participant-profile.md
    - Host MCP access: reference/host-mcp-access.md
    - Appliance Seat Launcher: reference/appliance-seat-launcher.md
    - TechVault Scenario Overview: reference/techvault-scenario-overview.md
    - TechVault Company Profile: reference/techvault-company-profile.md
    - TechVault OSINT Readiness: reference/techvault-osint-readiness.md
    - Experiment Runs: reference/experiment-runs.md
    - Portable Evidence Bundle Export: reference/evidence-bundle-export.md
    - SOC Feature Spec: specs/soc-feature-spec.md
    - Web GUI Design Specification: specs/web-gui-design.md
    - Web GUI Design Preflight Guardrails: specs/web-gui-design-preflight.md
    - Web Component Kit: specs/web-component-kit.md
  - Decisions:
    - Index: adrs/README.md
    - ADR-000 Use ADRs: adrs/adr-000-use-adrs.md
    - ADR-001 Docker Compose Deployment: adrs/adr-001-docker-compose-deployment.md
    - ADR-002 Wazuh SIEM: adrs/adr-002-wazuh-siem.md
    - ADR-003 MCP Common Library: adrs/adr-003-mcp-common-library.md
    - ADR-004 Persistent SSH Sessions: adrs/adr-004-persistent-ssh-sessions.md
    - ADR-005 Docker Compose Profiles: adrs/adr-005-docker-compose-profiles.md
    - ADR-006 Network Segmentation: adrs/adr-006-four-network-segmentation.md
    - ADR-007 Python CLI Control Plane: adrs/adr-007-python-cli-control-plane.md
    - ADR-008 SOC Stack Integration: adrs/adr-008-soc-stack-integration.md
    - ADR-009 Scenario Engine: adrs/adr-009-scenario-engine.md
    - ADR-010 SonarCloud Quality: adrs/adr-010-sonarcloud-quality.md
    - ADR-011 Web UI: adrs/adr-011-web-ui.md
    - ADR-012 OpenTelemetry Integration: adrs/adr-012-opentelemetry-integration.md
    - ADR-013 Deployment Abstraction: adrs/adr-013-deployment-abstraction.md
    - ADR-014 Scenario Description Language: adrs/adr-014-scenario-description-language.md
    - ADR-015 Declarative SDL Objectives: adrs/adr-015-declarative-sdl-objectives.md
    - ADR-016 Workflows and Enum Variables: adrs/adr-016-workflows-targetable-subobjects-and-enum-variables.md
    - ADR-017 SDL Runtime Layer: adrs/adr-017-sdl-runtime-layer.md
    - ADR-018 Control Flow Primitives: adrs/adr-018-control-flow-primitives.md
    - ADR-019 Suricata IDS-Only: adrs/adr-019-suricata-ids-only-prevention-via-wazuh-ar.md
    - ADR-020 Wazuh Agents In-Process: adrs/adr-020-wazuh-agents-in-process-vs-sidecar.md
    - ADR-021 Active-Response Whitelist: adrs/adr-021-active-response-whitelist-via-wrapper.md
    - ADR-022 MISP-Driven Suricata Rules: adrs/adr-022-misp-driven-suricata-rules.md
    - ADR-023 Container Interaction Backend: adrs/adr-023-container-interaction-in-deployment-backend.md
    - ADR-024 Purple Continuity Carve-Out: adrs/adr-024-orchestrator-side-purple-continuity-carve-out.md
    - ADR-025 Strict First-Party Config Schema: adrs/adr-025-strict-first-party-config-schema.md
    - ADR-026 Advisory CI Vulnerability Scanning: adrs/adr-026-advisory-ci-vulnerability-scanning.md
    - ADR-027 Red Team Structured Logging: adrs/adr-027-red-team-structured-logging.md
    - ADR-028 Runtime-Rendered Service Config: adrs/adr-028-runtime-rendered-service-config.md
    - ADR-029 Control-Plane Secret Handling: adrs/adr-029-control-plane-secret-handling.md
    - ADR-030 Startup Partial-Readiness: adrs/adr-030-startup-partial-readiness-classification.md
    - ADR-031 Lab Orchestration Contract Guards: adrs/adr-031-lab-orchestration-contract-guards.md
    - ADR-032 Conversation Surface Hardening: adrs/adr-032-conversation-surface-hardening.md
    - ADR-033 Agent Reasoning Trace Boundary: adrs/adr-033-agent-reasoning-trace-boundary.md
    - ADR-034 Lab-Managed SOC TLS CA: adrs/adr-034-lab-managed-soc-tls-ca.md
    - ADR-035 RAES SDL Adoption: adrs/adr-035-raes-sdl-adoption.md
    - ADR-036 Snapshot Endpoint Registry: adrs/adr-036-snapshot-endpoint-registry.md
    - ADR-037 Docker Compose Backend Cohesion: adrs/adr-037-docker-compose-backend-cohesion.md
    - ADR-038 Docs Style Lint and Published Site: adrs/adr-038-docs-style-lint-and-published-site.md
    - ADR-039 Web Control Plane Authentication: adrs/adr-039-web-control-plane-authentication.md
    - ADR-040 Terminal SSH Host-Key Verification: adrs/adr-040-terminal-ssh-host-key-verification.md
    - ADR-041 Kali Capture Sidecar Ownership Boundary: adrs/adr-041-kali-capture-sidecar-ownership-boundary.md
    - ADR-042 Sidecar-Owned PTY Master: adrs/adr-042-sidecar-owned-pty-master.md
    - ADR-043 Suricata Runtime Config Ownership Boundary: adrs/adr-043-suricata-runtime-config-ownership-boundary.md
    - ADR-044 RAES-Aligned Run Reproducibility Record: adrs/adr-044-raes-aligned-run-reproducibility-record.md
    - ADR-045 Ephemeral Lifecycle Policy Enforcement: adrs/adr-045-ephemeral-lifecycle-policy-enforcement.md
    - ADR-046 Dynamic RAES Scenario Realization: adrs/adr-046-dynamic-raes-scenario-realization.md
    - ADR-047 RAES Experiment Admission and Trial-Plan Boundary: adrs/adr-047-raes-experiment-admission-and-trial-plan-boundary.md
    - ADR-048 APTL Image-Free, Placement-Based Realization Envelope: adrs/adr-048-image-free-placement-realization.md
    - ADR-049 Sealed Disposable Lab Appliance: adrs/adr-049-sealed-disposable-lab-appliance.md
    - ADR-051 Component-Level RAES Realization: adrs/adr-051-component-level-raes-realization.md
    - ADR-052 Configured Participant Credential Sourcing: adrs/adr-052-configured-participant-credential-sourcing.md
    - ADR-053 Pack-Backend Deployment-Serving Interaction Seam: adrs/adr-053-pack-backend-deployment-serving-interaction-seam.md
    - ADR-054 APTL-to-LilRAE Identity Continuity and Capability Ownership: adrs/adr-054-lilrae-core-and-experience-ownership.md
    - ADR-055 Local Runtime Authority and Ownership: adrs/adr-055-local-runtime-authority-and-ownership.md
    - ADR-056 Scenario-Led Capability Qualification: adrs/adr-056-scenario-led-capability-qualification.md
    - ADR-057 Agent Execution Compartments: adrs/adr-057-agent-execution-compartments.md
    - ADR-058 Adoption and Security Release Gates: adrs/adr-058-adoption-and-security-release-gates.md
    - ADR-059 Canonical TechVault Delivery and Host MCP Access: adrs/adr-059-canonical-techvault-delivery-and-host-mcp-access.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Brad-Edwards/aptl