macOS Client

Configuration of the Yggdrasil Private Relay on macOS

Install Yggdrasil

We recommend running the latest stable .pkg file from GitHub Releases, e.g. yggdrasil-0.5.12-macos-arm64.pkg (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 /etc/yggdrasil.conf.

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

sudo yggdrasil -genconf > /etc/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: en.*
            Beacon: true
            Listen: true
            Password: ""
        }
        {
            Regex: bridge.*
            Beacon: true
            Listen: true
            Password: ""
        }
        {
            Regex: awdl0
            Beacon: false
            Listen: false
            Password: ""
        }
    ]
    AllowedPublicKeys: []
    IfName: auto
    # 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 run:

sudo launchctl unload /Library/LaunchDaemons/yggdrasil.plist
sudo launchctl load /Library/LaunchDaemons/yggdrasil.plist

To stop the Yggdrasil service (also disables auto-initialize on boot):

sudo launchctl unload /Library/LaunchDaemons/yggdrasil.plist

Get Yggdrasil IP address

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

sudo yggdrasilctl getself