mkdocs.yml

site_name: "Gixy-Next: NGINX Configuration Security Scanner"
site_long_name: "Gixy-Next: NGINX Security Scanner & Configuration Hardening"
site_description: "Gixy-Next (Gixy) is an open source NGINX security, hardening, and configuration compliance scanner. Run automated NGINX configuration security audits and compliance checks, find performance misconfigurations in nginx.conf, and harden your NGINX servers."
site_url: https://gixy.io/
repo_url: https://github.com/MegaManSec/Gixy-Next
repo_name: MegaManSec/Gixy-Next
site_author: "Joshua Rogers"
theme:
  name: "material"
  language: en
  custom_dir: docs/overrides
  favicon: "https://gixy.io/favicon.ico"
  logo: /favicon.svg
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  features:
    - content.code.copy
plugins:
  - privacy
  - optimize
  - search:
      separator: '[\s\-,:!=\[\]()"/_]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - i18n:
      languages:
        - locale: en
          name: English
          default: true
          build: true
      docs_structure: folder
      reconfigure_material: true
      fallback_to_default: true
  - llmstxt:
      markdown_description: The Gixy-Next security scanner and configuration checker statically analyzes NGINX configurations to find security issues, performance issues, and hardening opportunities before they reach production.
      full_output: llms-full.txt
      sections:
        Overview and usage:
          - en/index.md: Overview and quickstart
          - en/usage.md: Usage Guide
          - en/configuration.md: Configuration and CLI usage
          - en/variables-dropins.md: Variables and drop-in files
          - en/contributing.md: Contributing Guide
          - en/nginx-configuration-checker.md: "NGINX Config Checker: gixy-next vs nginx -t"
        Built-in plugins:
          - en/plugins/*.md: Scanning plugin
nav:
  - "Gixy-Next Overview": index.md
  - "Usage Guide": usage.md
  - "In-Browser Scanner": scanner.md
  - "Live Config Dump: nginx -T": nginx-config-dump.md
  - Plugins:
    - plugins/add_header_content_type.md
    - plugins/add_header_multiline.md
    - plugins/add_header_redefinition.md
    - plugins/alias_traversal.md
    - plugins/allow_without_deny.md
    - plugins/default_server_flag.md
    - plugins/error_log_off.md
    - plugins/hash_without_default.md
    - plugins/host_spoofing.md
    - plugins/http_splitting.md
    - plugins/if_is_evil.md
    - plugins/invalid_regex.md
    - plugins/low_keepalive_requests.md
    - plugins/merge_slashes_on.md
    - plugins/missing_worker_processes.md
    - plugins/origins.md
    - plugins/proxy_buffering_off.md
    - plugins/proxy_pass_normalized.md
    - plugins/regex_redos.md
    - plugins/resolver_external.md
    - plugins/return_bypasses_allow_deny.md
    - plugins/ssrf.md
    - plugins/stale_dns_cache.md
    - plugins/try_files_is_evil_too.md
    - plugins/unanchored_regex.md
    - plugins/valid_referers.md
    - plugins/version_disclosure.md
    - plugins/worker_rlimit_nofile_vs_connections.md
  - "Configuration Guide": configuration.md
  - "Custom Variables & Drop-ins": variables-dropins.md
  - "Contributing to Gixy-Next": contributing.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.tabbed
  - toc:
      permalink: false
extra_javascript:
  - extra/gixy-scan.js
  - extra/redirect-en.js
extra:
  generator: false
extra_css:
  - extra.css
extra_files:
  - extra/gixy_next-0.0.9-py3-none-any.whl