@@ -29,6 +29,28 @@ there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/self
29
29
30
30
## Configuration
31
31
32
+ ### Authenticate the machine
33
+
34
+ Fill out the authentication form with the following values and click ` Save ` :
35
+
36
+ - ** Management URL** : Default is ` https://app.netbird.io:443 ` . If self-hosting, enter your custom management server URL.
37
+ - ** Setup Key** : Paste the setup key from your NetBird account.
38
+
39
+ <p >
40
+ <img src = " /docs-static/img/how-to-guides/opnsense/authentication.png" alt = " authentication" className = " imagewrapper-big" />
41
+ </p >
42
+
43
+ ### Verify Connection Status
44
+
45
+ The Status page shows detailed information about connected peers and control services, helping you monitor your deployment.
46
+ Access it via ` VPN ` > ` NetBird ` > ` Status ` in the OPNsense menu.
47
+
48
+ Use this section for diagnostics and troubleshooting common connection or setup issues.
49
+
50
+ <p >
51
+ <img src = " /docs-static/img/how-to-guides/opnsense/status.png" alt = " connection status" className = " imagewrapper-big" />
52
+ </p >
53
+
32
54
### Assign NetBird interface
33
55
After installation, a new interface named ` wt0 ` will be available but unassigned. To assign it go to ` Interfaces ` >
34
56
` Assignments ` . Under ` Assign a new interface ` , set the following values:
@@ -54,7 +76,7 @@ the following options and click `Save`, then `Apply changes` to activate the int
54
76
<p > <img src = " /docs-static/img/how-to-guides/opnsense/enable_interface.png" alt = " enableInterface" className = " imagewrapper-big" /> </p >
55
77
56
78
<Note >
57
- OPNsense includes native WireGuard support, however do not configure or manage the NetBird interface (wt0) via the OPNsense WireGuard UI.
79
+ OPNsense includes native WireGuard support, however do not configure or manage the NetBird interface (wt0) via the OPNsense WireGuard UI.
58
80
NetBird fully manages the WireGuard interface and keys.
59
81
</Note >
60
82
@@ -65,44 +87,21 @@ This ensures traffic flows freely, while NetBird’s own policies (ACLs) govern
65
87
1 . Navigate to ` Firewall ` > ` Rules ` > ` NetBird ` .
66
88
2 . Click ` + Add ` to create a new rule.
67
89
3 . Configure the rule:
68
- - ** Action** : ` Pass `
69
- - ** Interface** : ` NetBird `
70
- - ** Direction** : ` in `
71
- - ** TCP/IP Version** : ` IPv4 `
72
- - ** Protocol** : ` any `
73
- - ** Source** : ` any `
74
- - ** Destination** : ` any `
75
- - ** Description** : ` Allow all on NetBird (managed by NetBird) `
90
+ - ** Action** : ` Pass `
91
+ - ** Interface** : ` NetBird `
92
+ - ** Direction** : ` in `
93
+ - ** TCP/IP Version** : ` IPv4 `
94
+ - ** Protocol** : ` any `
95
+ - ** Source** : ` any `
96
+ - ** Destination** : ` any `
97
+ - ** Description** : ` Allow all on NetBird (managed by NetBird) `
76
98
4 . Click ` Save ` , then ` Apply changes ` .
77
99
5 . Ensure this rule is at the top of the ` NetBird ` rules list so it isn’t shadowed by other rules.
78
100
79
101
<p >
80
102
<img src = " /docs-static/img/how-to-guides/opnsense/firewall_rules.png" alt = " firewallRules" className = " imagewrapper-big" />
81
103
</p >
82
104
83
- ### Authenticate the machine
84
-
85
- Fill out the authentication form with the following values and click ` Save ` :
86
-
87
- - ** Management URL** : Default is ` https://app.netbird.io:443 ` . If self-hosting, enter your custom management server URL.
88
- - ** Setup Key** : Paste the setup key from your NetBird account. .
89
-
90
- <p >
91
- <img src = " /docs-static/img/how-to-guides/opnsense/authentication.png" alt = " authentication" className = " imagewrapper-big" />
92
- </p >
93
-
94
- ### Verify Connection Status
95
-
96
- The Status page shows detailed information about connected peers and control services, helping you monitor your deployment.
97
- Access it via ` VPN ` > ` NetBird ` > ` Status ` in the OPNsense menu.
98
-
99
- Use this section for diagnostics and troubleshooting common connection or setup issues.
100
-
101
- <p >
102
- <img src = " /docs-static/img/how-to-guides/opnsense/status.png" alt = " connection status" className = " imagewrapper-big" />
103
- </p >
104
-
105
-
106
105
## Get started
107
106
<p float = " center" >
108
107
<Button name = " button" className = " button-5" onClick = { () => window .open (" https://netbird.io/pricing" )} >Use NetBird</Button >
0 commit comments