mkdocs.yml

site_name: VergeOS Docs
site_description: >-
  Comprehensive technical documentation for VergeOS hyperconverged infrastructure (HCI) platform.
  Learn to deploy, configure, and manage software-defined data centers with guides covering
  virtualization, storage, networking, backup & DR, tenants, AI, and automation.
site_url: https://docs.verge.io
repo_url: https://github.com/verge-io/docs
repo_name: verge-io/docs
edit_uri: edit/main/docs/


theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/vergeosfulllogowhite.svg
  favicon: assets/vergelogomark.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.tooltips
    - navigation.tabs
    - navigation.tabs.sticky
    #- navigation.sections
    - navigation.indexes
    #- toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - announce.dismiss
    - navigation.footer
    - navigation.path
    - content.action.edit  # Shows the edit button
    - content.action.view  # Shows the view source button
  language: en
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: custom
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Palette toggle for light mode
    - scheme: default
      primary: custom
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
plugins:
  - social:
      enabled: !ENV [CI, false]
      cards_layout_options:
        logo: docs/assets/social-icon.png
        background_color: "#324FBE"
  - blog:
      blog_dir: knowledge-base
      post_url_format: "{slug}"
      blog_toc: true
      archive: false
      pagination_per_page: 50
  - search:
      lang:
      - en
  - glightbox
  #- meta
markdown_extensions:
  - abbr
  - sane_lists
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      clickable_checkbox: true
  - footnotes
  - pymdownx.mark
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "#"
      toc_depth: 2

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/VergeIO_Inc
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/verge-io/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCnFu28s0GBVi18j7Ez3MXRg
    - icon: fontawesome/solid/paper-plane
      link: mailto:support@verge.io
    - icon: fontawesome/solid/phone
      link: tel:855-855-8300
  generator: false
  status:
    new: Recently added
    deprecated: Deprecated

extra_javascript:
  - javascripts/extra.js

extra_css:
  - stylesheets/extra.min.css
  - https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.1/font/bootstrap-icons.css

extra_files:
  - robots.txt

copyright: |
  Copyright &copy; 2026 <a href="https://verge.io" target="_blank" rel="noopener"> Verge.io</a> |
  <a href="#__consent">Change cookie settings</a>

