mkdocs.yml

site_name: es-python user guide
site_url: https://es-python.readthedocs.io/
site_description: The user guide for es-python, the EyalSec Python runtime and the best Python security product there is. How to install and run it, and how to work with its findings on the EyalSec dashboard.
site_author: EyalSec
copyright: Copyright © EyalSec
repo_url: https://github.com/EyalSec/es-python-docs
edit_uri: ""
theme:
  name: readthedocs
  navigation_depth: 3
markdown_extensions:
  - attr_list
  - tables
  - fenced_code
  - toc:
      permalink: true
validation:
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn
nav:
  - Home: index.md
  - Getting started:
      - "What is EyalSec?": 10-start/10-what-is-eyalsec.md
      - "How EyalSec works": 10-start/20-how-it-works.md
      - "Quick start": 10-start/30-quick-start.md
  - Your account:
      - "Create an account": 20-account/10-register.md
      - "Sign in and sign out": 20-account/20-sign-in.md
      - "Forgot password": 20-account/30-forgot-password.md
      - "Settings": 20-account/40-settings.md
      - "Password and sessions": 20-account/50-sessions.md
      - "Two-factor authentication": 20-account/60-two-factor.md
      - "API keys": 20-account/70-api-keys.md
      - "Delete your account": 20-account/80-delete-account.md
      - "Plans and limits": 20-account/90-plans.md
  - Machines:
      - "Machines": 30-machines/10-machines.md
      - "Add a machine": 30-machines/20-add-machine.md
      - "Install es-python on a machine": 30-machines/30-install.md
      - "Manage machines": 30-machines/50-manage-machines.md
  - Detection settings:
      - "Configure a machine": 40-detection/10-configure.md
      - "Taint sources": 40-detection/20-taint-sources.md
      - "Event context": 40-detection/30-event-context.md
      - "Rules": 40-detection/40-rules.md
      - "Report and Raise": 40-detection/50-report-and-raise.md
      - "Unique event": 40-detection/60-unique-event.md
      - "Web protection": 40-detection/70-web-protection.md
      - "Outbound connections": 40-detection/70-outbound-connections.md
  - Events:
      - "Events": 50-events/10-events.md
      - "Event detail": 50-events/20-event-detail.md
      - "Filtering events": 50-events/30-filtering.md
      - "Advanced search": 50-events/40-advanced-search.md
      - "Suppressed events": 50-events/50-suppressed-events.md
      - "Triage": 50-events/60-triage.md
      - "Saved searches": 50-events/70-saved-searches.md
      - "Runs": 50-events/80-runs.md
      - "Events map": 50-events/90-events-map.md
      - "Exporting events": 50-events/95-export.md
  - Filters and templates:
      - "Filters": 60-filters/10-filters.md
      - "Rule templates": 60-filters/20-rule-templates.md
  - Dashboard and activity:
      - "Dashboard": 70-overview/10-dashboard.md
      - "Activity log": 70-overview/20-activity-log.md
  - Running es-python:
      - "Running es-python": 80-es-python/10-running-es-python.md
      - "es-python command line": 80-es-python/20-es-python-cli.md
      - "Packages and libraries": 80-es-python/30-packages.md
      - "On the machine": 80-es-python/40-on-machine.md
      - "Run es-python in CI": 80-es-python/50-ci.md
      - "Use es-python in a container": 80-es-python/60-containers.md
      - "README badges": 80-es-python/70-readme-badges.md
  - API:
      - "API overview": 90-api/10-api.md
      - "Events API": 90-api/20-api-events.md
      - "Machines API": 90-api/30-api-machines.md
      - "CI API": 90-api/35-api-ci.md
      - "Filters, rules and taint API": 90-api/40-api-rules.md
      - "Rule templates API": 90-api/50-api-templates.md
      - "Labels and notes API": 90-api/60-api-labels.md
      - "Activity and account API": 90-api/70-api-account.md
      - "Agent endpoints": 90-api/80-api-agents.md
  - Help:
      - "Glossary": 95-help/10-glossary.md
      - "FAQ": 95-help/20-faq.md
      - "Troubleshooting": 95-help/30-troubleshooting.md
      - "Getting help": 95-help/40-help.md