diff --git a/public/docs-static/img/agent-network/integrations/agent-network-connect-vllm.png b/public/docs-static/img/agent-network/integrations/agent-network-connect-vllm.png new file mode 100644 index 00000000..4c96221a Binary files /dev/null and b/public/docs-static/img/agent-network/integrations/agent-network-connect-vllm.png differ diff --git a/public/docs-static/img/agent-network/integrations/agent-network-create-policy-vllm.png b/public/docs-static/img/agent-network/integrations/agent-network-create-policy-vllm.png new file mode 100644 index 00000000..97c3e8b6 Binary files /dev/null and b/public/docs-static/img/agent-network/integrations/agent-network-create-policy-vllm.png differ diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 26658ef7..820a88bd 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -1,1308 +1,1310 @@ import { useRouter } from 'next/router' import clsx from 'clsx' import { - ActivePageMarker, - NavLink, - TopLevelNavItem, - VisibleSectionHighlight, + ActivePageMarker, + NavLink, + TopLevelNavItem, + VisibleSectionHighlight, } from '@/components/NavigationAPI' import { AnimatePresence, motion } from 'framer-motion' import { Button } from '@/components/mdx' import { useEffect, useState } from 'react' import { - NavigationStateProvider, - useNavigationState, + NavigationStateProvider, + useNavigationState, } from '@/components/NavigationState' import ChevronDownIcon from '@/components/icons/ChevronDownIcon' import { useIsInsideMobileNavigation } from '@/components/MobileNavigation' export const docsNavigation = [ - { - title: 'ABOUT', - links: [ - { title: 'How NetBird Works', href: '/about-netbird/how-netbird-works' }, - { - title: 'NetBird vs. Traditional VPN', - href: '/about-netbird/netbird-vs-traditional-vpn', - }, - { - title: 'Self-Hosted vs. Cloud', - href: '/about-netbird/self-hosted-vs-cloud', - }, - { - title: 'NAT and Connectivity', - href: '/about-netbird/understanding-nat-and-connectivity', - }, - { - title: 'Ports & Firewalls', - href: '/about-netbird/ports-and-firewalls', - }, - { title: 'FAQ', href: '/about-netbird/faq' }, - /*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' }, - { title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/ - ], - }, - { - title: 'GET STARTED', - links: [ - { title: 'Quickstart Guide', href: '/get-started' }, - { - title: 'Install NetBird', - isOpen: false, - href: '/get-started/install', + { + title: 'ABOUT', links: [ - { title: 'Linux', href: '/get-started/install/linux' }, - { title: 'Windows', href: '/get-started/install/windows' }, - { title: 'MacOS', href: '/get-started/install/macos' }, - { title: 'Docker', href: '/get-started/install/docker' }, - { title: 'iOS', href: '/get-started/install/ios' }, - { title: 'tvOS', href: '/get-started/install/tvos' }, - { title: 'Android', href: '/get-started/install/android' }, - { title: 'Android TV', href: '/get-started/install/android-tv' }, - ], - }, - { - title: 'Platforms', - isOpen: false, - links: [ - { title: 'Proxmox VE', href: '/get-started/install/proxmox-ve' }, - { title: 'Synology', href: '/get-started/install/synology' }, - { title: 'TrueNAS', href: '/get-started/install/truenas' }, - { title: 'pfSense', href: '/get-started/install/pfsense' }, - { title: 'OPNsense', href: '/get-started/install/opnsense' }, - { title: 'OpenWrt', href: '/get-started/install/openwrt' }, - { title: 'MikroTik', href: '/get-started/install/mikrotik' }, - { title: 'Raspberry Pi', href: '/get-started/install/raspberrypi' }, - ], - }, - { title: 'CLI', href: '/get-started/cli' }, - ], - }, - { - title: 'MANAGE NETBIRD', - links: [ - { title: 'Control Center', href: '/manage/control-center' }, - { - title: 'Peers', - isOpen: false, - links: [ - { - title: 'Add Peers', - href: '/manage/peers/add-machines-to-your-network', - }, - { title: 'Approve Peers', href: '/manage/peers/approve-peers' }, - { - title: 'Setup Keys', - href: '/manage/peers/register-machines-using-setup-keys', - }, - { - title: 'Bootstrap via Config File', - href: '/manage/peers/bootstrap-via-config-file', - }, - { - title: 'Browser Client', - isOpen: false, - links: [ - { title: 'Overview', href: '/manage/peers/browser-client' }, - { - title: 'Architecture', - href: '/manage/peers/browser-client/architecture', - }, - ], - }, - { title: 'SSH', href: '/manage/peers/ssh' }, - { title: 'Lazy Connections', href: '/manage/peers/lazy-connection' }, - { title: 'Remote Jobs', href: '/manage/peers/remote-jobs' }, - { - title: 'Access Infrastructure', - isOpen: true, - links: [ - { - title: 'Access Remote Webserver', - href: '/manage/peers/access-infrastructure/secure-remote-webserver-access', - }, - { - title: 'Add Servers to the Network', - href: '/manage/peers/access-infrastructure/setup-keys-add-servers-to-network', - }, - { - title: 'Access from Kubernetes', - href: '/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments', - }, - { - title: 'Peer Approval for Remote Access', - href: '/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access', - }, - ], - }, - { title: 'Auto Update', href: '/manage/peers/auto-update' }, - ], - }, - { - title: 'Access Control', - isOpen: false, - links: [ - { title: 'Groups & Policies', href: '/manage/access-control' }, - { - title: 'Manage Access', - href: '/manage/access-control/manage-network-access', - }, - { - title: 'Posture Checks', - href: '/manage/access-control/posture-checks', - isOpen: false, - links: [ - { - title: 'Disable route when in the office', - href: '/manage/access-control/posture-checks/connecting-from-the-office', - }, - ], - }, - { - title: 'Integrate MDM & EDR', - href: '/manage/access-control/endpoint-detection-and-response', - isOpen: false, - links: [ - { - title: 'CrowdStrike Falcon', - href: '/manage/access-control/endpoint-detection-and-response/crowdstrike-edr', - }, - { - title: 'FleetDM', - href: '/manage/access-control/endpoint-detection-and-response/fleetdm-edr', - }, - { - title: 'Huntress', - href: '/manage/access-control/endpoint-detection-and-response/huntress-edr', - }, - { - title: 'Microsoft Intune', - href: '/manage/access-control/endpoint-detection-and-response/intune-mdm', - }, - { - title: 'SentinelOne Singularity', - href: '/manage/access-control/endpoint-detection-and-response/sentinelone-edr', - }, - { - title: 'Bypass Compliance', - href: '/manage/access-control/endpoint-detection-and-response/bypass-compliance', - }, - ], - }, - ], - }, - { - title: 'Networks', - isOpen: false, - links: [ - { title: 'Overview', href: '/manage/networks' }, - { - title: 'How Routing Peers Work', - href: '/manage/networks/how-routing-peers-work', - }, - { - title: 'Sizing Routing Peers', - href: '/manage/networks/sizing-routing-peers', - }, - { - title: 'Masquerade', - href: '/manage/networks/masquerade', - }, - ], - }, - { - title: 'Routes', - isOpen: false, - links: [ - { title: 'Overview', href: '/manage/network-routes' }, - { - title: 'Site-to-Site (legacy)', - href: '/manage/network-routes/use-cases/site-to-site', - }, - { - title: 'Access Control', - href: '/manage/network-routes/access-control', - }, - { - title: 'Overlapping Routes', - href: '/manage/network-routes/overlapping-routes', - }, - { - title: 'Advanced Configuration', - href: '/manage/network-routes/advanced-configuration', - }, - ], - }, - { - title: 'Reverse Proxy', - isOpen: false, - links: [ - { title: 'Overview', href: '/manage/reverse-proxy' }, - { - title: 'Bring Your Own Proxy', - href: '/manage/reverse-proxy/bring-your-own-proxy', - }, - { - title: 'Custom Domains', - href: '/manage/reverse-proxy/custom-domains', - }, - { - title: 'Authentication', - href: '/manage/reverse-proxy/authentication', - }, - { title: 'Access Logs', href: '/manage/reverse-proxy/access-logs' }, - { - title: 'Service Configuration', - href: '/manage/reverse-proxy/service-configuration', - }, - { - title: 'Expose from CLI', - href: '/manage/reverse-proxy/expose-from-cli', - }, - { - title: 'Troubleshooting', - href: '/manage/reverse-proxy/troubleshooting', - }, - ], - }, - { - title: 'DNS', - isOpen: false, - links: [ - { title: 'Overview', href: '/manage/dns' }, - { - title: 'Internal DNS Servers', - href: '/manage/dns/internal-dns-servers', - }, - { title: 'DNS Settings', href: '/manage/dns/dns-settings' }, - { title: 'Custom Zones', href: '/manage/dns/custom-zones' }, - { - title: 'Extra DNS Labels', - href: '/manage/dns/extra-dns-labels', - }, - { - title: 'DNS Aliases for Routed Networks', - href: '/manage/dns/dns-aliases-for-routed-networks', - }, - { title: 'Troubleshooting', href: '/manage/dns/troubleshooting' }, - ], - }, - { - title: 'Team', - isOpen: false, - links: [ - { - title: 'Add Users to Your Network', - href: '/manage/team/add-users-to-your-network', - }, - { title: 'User Roles', href: '/manage/team/user-roles' }, - { title: 'Approve Users', href: '/manage/team/approve-users' }, - { - title: 'Enable NetBird for Entra ID', - href: '/manage/team/entra-id-app-enablement', - }, - { - title: 'Provision Users & Groups', - href: '/manage/team/idp-sync', - isOpen: false, - links: [ - { - title: 'Microsoft Entra ID (API)', - href: '/manage/team/idp-sync/microsoft-entra-id-sync', - }, - { - title: 'Microsoft Entra ID (SCIM)', - href: '/manage/team/idp-sync/microsoft-entra-id-scim-sync', - }, - { title: 'Okta', href: '/manage/team/idp-sync/okta-sync' }, - { - title: 'Google Workspace', - href: '/manage/team/idp-sync/google-workspace-sync', - }, - { - title: 'JumpCloud', - href: '/manage/team/idp-sync/jumpcloud-sync', - }, - { - title: 'Keycloak', - href: '/manage/team/idp-sync/keycloak-sync', - }, - ], - }, - { - title: 'Auto-Offboard Users', - href: '/manage/team/auto-offboard-users', - isOpen: false, - }, - { - title: 'Single Sign-On', - href: '/manage/team/single-sign-on', - isOpen: false, - // links: [ - // { title: 'Authentik', href: '/manage/team/single-sign-on/authentik' }, - // { title: 'Keycloak', href: '/manage/team/single-sign-on/keycloak' }, - // { title: 'Auth0', href: '/manage/team/single-sign-on/auth0' }, - // { title: 'JumpCloud', href: '/manage/team/single-sign-on/jumpcloud' }, - // ] - }, - ], - }, - { - title: 'Activity', - links: [ - { title: 'Audit Events Logging', href: '/manage/activity' }, - { - title: 'Traffic Events Logging', - href: '/manage/activity/traffic-events-logging', - }, - { - title: 'Stream Activity Events', - href: '/manage/activity/event-streaming', - isOpen: false, - links: [ - { - title: 'Datadog', - href: '/manage/activity/event-streaming/datadog', - }, - { - title: 'Amazon S3', - href: '/manage/activity/event-streaming/amazon-s3', - }, - { - title: 'Amazon Firehose', - href: '/manage/activity/event-streaming/amazon-firehose', - }, - { - title: 'SentinelOne Data Lake', - href: '/manage/activity/event-streaming/sentinelone-data-lake', - }, - { - title: 'Generic HTTP', - href: '/manage/activity/event-streaming/generic-http', - }, - { - title: 'Wazuh', - href: '/manage/activity/event-streaming/wazuh', - }, - ], - }, - ], - }, - { - title: 'Settings', - isOpen: false, - links: [ - { - title: 'Authentication', - href: '/manage/settings/enforce-periodic-user-authentication', - }, - { - title: 'Multi-Factor Authentication', - href: '/manage/settings/multi-factor-authentication', - }, - { title: 'IPv6 Overlay Addressing', href: '/manage/settings/ipv6' }, - { title: 'Auto Update', href: '/manage/peers/auto-update' }, - { title: 'Lazy Connections', href: '/manage/peers/lazy-connection' }, - { - title: 'Client Metrics', - href: '/manage/client-metrics', - }, - { - title: 'Notifications', - href: '/manage/settings/notifications', - }, - { - title: 'Plans and Billing', - href: '/manage/settings/plans-and-billing', - }, - { title: 'Delete Account', href: '/manage/settings/delete-account' }, - ], - }, - { - title: 'Integrations', - isOpen: false, - links: [ - { - title: 'MDM for Deployment', - isOpen: true, - links: [ - { - title: 'macOS CLI-Only .pkg', - href: '/manage/integrations/mdm-deployment/macos-cli-pkg-deployment', - }, - { - title: 'Deploy with Jamf Pro', - href: '/manage/integrations/mdm-deployment/jamf-pro-netbird-integration', - }, - { - title: 'Deploy with Kandji', - href: '/manage/integrations/mdm-deployment/kandji-netbird-integration', - }, - { - title: 'Deploy with Intune', - href: '/manage/integrations/mdm-deployment/intune-netbird-integration', - }, - ], - }, - ], - }, - - { - title: 'Public API', - isOpen: false, - links: [{ title: 'Access Public API', href: '/manage/public-api' }], - }, - { - title: 'For Partners', - isOpen: false, - links: [ - { - title: 'Managed Service Providers', - href: '/manage/for-partners/msp-portal', - }, - { - title: 'Distributors', - href: '/manage/for-partners/distributor-portal', - }, - { - title: 'Acronis NetBird integration', - href: '/manage/for-partners/acronis-integration', - }, - ], - }, - ], - }, - { - title: 'AGENT NETWORK', - links: [ - { - title: 'Getting Started', - href: '/agent-network', - links: [ - { title: 'What is Agent Network?', href: '/agent-network' }, - { title: 'How It Works', href: '/agent-network/how-it-works' }, - { title: 'Quickstart', href: '/agent-network/quickstart' }, - { title: 'Providers', href: '/agent-network/providers' }, - ], - }, - { - title: 'Policies', - href: '/agent-network/policies', - links: [ - { - title: 'Token & Budget Limits', - href: '/agent-network/policies/limits', - }, - { title: 'Guardrails', href: '/agent-network/policies/guardrails' }, - ], - }, - { - title: 'Usage & Logs', - href: '/agent-network/usage-and-logs', - links: [ - { - title: 'Usage Overview', - href: '/agent-network/usage-and-logs/usage-overview', - }, - { - title: 'Access Logs', - href: '/agent-network/usage-and-logs/access-logs', - }, - { - title: 'Log Collection & Retention', - href: '/agent-network/usage-and-logs/log-collection', - }, - { title: 'Global Limits', href: '/agent-network/global-limits' }, - ], - }, - { - title: 'Integrations', - href: '/agent-network/integrations', - links: [ - { - title: 'Claude Code', - href: '/agent-network/integrations/claude-code', - }, - { title: 'Codex', href: '/agent-network/integrations/codex' }, - { title: 'LiteLLM', href: '/agent-network/integrations/litellm' }, - { - title: 'Google Vertex AI', - href: '/agent-network/integrations/vertex-ai', - }, - { title: 'AWS Bedrock', href: '/agent-network/integrations/bedrock' }, - ], - }, - ], - }, - { - title: 'SELF-HOST NETBIRD', - links: [ - { title: 'Quickstart Guide', href: '/selfhosted/selfhosted-quickstart' }, - { title: 'Automated Setup', href: '/selfhosted/automated-setup' }, - { - title: 'Cloud Marketplaces', - isOpen: false, - links: [ - { title: 'Overview', href: '/selfhosted/marketplaces' }, - { title: 'Vultr', href: '/selfhosted/marketplaces/vultr' }, - ], - }, - { - title: 'Maintenance', - isOpen: false, - links: [ - { - title: 'Configuration Files', - href: '/selfhosted/maintenance/configuration-files', - }, - { - title: 'Environment Variables', - href: '/selfhosted/environment-variables', - }, - { - title: 'Scaling Your Deployment', - href: '/selfhosted/maintenance/scaling/scaling-your-self-hosted-deployment', - isOpen: false, - links: [ - { - title: 'Set Up External Relays', - href: '/selfhosted/maintenance/scaling/set-up-external-relays', - }, - { - title: 'Migrate SQLite to PostgreSQL', - href: '/selfhosted/maintenance/scaling/migrate-sqlite-to-postgresql', - }, - { - title: 'Set Up External Signal', - href: '/selfhosted/maintenance/scaling/set-up-external-signal', - }, - { - title: 'Multiple Proxy Instances', - href: '/selfhosted/maintenance/scaling/multiple-proxy-instances', - }, - ], - }, - { title: 'Backup', href: '/selfhosted/maintenance/backup' }, - { title: 'Upgrade', href: '/selfhosted/maintenance/upgrade' }, - { title: 'Remove', href: '/selfhosted/maintenance/remove' }, - { title: 'Reverse Proxy', href: '/selfhosted/reverse-proxy' }, - { - title: 'Management SQLite Store', - href: '/selfhosted/maintenance/sqlite-store', - }, - { - title: 'Management Postgres Store', - href: '/selfhosted/maintenance/postgres-store', - }, - { - title: 'Activity Events Postgres Store', - href: '/selfhosted/maintenance/activity-postgres-store', - }, - { - title: 'Geolocation Database', - href: '/selfhosted/maintenance/geo-support', - }, - { - title: 'CrowdSec IP Reputation', - href: '/selfhosted/maintenance/crowdsec', - }, - ], - }, - { - title: 'Observability', - isOpen: false, - links: [ - { title: 'Overview', href: '/selfhosted/observability' }, - { title: 'Management', href: '/selfhosted/observability/management' }, - { title: 'Signal', href: '/selfhosted/observability/signal' }, - { title: 'Relay', href: '/selfhosted/observability/relay' }, - { title: 'Proxy', href: '/selfhosted/observability/proxy' }, - { title: 'Combined', href: '/selfhosted/observability/combined' }, - { title: 'Dashboards', href: '/selfhosted/observability/dashboards' }, - ], - }, - { - title: 'Authentication', - isOpen: false, - links: [ - { - title: 'Authentication and IdPs', - href: '/selfhosted/identity-providers', - }, - { - title: 'Local Users', - isOpen: false, - links: [ - { - title: 'Local User Management', - href: '/selfhosted/identity-providers/local', - }, - { - title: 'Disable Local Auth', - href: '/selfhosted/identity-providers/disable-local-authentication', - }, - { - title: 'Enable MFA for local users', - href: '/selfhosted/identity-providers/enable-local-mfa', - }, - ], - }, - { - title: 'Identity Provider Connectors', - isOpen: false, - links: [ - { - title: 'Self-hosted IdPs', - isOpen: true, - links: [ - { - title: 'Generic OIDC', - href: '/selfhosted/identity-providers/generic-oidc', - }, - { - title: 'Zitadel', - href: '/selfhosted/identity-providers/zitadel', - }, - { - title: 'Authentik', - href: '/selfhosted/identity-providers/authentik', - }, - { - title: 'Keycloak', - href: '/selfhosted/identity-providers/keycloak', - }, - { - title: 'PocketID', - href: '/selfhosted/identity-providers/pocketid', - }, - { - title: 'AD FS', - href: '/selfhosted/identity-providers/adfs', - }, - ], - }, - { - title: 'Managed IdPs', - isOpen: true, - links: [ - { - title: 'Google Workspace', - href: '/selfhosted/identity-providers/managed/google-workspace', - }, - { - title: 'Microsoft Entra ID', - href: '/selfhosted/identity-providers/managed/microsoft-entra-id', - }, - { - title: 'JumpCloud', - href: '/selfhosted/identity-providers/managed/jumpcloud', - }, - { - title: 'Auth0', - href: '/selfhosted/identity-providers/managed/auth0', - }, - { - title: 'Duo', - href: '/selfhosted/identity-providers/managed/duo', - }, - { - title: 'Okta', - href: '/selfhosted/identity-providers/managed/okta', - }, - ], - }, - ], - }, - { - title: 'Provision Users & Groups', - isOpen: false, - links: [ - { - title: 'Microsoft Entra ID (API)', - href: '/manage/team/idp-sync/embedded/microsoft-entra-id-sync', - }, - { - title: 'Microsoft Entra ID (SCIM)', - href: '/manage/team/idp-sync/embedded/microsoft-entra-id-scim-sync', - }, - { - title: 'Google Workspace', - href: '/manage/team/idp-sync/embedded/google-workspace-sync', - }, - { - title: 'JumpCloud', - href: '/manage/team/idp-sync/embedded/jumpcloud-sync', - }, - { - title: 'Keycloak', - href: '/manage/team/idp-sync/embedded/keycloak-sync', - }, - ], - }, - ], - }, - { title: 'Advanced Guide', href: '/selfhosted/selfhosted-guide' }, - { - title: 'Troubleshooting', - isOpen: false, - links: [ - { title: 'Overview', href: '/selfhosted/troubleshooting' }, - { - title: 'Installation', - href: '/selfhosted/troubleshooting/installation', - }, - { - title: 'Embedded IdP', - href: '/selfhosted/troubleshooting/identity-provider', - }, - { title: 'Dashboard', href: '/selfhosted/troubleshooting/dashboard' }, - { - title: 'Certificates', - href: '/selfhosted/troubleshooting/certificates', - }, - { - title: 'Connectivity', - href: '/selfhosted/troubleshooting/connectivity', - }, - { title: 'Database', href: '/selfhosted/troubleshooting/database' }, - ], - }, - { - title: 'Migration Guides', - isOpen: false, - links: [ - { - title: 'Coturn to Embedded STUN', - href: '/selfhosted/migration/coturn-to-stun-migration', - }, - { - title: 'Combined Container Setup', - href: '/selfhosted/migration/combined-container', - }, - { - title: 'Enable Reverse Proxy', - href: '/selfhosted/migration/enable-reverse-proxy', - }, - { - title: 'External IdP to Embedded IdP', - href: '/selfhosted/migration/external-to-embedded-idp', - }, - ], - }, - ], - }, - { - title: 'CLIENT', - links: [ - { title: 'Desktop App', href: '/client/desktop-app' }, - { title: 'Profiles', href: '/client/profiles' }, - { title: 'Environment Variables', href: '/client/environment-variables' }, - { title: 'MDM Integration', href: '/client/mdm-integration' }, - { - title: 'Settings', - isOpen: false, - links: [ - { - title: 'Block Inbound Connections', - href: '/client/block-inbound-connections', - }, - { - title: 'Connect on Startup', - href: '/client/connect-on-startup', - }, - { - title: 'Enable Quantum-Resistance', - href: '/client/post-quantum-cryptography', - }, - { - title: 'Allow SSH', - href: '/client/allow-ssh', - }, - { - title: 'Enable Lazy Connections', - href: '/client/enable-lazy-connections', - }, - ], - }, - ], - }, - { - title: 'USE CASES', - links: [ - { title: 'Overview', href: '/use-cases' }, - { - title: 'Remote Access', - isOpen: false, - links: [ - { title: 'Overview', href: '/use-cases/remote-access' }, - { - title: 'Access Home Devices', - href: '/use-cases/remote-access/access-home-devices', - }, - { - title: 'Active Directory & Windows File Shares', - href: '/use-cases/remote-access/active-directory', - }, - { - title: 'Cloud to On-Premise', - href: '/use-cases/remote-access/cloud-to-on-premise', - }, - { - title: 'Exit Nodes', - href: '/use-cases/remote-access/exit-nodes', - }, - { - title: 'Overlapping IPs for Resources', - href: '/use-cases/remote-access/overlapping-ips-for-resources', - }, - { - title: 'Reach Services on the Routing Peer', - href: '/use-cases/remote-access/reach-services-on-the-routing-peer', - }, - { - title: 'Site-to-Site', - href: '/use-cases/remote-access/site-to-site', - }, - { - title: 'Site-to-VPN', - href: '/use-cases/remote-access/site-to-vpn', - }, - ], - }, - { - title: 'Cloud', - isOpen: false, - links: [ - { title: 'Overview', href: '/use-cases/cloud' }, - { - title: 'AWS ECS', - href: '/use-cases/cloud/aws-ecs-terraform', - }, - { - title: 'Serverless (FaaS)', - href: '/use-cases/cloud/netbird-on-faas', - }, - { - title: 'Distributed Multi-Cloud AI', - href: '/use-cases/cloud/distributed-multi-cloud-ai', - }, - ], - }, - { - title: 'Kubernetes', - isOpen: false, - links: [ - { title: 'Getting Started', href: '/use-cases/kubernetes' }, - { - title: 'Routing Peer', - href: '/use-cases/kubernetes/routing-peer', - }, - { - title: 'Client Sidecar', - href: '/use-cases/kubernetes/client-sidecar', - }, - { - title: 'API Server Proxy', - href: '/use-cases/kubernetes/api-server-proxy', - }, - { - title: 'Gateway API', - href: '/use-cases/kubernetes/gateway-api', - }, - { - title: 'Route to a Kubernetes Service', - href: '/use-cases/kubernetes/route-to-a-kubernetes-service', - }, - { - title: 'Deploy Routing Peers to a Cluster', - href: '/use-cases/kubernetes/routing-peers-and-kubernetes', - }, - ], - }, - { - title: 'Security', - isOpen: false, - links: [ - { title: 'Overview', href: '/use-cases/security' }, - { - title: 'Implement Zero Trust', - href: '/use-cases/security/implement-zero-trust', - }, - { - title: 'Private Proxy Without Inbound Ports', - href: '/use-cases/security/private-no-inbound', - }, - ], - }, - { title: 'Homelab', href: '/use-cases/homelab' }, - ], - }, - { - title: 'GET MORE HELP', - links: [ - { - title: 'Troubleshooting', - isOpen: false, - links: [ - { title: 'Overview', href: '/help/troubleshooting' }, - { - title: 'NetBird Client', - isOpen: false, - links: [ - { title: 'Overview', href: '/help/troubleshooting-client' }, - { title: 'Linux', href: '/help/troubleshooting-client/linux' }, - { - title: 'Windows', - href: '/help/troubleshooting-client/windows', - }, - { title: 'macOS', href: '/help/troubleshooting-client/macos' }, - { - title: 'Android', - href: '/help/troubleshooting-client/android', - }, - { title: 'iOS', href: '/help/troubleshooting-client/ios' }, - ], - }, - { - title: 'Self-hosted', - isOpen: false, - links: [ - { title: 'Overview', href: '/selfhosted/troubleshooting' }, - { - title: 'Installation', - href: '/selfhosted/troubleshooting/installation', - }, - { - title: 'Embedded IdP', - href: '/selfhosted/troubleshooting/identity-provider', - }, - { - title: 'Dashboard', - href: '/selfhosted/troubleshooting/dashboard', - }, - { - title: 'Certificates', - href: '/selfhosted/troubleshooting/certificates', - }, - { - title: 'Connectivity', - href: '/selfhosted/troubleshooting/connectivity', - }, - { - title: 'Database', - href: '/selfhosted/troubleshooting/database', - }, - ], - }, - { - title: 'Cloud & identity', - isOpen: false, - links: [ - { - title: 'Pending approval', - href: '/help/troubleshooting-account-access', - }, - { title: 'IdP & SSO setup', href: '/manage/team/single-sign-on' }, - { title: 'User provisioning', href: '/manage/team/idp-sync' }, - { - title: 'Plan limits & quotas', - href: '/manage/settings/plans-and-billing', - }, - ], - }, - { - title: 'Connectivity', - isOpen: false, - links: [ - { - title: 'Relayed Connections', - href: '/help/troubleshooting-relayed-connections', - }, - { - title: 'Resource Connectivity', - href: '/help/troubleshooting-resource-connectivity', - }, - { - title: 'NAT & Connectivity', + { title: 'How NetBird Works', href: '/about-netbird/how-netbird-works' }, + { + title: 'NetBird vs. Traditional VPN', + href: '/about-netbird/netbird-vs-traditional-vpn', + }, + { + title: 'Self-Hosted vs. Cloud', + href: '/about-netbird/self-hosted-vs-cloud', + }, + { + title: 'NAT and Connectivity', href: '/about-netbird/understanding-nat-and-connectivity', - }, - { + }, + { title: 'Ports & Firewalls', href: '/about-netbird/ports-and-firewalls', - }, - ], - }, - { - title: 'Access control', - isOpen: false, - links: [ - { title: 'Policies', href: '/manage/access-control' }, - { - title: 'Posture checks', - href: '/manage/access-control/posture-checks', - }, - { - title: 'Groups', - href: '/manage/access-control#understanding-groups', - }, - ], - }, - { - title: 'Report a bug', - isOpen: false, - links: [ - { title: 'Overview', href: '/help/report-bug-issues' }, - { title: 'Community Support', href: '/help/community-support' }, - { title: 'NetBird Support', href: '/help/netbird-support' }, - ], - }, + }, + { title: 'FAQ', href: '/about-netbird/faq' }, + /*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' }, + { title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/ ], - }, - { - title: 'Support Matrix', - isOpen: false, + }, + { + title: 'GET STARTED', links: [ - { title: 'Overview', href: '/help/support-matrix' }, - { - title: 'NetBird Client', - href: '/help/support-matrix/netbird-client', - isOpen: false, - links: [ - { - title: 'Linux', - href: '/help/support-matrix/netbird-client/linux', - }, - { - title: 'Windows', - href: '/help/support-matrix/netbird-client/windows', - }, - { - title: 'macOS', - href: '/help/support-matrix/netbird-client/macos', - }, - { - title: 'iOS', - href: '/help/support-matrix/netbird-client/ios', - }, - { - title: 'Android', - href: '/help/support-matrix/netbird-client/android', - }, - { - title: 'Android TV', - href: '/help/support-matrix/netbird-client/android-tv', - }, - { - title: 'tvOS', - href: '/help/support-matrix/netbird-client/tvos', - }, - ], - }, - { - title: 'Kubernetes Operator', - href: '/help/support-matrix/kubernetes-operator', - }, - { - title: 'Terraform Provider', - href: '/help/support-matrix/terraform-provider', - }, - { - title: 'Self-Hosted', - href: '/help/support-matrix/self-hosted', - }, + { title: 'Quickstart Guide', href: '/get-started' }, + { + title: 'Install NetBird', + isOpen: false, + href: '/get-started/install', + links: [ + { title: 'Linux', href: '/get-started/install/linux' }, + { title: 'Windows', href: '/get-started/install/windows' }, + { title: 'MacOS', href: '/get-started/install/macos' }, + { title: 'Docker', href: '/get-started/install/docker' }, + { title: 'iOS', href: '/get-started/install/ios' }, + { title: 'tvOS', href: '/get-started/install/tvos' }, + { title: 'Android', href: '/get-started/install/android' }, + { title: 'Android TV', href: '/get-started/install/android-tv' }, + ], + }, + { + title: 'Platforms', + isOpen: false, + links: [ + { title: 'Proxmox VE', href: '/get-started/install/proxmox-ve' }, + { title: 'Synology', href: '/get-started/install/synology' }, + { title: 'TrueNAS', href: '/get-started/install/truenas' }, + { title: 'pfSense', href: '/get-started/install/pfsense' }, + { title: 'OPNsense', href: '/get-started/install/opnsense' }, + { title: 'OpenWrt', href: '/get-started/install/openwrt' }, + { title: 'MikroTik', href: '/get-started/install/mikrotik' }, + { title: 'Raspberry Pi', href: '/get-started/install/raspberrypi' }, + ], + }, + { title: 'CLI', href: '/get-started/cli' }, ], - }, - ], - }, + }, + { + title: 'MANAGE NETBIRD', + links: [ + { title: 'Control Center', href: '/manage/control-center' }, + { + title: 'Peers', + isOpen: false, + links: [ + { + title: 'Add Peers', + href: '/manage/peers/add-machines-to-your-network', + }, + { title: 'Approve Peers', href: '/manage/peers/approve-peers' }, + { + title: 'Setup Keys', + href: '/manage/peers/register-machines-using-setup-keys', + }, + { + title: 'Bootstrap via Config File', + href: '/manage/peers/bootstrap-via-config-file', + }, + { + title: 'Browser Client', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/peers/browser-client' }, + { + title: 'Architecture', + href: '/manage/peers/browser-client/architecture', + }, + ], + }, + { title: 'SSH', href: '/manage/peers/ssh' }, + { title: 'Lazy Connections', href: '/manage/peers/lazy-connection' }, + { title: 'Remote Jobs', href: '/manage/peers/remote-jobs' }, + { + title: 'Access Infrastructure', + isOpen: true, + links: [ + { + title: 'Access Remote Webserver', + href: '/manage/peers/access-infrastructure/secure-remote-webserver-access', + }, + { + title: 'Add Servers to the Network', + href: '/manage/peers/access-infrastructure/setup-keys-add-servers-to-network', + }, + { + title: 'Access from Kubernetes', + href: '/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments', + }, + { + title: 'Peer Approval for Remote Access', + href: '/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access', + }, + ], + }, + { title: 'Auto Update', href: '/manage/peers/auto-update' }, + ], + }, + { + title: 'Access Control', + isOpen: false, + links: [ + { title: 'Groups & Policies', href: '/manage/access-control' }, + { + title: 'Manage Access', + href: '/manage/access-control/manage-network-access', + }, + { + title: 'Posture Checks', + href: '/manage/access-control/posture-checks', + isOpen: false, + links: [ + { + title: 'Disable route when in the office', + href: '/manage/access-control/posture-checks/connecting-from-the-office', + }, + ], + }, + { + title: 'Integrate MDM & EDR', + href: '/manage/access-control/endpoint-detection-and-response', + isOpen: false, + links: [ + { + title: 'CrowdStrike Falcon', + href: '/manage/access-control/endpoint-detection-and-response/crowdstrike-edr', + }, + { + title: 'FleetDM', + href: '/manage/access-control/endpoint-detection-and-response/fleetdm-edr', + }, + { + title: 'Huntress', + href: '/manage/access-control/endpoint-detection-and-response/huntress-edr', + }, + { + title: 'Microsoft Intune', + href: '/manage/access-control/endpoint-detection-and-response/intune-mdm', + }, + { + title: 'SentinelOne Singularity', + href: '/manage/access-control/endpoint-detection-and-response/sentinelone-edr', + }, + { + title: 'Bypass Compliance', + href: '/manage/access-control/endpoint-detection-and-response/bypass-compliance', + }, + ], + }, + ], + }, + { + title: 'Networks', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/networks' }, + { + title: 'How Routing Peers Work', + href: '/manage/networks/how-routing-peers-work', + }, + { + href: '/manage/networks/sizing-routing-peers', + name: 'Sizing Routing Peers', + description: 'Choose the size and number of routing peers from measured throughput', + }, + { + title: 'Masquerade', + href: '/manage/networks/masquerade', + }, + ], + }, + { + title: 'Routes', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/network-routes' }, + { + title: 'Site-to-Site (legacy)', + href: '/manage/network-routes/use-cases/site-to-site', + }, + { + title: 'Access Control', + href: '/manage/network-routes/access-control', + }, + { + title: 'Overlapping Routes', + href: '/manage/network-routes/overlapping-routes', + }, + { + title: 'Advanced Configuration', + href: '/manage/network-routes/advanced-configuration', + }, + ], + }, + { + title: 'Reverse Proxy', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/reverse-proxy' }, + { + title: 'Bring Your Own Proxy', + href: '/manage/reverse-proxy/bring-your-own-proxy', + }, + { + title: 'Custom Domains', + href: '/manage/reverse-proxy/custom-domains', + }, + { + title: 'Authentication', + href: '/manage/reverse-proxy/authentication', + }, + { title: 'Access Logs', href: '/manage/reverse-proxy/access-logs' }, + { + title: 'Service Configuration', + href: '/manage/reverse-proxy/service-configuration', + }, + { + title: 'Expose from CLI', + href: '/manage/reverse-proxy/expose-from-cli', + }, + { + title: 'Troubleshooting', + href: '/manage/reverse-proxy/troubleshooting', + }, + ], + }, + { + title: 'DNS', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/dns' }, + { + title: 'Internal DNS Servers', + href: '/manage/dns/internal-dns-servers', + }, + { title: 'DNS Settings', href: '/manage/dns/dns-settings' }, + { title: 'Custom Zones', href: '/manage/dns/custom-zones' }, + { + title: 'Extra DNS Labels', + href: '/manage/dns/extra-dns-labels', + }, + { + title: 'DNS Aliases for Routed Networks', + href: '/manage/dns/dns-aliases-for-routed-networks', + }, + { title: 'Troubleshooting', href: '/manage/dns/troubleshooting' }, + ], + }, + { + title: 'Team', + isOpen: false, + links: [ + { + title: 'Add Users to Your Network', + href: '/manage/team/add-users-to-your-network', + }, + { title: 'User Roles', href: '/manage/team/user-roles' }, + { title: 'Approve Users', href: '/manage/team/approve-users' }, + { + title: 'Enable NetBird for Entra ID', + href: '/manage/team/entra-id-app-enablement', + }, + { + title: 'Provision Users & Groups', + href: '/manage/team/idp-sync', + isOpen: false, + links: [ + { + title: 'Microsoft Entra ID (API)', + href: '/manage/team/idp-sync/microsoft-entra-id-sync', + }, + { + title: 'Microsoft Entra ID (SCIM)', + href: '/manage/team/idp-sync/microsoft-entra-id-scim-sync', + }, + { title: 'Okta', href: '/manage/team/idp-sync/okta-sync' }, + { + title: 'Google Workspace', + href: '/manage/team/idp-sync/google-workspace-sync', + }, + { + title: 'JumpCloud', + href: '/manage/team/idp-sync/jumpcloud-sync', + }, + { + title: 'Keycloak', + href: '/manage/team/idp-sync/keycloak-sync', + }, + ], + }, + { + title: 'Auto-Offboard Users', + href: '/manage/team/auto-offboard-users', + isOpen: false, + }, + { + title: 'Single Sign-On', + href: '/manage/team/single-sign-on', + isOpen: false, + // links: [ + // { title: 'Authentik', href: '/manage/team/single-sign-on/authentik' }, + // { title: 'Keycloak', href: '/manage/team/single-sign-on/keycloak' }, + // { title: 'Auth0', href: '/manage/team/single-sign-on/auth0' }, + // { title: 'JumpCloud', href: '/manage/team/single-sign-on/jumpcloud' }, + // ] + }, + ], + }, + { + title: 'Activity', + links: [ + { title: 'Audit Events Logging', href: '/manage/activity' }, + { + title: 'Traffic Events Logging', + href: '/manage/activity/traffic-events-logging', + }, + { + title: 'Stream Activity Events', + href: '/manage/activity/event-streaming', + isOpen: false, + links: [ + { + title: 'Datadog', + href: '/manage/activity/event-streaming/datadog', + }, + { + title: 'Amazon S3', + href: '/manage/activity/event-streaming/amazon-s3', + }, + { + title: 'Amazon Firehose', + href: '/manage/activity/event-streaming/amazon-firehose', + }, + { + title: 'SentinelOne Data Lake', + href: '/manage/activity/event-streaming/sentinelone-data-lake', + }, + { + title: 'Generic HTTP', + href: '/manage/activity/event-streaming/generic-http', + }, + { + title: 'Wazuh', + href: '/manage/activity/event-streaming/wazuh', + }, + ], + }, + ], + }, + { + title: 'Settings', + isOpen: false, + links: [ + { + title: 'Authentication', + href: '/manage/settings/enforce-periodic-user-authentication', + }, + { + title: 'Multi-Factor Authentication', + href: '/manage/settings/multi-factor-authentication', + }, + { title: 'IPv6 Overlay Addressing', href: '/manage/settings/ipv6' }, + { title: 'Auto Update', href: '/manage/peers/auto-update' }, + { title: 'Lazy Connections', href: '/manage/peers/lazy-connection' }, + { + title: 'Client Metrics', + href: '/manage/client-metrics', + }, + { + title: 'Notifications', + href: '/manage/settings/notifications', + }, + { + title: 'Plans and Billing', + href: '/manage/settings/plans-and-billing', + }, + { title: 'Delete Account', href: '/manage/settings/delete-account' }, + ], + }, + { + title: 'Integrations', + isOpen: false, + links: [ + { + title: 'MDM for Deployment', + isOpen: true, + links: [ + { + title: 'macOS CLI-Only .pkg', + href: '/manage/integrations/mdm-deployment/macos-cli-pkg-deployment', + }, + { + title: 'Deploy with Jamf Pro', + href: '/manage/integrations/mdm-deployment/jamf-pro-netbird-integration', + }, + { + title: 'Deploy with Kandji', + href: '/manage/integrations/mdm-deployment/kandji-netbird-integration', + }, + { + title: 'Deploy with Intune', + href: '/manage/integrations/mdm-deployment/intune-netbird-integration', + }, + ], + }, + ], + }, + + { + title: 'Public API', + isOpen: false, + links: [{ title: 'Access Public API', href: '/manage/public-api' }], + }, + { + title: 'For Partners', + isOpen: false, + links: [ + { + title: 'Managed Service Providers', + href: '/manage/for-partners/msp-portal', + }, + { + title: 'Distributors', + href: '/manage/for-partners/distributor-portal', + }, + { + title: 'Acronis NetBird integration', + href: '/manage/for-partners/acronis-integration', + }, + ], + }, + ], + }, + { + title: 'AGENT NETWORK', + links: [ + { + title: 'Getting Started', + href: '/agent-network', + links: [ + { title: 'What is Agent Network?', href: '/agent-network' }, + { title: 'How It Works', href: '/agent-network/how-it-works' }, + { title: 'Quickstart', href: '/agent-network/quickstart' }, + { title: 'Providers', href: '/agent-network/providers' }, + ], + }, + { + title: 'Policies', + href: '/agent-network/policies', + links: [ + { + title: 'Token & Budget Limits', + href: '/agent-network/policies/limits', + }, + { title: 'Guardrails', href: '/agent-network/policies/guardrails' }, + ], + }, + { + title: 'Usage & Logs', + href: '/agent-network/usage-and-logs', + links: [ + { + title: 'Usage Overview', + href: '/agent-network/usage-and-logs/usage-overview', + }, + { + title: 'Access Logs', + href: '/agent-network/usage-and-logs/access-logs', + }, + { + title: 'Log Collection & Retention', + href: '/agent-network/usage-and-logs/log-collection', + }, + { title: 'Global Limits', href: '/agent-network/global-limits' }, + ], + }, + { + title: 'Integrations', + href: '/agent-network/integrations', + links: [ + { + title: 'Claude Code', + href: '/agent-network/integrations/claude-code', + }, + { title: 'Codex', href: '/agent-network/integrations/codex' }, + { title: 'LiteLLM', href: '/agent-network/integrations/litellm' }, + { title: 'vLLM', href: '/agent-network/integrations/vllm' }, + { + title: 'Google Vertex AI', + href: '/agent-network/integrations/vertex-ai', + }, + { title: 'AWS Bedrock', href: '/agent-network/integrations/bedrock' }, + ], + }, + ], + }, + { + title: 'SELF-HOST NETBIRD', + links: [ + { title: 'Quickstart Guide', href: '/selfhosted/selfhosted-quickstart' }, + { title: 'Automated Setup', href: '/selfhosted/automated-setup' }, + { + title: 'Cloud Marketplaces', + isOpen: false, + links: [ + { title: 'Overview', href: '/selfhosted/marketplaces' }, + { title: 'Vultr', href: '/selfhosted/marketplaces/vultr' }, + ], + }, + { + title: 'Maintenance', + isOpen: false, + links: [ + { + title: 'Configuration Files', + href: '/selfhosted/maintenance/configuration-files', + }, + { + title: 'Environment Variables', + href: '/selfhosted/environment-variables', + }, + { + title: 'Scaling Your Deployment', + href: '/selfhosted/maintenance/scaling/scaling-your-self-hosted-deployment', + isOpen: false, + links: [ + { + title: 'Set Up External Relays', + href: '/selfhosted/maintenance/scaling/set-up-external-relays', + }, + { + title: 'Migrate SQLite to PostgreSQL', + href: '/selfhosted/maintenance/scaling/migrate-sqlite-to-postgresql', + }, + { + title: 'Set Up External Signal', + href: '/selfhosted/maintenance/scaling/set-up-external-signal', + }, + { + title: 'Multiple Proxy Instances', + href: '/selfhosted/maintenance/scaling/multiple-proxy-instances', + }, + ], + }, + { title: 'Backup', href: '/selfhosted/maintenance/backup' }, + { title: 'Upgrade', href: '/selfhosted/maintenance/upgrade' }, + { title: 'Remove', href: '/selfhosted/maintenance/remove' }, + { title: 'Reverse Proxy', href: '/selfhosted/reverse-proxy' }, + { + title: 'Management SQLite Store', + href: '/selfhosted/maintenance/sqlite-store', + }, + { + title: 'Management Postgres Store', + href: '/selfhosted/maintenance/postgres-store', + }, + { + title: 'Activity Events Postgres Store', + href: '/selfhosted/maintenance/activity-postgres-store', + }, + { + title: 'Geolocation Database', + href: '/selfhosted/maintenance/geo-support', + }, + { + title: 'CrowdSec IP Reputation', + href: '/selfhosted/maintenance/crowdsec', + }, + ], + }, + { + title: 'Observability', + isOpen: false, + links: [ + { title: 'Overview', href: '/selfhosted/observability' }, + { title: 'Management', href: '/selfhosted/observability/management' }, + { title: 'Signal', href: '/selfhosted/observability/signal' }, + { title: 'Relay', href: '/selfhosted/observability/relay' }, + { title: 'Proxy', href: '/selfhosted/observability/proxy' }, + { title: 'Combined', href: '/selfhosted/observability/combined' }, + { title: 'Dashboards', href: '/selfhosted/observability/dashboards' }, + ], + }, + { + title: 'Authentication', + isOpen: false, + links: [ + { + title: 'Authentication and IdPs', + href: '/selfhosted/identity-providers', + }, + { + title: 'Local Users', + isOpen: false, + links: [ + { + title: 'Local User Management', + href: '/selfhosted/identity-providers/local', + }, + { + title: 'Disable Local Auth', + href: '/selfhosted/identity-providers/disable-local-authentication', + }, + { + title: 'Enable MFA for local users', + href: '/selfhosted/identity-providers/enable-local-mfa', + }, + ], + }, + { + title: 'Identity Provider Connectors', + isOpen: false, + links: [ + { + title: 'Self-hosted IdPs', + isOpen: true, + links: [ + { + title: 'Generic OIDC', + href: '/selfhosted/identity-providers/generic-oidc', + }, + { + title: 'Zitadel', + href: '/selfhosted/identity-providers/zitadel', + }, + { + title: 'Authentik', + href: '/selfhosted/identity-providers/authentik', + }, + { + title: 'Keycloak', + href: '/selfhosted/identity-providers/keycloak', + }, + { + title: 'PocketID', + href: '/selfhosted/identity-providers/pocketid', + }, + { + title: 'AD FS', + href: '/selfhosted/identity-providers/adfs', + }, + ], + }, + { + title: 'Managed IdPs', + isOpen: true, + links: [ + { + title: 'Google Workspace', + href: '/selfhosted/identity-providers/managed/google-workspace', + }, + { + title: 'Microsoft Entra ID', + href: '/selfhosted/identity-providers/managed/microsoft-entra-id', + }, + { + title: 'JumpCloud', + href: '/selfhosted/identity-providers/managed/jumpcloud', + }, + { + title: 'Auth0', + href: '/selfhosted/identity-providers/managed/auth0', + }, + { + title: 'Duo', + href: '/selfhosted/identity-providers/managed/duo', + }, + { + title: 'Okta', + href: '/selfhosted/identity-providers/managed/okta', + }, + ], + }, + ], + }, + { + title: 'Provision Users & Groups', + isOpen: false, + links: [ + { + title: 'Microsoft Entra ID (API)', + href: '/manage/team/idp-sync/embedded/microsoft-entra-id-sync', + }, + { + title: 'Microsoft Entra ID (SCIM)', + href: '/manage/team/idp-sync/embedded/microsoft-entra-id-scim-sync', + }, + { + title: 'Google Workspace', + href: '/manage/team/idp-sync/embedded/google-workspace-sync', + }, + { + title: 'JumpCloud', + href: '/manage/team/idp-sync/embedded/jumpcloud-sync', + }, + { + title: 'Keycloak', + href: '/manage/team/idp-sync/embedded/keycloak-sync', + }, + ], + }, + ], + }, + { title: 'Advanced Guide', href: '/selfhosted/selfhosted-guide' }, + { + title: 'Troubleshooting', + isOpen: false, + links: [ + { title: 'Overview', href: '/selfhosted/troubleshooting' }, + { + title: 'Installation', + href: '/selfhosted/troubleshooting/installation', + }, + { + title: 'Embedded IdP', + href: '/selfhosted/troubleshooting/identity-provider', + }, + { title: 'Dashboard', href: '/selfhosted/troubleshooting/dashboard' }, + { + title: 'Certificates', + href: '/selfhosted/troubleshooting/certificates', + }, + { + title: 'Connectivity', + href: '/selfhosted/troubleshooting/connectivity', + }, + { title: 'Database', href: '/selfhosted/troubleshooting/database' }, + ], + }, + { + title: 'Migration Guides', + isOpen: false, + links: [ + { + title: 'Coturn to Embedded STUN', + href: '/selfhosted/migration/coturn-to-stun-migration', + }, + { + title: 'Combined Container Setup', + href: '/selfhosted/migration/combined-container', + }, + { + title: 'Enable Reverse Proxy', + href: '/selfhosted/migration/enable-reverse-proxy', + }, + { + title: 'External IdP to Embedded IdP', + href: '/selfhosted/migration/external-to-embedded-idp', + }, + ], + }, + ], + }, + { + title: 'CLIENT', + links: [ + { title: 'Desktop App', href: '/client/desktop-app' }, + { title: 'Profiles', href: '/client/profiles' }, + { title: 'Environment Variables', href: '/client/environment-variables' }, + { title: 'MDM Integration', href: '/client/mdm-integration' }, + { + title: 'Settings', + isOpen: false, + links: [ + { + title: 'Block Inbound Connections', + href: '/client/block-inbound-connections', + }, + { + title: 'Connect on Startup', + href: '/client/connect-on-startup', + }, + { + title: 'Enable Quantum-Resistance', + href: '/client/post-quantum-cryptography', + }, + { + title: 'Allow SSH', + href: '/client/allow-ssh', + }, + { + title: 'Enable Lazy Connections', + href: '/client/enable-lazy-connections', + }, + ], + }, + ], + }, + { + title: 'USE CASES', + links: [ + { title: 'Overview', href: '/use-cases' }, + { + title: 'Remote Access', + isOpen: false, + links: [ + { title: 'Overview', href: '/use-cases/remote-access' }, + { + title: 'Access Home Devices', + href: '/use-cases/remote-access/access-home-devices', + }, + { + title: 'Active Directory & Windows File Shares', + href: '/use-cases/remote-access/active-directory', + }, + { + title: 'Cloud to On-Premise', + href: '/use-cases/remote-access/cloud-to-on-premise', + }, + { + title: 'Exit Nodes', + href: '/use-cases/remote-access/exit-nodes', + }, + { + title: 'Overlapping IPs for Resources', + href: '/use-cases/remote-access/overlapping-ips-for-resources', + }, + { + title: 'Reach Services on the Routing Peer', + href: '/use-cases/remote-access/reach-services-on-the-routing-peer', + }, + { + title: 'Site-to-Site', + href: '/use-cases/remote-access/site-to-site', + }, + { + title: 'Site-to-VPN', + href: '/use-cases/remote-access/site-to-vpn', + }, + ], + }, + { + title: 'Cloud', + isOpen: false, + links: [ + { title: 'Overview', href: '/use-cases/cloud' }, + { + title: 'AWS ECS', + href: '/use-cases/cloud/aws-ecs-terraform', + }, + { + title: 'Serverless (FaaS)', + href: '/use-cases/cloud/netbird-on-faas', + }, + { + title: 'Distributed Multi-Cloud AI', + href: '/use-cases/cloud/distributed-multi-cloud-ai', + }, + ], + }, + { + title: 'Kubernetes', + isOpen: false, + links: [ + { title: 'Getting Started', href: '/use-cases/kubernetes' }, + { + title: 'Routing Peer', + href: '/use-cases/kubernetes/routing-peer', + }, + { + title: 'Client Sidecar', + href: '/use-cases/kubernetes/client-sidecar', + }, + { + title: 'API Server Proxy', + href: '/use-cases/kubernetes/api-server-proxy', + }, + { + title: 'Gateway API', + href: '/use-cases/kubernetes/gateway-api', + }, + { + title: 'Route to a Kubernetes Service', + href: '/use-cases/kubernetes/route-to-a-kubernetes-service', + }, + { + title: 'Deploy Routing Peers to a Cluster', + href: '/use-cases/kubernetes/routing-peers-and-kubernetes', + }, + ], + }, + { + title: 'Security', + isOpen: false, + links: [ + { title: 'Overview', href: '/use-cases/security' }, + { + title: 'Implement Zero Trust', + href: '/use-cases/security/implement-zero-trust', + }, + { + title: 'Private Proxy Without Inbound Ports', + href: '/use-cases/security/private-no-inbound', + }, + ], + }, + { title: 'Homelab', href: '/use-cases/homelab' }, + ], + }, + { + title: 'GET MORE HELP', + links: [ + { + title: 'Troubleshooting', + isOpen: false, + links: [ + { title: 'Overview', href: '/help/troubleshooting' }, + { + title: 'NetBird Client', + isOpen: false, + links: [ + { title: 'Overview', href: '/help/troubleshooting-client' }, + { title: 'Linux', href: '/help/troubleshooting-client/linux' }, + { + title: 'Windows', + href: '/help/troubleshooting-client/windows', + }, + { title: 'macOS', href: '/help/troubleshooting-client/macos' }, + { + title: 'Android', + href: '/help/troubleshooting-client/android', + }, + { title: 'iOS', href: '/help/troubleshooting-client/ios' }, + ], + }, + { + title: 'Self-hosted', + isOpen: false, + links: [ + { title: 'Overview', href: '/selfhosted/troubleshooting' }, + { + title: 'Installation', + href: '/selfhosted/troubleshooting/installation', + }, + { + title: 'Embedded IdP', + href: '/selfhosted/troubleshooting/identity-provider', + }, + { + title: 'Dashboard', + href: '/selfhosted/troubleshooting/dashboard', + }, + { + title: 'Certificates', + href: '/selfhosted/troubleshooting/certificates', + }, + { + title: 'Connectivity', + href: '/selfhosted/troubleshooting/connectivity', + }, + { + title: 'Database', + href: '/selfhosted/troubleshooting/database', + }, + ], + }, + { + title: 'Cloud & identity', + isOpen: false, + links: [ + { + title: 'Pending approval', + href: '/help/troubleshooting-account-access', + }, + { title: 'IdP & SSO setup', href: '/manage/team/single-sign-on' }, + { title: 'User provisioning', href: '/manage/team/idp-sync' }, + { + title: 'Plan limits & quotas', + href: '/manage/settings/plans-and-billing', + }, + ], + }, + { + title: 'Connectivity', + isOpen: false, + links: [ + { + title: 'Relayed Connections', + href: '/help/troubleshooting-relayed-connections', + }, + { + title: 'Resource Connectivity', + href: '/help/troubleshooting-resource-connectivity', + }, + { + title: 'NAT & Connectivity', + href: '/about-netbird/understanding-nat-and-connectivity', + }, + { + title: 'Ports & Firewalls', + href: '/about-netbird/ports-and-firewalls', + }, + ], + }, + { + title: 'Access control', + isOpen: false, + links: [ + { title: 'Policies', href: '/manage/access-control' }, + { + title: 'Posture checks', + href: '/manage/access-control/posture-checks', + }, + { + title: 'Groups', + href: '/manage/access-control#understanding-groups', + }, + ], + }, + { + title: 'Report a bug', + isOpen: false, + links: [ + { title: 'Overview', href: '/help/report-bug-issues' }, + { title: 'Community Support', href: '/help/community-support' }, + { title: 'NetBird Support', href: '/help/netbird-support' }, + ], + }, + ], + }, + { + title: 'Support Matrix', + isOpen: false, + links: [ + { title: 'Overview', href: '/help/support-matrix' }, + { + title: 'NetBird Client', + href: '/help/support-matrix/netbird-client', + isOpen: false, + links: [ + { + title: 'Linux', + href: '/help/support-matrix/netbird-client/linux', + }, + { + title: 'Windows', + href: '/help/support-matrix/netbird-client/windows', + }, + { + title: 'macOS', + href: '/help/support-matrix/netbird-client/macos', + }, + { + title: 'iOS', + href: '/help/support-matrix/netbird-client/ios', + }, + { + title: 'Android', + href: '/help/support-matrix/netbird-client/android', + }, + { + title: 'Android TV', + href: '/help/support-matrix/netbird-client/android-tv', + }, + { + title: 'tvOS', + href: '/help/support-matrix/netbird-client/tvos', + }, + ], + }, + { + title: 'Kubernetes Operator', + href: '/help/support-matrix/kubernetes-operator', + }, + { + title: 'Terraform Provider', + href: '/help/support-matrix/terraform-provider', + }, + { + title: 'Self-Hosted', + href: '/help/support-matrix/self-hosted', + }, + ], + }, + ], + }, ] export function NavigationDocs({ className }) { - return ( - - ) + return ( + + ) } const findActiveGroupIndex = (group, pathname) => { - let activeIndex = -1 - group.links.forEach((link, index) => { - if (link.href === pathname) { - activeIndex = index - } else if (link.links) { - const childIndex = findActiveGroupIndex(link, pathname) - if (childIndex !== -1) { - activeIndex = index - } - } - }) - return activeIndex + let activeIndex = -1 + group.links.forEach((link, index) => { + if (link.href === pathname) { + activeIndex = index + } else if (link.links) { + const childIndex = findActiveGroupIndex(link, pathname) + if (childIndex !== -1) { + activeIndex = index + } + } + }) + return activeIndex } function NavigationGroup({ group, className, hasChildren }) { - let router = useRouter() - let isActiveGroup = - group.href === router.pathname || - findActiveGroupIndex(group, router.pathname) !== -1 - const [isOpen, setIsOpen] = useState( - (group.isOpen ?? !hasChildren) || isActiveGroup - ) - useEffect(() => { - if (isActiveGroup) setIsOpen(true) - }, [router.pathname, isActiveGroup]) - const [, setActiveHighlight] = useNavigationState() - const isInsideMobileNavigation = useIsInsideMobileNavigation() + let router = useRouter() + let isActiveGroup = + group.href === router.pathname || + findActiveGroupIndex(group, router.pathname) !== -1 + const [isOpen, setIsOpen] = useState( + (group.isOpen ?? !hasChildren) || isActiveGroup + ) + useEffect(() => { + if (isActiveGroup) setIsOpen(true) + }, [router.pathname, isActiveGroup]) + const [, setActiveHighlight] = useNavigationState() + const isInsideMobileNavigation = useIsInsideMobileNavigation() - return ( -
  • - { - if (group.href) { - if (!isOpen) setIsOpen(true) - if (group.href !== router.pathname) router.push(group.href) - setActiveHighlight() - return - } - setIsOpen(!isOpen) - if (!isOpen) { - if ( - !isActiveGroup && - !isInsideMobileNavigation && - group.links[0]?.href - ) - router.push(group.links[0].href) - setActiveHighlight() - } else { - setActiveHighlight(group.title) - } - }} - data-nb-link={group.title} - data-nb-active={hasChildren && isActiveGroup ? '1' : '0'} - > - {group.title} - {hasChildren && ( - { - e.preventDefault() - e.stopPropagation() - setIsOpen(!isOpen) - if (isOpen) { - setActiveHighlight(group.title) - } else { - setActiveHighlight() - } - }} - > + return ( +
  • + { + if (group.href) { + if (!isOpen) setIsOpen(true) + if (group.href !== router.pathname) router.push(group.href) + setActiveHighlight() + return + } + setIsOpen(!isOpen) + if (!isOpen) { + if ( + !isActiveGroup && + !isInsideMobileNavigation && + group.links[0]?.href + ) + router.push(group.links[0].href) + setActiveHighlight() + } else { + setActiveHighlight(group.title) + } + }} + data-nb-link={group.title} + data-nb-active={hasChildren && isActiveGroup ? '1' : '0'} + > + {group.title} + {hasChildren && ( + { + e.preventDefault() + e.stopPropagation() + setIsOpen(!isOpen) + if (isOpen) { + setActiveHighlight(group.title) + } else { + setActiveHighlight() + } + }} + > - )} - -
    - {!hasChildren && ( - <> - - {isActiveGroup && ( - - )} - - - - {isActiveGroup && ( - - )} - - - )} + )} + +
    + {!hasChildren && ( + <> + + {isActiveGroup && ( + + )} + + + + {isActiveGroup && ( + + )} + + + )} - - {isOpen && ( - - {group.links.map((link) => { - return link.links ? ( - - ) : ( - - - {link.title} - - - ) - })} - - )} - -
    -
    • - ) + + {isOpen && ( + + {group.links.map((link) => { + return link.links ? ( + + ) : ( + + + {link.title} + + + ) + })} + + )} + + + + ) } diff --git a/src/pages/agent-network/integrations/index.mdx b/src/pages/agent-network/integrations/index.mdx index 64e01aa0..9aa6239a 100644 --- a/src/pages/agent-network/integrations/index.mdx +++ b/src/pages/agent-network/integrations/index.mdx @@ -17,6 +17,8 @@ Replace `` in the snippets below with the endpoint shown on the - [Codex](/agent-network/integrations/codex) — point the Codex CLI at the endpoint. - [LiteLLM](/agent-network/integrations/litellm) — use a LiteLLM gateway with identity-based attribution and budgets. +- [vLLM](/agent-network/integrations/vllm) — connect a self-hosted, OpenAI-compatible vLLM + server. - [Google Vertex AI](/agent-network/integrations/vertex-ai) — connect Gemini and Claude on Vertex AI with a Google Cloud service account. - [AWS Bedrock](/agent-network/integrations/bedrock) — connect Claude, Llama, and Nova on diff --git a/src/pages/agent-network/integrations/vllm.mdx b/src/pages/agent-network/integrations/vllm.mdx new file mode 100644 index 00000000..4bf3aa27 --- /dev/null +++ b/src/pages/agent-network/integrations/vllm.mdx @@ -0,0 +1,71 @@ +import { Note } from '@/components/mdx' + +export const description = + 'Serve a self-hosted vLLM model behind NetBird Agent Network: keyless, tunnel-only access to your OpenAI-compatible vLLM endpoint with policy-based authorization.' + +# vLLM + +[vLLM](https://docs.vllm.ai) is a high-throughput inference server for self-hosted models +that exposes an **OpenAI-compatible API**. You run it yourself — typically on a GPU host +inside the same network as the NetBird proxy — and connect it as a provider so agents reach +it keyless over the tunnel, authorized by your [policies](/agent-network/policies). + +This gives you keyless access to your private vLLM from anywhere: the endpoint stays +off the public internet, and any authorized user or agent reaches it over the NetBird +tunnel without shared API keys. + +vLLM behaves like a [custom / self-hosted provider](/agent-network/providers#custom-and-self-hosted-providers); +it simply has its own named entry in the provider picker. + +## Connect vLLM as a Provider + +Because vLLM is self-hosted, the upstream URL points at your own instance. Host it in the +same network as the proxy so the proxy can reach it directly. + +1. Go to **Agent Network → Providers** and click **Connect Provider**. +2. Select **vLLM** and set the **Upstream URL** to your vLLM server's OpenAI-compatible base + URL, for example `https://vllm.internal:8000`. +3. If your vLLM server was started with an API key (`--api-key`), paste it as the **API key**; + NetBird stores it server-side and sends it as a bearer token. Leave it empty if the server + requires none. +4. _(Optional)_ Enable **Skip TLS Verification** if your vLLM endpoint serves a self-signed + certificate — see [Skip TLS Verification](/agent-network/providers#skip-tls-verification). + Prefer mounting trusted certificates on your proxy instances for anything beyond testing. +5. _(Optional)_ List the **models** your server exposes with per-model pricing so cost shows + up in [Usage & Logs](/agent-network/usage-and-logs). Leaving the list empty accepts any + model name the server serves. +6. Save the provider. + +

    + connect a self-hosted vLLM provider in NetBird Agent Network +

    + +## Create a Policy + +By default nothing is allowed — a policy must connect a source group to the vLLM provider +before anyone can route through it. + +1. Go to **Agent Network → Policies** and add a policy. +2. Set the **Source** to the users or agents who should be able to use vLLM (for example your + `Engineering` group from your IdP). +3. Set the **Provider** to the vLLM provider you just connected. +4. Optionally attach per-user or per-group [token and budget limits](/agent-network/policies/limits) + and [guardrails](/agent-network/policies/guardrails) such as a model allowlist. + +

    + create a NetBird Agent Network policy authorizing vLLM +

    + +See [Policies](/agent-network/policies) for details. + +## Result + +Agents point at the NetBird endpoint with no key and call your vLLM models by name. NetBird +enforces your policies, limits, and guardrails, then forwards the request to your vLLM server. +Every call is recorded in [Usage & Logs](/agent-network/usage-and-logs) with the caller's +identity, auth group, model, tokens, cost, and status. + + + vLLM speaks the OpenAI API shape, so point OpenAI-compatible clients at + `https://` and select a model your server hosts. +