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:
    - Overview: index.md
    - Kubernetes - Quick Start: getting-started/kubernetes-quickstart.md
    - Docker - Quick Start: getting-started/docker-quickstart.md
    - Installation:
      - Getting Tracee: getting-started/installing/getting.md
      - Prerequisites: getting-started/installing/prerequisites.md
      - Docker: getting-started/installing/docker.md
      - Kubernetes: getting-started/installing/kubernetes.md
      - Packages:
        - Ubuntu: getting-started/installing/distros/ubuntu.md
        - Fedora: getting-started/installing/distros/fedora.md
        - NixOS: getting-started/installing/distros/nix-nixos.md
      - Linux Headers: getting-started/installing/headers.md
  - Tutorials:
    - Everything is an event: tutorials/everything-is-an-event.md
    - Setup Development Machine with Vagrant: tutorials/setup-development-machine-with-vagrant.md
    - Deploy Tracee Grafana Dashboard: tutorials/deploy-grafana-dashboard.md
  - Docs:
    - Overview: docs/overview.md
    - Tracing:
      - Getting Started: docs/tracing/index.md
      - Output Formats: docs/tracing/output-formats.md
      - Output Options: docs/tracing/output-options.md
      - Event Filtering: docs/tracing/event-filtering.md
      - Network Events: docs/tracing/network-events.md
    - Capturing:
      - Getting Started: docs/capturing/index.md
    - Detecting:
      - Getting Started: docs/detecting/index.md
      - Creating Rules:
        - Golang: docs/detecting/golang.md
        - Rego: docs/detecting/rego.md
        - Go-Cel: docs/detecting/go-cel.md
      - Available Rules: docs/detecting/rules.md
      - AVD: docs/detecting/avd.md
    - Integrating:
        - Container Engines: docs/integrating/container-engines.md
        - Detected Events:
          - Go-template: docs/integrating/go-templates.md
          - Deliver:
            - Webhook: docs/integrating/webhook.md
            - Postee: docs/integrating/postee.md
            - Falcosidekick: docs/integrating/falcosidekick.md
        - Prometheus: docs/integrating/prometheus.md
    - Deep Dive:
      - Architecture: docs/deep-dive/architecture.md
      - Secure Tracing: docs/deep-dive/secure-tracing.md
      - Performance: docs/deep-dive/performance.md
      - Caching Events: docs/deep-dive/caching-events.md
      - Ordering Events: docs/deep-dive/ordering-events.md
      - Override OS files: docs/deep-dive/override-os-files.md
      - Healthz: docs/deep-dive/healthz.md

  - Contributing:
    - Overview: contributing/overview.md
    - Source Code Guidelines: contributing/guidelines.md
    - Building:
      - Building Tracee: contributing/building/building.md
      - Building Environment: contributing/building/environment.md
      - Building Containers: contributing/building/containers.md
      - Building non CO-RE: contributing/building/nocore-ebpf.md
      - OS Packaging: contributing/building/packaging.md
      - Building on OSX: contributing/building/macosx.md
theme:
    name: material
    language: 'en'
    logo: images/tracee_logo_only.png
    features:
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.sections
      - content.tabs.link

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

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

plugins:
  - search
  - macros