From 6365731e115518f20f10323622e62494f71c267b Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Fri, 15 Mar 2019 17:44:04 +0000 Subject: [PATCH] Use bigger headings --- installation-linux-deb.md | 6 +++--- installation-linux-edgeos.md | 6 +++--- installation-linux-other.md | 10 +++++----- installation-linux-rpm.md | 8 ++++---- installation-macos-other.md | 10 +++++----- installation-macos-pkg.md | 6 +++--- platforms.md | 2 +- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/installation-linux-deb.md b/installation-linux-deb.md index 67b0928..07f3ca9 100644 --- a/installation-linux-deb.md +++ b/installation-linux-deb.md @@ -9,7 +9,7 @@ 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. -### Package install from an Aptitude repository +## Package install from an Aptitude repository To start with, import the repository key to your `gpg` keyring and export it to your `apt` keyring: @@ -41,7 +41,7 @@ sudo systemctl enable yggdrasil sudo systemctl start yggdrasil ``` -### One-off package install from CircleCI +## 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 @@ -66,7 +66,7 @@ systemctl reload yggdrasil systemctl restart yggdrasil ``` -### After installation +## After installation Read the [Linux platform page](platform-linux.md) page for further information about Linux platform support. diff --git a/installation-linux-edgeos.md b/installation-linux-edgeos.md index 5bbfa73..0087e3a 100644 --- a/installation-linux-edgeos.md +++ b/installation-linux-edgeos.md @@ -12,7 +12,7 @@ Perform installation steps over SSH by connecting to the EdgeRouter as the `ubnt` user, e.g. `ssh ubnt@192.168.1.1`, or another admin-level user if configured. -### Package install from an Aptitude repository +## Package install from an Aptitude repository Start by adding the GPG key: ``` @@ -41,7 +41,7 @@ sudo apt-get update sudo apt-get upgrade ``` -### One-off package install from CircleCI +## One-off package install from CircleCI If you do not want to configure the repository above, you can perform a one-off installation by [downloading the latest vyatta-yggdrasil `.deb` @@ -51,7 +51,7 @@ curl -O https://xx-xxxxxxxxx-gh.circle-artifacts.com/x/vyatta-yggdrasil-x.x.xxx- sudo dpkg -i vyatta-yggdrasil-x.x.xxx-mipsel.deb ``` -### After installation +## After installation Read the [EdgeRouter platform page](platform-edgerouter.md) page for information on how to configure Yggdrasil and guidance on modifying the configuration. diff --git a/installation-linux-other.md b/installation-linux-other.md index d44db14..6d45444 100644 --- a/installation-linux-other.md +++ b/installation-linux-other.md @@ -8,7 +8,7 @@ sitemap: true Yggdrasil is supported on Linux. You can either [download the latest binary from CircleCI](builds.md) or you can build from source. -### Build from source +## Build from source Linux has most of the tools needed to build Yggdrasil from source - you just need to install the Go toolchain. Yggdrasil requires Go 1.11 as a minimum. @@ -35,13 +35,13 @@ into a suitable location: sudo cp {yggdrasil,yggdrasilctl} /usr/local/bin ``` -##### Debug builds +#### Debug builds You can create a debug build by running `./build -d` instead of `./build`. Debug builds contain profiling code as well as additional debugging symbols. They are likely to be larger files as a result. -### Install systemd service +## Install systemd service systemd service scripts are included in the `contrib/systemd/` folder so that it runs automatically in the background (using `/etc/yggdrasil.conf` for @@ -72,7 +72,7 @@ systemctl status yggdrasil journalctl -u yggdrasil ``` -### Generate configuration +## Generate configuration Generate an initial Yggdrasil configuration file: ``` @@ -82,7 +82,7 @@ sudo yggdrasil -genconf > /etc/yggdrasil.conf You can make changes to this file as described in the [Configuration](configuration.md) page. -### After installation +## After installation Read the [Linux platform page](platform-linux.md) page for further information about Linux platform support. diff --git a/installation-linux-rpm.md b/installation-linux-rpm.md index d8f5d06..492ae1f 100644 --- a/installation-linux-rpm.md +++ b/installation-linux-rpm.md @@ -8,7 +8,7 @@ sitemap: true RPM binary packages exist to simplify the installation of Yggdrasil. These will also work on any other RPM-based distribution. -### Package install from an RPM repository +## Package install from an RPM repository To start with, import the repository key to your `gpg` keyring and export it to your `rpm` keyring: @@ -47,7 +47,7 @@ sudo systemctl enable yggdrasil sudo systemctl start yggdrasil ``` -### One-off package install from CircleCI +## One-off package install from CircleCI Visit our [Builds](builds.md) page and download the relevant `.rpm` file, then install it on your system: @@ -59,7 +59,7 @@ 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 +## Making configuration changes Modify the `/etc/yggdrasil.conf` file and then either reload the config: ``` @@ -70,7 +70,7 @@ systemctl reload yggdrasil systemctl restart yggdrasil ``` -### After installation +## After installation Read the [Linux platform page](platform-linux.md) page for further information about Linux platform support. diff --git a/installation-macos-other.md b/installation-macos-other.md index ab98f4a..2751f38 100644 --- a/installation-macos-other.md +++ b/installation-macos-other.md @@ -8,7 +8,7 @@ sitemap: true Yggdrasil is supported on macOS. You can either [download the latest binary from CircleCI](builds.md) or you can build from source. -### Build from source +## Build from source macOS has most of the tools needed to build Yggdrasil from source - you just need to install the Go toolchain. Yggdrasil requires Go 1.11 as a minimum. @@ -34,13 +34,13 @@ you should install into `/usr/local/bin`: sudo cp {yggdrasil,yggdrasilctl} /usr/local/bin ``` -##### Debug builds +#### Debug builds You can create a debug build by running `./build -d` instead of `./build`. Debug builds contain profiling code as well as additional debugging symbols. They are likely to be larger files as a result. -### Install launchd service +## Install launchd service launchd service scripts are included in the `contrib/macos/` folder so that it runs automatically in the background (using `/etc/yggdrasil.conf` for @@ -64,7 +64,7 @@ tail -f /tmp/yggdrasil.stdout.log tail -f /tmp/yggdrasil.stderr.log ``` -### Generate configuration +## Generate configuration Generate an initial Yggdrasil configuration file: ``` @@ -74,7 +74,7 @@ sudo yggdrasil -genconf > /etc/yggdrasil.conf You can make changes to this file as described in the [Configuration](configuration.md) page. -### After installation +## After installation Read the [macOS platform page](platform-macos.md) page for further information about macOS platform support. diff --git a/installation-macos-pkg.md b/installation-macos-pkg.md index 1cf9e21..ad672ca 100644 --- a/installation-macos-pkg.md +++ b/installation-macos-pkg.md @@ -8,7 +8,7 @@ sitemap: true Yggdrasil is supported on macOS. Visit our [Builds](builds.md) page and download the relevant `.pkg` file -### Install using Finder +## Install using Finder Locate the downloaded `.pkg` installer in Finder. Right-click it and click Open. @@ -18,7 +18,7 @@ Once completed, the Yggdrasil configuration will have automatically been generated, the `launchd` service will have been installed and the service will be running. -### Install using Terminal +## Install using Terminal Open Terminal.app and install the package: ``` @@ -29,7 +29,7 @@ Once completed, the Yggdrasil configuration will have automatically been generated, the `launchd` service will have been installed and the service will be running. -### After installation +## After installation Read the [macOS platform page](platform-macos.md) page for further information about macOS platform support. diff --git a/platforms.md b/platforms.md index 860ca34..eed9c31 100644 --- a/platforms.md +++ b/platforms.md @@ -2,7 +2,7 @@ sitemap: true --- -# Platforms +# Platform Notes ## Linux