yggdrasil-network.github.io/platform-linux.md

tags
dontlink

Linux

Yggdrasil is well supported on Linux.

Notes

• Should work with any kernel that includes tun and/or tap.
• The maximum MTU size supported on Linux is 65535.
• Binary .deb packages are available for Debian, Ubuntu, elementaryOS and similar distributions.
• Binary .rpm packages are available for Red Hat Enterprise Linux, Fedora, CentOS and similar distributions.

Debian, Ubuntu, elementaryOS

Debian binary packages exist to simplify the installation of Yggdrasil. These will also work on any Debian-based distribution.

From CircleCI

Visit our Builds page and download the relevant .deb file, then install it on your system:

sudo dpkg -i yggdrasil...deb

Configuration will be generated automatically into /etc/yggdrasil.conf when the package is installed, and the Yggdrasil service will automatically be installed into systemd and started.

From an Internet repository

To start with, trust the repository key:

curl -o- http://neilalexander.s3.eu-west-2.amazonaws.com/deb/key.txt | sudo apt-key add -

Add the repository:

echo 'deb http://neilalexander.s3.eu-west-2.amazonaws.com/deb/ debian yggdrasil' | sudo tee /etc/apt/sources.list.d/yggdrasil.list
sudo apt-get update

Install Yggdrasil:

sudo apt-get install yggdrasil

Configuration will be generated automatically into /etc/yggdrasil.conf when the package is installed, and the Yggdrasil service will automatically be installed into systemd and started.

Red Hat Enterprise Linux, Fedora, CentOS

RPM binary packages exist to simplify the installation of Yggdrasil. These will also work on any other RPM-based distribution.

From CircleCI

Visit our Builds page and download the relevant .rpm file, then install it on your system:

sudo rpm -i yggdrasil...rpm

Configuration will be generated automatically into /etc/yggdrasil.conf when the package is installed, and the Yggdrasil service will automatically be installed into systemd and started.

Other Distributions

Download the latest Yggdrasil binary and install it:

sudo cp ~/yggdrasil-x.x.xx-linux-amd64 /usr/bin/yggdrasil
sudo chmod +x /usr/bin/yggdrasil

Alternatively, compile Yggdrasil from source (below) and install:

sudo cp /path/to/yggdrasil-go/yggdrasil /usr/bin/yggdrasil
sudo chmod +x /usr/bin/yggdrasil

Generate configuration

If you do not have a configuration file, you should generate configuration before starting Yggdrasil:

sudo yggdrasil -genconf > /etc/yggdrasil.conf

Run Yggdrasil

Run once

Open a shell and start Yggdrasil using your generated configuration:

sudo nohup yggdrasil -useconffile /etc/yggdrasil.conf &

Alternatively, start Yggdrasil in auto-configuration mode:

sudo nohup yggdrasil -autoconf &

Run with systemd

systemd service scripts are included in the contrib/systemd/ folder so that it runs automatically in the background (using /etc/yggdrasil.conf for configuration).

Copy the service files into /etc/systemd/system, copy yggdrasil into your $PATH, i.e. /usr/bin, and then enable the service:

systemctl enable yggdrasil
systemctl start yggdrasil

Once installed as a systemd service, you can read the yggdrasil output:

systemctl status yggdrasil
journalctl -u yggdrasil

Build instructions

Linux has most of the tools needed to build Yggdrasil from source - you just need to install Go 1.9 or later.

1. Install Go 1.9 or later, godeb is recommended for Debian-based distributions).
2. Open a shell, clone the repository and build:

cd /path/to
git clone https://github.com/yggdrasil-network/yggdrasil-go
cd yggdrasil-go
./build

1. The resulting yggdrasil file is your build - optionally install it into your system, as above.