Updating
An update keeps your settings. A fresh install erases them. Choose the update path unless you want to start over.
Over the air (recommended)
- Back up first: System → Backup.
- Upload
firmware.binin System → Firmware, or enable the opt-in GitHub update check there. - The gateway writes the free slot, restarts into it and keeps the previous image. If the new image does not start correctly, it returns to the previous one.
This works between 3.x versions. A 2.x gateway first moves to the 3.0 flash layout: see below.
From 2.x to 3.0
Firmware 3.0 uses a new 8 MB flash layout, so the 2.x updater does not offer it. Settings, the tailnet identity and saved Wi-Fi are kept on every path:
- Over the network: in System → Firmware update install 2.1.0, the migration bridge (a normal 2.x update). Turn on the web UI lock (System → Access → Require the admin password) and sign in — the migration needs it. Then System → Maintenance → Move to the 3.0 flash layout: tick the confirmation and press Migrate to 3.0. Keep the power on; it takes a few minutes and returns to 2.1.0 if 3.0 does not start.
- Over USB: the browser installer with Erase device unticked, or
UPDATE-KEEP-SETTINGS/install.sh updatefrom the Easy Install package.
Boards with 4 MB of flash cannot run 3.0 and stay on 2.x. Full guide: Moving a 2.x gateway to 3.0.
From v2.0.0 or v2.0.1
The GitHub updater in these two releases restarts the gateway without installing the update. For the network migration, upload firmware.bin from the 2.1.0 bridge once in System → Firmware, then follow the bridge steps above. Do not upload the current 3.x application directly into a 2.x slot. Alternatively, use the current Easy Install package over USB keeping settings.
By USB, keeping settings
Use the browser installer with Erase device unticked, or UPDATE-KEEP-SETTINGS / install.sh update from the Easy Install package.
From 1.13 and earlier to v3.0.2
These installations use the old 4 MB layout and cannot install the current 3.x application as an ordinary OTA update. Their older updater can also fail after the repository rename.
- Back up your configuration and check the 3.x hardware requirements.
- For USB, use the current Easy Install keep-settings option.
- For a staged network upgrade, first upload
firmware.binfrom the legacy 1.100 bridge release. Then install the 2.1.0 bridge and follow Move to the 3.0 flash layout.
Use the image belonging to each bridge stage, not firmware.bin from the latest 3.x release. See the legacy migration guide. Keeping configuration does not reopen the initial setup wizard.