README.md 5.33 KB
Newer Older
1
2
fwupd
=====
3
[![Build Status](https://travis-ci.org/fwupd/fwupd.png?branch=master)](https://travis-ci.org/fwupd/fwupd)
4
[![Coverity Scan Build Status](https://scan.coverity.com/projects/10744/badge.svg)](https://scan.coverity.com/projects/10744)
5

6
This project aims to make updating firmware on Linux automatic, safe and reliable.
7

Jonathan's avatar
Jonathan committed
8
Additional information is available at the website: https://fwupd.org/
9

10
11
## Compiling

Jonathan's avatar
Jonathan committed
12
The most up to date compilation instructions are available in the [Wiki](https://github.com/fwupd/fwupd/wiki/Compilation).
13

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
**NOTE:** In most cases end users should never compile fwupd from scratch; it's a
complicated project with dozens of dependencies (and as many configuration options)
and there's just too many things that can go wrong.

Users should just have fwupd installed and updated by their distro, managed and
tested by the package maintainer.
The distribution will have also done some testing with how fwupd interacts with
other software on your system, for instance using GNOME Software.

Installing fwupd using [Snap](https://github.com/fwupd/fwupd/wiki/fwupd-snap)
or using [Flatpak](https://github.com/fwupd/fwupd/wiki/fwupd-flatpak) might be
useful to update a specific device on the command line that needs a bleeding
edge fwupd version, but it should not be considered as a replacement to the
distro-provided system version.

29
30
31
LVFS
----
This project is configured by default to download firmware from the [Linux Vendor
32
Firmware Service (LVFS)](https://fwupd.org/).
33

34
35
This service is available to all OEMs and firmware creators who would like to make
their firmware available to Linux users.
36

37
You can find more information about the technical details of creating a firmware
Zander's avatar
Zander committed
38
capsule in the hardware vendors section of the [fwupd website](https://fwupd.org).
39

40
41
42
43
Basic usage flow (command line)
------------------------------

If you have a device with firmware supported by fwupd, this is how you will check
44
for updates and apply them using fwupd's command line tools.
45

46
`# fwupdmgr get-devices`
47
48
49

This will display all devices detected by fwupd.

50
`# fwupdmgr refresh`
51
52
53

This will download the latest metadata from LVFS.

54
`# fwupdmgr get-updates`
55
56
57

If updates are available for any devices on the system, they'll be displayed.

58
`# fwupdmgr update`
59
60
61

This will download and apply all updates for your system.

62
63
* Updates that can be applied live will be done immediately.
* Updates that run at bootup will be staged for the next reboot.
64

65
You can find more information about the update workflow in the end
Zander's avatar
Zander committed
66
users section of the [fwupd website](https://fwupd.org).
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
Reporting status
---------------

fwupd will encourage users to report both successful and failed updates back
to LVFS.  This is an optional feature, but encouraged as it provides valuable
feedback to LVFS administrators and OEM developers regarding firmware update
process efficacy.

The privacy policy regarding this data can be viewed on the [fwupd website](https://fwupd.org/privacy).

To report the status of an update run:

`# fwupdmgr report-history`

To clear the local history of updates:

`# fwupdmgr clear-history`

 Only updates that were distributed from the LVFS will be reported to the LVFS.

Jonathan's avatar
Jonathan committed
88
Enterprise use
89
90
91
92
93
--------------

The flow of updates can be controlled in the enterprise using the
"approved updates" feature. This allows the domain administrator to filter
the possible updates from a central server (e.g. the LVFS, or a mirror)
Richard Hughes's avatar
Richard Hughes committed
94
to only firmware that have been tested specifically in your organization.
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

The list of approved updates can be enabled by adding `ApprovalRequired=true`
to the remote configuration file, e.g. `lvfs.conf`. Once enabled, the
list of approved updates can be set in `daemon.conf` using a comma delimited list.

For example:

    ApprovedFirmware=foo,bar

Where `foo,bar` refers to the container checksums that would correspond
to two updates in the metadata file.

Additionally, the list of approved firmware can be supplemented using
`fwupdmgr set-approved-firmware baz` or using the D-Bus interface.

110
111
112
Other frontends
-------------------

113
114
115
 1. [GNOME Software](https://wiki.gnome.org/Apps/Software) is the graphical
 frontend available. When compiled with firmware support, it will check for
 updates periodically and automatically download firmware in the background.
Jonathan's avatar
Jonathan committed
116
 After the firmware has been downloaded a popup will be displayed in GNOME
117
118
 Software to perform the update.

Richard Hughes's avatar
Richard Hughes committed
119
2. [KDE Discover](https://userbase.kde.org/Discover) is the software center,
120
121
122
123
124
 generally bundled with KDE Plasma. With the release of
 [KDE Plasma 5.14](https://www.kde.org/announcements/plasma-5.14.0.php),
 a new fwupd backend has been implemented in KDE Discover for firmware updates.
 These firmware updates are shown with other system updates.

125
126
3. [Wyse Management Suite](https://www.dell.com/en-us/work/shop/wyse-endpoints-and-software/wyse-management-suite/spd/wyse-wms)
 A software suite available on Dell IoT gateways and Wyse thin clients with built-in fwupd support.
127
128
 The remote administration interface can be used to download and deploy firmware
 updates.
129
130
131
132
133
134
135


Fuzzing
-------

There are several automated fuzzing tests in fwupd. These take some time to run:

136
137
138
139
    CC=hfuzz-clang meson --default-library=static \
        -Dtmpdir=/tmp -Dsystemd_root_prefix=/tmp \
        -Dplugin_redfish=false -Dcurl=false \
        -Dintrospection=false ../
140
    ninja install
141
142
    ninja fuzz-firmware
    ninja fuzz-smbios
143
    ninja fuzz-tpm-eventlog