mkdocs.yml

site_name: OpenBAS Documentation
site_description: Documentation about OpenBAS, the next-generation Breach & Attack Simulation platform.
site_author: Filigran
site_url: https://docs.openbas.io
copyright: © 2024 Filigran. All rights reserved
repo_name: GitHub
repo_url: https://github.com/OpenBAS-Platform/openbas
edit_uri: https://github.com/OpenBAS-Platform/docs/blob/main/docs/

# Theming
theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.png
  features:
    - navigation.tabs
    - navigation.path
    - navigation.footer
    - navigation.expand
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - search.highlight
  palette:
    scheme: filigran
  font:
    text: IBM Plex Sans
    code: Roboto Mono
# CSS
extra_css:
  - assets/css/custom.css

# Extra
extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-D12HQ64D7C
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OpenBAS-Platform
    - icon: fontawesome/brands/medium
      link: https://blog.filigran.io
    - icon: fontawesome/brands/slack
      link: https://community.filigran.io
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/filigran
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/FiligranHQ
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/FiligranHQ

# Plugins
plugins:
  - mike:
      alias_type: symlink
      canonical_version: latest
  - search
  - git-committers:
      repository: OpenBAS-Platform/docs
      branch: main
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - glightbox

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - tables
  - admonition
  - def_list
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.smartsymbols
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.betterem
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: false
      auto_title: false
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.snippets:
      url_download: true

# Page tree
nav:
  - Home: 'index.md'
  - Deployment & Setup:
    - Platform:
      - Overview: deployment/overview.md
      - Installation: deployment/installation.md
      - Configuration: deployment/configuration.md
      - Authentication: deployment/authentication.md
      - Upgrade: deployment/upgrade.md
    - Ecosystem:
      - Executors: deployment/executors.md
      - Injectors: deployment/injectors.md
      - Collectors: deployment/collectors.md
      - Integrations: deployment/integrations.md
      - Other resources: deployment/resources.md
    - Advanced:
      - Clustering: deployment/clustering.md
      - Troubleshooting: deployment/troubleshooting.md
  - User Guide:
    - Getting started: usage/getting-started.md
    - Foundations:
      - Scenario and Simulations: usage/scenarios_and_simulations.md
      - Injects and Expectations: usage/injects_and_expectations.md
    - Evaluate your Security posture:
      - Overview: usage/evaluate/overview.md
      - Simulation: usage/simulation.md
      - Atomic testing: usage/atomic.md
      - Injects: usage/injects.md
      - Targets: usage/targets.md
      - Expectations: usage/expectations.md
    - Build your own Threat Scenario:
      - Scenario: usage/scenario.md
      - Generating Scenario from OpenCTI: usage/scenario/opencti_scenario.md
      - Importing injects into a Scenario: usage/scenario_import.md
      - Assets: usage/assets.md
      - Teams, Players and Organizations: usage/teams_and_players_and_organizations.md
      - Components:
        - Documents: usage/components/documents.md
        - Custom variables: usage/components/variables.md
        - Personas: usage/components/personas.md
        - Channels: usage/components/channels.md
        - Media pressure: usage/components/media_pressure.md
        - Challenges: usage/components/challenges.md
        - Lessons: usage/components/lessons.md
        - Payloads: usage/components/payloads.md
    - Share and export:
      - Simulations: usage/simulation_reports.md
    - Improve your security posture:
      - Mitigations: usage/mitigations.md
      - Skills: usage/skills.md
    - Interact with your environment:
      - Injectors:
        - Overview: usage/injectors.md
        - Built-In Injector: usage/injects_builtin.md
        - Caldera Injector: usage/inject-caldera.md
      - Collectors:
        - Overview: usage/collectors.md
        - Caldera Collector: usage/collector-caldera.md
      - Agents: usage/openbas-agent.md
  - Administration:
    - Introduction: administration/introduction.md
    - Enterprise edition: administration/enterprise.md
    - Platform settings:
      - Parameters: administration/parameters.md
      - Security:
        - Policies: administration/policies.md
        - Users and RBAC: administration/users.md
  - Reference:
      - APIs:
          - Filters: reference/apis/filters.md
  - Development:
    - Prerequisites:
      - Ubuntu: development/environment_ubuntu.md
      - Windows: development/environment_windows.md
    - Platform: development/platform.md
    - Injectors: development/injectors.md
    - REST API: development/api-usage.md