README.md 4.29 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

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

Additional information is available at the website: http://www.fwupd.org
8

9
10
11
12
13
14
15
16
17
18
19
## Compiling

fwupd uses the [Meson build system](http://mesonbuild.com/) for compilation.
All building is done in a temporary directory, and autotools is not required.

### Create the build directory
`# mkdir -p build; pushd build`
### Generate the build script
This is done relative to the location of `meson.build`.  Any missing dependencies will be mentioned while running `meson`.

By default meson places `/etc` and `/var` under the prefix, which works incorrectly with fwupd.
Bruno Pagani's avatar
Bruno Pagani committed
20
Unless you have a version of meson with the fix for https://github.com/mesonbuild/meson/issues/1637 you will need to build setting *sysconfdir* and *localstatedir* manually.
21

Mario Limonciello's avatar
Mario Limonciello committed
22
`# meson --sysconfdir=/etc --localstatedir=/var ..`
23
24
25
26
27

The default compilation options are documented in `meson_options.txt` in the root of the build tree.
If you would like to override any option. you can do so when generating the build rules.
For example to disable the *DELL* plugin you would run meson like this:

Mario Limonciello's avatar
Mario Limonciello committed
28
`# meson --sysconfdir=/etc --localstatedir=/var -Denable-dell=false ..`
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

### Compile using ninja
Compilation is executed by one command:

`# ninja `

#### Common problems
While compiling policykit policy: `/home/user/jhbuild/install/bin/msgfmt: cannot locate ITS rules for org.freedesktop.fwupd.policy.in`
* This is caused by an older version of polkit (0.113 or older).  Some distros have patched polkit 0.113 to contain ITS rules.  See https://github.com/hughsie/fwupd/issues/107 for the most up to date information


### Install using `ninja`

`# sudo ninja install`

44
## Distribution packages
45
Scripts for generating distribution packages are available in the [contrib](https://github.com/hughsie/fwupd/tree/master/contrib) for popular distributions.
46

47
Adding a new plugin
48
49
-------------------

50
51
An extensible architecture allows for providing new plugin types (for reading
and writing different firmware) as well as ways quirk their behavior.
52

53
You can find more information about the architecture in the developers section
hadess's avatar
hadess committed
54
of the [fwupd website](http://www.fwupd.org).
55

56
57
58
59
60
61
62
If you have a firmware specification and would like to see support
in this project, please file an issue and share the spec.  Patches are also
welcome.

LVFS
----
This project is configured by default to download firmware from the [Linux Vendor
63
Firmware Service (LVFS)](https://secure-lvfs.rhcloud.com/lvfs/).
64

65
66
This service is available to all OEMs and firmware creators who would like to make
their firmware available to Linux users.
67

68
You can find more information about the technical details of creating a firmware
hadess's avatar
hadess committed
69
capsule in the hardware vendors section of the [fwupd website](http://www.fwupd.org).
70

71
72
73
74
Basic usage flow (command line)
------------------------------

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

77
`# fwupdmgr get-devices`
78
79
80

This will display all devices detected by fwupd.

81
`# fwupdmgr refresh`
82
83
84

This will download the latest metadata from LVFS.

85
`# fwupdmgr get-updates`
86
87
88

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

89
`# fwupdmgr update`
90
91
92
93
94
95

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.

96
You can find more information about the update workflow in the end
hadess's avatar
hadess committed
97
users section of the [fwupd website](http://www.fwupd.org).
98

99
100
101
Other frontends
-------------------

102
Currently [GNOME Software](https://wiki.gnome.org/Apps/Software) is the only graphical
103
frontend available.  When compiled with firmware support, it will check for updates
104
periodically and automatically download firmware in the background.
105
106
107
108

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

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