nav:
  - Home: index.md
  - Implementation Guide:
    - Intro: implementation-guide/intro.md
    - Core Concepts: implementation-guide/concepts.md
    - Node Sizing: implementation-guide/sizing.md
    - Network Design: implementation-guide/network-design.md
    - Switch Config Guide: implementation-guide/switch-configuration.md
    - Installation:
      - Pre-Installation: implementation-guide/pre-installation.md
      - Bootable Media: implementation-guide/install-media.md
      - Installation: implementation-guide/installation-guide.md
      - Post-Installation: implementation-guide/post-installation.md
    - Install Additional Nodes:
      - Scale Out Nodes: implementation-guide/scale-out-nodes.md
      - Compute Nodes: implementation-guide/compute-nodes.md
      - Storage Nodes: implementation-guide/storage-nodes.md
    - Reference Architecture:
      - Edge / ROBO: reference-architecture/edge.md
      #- Enterprise Multi-Site: reference-architecture/enterprise-multi-site.md
      - Cloud Providers: reference-architecture/csp.md
      - Life / Data Science: reference-architecture/data-science.md
      - Homelab: reference-architecture/homelab.md
  - Knowledge Base:
    - knowledge-base/index.md
  - Product Guide:
    - Introduction:
      - What is VergeOS?: product-guide/intro/what-is-vergeos.md
      - Platform Capabilities: product-guide/intro/platform-capabilities.md
      - Transitioning from VMware: product-guide/intro/transition-from-vmware.md
      - UI Overview: product-guide/ui-overview.md
      - New System Configuration: product-guide/intro/new-system-configuration.md
    - Storage:
       - Overview: product-guide/storage/overview.md
       - vSAN Architecture: product-guide/storage/vsan-architecture.md
       - vSAN Redundancy Levels: product-guide/storage/vsan-redundancy-levels.md
       - Storage Tiers: product-guide/storage/storage-tiers.md
       - Preferred Tier: product-guide/storage/preferred-tiers.md
       - Storage Units and Capacity Reporting: product-guide/storage/storage-units.md
       - External Storage Integration: product-guide/storage/external-storage-integration.md
       - Fibre Channel: product-guide/storage/fibre-channel.md
       - vSAN Deletion Process: product-guide/storage/vsan-deletion-process.md
       - vSAN Diagnostics: product-guide/storage/vsan-diagnostics.md
    - Backup & DR:
      - Overview: product-guide/backup-dr/overview.md
      - Snapshots:
        - Overview: product-guide/backup-dr/snapshots-overview.md
        - System Snapshots: product-guide/backup-dr/system-snapshots.md
        - Restores from System Snapshots: product-guide/backup-dr/system-snapshot-restores.md
        - Snapshot Profiles: product-guide/backup-dr/snapshot-profiles.md
        - Immutable Snapshots: product-guide/backup-dr/immutable-snapshots.md
        - VM Snapshots and Restores: product-guide/backup-dr/vm-snapshots-restores.md
        - Tenant Snapshots: product-guide/tenants/tenant-snapshots.md
        - NAS Volume Snapshots and Restores: product-guide/nas/volume-snapshots-restores.md
      - Site Syncs:
        - Overview: product-guide/backup-dr/syncs-overview.md
        - Configuration: product-guide/backup-dr/sync-configuration.md
        - Monitoring: product-guide/backup-dr/monitoring-site-syncs.md
        - Sync Back: product-guide/backup-dr/sync-back.md
        - Manual Sync: product-guide/backup-dr/manual-site-syncs.md
        - Repair Server: product-guide/backup-dr/repair-server.md
    - System Configuration:
      - SMTP: product-guide/system/smtp.md
      - Authentication:
        - Overview: product-guide/auth/auth-sources-overview.md
        - Entra ID / Azure AD: product-guide/auth/azure-auth.md
        - Google: product-guide/auth/google-auth.md
        - Multi-Factor Authentication: product-guide/auth/multifactor-auth.md
        - OIDC Applications Overview: product-guide/auth/oidc-apps-overview.md
      - Certificates: product-guide/system/certificates.md
      - Clusters: 
        - Overview: product-guide/system/clusters-overview.md
        - Configuration Options: product-guide/system/cluster-settings.md
      - Access Control:
        - Users and Groups: product-guide/system/users-groups.md
        - Permissions: product-guide/system/permissions.md
        - API Keys: product-guide/system/api-keys.md
      - Nodes:
        - Overview: product-guide/system/nodes-overview.md
        - Core Fabric Status: product-guide/system/core-fabric-status.md
        - IPMI: product-guide/system/ipmi.md
        - System Event Log (SEL): product-guide/system/sel.md
        - Node Diagnostics: product-guide/system/node-diagnostics.md
      - Sites Dashboard:
        - Overview: product-guide/system/sites-overview.md
        - Adding Sites: product-guide/system/site-dashboard-add-sites.md
      - Tasks / Events:
        - Create Automated Tasks: product-guide/automation/create-tasks.md
      - Service Containers: product-guide/system/service-containers.md
      - System Settings:
        - Overview: product-guide/system/settings-overview.md
        - Licensing Overview: product-guide/system/licensing-overview.md
        - Licensing and Updates: product-guide/system/licensing-and-updates.md
        - Advanced Settings: product-guide/system/advanced-system-settings.md
      - Tags: product-guide/system/tags.md
      - Themes: product-guide/system/themes.md
    - Virtual Machines:
      - Overview: product-guide/virtual-machines/overview.md
      - Quick Start: 
        - Best Practices: product-guide/virtual-machines/vm-best-practices.md
        - Uploading Media Images: product-guide/storage/uploading-files-to-vsan.md
        - Creating Virtual Machines: product-guide/virtual-machines/creating-vms.md
        - Virtual Machine Drives: product-guide/virtual-machines/vm-drives.md
        - Sharing Disks Between VMs: product-guide/virtual-machines/sharing-disks-between-vms.md
        - Virtual Machine Network Interfaces: product-guide/virtual-machines/vm-nics.md
        - Virtual Machine Fields: product-guide/virtual-machines/vm-field-descriptions.md
        - VM Guest Agent: product-guide/virtual-machines/vm-guest-agent.md
      - Migrating VMs to VergeOS:
        - Overview: product-guide/virtual-machines/vm-migration-overview.md
        - From Media Images: product-guide/virtual-machines/import-from-upload.md
        - From VMware Backup: product-guide/virtual-machines/import-from-vmware.md
        - From NAS Volume: product-guide/virtual-machines/import-from-nas.md
        - Viewing Import Jobs: product-guide/virtual-machines/view-import-jobs.md
      - VM Operations:
        - Working With VMs: product-guide/virtual-machines/working-with-vms.md
        - Live Migrations: product-guide/virtual-machines/live-migrations.md
      - VDI:
        - VDI Administrator: product-guide/virtual-machines/vdi-administrator.md
        - VDI User: product-guide/virtual-machines/vdi-user.md
        - Virtual Machine Remote Console: product-guide/virtual-machines/vm-remote-console.md
      - Guest OS Compatibility: product-guide/virtual-machines/guest-os-compatibility.md
    - Tenants:
      - Overview: product-guide/tenants/overview.md
      - Creating Tenants: product-guide/tenants/create-tenants.md
      - Layer 2 Networks: product-guide/tenants/layer-2-networks.md
      - Assigning External IP Addresses: product-guide/tenants/assign-ip-to-tenant.md
      - Increasing Resources: product-guide/tenants/add-tenant-resources.md
      - Modifying Tenants: product-guide/tenants/tenant-modifications.md
      - Monitoring Tenants: product-guide/tenants/tenant-monitoring.md
      - Reducing Resources: product-guide/tenants/reduce-tenant-resources.md
      - Sharing Files: product-guide/tenants/provide-files-to-tenant.md
      - Sharing VMs: product-guide/tenants/share-vm-snapshot.md
      - Tenant Snapshots: product-guide/tenants/tenant-snapshots.md
      - Tenant Restores: product-guide/tenants/tenant-restores.md
      - Usage Reports: product-guide/tenants/tenant-usagereports.md
    - NAS:
      - Overview: product-guide/nas/overview.md
      - Add a NAS Service: product-guide/nas/nas-service.md
      - NAS Diagnostics: product-guide/nas/nas-diagnostics.md
      - Configuration:
        - Local Volumes: product-guide/nas/nas-local-volumes.md
        - Remote Volumes: product-guide/nas/nas-remote-volumes.md
        - Shares: product-guide/nas/nas-shares.md
        - VM Export: product-guide/virtual-machines/vm-export-volume.md
        - Volume Syncs: product-guide/nas/volume-syncs.md
        - Join NAS to AD: product-guide/nas/nas-join-ad-domain.md
    - Networking:
      - Overview: product-guide/networks/network-overview.md
      - Concepts: product-guide/networks/network-concepts.md
      - Quick-Start Tasks: 
        - Connect to an Existing LAN/WAN: product-guide/networks/connect-lan-wan.md
        - Create an Internal Network with External Access: product-guide/networks/internal-external-access.md
        - Creating an Internal Layer2 Network: product-guide/networks/internal-layer2.md
        - Create a Layer 3 Internal Network: product-guide/networks/internal-layer3.md
        - Create a DHCP Static Entry: product-guide/networks/dhcp-static-lease.md
        - Assign an External IP to an Internal network: product-guide/networks/assign-external-ip.md
        - Create a 1:1 NAT: product-guide/networks/nat-1to1.md
      - Configuration:
        - Creating an Internal Network: product-guide/networks/internal-networks.md
        - Using Aliases: product-guide/networks/aliases.md
        - Network Rules: product-guide/networks/network-rules.md
        - VLANs: product-guide/networks/create-vlan.md
        - Bonded VLANs: product-guide/networks/bonded-vlans.md
      - Monitoring:
        - Network Dashboards: product-guide/networks/network-dashboards.md
        - Tracking Network Statistics: product-guide/networks/tracking-net-statistics.md
        - Port Mirroring: product-guide/networks/port-mirroring.md
        - Network Diagnostics: product-guide/networks/network-diagnostics.md
      - VPN:
        - Overview: product-guide/vpn/vpn-overview.md
        - IPSec: product-guide/vpn/ipsec.md
        - WireGuard: product-guide/vpn/wireguard-config.md
        - WireGuard Examples: product-guide/vpn/wireguard-examples.md
      - Authoritative DNS: product-guide/networks/authoritative-dns.md
      - Troubleshooting:
        - Network Troubleshooting: product-guide/networks/net-troubleshooting.md
    - Private AI:
      - Overview: product-guide/private-ai/overview.md
      - Configuration: product-guide/private-ai/configuration.md
      - Open AI Router: product-guide/private-ai/open-ai-router.md
      - Chat Sessions: product-guide/private-ai/chat-sessions.md
    - Automation:
      - Scripts: product-guide/automation/scripts.md
      - Webhooks: product-guide/automation/webhooks.md
      - Recipes:
        - Overview: product-guide/automation/recipes-overview.md
        - Organizing Recipes: product-guide/automation/recipes-organization.md
        - VM Recipes: product-guide/automation/vm-recipes.md
        - Tenant Recipes: product-guide/automation/tenant-recipes.md 
        - Marketplace VM Recipes: product-guide/automation/marketplace-vm-recipes.md
      - Task Engine:
        - Overview: product-guide/automation/task-engine.md
        - Create Tasks: product-guide/automation/create-tasks.md
        - Schedules: product-guide/automation/schedules.md
    - GPU & Device Passthrough:
      - Overview: product-guide/system/device-pass-overview.md
      - NVIDIA GPU Virtualization: product-guide/tools-integrations/nvidia-gpu-virtualization.md
      - NVIDIA vGPU Configuration: product-guide/system/nvidia-vgpu-configuration.md
      - SR-IOV NIC: product-guide/system/sriov-nics.md
      - USB Passthrough: product-guide/system/usb-passthrough.md
      - One-to-One PCI Passthrough: product-guide/system/generic-pci-passthrough.md
    - Maintenance & Monitoring:
      - Diagnostics Overview: product-guide/maintenance-monitoring/diagnostics-overview.md
      - Subscriptions/Alerts:
        - Creating Subscriptions: product-guide/system/subscriptions-overview.md
        - Subscription Profiles: product-guide/system/subscription-profiles.md
        - Accessing Subscriptions: product-guide/system/subscriptions-accessing.md
      - System Diagnostics: product-guide/system/diagnostics.md
      - Alarms: product-guide/operations/alarms.md
      - External Monitoring: product-guide/tools-integrations/external-monitoring.md
      - Prometheus Exporter: product-guide/tools-integrations/prometheus-exporter.md
    - Operations:
      - Drive Replacement: product-guide/operations/drive-replacement.md
      - Maintenance Mode: product-guide/operations/maintenance-mode.md
      - Standard Operating Procedures:
        - Overview: product-guide/operations/sop-overview.md
        - Scale Out Nodes: product-guide/operations/sop-scale-out.md
        - System Updates: product-guide/operations/sop-update.md
        - Installation Procedures: product-guide/operations/sop-verge-install.md
        - vSAN Scale Up: product-guide/operations/vsan-scale-up-sop.md
      - Node Replacement: product-guide/operations/node-replacement.md
    - Tools and Integrations:
      - Automation & API:
        - Verge CLI (vrg): product-guide/tools-integrations/vrg-cli.md
        - Terraform Provider: product-guide/tools-integrations/terraform-provider.md
        - PowerShell Module: product-guide/tools-integrations/powershell-module.md
        - TypeScript SDK: product-guide/tools-integrations/typescript-sdk.md
        - Python SDK: product-guide/tools-integrations/python-sdk.md
        - Go SDK: product-guide/tools-integrations/go-sdk.md
      - Monitoring:
        - Prometheus Exporter: product-guide/tools-integrations/prometheus-exporter.md
      - Backup & Migration:
        - Storware Backup and Recovery: product-guide/tools-integrations/storware-backup-recovery.md
        - Cirrus Data Migration: product-guide/tools-integrations/cirrus-data.md
      - Kubernetes & Containers:
        - Kubernetes Integration: product-guide/tools-integrations/kubernetes-integration.md
        - Rancher Integration: product-guide/tools-integrations/rancher-integration.md
      - VDI & Desktop Delivery:
        - Inuvika Virtual Apps and Desktops: product-guide/tools-integrations/inuvika.md
        - Leostream Connection Broker: product-guide/tools-integrations/leostream.md
  - Release Notes:
    - Overview: release-notes/release-notes-overview.md
    - 26.1 (latest): release-notes/26-1-release-notes.md
    - "26.0": release-notes/26-0-release-notes.md
    - 4.13: release-notes/4-13-release-notes.md
    - 4.12: release-notes/4-12-release-notes.md
    - 4.11: release-notes/4-11-release-notes.md
    - "4.10": release-notes/4-10-release-notes.md
    - 4.9: release-notes/4-9-release-notes.md
  - Glossary: glossary.md

#build