.TH "fwupd-remotes.d" "5" "" 1.9.31 "Remote File Format"
.hy
.SH
NAME 
.PP
\f[B]fwupd-remotes.d\f[R] — remotes used for the fwupd daemon.  
.SH
SYNOPSIS 
.PP
The \f[B]/etc/fwupd/remotes.d\f[R] and \f[B]/var/fwupd/remotes.d\f[R] directories are used to read information about remote metadata sources.  The complete description of the file format and possible parameters are documented here for reference purposes.  
.SH
FILE FORMAT 
.PP
The file consists of a multiple sections with optional parameters. Parameters are of the form: 
.PP
.nf
\f[B]\f[R]\f[B]
.fi
.nf
[section]
.fi
.nf
key = value
.fi
\f[R]\f[B]\f[R] 
.PP
The file is line-based, each newline-terminated line represents either a comment, a section name or a parameter.  
.PP
Section and parameter names are case sensitive.  
.PP
Only the first equals sign in a parameter is significant.  Whitespace before or after the first equals sign is discarded as is leading and trailing whitespace in a parameter value.  Internal whitespace within a parameter value is retained.  
.PP
Any line beginning with a hash (\f[B]#\f[R]) character is ignored, as are lines containing only whitespace.  
.PP
The values following the equals sign in parameters are all either a string (no quotes needed), unsigned integers, or a boolean, which may be given as \f[B]true\f[R] or \f[B]false\f[R].  Case is not significant in boolean values, but is preserved in string values.  
.SH
REMOTE PARAMETERS 
.PP
The \f[B][fwupd Remote]\f[R] section can contain the following parameters: 
.PP
\f[B]Enabled=false\f[R] 
.PP
  If the remote should be considered when finding releases for devices.    Only enabled remotes are refreshed when using \f[B]fwupdmgr refresh\f[R] and when considering what updates   are available for each device. This value can be modified using \f[B]fwupdmgr enable-remote\f[R].  
.PP
\f[B]Title=\f[R] 
.PP
  The single line description to show in any UI tools.  
.PP
\f[B]Keyring=jcat\f[R] 
.PP
  The signing scheme to use when downloading and verifying the metadata.    The options are \f[B]jcat\f[R], \f[B]gpg\f[R], \f[B]pkcs\f[R], and \f[B]none\f[R].  
.PP
  \f[B]NOTE:\f[R] Using \f[B]Keyring=none\f[R] is only designed when local firmware installed to an immutable   location, and should not be used when the metadata could be written by an untrusted user.  
.PP
  \f[B]NOTE:\f[R] Using \f[B]Keyring=jcat\f[R] is usually a better choice than \f[B]Keyring=gpg\f[R] or \f[B]Keyring=pkcs\f[R]   as deployments may disable either PKCS#7 or GPG support. Using \f[B]Keyring=jcat\f[R] means it works in   both cases, and JCat also provides other benefits like desynchronized CDN mitigation and multiple   types of checksum.  
.PP
\f[B]MetadataURI=\f[R] 
.PP
  The URL of AppStream metadata to download and use. This should have a suffix of \f[B].xml.gz\f[R] for   legacy metadata and \f[B].xml.xz\f[R] for the more modern format.    Only prefixes of \f[B]http://\f[R], \f[B]https://\f[R] and \f[B]file://\f[R] are supported here.  
.PP
\f[B]FirmwareBaseURI=\f[R] 
.PP
  The optional base URL of the cabinet archives to download.    If not specified the \f[B]MetadataURI\f[R] base URL is used.    Only prefixes of \f[B]http://\f[R], \f[B]https://\f[R] and \f[B]file://\f[R] are supported here.  
.PP
\f[B]ApprovalRequired=false\f[R] 
.PP
  If set to \f[B]true\f[R] then only releases allow-listed with \f[B]fwupdmgr set-approved-firmware\f[R] will show   in CLI and GUI tools.  
.PP
\f[B]ReportURI=\f[R] 
.PP
  The endpoint to use for sending success reports for firmware obtained from this remote,   or blank to disable this feature.  
.PP
\f[B]AutomaticReports=false\f[R] 
.PP
  If \f[B]true\f[R], automatically sent success reports for firmware obtained from this remote after the   firmware update has completed.  
.PP
\f[B]SecurityReportURI=\f[R] 
.PP
  The endpoint to use for sending HSI platform security reports, or blank to disable this feature.  
.PP
\f[B]AutomaticSecurityReports=false\f[R] 
.PP
  If \f[B]true\f[R], automatically sent HSI platform security reports when running \f[B]fwupdmgr security\f[R].  
.PP
\f[B]OrderBefore=\f[R] 
.PP
  This remote will be ordered before any remotes listed here, using commas as the delimiter.  
.PP
  \f[B]NOTE:\f[R] When the same firmware release is available from multiple remotes, the one with the   highest priority will be used.  
.PP
\f[B]OrderAfter=\f[R] 
.PP
  This remote will be ordered after any remotes listed here, using commas as the delimiter.  
.PP
\f[B]Username=\f[R] 
.PP
  The username to use for BASIC authentication when downloading metadata and firmware from this   remote, and for uploading success reports.  
.PP
\f[B]Password=\f[R] 
.PP
  The password (although, in practice this will be a user *token*) to use for BASIC authentication   when downloading both metadata and firmware from this remote, and for uploading success reports.  
.PP
\f[B]RefreshInterval=\f[R] 
.PP
  The time in seconds after which the front end tools should re-download the metadata signature,   or \f[B]0\f[R] to re-download every time.  
.SH
NOTES 
.PP
The basename of the path without the extension is used for the remote ID.  For instance, the \f[B]/etc/fwupd/remotes.d/lvfs.conf\f[R] remote file will have ID of \f[B]lvfs\f[R].  
.SH
SEE ALSO 
.PP
<fwupd.conf(5)> 