Skip to content

Commit 3eae4c5

Browse files
committed
Enhance formatting and clarity in routing traffic documentation
- Updated section headers to bold for improved visibility and consistency. - Reformatted descriptions for "Network identifiers and ranges," "Routing peer," "Routing group," "High availability routes," "Masquerade," and "DNS Routes" for better readability. - Added emphasis to the note regarding route configuration when masquerade is not enabled.
1 parent 7ceaa64 commit 3eae4c5

1 file changed

Lines changed: 7 additions & 13 deletions

File tree

src/pages/how-to/routing-traffic-to-private-networks.mdx

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,20 @@ A network route describes the network you want to connect with your NetBird peer
3939
Network routes are available in NetBird [v0.9.0](https://github.com/netbirdio/netbird/releases) or later.
4040
</Note>
4141

42-
#### Network identifiers and ranges
43-
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.
42+
**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.
4443

45-
#### Routing peer
46-
A routing peer is a peer that routes packets between your routed network and the other NetBird peers.
44+
**Routing peer**: A routing peer is a peer that routes packets between your routed network and the other NetBird peers.
4745

48-
#### Routing group
49-
A routing group is a set of routing peers. Each will route packets between your routed network and the other NetBird peers.
46+
**Routing group**: A routing group is a set of routing peers. Each will route packets between your routed network and the other NetBird peers.
5047

51-
#### High availability routes
52-
A highly available route is a combination of multiple routes with the same network identifier and ranges. They have different routing peers or routing peer groups offering highly available paths for communication between your peers and external networks.
48+
**High availability routes**: A highly available route is a combination of multiple routes with the same network identifier and ranges. They have different routing peers or routing peer groups offering highly available paths for communication between your peers and external networks.
5349
Nodes connected to routing peers will choose one of them to route packets to external networks based on connection type and defined metrics.
5450

55-
#### Masquerade
56-
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.
51+
**Masquerade**: 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.
5752

58-
If you do not enable this option, you must configure a route to your NetBird network in your external network infrastructure.
53+
_If you do not enable this option, you must configure a route to your NetBird network in your external network infrastructure._
5954

60-
### DNS Routes
61-
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.
55+
**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.
6256

6357
By default, DNS routes are resolved every 60 seconds. You can adjust this interval using the `--dns-router-interval` flag:
6458

0 commit comments

Comments
 (0)