mkdocs.yml

site_name: NOC
site_description: NOC, the open-source network management system
site_author: Gufo Labs
site_url: https://getnoc.com/
repo_url: https://github.com/gufolabs/noc
repo_name: GitHub
edit_uri: -/edit/master/docs/
copyright: 2007-2026, Gufo Labs
nav:
  - Home: index.md
  - Installation: installation-guide/
  - Guides:
      - Overview: sections-overview/guides.md
      - Quickstart: quickstart-guide/index.md
      - Community Guide: community-guide/
      - Docs Contributing Guide: docs-contributing-guide/index.md
      - Docs Translation Guide: docs-translation-guide/index.md
      - Docs Style Guide: docs-style-guide/
  - References:
      - Overview: sections-overview/references.md
      - Concepts: concepts/
      - Profiles: profiles-reference/
      - Capabilities: caps-reference/
      - Alarm Classes: alarm-classes-reference/
      - Event Classes: event-classes-reference/
      - Measurement Units: measurement-units-reference/index.md
      - Metrics: metrics-reference/
      - MX Messages: mx-messages-reference/
      - Technologies: technologies-reference/index.md
      - Services: services-reference/
      - Configuration: config-reference/
      - Discovery: discovery-reference/
      - Internal Metrics: internal-metrics-reference/index.md
      - noc-agent: agent-reference/
      - Merge Request Labels: mr-labels-reference/index.md
      - DataStream API: datastream-api-reference/
      - NBI API: nbi-api-reference/
      - BI Dictionaries: bi-dict-reference/
      - BI Models: bi-models-reference/
      - ConfDB: confdb-reference/
      - Scripts Reference: scripts-reference/
      - Handlers: handlers-reference/
      - Object Models: object-models-reference/
      - Model Interfaces: model-interfaces-reference/
      - Connection Types: connection-types-reference/
      - Inventory Protocols: inventory-protocols-reference/index.md
      - Streams: streams-reference/
      - Alarm Reference Format: alarm-reference-format/index.md
      - Date and Time Formats: datetime-format/index.md
      - Man Pages: man/
      - Feature Gates: feature-gates-reference/index.md
      - Operational Alerts: operational-alerts-reference/
      - Supported Standards: supported-standards/index.md
  - How-to:
      - Overview: sections-overview/howto.md
      - Deploy NOC: deploy-noc-howto/index.md
      - Backup NOC: backup-noc-howto/index.md
      - Shell: noc-shell-howto/index.md
      - Add devices from network scan: add-from-network-scan-howto/index.md
      - Sharing Collections Howto: sharing-collections-howto/index.md
      - Loading FIAS Data Howto: fias-loading-howto/
      - Custom Static Dashbord with Device Charts: custom-dev-grafana-dashboard-howto/index.md
      - How to Import MIB Files: import-mib-file-howto/index.md
      - Using Housekeeper to Collect Device Data: using-hk-to-collect-data-howto/index.md
      - Upgrade Your Single-node Postgres Server: upgrade-single-postgres-howto/index.md
      - NOC Monitoring: noc-monitoring-howto/index.md
      - Reclaim Database Space: reclaim-db-space-howto/index.md
      - Migrate Liftbridge to Kafka: liftbridge-to-kafka-howto/index.md
      - Cleaning False Config Changes: cleaning-false-config-changes-howto/index.md
      - Create Object Models: create-object-models-howto/
      - Writing NOC Command: writing-noc-command-howto/index.md
      - Language translation: language-translation-howto/index.md
      - Configure vCenter on NOC as Device Source: howto-add-vcenter-to-noc/index.md
      - Connect Zabbix Remote System as Managed Object Source: howto-add-zabbix-rs-to-noc/index.md
  - Background:
      - Overview: sections-overview/background.md
      - NOC Governance: governance/index.md
      - Connection Restrictions: connection-restrictions/index.md
      - Connection Type Restrictions: connection-type-restrictions/index.md
      - Topology Processing Features: topology-processing-features/index.md
      - Configuration Management: configuration-management/index.md
      - Host Discovery Network: host-discovery-network/index.md
      - Fault Management: fault-management/index.md
      - Alarm Escalation: alarm-escalation-reference/index.md
      - Performance Management: performance-management/
      - Working with Report: reference-report-configuration/index.md
      - Peering Management: peering-management/index.md
      - Monitoring by Service Operation Status: service-status-monitoring/index.md
      - Message Notification: message-notification/index.md
      - Custom: custom/index.md
      - Cards: card/index.md
      - ETL: etl/index.md
      - Storm Protection: storm-protection/index.md
      - UI Guideline: ui-guideline/index.md
      - NOC Products Highlights: highlights/
  - Blog:
      - blog/index.md
  - Releases: releases/
  - Glossary: glossary/index.md
  - License: license.md
  - Thanks: thanks.md
