You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/selfhosted/identity-providers/connectors.mdx
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,16 @@
1
-
# Identity Provider Connectors
1
+
# External Identity Providers
2
2
3
-
When using the [embedded IdP](/selfhosted/identity-providers/embedded-idp), you can add identity provider **connectors** to enable Single Sign-On (SSO). This allows users to sign in with their existing accounts from services like Google, Microsoft, or your corporate identity provider—while still maintaining the simplicity of the embedded IdP.
3
+
NetBird supports connecting **multiple external identity providers** alongside local user management. This allows users to sign in with their existing accounts from services like Google, Microsoft, or your corporate identity provider—while still maintaining the option for local username/password authentication.
4
4
5
-
## Why Use Connectors?
5
+
## Why Add External Identity Providers?
6
6
7
-
Connectors provide:
7
+
External identity providers give you:
8
8
9
9
-**Single Sign-On (SSO)** - Users authenticate with familiar credentials
10
+
-**Multiple providers** - Configure as many OIDC-compatible providers as you need
10
11
-**Federation** - Multiple identity sources, single NetBird account
11
12
-**Flexibility** - Mix local users with SSO authentication
12
-
-**Gradual adoption** - Start with local users, add SSO later
13
+
-**Gradual adoption** - Start with local users, add SSO providers later
|[**Generic OIDC**](/selfhosted/identity-providers/generic-oidc)|`oidc`| Any OIDC-compliant provider |
26
27
27
-
## Adding a Connector
28
+
## Adding an Identity Provider
28
29
29
30
### Via Dashboard
30
31
@@ -36,7 +37,7 @@ Connectors provide:
36
37
6. Copy the **Redirect URL** and configure it in your identity provider
37
38
38
39
<Note>
39
-
The Identity Providers tab is only visible when the embedded IdP is enabled.
40
+
The Identity Providers tab is only visible when local user management is enabled (default for new installations).
40
41
</Note>
41
42
42
43
### Via API
@@ -82,33 +83,35 @@ Some providers also require:
82
83
83
84
Users who authenticate via a connector appear in your Users list with a badge showing their identity provider.
84
85
85
-
## Multiple Connectors
86
+
## Multiple Identity Providers
86
87
87
-
You can configure multiple connectors simultaneously:
88
+
You can configure **multiple identity providers simultaneously**:
88
89
89
-
- All enabled providers appear as buttons on the login page
90
-
- "Continue with Email" (local authentication) is always available
90
+
- All configured providers appear as buttons on the login page
91
+
- "Continue with Email" (local authentication) is always available first
91
92
- Users can authenticate with any configured provider
92
93
- Each user's provider is tracked and displayed in the Dashboard
93
94
95
+
This allows you to support different authentication methods for different user groups—for example, Google for contractors and Microsoft Entra ID for employees.
96
+
94
97
## Best Practices
95
98
96
-
1.**Start simple** - Begin with local users, add connectors as needed
97
-
2.**Test thoroughly** - Verify the connector works before announcing to users
99
+
1.**Start simple** - Begin with local users, add external providers as needed
100
+
2.**Test thoroughly** - Verify the provider works before announcing to users
98
101
3.**Communicate changes** - Let users know about new login options
99
-
4.**Keep a fallback** - Local authentication remains available if a connector has issues
102
+
4.**Keep a fallback** - Local authentication remains available if an external provider has issues
100
103
101
104
## Troubleshooting
102
105
103
106
### Provider not appearing on login page
104
107
105
-
- Verify the connector was saved successfully in Settings → Identity Providers
106
-
- Check that the connector is enabled
108
+
- Verify the provider was saved successfully in Settings → Identity Providers
109
+
- Check that the provider is enabled
107
110
- Clear browser cache and reload the login page
108
111
109
112
### "Invalid redirect URI" error
110
113
111
-
- Copy the exact Redirect URL from NetBird after creating the connector
114
+
- Copy the exact Redirect URL from NetBird after creating the provider
Copy file name to clipboardExpand all lines: src/pages/selfhosted/identity-providers/embedded-idp.mdx
+31-27Lines changed: 31 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,51 +1,53 @@
1
-
# Embedded Identity Provider
1
+
# Local User Management
2
2
3
-
The embedded identity provider is NetBird's built-in authentication system, powered by [Dex](https://dexidp.io/). It runs directly within the Management service, eliminating the need for external IdP containers or complex configuration.
3
+
NetBird's Management service includes built-in user management, allowing you to create and manage local users directly without requiring an external identity provider. This functionality is powered by an embedded [Dex](https://dexidp.io/) server.
4
4
5
5
## Overview
6
6
7
-
The embedded IdP provides:
7
+
The Management service provides:
8
8
9
9
-**Local user management** - Create users with email/password authentication directly in NetBird
Compare this to the external IdP architecture which requires separate containers for the IdP and its database.
@@ -94,7 +96,7 @@ openssl rand -base64 32
94
96
```
95
97
96
98
<Note>
97
-
**Warning:**Store your encryption key securely. If lost, encrypted user data (emails, names) cannot be recovered. Include it in your backup procedures.
99
+
Store your encryption key securely. If lost, encrypted user data (emails, names) cannot be recovered. Include it in your backup procedures.
98
100
</Note>
99
101
100
102
## User Management
@@ -117,7 +119,7 @@ After creation, a modal displays with:
117
119
-**Copy & Close** button to copy password and dismiss
118
120
119
121
<Note>
120
-
**Warning:**The generated password is only shown once at creation time. It cannot be retrieved later. Make sure to copy it and share it securely with the user.
122
+
The generated password is only shown once at creation time. It cannot be retrieved later. Make sure to copy it and share it securely with the user.
121
123
</Note>
122
124
123
125
### User IdP Badges
@@ -213,9 +215,9 @@ curl -X POST "https://netbird.example.com/api/instance/setup" \
213
215
}
214
216
```
215
217
216
-
## Adding Identity Provider Connectors
218
+
## Adding External Identity Providers
217
219
218
-
The embedded IdP supports adding identity provider [**connectors**](/selfhosted/identity-providers/connectors) to enable SSO. This allows users to sign in with existing accounts from:
220
+
You can connect one or more external identityproviders to enable SSO alongside local users. This allows users to sign in with existing accounts from:
**Multiple providers supported**: You can configure as many OIDC-compatible identity providers as you need. Users will see all configured providers as login options alongside the local email/password option.
231
+
232
+
### Managing External IdPs via Dashboard
229
233
230
234
1. Navigate to **Settings** → **Identity Providers**
231
235
2. Click **Add Identity Provider**
@@ -404,5 +408,5 @@ To switch from embedded IdP to an external IdP:
404
408
4. Users will need to re-authenticate with the new IdP
405
409
406
410
<Note>
407
-
**Warning:**Disabling the embedded IdP will invalidate all local user accounts. Ensure users have accounts in the external IdP before switching.
411
+
Disabling the embedded IdP will invalidate all local user accounts. Ensure users have accounts in the external IdP before switching.
Copy file name to clipboardExpand all lines: src/pages/selfhosted/identity-providers/index.mdx
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,20 @@
2
2
3
3
NetBird's self-hosted implementation uses the OpenID Connect (OIDC) protocol for authentication, an industry-standard identity layer built on top of OAuth 2.0. OIDC is used both for user authentication to access the Management Service Dashboard and for user device authorization when accessing internal resources.
4
4
5
-
## Embedded IdP (Recommended)
5
+
## Local User Management
6
6
7
-
Starting with version X.XX, NetBird includes a **built-in identity provider** powered by [Dex](https://dexidp.io/). This is now the default for new deployments and eliminates the need for separate IdP infrastructure.
7
+
Starting with version X.XX, NetBird **no longer requires an external identity provider**. The Management service now supports creating and managing local users directly, so you can get started without setting up Zitadel, Keycloak, or any other IdP.
8
8
9
-
With the embedded IdP, you can:
9
+
With local user management, you can:
10
10
11
11
-**Create local users** directly from the NetBird Dashboard
12
-
-**Add SSO connectors** (Google, Microsoft, Okta, etc.) through the Dashboard UI
12
+
-**Add external identity providers** (Google, Microsoft, Okta, etc.) through the Dashboard UI
13
+
-**Configure multiple IdPs** simultaneously—users see all providers as login options
13
14
-**Simplify your deployment** with fewer containers and reduced resource requirements
14
-
-**Get started faster** with automatic configuration and no additional setup
15
+
-**Get started faster** with no additional IdP setup required
15
16
16
17
<Note>
17
-
The embedded IdP uses [Dex](https://dexidp.io/), a lightweight, portable OIDC identity provider that supports federated authentication. Dex runs embedded within the NetBird Management service, requiring no additional containers or databases.
18
+
Local user management is powered by an embedded [Dex](https://dexidp.io/) server running within the NetBird Management service, requiring no additional containers or databases.
18
19
</Note>
19
20
20
21
[Get Started →](/selfhosted/selfhosted-quickstart)
@@ -35,11 +36,11 @@ This approach provides several key benefits:
@@ -76,7 +78,7 @@ For organizations with specific requirements or existing IdP investments:
76
78
77
79
## Identity Provider Options
78
80
79
-
Each provider page includes both **connector setup** (recommended, for use with embedded IdP) and **standalone setup** (advanced) instructions.
81
+
Each provider page includes both **connector setup** (recommended, for adding to local user management) and **standalone setup** (advanced) instructions.
80
82
81
83
### Self-Hosted Providers
82
84
@@ -109,12 +111,11 @@ In addition to OIDC-based authentication, NetBird supports provisioning users an
109
111
110
112
## Migration Guide
111
113
112
-
If you have an existing NetBird deployment using a standalone IdP (like Zitadel from the previous quickstart), you can continue using it. To migrate to the embedded IdP:
114
+
If you have an existing NetBird deployment using a standalone IdP (like Zitadel from the previous quickstart), you have several options:
113
115
114
-
1.ExportyouruserlistfromyourcurrentIdP
115
-
2. Deploy the new version with embedded IdP enabled
116
-
3. Recreate users through the Dashboard or API
117
-
4. (Optional) Add your previous IdP as a connector for SSO
116
+
1.**Keep using your standalone IdP** - No changes required, your setup continues to work
117
+
2.**Add your IdP as an external provider** - Keep your IdP but add it as an OIDC provider alongside local users
118
+
3.**Migrate to local users** - Export users from your IdP and recreate them as local users
118
119
119
120
<Note>
120
121
User data and network configurations are preserved during migration. Only authentication changes—users may need to re-authenticate after the switch.
Copy file name to clipboardExpand all lines: src/pages/selfhosted/self-hosted-vs-cloud-netbird.mdx
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,16 @@ peer-to-peer connectivity, fallback relayed connections through a network of geo
18
18
and overall system reliability and availability. It is not an easy task to deploy and maintain such infrastructure in
19
19
a reliable manner. NetBird is not just one VPN server. You can read more about how NetBird works [here](/about-netbird/how-netbird-works).
20
20
21
-
## What's New: Simplified Self-Hosting
21
+
## What's New: No External IdP Required
22
22
23
-
Starting with version X.XX, self-hosting NetBird has become significantly easier with the introduction of the **embedded identity provider**. Previously, self-hosting required setting up and maintaining a separate identity provider (like Zitadel, Keycloak, or Auth0). Now, NetBird includes a built-in IdP powered by [Dex](https://dexidp.io/), which means:
23
+
Starting with version X.XX, 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:
24
24
25
+
-**No external IdP required** - Create and manage users directly in NetBird
25
26
-**Fewer containers** to deploy and maintain (4-5 vs 7+ previously)
26
27
-**Lower resource requirements** (~1GB RAM vs 2-4GB previously)
27
-
-**No external IdP configuration** required
28
28
-**User management directly in the Dashboard**
29
-
-**Optional SSO connectors** if you want to integrate with Google, Microsoft, Okta, etc.
29
+
-**Optional external IdPs** - Connect Google, Microsoft, Okta, etc. if you want SSO
This makes self-hosting a more viable option for homelabs, small teams, and proof-of-concept deployments.
32
33
@@ -37,7 +38,7 @@ machines to establish direct point-to-point connections and for network administ
37
38
e.g., control network access.
38
39
39
40
When running the self-hosted version, you are responsible for installing and maintaining all the components as well as backing up
40
-
and securing the data. With the new embedded IdP, this burden is reduced—you no longer need to maintain a separate identity provider infrastructure.
41
+
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.
41
42
42
43
The cloud-hosted NetBird only requires you to install the client software (NetBird agent) on your machines and log them in to the network.
43
44
The cloud-hosted version is more suitable for organizations that want a hassle-free solution that is easy to set up and maintain.
@@ -78,9 +79,10 @@ your critical network infrastructure.
78
79
79
80
| Aspect | Self-Hosted | Cloud-Hosted |
80
81
|--------|-------------|--------------|
81
-
|**Setup time**|~5 minutes with embedded IdP| Instant |
82
+
|**Setup time**|~5 minutes with local users| Instant |
82
83
|**Infrastructure**| You manage | We manage |
83
-
|**Identity provider**| Built-in (or bring your own) | Managed |
0 commit comments