Skip to content

Commit 69280e1

Browse files
authored
Add exit node selection and auto-apply behavior documentation (#415)
* Add exit node selection and auto-apply behavior documentation, including new image for Skip Auto Apply feature. * Add exit node auto-apply feature documentation and new image for exit node configuration. * Add documentation for existing exit node routes and their auto-apply behavior, clarifying that routes created before the feature's introduction are treated as auto-applied by default.
1 parent af9b1b3 commit 69280e1

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed
152 KB
Loading

src/pages/how-to/configuring-default-routes-for-internet-traffic.mdx

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,27 @@ Peers within the specified distribution group are configured to send their Inter
3131
VPN.
3232
This setup is activated as soon as the routing peer is connected.
3333

34-
### Routing Peer Selection
34+
### Exit Node Selection and Auto Apply Behavior
3535

36-
Currently, this is exclusively configured through the dashboard and cannot be influenced by the client.
36+
Administrators configure exit nodes from the dashboard, and can optionally mark the default route (0.0.0.0/0) as selected by default. Clients will then auto-apply the selected exit node if the route is configured with **Auto Apply** or the user has made a local choice on the device.
37+
38+
- **Auto Apply**: when enabled on an exit node route, clients will auto-apply that exit node. Users can still manually disable it from the client if they choose to use that exit node.
39+
- **Client override**: if a user selects or deselects an exit node on their device, that local choice takes precedence over the management server’s preference. This includes the ability to deselect a forced/selected route sent by management.
40+
41+
<Note>
42+
Management can provide preferences for exit node selection, but the client user’s explicit selection or deselection is always respected on that device.
43+
</Note>
44+
45+
<Note>
46+
Exit node auto-apply feature requires NetBird client **v0.55.0** or later.
47+
</Note>
48+
49+
### Existing exit node routes
50+
51+
Exit node routes that existed before the Auto Apply feature are treated as if **Auto Apply** is enabled by default. This preserves previous behavior where exit nodes were applied automatically when distributed.
52+
53+
- Clients running v0.55.0 or later will auto-apply these existing routes unless the user has explicitly selected/deselected an exit node on the device.
54+
- Administrators can edit any exit node route in the dashboard to change its Auto Apply setting at any time.
3755

3856
## Configuration Steps
3957

@@ -60,12 +78,17 @@ Hit the `Add Exit Node` button to configure the peer as an exit node routing pee
6078
In the opened window, specify which peers should use the default route by assigning one or more distribution groups.
6179
These peers will automatically route their internet traffic through the routing peer upon its connection.
6280

63-
6481
<p>
6582
<img src="/docs-static/img/how-to-guides/netbird-peers-add-exit-node.png" alt="add-exit-node-view"
6683
className="imagewrapper-big"/>
6784
</p>
6885

86+
If you want exit nodes to be available without being automatically enabled on clients, enable the **Auto Apply** option. When Auto Apply is on, clients will auto-apply the exit node, but users can manually disable it from the client.
87+
88+
<p>
89+
<img src="/docs-static/img/how-to-guides/exit-node-auto-apply.png" alt="exit-node-auto-apply" className="imagewrapper-big"/>
90+
</p>
91+
6992
Then hit the `Add Exit Node` button to complete the configuration.
7093

7194
The routing peer is automatically set up to handle and route traffic it receives from connected peers. Masquerading

0 commit comments

Comments
 (0)