VyOS is an open source router operating system that has been successfully installed on all of the Vault platforms. The VyOS home page is at https://www.vyos.io. The current “Stable” versions do not install on the Vault. They have the exact issue as described in the VyOS forum at this link. However the Beta builds do install on the Vault. The test installation was done with the VyOS build from November 1, 2017.
To install a fresh instance of VyOS onto the Vault, there is a relatively straight forward process that is very similar to installing any operating system onto any computer.
- Obtain the installation image
- Download software to transfer the installation image to a USB drive
- Install the new image
There are a few steps along the way that I’ll highlight so as to make sure that the process is very clear
Note: If using the Vault FW1x, FW2x, or FW4x, be sure to use a USB stick and the USB keyboard with a plug that is relatively skinny. The 2 USB ports on the Vault are very close to each other and if either the USB stick or the USB keyboard plug is too wide, you will not be able to plug both in at the same time, which will prevent you from doing the installation.
Obtain the Installation Image
The VyOS installation image can be downloaded from https://www.vyos.io. The same image can be used to install VyOS on any of the Vault platforms. It is important to choose the correct options when downloading the image.
Select “Download” from the VyOS main page
Select “Beta Version”
Select an image. Protectli recommends the most recent image.
Your download should begin immediately and when it is completed you should have an ISO file (an example file name is: vyos-999.201710312237-amd64.iso) downloaded that is ~350MB in size.
Download software to transfer the installation image to a USB drive
There are multiple applications to transfer the installation image to a USB drive. Protectli recommends “Rufus” for Windows and “Etcher” for the Mac. See this link for detailed instructions on how to create a bootable USB drive using Rufus or Etcher.
Install the new image
Once the VyOS installation image is properly copied to the USB drive, it is ready to be installed on the Vault.
- Verify that the Vault is powered down.
- Verify that the VGA monitor or serial console is connected.
- Verify that the USB keyboard is plugged in.
- Insert the USB install drive into the other USB port on the Vault.
- While powering up the Vault, press “F11” key and hold it down until it boots to the BIOS and you see the boot options screen.
- Select the USB drive to boot from.
- Verify that the Vault boots to the “Boot menu”
- Select Live (amd64-vyos) and press Enter to begin the boot process.
- Verify that the vyos login prompt occurs
- Login as user “vyos” with password “vyos”
- Type “install image” and verify that the installation process begins
- When prompted for partitions, select “Auto”.
- Install image on “sda” and continue (“Yes”)
- Accept default root partition size
- Select a name for the image or accept the default
- Select the default for config.boot
- Enter a password for user “vyos”
- Select the default for the GRUB partition
- Verify the installation completes and the vyos prompt reappears.
An example installation is shown below
VyOS Login and Begin Install
VyOS has a command line interface (CLI) only. To verify that it has been installed, type “show configuration” at the CLI. Sample output below. The available commands can be found by typing a question mark “?” at the CLI.
Documentation and more information for VyOS can be found on the VyOS Wiki page at this link.
VyOS should be up and running. If you experience any issues, please feel free to reach out: email@example.com.