aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/adminregistry.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2021-07-12 15:53:10 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2021-08-02 19:10:58 +0200
commit5409c45a10dc7a045197bc4105c6a7bd5d29283f (patch)
treee64f9e7e09a4f3d965659413487781f452800256 /docs/adminregistry.md
parentversion: bump (diff)
downloadwireguard-windows-5409c45a10dc7a045197bc4105c6a7bd5d29283f.tar.xz
wireguard-windows-5409c45a10dc7a045197bc4105c6a7bd5d29283f.zip
driver: introduce new module for talking with kernel driver
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'docs/adminregistry.md')
-rw-r--r--docs/adminregistry.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/adminregistry.md b/docs/adminregistry.md
index 9196a93f..34033446 100644
--- a/docs/adminregistry.md
+++ b/docs/adminregistry.md
@@ -51,3 +51,15 @@ overlapping routes, but for now, this key provides a manual override.
```
> reg add HKLM\Software\WireGuard /v MultipleSimultaneousTunnels /t REG_DWORD /d 1 /f
```
+
+#### `HKLM\Software\WireGuard\ExperimentalKernelDriver`
+
+When this key is set to `DWORD(1)`, an experimental kernel driver from the
+[WireGuardNT](https://git.zx2c4.com/wireguard-nt/about/) project is used instead
+of the much slower wireguard-go/Wintun implementation. There are significant
+performance gains, but do note that this is _currently_ considered experimental,
+and hence is not recommended.
+
+```
+> reg add HKLM\Software\WireGuard /v ExperimentalKernelDriver /t REG_DWORD /d 1 /f
+```