sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-05-04 00:06:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Streamlined site-to-site docs in new dedicated section. Removed old u… (#585)

Browse Source 
* Streamlined site-to-site docs in new dedicated section. Removed old use-case guide and added redirects

* restructure use-cases, move network use cases to network sections

* Reorganize network routes and networks documentation structure

- Restructure use cases into by-scenario and by-configuration folders
- Reorganize images to match new doc structure (concepts, by-scenario, by-resource-type)
- Add screenshots for site-to-site guides (home, office, cloud)
- Add policy screenshots for networks use cases
- Update site-to-site docs to use two separate policies instead of bidirectional
- Fix Access Control Groups to use correct destination groups
- Move "Self-Hosted vs Cloud" page to about section
- Update navigation and add redirects for moved pages
- Add CLAUDE.md for Claude Code guidance

* cleaned up network docs/image folder structure

* Align site-to-site use case links and redirects

Co-authored-by: Cursor <cursoragent@cursor.com>

* Update CLAUDE.md with accurate project details

Fix Next.js version (14 → 16), add React 19/Tailwind/Pages Router
details, document MDX page conventions, image paths, and note
absence of test suite.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix broken images and hydration error on networks page

- Restore 6 network index images accidentally deleted in 4116092
- Fix keycloak image filename typo (keycloack -> keycloak)
- Fix hydration mismatch by replacing invalid <p><div> nesting with <div>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix 4 broken internal links found in PR review

- Fix missing by-scenario/ segment in site-to-site-home and
  site-to-site-office Tile hrefs (network-routes use-cases index)
- Fix lazy-connections typo to lazy-connection (implement-zero-trust)
- Update stale redirect link to direct path for access-control

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
shuuri-labs
2026-02-13 15:35:44 +01:00
committed by GitHub
parent 2e1c05a655
commit f69c55b9c2
177 changed files with 3761 additions and 2561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/pages/about-netbird/faq.mdx
View File

@@ -16,10 +16,10 @@ all outgoing traffic, and that may affect how NetBird clients connect to the [co
and negotiate the peer-to-peer connections.
<Note>
Allowing the outbound **P2P (STUN)** service below is **recommended** in more restricted networks for reliable peer connections. This will also improve the reliability of your [High Availability Routes](https://docs.netbird.io/manage/network-routes/routing-traffic-to-private-networks#high-availability-routes).
Allowing the outbound **P2P (STUN)** service below is **recommended** in more restricted networks for reliable peer connections. This will also improve the reliability of your [High Availability Routes](https://docs.netbird.io/manage/network-routes#high-availability).
</Note>
<Note>
Allowing the outbound **Relay (TURN)** service below is **recommended** in more restricted networks for reliable peer connections. This will also improve the reliability of your [High Availability Routes](https://docs.netbird.io/manage/network-routes/routing-traffic-to-private-networks#high-availability-routes).
Allowing the outbound **Relay (TURN)** service below is **recommended** in more restricted networks for reliable peer connections. This will also improve the reliability of your [High Availability Routes](https://docs.netbird.io/manage/network-routes#high-availability).
</Note>
<Note>
If using `fail2ban` or similar, you should whitelist each netbird.io endpoint below.

101
src/pages/about-netbird/self-hosted-vs-cloud.mdx Normal file
View File

@@ -0,0 +1,101 @@
# Self-hosted vs. Cloud-hosted NetBird
NetBird can be used in two ways: self-hosted and cloud-hosted (SaaS). The self-hosted version is a standalone version
that can be installed on your own servers while the cloud-hosted version is a SaaS (Software as a Service) that is hosted
on our servers.
Often times, the question arises: what is the difference between the two? This post gives a short overview of the
differences between the two versions.
## Before Choosing to Self-Host NetBird in Production
When we first created NetBird, our goal was to simplify network administration — freeing admins from the headaches of
configuring firewalls, opening ports, managing VPN gateways, handling certificates, and so on. We wanted to provide a
tool that lets teams completely close off their network from the outside world, while still enabling devices to seamlessly
discover and connect to internal resources just by installing the client apps. However, as is often the case with easy-to-use tools,
a lot happens behind the scenes. NetBird relies on a range of interconnected components that work together to ensure secure
peer-to-peer connectivity, fallback relayed connections through a network of geographically distributed relay servers,
and overall system reliability and availability. It is not an easy task to deploy and maintain such infrastructure in
a reliable manner. NetBird is not just one VPN server. You can read more about how NetBird works [here](/about-netbird/how-netbird-works).
## What's New: No External IdP Required
Starting with version 0.62, self-hosting NetBird has become significantly easier. Previously, self-hosting required setting up and maintaining a separate identity provider (like Zitadel, Keycloak, or Auth0). Now, the Management service supports **local user management** directly, which means:
- **No external IdP required** - Create and manage users directly in NetBird
- **Fewer containers** to deploy and maintain (4-5 vs 7+ previously)
- **Lower resource requirements** (~1GB RAM vs 2-4GB previously)
- **User management directly in the Dashboard**
- **Optional external IdPs** - Connect Google, Microsoft, Okta, etc. if you want SSO
- **Multiple IdPs supported** - Configure multiple OIDC providers simultaneously
This makes self-hosting a more viable option for homelabs, small teams, and proof-of-concept deployments.
## Installation and Maintenance
NetBird platform is a combination of [multiple components](/about-netbird/how-netbird-works) that make it possible for
machines to establish direct point-to-point connections and for network administrators to manage the network,
e.g., control network access.
When running the self-hosted version, you are responsible for installing and maintaining all the components as well as backing up
and securing the data. With local user management built into the Management service, this burden is significantly reduced—you no longer need to maintain separate identity provider infrastructure.
The cloud-hosted NetBird only requires you to install the client software (NetBird agent) on your machines and log them in to the network.
The cloud-hosted version is more suitable for organizations that want a hassle-free solution that is easy to set up and maintain.
## Features
While the self-hosted and cloud-hosted versions share the same core connectivity features, the cloud-hosted version has
some additional features that are targeted at business customers and help with network automation and management. These features include:
- **[Users and groups provisioning](/manage/team/idp-sync)** from your identity provider (IdP).
- **[Traffic events logging](/manage/activity/traffic-events-logging)** of connections to internal resources for audit and analysis.
- **[Event streaming](/manage/activity/event-streaming)** to 3rd party platforms and SIEM systems.
- **[Integrations with EDR](/manage/access-control/endpoint-detection-and-response)** like CrowdStrike and others.
- **[Peer approval](/manage/peers/approve-peers)** to join the network.
- **[User invites](/manage/team/add-users-to-your-network#direct-user-invites)**.
- **[MSP functionality](/manage/for-partners/msp-portal)** for managing multiple tenant networks from a single account.
<Note>
SCIM provisioning and some enterprise features require a [Commercial License](https://netbird.io/pricing#on-prem) for self-hosted deployments.
</Note>
## Geo Distributed Relay Servers
NetBird uses relay servers to establish connections between machines when a direct point-to-point connections isn't possible.
When using the cloud-hosted version, you benefit from the geo-distributed relay server clusters that are located in multiple regions
around the world ensuring that your machines can always establish a connection. The NetBird agents pick the closest relay server.
When using the self-hosted version, you need to set up your own relay servers. This a complex task and requires additional
maintenance effort.
## Highly Available Management Layer
When using the cloud-hosted version, you benefit from highly available control plane servers (Management) providing stability for
your critical network infrastructure.
## Quick Comparison
| Aspect | Self-Hosted | Cloud-Hosted |
|--------|-------------|--------------|
| **Setup time** | ~5 minutes with local users | Instant |
| **Infrastructure** | You manage | We manage |
| **Identity provider** | Built-in local users (+ optional external IdPs) | Managed |
| **Multiple IdPs** | Yes, OIDC-compatible | Yes |
| **Relay servers** | Single instance (or DIY geo-distribution) | Geo-distributed globally |
| **High availability** | DIY | Included |
| **SCIM provisioning** | Enterprise license | Included (Business+) |
| **Cost** | Your infrastructure costs | Subscription |
| **Best for** | Homelabs, air-gapped networks, compliance requirements | Teams wanting hassle-free setup |
## Get started
<p float="center" >
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
</p>
- [Self-hosting Quickstart](/selfhosted/selfhosted-quickstart) - Get started with self-hosted NetBird in 5 minutes
- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird)
- Follow us [on X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub