Skip to content

Commit b07a45a

Browse files
committed
luci-app-attendedsysupgrade: rewrite README.md
README.md rewritten for improvements to spelling, grammar, and clarity.
1 parent 3eca54e commit b07a45a

1 file changed

Lines changed: 42 additions & 7 deletions

File tree

  • applications/luci-app-attendedsysupgrade
Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,46 @@
11
# luci-app-attendedsysupgrade
22

3-
This app allows firmware upgrades of routers while keeping user installed packages.
4-
To do so the app sends a request to an *Atttended SysUpgrade server* which will
5-
respond with a custom image, containing all previously installed packages.
3+
`luci-app-attendedsysupgrade` is a plugin for the OpenWrt LuCI web interface
4+
that facilitates updates and upgrades for both firmware and software packages.
65

7-
The process takes per images between 30 seconds and 5 minutes, please be
8-
patient.
6+
It appears at `System → Attended Sysupgrade` in the web interface
7+
where controls and configurations for _when_ it should check for
8+
firmware upgrades and _where_ it should send build requests are provided.
99

10-
More information on the backend server and how to host one are available on the
11-
projects page: https://github.com/openwrt/asu
10+
Build requests include information about the request system's
11+
CPU architecture/target and its currently installed packages. These are sent
12+
to an **A**ttended **S**ys**U**pgrade server (ASU) which,
13+
if available, will then respond with an install-ready custom firmware image that
14+
includes the latest requested firmware and package updates.
15+
16+
By default, this plugin only prompts to send a build request when firmware
17+
upgrades are detected and the user interactively selects to upgrade.
18+
19+
_Customizable build requests are directly available via the
20+
`Search for firmware upgrades` button when `Advanced Mode` is active._
21+
22+
Following a successful build request, a prompt appears with information about
23+
the custom firmware image. The user may select to install either with
24+
or without the existing system configuration.
25+
There is also an option to download a separate copy
26+
of that custom image via the web browser. Selecting `Install firmware image`
27+
closes the prompt and the install proceeds with a system reboot.
28+
29+
ASU servers typically take between 30 seconds and 5 minutes
30+
to process each build request and prepare a custom image.
31+
32+
> [!NOTE]
33+
> Following the announcement of a major OpenWrt upgrade, availability of
34+
> ASU servers may become limited for a few days as target builds are rolled out
35+
> and servers contend with sharply increased demand.
36+
37+
## Further reading
38+
If you would like more information about the backend server (and how to
39+
host one yourself), please visit the [ASU Server repository](https://github.com/openwrt/asu).
40+
41+
Support is available at the official
42+
[LuCI Attended Sysupgrade support thread](https://forum.openwrt.org/t/luci-attended-sysupgrade-support-thread).
43+
44+
<sub>`luci-app-attendedsysupgrade` is proudly installed in OpenWrt by default
45+
since the
46+
[release of OpenWrt 25.12.0](https://openwrt.org/releases/25.12/notes-25.12.0#integration_of_attended_sysupgrade).</sub>

0 commit comments

Comments
 (0)