README.md 2.38 KB
Newer Older
1
2
fwupd
=====
3
[![Build Status](https://travis-ci.org/hughsie/fwupd.png?branch=master)](https://travis-ci.org/hughsie/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

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

10
11
## Compiling

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

14
15
16
LVFS
----
This project is configured by default to download firmware from the [Linux Vendor
17
Firmware Service (LVFS)](https://fwupd.org/).
18

19
20
This service is available to all OEMs and firmware creators who would like to make
their firmware available to Linux users.
21

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

25
26
27
28
Basic usage flow (command line)
------------------------------

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

31
`# fwupdmgr get-devices`
32
33
34

This will display all devices detected by fwupd.

35
`# fwupdmgr refresh`
36
37
38

This will download the latest metadata from LVFS.

39
`# fwupdmgr get-updates`
40
41
42

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

43
`# fwupdmgr update`
44
45
46
47
48
49

This will download and apply all updates for your system.

* Updates that can be applied live *(Online updates)* will be done immediately.
* Updates that require a reboot *(Offline updates)* will be staged for the next reboot.

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

53
54
55
Other frontends
-------------------

56
Currently [GNOME Software](https://wiki.gnome.org/Apps/Software) is the only graphical
57
frontend available.  When compiled with firmware support, it will check for updates
58
periodically and automatically download firmware in the background.
59
60
61
62

After the firmware has been downloaded a popup will be displayed in Gnome Software
to perform the update.

63
On Dell IoT gateways, [Wyse Cloud Client Manager (CCM)](http://www.dell.com/us/business/p/wyse-cloud-client-manager/pd)
64
65
has been built with fwupd support.
The remote administration interface can be used to download and deploy
66
firmware updates.