diff --git a/src/pages/how-to/access-netbird-public-api.mdx b/src/pages/how-to/access-netbird-public-api.mdx index daa42f7d..681956ec 100644 --- a/src/pages/how-to/access-netbird-public-api.mdx +++ b/src/pages/how-to/access-netbird-public-api.mdx @@ -22,14 +22,14 @@ The most common usage scenarios: To create a service user, you'll need to log in to your organization's account at https://app.netbird.io and navigate to the "Users" -> "Service Users" section of your account.

- service-user-overview + service-user-overview

From there, you can create a new service user and specify a role that the user should have. User role allows read-only access, use the admin for write access.

- service-user-creation-popup + service-user-creation-popup

@@ -41,20 +41,20 @@ User role allows read-only access, use the admin for write access. To create an access token, you'll need to log in to your account and navigate to the "Users" section and look for your user or create a [service user](#service-users) to use for your API requests.

- personal-access-token-overview + personal-access-token-overview

From there, you can create a new token and specify expiration for the token. You won't be able to modify your token.

- personal-access-creation-popup + personal-access-creation-popup

After the token was generated successfully you will see a plain version of your token to copy and store in a secure place. Be aware that once you close the popup it is impossible to see the plain version of the token again as NetBird only stores a hashed version of the token.

- personal-access-token-example + personal-access-token-example

diff --git a/src/pages/how-to/add-machines-to-your-network.mdx b/src/pages/how-to/add-machines-to-your-network.mdx index 15f1d8e0..9927bef5 100644 --- a/src/pages/how-to/add-machines-to-your-network.mdx +++ b/src/pages/how-to/add-machines-to-your-network.mdx @@ -15,19 +15,19 @@ To add a new peer to your network follow these steps: 2. Hit `Add new peer` button

- high-level-dia + high-level-dia

3. Follow the instructions

- high-level-dia + high-level-dia

4. Refresh the Peers tab, and it will display new machines

- high-level-dia + high-level-dia

diff --git a/src/pages/how-to/add-users-to-your-network.mdx b/src/pages/how-to/add-users-to-your-network.mdx index 92213958..8eff4cae 100644 --- a/src/pages/how-to/add-users-to-your-network.mdx +++ b/src/pages/how-to/add-users-to-your-network.mdx @@ -34,7 +34,7 @@ The invited users will receive an email invitation that they have to confirm. After logging in to the system, they will join your network automatically.

- high-level-dia + high-level-dia

diff --git a/src/pages/how-to/enforce-periodic-user-authentication.mdx b/src/pages/how-to/enforce-periodic-user-authentication.mdx index 5831c9fc..dbab1498 100644 --- a/src/pages/how-to/enforce-periodic-user-authentication.mdx +++ b/src/pages/how-to/enforce-periodic-user-authentication.mdx @@ -11,7 +11,7 @@ Every new network has this feature enabled, and the expiration period is set to Expired peers will appear in the peers' view with the status `needs login`.

- peer-needs-login.png + peer-needs-login.png

## Configure and disable expiration @@ -20,7 +20,7 @@ Go to the Web UI Settings tab and set the desired period in the Authentication s You can also disable the expiration for the whole network in the same section.

- peer-login-expiration + peer-login-expiration

@@ -36,7 +36,7 @@ In the Peers tab of the web UI click on the peer you want to disable expiration Peers with `expiration disabled` will be marked with a corresponding label in the peers' table.

- peer-login-expiration + peer-login-expiration

## Get started diff --git a/src/pages/how-to/getting-started.mdx b/src/pages/how-to/getting-started.mdx index d85385df..daf3818a 100644 --- a/src/pages/how-to/getting-started.mdx +++ b/src/pages/how-to/getting-started.mdx @@ -6,7 +6,7 @@ export const title = 'Getting Started' Step-by-step video guide on YouTube: -
+

@@ -20,7 +20,7 @@ Both machines are running Linux but NetBird also works on Windows, MacOS nad pop You can use your Google, GitHub or Microsoft account.

- login-to-netbird + login-to-netbird

2. After a successful login you will be redirected to the ```Peers``` screen which is empty because you don't have any peers yet. @@ -28,25 +28,25 @@ You can use your Google, GitHub or Microsoft account. The `Add peer` window should automatically pop up, but if it doesn't, click ```Add new peer``` to add a new machine.

- login-to-netbird + login-to-netbird

3. Choose your machine operating system (in our case it is ```Linux```) and proceed with the installation steps.

- login-to-netbird + login-to-netbird

4. If you installed NetBird Desktop UI you can use it to connect to the network instead of running `netbird up` command. Look for `NetBird` in your application list, run it, and click `Connect`. >

- login-to-netbird + login-to-netbird

5. At this point a browser window pops up starting a device registration process. Click confirm and follow the steps if required.

- login-to-netbird + login-to-netbird

6. On the EC2 node repeat the installation steps and run `netbird up` command. @@ -57,13 +57,13 @@ sudo netbird up 7. Copy the verification URL from the terminal output and paste it in your browser. Repeat step #5

- login-to-netbird + login-to-netbird

8. Return to ```Peers``` and you should notice 2 new machines with status ```online```

- login-to-netbird + login-to-netbird

9. To test the connection you could try pinging devices: @@ -271,7 +271,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect. > It will open your browser, and you will be prompt for email and password. Follow the instructions.

- high-level-dia + high-level-dia

#### CLI @@ -282,7 +282,7 @@ Alternatively, you could use command line. Simply run > It will open your browser, and you will be prompt for email and password. Follow the instructions.

- high-level-dia + high-level-dia

Check connection status: diff --git a/src/pages/how-to/installation.mdx b/src/pages/how-to/installation.mdx index 6fa10308..d972e7df 100644 --- a/src/pages/how-to/installation.mdx +++ b/src/pages/how-to/installation.mdx @@ -150,7 +150,7 @@ NetBird has an official Android application that you can download at Google Play

- playstore + playstore

@@ -197,7 +197,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect. > It will open your browser, and you will be prompt for email and password. Follow the instructions.

- high-level-dia + high-level-dia

#### CLI @@ -208,7 +208,7 @@ Alternatively, you could use command line. Simply run > It will open your browser, and you will be prompt for email and password. Follow the instructions.

- high-level-dia + high-level-dia

Check connection status: diff --git a/src/pages/how-to/manage-dns-in-your-network.mdx b/src/pages/how-to/manage-dns-in-your-network.mdx index a0b4f185..cc1f3848 100644 --- a/src/pages/how-to/manage-dns-in-your-network.mdx +++ b/src/pages/how-to/manage-dns-in-your-network.mdx @@ -1,7 +1,7 @@ # Manage DNS in your network -
+


@@ -57,7 +57,7 @@ A nameserver group defines up to 2 nameservers to resolve DNS to a set of peers ### Creating a nameserver group Access the `DNS` tab and click the `Add Nameserver` button to create a new nameserver.

- high-level-dia + high-level-dia

That will open a nameserver selection configuration screen where you can choose between using three predefined public nameservers or using a custom setup. @@ -68,13 +68,13 @@ If you choose a predefined public nameserver option, you can select the followin - [Cloudflare DNS servers](https://one.one.one.one/dns/) - [Quad9 DNS servers](https://www.quad9.net/)

- high-level-dia + high-level-dia

After selecting one of the three options, you need to assign a peer group for which this nameserver will be effective. In the example below, we chose the "All" group:

- high-level-dia + high-level-dia

#### Creating custom nameservers @@ -88,7 +88,7 @@ In the example below, we are creating a nameserver with the following informatio - Match mode: `All domains` - Distribution group: `Remote developers`

- high-level-dia + high-level-dia

### Creating a nameserver for specific domains @@ -96,7 +96,7 @@ Sometimes we want to forward DNS queries to specific nameservers but only for pa Taking the example of custom nameservers above, you could select a match mode for only domains listed there. Below you can see the same nameserver setup but only for the `berlinoffice.com` domain:

- high-level-dia + high-level-dia

@@ -108,12 +108,12 @@ You can select as many distribution groups as you want for your nameserver setup ### Adding remote private DNS servers To add a private DNS server that is running behind routing peers, you need to create resources to ensure communication between your nameserver clients can communicate. In the Berlin office example from previous steps, we have a peer from the `Office network` that can route traffic to the `192.168.0.32` IP, so we need to ensure that a similar network route exists:

- high-level-dia + high-level-dia

Then we need to confirm that an access rule exists to connect `Remote developers` to `Office network` group:

- high-level-dia + high-level-dia

## Testing configuration diff --git a/src/pages/how-to/manage-network-access.mdx b/src/pages/how-to/manage-network-access.mdx index 268346a3..5d4e08aa 100644 --- a/src/pages/how-to/manage-network-access.mdx +++ b/src/pages/how-to/manage-network-access.mdx @@ -3,7 +3,7 @@ NetBird allows administrators to restrict access to resources (peers) by creating access rules and defining what peer groups are permitted to establish connections with one another. -
+
@@ -69,18 +69,18 @@ After accessing the `Access Control` tab, you can click on the `Add Rule` button where you need to name the rule, set its status, and add groups to the source and destination lists.

- high-level-dia + high-level-dia

If required, you can create new groups by simply entering new names in the input box for either source or destination lists.

- high-level-dia + high-level-dia

Once you are done configuring the rule, click the `Create` button to save it. You will then see your new rule in the table.

- high-level-dia + high-level-dia

@@ -92,7 +92,7 @@ If you create a new group when defining a rule, you will need to associate peers You can do it by accessing the `Peers` tab and clicking the `Groups` column of any peer you want to associate with the new group.

- high-level-dia + high-level-dia

@@ -108,9 +108,9 @@ To disable a rule, you should follow the steps of [updating rules](#updating-rul To delete a rule, you should click on the rule's menu and choose `Delete`. A confirmation window will pop up.

- high-level-dia + high-level-dia

- high-level-dia + high-level-dia

\ No newline at end of file diff --git a/src/pages/how-to/monitor-system-and-network-activity.mdx b/src/pages/how-to/monitor-system-and-network-activity.mdx index 86a2809e..840f27c2 100644 --- a/src/pages/how-to/monitor-system-and-network-activity.mdx +++ b/src/pages/how-to/monitor-system-and-network-activity.mdx @@ -10,7 +10,7 @@ Activity monitoring is enabled by default for every network, and you can access You can also use the search bar to filter events by activity type.

- activity-monitoring + activity-monitoring

diff --git a/src/pages/how-to/register-machines-using-setup-keys.mdx b/src/pages/how-to/register-machines-using-setup-keys.mdx index 95c1bbbc..69d8e0a6 100644 --- a/src/pages/how-to/register-machines-using-setup-keys.mdx +++ b/src/pages/how-to/register-machines-using-setup-keys.mdx @@ -24,7 +24,7 @@ Setup keys are available in the NetBird Management dashboard under the Setup Key By default, we generate 2 setup keys right after account creation. You can easily add new or revoke keys.

- high-level-dia + high-level-dia

@@ -37,7 +37,7 @@ Setup keys are set to expire after 30 days. When expired, the setup key can't be ## Peer Auto-grouping

- high-level-dia + high-level-dia

NetBird offers a powerful [access control feature](/how-to/manage-network-access) that allows easy access management of your resources. @@ -52,7 +52,7 @@ To add `Auto-assign groups`, open the `Setup Keys` tab and create or update any Then use this key to enroll new machine.

- high-level-dia + high-level-dia

diff --git a/src/pages/how-to/routing-traffic-to-private-networks.mdx b/src/pages/how-to/routing-traffic-to-private-networks.mdx index 0d05b01f..bbdd2bd8 100644 --- a/src/pages/how-to/routing-traffic-to-private-networks.mdx +++ b/src/pages/how-to/routing-traffic-to-private-networks.mdx @@ -1,7 +1,7 @@ # Routing traffic to private networks -
+


@@ -60,7 +60,7 @@ A network route describes a network you want to connect with your NetBird peers. Access the `Network Routes` tab and click the `Add Route` button to create a new route. That will open a route configuration screen where you can add the information about the network you want to route:

- high-level-dia + high-level-dia

Now you can enter the details of your route. @@ -73,12 +73,12 @@ In the example below, we are creating a route with the following information: - Distribution Groups: `All`

- high-level-dia + high-level-dia

Once you fill in the route information, you can click on the `Save` button to save your new route.

- high-level-dia + high-level-dia

Done! Now every peer connected to your routing peer will be able to send traffic to your external network. @@ -93,13 +93,13 @@ To enable high-available mode, you can click on `Configure` and select a new pee In the following screenshot, we are adding the peer `aws-nb-europe-router-az-b` to the `aws-eu-central-1-vpc` route:

- high-level-dia + high-level-dia

This way, nodes connected to both peer `aws-nb-europe-router-az-a` and peer `aws-nb-europe-router-az-b` would have a highly available connection with the network `172.31.0.0/16`.

- high-level-dia + high-level-dia

@@ -116,7 +116,7 @@ That will require a routing configuration on your external network router pointi This way, devices that don't have the agent installed can communicate with your NetBird peers.

- high-level-dia + high-level-dia

## Get started diff --git a/src/pages/selfhosted/identity-providers.mdx b/src/pages/selfhosted/identity-providers.mdx index 445fc81a..6989b93a 100644 --- a/src/pages/selfhosted/identity-providers.mdx +++ b/src/pages/selfhosted/identity-providers.mdx @@ -75,14 +75,14 @@ You can enable it by following these steps: - Click `Create`

- high-level-dia + high-level-dia

- Click `Settings` tab - Copy **`Client ID`** to `NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID` in the `setup.env` file

- high-level-dia + high-level-dia

- Scroll down to the `Advanced Settings` section @@ -90,7 +90,7 @@ You can enable it by following these steps: - Click `Save Changes`

- high-level-dia + high-level-dia

@@ -119,7 +119,7 @@ to your network using the [Interactive SSO Login feature](/how-to/getting-starte over Keycloak.

- high-level-dia + high-level-dia

### Step 1: Check your Keycloak Instance @@ -143,7 +143,7 @@ To create a realm you need to: - Click `Create`

- high-level-dia + high-level-dia

@@ -160,7 +160,7 @@ In this step we will create a NetBird administrator user. - Click `Create`

- high-level-dia + high-level-dia

The user will need an initial password set to be able to log in. To do this: @@ -171,7 +171,7 @@ The user will need an initial password set to be able to log in. To do this: - Click `Save`

- high-level-dia + high-level-dia

### Step 4: Create a NetBird client @@ -188,14 +188,14 @@ In this step we will create NetBird application client and register with the Key - Your newly client `netbird-client` will be used later to set `NETBIRD_AUTH_CLIENT_ID` in the `setup.env`

- high-level-dia + high-level-dia

- Check the checkboxes as on the screenshot below and click Save

- high-level-dia + high-level-dia

### Step 5: Adjust NetBird client access settings @@ -215,7 +215,7 @@ In this step we will configure NetBird application client access with the NetBir - Click `Save`

- high-level-dia + high-level-dia

### Step 6: Create a NetBird client scope @@ -233,7 +233,7 @@ In this step, we will create and configure the NetBird client audience for Keycl - Click `Save`

- high-level-dia + high-level-dia

- While in the newly created Client Scope, switch to the `Mappers` tab @@ -241,7 +241,7 @@ In this step, we will create and configure the NetBird client audience for Keycl - Choose the `Audience` mapping

- high-level-dia + high-level-dia

- Fill in the form with the following values: @@ -251,7 +251,7 @@ In this step, we will create and configure the NetBird client audience for Keycl - Click `Save`

- high-level-dia + high-level-dia

### Step 7: Add client scope to NetBird client @@ -267,7 +267,7 @@ In this step, we will create and configure the NetBird client audience for Keycl - The value `netbird-client` will be used as audience

- high-level-dia + high-level-dia

### Step 8: Create a NetBird-Backend client @@ -284,13 +284,13 @@ In this step we will create NetBird backend client and register with the Keycloa - Your newly client `netbird-backend` will be used later to set `KeycloakClientCredentials` in the `management.json`

- high-level-dia + high-level-dia

- Check the checkboxes as on the screenshot below and click Save

- high-level-dia + high-level-dia

The client will need secret to authenticate. To do this: @@ -298,7 +298,7 @@ The client will need secret to authenticate. To do this: - Copy `client secret` will be used later to set `ClientSecret` in the `management.json`

- high-level-dia + high-level-dia

### Step 9: Add manage-users role to netbird-backend @@ -312,13 +312,13 @@ The client will need secret to authenticate. To do this: - Select `Filter by clients` and search for `manage-users`

- high-level-dia + high-level-dia

- Check the role checkbox and click assign

- high-level-dia + high-level-dia

Your authority OIDC configuration will be available under: @@ -388,7 +388,7 @@ In this step, we will create and configure NetBird application in azure AD. - Redirect URI: select `Single-page application (SPA)` and URI as `https:///silent-auth`

- high-level-dia + high-level-dia

### Step 2. Platform configurations @@ -396,13 +396,13 @@ In this step, we will create and configure NetBird application in azure AD. - Under the `Single-page application` Section, add another URI `https:///auth`

- high-level-dia + high-level-dia

- Scroll down and setup other options as on the screenshot below and click Save

- high-level-dia + high-level-dia

### Step 3. Create a NetBird application scope @@ -413,7 +413,7 @@ In this step, we will create and configure NetBird application in azure AD. - Scope name: `api`

- high-level-dia + high-level-dia

- Under `Authorized client Applications`, click on `+ add a client application` and enter the following: @@ -421,7 +421,7 @@ In this step, we will create and configure NetBird application in azure AD. - Client ID: same as your Application ID URI minus the `api://`

- high-level-dia + high-level-dia

@@ -432,7 +432,7 @@ In this step, we will create and configure NetBird application in azure AD. - Click `My APIs` tab, and select `Netbird`. Next check `api` permission checkbox and click `Add permissions`.

- high-level-dia + high-level-dia

- Add `Delagated permissions` to Microsoft Graph @@ -440,7 +440,7 @@ In this step, we will create and configure NetBird application in azure AD. - Click `Microsoft Graph` and then click `Delagated permissions` tab and check all permissions under the `OpenId permissions` section and click `Add permissions`

- high-level-dia + high-level-dia

@@ -450,19 +450,19 @@ In this step, we will create and configure NetBird application in azure AD. - Search for `User.ReadWrite.All` and under `User` sections and check `User.ReadWrite.All` checkbox section

- high-level-dia + high-level-dia

- Search for `Application.ReadWrite.All` and under `Application` sections and check `Application.ReadWrite.All` checkbox section and click `Add permissions`

- high-level-dia + high-level-dia

- Click `Grant admin conset for Default Directory` and click `Yes`

- high-level-dia + high-level-dia

### Step 5. Update token version @@ -478,7 +478,7 @@ In this step, we will create and configure NetBird application in azure AD. - Copy `Value` and save it as it can be viewed only once after creation.

- high-level-dia + high-level-dia

Your authority OIDC configuration will be available under: @@ -546,7 +546,7 @@ Create new zitadel project - Name: `NETBIRD`

- high-level-dia + high-level-dia

Create new zitadel application @@ -557,14 +557,14 @@ Create new zitadel application - TYPE OF APPLICATION: `User Agent`

- high-level-dia + high-level-dia

- Fill in the form with the following values and click `Continue` - Authentication Method: `PKCE`

- high-level-dia + high-level-dia

- Fill in the form with the following values and click `Continue` @@ -572,14 +572,14 @@ Create new zitadel application - Post Logout URIs: `https:///silent-auth` and click `+`

- high-level-dia + high-level-dia

- Verify applications details and Click `Create` and then click `Close` - Check `Refresh Token` checkbox and click `Save`

- high-level-dia + high-level-dia

- Copy `Client ID` will be used later in the `setup.env` @@ -597,7 +597,7 @@ To configure `netbird` application token you need to: - Click `Save`

- high-level-dia + high-level-dia

### Step 3: Application Redirect Configuration @@ -616,7 +616,7 @@ To configure `netbird` application redirect you need to: - Click `Save`

- high-level-dia + high-level-dia

### Step 4: Create a Service User @@ -634,7 +634,7 @@ In this step we will create a `netbird` service user. - Click `Create`

- high-level-dia + high-level-dia

In this step we will generate `ClientSecret` for the `netbird` service user. @@ -643,7 +643,7 @@ In this step we will generate `ClientSecret` for the `netbird` service user. - Copy `ClientSecret` from the dialog will be used later to set `ClientSecret` in the `management.json`

- high-level-dia + high-level-dia

### Step 5: Grant manage-users role to netbird service user @@ -657,7 +657,7 @@ In this step we will grant `Org User Manager` role to `netbird` service user. - Click `Add`

- high-level-dia + high-level-dia

Your authority OIDC configuration will be available under: