diff --git a/public/docs-static/img/how-to-guides/netbird-network-routes-dns-routes.png b/public/docs-static/img/how-to-guides/netbird-network-routes-dns-routes.png new file mode 100644 index 00000000..eed023be Binary files /dev/null and b/public/docs-static/img/how-to-guides/netbird-network-routes-dns-routes.png differ diff --git a/src/pages/how-to/configuring-default-routes-for-internet-traffic.mdx b/src/pages/how-to/configuring-default-routes-for-internet-traffic.mdx index f1580907..754a3b88 100644 --- a/src/pages/how-to/configuring-default-routes-for-internet-traffic.mdx +++ b/src/pages/how-to/configuring-default-routes-for-internet-traffic.mdx @@ -31,10 +31,6 @@ Peers within the specified distribution group are configured to send their Inter VPN. This setup is activated as soon as the routing peer is connected. -### Supported Clients - -The feature currently supports Linux, macOS, iOS and Windows as client operating systems. - ### Routing Peer Selection Currently, this is exclusively configured through the dashboard and cannot be influenced by the client. 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 83c6d53e..3a70de5a 100644 --- a/src/pages/how-to/routing-traffic-to-private-networks.mdx +++ b/src/pages/how-to/routing-traffic-to-private-networks.mdx @@ -26,10 +26,12 @@ In these cases, you can configure network routes assigning routing peers to conn ## Concepts ### Network routes -A network route describes the network you want to connect with your NetBird peers. It has an identifier, a network range, a routing peer, and some parameters available for managing priority and masquerading. +A network route describes the network you want to connect with your NetBird peers. It has an identifier, a network range or list of domains, a routing peer, and some parameters available for managing priority and masquerading. + - Network routes is available for NetBird [v0.9.0](https://github.com/netbirdio/netbird/releases) or later. + Network routes are available in NetBird [v0.9.0](https://github.com/netbirdio/netbird/releases) or later. + #### Network identifiers and ranges Network identifiers are names for each network you want to route traffic from your peers, and ranges are IP ranges declared in CIDR notation which refers to an external network. The combination of identifiers and these ranges makes a single network. #### Routing peer @@ -49,8 +51,41 @@ Nodes connected to routing peers will choose one of them to route packets to ext Masquerade hides other NetBird network IPs behind the routing peer local address when accessing the target Network range. This option allows access to your private networks without configuring routes on your local routers or other devices. If you don't enable this option, you must configure a route to your NetBird network in your external network infrastructure. + +### DNS Routes +An alternative to specifying a network range directly is to use DNS routes. Instead of adding the network directly, you can add multiple domains in a route that will be dynamically resolved on the client. The resolved IP addresses for these domains will be added as routes. For example, a network administrator can ensure that traffic to `website.com` or `api.website.com` is routed through a specific machine. So they configure DNS routes for these domains instead of specifying the IP ranges. + +By default, DNS routes are resolved every 60 seconds. You can adjust this interval using the `--dns-router-interval` flag: + + +```bash +netbird up --dns-router-interval 30s +``` + +Additionally, a keep routes switch is enabled by default. + +

+ high-level-dia +

+ +When the keep routes switch is on, and a domain no longer resolves to an IP address, the corresponding route will still be maintained (and any new resolved IP addresses will be added). +If the switch is off, the routes will be replaced with the newly resolved IP addresses. + +The purpose of the keep routes functionality is to retain previously resolved routes after IP address updates, in order to maintain stable connections. For example, long-running connections to an IP address that are still valid even if the DNS now resolves to a different IP address (e.g., DNS-based load balancing). + + + + DNS Routes are available for NetBird [v0.28.0](https://github.com/netbirdio/netbird/releases) or later. + + + + Currently, wildcard domains are not supported for DNS routes. + + ### Metric and priority Metric defines prioritization when choosing the main routing peer in a high availability network. Lower metrics have higher priority. +Outside of high availability routes, the metric has no effect. + ### Distribution groups Distribution groups define that peers that belong to these groups set in this field will receive the network route. @@ -58,6 +93,7 @@ Distribution groups define that peers that belong to these groups set in this fi It doesn't remove the need for the routing peer to be connected to these peers + ## Managing network routes A network route describes a network you want to connect with your NetBird peers. It has an identifier, a network range, a routing peer or set of peer groups, and some parameters available for managing priority and masquerading.