mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-20 20:49:04 +02:00
Align docs with the new dashboard UI (Phase 1) (#778)
* bulk text edit to fit new flows * Updated screenshots, some minor docs fix. (#782) * Update Settings on site-to-site.mdx * fix image names and embedded links * Update high level dia * general dashboard images and auto-update stucture fix * remove temp audit file --------- Co-authored-by: PizzaLovingNerd <cameron@stillhq.io>
This commit is contained in:
Brandon Hopkins
co-authored by
PizzaLovingNerd
PizzaLovingNerd
parent
6107943b50
commit
39303d1c48
@@ -28,7 +28,7 @@ Select your **Microsoft Entra ID** identity provider connector for this integrat
|
||||
|
||||
This will open a pop-up window featuring a user-friendly wizard, guiding you through the synchronization process between NetBird and Azure AD.
|
||||
|
||||
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -46,7 +46,7 @@ To check your permissions:
|
||||
* Expand the `Manage` tab and click on `Roles and administrators` in the left menu.
|
||||
* Look for your username and verify if you're assigned any of the above roles.
|
||||
|
||||
|
||||
|
||||
|
||||
If you don't have the required permissions, contact your Azure AD administrator to grant you the appropriate role before proceeding with the NetBird integration.
|
||||
|
||||
@@ -61,21 +61,21 @@ A new wizard screen will appear, offering step-by-step instructions for creating
|
||||
* Redirect Type
|
||||
* Redirect URI
|
||||
|
||||
|
||||
|
||||
|
||||
For convenience, click on [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) (step 1). That will open the Azure dashboard. Navigate to `App registrations` in the left menu and then click `+New registration` as indicated below:
|
||||
|
||||
|
||||
|
||||
|
||||
Fill in the required information:
|
||||
|
||||
|
||||
|
||||
|
||||
After entering all required information, click the `Register` button at the bottom of the form to finalize the application registration process.
|
||||
|
||||
Upon successful registration, you'll be redirected to a confirmation screen similar to the following:
|
||||
|
||||
|
||||
|
||||
|
||||
Copy and securely store the generated `Application (client) ID` and `Directory (tenant) ID` as you will need them shortly.
|
||||
|
||||
@@ -83,23 +83,23 @@ Copy and securely store the generated `Application (client) ID` and `Directory (
|
||||
|
||||
On the NetBird dashboard click the `Continue →` button. A new wizard screen will appear, this time, offering step-by-step instructions for setting up API permissions.
|
||||
|
||||
|
||||
|
||||
|
||||
Back to Azure, in the `App registrations` screen, click on `Manage` in the left menu to expand it and then click on `API permissions`:
|
||||
|
||||
|
||||
|
||||
|
||||
Look for the `+ Add a permission` button, located near the top of the permissions list and click on it.
|
||||
|
||||
|
||||
|
||||
|
||||
A new pop-up window will appear, asking you to select an API. Click on `Microsoft Graph`.
|
||||
|
||||
|
||||
|
||||
|
||||
On the next screen, click on the `Application permissions` button, which will let you select the appropriate permissions for NetBird to function correctly with your Microsoft Entra ID environment.
|
||||
|
||||
|
||||
|
||||
|
||||
To assign user permissions:
|
||||
|
||||
@@ -107,17 +107,17 @@ To assign user permissions:
|
||||
* In the search results, click on the `User` tab to expand it and view the available permissions.
|
||||
* Click on the checkbox to select and enable the `User.Read.All` permission.
|
||||
|
||||
|
||||
|
||||
|
||||
The `User.Read.All` permission allows NetBird to read the full set of profile properties, group memberships, and reports of the signed-in user and other users in your organization.
|
||||
|
||||
Next, repeat the procedure. This time, search for `Group.Read.All` and click on the checkbox to enable it as shown below:
|
||||
|
||||
|
||||
|
||||
|
||||
Once done, click the `Add permissions` button. You will see a few warnings:
|
||||
|
||||
|
||||
|
||||
|
||||
Locate the `Grant admin consent for [Your Organization Name]` button (you'll find it next to `+Add a permission` button). Click on it to grant the required permissions.
|
||||
|
||||
@@ -125,21 +125,21 @@ A confirmation dialog will appear, asking you to verify this action. Review the
|
||||
|
||||
Once finished, the status of the permissions should change to `Granted for [Your Organization Name]`. Verify that all selected permissions now show a green checkmark, indicating they've been successfully granted:
|
||||
|
||||
|
||||
|
||||
|
||||
## Create a Client Secret for Secure NetBird-Entra ID Authentication
|
||||
|
||||
Back to the NetBird dashboard, click the `Continue →` button. A new wizard screen will appear, showing instructions for generating a client secret in Entra ID.
|
||||
|
||||
|
||||
|
||||
|
||||
On Azure, click on the `Certificates & secrets` button in the left menu to open the management page. Click on `+New client secret` as shown below. Choose an expiration time that suits your security needs and click the `Add` button.
|
||||
|
||||
|
||||
|
||||
|
||||
A new client secret will be generated and displayed on the screen. Copy and securely store the `Value` field immediately, as you will needed in the next step.
|
||||
|
||||
|
||||
|
||||
|
||||
## Enter Application ID and Directory ID in NetBird
|
||||
|
||||
@@ -147,7 +147,7 @@ Paste the secret `Value` from the previous step into NetBird and click the `Cont
|
||||
|
||||
Paste the values and click the `Continue →` button.
|
||||
|
||||
|
||||
|
||||
|
||||
## Choose Groups to Synchronize from Entra ID
|
||||
At this stage, NetBird is set to synchronize all groups from your Microsoft Entra ID by default. You have two options:
|
||||
@@ -155,7 +155,7 @@ At this stage, NetBird is set to synchronize all groups from your Microsoft Entr
|
||||
* If you want to synchronize all groups, simply click the `Continue →` button.
|
||||
* To synchronize only specific groups, click the `+ Add group filter` button, which will open a new panel where you can set criteria to include or exclude groups.
|
||||
|
||||
|
||||
|
||||
|
||||
## Choose Users to Synchronize from Entra ID
|
||||
After configuring group synchronization, you'll now set up user synchronization. Similar than before, NetBird is configured to synchronize all users from your Microsoft Entra ID by default.
|
||||
@@ -167,7 +167,7 @@ After configuring group synchronization, you'll now set up user synchronization.
|
||||
You can modify these synchronization settings later if necessary.
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
|
||||
After configuring user and group synchronization, the setup wizard will finalize the process and you'll automatically return to the main Identity Provider screen.
|
||||
|
||||
@@ -186,7 +186,7 @@ These indicators confirm that:
|
||||
You can manually trigger a sync or adjust settings by clicking on the Microsoft Entra ID section in the Identity Provider screen
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
|
||||
## Verify the Integration
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ To get started, navigate to [Integrations](https://app.netbird.io/integrations)
|
||||
`Identity Provider` integration. Click the `Entra ID (Azure AD)` button. This action will trigger a pop-up window that will
|
||||
present you with a user-friendly wizard, guiding you through the synchronization process between NetBird and Azure AD.
|
||||
|
||||
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -43,7 +43,7 @@ To check your permissions:
|
||||
* Expand the `Manage` tab and click on `Roles and administrators` in the left menu.
|
||||
* Look for your username and verify if you're assigned any of the above roles.
|
||||
|
||||
|
||||
|
||||
|
||||
If you don't have the required permissions, contact your Azure AD administrator to grant you the appropriate role before proceeding with the NetBird integration.
|
||||
|
||||
@@ -58,21 +58,21 @@ A new wizard screen will appear, offering step-by-step instructions for creating
|
||||
* Redirect Type
|
||||
* Redirect URI
|
||||
|
||||
|
||||
|
||||
|
||||
For convenience, click on [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) (step 1). That will open the Azure dashboard. Navigate to `App registrations` in the left menu and then click `+New registration` as indicated below:
|
||||
|
||||
|
||||
|
||||
|
||||
Fill in the required information:
|
||||
|
||||
|
||||
|
||||
|
||||
After entering all required information, click the `Register` button at the bottom of the form to finalize the application registration process.
|
||||
|
||||
Upon successful registration, you'll be redirected to a confirmation screen similar to the following:
|
||||
|
||||
|
||||
|
||||
|
||||
Copy and securely store the generated `Application (client) ID` and `Directory (tenant) ID` as you will need them shortly.
|
||||
|
||||
@@ -80,23 +80,23 @@ Copy and securely store the generated `Application (client) ID` and `Directory (
|
||||
|
||||
On the NetBird dashboard click the `Continue →` button. A new wizard screen will appear, this time, offering step-by-step instructions for setting up API permissions.
|
||||
|
||||
|
||||
|
||||
|
||||
Back to Azure, in the `App registrations` screen, click on `Manage` in the left menu to expand it and then click on `API permissions`:
|
||||
|
||||
|
||||
|
||||
|
||||
Look for the `+ Add a permission` button, located near the top of the permissions list and click on it.
|
||||
|
||||
|
||||
|
||||
|
||||
A new pop-up window will appear, asking you to select an API. Click on `Microsoft Graph`.
|
||||
|
||||
|
||||
|
||||
|
||||
On the next screen, click on the `Application permissions` button, which will let you select the appropriate permissions for NetBird to function correctly with your Microsoft Entra ID environment.
|
||||
|
||||
|
||||
|
||||
|
||||
To assign user permissions:
|
||||
|
||||
@@ -104,17 +104,17 @@ To assign user permissions:
|
||||
* In the search results, click on the `User` tab to expand it and view the available permissions.
|
||||
* Click on the checkbox to select and enable the `User.Read.All` permission.
|
||||
|
||||
|
||||
|
||||
|
||||
The `User.Read.All` permission allows NetBird to read the full set of profile properties, group memberships, and reports of the signed-in user and other users in your organization.
|
||||
|
||||
Next, repeat the procedure. This time, search for `Group.Read.All` and click on the checkbox to enable it as shown below:
|
||||
|
||||
|
||||
|
||||
|
||||
Once done, click the `Add permissions` button. You will see a few warnings:
|
||||
|
||||
|
||||
|
||||
|
||||
Locate the `Grant admin consent for [Your Organization Name]` button (you’ll find it next to `+Add a permission` button). Click on it to grant the required permissions.
|
||||
|
||||
@@ -122,21 +122,21 @@ A confirmation dialog will appear, asking you to verify this action. Review the
|
||||
|
||||
Once finished, the status of the permissions should change to `Granted for [Your Organization Name]`. Verify that all selected permissions now show a green checkmark, indicating they've been successfully granted:
|
||||
|
||||
|
||||
|
||||
|
||||
## Create a Client Secret for Secure NetBird-Entra ID Authentication
|
||||
|
||||
Back to the NetBird dashboard, click the `Continue →` button. A new wizard screen will appear, showing instructions for generating a client secret in Entra ID.
|
||||
|
||||
|
||||
|
||||
|
||||
On Azure, click on the `Certificates & secrets` button in the left menu to open the management page. Click on `+New client secret` as shown below. Choose an expiration time that suits your security needs and click the `Add` button.
|
||||
|
||||
|
||||
|
||||
|
||||
A new client secret will be generated and displayed on the screen. Copy and securely store the `Value` field immediately, as you will needed in the next step.
|
||||
|
||||
|
||||
|
||||
|
||||
## Enter Application ID and Directory ID in NetBird
|
||||
|
||||
@@ -144,7 +144,7 @@ Paste the secret `Value` from the previous step into NetBird and click the `Cont
|
||||
|
||||
Paste the values and click the `Continue →` button.
|
||||
|
||||
|
||||
|
||||
|
||||
## Choose Groups to Synchronize from Entra ID
|
||||
At this stage, NetBird is set to synchronize all groups from your Microsoft Entra ID by default. You have two options:
|
||||
@@ -152,7 +152,7 @@ At this stage, NetBird is set to synchronize all groups from your Microsoft Entr
|
||||
* If you want to synchronize all groups, simply click the `Continue →` button.
|
||||
* To synchronize only specific groups, click the `+ Add group filter` button, which will open a new panel where you can set criteria to include or exclude groups.
|
||||
|
||||
|
||||
|
||||
|
||||
## Choose Users to Synchronize from Entra ID
|
||||
After configuring group synchronization, you'll now set up user synchronization. Similar than before, NetBird is configured to synchronize all users from your Microsoft Entra ID by default.
|
||||
@@ -164,7 +164,7 @@ After configuring group synchronization, you'll now set up user synchronization.
|
||||
You can modify these synchronization settings later if necessary.
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
|
||||
After configuring user and group synchronization, the setup wizard will finalize the process and you'll automatically return to the main Identity Provider screen.
|
||||
|
||||
@@ -183,7 +183,7 @@ These indicators confirm that:
|
||||
You can manually trigger a sync or adjust settings by clicking on the Microsoft Entra ID section in the Identity Provider screen
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
|
||||
## Verify the Integration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user