mkdocs.yml

site_name: NetBox Labs Documentation
theme:
  name: material
  custom_dir: overrides
  favicon: images/netbox-favicon.png
  logo: images/netbox-light-favicon.png
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.indexes
    - navigation.sections
    - navigation.prune
    - search.suggest
    # - toc.integrate
    - content.code.copy
    - content.code.select
  palette:
    - scheme: nbl-light
      toggle:
        icon: material/lightbulb 
        name: Switch to dark mode
    - scheme: nbl-dark
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
extra_css:
  - stylesheets/extra.css
  - stylesheets/custom.css
markdown_extensions:
  - abbr
  - attr_list
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      toc_depth: 3
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
  - search
nav:
  - Home: index.md
  - Cloud:
      - Getting Access:
        - Setting up Console Access: "Administration Console/console-access.md"
        - Accessing the Console From the NetBox Cloud UI: "Administration Console/console-access-from-ui.md"
        - Retrieving NetBox Cloud Admin Credentials: "Administration Console/retrieving-nbc-credentials.md"
      - Prefix Lists: "Administration Console/prefix-lists.md"
      - Working with Database Backups: "Administration Console/working_with_database_backups.md"
      - Upgrade NetBox Cloud: "Administration Console/upgrading-nbc.md"
      - Set up Two-Factor Authentication: "Administration Console/set_up_2fa.md"
      - Migrate to NetBox Cloud: "NetBox Cloud/migrating-to-netbox-cloud.md"
      - NetBox Cloud Plugins: "Administration Console/netbox-cloud-plugins.md"
      - Public IP Addressing: "Administration Console/public-ip-addressing.md"
      - Managing Hostnames: "Administration Console/managing-hostnames.md"
      - Single Sign-On (SSO):
        - Entra ID:
          - Microsoft Entra ID SSO: "Administration Console/azure-ad-sso-setup.md"
          - Entra ID Group Mapping: "Administration Console/azure-group-mapping.md"
        - Okta:
          - Set up Okta SSO: "Administration Console/okta-sso-setup.md"
          - Okta Group Mapping: "Administration Console/okta-group-mapping.md"
      - Free Plan:
        - Features: "Administration Console/free-plan-features.md"
        - Add a New User: "Administration Console/free-plan-new-user.md"
      - Cloud Connectivity:
        - Do I Need Cloud Connectivity Options?: "cloud-connectivity/do-i-need-cloud-connectivity.md"
        - Cloud Connectivity Options:
          - Which Cloud Connectivity Option is Right for Me?: "cloud-connectivity/which-connectivity-option.md"
          - Internet Delivery (Single Region): "cloud-connectivity/internet-delivery.md"
          - AWS Private Link (Single Region): "cloud-connectivity/aws-private-link.md"
          - IPSEC VPN Tunnels (Single Region): "cloud-connectivity/ipsec-vpn-tunnels.md"
          - AWS Direct Connect (Single Region): "cloud-connectivity/aws-direct-connect.md"
          - AWS Direct Connect (Multi-Region): "cloud-connectivity/aws-direct-connect-multi-region.md"
        - Frequently Asked Questions: "cloud-connectivity/cloud-connectivity-faq.md"
      - Maintenance:
        - Scheduled Maintenance: "maintenance.md"
  - Enterprise:
    - Overview: "netbox-enterprise/nbe-overview.md"
    - Embedded Cluster:
      - Requirements: "netbox-enterprise/nbe-ec-requirements.md"
      - Installation: "netbox-enterprise/nbe-ec-installation.md"
    #- KOTS:
    #  - Requirements: "netbox-enterprise/nbe-kots-requirements.md"
    #  - Installation: "netbox-enterprise/nbe-kots-installation.md"
    - SSO:
      - Entra ID:
        - NBE Entra ID SSO Setup: "netbox-enterprise/nbe-azure-sso.md"
        - NBE Entra ID Group Mapping: "netbox-enterprise/nbe-azure-group-mapping.md"
      - LDAP: "netbox-enterprise/nbe-ldap.md"
    - "Administration":
      - "TLS and Ingress": "netbox-enterprise/nbe-tls-ingress.md"
      - "Backups": "netbox-enterprise/nbe-backups.md"
      - "Advanced Tools and Troubleshooting": "netbox-enterprise/nbe-troubleshooting.md"
    - "Release Notes": "netbox-enterprise/nbe-release-notes.md"
  - Discovery & Assurance:
    - Solution Overview: "discovery-assurance.md"
    - Quickstart Guide: "netbox-discovery/quickstart-guide.md"
    - NetBox Discovery:
      - NetBox Discovery: "netbox-discovery/index.md"
      - Discovery Agent:
        - Overview: "netbox-discovery/agent/index.md"
        - Getting started: "netbox-discovery/agent/get-started.md"
        - Configuration format: "netbox-discovery/agent/configuration-file.md"
        - Network Discovery: "netbox-discovery/agent/network_discovery.md"
        - Device Discovery: "netbox-discovery/agent/device_discovery.md"
    - NetBox Assurance:
      - NetBox Assurance: "netbox-assurance/index.md"
  - Integrations: 
    - NetBox Ansible Collection: "netbox-integrations/netbox-ansible-collection.md"
    - pyATS: "netbox-integrations/pyats.md"
    - ServiceNow: 
      - Overview: "netbox-integrations/servicenow/index.md"
  - SDKs:
    - Pynetbox: "sdks/pynetbox.md"
  - Extensions:
    - Branching:
      - Overview: "netbox-extensions/branching/index.md"
      - Configuration: "netbox-extensions/branching/configuration.md"
      - Changelog: "netbox-extensions/branching/changelog.md"
      - Using Branches:
        - Creating a Branch: "netbox-extensions/branching/using-branches/creating-a-branch.md"
        - Syncing & Merging Changes: "netbox-extensions/branching/using-branches/syncing-merging.md"
        - Reverting a Branch: "netbox-extensions/branching/using-branches/reverting-a-branch.md"
        - Interact with Branches via API: "netbox-extensions/branching/using-branches/api.md"
      - Models:
        - Branches: "netbox-extensions/branching/models/branch.md"
        - Branch Events: "netbox-extensions/branching/models/branchevent.md"
        - Change Diffs: "netbox-extensions/branching/models/changediff.md"
        - Object Changes: "netbox-extensions/branching/models/objectchange.md"
    - Change Management:
      - Overview: "netbox-extensions/changes/index.md"
      - Configuration: "netbox-extensions/changes/configuration.md"
      - Changelog: "netbox-extensions/changes/changelog.md"
      - Models:
        - Change Request: "netbox-extensions/changes/models/changerequest.md"
        - Comment: "netbox-extensions/changes/models/comment.md"
        - Comment Reply: "netbox-extensions/changes/models/commentreply.md"
        - Policy: "netbox-extensions/changes/models/policy.md"
        - Policy Rule: "netbox-extensions/changes/models/policyrule.md"
        - Review: "netbox-extensions/changes/models/review.md"
    - Diode:
      - Overview: "netbox-extensions/diode/index.md"
      - Get started: 
        - Components: "netbox-extensions/diode/diode-get-started.md"
        - Installing the Diode plugin: "netbox-extensions/diode/diode-plugin.md"
        - Running the Diode server: "netbox-extensions/diode/diode-server.md"
        - Installing the Diode client SDK: "netbox-extensions/diode/diode-client.md"
  - Product and Feature Lifecycle: "product_feature_lifecycle.md"
extra:
  social:
    - icon: fontawesome/solid/globe
      link: https://netboxlabs.com
    - icon: octicons/mail-24
      link: "mailto:support@netboxlabs.com"
  analytics:
    provider: google
    property: G-Q107GMDTJM
copyright: Copyright © 2025 NetBox Labs