||4 months ago|
|.circleci||4 months ago|
|cmd||4 months ago|
|contrib||4 months ago|
|doc||1 year ago|
|misc||4 months ago|
|src||4 months ago|
|.gitmodules||1 year ago|
|.golangci.yml||4 months ago|
|CHANGELOG.md||4 months ago|
|Dockerfile||2 years ago|
|LICENSE||2 years ago|
|README.md||4 months ago|
|appveyor.yml||1 year ago|
|build||1 year ago|
|clean||2 years ago|
|go.mod||8 months ago|
|go.sum||8 months ago|
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.
Although Yggdrasil shares many similarities with cjdns, it employs a different routing algorithm based on a globally-agreed spanning tree and greedy routing in a metric space, and aims to implement some novel local backpressure routing techniques. In theory, Yggdrasil should scale well on networks with internet-like topologies.
We actively support the following platforms, and packages are available for some of the below:
.rpmpackages are built by CI for Debian and Red Hat-based distributions
- Arch, Nix, Void packages also available within their respective repositories
.pkgpackages are built by CI
- Ubiquiti EdgeOS
.debVyatta packages are built by CI
Please see our Platforms pages for more specific information about each of our supported platforms, including installation steps and caveats.
You may also find other platform-specific wrappers, scripts or tools in the
If you want to build from source, as opposed to installing one of the pre-built packages:
- Install Go (requires Go 1.13 or later)
- Clone this repository
Note that you can cross-compile for other platforms and architectures by
GOARCH environment variables, e.g.
GOOS=windows ./build or
GOOS=linux GOARCH=mipsle ./build.
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.
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):
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
Documentation is available on our GitHub
Pages site, or in the base submodule
- Configuration file options
- Platform-specific documentation
- Frequently asked questions
- Admin API documentation
- Version changelog
Feel free to join us on our Matrix
or in the
#yggdrasil IRC channel on Freenode.
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.