# NetBird Documentation

> NetBird is an open-source WireGuard-based mesh VPN platform that creates secure private networks.
> This file provides an index of all documentation pages in markdown format for LLM consumption.

## About

- Website: https://netbird.io
- Documentation: https://docs.netbird.io
- GitHub: https://github.com/netbirdio/netbird

## Documentation Index

Each link below points to a clean markdown version of the documentation page.

### About NetBird

- [FAQ](https://docs.netbird.io/llms/about-netbird/faq.md)
- [How NetBird Works](https://docs.netbird.io/llms/about-netbird/how-netbird-works.md)
- [NetBird vs. Traditional VPN](https://docs.netbird.io/llms/about-netbird/netbird-vs-traditional-vpn.md)
- [Ports & Firewalls](https://docs.netbird.io/llms/about-netbird/ports-and-firewalls.md)
- [Self-hosted vs. Cloud-hosted NetBird](https://docs.netbird.io/llms/about-netbird/self-hosted-vs-cloud.md)
- [Understanding NAT and Connectivity](https://docs.netbird.io/llms/about-netbird/understanding-nat-and-connectivity.md)

### Client

- [Block Inbound Connections](https://docs.netbird.io/llms/client/block-inbound-connections.md)
- [Connect on Startup](https://docs.netbird.io/llms/client/connect-on-startup.md)
- [NetBird Desktop App](https://docs.netbird.io/llms/client/desktop-app.md)
- [Client Environment Variables](https://docs.netbird.io/llms/client/environment-variables.md)
- [MDM Integration](https://docs.netbird.io/llms/client/mdm-integration.md)
- [Enable Quantum-Resistance](https://docs.netbird.io/llms/client/post-quantum-cryptography.md)
- [Switching Between NetBird Accounts with Profiles](https://docs.netbird.io/llms/client/profiles.md)

### Getting Started

- [NetBird Agent command line interface (CLI)](https://docs.netbird.io/llms/get-started/cli.md)
- [Getting Started](https://docs.netbird.io/llms/get-started.md)
- [Install NetBird on an Android TV](https://docs.netbird.io/llms/get-started/install/android-tv.md)
- [Install NetBird on an Android](https://docs.netbird.io/llms/get-started/install/android.md)
- [Docker Installation](https://docs.netbird.io/llms/get-started/install/docker.md)
- [Install NetBird](https://docs.netbird.io/llms/get-started/install.md)
- [iOS](https://docs.netbird.io/llms/get-started/install/ios.md)
- [Linux Installation](https://docs.netbird.io/llms/get-started/install/linux.md)
- [MacOS Installation](https://docs.netbird.io/llms/get-started/install/macos.md)
- [Mobile Applications](https://docs.netbird.io/llms/get-started/install/mobile.md)
- [OPNsense Installation](https://docs.netbird.io/llms/get-started/install/opnsense.md)
- [pfSense Installation](https://docs.netbird.io/llms/get-started/install/pfsense.md)
- [Install NetBird on Proxmox VE](https://docs.netbird.io/llms/get-started/install/proxmox-ve.md)
- [Install NetBird on the Raspberry Pi](https://docs.netbird.io/llms/get-started/install/raspberrypi.md)
- [Synology Installation](https://docs.netbird.io/llms/get-started/install/synology.md)
- [Install NetBird on TrueNAS](https://docs.netbird.io/llms/get-started/install/truenas.md)
- [tvOS (Apple TV)](https://docs.netbird.io/llms/get-started/install/tvos.md)
- [Windows Installation](https://docs.netbird.io/llms/get-started/install/windows.md)

### Help & Troubleshooting

- [Report bugs and issues](https://docs.netbird.io/llms/help/report-bug-issues.md)
- [Support Matrix](https://docs.netbird.io/llms/help/support-matrix.md)
- [Kubernetes Operator Support Matrix](https://docs.netbird.io/llms/help/support-matrix/kubernetes-operator.md)
- [Android TV](https://docs.netbird.io/llms/help/support-matrix/netbird-client/android-tv.md)
- [Android](https://docs.netbird.io/llms/help/support-matrix/netbird-client/android.md)
- [NetBird Client Support Matrix](https://docs.netbird.io/llms/help/support-matrix/netbird-client.md)
- [iOS](https://docs.netbird.io/llms/help/support-matrix/netbird-client/ios.md)
- [Linux](https://docs.netbird.io/llms/help/support-matrix/netbird-client/linux.md)
- [macOS](https://docs.netbird.io/llms/help/support-matrix/netbird-client/macos.md)
- [tvOS](https://docs.netbird.io/llms/help/support-matrix/netbird-client/tvos.md)
- [Windows](https://docs.netbird.io/llms/help/support-matrix/netbird-client/windows.md)
- [Self-Hosted Support Matrix](https://docs.netbird.io/llms/help/support-matrix/self-hosted.md)
- [Terraform Provider Support Matrix](https://docs.netbird.io/llms/help/support-matrix/terraform-provider.md)
- [Troubleshooting client issues](https://docs.netbird.io/llms/help/troubleshooting-client.md)
- [Troubleshooting relayed connections](https://docs.netbird.io/llms/help/troubleshooting-relayed-connections.md)

### Introduction

- [Introduction to NetBird](https://docs.netbird.io/llms/introduction.md)

### API Reference

- [Authentication](https://docs.netbird.io/llms/ipa/guides/authentication.md)
- [Errors](https://docs.netbird.io/llms/ipa/guides/errors.md)
- [MSP API access](https://docs.netbird.io/llms/ipa/guides/msp-api-access.md)
- [Quickstart](https://docs.netbird.io/llms/ipa/guides/quickstart.md)
- [NetBird REST API](https://docs.netbird.io/llms/ipa/introduction.md)
- [accounts](https://docs.netbird.io/llms/ipa/resources/accounts.md)
- [dns-zones](https://docs.netbird.io/llms/ipa/resources/dns-zones.md)
- [dns](https://docs.netbird.io/llms/ipa/resources/dns.md)
- [edr-falcon-integrations](https://docs.netbird.io/llms/ipa/resources/edr-falcon-integrations.md)
- [edr-fleetdm-integrations](https://docs.netbird.io/llms/ipa/resources/edr-fleetdm-integrations.md)
- [edr-huntress-integrations](https://docs.netbird.io/llms/ipa/resources/edr-huntress-integrations.md)
- [edr-intune-integrations](https://docs.netbird.io/llms/ipa/resources/edr-intune-integrations.md)
- [edr-peers](https://docs.netbird.io/llms/ipa/resources/edr-peers.md)
- [edr-sentinelone-integrations](https://docs.netbird.io/llms/ipa/resources/edr-sentinelone-integrations.md)
- [event-streaming-integrations](https://docs.netbird.io/llms/ipa/resources/event-streaming-integrations.md)
- [events](https://docs.netbird.io/llms/ipa/resources/events.md)
- [geo-locations](https://docs.netbird.io/llms/ipa/resources/geo-locations.md)
- [groups](https://docs.netbird.io/llms/ipa/resources/groups.md)
- [identity-providers](https://docs.netbird.io/llms/ipa/resources/identity-providers.md)
- [idp-azure-integrations](https://docs.netbird.io/llms/ipa/resources/idp-azure-integrations.md)
- [idp-google-integrations](https://docs.netbird.io/llms/ipa/resources/idp-google-integrations.md)
- [idp-okta-scim-integrations](https://docs.netbird.io/llms/ipa/resources/idp-okta-scim-integrations.md)
- [idp-scim-integrations](https://docs.netbird.io/llms/ipa/resources/idp-scim-integrations.md)
- [ingress-ports](https://docs.netbird.io/llms/ipa/resources/ingress-ports.md)
- [instance](https://docs.netbird.io/llms/ipa/resources/instance.md)
- [invoice](https://docs.netbird.io/llms/ipa/resources/invoice.md)
- [jobs](https://docs.netbird.io/llms/ipa/resources/jobs.md)
- [msp](https://docs.netbird.io/llms/ipa/resources/msp.md)
- [networks](https://docs.netbird.io/llms/ipa/resources/networks.md)
- [notifications](https://docs.netbird.io/llms/ipa/resources/notifications.md)
- [peers](https://docs.netbird.io/llms/ipa/resources/peers.md)
- [policies](https://docs.netbird.io/llms/ipa/resources/policies.md)
- [posture-checks](https://docs.netbird.io/llms/ipa/resources/posture-checks.md)
- [routes](https://docs.netbird.io/llms/ipa/resources/routes.md)
- [self-hosted-proxies](https://docs.netbird.io/llms/ipa/resources/self-hosted-proxies.md)
- [services](https://docs.netbird.io/llms/ipa/resources/services.md)
- [setup-keys](https://docs.netbird.io/llms/ipa/resources/setup-keys.md)
- [tokens](https://docs.netbird.io/llms/ipa/resources/tokens.md)
- [usage](https://docs.netbird.io/llms/ipa/resources/usage.md)
- [users](https://docs.netbird.io/llms/ipa/resources/users.md)

### Managing NetBird

- [Bypass Compliance for Non-Compliant Peers](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/bypass-compliance.md)
- [Restrict Network Access with CrowdStrike Falcon®](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/crowdstrike-edr.md)
- [Restrict Network Access with FleetDM](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/fleetdm-edr.md)
- [Restrict Network Access with Huntress EDR](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/huntress-edr.md)
- [Integrate NetBird with MDM & EDR Platforms](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response.md)
- [Allow Only Intune-Managed Devices to Access Your Network](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/intune-mdm.md)
- [Restrict Network Access with SentinelOne Singularity™](https://docs.netbird.io/llms/manage/access-control/endpoint-detection-and-response/sentinelone-edr.md)
- [Understanding Groups and Access Policies](https://docs.netbird.io/llms/manage/access-control.md)
- [Managing Access with NetBird: Groups and Access Policies](https://docs.netbird.io/llms/manage/access-control/manage-network-access.md)
- [Connecting from the office](https://docs.netbird.io/llms/manage/access-control/posture-checks/connecting-from-the-office.md)
- [Understanding NetBird Posture Checks](https://docs.netbird.io/llms/manage/access-control/posture-checks.md)
- [Stream Network Activity to Amazon Data Firehose](https://docs.netbird.io/llms/manage/activity/event-streaming/amazon-firehose.md)
- [Stream Network Activity to Amazon S3](https://docs.netbird.io/llms/manage/activity/event-streaming/amazon-s3.md)
- [Stream Network Activity to Datadog Cloud SIEM](https://docs.netbird.io/llms/manage/activity/event-streaming/datadog.md)
- [Stream Network Activity to a Generic HTTP Endpoint](https://docs.netbird.io/llms/manage/activity/event-streaming/generic-http.md)
- [Stream Network Activity to Third-Party SIEM Platforms](https://docs.netbird.io/llms/manage/activity/event-streaming.md)
- [Stream Network Activity to SentinelOne Singularity Data Lake](https://docs.netbird.io/llms/manage/activity/event-streaming/sentinelone-data-lake.md)
- [Stream Activity Events to Wazuh](https://docs.netbird.io/llms/manage/activity/event-streaming/wazuh.md)
- [Audit Events Logging](https://docs.netbird.io/llms/manage/activity.md)
- [Traffic Events Logging](https://docs.netbird.io/llms/manage/activity/traffic-events-logging.md)
- [Visualize Remote Access with Control Center](https://docs.netbird.io/llms/manage/control-center.md)
- [Custom Zones](https://docs.netbird.io/llms/manage/dns/custom-zones.md)
- [DNS Aliases for Routed Networks](https://docs.netbird.io/llms/manage/dns/dns-aliases-for-routed-networks.md)
- [DNS Settings](https://docs.netbird.io/llms/manage/dns/dns-settings.md)
- [Extra DNS Labels](https://docs.netbird.io/llms/manage/dns/extra-dns-labels.md)
- [DNS in NetBird](https://docs.netbird.io/llms/manage/dns.md)
- [Internal DNS Servers](https://docs.netbird.io/llms/manage/dns/internal-dns-servers.md)
- [Configuring Nameservers](https://docs.netbird.io/llms/manage/dns/nameserver-groups.md)
- [Private DNS Behind Routing Peers](https://docs.netbird.io/llms/manage/dns/private-dns-behind-routing-peers.md)
- [DNS Troubleshooting](https://docs.netbird.io/llms/manage/dns/troubleshooting.md)
- [Deploying NetBird with Acronis Cyber Protect Cloud](https://docs.netbird.io/llms/manage/for-partners/acronis-integration.md)
- [NetBird Distributor Portal for Distributors](https://docs.netbird.io/llms/manage/for-partners/distributor-portal.md)
- [NetBird MSP Portal for Managed Service Providers](https://docs.netbird.io/llms/manage/for-partners/msp-portal.md)
- [API Server Proxy](https://docs.netbird.io/llms/manage/integrations/kubernetes/api-server-proxy.md)
- [Client Sidecar](https://docs.netbird.io/llms/manage/integrations/kubernetes/client-sidecar.md)
- [Kubernetes Gateway API Integration](https://docs.netbird.io/llms/manage/integrations/kubernetes/gateway-api.md)
- [Getting Started](https://docs.netbird.io/llms/manage/integrations/kubernetes.md)
- [Routing Peer](https://docs.netbird.io/llms/manage/integrations/kubernetes/routing-peer.md)
- [Deploying NetBird with Intune](https://docs.netbird.io/llms/manage/integrations/mdm-deployment/intune-netbird-integration.md)
- [Deploying NetBird's with Jamf Pro](https://docs.netbird.io/llms/manage/integrations/mdm-deployment/jamf-pro-netbird-integration.md)
- [Deploying NetBird with Kandji MDM](https://docs.netbird.io/llms/manage/integrations/mdm-deployment/kandji-netbird-integration.md)
- [Building a CLI-Only .pkg for macOS MDM Deployment](https://docs.netbird.io/llms/manage/integrations/mdm-deployment/macos-cli-pkg-deployment.md)
- [Configuring Routes with Access Control](https://docs.netbird.io/llms/manage/network-routes/access-control.md)
- [Advanced Configuration](https://docs.netbird.io/llms/manage/network-routes/advanced-configuration.md)
- [Routes](https://docs.netbird.io/llms/manage/network-routes.md)
- [Resolving Overlapping Routes](https://docs.netbird.io/llms/manage/network-routes/overlapping-routes.md)
- [Configuring Exit Nodes for Internet Traffic](https://docs.netbird.io/llms/manage/network-routes/use-cases/exit-nodes.md)
- [Site-to-Site](https://docs.netbird.io/llms/manage/network-routes/use-cases/site-to-site.md)
- [How Routing Peers Work](https://docs.netbird.io/llms/manage/networks/how-routing-peers-work.md)
- [Networks](https://docs.netbird.io/llms/manage/networks.md)
- [Masquerade](https://docs.netbird.io/llms/manage/networks/masquerade.md)
- [Access Home Devices (VPN-to-Site)](https://docs.netbird.io/llms/manage/networks/use-cases/access-home-devices.md)
- [Active Directory & Windows File Shares](https://docs.netbird.io/llms/manage/networks/use-cases/active-directory.md)
- [Cloud to On-Premise Access (VPN-to-Site)](https://docs.netbird.io/llms/manage/networks/use-cases/cloud-to-on-premise.md)
- [Reach Services on the Routing Peer](https://docs.netbird.io/llms/manage/networks/use-cases/reach-services-on-the-routing-peer.md)
- [Site-to-Site](https://docs.netbird.io/llms/manage/networks/use-cases/site-to-site.md)
- [Site-to-VPN: Clientless Devices Reaching NetBird Peers](https://docs.netbird.io/llms/manage/networks/use-cases/site-to-vpn.md)
- [Access Internal Resources From Autoscaled Environments](https://docs.netbird.io/llms/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments.md)
- [Peer Approval for Remote Worker Access with NetBird](https://docs.netbird.io/llms/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access.md)
- [Secure Remote Web Server Access: SSH Without Port Exposure](https://docs.netbird.io/llms/manage/peers/access-infrastructure/secure-remote-webserver-access.md)
- [Add Servers to the Network with Setup Keys](https://docs.netbird.io/llms/manage/peers/access-infrastructure/setup-keys-add-servers-to-network.md)
- [Add peers to your NetBird network](https://docs.netbird.io/llms/manage/peers/add-machines-to-your-network.md)
- [Approve peers](https://docs.netbird.io/llms/manage/peers/approve-peers.md)
- [Client Automatic Updates](https://docs.netbird.io/llms/manage/peers/auto-update.md)
- [Bootstrap peers via config file](https://docs.netbird.io/llms/manage/peers/bootstrap-via-config-file.md)
- [Browser Client Technical Architecture](https://docs.netbird.io/llms/manage/peers/browser-client/architecture.md)
- [Browser Client - Web-based Remote Access](https://docs.netbird.io/llms/manage/peers/browser-client.md)
- [Lazy Connections](https://docs.netbird.io/llms/manage/peers/lazy-connection.md)
- [Automate Deployments and Onboard Machines at Scale with Setup Keys](https://docs.netbird.io/llms/manage/peers/register-machines-using-setup-keys.md)
- [Remote Jobs](https://docs.netbird.io/llms/manage/peers/remote-jobs.md)
- [SSH Access](https://docs.netbird.io/llms/manage/peers/ssh.md)
- [Use service users and tokens to access NetBird's public API](https://docs.netbird.io/llms/manage/public-api.md)
- [Reverse Proxy Access Logs](https://docs.netbird.io/llms/manage/reverse-proxy/access-logs.md)
- [Reverse Proxy Authentication and Access Restrictions](https://docs.netbird.io/llms/manage/reverse-proxy/authentication.md)
- [Bring Your Own Proxy](https://docs.netbird.io/llms/manage/reverse-proxy/bring-your-own-proxy.md)
- [Custom Domains](https://docs.netbird.io/llms/manage/reverse-proxy/custom-domains.md)
- [Expose from CLI](https://docs.netbird.io/llms/manage/reverse-proxy/expose-from-cli.md)
- [Reverse Proxy](https://docs.netbird.io/llms/manage/reverse-proxy.md)
- [Backend Service Configuration](https://docs.netbird.io/llms/manage/reverse-proxy/service-configuration.md)
- [Reverse Proxy Troubleshooting](https://docs.netbird.io/llms/manage/reverse-proxy/troubleshooting.md)
- [Delete your NetBird account](https://docs.netbird.io/llms/manage/settings/delete-account.md)
- [Enforce periodic user authentication](https://docs.netbird.io/llms/manage/settings/enforce-periodic-user-authentication.md)
- [IPv6 Overlay Addressing](https://docs.netbird.io/llms/manage/settings/ipv6.md)
- [Multi-Factor Authentication (MFA)](https://docs.netbird.io/llms/manage/settings/multi-factor-authentication.md)
- [Notifications](https://docs.netbird.io/llms/manage/settings/notifications.md)
- [Plans and billing](https://docs.netbird.io/llms/manage/settings/plans-and-billing.md)
- [Add users to your network](https://docs.netbird.io/llms/manage/team/add-users-to-your-network.md)
- [Approve users](https://docs.netbird.io/llms/manage/team/approve-users.md)
- [Automatically Offboard Team Members from NetBird](https://docs.netbird.io/llms/manage/team/auto-offboard-users.md)
- [Enable NetBird for Microsoft Entra ID](https://docs.netbird.io/llms/manage/team/entra-id-app-enablement.md)
- [Provision Users and Groups From Google Workspace (Embedded IdP)](https://docs.netbird.io/llms/manage/team/idp-sync/embedded/google-workspace-sync.md)
- [Provision Users and Groups From JumpCloud (Embedded IdP)](https://docs.netbird.io/llms/manage/team/idp-sync/embedded/jumpcloud-sync.md)
- [Provision Users and Groups From Keycloak (Embedded IdP)](https://docs.netbird.io/llms/manage/team/idp-sync/embedded/keycloak-sync.md)
- [Provision Users and Groups From Microsoft Entra ID via SCIM (Embedded IdP)](https://docs.netbird.io/llms/manage/team/idp-sync/embedded/microsoft-entra-id-scim-sync.md)
- [Provision Users and Groups From Microsoft Entra ID via API (Embedded IdP)](https://docs.netbird.io/llms/manage/team/idp-sync/embedded/microsoft-entra-id-sync.md)
- [Provision Users and Groups From Google Workspace](https://docs.netbird.io/llms/manage/team/idp-sync/google-workspace-sync.md)
- [Provision Users and Groups From Your Identity Provider](https://docs.netbird.io/llms/manage/team/idp-sync.md)
- [Provision Users and Groups From JumpCloud](https://docs.netbird.io/llms/manage/team/idp-sync/jumpcloud-sync.md)
- [Provision Users and Groups From Keycloak](https://docs.netbird.io/llms/manage/team/idp-sync/keycloak-sync.md)
- [Provision Users and Groups From Microsoft Entra ID via SCIM](https://docs.netbird.io/llms/manage/team/idp-sync/microsoft-entra-id-scim-sync.md)
- [Provision Users and Groups From Microsoft Entra ID via API](https://docs.netbird.io/llms/manage/team/idp-sync/microsoft-entra-id-sync.md)
- [Provision Users and Groups from Okta](https://docs.netbird.io/llms/manage/team/idp-sync/okta-sync.md)
- [Auth0 on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/auth0.md)
- [Authentik on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/authentik.md)
- [AWS Cognito on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/aws-cognito.md)
- [cidaas on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/cidaas.md)
- [Duo Security on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/duo-security.md)
- [Authenticate to NetBird with Single Sign On (SSO)](https://docs.netbird.io/llms/manage/team/single-sign-on.md)
- [JumpCloud on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/jumpcloud.md)
- [Keycloak on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/keycloak.md)
- [Zitadel on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/zitadel.md)
- [Zoho on NetBird Cloud](https://docs.netbird.io/llms/manage/team/single-sign-on/zoho.md)
- [User Roles](https://docs.netbird.io/llms/manage/team/user-roles.md)

### Self-Hosting

- [Automated setup with a Personal Access Token](https://docs.netbird.io/llms/selfhosted/automated-setup.md)
- [Getting Started with NetBird Enterprise Commercial License](https://docs.netbird.io/llms/selfhosted/enterprise/getting-started.md)
- [Environment Variables Configuration](https://docs.netbird.io/llms/selfhosted/environment-variables.md)
- [External Reverse Proxy Setup for Self-Hosted NetBird](https://docs.netbird.io/llms/selfhosted/external-reverse-proxy.md)
- [ADFS SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/adfs.md)
- [Authentik SSO with NetBird Self-Hosted (Advanced)](https://docs.netbird.io/llms/selfhosted/identity-providers/advanced/authentik.md)
- [Keycloak SSO with NetBird Self-Hosted (Advanced)](https://docs.netbird.io/llms/selfhosted/identity-providers/advanced/keycloak.md)
- [PocketID SSO with NetBird Self-Hosted (Advanced)](https://docs.netbird.io/llms/selfhosted/identity-providers/advanced/pocketid.md)
- [Zitadel SSO with NetBird Self-Hosted (Advanced)](https://docs.netbird.io/llms/selfhosted/identity-providers/advanced/zitadel.md)
- [Authentik with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/authentik.md)
- [Disable Local Authentication](https://docs.netbird.io/llms/selfhosted/identity-providers/disable-local-authentication.md)
- [Enable MFA for local users](https://docs.netbird.io/llms/selfhosted/identity-providers/enable-local-mfa.md)
- [Generic OIDC Provider with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/generic-oidc.md)
- [Authentication and Identity Providers (IdPs)](https://docs.netbird.io/llms/selfhosted/identity-providers.md)
- [Keycloak with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/keycloak.md)
- [Local User Management](https://docs.netbird.io/llms/selfhosted/identity-providers/local.md)
- [Auth0 SSO with NetBird Self-Hosted (Legacy)](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/advanced/auth0.md)
- [Google Workspace SSO with NetBird Self-Hosted (Legacy)](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/advanced/google-workspace.md)
- [JumpCloud SSO with NetBird Self-Hosted (Legacy)](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/advanced/jumpcloud.md)
- [Microsoft and Entra ID SSO with NetBird Self-Hosted (Legacy)](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/advanced/microsoft-entra-id.md)
- [Okta SSO with NetBird Self-Hosted (Legacy)](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/advanced/okta.md)
- [Auth0 SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/auth0.md)
- [Duo SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/duo.md)
- [Google Workspace SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/google-workspace.md)
- [JumpCloud SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/jumpcloud.md)
- [Microsoft and Entra ID SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/microsoft-entra-id.md)
- [Okta SSO with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/managed/okta.md)
- [PocketID with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/pocketid.md)
- [Zitadel with NetBird Self-Hosted](https://docs.netbird.io/llms/selfhosted/identity-providers/zitadel.md)
- [Activity Events MySQL store](https://docs.netbird.io/llms/selfhosted/maintenance/activity-mysql-store.md)
- [Activity Events Postgresql store](https://docs.netbird.io/llms/selfhosted/maintenance/activity-postgres-store.md)
- [Back Up Your Self-Hosted NetBird Installation](https://docs.netbird.io/llms/selfhosted/maintenance/backup.md)
- [Self-Hosted Deployment Configuration Files Reference](https://docs.netbird.io/llms/selfhosted/maintenance/configuration-files.md)
- [CrowdSec IP Reputation](https://docs.netbird.io/llms/selfhosted/maintenance/crowdsec.md)
- [Management Geolocation](https://docs.netbird.io/llms/selfhosted/maintenance/geo-support.md)
- [Management PostgreSQL store](https://docs.netbird.io/llms/selfhosted/maintenance/postgres-store.md)
- [Remove Your Self-Hosted NetBird Installation](https://docs.netbird.io/llms/selfhosted/maintenance/remove.md)
- [Migrate from SQLite to PostgreSQL](https://docs.netbird.io/llms/selfhosted/maintenance/scaling/migrate-sqlite-to-postgresql.md)
- [Running Multiple Proxy Instances](https://docs.netbird.io/llms/selfhosted/maintenance/scaling/multiple-proxy-instances.md)
- [Splitting Your Self-Hosted Deployment](https://docs.netbird.io/llms/selfhosted/maintenance/scaling/scaling-your-self-hosted-deployment.md)
- [Set Up External Relay Servers](https://docs.netbird.io/llms/selfhosted/maintenance/scaling/set-up-external-relays.md)
- [Set Up External Signal Server](https://docs.netbird.io/llms/selfhosted/maintenance/scaling/set-up-external-signal.md)
- [Management SQLite store](https://docs.netbird.io/llms/selfhosted/maintenance/sqlite-store.md)
- [Upgrade Your Self-Hosted NetBird Installation](https://docs.netbird.io/llms/selfhosted/maintenance/upgrade.md)
- [VPS Marketplaces](https://docs.netbird.io/llms/selfhosted/marketplaces.md)
- [Deploy NetBird on Vultr](https://docs.netbird.io/llms/selfhosted/marketplaces/vultr.md)
- [Migration Guide: Combined Container Setup](https://docs.netbird.io/llms/selfhosted/migration/combined-container.md)
- [Migration Guide: From Coturn to Embedded STUN Server](https://docs.netbird.io/llms/selfhosted/migration/coturn-to-stun-migration.md)
- [Migration Guide: Enable Reverse Proxy Feature](https://docs.netbird.io/llms/selfhosted/migration/enable-reverse-proxy.md)
- [Migration Guide: External IdP to Embedded IdP](https://docs.netbird.io/llms/selfhosted/migration/external-to-embedded-idp.md)
- [Combined deployment metrics](https://docs.netbird.io/llms/selfhosted/observability/combined.md)
- [Grafana dashboards](https://docs.netbird.io/llms/selfhosted/observability/dashboards.md)
- [Observability](https://docs.netbird.io/llms/selfhosted/observability.md)
- [Management metrics](https://docs.netbird.io/llms/selfhosted/observability/management.md)
- [Proxy metrics](https://docs.netbird.io/llms/selfhosted/observability/proxy.md)
- [Relay metrics](https://docs.netbird.io/llms/selfhosted/observability/relay.md)
- [Signal metrics](https://docs.netbird.io/llms/selfhosted/observability/signal.md)
- [Advanced guide](https://docs.netbird.io/llms/selfhosted/selfhosted-guide.md)
- [Self-Hosting Quickstart Guide (5 min)](https://docs.netbird.io/llms/selfhosted/selfhosted-quickstart.md)
- [Troubleshooting](https://docs.netbird.io/llms/selfhosted/troubleshooting.md)

### Use Cases

- [Examples](https://docs.netbird.io/llms/use-cases/cloud/aws-ecs-terraform.md)
- [Open Source Distributed AI Stack: ArgoCD, MicroK8s, vLLM, and NetBird](https://docs.netbird.io/llms/use-cases/cloud/distributed-multi-cloud-ai.md)
- [Cloud Use Cases](https://docs.netbird.io/llms/use-cases/cloud.md)
- [Running NetBird on serverless environments (FaaS)](https://docs.netbird.io/llms/use-cases/cloud/netbird-on-faas.md)
- [Deploy routing peers to a Kubernetes cluster](https://docs.netbird.io/llms/use-cases/cloud/routing-peers-and-kubernetes.md)
- [NetBird client on MikroTik router](https://docs.netbird.io/llms/use-cases/homelab/client-on-mikrotik-router.md)
- [Homelab Use Cases](https://docs.netbird.io/llms/use-cases/homelab.md)
- [Use Cases](https://docs.netbird.io/llms/use-cases.md)
- [Implementing Zero Trust with NetBird](https://docs.netbird.io/llms/use-cases/security/implement-zero-trust.md)
- [Security Use Cases](https://docs.netbird.io/llms/use-cases/security.md)
- [Site-to-Site Connectivity](https://docs.netbird.io/llms/use-cases/site-to-site.md)

---

## Usage

LLMs can fetch individual markdown files to get detailed information about specific topics.
Each markdown file contains the clean documentation content with a link back to the original page.

Generated: 2026-06-19T21:22:29.546Z