Skip to content

Update readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update readme #12

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34e463d
Add features to readme
HLeithner Feb 5, 2021
d011b11
Use sudo for download
HLeithner Feb 5, 2021
b3670e8
Revert single line install
HLeithner Feb 21, 2021
604bb81
Add sudo to commands
HLeithner May 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# Download and install WireGuard on Ubiquiti edge devices
# Introduction

***Warning:*** _This script attempts to preserve your running configuration, however you should have a backup of your configuration before running this script._

This script installs and maintaince the wireguard vpn solution on a ubiquiti router.

*Features*

* Simple installation
* Automatically detect used hardware
* Proper upgrade process preserving configuration
* Scheduled auto update
* Preserve wireguard on firmware upgrade
* Preserve wireguard configuration on firmeware upgrade

# Download and install WireGuard on Ubiquiti edge devices

This script will reference [WireGuard/wireguard-vyatta-ubnt](https://github.com/WireGuard/wireguard-vyatta-ubnt) repo for WireGuard releases. It will download, install, and setup the package to install post firmware upgrade. Rebooting the device is **not** required after running this script as long as the script did not generate any errors. Grab the script by running the following commands from the web CLI or SSH.

```
cd /config/scripts
curl -LO --silent https://github.com/whiskerz007/ubnt_get_wireguard/raw/master/get_wireguard.sh
chmod +x get_wireguard.sh
sudo curl -LO --silent https://github.com/whiskerz007/ubnt_get_wireguard/raw/master/get_wireguard.sh
sudo chmod +x get_wireguard.sh
```

***Note:*** _Best practice is to save scripts into `/config/scripts` directory._
Expand All @@ -17,13 +30,13 @@ chmod +x get_wireguard.sh
To download and install the latest release of WireGuard, run the following command.

```
./get_wireguard.sh
sudo ./get_wireguard.sh
```

To download and install a specific release of WireGuard, run the following command with the desired release as a parameter.

```
./get_wireguard.sh 0.0.20190913-1
sudo ./get_wireguard.sh 0.0.20190913-1
```

## Log
Expand Down