vyatta-wireguard-installer's Introduction

vyatta-wireguard-installer

Install, upgrade or remove WireGuard (Lochnair/vyatta-wireguard) on Ubiquiti hardware. By default, the installer caches the deb-package so that the same version of WireGuard can be restored after a firmware upgrade.

Installation

Simply copy the script onto your Ubiquiti router and run it.

Note: By placing this script in /config/scripts/post-config.d, the WireGuard installation will persist across firmware upgrades.

curl -sSL https://github.com/mafredri/vyatta-wireguard-installer/raw/master/wireguard.sh -o /config/scripts/post-config.d/wireguard.sh
chmod +x /config/scripts/post-config.d/wireguard.sh

Usage

$ ./wireguard.sh help
Install, upgrade or remove WireGuard (github.com/Lochnair/vyatta-wireguard) on
Ubiquiti hardware. By default, the installer caches the deb-package so that the
same version of WireGuard can be restored after a firmware upgrade.

Note: This script can be placed in /config/scripts/post-config.d for automatic
installation after firmware upgrades.

Usage:
  ./wireguard.sh [COMMAND] [OPTION]...

Commands:
  install      Install the latest version of WireGuard
  upgrade      Upgrade WireGuard to the latest version
  remove       Remove WireGuard
  self-update  Fetch the latest version of this script
  help         Show this help

Options:
      --no-cache  Disable package cache for this run, cache is used during (re)install

Todo

Investigate using /config/scripts/pre-config.d for post-firmware upgrade installation
- Why? It would make WireGuard available by the time the initial configuration is run
- Possible, since we cache the installer in /config/user-data/wireguard/cache.
Periodically check for new releases via cron (+automatic upgrades)
Support rollback if a release doesn't work as expected?
Check compatibility with current kernel / firmware version?