yggdrasil-network / yggdrasil-go

Yggdrasil Introduction 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 folder. Building If you want to build from source, as opposed to installing one of the pre-built packages: • Install Go (requires Go 1.22 or later) • Clone this repository • Run Note that you can cross-compile for other platforms and architectures by specifying the and environment variables, e.g. or . Running Generate configuration To generate static configuration, either generate a HJSON file (human-friendly, complete with comments): ... or generate a plain JSON file (which is easy to manipulate programmatically): You will need to edit the 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: To run in auto-configuration mode (which will use sane defaults and random keys at each startup, instead of using a static configuration file): You will likely need to run Yggdrasil as a privileged user or under , unless you have permission to create TUN/TAP adapters. On Linux this can be done by giving the Yggdrasil binary the capability. Documentation Documentation is available on our website. • Installing Yggdrasil • Configuring Yggdrasil • Frequently asked questions • Version changelog Communities A number of IRC communities exist, including the IRC channel on libera.chat and various others on Yggdrasil-internal IRC networks. License 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.