mkdocs.yml

site_name: Tracee
site_url: https://aquasecurity.github.io/tracee/
site_description: Runtime security and forensics using eBPF.
docs_dir: docs/
repo_name: GitHub
repo_url: https://github.com/aquasecurity/tracee
edit_uri: ""

nav:
  - Getting Started: index.md
  - Architecture: architecture.md
  - Installation:
    - Getting Tracee: installing/getting.md
    - Prerequisites: installing/prerequisites.md
    - Docker: installing/docker.md
    - Kubernetes: installing/kubernetes.md
    - Packages:
      - Ubuntu: installing/distros/ubuntu.md
      - Fedora: installing/distros/fedora.md
      - NixOS: installing/distros/nix-nixos.md
    - Linux Headers: installing/headers.md
  - Building:
    - Building Tracee: building/building.md
    - Building Environment: building/environment.md
    - Building Containers: building/containers.md
    - Building non CO-RE: building/nocore-ebpf.md
    - OS Packaging: building/packaging.md
    - Building on OSX: building/macosx.md
  - Tracing:
    - Getting Started: tracing/index.md
    - Output Formats: tracing/output-formats.md
    - Output Options: tracing/output-options.md
    - Event Filtering: tracing/event-filtering.md
  - Capturing:
    - Getting Started: capturing/index.md
  - Detecting:
    - Getting Started: detecting/index.md
    - Creating Rules:
      - Golang: detecting/golang.md
      - Rego: detecting/rego.md
      - Go-Cel: detecting/go-cel.md
    - Available Rules: detecting/rules.md
  - Integrating:
      - Container Engines: integrating/container-engines.md
      - Detected Events:
        - Go-template: integrating/go-templates.md
        - Deliver:
          - Webhook: integrating/webhook.md
          - Postee: integrating/postee.md
          - Falcosidekick: integrating/falcosidekick.md
      - Prometheus: integrating/prometheus.md
  - Deep Dive:
    - Secure Tracing: deep-dive/secure-tracing.md
    - Performance: deep-dive/performance.md
    - Caching Events: deep-dive/caching-events.md
    - Ordering Events: deep-dive/ordering-events.md
    - Dropping Capabilities: deep-dive/dropping-capabilities.md
    - Override OS files: deep-dive/override-os-files.md
  - Tutorials:
      - Setup Development Machine with Vagrant: tutorials/setup-development-machine-with-vagrant.md
      - Deploy Tracee Grafana Dashboard: tutorials/deploy-grafana-dashboard.md
  - Contributing:
      - Source Code Guidelines: contributing/guidelines.md

theme:
    name: material
    language: 'en'
    logo: images/tracee_logo_only.png
    features:
      - navigation.expand
      - navigation.instant

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - admonition
  - toc:
      permalink: true

extra:
  generator: false
  version:
    method: mike
    provider: mike

plugins:
  - search
  - macros