Skip to content

Commit 0fe3337

Browse files
authored
Update README.md
1 parent dd3b6b4 commit 0fe3337

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Because of the present limitations with pfSense internals and what packages can
99

1010
These changes include:
1111
1. XML configuration bits have been moved from `wireguard/tunnel` to `installedpackages/wireguard/tunnel` (this package will currently NOT convert tunnels created using the old 2.5.0 schema and config location).
12-
2. Because assigned interfaces become a system dependency, this package includes several (clever) tricks to allow the system to be upgraded and rebooted with WireGuard tunnels assigned to pfSense interfaces (e.g. LAN, OPT#, etc...). There are now two `<earlyshellcmds>` that are installed. One is a bootstrapper and one is a reloader. The bootstrapper [here](https://github.com/theonemcdonald/pfSense-pkg-WireGuard/blob/main/src/files/usr/local/pkg/wireguard/etc/rc.bootstrap_wireguard) always runs first and is written to disk by the package internals instead of by `pkg(7)`. This means that this script will remain on your system by default even if the WireGuard package is uninstalled. There will be a configuration setting to change this behavior soon. This bootstrapper protects the system from interface mismatches on startup caused by WireGuard tunnels not being built (even though they are assigned) because the package is being updated or was removed for some reason. This is accomplishd by temporarily creating loopback interfaces of the same names, thus allowing the system to boot. However, if the WireGuard package is installed, the reloader [here](https://github.com/theonemcdonald/pfSense-pkg-WireGuard/blob/main/src/files/usr/local/etc/rc.reload_wireguard) will destroy these temporary loopbacks and replace them with true `wg(8)` tunnels early on system startup.
1312
3. Assigned interfaces are now configured under the traditional pfSense `interfaces.php` page. Unassigned tunnels are still configured through the WireGuard UI.
1413
4. Gateways are no longer automatically created for tunnels assigned to pfSense interfaces. Just like any other WAN, you will now be required to create your own gateway entries for the tunnel remote side if you intended to route traffic over the tunnel itself.
1514
5. There is now a proper status page at Status > WireGuard Status. This page includes various bits from `wg(8)`, `ifconfig(8)`, `pkg(7)`, and `kldstat(8)`.
@@ -22,6 +21,9 @@ Note: I have now moved development to the dev branch. Moving forward main will c
2221

2322
**DO NOT INSTALL ON pfSense 2.5.0.**
2423

24+
## Chat with us!
25+
https://discord.gg/VjmRExyQww
26+
2527
## Build
2628
The build process is similar to that of other FreeBSD and pfSense packages. You will need to set up a FreeBSD build environment and install or build `wireguard` and `wireguard-kmod` on it. Please check the [pfSense package development documentation](https://docs.netgate.com/pfsense/en/latest/development/developing-packages.html#testing-building-individual-packages) for more information.
2729

@@ -56,4 +58,4 @@ https://docs.netgate.com/pfsense/en/latest/vpn/wireguard/index.html
5658

5759
![3](https://github.com/theonemcdonald/pfSense-pkg-WireGuard/blob/main/extra/images/screen3.PNG)
5860

59-
![4](https://github.com/theonemcdonald/pfSense-pkg-WireGuard/blob/main/extra/images/screen4.PNG)
61+
![4](https://github.com/theonemcdonald/pfSense-pkg-WireGuard/blob/main/extra/images/screen4.PNG)

0 commit comments

Comments
 (0)