5
0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-09-16 19:19:36 +00:00

Update installation pages

This commit is contained in:
Neil Alexander 2022-09-24 15:14:06 +01:00
parent 832b72e1e6
commit c05d4be955
No known key found for this signature in database
GPG Key ID: A02A2019A2BB0944
3 changed files with 20 additions and 58 deletions

View File

@ -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 the installation of Yggdrasil. These will also work on any Debian-based
distribution, e.g. elementaryOS. 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 ## Package install from the S3 repository
On some platforms, e.g. Raspberry Pi, you may need to start by installing On some platforms, e.g. Raspberry Pi, you may need to start by installing
@ -39,6 +52,9 @@ Install Yggdrasil:
``` ```
sudo apt-get install yggdrasil sudo apt-get install yggdrasil
``` ```
## After installation
Configuration will be generated automatically into `/etc/yggdrasil.conf` when Configuration will be generated automatically into `/etc/yggdrasil.conf` when
the package is installed, and the Yggdrasil service will automatically be the package is installed, and the Yggdrasil service will automatically be
installed into `systemd`. installed into `systemd`.
@ -49,32 +65,10 @@ sudo systemctl enable yggdrasil
sudo systemctl start yggdrasil sudo systemctl start yggdrasil
``` ```
## One-off package install from CircleCI To make configuration changes, modify the `/etc/yggdrasil.conf` file and then restart the Yggdrasil daemon:
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:
``` ```
systemctl restart yggdrasil systemctl restart yggdrasil
``` ```
## After installation
Read the [Linux platform page](configuration.md) page for further Read the [Linux platform page](configuration.md) page for further
information about Linux platform support. information about Linux platform support.

View File

@ -8,16 +8,6 @@ sitemap: true
Yggdrasil is supported on Linux. You can either [download the latest binary from Yggdrasil is supported on Linux. You can either [download the latest binary from
CircleCI](builds.md) or you can build from source. 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 ## Build from source
Linux has most of the tools needed to build Yggdrasil from source - you just Linux has most of the tools needed to build Yggdrasil from source - you just

View File

@ -10,46 +10,24 @@ sitemap: true
RPM binary packages exist to simplify the installation of Yggdrasil. These RPM binary packages exist to simplify the installation of Yggdrasil. These
will also work on any other RPM-based distribution. will also work on any other RPM-based distribution.
## Install RPM package from COPR repository ## 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 ### Fedora
Installation on Fedora is easy as: Installation on Fedora is easy as:
```bash ```bash
dnf copr enable rany/yggdrasil dnf copr enable neilalexander/yggdrasil-go
dnf install yggdrasil dnf install yggdrasil
``` ```
... and you're ready to go! ... 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 ## Making configuration changes
Modify the `/etc/yggdrasil.conf` file and then either reload the config: Modify the `/etc/yggdrasil.conf` file and then either restart the Yggdrasil daemon:
```
systemctl reload yggdrasil
```
... or restart the Yggdrasil daemon altogether:
``` ```
systemctl restart yggdrasil systemctl restart yggdrasil
``` ```