| Next revision | Previous revision Next revisionBoth sides next revision |
| docs:guide-quick-start:admingui_sysupgrade [2017/08/19 16:48] – created alx | docs:guide-quick-start:sysupgrade.luci [2023/01/17 13:04] – [Backup] vgaetera |
|---|
| ====== Sysupgrading an existing LEDE device from the web admin GUI ====== | ====== Upgrading OpenWrt firmware using LuCI ====== |
| Your device must already have an older LEDE or OpenWrt firmware installed, to be eligible for this "sysupgrade" procedure. | Your device must already have an older OpenWrt firmware installed, to be eligible for this "sysupgrade" procedure. |
| | * Alternatively refer to the [[docs:guide-quick-start:factory_installation|factory installation]] howto, to install OpenWrt on a device that still has vendor factory firmware on it. |
| | * If your current OpenWrt installation does not have web interface installed or if you prefer to upgrade from the command line (upgrade from command line provides more fine-grained control), refer to [[docs:guide-user:installation:sysupgrade.cli|Upgrading OpenWrt firmware using CLI]]. |
| | * If you have any questions about this description, ask for help on the [[https://forum.openwrt.org/c/installation|Installing and Using OpenWrt forum section]] before beginning. |
| | * Be aware of major config incompatibilities and version compatibility [[docs:guide-quick-start:admingui_sysupgrade_keepsettings#upgrade_compatibility|Keep Settings and Upgrade Compatibility]] |
| |
| * Alternatively refer to the [[docs:guide-quick-start:factory_installation|factory installation]] howto, to install LEDE on a device that still has vendor factory firmware on it. | ===== Back up OpenWrt configuration ===== |
| * If your current LEDE installation does not have the web admin GUI installed or if you prefer to upgrade from the command line (upgrade from command line provides more fine-grained control), refer to [[docs:user-guide:ssh-firmware-upgrade|Upgrading LEDE from the Command Line]]. | {{section>docs:guide-user:installation:sysupgrade.cli#back_up_openwrt_configuration&noheader&nofooter&noeditbutton}} |
| * If you have any questions about this description, ask for help on the [[https://forum.lede-project.org/c/installation|Installing and Using LEDE forum section]] before beginning. | |
| | |
| ===== Locate and download the LEDE firmware ===== | |
| |
| | ===== Locate and download the OpenWrt firmware ===== |
| - On the [[toh:views:toh_fwdownload|Table of Hardware: Firmware downloads]] page, locate your specific device. | - On the [[toh:views:toh_fwdownload|Table of Hardware: Firmware downloads]] page, locate your specific device. |
| - When you have located your device in the list, click on the "View/edit data" link of the device record. This will open a new page with several details for your specific device. We recommend to bookmark that page, as it has lots of helpful information about your router. | - Download the sysupgrade file. **Please note that not all devices do have a firmware image called sysupgrade.bin.** |
| - On this device-specific **Techdata** page, at the bottom locate the line called **"Firmware LEDE Upgrade URL"** that links to a downloadable file called **"...sysupgrade.bin"**. | |
| - Download this file. | |
| |
| Troubleshooting: | Troubleshooting: |
| * Some devices lack a sysupgrade image and require a special (and usually a bit more complex) installation procedure that is device-specific. This tutorial won't apply for such devices. Instead locate and the corresponding device page in the older OpenWrt wiki and follow the custom installation description (Eventually older OpenWrt info will be migrated to the LEDE tech data pages). | * **Some devices lack a sysupgrade image** and require a special (and usually a bit more complex) installation procedure that is device-specific. This tutorial won't apply for such devices. Instead **follow the custom installation description on the corresponding device page** in the OpenWrt wiki. |
| * If you can't find your device, or if there is no "...sysupgrade.bin", you can consult the [[https://forum.lede-project.org/c/installation|"Installing and Using LEDE" Forum]] for help. | * If you don't find your device in the Table of Hardware or Device Pages/Techdata pages, you can also try [[docs:guide-quick-start:alternate-directory-search|alternative ways to find OpenWrt firmware images.]] |
| * If you don't find your device in the Table of Hardware or Device Pages/Techdata pages, you can also try [[docs:guide-quick-start:alternate-directory-search|alternative ways to find LEDE firmware images.]] | * If you have accidentally browsed the generic OpenWrt download folders to locate your device, you might see some more download files matching your device. |
| * If you have accidently browsed the generic LEDE download folders to locate your device, you might see some more download files matching your device. Ignore those files: you only want the "...sysupgrade.bin" file . | |
| | |
| ===== Backup ===== | |
| | |
| * If you want to preserve your existing LEDE configuration, backup the configuration before flashing, by using the web admin GUI menu: (LEDE default IP: http://192.168.1.1) -> **System > Backup/flash firmware** -> **Backup/Restore section** > **Generate archive**. | |
| * If you do not choose to backup, the existing LEDE configuration will be lost and you have to start with a default LEDE configuration after the upgrade. | |
| * If you have NAS storage attached to your LEDE device, decide by yourself, whether you require a backup of files on that NAS. | |
| |
| ===== Verify firmware file and flash the firmware ===== | ===== Verify firmware file and flash the firmware ===== |
| | - Connect to the device via Ethernet cable (Only use wireless if the device has no Ethernet connection options) |
| - Connect to the device via Ethernet cable (Use wireless only, if the device has no Ethernet connection options) | - Log into the web interface and in the **System -> Backup/Flash Firmware** menu, go to the "Flash new firmware image" section. |
| - Log into the LEDE's web admin GUI and in the **System -> Backup/Flash Firmware** menu, go to the "Flash new firmware image" section. | - **Uncheck**/clear the **"Keep settings"** checkbox especially for major version upgrades, so that new defaults will get applied. Keeping settings may be possible for minor upgrades, but there is always a risk of incompatible settings. (more info regarding the [[docs:guide-quick-start:admingui_sysupgrade_keepsettings|"Keep settings" checkbox]] and its use cases). |
| - **Uncheck**/clear the **"Keep settings"** checkbox**!** (more info regarding the [[docs:guide-quick-start:admingui_sysupgrade_keepsettings|"Keep settings" checkbox]] and it's rare use cases). | - Ensure that the OpenWrt firmware file you are about to flash matches your router model and is called **"....sysupgrade.bin"** (the file type varies like .bin .tar.gz etc., but the key is "sysupgrade"), as you will **upgrade** an existing OpenWrt system towards a newer OpenWrt firmware version. |
| - Ensure that the LEDE firmware file you are about to flash matches your router model and is called **"....sysupgrade.bin"**, as you will **upgrade** an existing LEDE/OpenWrt system towards a newer LEDE firmware version. | |
| - In the **"Flash new firmware image"** section, click **"Choose file"** to select the image file, then click "Flash image...". This displays a “Flash Firmware - Verify" page, containing a SHA256 checksum of the image file just uploaded to the router. | - In the **"Flash new firmware image"** section, click **"Choose file"** to select the image file, then click "Flash image...". This displays a “Flash Firmware - Verify" page, containing a SHA256 checksum of the image file just uploaded to the router. |
| - Check that the firmware-checksum displayed on the web GUI matches the SHA256 checksum from the LEDE downloaded page. If it does not match, do NOT continue, as it is a corrupt file and will likely brick your device. | - [[docs:guide-quick-start:verify_firmware_checksum|Check]] that the firmware-checksum displayed in web interface matches the SHA256 checksum from the OpenWrt download page. If it does not match, do NOT continue, as it is a corrupt file and will likely brick your device. Note: If you are upgrading from OpenWrt 15.05, the 32 character displayed is an MD5 checksum, not SHA256. Please verify this MD5 checksum on your operating system before proceeding. |
| - If the checksum matches, click "Proceed". This starts the "System - Flashing ..." along with a spinning wheel and "Waiting for changes to be applied..." | - If the checksum matches, click "Proceed". This starts the "System - Flashing ..." along with a spinning wheel and "Waiting for changes to be applied..." |
| - It can take several minutes, while the router uploads the firmware image and write it into its flash ROM and finally reboots. | - It can take several minutes, while the router uploads the firmware image and write it into its flash ROM and finally reboots. |
| Troubleshooting: | Troubleshooting: |
| * if the checksum process failed, do NOT start flashing, as the download could be corrupt. A corrupt firmware file can brick your device! Instead repeat this howto with another download attempt from the download section. | * if the checksum process failed, do NOT start flashing, as the download could be corrupt. A corrupt firmware file can brick your device! Instead repeat this howto with another download attempt from the download section. |
| * if the checksum step fails repeatedly, you can consult the [[https://forum.lede-project.org/c/installation|"Installing and Using LEDE" Forum]] for help. Be sure to include the exact brand, model, and version of your device. | * if the checksum step fails repeatedly, you can consult the [[https://forum.openwrt.org/c/installation|Installing and Using OpenWrt Forum]] for help. Be sure to include the exact brand, model, and version of your device. |
| |
| ===== Check flash result ===== | ===== Post-upgrade steps ===== |
| | * After your device has finished flashing and rebooting, check if you can access the LuCI web interface (or the IP that you know of). |
| * After your device has finished flashing and rebooting, check if you can access the web admin GUI of LEDE on it's default IP: http://192.168.1.1 (or the IP that you know of) | * See **Post-upgrade steps** in [[docs:guide-user:installation:sysupgrade.cli|Upgrading OpenWrt firmware using CLI]] |
| |
| Troubleshooting: | Troubleshooting: |
| * If you have flashed a development/snapshot firmware of LEDE, you first need to manually enable the admin web GUI: [[docs:guide-quick-start:developmentinstallation|development installation guide]]. Or verify the result by SSH-connecting to your LEDE device IP 192.168.1.1 | * If you have flashed a development/snapshot firmware of OpenWrt, you first need to manually enable the web interface: [[docs:guide-quick-start:developmentinstallation|development installation guide]]. Or verify the result by SSH-connecting to your OpenWrt device. |
| * The router may have succeeded, but gotten a different IP address than you expected. Either scan your local network, check your regular router's status page (to find out about the IP address it has assigned to your LEDE device) or use [[docs:user-guide:failsafe_and_factory_reset| failsafe mode]], to manually reset LEDE's settings (which includes the network settings) | * The router may have succeeded, but gotten a different IP address than you expected. Either scan your local network, check your regular router's status page (to find out about the IP address it has assigned to your OpenWrt device) or use [[docs:guide-user:troubleshooting:failsafe_and_factory_reset|failsafe mode]], to manually reset OpenWrt's settings (which includes the network settings) |
| * If you have checkmarked the "Keep settings" checkbox in the previous section and the system fails to boot after flashing, you need to consult the [[docs:user-guide:failsafe_and_factory_reset| failsafe mode]], to manually reset all settings. | * If you have checkmarked the "Keep settings" checkbox in the previous section and the system fails to boot after flashing, you need to consult the [[docs:guide-user:troubleshooting:failsafe_and_factory_reset|failsafe mode]], to manually reset all settings. |
| | * Otherwise you need to start configuring from scratch. In this case, remember to properly **set your country code in the OpenWrt Wi-Fi configuration** again, to comply with your country's Wi-Fi legal regulation, e.g. see in [[docs:guide-quick-start:basic_wifi|basic Wi-Fi setup]]. |
| | |
| ===== Install additional packages ===== | |
| | |
| * You may now want to reinstall the custom packages that you had before the sysupgrade, by using ''opkg''. | |
| * If any package installs a system service, you also need to enable the corresponding service according to your needs. | |
| | |
| ===== Restore backed up LEDE configuration ===== | |
| | |
| * If you have chosen to backup your previous config in the previous step, you can now restore it, using LuCi's **System > Backup/flash firmware** menu. | |
| * Otherwise you need to start configuring from scratch | |
| |