mirror of
https://github.com/netbirdio/docs.git
synced 2026-08-25 01:01:27 +02:00
b99bf2838e
New page covering how to pre-populate default.json so NetBird peers register with the right settings on first start in IaC, Docker, and Kubernetes deployments. Documents file location across OSes, common keys (with guidance to leave PrivateKey empty and treat PreSharedKey as optional), runtime setup-key injection with worked Docker and Kubernetes ConfigMap + Secret examples, backup hazards around the embedded WireGuard private key, and how to verify registration via netbird status --check startup, --json, and GET /api/peers. Includes a callout that this workflow is for unattended workloads only -- end-user devices should still enroll via the SSO flow so Zero Trust can re-verify the user identity. Linked from Manage NetBird -> Peers, right after Setup Keys.
990 lines
32 KiB
JavaScript
990 lines
32 KiB
JavaScript
import { useRouter } from 'next/router'
|
|
import clsx from 'clsx'
|
|
import {
|
|
ActivePageMarker,
|
|
NavLink,
|
|
TopLevelNavItem,
|
|
VisibleSectionHighlight,
|
|
} from '@/components/NavigationAPI'
|
|
import { AnimatePresence, motion } from 'framer-motion'
|
|
import { Button } from '@/components/mdx'
|
|
import { useState } from 'react'
|
|
import {
|
|
NavigationStateProvider,
|
|
useNavigationState,
|
|
} from '@/components/NavigationState'
|
|
import ChevronDownIcon from '@/components/icons/ChevronDownIcon'
|
|
|
|
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: 'Understanding NAT and Connectivity',
|
|
href: '/about-netbird/understanding-nat-and-connectivity',
|
|
},
|
|
{
|
|
title: 'Why WireGuard with NetBird',
|
|
href: '/about-netbird/why-wireguard-with-netbird',
|
|
},
|
|
{
|
|
title: 'Browser Client Architecture',
|
|
href: '/about-netbird/browser-client-architecture',
|
|
},
|
|
{ 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: true,
|
|
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: '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', href: '/manage/peers/browser-client' },
|
|
{ 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: 'Concept', href: '/manage/networks' },
|
|
{
|
|
title: 'How Routing Peers Work',
|
|
href: '/manage/networks/how-routing-peers-work',
|
|
},
|
|
{
|
|
title: 'Use Cases',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/manage/networks/use-cases' },
|
|
{
|
|
title: 'By Scenario',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Access Home Devices',
|
|
href: '/manage/networks/use-cases/by-scenario/access-home-devices',
|
|
},
|
|
{
|
|
title: 'Remote Worker Access',
|
|
href: '/manage/networks/use-cases/by-scenario/remote-worker-access',
|
|
},
|
|
{
|
|
title: 'Cloud to On-Premise',
|
|
href: '/manage/networks/use-cases/by-scenario/cloud-to-on-premise',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'By Resource Type',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Multiple IP Resources',
|
|
href: '/manage/networks/use-cases/by-resource-type/routing-traffic-to-multiple-resources',
|
|
},
|
|
{
|
|
title: 'Domain Resources',
|
|
href: '/manage/networks/use-cases/by-resource-type/accessing-restricted-domain-resources',
|
|
},
|
|
{
|
|
title: 'Wildcard Domains',
|
|
href: '/manage/networks/use-cases/by-resource-type/accessing-entire-domains-within-networks',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Network Routes',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Concept', href: '/manage/network-routes' },
|
|
{
|
|
title: 'Use Cases',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/manage/network-routes/use-cases' },
|
|
{
|
|
title: 'By Scenario',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Site-to-Site: Home',
|
|
href: '/manage/network-routes/use-cases/by-scenario/site-to-site-home',
|
|
},
|
|
{
|
|
title: 'Site-to-Site: Office',
|
|
href: '/manage/network-routes/use-cases/by-scenario/site-to-site-office',
|
|
},
|
|
{
|
|
title: 'Site-to-Site: Cloud',
|
|
href: '/manage/network-routes/use-cases/by-scenario/site-to-site-cloud',
|
|
},
|
|
{
|
|
title: 'Exit Nodes',
|
|
href: '/manage/network-routes/use-cases/by-scenario/exit-nodes',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'By Configuration',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Access Control',
|
|
href: '/manage/network-routes/use-cases/by-configuration/access-control',
|
|
},
|
|
{
|
|
title: 'Overlapping Routes',
|
|
href: '/manage/network-routes/use-cases/by-configuration/overlapping-routes',
|
|
},
|
|
{
|
|
title: 'Advanced Configuration',
|
|
href: '/manage/network-routes/use-cases/by-configuration/advanced-configuration',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Reverse Proxy',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/manage/reverse-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: '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: 'Settings',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Authentication',
|
|
href: '/manage/settings/enforce-periodic-user-authentication',
|
|
},
|
|
{
|
|
title: 'Multi-Factor Authentication',
|
|
href: '/manage/settings/multi-factor-authentication',
|
|
},
|
|
{ title: 'Auto Update', href: '/manage/peers/auto-update' },
|
|
{ title: 'Lazy Connections', href: '/manage/peers/lazy-connection' },
|
|
{
|
|
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: 'Kubernetes',
|
|
isOpen: true,
|
|
links: [
|
|
{ title: 'Operator', href: '/manage/integrations/kubernetes' },
|
|
{
|
|
title: 'Gateway API beta',
|
|
href: '/manage/integrations/kubernetes/gateway-api-beta',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
|
|
{
|
|
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: 'Acronis NetBird integration',
|
|
href: '/manage/for-partners/acronis-integration',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'SELF-HOST NETBIRD',
|
|
links: [
|
|
{ title: 'Quickstart Guide', href: '/selfhosted/selfhosted-quickstart' },
|
|
{ title: 'Automated Setup', href: '/selfhosted/automated-setup' },
|
|
{
|
|
title: 'Maintenance',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Configuration Files',
|
|
href: '/selfhosted/configuration-files',
|
|
},
|
|
{
|
|
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/sqlite-store',
|
|
},
|
|
{
|
|
title: 'Management Postgres Store',
|
|
href: '/selfhosted/postgres-store',
|
|
},
|
|
{
|
|
title: 'Activity Events Postgres Store',
|
|
href: '/selfhosted/activity-postgres-store',
|
|
},
|
|
{
|
|
title: 'Management Geolocation Database',
|
|
href: '/selfhosted/geo-support',
|
|
},
|
|
{
|
|
title: 'CrowdSec IP Reputation',
|
|
href: '/selfhosted/maintenance/crowdsec',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
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: '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', href: '/selfhosted/troubleshooting' },
|
|
{
|
|
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: 'Profiles', href: '/client/profiles' },
|
|
{ title: 'Environment Variables', href: '/client/environment-variables' },
|
|
{
|
|
title: 'Settings',
|
|
isOpen: false,
|
|
links: [
|
|
{
|
|
title: 'Allow SSH',
|
|
href: '/client/allow-ssh',
|
|
},
|
|
{
|
|
title: 'Block Inbound Connections',
|
|
href: '/client/block-inbound-connections',
|
|
},
|
|
{
|
|
title: 'Connect on Startup',
|
|
href: '/client/connect-on-startup',
|
|
},
|
|
{
|
|
title: 'Enable Lazy Connections',
|
|
href: '/client/enable-lazy-connections',
|
|
},
|
|
{
|
|
title: 'Enable Quantum-Resistance',
|
|
href: '/client/post-quantum-cryptography',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'USE CASES',
|
|
links: [
|
|
{ title: 'Overview', href: '/use-cases' },
|
|
{
|
|
title: 'Remote Access',
|
|
isOpen: false,
|
|
links: [{ title: 'Overview', href: '/use-cases/site-to-site' }],
|
|
},
|
|
{
|
|
title: 'Homelab',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/use-cases/homelab' },
|
|
{
|
|
title: 'NetBird on MikroTik Router',
|
|
href: '/use-cases/homelab/client-on-mikrotik-router',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Cloud',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/use-cases/cloud' },
|
|
{
|
|
title: 'NetBird on AWS ECS',
|
|
href: '/use-cases/cloud/aws-ecs-terraform',
|
|
},
|
|
{
|
|
title: 'NetBird on Serverless (FaaS)',
|
|
href: '/use-cases/cloud/netbird-on-faas',
|
|
},
|
|
{
|
|
title: 'Routing Peers and Kubernetes',
|
|
href: '/use-cases/cloud/routing-peers-and-kubernetes',
|
|
},
|
|
{
|
|
title: 'Distributed Multi-Cloud AI',
|
|
href: '/use-cases/cloud/distributed-multi-cloud-ai',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Security',
|
|
isOpen: false,
|
|
links: [
|
|
{ title: 'Overview', href: '/use-cases/security' },
|
|
{
|
|
title: 'Implement Zero Trust',
|
|
href: '/use-cases/security/implement-zero-trust',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'GET MORE HELP',
|
|
links: [
|
|
{
|
|
title: 'Troubleshooting client issues',
|
|
href: '/help/troubleshooting-client',
|
|
},
|
|
{ title: 'Report bugs and issues', href: '/help/report-bug-issues' },
|
|
],
|
|
},
|
|
]
|
|
|
|
export function NavigationDocs({ className }) {
|
|
return (
|
|
<nav className={className}>
|
|
<ul role="list">
|
|
<TopLevelNavItem href="https://netbird.io/">Home</TopLevelNavItem>
|
|
<TopLevelNavItem href="/">Docs</TopLevelNavItem>
|
|
<TopLevelNavItem href="/api">API</TopLevelNavItem>
|
|
<TopLevelNavItem href="https://netbird.io/knowledge-hub/">
|
|
Learn
|
|
</TopLevelNavItem>
|
|
<TopLevelNavItem href="https://github.com/netbirdio/netbird">
|
|
Github
|
|
</TopLevelNavItem>
|
|
<TopLevelNavItem href="/slack-url">Support</TopLevelNavItem>
|
|
{docsNavigation.map((group, groupIndex) => (
|
|
<NavigationStateProvider key={group.title} index={groupIndex}>
|
|
<NavigationGroup
|
|
group={group}
|
|
index={groupIndex}
|
|
className={groupIndex === 0 && 'md:mt-0'}
|
|
/>
|
|
</NavigationStateProvider>
|
|
))}
|
|
<li className="sticky bottom-0 z-10 mt-6 min-[416px]:hidden">
|
|
<Button
|
|
href="https://app.netbird.io/"
|
|
variant="filled"
|
|
className="w-full"
|
|
>
|
|
Sign in
|
|
</Button>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
)
|
|
}
|
|
|
|
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
|
|
}
|
|
|
|
function NavigationGroup({ group, className, hasChildren }) {
|
|
let router = useRouter()
|
|
let isActiveGroup = findActiveGroupIndex(group, router.pathname) !== -1
|
|
const [isOpen, setIsOpen] = useState(
|
|
group.isOpen ? group.isOpen : !hasChildren
|
|
)
|
|
const [, setActiveHighlight] = useNavigationState()
|
|
|
|
return (
|
|
<li className={clsx('relative', className, hasChildren ? '' : 'mt-6')}>
|
|
<motion.h2
|
|
// layout={"size"}
|
|
className={clsx(
|
|
'group flex items-center justify-between gap-2',
|
|
hasChildren
|
|
? 'cursor-pointer select-none py-1 pr-3 text-sm font-medium text-zinc-700 hover:text-zinc-900 dark:text-zinc-300 dark:hover:text-white'
|
|
: 'text-xs font-semibold text-zinc-900 dark:text-white'
|
|
)}
|
|
onClick={() => {
|
|
setIsOpen(!isOpen)
|
|
if (!isOpen) {
|
|
if (!isActiveGroup && 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 && (
|
|
<ChevronDownIcon
|
|
className={clsx(
|
|
'fill-zinc-700 group-hover:fill-zinc-900 dark:fill-zinc-300 dark:group-hover:fill-white',
|
|
'transition',
|
|
isOpen ? 'rotate-180 transform' : ''
|
|
)}
|
|
size={10}
|
|
/>
|
|
)}
|
|
</motion.h2>
|
|
<div className={clsx('relative', hasChildren ? '' : 'mt-3 pl-2')}>
|
|
{!hasChildren && (
|
|
<>
|
|
<AnimatePresence>
|
|
{isActiveGroup && (
|
|
<VisibleSectionHighlight
|
|
group={group}
|
|
pathname={router.pathname}
|
|
/>
|
|
)}
|
|
</AnimatePresence>
|
|
<motion.div
|
|
// layout
|
|
className="absolute inset-y-0 left-2 w-px bg-zinc-900/10 dark:bg-white/5"
|
|
/>
|
|
<AnimatePresence initial={false}>
|
|
{isActiveGroup && (
|
|
<ActivePageMarker group={group} pathname={router.pathname} />
|
|
)}
|
|
</AnimatePresence>
|
|
</>
|
|
)}
|
|
|
|
<AnimatePresence mode={'wait'} initial={false}>
|
|
{isOpen && (
|
|
<motion.ul
|
|
role="list"
|
|
initial={{ opacity: 0 }}
|
|
animate={{
|
|
opacity: 1,
|
|
transition: { delay: 0.05 },
|
|
}}
|
|
exit={{
|
|
opacity: 0,
|
|
transition: { duration: 0.15 },
|
|
}}
|
|
className="border-l border-transparent"
|
|
>
|
|
{group.links.map((link) => {
|
|
return link.href ? (
|
|
<motion.li key={link.href} className="relative">
|
|
<NavLink
|
|
href={link.href}
|
|
active={link.href === router.pathname}
|
|
links={link.links}
|
|
>
|
|
{link.title}
|
|
</NavLink>
|
|
</motion.li>
|
|
) : (
|
|
<NavigationGroup
|
|
className={'ml-4'}
|
|
key={link.title + isOpen}
|
|
group={link}
|
|
hasChildren={true}
|
|
/>
|
|
)
|
|
})}
|
|
</motion.ul>
|
|
)}
|
|
</AnimatePresence>
|
|
</div>
|
|
</li>
|
|
)
|
|
}
|