Skip to content

Commit 3fd10c3

Browse files
Merge pull request #1098 from Dasharo/fwupd-usage
docs/kb/fwupd.md: Add
2 parents ac20fbe + 6b413c9 commit 3fd10c3

3 files changed

Lines changed: 65 additions & 0 deletions

File tree

docs/kb/fwupd.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# fwupd
2+
3+
## Introduction
4+
5+
[fwupd][fwupd website] is an open-source project, that
6+
is widely used to make firmware updates almost as seamless and simple
7+
as updating system packages. It is supported by most hardware vendors
8+
and Linux distributions.
9+
10+
The `fwupd` daemon relies on the Linux Vendor Firmware Service (LVFS)
11+
for distributing and managing the firmware binaries to the users.
12+
13+
!!! note
14+
`fwupd` depends on
15+
[Capsule Updates](https://docs.dasharo.com/guides/capsule-update/)
16+
support. Refer to the "Firmware update" section of your device
17+
documentation (like [this one](https://docs.dasharo.com/unified/novacustom/firmware-update/)).
18+
19+
## Usage
20+
21+
The most popular Desktop Environments like Gnome and KDE automatically
22+
look for firmware updates on LVFS and suggest performing them with a
23+
simple button press.
24+
25+
|![Firmware update available in Gnome Software](./images/fwupd-gnome.png)|
26+
|--|
27+
|Firmware update available in Gnome Software|
28+
29+
For more advanced users or in more lightweight
30+
DEs/WMs `fwupdmgr` can be used in the terminal.
31+
32+
* Detect the supported hardware
33+
34+
```bash
35+
fwupdmgr get-devices
36+
```
37+
38+
* Refresh metadata from LVFS
39+
40+
```bash
41+
fwupdmgr refresh
42+
```
43+
44+
* Check for available updates
45+
46+
```bash
47+
fwupdmgr get-updates
48+
```
49+
50+
* Download and install the firmware updates
51+
52+
```bash
53+
fwupdmgr update
54+
```
55+
56+
## References
57+
58+
[fwupd website][fwupd website]
59+
[fwupd github repository][fwupd github repository]
60+
[fwupd documentation][fwupd documentation]
61+
62+
[fwupd website]: https://fwupd.org
63+
[fwupd github repository]: https://github.com/fwupd/fwupd
64+
[fwupd documentation]: https://lvfs.readthedocs.io

docs/kb/images/fwupd-gnome.png

52.7 KB
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,7 @@ nav:
511511
- 'PCR Measurements': kb/pcr-measurements.md
512512
- 'NovaCustom dev setup': kb/laptop-dev-env.md
513513
- 'Flash Regions': kb/flashregions.md
514+
- 'fwupd firmware updates': kb/fwupd.md
514515
# - 'Trolling Topics List':
515516
# - 'Introduction': osf-trolling-list/osf_issues_taxonomy.md
516517
- 'FAQ':

0 commit comments

Comments
 (0)