Skip to content

Commit 4c03453

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent 8d0400f commit 4c03453

2 files changed

Lines changed: 207 additions & 0 deletions

File tree

‎assets/commands/owut.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# TAGLINE
2+
3+
OpenWrt firmware upgrade tool
4+
5+
# TLDR
6+
7+
**Check** for available firmware upgrades
8+
9+
```owut check```
10+
11+
**Upgrade** firmware while retaining all packages and configuration
12+
13+
```owut upgrade```
14+
15+
**Download** a firmware image without installing it
16+
17+
```owut download```
18+
19+
**Upgrade** to a specific OpenWrt version
20+
21+
```owut upgrade -V [24.10.1]```
22+
23+
**Add packages** during the upgrade
24+
25+
```owut upgrade -a [package1] -a [package2]```
26+
27+
**Remove packages** during the upgrade
28+
29+
```owut upgrade -r [package_name]```
30+
31+
**List** all user-installed packages
32+
33+
```owut list```
34+
35+
**Show available** OpenWrt versions
36+
37+
```owut versions```
38+
39+
# SYNOPSIS
40+
41+
**owut** [_options_] _command_
42+
43+
# DESCRIPTION
44+
45+
**owut** (OpenWrt Upgrade Tool) is a command-line utility that upgrades OpenWrt router firmware by creating custom images through the Attended Sysupgrade (ASU) server. It builds personalized firmware images that retain all currently installed packages and configuration, then downloads, verifies, and installs them.
46+
47+
The tool communicates with the ASU server to request a build matching the device's current package set, optionally adding or removing packages. It handles the entire upgrade workflow: collecting device information, requesting a build, monitoring progress, downloading the image, verifying its integrity, and performing the sysupgrade.
48+
49+
# COMMANDS
50+
51+
**check**
52+
> Collect all resources and report upgrade stats without performing any action.
53+
54+
**upgrade**
55+
> Build, download, verify and install a firmware image.
56+
57+
**download**
58+
> Build, download and verify an image without installing.
59+
60+
**verify**
61+
> Verify a previously downloaded firmware image.
62+
63+
**install**
64+
> Install a specified local firmware image.
65+
66+
**list**
67+
> Show all packages installed by the user.
68+
69+
**versions**
70+
> Show available OpenWrt versions.
71+
72+
**blob**
73+
> Display the JSON blob for the ASU build request.
74+
75+
**dump**
76+
> Collect all resources and dump internal data structures.
77+
78+
# PARAMETERS
79+
80+
**-V** _version_, **--version-to** _version_
81+
> Specify the target version. Defaults to the currently installed version.
82+
83+
**-R** _code_, **--rev-code** _code_
84+
> Specify a version code. Literal **none** is allowed. Defaults to latest build.
85+
86+
**-a** _package_, **--add** _package_
87+
> Add a new package to the build list. Can be repeated.
88+
89+
**-r** _package_, **--remove** _package_
90+
> Remove an installed package from the build list. Can be repeated.
91+
92+
**-i** _path_, **--image** _path_
93+
> Image file path for download, verify, install and upgrade. Defaults to **/tmp/firmware.bin**.
94+
95+
**-I** _path_, **--init-script** _path_
96+
> Path to a uci-defaults script to run on first boot. Use **-** to read from stdin.
97+
98+
**-F** _type_, **--fstype** _type_
99+
> Desired root file system type: **squashfs**, **ext4**, **ubifs**, or **jffs2**.
100+
101+
**-S** _size_, **--rootfs-size** _size_
102+
> Root file system size in MB. Use with caution.
103+
104+
**-p** _script_, **--pre-install** _script_
105+
> Script to execute just prior to launching the final sysupgrade.
106+
107+
**-f** _format_, **--format** _format_
108+
> Format for **list** output: **fs-user**, **fs-all**, or **config**.
109+
110+
**-k**, **--keep**
111+
> Save all downloaded working files.
112+
113+
**--force**
114+
> Force a build even when there are downgrades or no changes.
115+
116+
**--clean-slate**
117+
> Remove all but default packages from the build.
118+
119+
**-v**, **--verbose**
120+
> Print various diagnostics. Repeat for more output.
121+
122+
**-q**, **--quiet**
123+
> Reduce verbosity. Repeat for total silence.
124+
125+
**-h**, **--help**
126+
> Display help information.
127+
128+
**--version**
129+
> Display version information.
130+
131+
# CAVEATS
132+
133+
owut requires OpenWrt **24.10 or later** (including main snapshots) due to its dependency on the **ucode-mod-uclient** package. For older OpenWrt versions (23.05 and earlier), use the **auc** package instead. The **--rootfs-size** option can render a device unbootable if misused. Firmware upgrades always carry risk and should be performed with a stable power source and network connection.
134+
135+
# HISTORY
136+
137+
owut was created by **efahl** and published on GitHub as an open-source project under the **GPL-2.0** license. It was developed as a successor to the **auc** (Attended Upgrade Client) tool, rewritten in **ucode** rather than C to be more maintainable and extensible. It became a standard OpenWrt package starting with version **24.10**, integrating with the Attended Sysupgrade server infrastructure that has been part of the OpenWrt ecosystem since **2017**.
138+
139+
# SEE ALSO
140+
141+
[sysupgrade](/man/sysupgrade)(1), [opkg](/man/opkg)(1)

