mirror of
https://github.com/yggdrasil-network/yggdrasil-go.git
synced 2024-11-25 11:05:26 +00:00
98 lines
3.3 KiB
Markdown
98 lines
3.3 KiB
Markdown
# Yggdrasil
|
|
|
|
[](https://github.com/yggdrasil-network/yggdrasil-go/actions/workflows/ci.yml)
|
|
|
|
## 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](https://yggdrasil-network.github.io/installation.html)
|
|
page for more information. You may also find other platform-specific wrappers, scripts
|
|
or tools in the `contrib` folder.
|
|
|
|
## Building
|
|
|
|
If you want to build from source, as opposed to installing one of the pre-built
|
|
packages:
|
|
|
|
1. Install [Go](https://golang.org) (requires Go 1.17 or later)
|
|
2. Clone this repository
|
|
2. 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`.
|
|
|
|
## Running
|
|
|
|
### 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
|
|
|
|
Documentation is available [on our website](https://yggdrasil-network.github.io).
|
|
|
|
- [Installing Yggdrasil](https://yggdrasil-network.github.io/installation.html)
|
|
- [Configuring Yggdrasil](https://yggdrasil-network.github.io/configuration.html)
|
|
- [Frequently asked questions](https://yggdrasil-network.github.io/faq.html)
|
|
- [Version changelog](CHANGELOG.md)
|
|
|
|
## Community
|
|
|
|
Feel free to join us on our [Matrix
|
|
channel](https://matrix.to/#/#yggdrasil:matrix.org) at `#yggdrasil:matrix.org`
|
|
or in the `#yggdrasil` IRC channel on [libera.chat](https://libera.chat).
|
|
|
|
## License
|
|
|
|
This code is released under the terms of the LGPLv3, but with an added exception
|
|
that was shamelessly taken from [godeb](https://github.com/niemeyer/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](LICENSE).
|