Windows Client

Configuration of the Yggdrasil Private Relay on Windows

Install Yggdrasil

We recommend running the latest stable .msi file from GitHub Releases, e.g. yggdrasil-0.5.12-x64.msi (may be hidden under Show all assets). Additional build instructions can be found on the official website.

Generate a Keypair

A keypair is automatically generated, under %ALLUSERSPROFILE%\Yggdrasil\yggdrasil.conf.

To generate a new keypair and configuration file for your client run:

"C:\Program Files\Yggdrasil\yggdrasil.exe" -genconf > "%ALLUSERSPROFILE%\Yggdrasil\yggdrasil.conf"

Manual Configuration

Edit the yggdrasil.conf using the template below. The Private Relay address can be found in the "Manage Subscription" page under "Yggdrasil Private Relay --> Edit --> Peer Configuration". Any changes made here may take up to 15 minutes to propogate to our servers.

For each #comment, edit the subsequent line using the instructions provided.

{
    PrivateKey: XXXXXXXX
    # Replace the address here with the Peer Configuration from above
    Peers: [
        "tls://hjxzjhx.hoppy.link:443/?sni=9b56.hoppy.link&password=abcd1234"
    ]
    InterfacePeers: {}
    Listen: []
    # Set Beacon and Listen to false to disable LAN peering
    MulticastInterfaces: [
        {
            Regex: .*
            Beacon: true
            Listen: true
            Password: ""
        }
    ]
    AllowedPublicKeys: []
    IfName: Yggdrasil
    # For latency sensitive applications, e.g. game streaming, set MTU to 1280
    IfMTU: 65535
    NodeInfoPrivacy: false
    NodeInfo: {}
}

Restart Yggdrasil

Yggdrasil should already be running, to reload the current configuration go to the Windows Services management console, find Yggdrasil Service, then Restart.

To stop the Yggdrasil service from auto-initializing on boot, go to Properties --> Startup type and select Disabled.

Get Yggdrasil IP address

To print out your new Yggdrasil IP address to the terminal:

"C:\Program Files\Yggdrasil\yggdrasilctl.exe" getself