Skip to content

Commit

Permalink
Update installation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
neilalexander committed Sep 24, 2022
1 parent 832b72e commit c05d4be
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 58 deletions.
40 changes: 17 additions & 23 deletions installation-linux-deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ Yggdrasil is supported on Debian Linux. Debian binary packages exist to simplify
the installation of Yggdrasil. These will also work on any Debian-based
distribution, e.g. elementaryOS.

## One-off installation

Debian packages are built and are available in the [GitHub Releases](https://github.com/yggdrasil-network/yggdrasil-go/releases).
Install the package using `dpkg -i filename.deb`.

## Package install from your distribution

Some Debian-based distributions may have an `yggdrasil-go` package available in
their repositories:
```
sudo apt-get install yggdrasil
```

## Package install from the S3 repository

On some platforms, e.g. Raspberry Pi, you may need to start by installing
Expand Down Expand Up @@ -39,6 +52,9 @@ Install Yggdrasil:
```
sudo apt-get install yggdrasil
```

## After installation

Configuration will be generated automatically into `/etc/yggdrasil.conf` when
the package is installed, and the Yggdrasil service will automatically be
installed into `systemd`.
Expand All @@ -49,32 +65,10 @@ sudo systemctl enable yggdrasil
sudo systemctl start yggdrasil
```

## One-off package install from CircleCI

Visit our [Builds](builds.md) page and download the relevant `.deb` file, then
install it on your system. If you want to install the latest `.deb` from the
`master` branch:
```
curl -so- "https://circleci.com/api/v1.1/project/github/yggdrasil-network/yggdrasil-go/latest/artifacts?branch=master&filter=successful" | \
egrep -o "https.*yggdrasil\-.*$(dpkg --print-architecture).deb" | \
while read line; do curl -O $line && dpkg -i $(basename $line); done
```
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.

### Making configuration changes

Modify the `/etc/yggdrasil.conf` file and then either reload the config:
```
systemctl reload yggdrasil
```
... or restart the Yggdrasil daemon altogether:
To make configuration changes, modify the `/etc/yggdrasil.conf` file and then restart the Yggdrasil daemon:
```
systemctl restart yggdrasil
```

## After installation

Read the [Linux platform page](configuration.md) page for further
information about Linux platform support.
10 changes: 0 additions & 10 deletions installation-linux-other.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,6 @@ sitemap: true
Yggdrasil is supported on Linux. You can either [download the latest binary from
CircleCI](builds.md) or you can build from source.

## Download binaries

Download the relevant Linux `yggdrasil` and `yggdrasilctl` binaries from the
[Builds](builds.md) page.

Copy these into a suitable location:
```
sudo cp {yggdrasil,yggdrasilctl} /usr/local/bin
```

## Build from source

Linux has most of the tools needed to build Yggdrasil from source - you just
Expand Down
28 changes: 3 additions & 25 deletions installation-linux-rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,24 @@ sitemap: true
RPM binary packages exist to simplify the installation of Yggdrasil. These
will also work on any other RPM-based distribution.


## Install RPM package from COPR repository

There's a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/rany/yggdrasil/) available, which provides recent versions of Yggdrasil - *only for Fedora!*

There's a [Fedora COPR repository](https://copr.fedorainfracloud.org/coprs/neilalexander/yggdrasil-go/) available, which provides recent versions of Yggdrasil for some RPM-based distributions.

### Fedora

Installation on Fedora is easy as:

```bash
dnf copr enable rany/yggdrasil
dnf copr enable neilalexander/yggdrasil-go
dnf install yggdrasil
```

... and you're ready to go!


## One-off package install from CircleCI (not recommended!)

Visit our [Builds](builds.md) page and download the relevant `.rpm` file, then
install it on your system:
```
sudo groupadd --system yggdrasil
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.

**Please note: By using this installation method, you won't receive (security-/) updates for Yggdrasil!**


## Making configuration changes

Modify the `/etc/yggdrasil.conf` file and then either reload the config:
```
systemctl reload yggdrasil
```
... or restart the Yggdrasil daemon altogether:
Modify the `/etc/yggdrasil.conf` file and then either restart the Yggdrasil daemon:
```
systemctl restart yggdrasil
```
Expand Down

0 comments on commit c05d4be

Please sign in to comment.