Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export const docsNavigation = [
{ title: 'Docker', href: '/how-to/installation/docker' },
{ title: 'Synology', href: '/how-to/installation/synology' },
{ title: 'Android/iOS', href: '/how-to/installation/mobile' },
{ title: 'pfSense', href: '/how-to/installation/pfsense' },
],
},
{ title: 'CLI', href: '/how-to/cli' },
Expand Down
92 changes: 92 additions & 0 deletions src/pages/how-to/installation/pfsense.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# pfSense Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available,
there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

<Note>
This installation is intended for early adopters while the pfSense package is under review and not yet available in the pfSense package manager.
</Note>


## Prerequisites
- Shell/SSH access to pfSense (via Web UI shell or remote SSH)
- A [setup key](/how-to/register-machines-using-setup-keys#types-of-setup-keys) to authenticate and register the pfSense device
- The latest NetBird `.pkg` binary from the [GitHub Releases](https://github.com/netbirdio/pfsense-netbird/releases)

## Installation

1. **SSH into your pfSense system**
```sh
ssh admin@<pfsense-ip>
```
If remote SSH is enabled or use the built-in shell via the pfSense Web UI (`Diagnostics` > `Command Prompt`).

3. **Download the NetBird client(agent)**

From a shell on your pfSense system, run:
```sh
fetch https://github.com/netbirdio/pfsense-netbird/releases/download/v0.1.0/netbird-0.49.0.pkg
```
3. **Download the NetBird pfSense package**

From a shell on your pfSense system, run:
```sh
fetch https://github.com/netbirdio/pfsense-netbird/releases/download/v0.1.0/pfSense-pkg-NetBird-0.1.0.pkg
```

4. **Install the packages**

```sh
pkg add -f netbird-0.49.0.pkg
pkg add -f pfSense-pkg-NetBird-0.1.0.pkg
```

5. **Verify the installation**

The NetBird GUI should now appear under `VPN` > `NetBird` in the pfSense menu.

## Configuration

### Authenticate the machine

Fill out the authentication form with the following values and click `Save`:

- **Management URL**: Default is `https://app.netbird.io:443`. If self-hosting, enter your custom management server URL.
- **Setup Key**: Paste the setup key from your NetBird account. .

<p>
<img src="/docs-static/img/how-to-guides/pfSense/authentication.png" alt="authentication" className="imagewrapper-big"/>
</p>

### Verify Connection Status

The Status page shows detailed information about connected peers and control services, helping you monitor your deployment.
Access it via `Status` > `NetBird` in the pfSense menu.

Use this section for diagnostics and troubleshooting common connection or setup issues.

<p>
<img src="/docs-static/img/how-to-guides/pfSense/status.png" alt="connection status" className="imagewrapper-big"/>
</p>

## Uninstallation

From a shell on your pfSense system, run:
<p>
```sh
pkg delete netbird-0.49.0 pfSense-pkg-NetBird-0.1.0
```
</p>




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

- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird)
- Follow us [on X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub