Installing on a VyOS-based UniFi Gateway Devices¶

This guide is for devices running VyOS such as:

USG 3P
USG Pro 4

Install the binary¶

Determine which architecture the USG is using:

uname -a

Determine if the USG is using softfloat or hardfloat optimizations:

readelf -A /bin/sh | grep ABI_FP

Tip

To ensure that ddns-route53 persists across reboots, it should be stored in the /config/scripts directory.

Install the ddns-route53 binary that matches the reported architecture and float type by following the install from binary instructions.

Now you have to create your ddns-route53.yml configuration file in /config/scripts/ddns-route53.yml

On the Cloud Key/Controller¶

Find the UniFi base path¶

By default, the paths are as follows:

UniFi Cloud Key: /srv/unifi
Debian/Ubuntu Linux: /usr/lib/unifi
Windows: %USERPROFILE%/Ubiquiti UniFi
macOS: ~/Library/Application Support/UniFi

Create a `config.gateway.json`¶

Create a file called config.gateway.json in your <unifi_base>/data/sites/<site_id> directory with the following contents:

{
  "system": {
    "task-scheduler": {
      "task": {
        "dnsupdate": {
          "executable": {
            "path": "/config/scripts/ddns-route53 --config /config/scripts/ddns-route53.yml"
          },
          "interval": "1m"
        }
      }
    }
  }
}

Tip

The interval field sets how often ddns-route53 will run (e.g. 1 minute).

Info

See UniFi - USG advanced configuration using config.gateway.json for more information.

Trigger a provision for the USG¶

See How to trigger a provision for instructions.

Last update: 2021-07-12 18:06:37
Created: 2020-07-22 09:34:17