# Russian translations
# nav:
#   - User's Guide:
#       - How-to Guides:
#           - Собственный статичный дашборд с графиками устройства в НОКе: user/howto/how-to-create-custom-device-grafana-dash.md
#           - Использование Housekeeper для сбора данных с устройства: user/howto/how-to-use-hk-for-collect-device-data.md
#           - Как импортировать MIB файл в НОК: user/howto/how-to-import-mib-file.md
#       - Background:
#           - Работа с конфигурацией оборудования: user/background/configuration-management/index.md
#           - Работа с топологией: user/background/topology/index.md
#           - Работа с авариями: user/background/fault-management/index.md
#           - Работа с метриками: user/background/performance-management/index.md
#           - Учет BGP сессий: user/background/peering-management/index.md
#       - Reference:
#           - Concepts:
#   - Developer's Guide:
#       - Tools:
#           - Использование консоли разработчика для настройки системы: dev/tools/howto-noc-shell-example-work-1.md
#       - Handlers:
#           - Удаление лишних данных из конфигурационного файла MO: dev/handlers/howto-delete-config-data.md
#       - Data Models: dev/data-models/index.md
#           - Типы соединений: dev/object-model/connection-type.md
#           - Правила соединений: dev/object-model/connection-rule.md
#           - Ограничения на соединения: dev/object-model/connection-restrictions.md
#           - Ограничения на типы соединения: dev/object-model/connection-type-restrictions.md
#           - Создания Модели Объекта: dev/object-model/how-to-create-object-model.md
theme:
  name: material
  logo: assets/logo.svg
  custom_dir: docs/overrides
  features:
    - content.action.edit
    - navigation.tabs
    - navigation.tabs.sticky
    # - navigation.path
    - navigation.prune
    # - navigation.instant
    - navigation.footer
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      primary: deep purple
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode
extra_css:
  - assets/extra.css
use_directory_urls: true
site_dir: dist/docs
strict: false
markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - attr_list
  - def_list
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
watch:
  - docs/
  - mkdocs.yml
  - macros.py
plugins:
  - search
  - macros:
      module_name: macros
      on_error_fail: true
  - blog:
      blog_dir: blog/
      post_url_date_format: yyyy
      post_url_format: "{date}-{slug}"
  - literate-nav:
      nav_file: SUMMARY.md
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ru
          name: Русский
          build: true
          nav_translations:
            Installation: Установка
            Using Gufo Thor: Используя Gufo Thor
            Overview: Обзор
            External Storage: Внешнее хранилище
            Interface: Интерфейс
            Interface Profile: Профиль интерфейса
            Label: Метка
hooks:
  - scripts/docs/hooks/blog.py
extra:
  analytics:
    provider: google
    property: G-9JQSC5GQTM
  tab: ":material-arrow-right:"
  tab2: ":material-arrow-right: :material-arrow-right:"
  tab3: ":material-arrow-right: :material-arrow-right: :material-arrow-right:"
  complex: ":material-arrow-down:"
  "yes": ":material-check:"
  "no": ":material-close:"
  wbr: "<wbr>"
  version: "25.1.2"