|
| 1 | +# pfSense Installation |
| 2 | + |
| 3 | +The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, |
| 4 | +there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available. |
| 5 | + |
| 6 | +<Note> |
| 7 | +This installation is intended for early adopters while the pfSense package is under review and not yet available in the pfSense package manager. |
| 8 | +</Note> |
| 9 | + |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | +- Shell/SSH access to pfSense (via Web UI shell or remote SSH) |
| 13 | +- A [setup key](/how-to/register-machines-using-setup-keys#types-of-setup-keys) to authenticate and register the pfSense device |
| 14 | +- The latest NetBird `.pkg` binary from the [GitHub Releases](https://github.com/netbirdio/pfsense-netbird/releases) |
| 15 | + |
| 16 | +## Installation |
| 17 | + |
| 18 | +1. **SSH into your pfSense system** |
| 19 | + ```sh |
| 20 | + ssh admin@<pfsense-ip> |
| 21 | + ``` |
| 22 | + If remote SSH is enabled or use the built-in shell via the pfSense Web UI (`Diagnostics` > `Command Prompt`). |
| 23 | + |
| 24 | +3. **Download the NetBird client(agent)** |
| 25 | + |
| 26 | + From a shell on your pfSense system, run: |
| 27 | + ```sh |
| 28 | + fetch https://github.com/netbirdio/pfsense-netbird/releases/download/v0.1.0/netbird-0.49.0.pkg |
| 29 | + ``` |
| 30 | +3. **Download the NetBird pfSense package** |
| 31 | + |
| 32 | + From a shell on your pfSense system, run: |
| 33 | + ```sh |
| 34 | + fetch https://github.com/netbirdio/pfsense-netbird/releases/download/v0.1.0/pfSense-pkg-NetBird-0.1.0.pkg |
| 35 | + ``` |
| 36 | + |
| 37 | +4. **Install the packages** |
| 38 | + |
| 39 | + ```sh |
| 40 | + pkg add -f netbird-0.49.0.pkg |
| 41 | + pkg add -f pfSense-pkg-NetBird-0.1.0.pkg |
| 42 | + ``` |
| 43 | + |
| 44 | +5. **Verify the installation** |
| 45 | + |
| 46 | + The NetBird GUI should now appear under `VPN` > `NetBird` in the pfSense menu. |
| 47 | + |
| 48 | +## Configuration |
| 49 | + |
| 50 | +### Authenticate the machine |
| 51 | + |
| 52 | +Fill out the authentication form with the following values and click `Save`: |
| 53 | + |
| 54 | +- **Management URL**: Default is `https://app.netbird.io:443`. If self-hosting, enter your custom management server URL. |
| 55 | +- **Setup Key**: Paste the setup key from your NetBird account. . |
| 56 | + |
| 57 | +<p> |
| 58 | + <img src="/docs-static/img/how-to-guides/pfSense/authentication.png" alt="authentication" className="imagewrapper-big"/> |
| 59 | +</p> |
| 60 | + |
| 61 | +### Verify Connection Status |
| 62 | + |
| 63 | +The Status page shows detailed information about connected peers and control services, helping you monitor your deployment. |
| 64 | +Access it via `Status` > `NetBird` in the pfSense menu. |
| 65 | + |
| 66 | +Use this section for diagnostics and troubleshooting common connection or setup issues. |
| 67 | + |
| 68 | +<p> |
| 69 | + <img src="/docs-static/img/how-to-guides/pfSense/status.png" alt="connection status" className="imagewrapper-big"/> |
| 70 | +</p> |
| 71 | + |
| 72 | +## Uninstallation |
| 73 | + |
| 74 | +From a shell on your pfSense system, run: |
| 75 | +<p> |
| 76 | +```sh |
| 77 | +pkg delete netbird-0.49.0 pfSense-pkg-NetBird-0.1.0 |
| 78 | +``` |
| 79 | +</p> |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | + |
| 84 | +## Get started |
| 85 | +<p float="center" > |
| 86 | + <Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button> |
| 87 | +</p> |
| 88 | + |
| 89 | +- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird) |
| 90 | +- Follow us [on X](https://x.com/netbird) |
| 91 | +- Join our [Slack Channel](/slack-url) |
| 92 | +- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub |
0 commit comments