Skip to content

Commit 024a06c

Browse files
authored
Update OPNsense configuration steps (#426)
* Fix incorrect order of steps Signed-off-by: bcmmbaga <[email protected]> * refactor Signed-off-by: bcmmbaga <[email protected]> * Fix typo Signed-off-by: bcmmbaga <[email protected]> --------- Signed-off-by: bcmmbaga <[email protected]>
1 parent 29b2752 commit 024a06c

File tree

1 file changed

+31
-32
lines changed

1 file changed

+31
-32
lines changed

src/pages/how-to/installation/opnsense.mdx

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,28 @@ there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/self
2929

3030
## Configuration
3131

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+
3254
### Assign NetBird interface
3355
After installation, a new interface named `wt0` will be available but unassigned. To assign it go to `Interfaces` >
3456
`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
5476
<p> <img src="/docs-static/img/how-to-guides/opnsense/enable_interface.png" alt="enableInterface" className="imagewrapper-big"/> </p>
5577

5678
<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.
5880
NetBird fully manages the WireGuard interface and keys.
5981
</Note>
6082

@@ -65,44 +87,21 @@ This ensures traffic flows freely, while NetBird’s own policies (ACLs) govern
6587
1. Navigate to `Firewall` > `Rules` > `NetBird`.
6688
2. Click `+ Add` to create a new rule.
6789
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)`
7698
4. Click `Save`, then `Apply changes`.
7799
5. Ensure this rule is at the top of the `NetBird` rules list so it isn’t shadowed by other rules.
78100

79101
<p>
80102
<img src="/docs-static/img/how-to-guides/opnsense/firewall_rules.png" alt="firewallRules" className="imagewrapper-big"/>
81103
</p>
82104

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-
106105
## Get started
107106
<p float="center" >
108107
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>

0 commit comments

Comments
 (0)