‎assets/commands/update-ca-certificates.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# TAGLINE
2+
3+
Update SSL certificate authority bundle
4+
5+
# TLDR
6+
7+
**Update** the CA certificates bundle
8+
9+
```sudo update-ca-certificates```
10+
11+
**Perform a fresh update**, removing existing symlinks first
12+
13+
```sudo update-ca-certificates --fresh```
14+
15+
**Update with verbose** output showing details
16+
17+
```sudo update-ca-certificates --verbose```
18+
19+
# SYNOPSIS
20+
21+
**update-ca-certificates** [_options_]
22+
23+
# PARAMETERS
24+
25+
**-h**, **--help**
26+
> Show summary of options.
27+
28+
**-v**, **--verbose**
29+
> Be verbose. Display c_rehash results.
30+
31+
**-f**, **--fresh**
32+
> Fresh update. Remove all symlinks in **/etc/ssl/certs** before regenerating them.
33+
34+
# DESCRIPTION
35+
36+
**update-ca-certificates** updates the directory **/etc/ssl/certs** to hold SSL certificates and generates **ca-certificates.crt**, a concatenated single-file list of trusted certificate authorities. It is used to maintain the system-wide set of CA certificates that applications rely on for verifying TLS/SSL connections.
37+
38+
The program reads **/etc/ca-certificates.conf**, where each line specifies a pathname of a CA certificate under **/usr/share/ca-certificates** that should be trusted. Lines beginning with **#** are comments and are ignored. Lines beginning with **!** deselect a certificate, causing it to be deactivated.
39+
40+
Certificates must have a **.crt** extension to be included. All certificates with a **.crt** extension found under **/usr/local/share/ca-certificates** are also included as implicitly trusted, making this the recommended location for adding custom CA certificates.
41+
42+
After updating, the program executes hooks in **/etc/ca-certificates/update.d** via **run-parts**, passing lists of added (prefixed with **+**) and removed (prefixed with **-**) certificates.
43+
44+
# CONFIGURATION
45+
46+
To **add a custom CA certificate**, place the **.crt** file in **/usr/local/share/ca-certificates/** and run **update-ca-certificates**. The certificate will be automatically trusted.
47+
48+
To **disable a certificate** shipped with the system, edit **/etc/ca-certificates.conf** and prefix the corresponding line with **!**, then run **update-ca-certificates**.
49+
50+
```
51+
# Example /etc/ca-certificates.conf entries
52+
mozilla/DigiCert_Global_Root_G2.crt
53+
!mozilla/Untrusted_CA.crt
54+
```
55+
56+
# CAVEATS
57+
58+
This command is primarily available on **Debian** and **Ubuntu** based distributions. On **Red Hat** and **Fedora** systems, use **update-ca-trust** instead. The command typically requires **root privileges** to modify system certificate directories. Changes only take effect for applications started after the update; running services may need to be restarted to pick up the new certificate bundle.
59+
60+
# HISTORY
61+
62+
**update-ca-certificates** was written for the **Debian** project as part of the **ca-certificates** package, which provides a curated collection of CA root certificates from the **Mozilla NSS** project. The ca-certificates package has been a core component of Debian since the early **2000s**, ensuring that system-wide TLS verification works out of the box. The tool has since been adopted by all Debian derivatives including **Ubuntu** and **Linux Mint**.
63+
64+
# SEE ALSO
65+
66+
[openssl](/man/openssl)(1), [c_rehash](/man/c_rehash)(1)

0 commit comments

Comments
 (0)