From 54c5ede2a820fbec6e317a535d305f4ebcb2c21a Mon Sep 17 00:00:00 2001 From: blazej-teonite <104985522+blazej-teonite@users.noreply.github.com> Date: Tue, 23 Jan 2024 15:45:05 +0100 Subject: [PATCH] Added Windows requirements to README (#47) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added Windows requirements to README * add a heading --------- Co-authored-by: Maciej Wójcik --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74148f5..fe44fae 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ It was developed as part of [defguard](https://github.com/defguard/defguard) sec ## Supported platforms -* **Native OS Kernel**: Linux, FreeBSD (and pfSense/OPNSense) - Windows (in development)* +* **Native OS Kernel**: Linux, FreeBSD (and pfSense/OPNSense), Windows * Userspace using [wireguard-go](https://github.com/WireGuard/wireguard-go) - Linux, **macOS**, FreeBSD - + ### Unique features * **Peer routing** - see [WGApi](https://docs.rs/defguard_wireguard_rs/latest/defguard_wireguard_rs/struct.WGApi.html) docs. @@ -20,6 +20,9 @@ It was developed as part of [defguard](https://github.com/defguard/defguard) sec * On Linux, handle network routing using **netlink**. * **fwmark** handling +### Windows support +Please note that [WireGuard](https://www.wireguard.com/install/) needs to be installed on Windows with commands `wg` and `wireguard` available to be called from the command line. + ### Note on `wireguard-go` If you intend to use the userspace WireGuard implementation you should note that currently the library assumes that the `wireguard-go` binary will be available at runtime. There are some sanity checks when instantiating the API,