Skip to content
Open
Changes from all commits
Commits
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
44 changes: 32 additions & 12 deletions docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,39 @@ then go to the "Firmware" tab.
If you correctly filled **OS identifier** in step 2, you should have a
situation similar to the one above: in this example, the device is using
version ``1.0`` and we want to upgrade it to version ``2.0``, once the new
firmware image is selected we just have to hit save, then a new tab will
appear in the device page which allows us to see what's going on during
the upgrade.
firmware image is selected we just have to hit save, then a new tab
"Recent Firmware Upgrades" will appear in the device page which allows us
to observe in real time what's going on during the upgrade without
requiring page reloads.

Right now, the update of the upgrade information is not asynchronous yet,
so you will have to reload the page periodically to find new information.
This will be addressed in a future release.
5. Canceling a Firmware Upgrade
-------------------------------

5. Performing Mass Upgrades
If you need to cancel a firmware upgrade that is currently in progress on
a specific device, you can do so from the device's firmware upgrade page.

To cancel an ongoing upgrade:

- Navigate to the device details page
- Go to the "Firmware" tab
- If an upgrade is in progress, you will see a "Cancel Upgrade" button
- Click the "Cancel Upgrade" button to stop the upgrade process

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-firmware-upgrader/docs/docs/images/quickstart-cancel-upgrade.gif
:target: https://raw.githubusercontent.com/openwisp/openwisp-firmware-upgrader/docs/docs/images/quickstart-cancel-upgrade.gif

Cancellation is only possible during the early stages of the upgrade
process. Once the firmware flashing begins, the cancel button will be
disabled and the upgrade cannot be stopped, as interrupting the flashing
process could corrupt the device.

The system automatically prevents cancellation during critical phases to
ensure device safety.

Once canceled, the upgrade status will be updated to show that the
operation was canceled, and you can attempt a new upgrade if needed.

6. Performing Mass Upgrades
---------------------------

Before proceeding, please ensure the following preconditions are met:
Expand Down Expand Up @@ -154,8 +178,4 @@ After reviewing the selection and setting any desired filters, you can
either confirm the operation or cancel.

Once the operation is confirmed you will be redirected to a page in which
you can monitor the progress of the upgrade operations.

Right now, the update of the upgrade information is not asynchronous yet,
so you will have to reload the page periodically to find new information.
This will be addressed in a future release.
you can monitor the progress of the upgrade operations in real time.
Loading