# NetBird

## Docs

- [Authentication](https://mintlify.wiki/netbirdio/netbird/api/authentication.md): Authenticate with the NetBird API using Personal Access Tokens
- [DNS API](https://mintlify.wiki/netbirdio/netbird/api/dns.md): Configure DNS nameservers and custom zones
- [Events API](https://mintlify.wiki/netbirdio/netbird/api/events.md): View audit logs and activity events
- [Groups API](https://mintlify.wiki/netbirdio/netbird/api/groups.md): Organize peers and users into groups
- [API Overview](https://mintlify.wiki/netbirdio/netbird/api/overview.md): Introduction to the NetBird REST API
- [Peers API](https://mintlify.wiki/netbirdio/netbird/api/peers.md): Manage network peers and devices
- [Policies API](https://mintlify.wiki/netbirdio/netbird/api/policies.md): Configure access control policies and network rules
- [Routes API](https://mintlify.wiki/netbirdio/netbird/api/routes.md): Manage network routes and exit nodes
- [Setup Keys API](https://mintlify.wiki/netbirdio/netbird/api/setup-keys.md): Generate and manage setup keys for peer enrollment
- [Users API](https://mintlify.wiki/netbirdio/netbird/api/users.md): Manage users and service accounts
- [Components](https://mintlify.wiki/netbirdio/netbird/architecture/components.md): Detailed breakdown of NetBird's architectural components and their responsibilities
- [How It Works](https://mintlify.wiki/netbirdio/netbird/architecture/how-it-works.md): Detailed explanation of NetBird's connection flow, NAT traversal, and peer discovery
- [Architecture Overview](https://mintlify.wiki/netbirdio/netbird/architecture/overview.md): High-level architecture and design principles of NetBird
- [netbird down](https://mintlify.wiki/netbirdio/netbird/cli/down.md): Disconnect from the NetBird network
- [netbird login](https://mintlify.wiki/netbirdio/netbird/cli/login.md): Authenticate with the NetBird management server
- [CLI Overview](https://mintlify.wiki/netbirdio/netbird/cli/overview.md): NetBird command-line interface reference
- [netbird networks (routes)](https://mintlify.wiki/netbirdio/netbird/cli/routes.md): Manage NetBird network routes and resources
- [netbird service](https://mintlify.wiki/netbirdio/netbird/cli/service.md): Manage the NetBird daemon service
- [netbird status](https://mintlify.wiki/netbirdio/netbird/cli/status.md): Display NetBird connection status and peer information
- [netbird up](https://mintlify.wiki/netbirdio/netbird/cli/up.md): Connect to the NetBird network
- [Docker Client](https://mintlify.wiki/netbirdio/netbird/clients/docker.md): Run NetBird in Docker containers
- [Linux Client](https://mintlify.wiki/netbirdio/netbird/clients/linux.md): Install and configure NetBird on Linux systems
- [macOS Client](https://mintlify.wiki/netbirdio/netbird/clients/macos.md): Install and configure NetBird on macOS
- [Mobile Clients (iOS & Android)](https://mintlify.wiki/netbirdio/netbird/clients/mobile.md): Install and configure NetBird on mobile devices
- [Windows Client](https://mintlify.wiki/netbirdio/netbird/clients/windows.md): Install and configure NetBird on Windows
- [NetBird Cloud vs Self-Hosted](https://mintlify.wiki/netbirdio/netbird/deployment/cloud.md): Compare NetBird Cloud and self-hosted deployment options to choose the right solution
- [Docker Compose Deployment](https://mintlify.wiki/netbirdio/netbird/deployment/docker-compose.md): Deploy NetBird using Docker Compose with the automated getting-started script
- [Kubernetes Deployment](https://mintlify.wiki/netbirdio/netbird/deployment/kubernetes.md): Deploy NetBird on Kubernetes clusters with custom manifests
- [Self-Hosted Overview](https://mintlify.wiki/netbirdio/netbird/deployment/self-hosted.md): Requirements and overview for self-hosting NetBird infrastructure
- [Installation](https://mintlify.wiki/netbirdio/netbird/installation.md): Install NetBird on Linux, macOS, Windows, Docker, and other platforms
- [What is NetBird?](https://mintlify.wiki/netbirdio/netbird/introduction.md): Learn about NetBird's peer-to-peer WireGuard VPN platform for secure network connectivity
- [Access Control](https://mintlify.wiki/netbirdio/netbird/network/access-control.md): Understanding NetBird's zero-trust access control model
- [DNS](https://mintlify.wiki/netbirdio/netbird/network/dns.md): Configure private DNS resolution in your NetBird network
- [Groups](https://mintlify.wiki/netbirdio/netbird/network/groups.md): Organize peers and users with NetBird groups
- [Policies](https://mintlify.wiki/netbirdio/netbird/network/policies.md): Define network access rules with NetBird policies
- [Routes](https://mintlify.wiki/netbirdio/netbird/network/routes.md): Configure network routing to access external networks through NetBird
- [Logging](https://mintlify.wiki/netbirdio/netbird/operations/logging.md): Configure and access NetBird logs for troubleshooting and auditing
- [Monitoring](https://mintlify.wiki/netbirdio/netbird/operations/monitoring.md): Monitor NetBird infrastructure with Prometheus metrics and health checks
- [Troubleshooting](https://mintlify.wiki/netbirdio/netbird/operations/troubleshooting.md): Diagnose and resolve common NetBird connectivity and configuration issues
- [Upgrading](https://mintlify.wiki/netbirdio/netbird/operations/upgrading.md): Upgrade NetBird clients and servers with minimal downtime
- [Quickstart](https://mintlify.wiki/netbirdio/netbird/quickstart.md): Get NetBird running in 5 minutes
- [Multi-Factor Authentication (MFA)](https://mintlify.wiki/netbirdio/netbird/security/mfa.md): Enforce multi-factor authentication for enhanced security
- [Posture Checks](https://mintlify.wiki/netbirdio/netbird/security/posture-checks.md): Enforce device security requirements before granting network access
- [Quantum Resistance](https://mintlify.wiki/netbirdio/netbird/security/quantum-resistance.md): Enable post-quantum cryptography with Rosenpass integration
- [SSO Setup](https://mintlify.wiki/netbirdio/netbird/security/sso-setup.md): Configure Single Sign-On with supported identity providers