prowler/mkdocs.yml

# Project information
site_name: Prowler Open Source Documentation
site_url: https://docs.prowler.com/
site_description: >-
  Prowler Open Source Documentation

# Theme Configuration
theme:
  language: en
  logo: img/prowler-logo-white.png
  name: material
  favicon: favicon.ico
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: green
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: green
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# plugins:
#   - search
#   - git-revision-date-localized:
#       enable_creation_date: true

edit_uri: "https://github.com/prowler-cloud/prowler/tree/master/docs"
# Prowler OSS Repository
repo_url: https://github.com/prowler-cloud/prowler/
repo_name: prowler-cloud/prowler

nav:
  - Getting Started:
    - Overview:
      - What is Prowler?: index.md
      - Products:
          - Prowler App: products/prowler-app.md
          - Prowler CLI: products/prowler-cli.md
          - Prowler Cloud 🔗: https://cloud.prowler.com
          - Prowler Hub 🔗: https://hub.prowler.com
    - Installation:
        - Prowler App: installation/prowler-app.md
        - Prowler CLI: installation/prowler-cli.md
    - Basic Usage:
        - Prowler App: basic-usage/prowler-app.md
        - Prowler CLI: basic-usage/prowler-cli.md
  - User Guide:
      - Prowler App:
          - Getting Started: tutorials/prowler-app.md
          - Authentication:
            - Social Login: tutorials/prowler-app-social-login.md
            - SSO with SAML: tutorials/prowler-app-sso.md
          - Role-Based Access Control: tutorials/prowler-app-rbac.md
          - Mutelist: tutorials/prowler-app-mute-findings.md
          - Integrations:
            - Amazon S3: tutorials/prowler-app-s3-integration.md
            - AWS Security Hub: tutorials/prowler-app-security-hub-integration.md
            - Jira: tutorials/prowler-app-jira-integration.md
          - Lighthouse AI: tutorials/prowler-app-lighthouse.md
          - Tutorials:
            - SSO with Entra: tutorials/prowler-app-sso-entra.md
            - Bulk Provider Provisioning: tutorials/bulk-provider-provisioning.md
      - CLI:
          - Miscellaneous: tutorials/misc.md
          - Reporting: tutorials/reporting.md
          - Compliance: tutorials/compliance.md
          - Dashboard: tutorials/dashboard.md
          - Configuration File: tutorials/configuration_file.md
          - Logging: tutorials/logging.md
          - Mutelist: tutorials/mutelist.md
          - Integrations:
            - AWS Security Hub: tutorials/aws/securityhub.md
            - Slack: tutorials/integrations.md
            - Send reports to AWS S3: tutorials/aws/s3.md
          - Fixers (Remediations): tutorials/fixer.md
          - Check Aliases: tutorials/check-aliases.md
          - Custom Metadata: tutorials/custom-checks-metadata.md
          - Pentesting: tutorials/pentesting.md
          - Scan Unused Services: tutorials/scan-unused-services.md
          - Quick Inventory: tutorials/quick-inventory.md
          - Tutorials:
            - Parallel Execution: tutorials/parallel-execution.md

      - Providers:
        - AWS:
            - Getting Started: tutorials/aws/getting-started-aws.md
            - Authentication: tutorials/aws/authentication.md
            - Assume Role (CLI): tutorials/aws/role-assumption.md
            - AWS Organizations: tutorials/aws/organizations.md
            - AWS Regions and Partitions: tutorials/aws/regions-and-partitions.md
            - Tag-based Scan: tutorials/aws/tag-based-scan.md
            - Resource ARNs based Scan: tutorials/aws/resource-arn-based-scan.md
            - Boto3 Configuration: tutorials/aws/boto3-configuration.md
            - Threat Detection: tutorials/aws/threat-detection.md
            - Tutorial > AWS CloudShell: tutorials/aws/cloudshell.md
            - Tutorial > Scan Multiple AWS Accounts: tutorials/aws/multiaccount.md
        - Azure:
            - Getting Started: tutorials/azure/getting-started-azure.md
            - Authentication: tutorials/azure/authentication.md
            - Non default clouds: tutorials/azure/use-non-default-cloud.md
            - Subscriptions: tutorials/azure/subscriptions.md
            - Create Prowler Service Principal: tutorials/azure/create-prowler-service-principal.md
        - Google Cloud:
            - Getting Started: tutorials/gcp/getting-started-gcp.md
            - Authentication: tutorials/gcp/authentication.md
            - Projects: tutorials/gcp/projects.md
            - Organization: tutorials/gcp/organization.md
            - Retry Configuration: tutorials/gcp/retry-configuration.md
        - Kubernetes:
            - In-Cluster Execution: tutorials/kubernetes/in-cluster.md
            - Non In-Cluster Execution: tutorials/kubernetes/outside-cluster.md
            - Miscellaneous: tutorials/kubernetes/misc.md
        - Microsoft 365:
            - Getting Started: tutorials/microsoft365/getting-started-m365.md
            - Authentication: tutorials/microsoft365/authentication.md
            - Use of PowerShell: tutorials/microsoft365/use-of-powershell.md
        - GitHub:
            - Getting Started: tutorials/github/getting-started-github.md
            - Authentication: tutorials/github/authentication.md
        - IaC:
            - Getting Started: tutorials/iac/getting-started-iac.md
            - Authentication: tutorials/iac/authentication.md
        - MongoDB Atlas:
            - Getting Started: tutorials/mongodbatlas/getting-started-mongodbatlas.md
            - Authentication: tutorials/mongodbatlas/authentication.md
        - LLM:
            - Getting Started: tutorials/llm/getting-started-llm.md
      - Compliance:
        - ThreatScore: tutorials/compliance/threatscore.md

  - Developer Guide:
      - Concepts:
        - Introduction: developer-guide/introduction.md
        - Providers: developer-guide/provider.md
        - Services: developer-guide/services.md
        - Checks: developer-guide/checks.md
        - Outputs: developer-guide/outputs.md
        - Integrations: developer-guide/integrations.md
        - Compliance: developer-guide/security-compliance-framework.md
        - Lighthouse: developer-guide/lighthouse.md
      - Providers:
        - AWS: developer-guide/aws-details.md
        - Azure: developer-guide/azure-details.md
        - Google Cloud: developer-guide/gcp-details.md
        - Kubernetes: developer-guide/kubernetes-details.md
        - Microsoft 365: developer-guide/m365-details.md
        - GitHub: developer-guide/github-details.md
        - LLM: developer-guide/llm-details.md
      - Miscellaneous:
        - Documentation: developer-guide/documentation.md
        - Testing:
          - Unit Tests: developer-guide/unit-testing.md
          - Integration Tests: developer-guide/integration-testing.md
        - Debugging: developer-guide/debugging.md
        - Configurable Checks: developer-guide/configurable-checks.md
        - Renaming Checks: developer-guide/renaming-checks.md
        - Check Metadata Writting Guidelines: developer-guide/check-metadata-guidelines.md
  - Security: security.md
  - Contact Us: contact.md
  - Troubleshooting: troubleshooting.md
  - About 🔗: https://prowler.com/about#team
  - Release Notes 🔗: https://github.com/prowler-cloud/prowler/releases

# Customization
extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  analytics:
    provider: google
    property: G-KBKV70W5Y2
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/prowler-cloud
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/toniblyx
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/toniblyx
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/prowlercloud

# Copyright
copyright: >
  Copyright &copy; <script>document.write(new Date().getFullYear())</script> Toni de la Fuente, Maintained by the Prowler Team at ProwlerPro, Inc.</a>
  </br><a href="#__consent">Change cookie settings</a>

markdown_extensions:
  - abbr
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde