Skip to content

Commit

Permalink
add Pre-requisites and adjust menu paths
Browse files Browse the repository at this point in the history
  • Loading branch information
mlsmaycon committed Dec 22, 2024
1 parent 5028029 commit 31c3f75
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
40 changes: 22 additions & 18 deletions src/pages/how-to/accessing-entire-domains-within-networks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ NetBird can help you configure access to these resources by routing your traffic
In the following scenario, we will create a new development network and add a wildcard domain resource for the entire `dev.example.com`
to be routed using [Routing peers](/how-to/networks-concept#routing-peers) running in the network. All developers will be able to access the development environment using the `Network` configuration.

### Pre-requisites

#### Configure Nameservers
In order for the the following steps to work, you need to configure Nameservers to resolve all domain queries in your NetBird account. See the [Manage DNS in your network](/how-to/manage-dns-in-your-network) guide for more information.

#### Enable DNS wildcard routing
When you configure wildcard domains as resources, you need to enable DNS wildcard routing. Which has an additional effect in comparison to the previous DNS routes behavior from Network routes; it switches the DNS resolution to the routing peer instead of the local client system.
This is also useful for regular DNS routes when you want to resolve the domain names using the routing peer's IP infrastructure, which will allow for more restricted access control rules in newer versions of the clients(**1**) and for the traffic to go to a near routing peer service.
<Note>
(1) Support for more restricted rules will be available in future releases.
</Note>
You can enable DNS resolution on the routing peer by accessing your account `Settings` > `Networks` > Enable DNS wildcard routing. See example below:
<p>
<img src="/docs-static/img/how-to-guides/networks/settings-1.png" alt="settings-acl" className="imagewrapper-big"/>
</p>

<Note>
The `Enable DNS wildcard routing` is supported by routing peers and routing clients running version 0.35.0 or later.
Once the feature is enabled, you may need to restart your routing peers and clients to apply the changes.
</Note>

### Create a Network
To create a Network, navigate to the `Networks` > `Networks` section in the NetBird dashboard:

Expand Down Expand Up @@ -72,7 +93,7 @@ To access a detailed view of the network, click on the network name:
You can edit or add more resources or routing peers to the network by clicking on the `Edit` buttons of each section in the detailed view.

### Add a regular domain resource
A wildcard domain won't cover the entire domain by itself because the wildcard character `*` only covers subdomains after the `.`. If you need to cover the entire domain, you can add a regular domain resource to the network.
A wildcard domain won't cover the entire domain by itself because the wildcard character `*` only covers subdomains after the `.`. If you need to cover the entire domain, you can additionally add a regular domain resource to the network.

This time, let's add a domain from the main Networks list view. Click on the `Add Resource` button:
<p>
Expand All @@ -85,23 +106,6 @@ Then, enter the domain name of the `Regular domain` in this case, `dev.example.c

We can also assign the same group to this resource, allowing us to reuse the previous access control policy for the `development-domains` group.

### Enable DNS wildcard routing
When you configure wildcard domains as resources, you need to enable DNS wildcard routing. Which has an additional effect in comparison to the previous DNS routes behavior from Network routes; it switches the DNS resolution to the routing peer instead of the local client system.
This is also useful for regular DNS routes when you want to resolve the domain names using the routing peer's IP infrastructure, which will allow for more restricted access control rules in newer versions of the clients(**1**) and for the traffic to go to a near routing peer service.
<Note>
(1) Support for more restricted rules will be available in future releases.
</Note>
You can enable DNS resolution on the routing peer by accessing your account `Settings` > `Permissions` > Enable DNS wildcard routing. See example below:
<p>
<img src="/docs-static/img/how-to-guides/networks/settings-1.png" alt="settings-acl" className="imagewrapper-big"/>
</p>

<Note>
The `Enable DNS wildcard routing` is supported by routing peers and routing clients running version 0.35.0 or later.
Once the feature is enabled, you may need to restart your routing peers and clients to apply the changes.
</Note>


With the steps above, we created resources that allow the development team to access the entire `dev.example.com` domain and the `*.dev.example.com` subdomains using the same policy.

## Get started
Expand Down
2 changes: 1 addition & 1 deletion src/pages/how-to/networks-concept.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This is also useful for regular DNS routes when you want to resolve the domain n
<Note>
(1) Support for more restricted rules will be available in future releases.
</Note>
You can enable DNS resolution on the routing peer by accessing your account `Settings` > `Permissions` > Enable DNS wildcard routing. See example below:
You can enable DNS resolution on the routing peer by accessing your account `Settings` > `Networks` > Enable DNS wildcard routing. See example below:
<p>
<img src="/docs-static/img/how-to-guides/networks/settings-1.png" alt="settings-acl" className="imagewrapper-big"/>
</p>
Expand Down

0 comments on commit 31c3f75

Please sign in to comment.