mirror of
https://github.com/cwinfo/yggdrasil-network.github.io.git
synced 2025-02-28 12:51:34 +00:00
Windows installation page
This commit is contained in:
Neil Alexander
parent
0bad187337
commit
f323da9a0e
59
installation-windows.md
Normal file
59
installation-windows.md
Normal file
@ -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.
|
||||
@ -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)
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user