fwupd-remotes.d(5)

1fwupd-remotes.d(5)            Remote File Format            fwupd-remotes.d(5)
2
3
4

NAME

6       fwupd-remotes.d — remotes used for the fwupd daemon.
7

SYNOPSIS

9       The  /etc/fwupd/remotes.d and /var/fwupd/remotes.d directories are used
10       to read information about remote metadata sources.   The  complete  de‐
11       scription  of  the  file  format and possible parameters are documented
12       here for reference purposes.
13

FILE FORMAT

15       The file consists of a multiple sections with optional parameters.  Pa‐
16       rameters are of the form:
17
18       [section]
19       key = value
20
21
22       The  file is line-based, each newline-terminated line represents either
23       a comment, a section name or a parameter.
24
25       Section and parameter names are case sensitive.
26
27       Only the first equals sign in a parameter is  significant.   Whitespace
28       before  or  after  the first equals sign is discarded as is leading and
29       trailing whitespace in a parameter value.  Internal whitespace within a
30       parameter value is retained.
31
32       Any  line  beginning with a hash (#) character is ignored, as are lines
33       containing only whitespace.
34
35       The values following the equals sign in parameters  are  all  either  a
36       string  (no  quotes needed), unsigned integers, or a boolean, which may
37       be given as true or false.  Case is not significant in boolean  values,
38       but is preserved in string values.
39

REMOTE PARAMETERS

41       The [fwupd Remote] section can contain the following parameters:
42
43       Enabled=false
44
45       If the remote should be considered when finding releases for devices.
46       Only enabled remotes are refreshed when using fwupdmgr refresh and when considering what updates
47       are available for each device. This value can be modified using fwupdmgr enable-remote.
48
49
50       Title=
51
52       The single line description to show in any UI tools.
53
54
55       Keyring=jcat
56
57       The signing scheme to use when downloading and verifying the metadata.
58       The options are jcat, gpg, pkcs, and none.
59
60
61       NOTE: Using Keyring=none is only designed when local firmware installed to an immutable
62       location, and should not be used when the metadata could be written by an untrusted user.
63
64
65       NOTE: Using Keyring=jcat is usually a better choice than Keyring=gpg or Keyring=pkcs
66       as deployments may disable either PKCS#7 or GPG support. Using Keyring=jcat means it works in
67       both cases, and JCat also provides other benefits like desynchronized CDN mitigation and multiple
68       types of checksum.
69
70
71       MetadataURI=
72
73       The URL of AppStream metadata to download and use. This should have a suffix of .xml.gz for
74       legacy metadata and .xml.xz for the more modern format.
75       Only prefixes of http://, https:// and file:// are supported here.
76
77
78       ApprovalRequired=false
79
80       If set to true then only releases allow-listed with fwupdmgr set-approved-firmware will show
81       in CLI and GUI tools.
82
83
84       ReportURI=
85
86       The endpoint to use for sending success reports for firmware obtained from this remote,
87       or blank to disable this feature.
88
89
90       AutomaticReports=false
91
92       If true, automatically sent success reports for firmware obtained from this remote after the
93       firmware update has completed.
94
95
96       SecurityReportURI=
97
98       The endpoint to use for sending HSI platform security reports, or blank to disable this feature.
99
100
101       AutomaticSecurityReports=false
102
103       If true, automatically sent HSI platform security reports when running fwupdmgr security.
104
105
106       OrderBefore=
107
108       This remote will be ordered before any remotes listed here, using commas as the delimiter.
109
110
111       NOTE: When the same firmware release is available from multiple remotes, the one with the
112       highest priority will be used.
113
114
115       OrderAfter=
116
117       This remote will be ordered after any remotes listed here, using commas as the delimiter.
118
119
120       Username=
121
122       The username to use for BASIC authentication when downloading metadata and firmware from this
123       remote, and for uploading success reports.
124
125
126       Password=
127
128       The password (although, in practice this will be a user *token*) to use for BASIC authentication
129       when downloading both metadata and firmware from this remote, and for uploading success reports.
130
131
132       RefreshInterval=86400
133
134       The time in seconds after which the front end tools should re-download the metadata signature,
135       or 0 to re-download every time.
136
137

NOTES

139       The  basename  of the path without the extension is used for the remote
140       ID.  For instance, the /etc/fwupd/remotes.d/lvfs.conf remote file  will
141       have ID of lvfs.
142

NAME

SYNOPSIS

FILE FORMAT

REMOTE PARAMETERS

NOTES

SEE ALSO