From f323da9a0eabe027e538e38e06108910e655783e Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Sat, 20 Jul 2019 11:28:57 +0100 Subject: [PATCH] Windows installation page --- installation-windows.md | 59 +++++++++++++++++++++++++++++++++++++++++ installation.md | 4 +++ platform-windows.md | 55 -------------------------------------- 3 files changed, 63 insertions(+), 55 deletions(-) create mode 100644 installation-windows.md diff --git a/installation-windows.md b/installation-windows.md new file mode 100644 index 0000000..f6f924c --- /dev/null +++ b/installation-windows.md @@ -0,0 +1,59 @@ +--- +tags: dontlink +sitemap: true +--- + +## TAP Driver + +Yggdrasil depends on the OpenVPN TAP driver to work on Windows. There are two flavours of this driver: + +- [NDIS 5](https://swupdate.openvpn.org/community/releases/tap-windows-9.9.2_3.exe) (`tap-windows-9.9.2_3`) - recommended +- [NDIS 6](https://swupdate.openvpn.org/community/releases/tap-windows-9.21.2.exe) (`tap-windows-9.21.2`) - functional + +Yggdrasil works with either driver, although the performance is remarkably better with the older NDIS 5 driver, therefore it is recommended to use that instead of the NDIS 6 driver. + +Please note that if you already have OpenVPN for Windows, you likely have one of the two drivers installed already and should not install it again. + +## Installation + +Start by [downloading the latest Yggdrasil binary](builds.md) and use Windows Explorer to copy it into a sensible location and rename it to `yggdrasil.exe`. + +The below examples assume that you placed `yggdrasil.exe` into `C:\Program Files\Yggdrasil`. + +## Generate configuration + +Before starting Yggdrasil, you should generate configuration. Open a Command Prompt as Administrator: +``` +"C:\Program Files\Yggdrasil\yggdrasil.exe" -genconf > "C:\Program Files\Yggdrasil\yggdrasil.conf" +``` + +## Run Yggdrasil + +### Run once + +Open a Command Prompt as Administrator and start Yggdrasil using your generated configuration: +``` +"C:\Program Files\Yggdrasil\yggdrasil.exe" -useconffile "C:\Program Files\Yggdrasil\yggdrasil.conf" +``` +Alternatively, start Yggdrasil in auto-configuration mode: +``` +"C:\Program Files\Yggdrasil\yggdrasil.exe" -autoconf +``` + +### Run as a background service + +Running as a background system service means that Yggdrasil will automatically start up in the background when Windows boots. + +Assuming that Yggdrasil is installed into `C:\Program Files\Yggdrasil` and your configuration *already exists* in `C:\Program Files\Yggdrasil\yggdrasil.conf`, as above, then you can install Yggdrasil as a Windows service. Open a Command Prompt as Administrator: +``` +sc create yggdrasil binpath= "\"C:\Program Files\Yggdrasil\yggdrasil.exe\" -useconffile \"C:\Program Files\Yggdrasil\yggdrasil.conf\"" +sc config yggdrasil displayname= "Yggdrasil Service" +sc config yggdrasil start= "auto" +sc start yggdrasil +``` +Alternatively, if you want the service to autoconfigure instead of using an `yggdrasil.conf`, replace the `sc create` line from above with: +``` +sc create yggdrasil binpath= "\"C:\Program Files\Yggdrasil\yggdrasil.exe\" -autoconf" +``` + +The Yggdrasil service can then be stopped and started using `services.msc`, or in more recent versions of Windows, the Task Manager. diff --git a/installation.md b/installation.md index f6e5c94..cced1eb 100644 --- a/installation.md +++ b/installation.md @@ -21,3 +21,7 @@ Installation guides are available for the following platforms/distributions. ## iOS - [App installation](installation-ios-app.md) + +## Windows + +- [Manual install as a Windows service](installation-windows.md) diff --git a/platform-windows.md b/platform-windows.md index 1584c7a..626fc2e 100644 --- a/platform-windows.md +++ b/platform-windows.md @@ -14,61 +14,6 @@ Yggdrasil has been tested and is working on the following versions of Windows: It may work on other versions of Windows too, although these are untested. -## TAP Driver - -Yggdrasil depends on the OpenVPN TAP driver to work on Windows. There are two flavours of this driver: - -- [NDIS 5](https://swupdate.openvpn.org/community/releases/tap-windows-9.9.2_3.exe) (`tap-windows-9.9.2_3`) - recommended -- [NDIS 6](https://swupdate.openvpn.org/community/releases/tap-windows-9.21.2.exe) (`tap-windows-9.21.2`) - functional - -Yggdrasil works with either driver, although the performance is remarkably better with the older NDIS 5 driver, therefore it is recommended to use that instead of the NDIS 6 driver. - -Please note that if you already have OpenVPN for Windows, you likely have one of the two drivers installed already and should not install it again. - ## Notes - TUN mode is not supported on Windows, and attempts to configure TUN mode will default to TAP mode automatically. - -## Installation - -Start by [downloading the latest Yggdrasil binary](builds.md) and use Windows Explorer to copy it into a sensible location and rename it to `yggdrasil.exe`. - -The below examples assume that you placed `yggdrasil.exe` into `C:\Program Files\Yggdrasil`. - -## Generate configuration - -Before starting Yggdrasil, you should generate configuration. Open a Command Prompt as Administrator: -``` -"C:\Program Files\Yggdrasil\yggdrasil.exe" -genconf > "C:\Program Files\Yggdrasil\yggdrasil.conf" -``` - -## Run Yggdrasil - -### Run once - -Open a Command Prompt as Administrator and start Yggdrasil using your generated configuration: -``` -"C:\Program Files\Yggdrasil\yggdrasil.exe" -useconffile "C:\Program Files\Yggdrasil\yggdrasil.conf" -``` -Alternatively, start Yggdrasil in auto-configuration mode: -``` -"C:\Program Files\Yggdrasil\yggdrasil.exe" -autoconf -``` - -### Run as a background service - -Running as a background system service means that Yggdrasil will automatically start up in the background when Windows boots. - -Assuming that Yggdrasil is installed into `C:\Program Files\Yggdrasil` and your configuration *already exists* in `C:\Program Files\Yggdrasil\yggdrasil.conf`, as above, then you can install Yggdrasil as a Windows service. Open a Command Prompt as Administrator: -``` -sc create yggdrasil binpath= "\"C:\Program Files\Yggdrasil\yggdrasil.exe\" -useconffile \"C:\Program Files\Yggdrasil\yggdrasil.conf\"" -sc config yggdrasil displayname= "Yggdrasil Service" -sc config yggdrasil start= "auto" -sc start yggdrasil -``` -Alternatively, if you want the service to autoconfigure instead of using an `yggdrasil.conf`, replace the `sc create` line from above with: -``` -sc create yggdrasil binpath= "\"C:\Program Files\Yggdrasil\yggdrasil.exe\" -autoconf" -``` - -The Yggdrasil service can then be stopped and started using `services.msc`, or in more recent versions of Windows, the Task Manager.