2019-07-20 10:28:57 +00:00
|
|
|
---
|
|
|
|
|
tags: dontlink
|
|
|
|
|
sitemap: true
|
|
|
|
|
---
|
|
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
# Installing using the Windows installer
|
2019-07-20 10:31:48 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Yggdrasil is supported on Windows. You can [download the latest installer from
|
|
|
|
|
GitHub](https://github.com/yggdrasil-network/yggdrasil-go/releases).
|
2019-07-20 10:31:48 +00:00
|
|
|
|
2021-06-16 16:40:34 +00:00
|
|
|
On Windows 7 and Server 2008 R2, you must install hotfix KB2921916 before installing
|
|
|
|
|
Yggdrasil:
|
|
|
|
|
|
|
|
|
|
* [KB2921916 for 64-bit systems](https://download.wireguard.com/windows-toolchain/distfiles/Windows6.1-KB2921916-x64.msu)
|
|
|
|
|
* [KB2921916 for 32-bit systems](https://download.wireguard.com/windows-toolchain/distfiles/Windows6.1-KB2921916-x86.msu)
|
|
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
## TUN driver
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Starting with version 0.3.13, Yggdrasil on Windows uses the Wireguard TUN
|
|
|
|
|
driver. If this is not installed on the system already, it will be installed
|
|
|
|
|
automatically by the Yggdrasil installer.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
For this reason, it is important that you use the correct installer for your
|
|
|
|
|
architecture - make sure to use the `x64` installer on 64-bit Windows and the
|
|
|
|
|
`x86` installer on 32-bit Windows.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Please note that the OpenVPN TAP driver is **no longer supported**.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Once Yggdrasil is started, a new virtual network adapter will be created called
|
|
|
|
|
`Yggdrasil` by default, although this can be renamed using the `IfName` option
|
|
|
|
|
in the configuration file (below). The virtual network adapter will *not* be
|
|
|
|
|
visible on the system when Yggdrasil is not running.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
## Configuration
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
The Yggdrasil installer will automatically generate an `yggdrasil.conf`
|
2020-09-27 11:48:31 +00:00
|
|
|
configuration file, if one does not exist, in:
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-09-27 11:48:31 +00:00
|
|
|
```
|
|
|
|
|
%ALLUSERSPROFILE%\Yggdrasil\yggdrasil.conf
|
|
|
|
|
```
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
## Windows Service
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Yggdrasil is installed as a Windows service that starts automatically with
|
|
|
|
|
Windows. You can start, stop and restart Yggdrasil using the Services MMC
|
|
|
|
|
snap-in (`services.msc`) or, in more recent versions of Windows, the "Services"
|
|
|
|
|
tab in Task Manager.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
You will need to restart the Yggdrasil service after each change to the
|
|
|
|
|
configuration file.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
## Windows Firewall
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Windows Firewall may prompt for the Yggdrasil process to allow incoming or
|
|
|
|
|
outgoing connections. If so, you should allow this or Yggdrasil may not be able
|
|
|
|
|
to establish peerings correctly.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
Note that Yggdrasil, by default, does allow incoming traffic over the
|
|
|
|
|
`Yggdrasil` virtual adapter, therefore you may wish to designate the `Yggdrasil`
|
|
|
|
|
virtual network adapter as a public network in the Windows Firewall so that
|
|
|
|
|
unexpected incoming connections are blocked automatically.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
If you do, pay particular attention to ensure that file sharing (SMB), remote
|
|
|
|
|
procedure call (RPC) or remote desktop (RDP) services are not allowed on public
|
|
|
|
|
networks unless you explicitly need them to be accessible from remote Yggdrasil
|
|
|
|
|
hosts.
|
2019-07-20 10:28:57 +00:00
|
|
|
|
2020-02-17 20:15:50 +00:00
|
|
|
## yggdrasilctl
|
|
|
|
|
|
|
|
|
|
The `yggdrasilctl` utility is also installed into the same location above. You
|
|
|
|
|
can query Yggdrasil's runtime state using this tool using a Command Prompt or
|
|
|
|
|
PowerShell command line, e.g.
|
2019-07-20 10:28:57 +00:00
|
|
|
```
|
2020-02-17 20:15:50 +00:00
|
|
|
"C:\Program Files\Yggdrasil\yggdrasilctl.exe" getPeers
|
2019-07-20 10:28:57 +00:00
|
|
|
```
|
