You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Neil Alexander 3d15da34ad
Release: Yggdrasil 0.5.4
1 week ago
.github/workflows Update dependencies, test cross-builds for FreeBSD and OpenBSD in CI 1 month ago
cmd Tweak logging 1 week ago
contrib Don't import `LDFLAGS` from the environment 1 month ago
misc update ironwood dependency, fix ansible code, go mod tidy 2 years ago
src Tweak logging 1 week ago
.golangci.yml golangci-lint in CI (#733) 3 years ago Release: Yggdrasil 0.5.4 1 week ago
Dockerfile Creating Dockerfile to / 5 years ago
LICENSE Rename to LICENSE 5 years ago Update 1 year ago
build Don't import `LDFLAGS` from the environment 1 month ago
clean Use #!/bin/sh for clean script 5 years ago
go.mod update ironwood dependency, should fix bloom filter encoding crash 1 week ago
go.sum update ironwood dependency, should fix bloom filter encoding crash 1 week ago


Build status


Yggdrasil is an early-stage implementation of a fully end-to-end encrypted IPv6 network. It is lightweight, self-arranging, supported on multiple platforms and allows pretty much any IPv6-capable application to communicate securely with other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet connectivity - it also works over IPv4.

Supported Platforms

Yggdrasil works on a number of platforms, including Linux, macOS, Ubiquiti EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.

Please see our Installation page for more information. You may also find other platform-specific wrappers, scripts or tools in the contrib folder.


If you want to build from source, as opposed to installing one of the pre-built packages:

  1. Install Go (requires Go 1.17 or later)
  2. Clone this repository
  3. Run ./build

Note that you can cross-compile for other platforms and architectures by specifying the GOOS and GOARCH environment variables, e.g. GOOS=windows ./build or GOOS=linux GOARCH=mipsle ./build.


Generate configuration

To generate static configuration, either generate a HJSON file (human-friendly, complete with comments):

./yggdrasil -genconf > /path/to/yggdrasil.conf

... or generate a plain JSON file (which is easy to manipulate programmatically):

./yggdrasil -genconf -json > /path/to/yggdrasil.conf

You will need to edit the yggdrasil.conf file to add or remove peers, modify other configuration such as listen addresses or multicast addresses, etc.

Run Yggdrasil

To run with the generated static configuration:

./yggdrasil -useconffile /path/to/yggdrasil.conf

To run in auto-configuration mode (which will use sane defaults and random keys at each startup, instead of using a static configuration file):

./yggdrasil -autoconf

You will likely need to run Yggdrasil as a privileged user or under sudo, unless you have permission to create TUN/TAP adapters. On Linux this can be done by giving the Yggdrasil binary the CAP_NET_ADMIN capability.


Documentation is available on our website.


Feel free to join us on our Matrix channel at or in the #yggdrasil IRC channel on


This code is released under the terms of the LGPLv3, but with an added exception that was shamelessly taken from godeb. Under certain circumstances, this exception permits distribution of binaries that are (statically or dynamically) linked with this code, without requiring the distribution of Minimal Corresponding Source or Minimal Application Code. For more details, see: LICENSE.