Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
fwupd-remotes.d(5)	       Remote File Format	      fwupd-remotes.d(5)

NAME
     fwupd-remotes.d - remotes used for the fwupd daemon.

SYNOPSIS
     The /usr/local/etc/fwupd/remotes.d and /var/fwupd/remotes.d directories are
     used  to  read information about remote metadata sources.	The complete de-
     scription of the file format and possible parameters  are	documented  here
     for reference purposes.

FILE FORMAT
     The  file consists of a multiple sections with optional parameters. Parame-
     ters are of the form:

     [section]
     key = value

     The file is line-based, each newline-terminated line  represents  either  a
     comment, a section name or a parameter.

     Section and parameter names are case sensitive.

     Only  the	first equals sign in a parameter is significant.  Whitespace be-
     fore 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.

     Any  line beginning with a hash (#) character is ignored, as are lines con-
     taining only whitespace.

     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
     true or false.  Case is not significant in boolean values, but is preserved
     in string values.

REMOTE PARAMETERS
     The [fwupd Remote] section can contain the following parameters:

     Enabled=false

       If the remote should be considered when	finding  releases  for	devices.
     Only  enabled  remotes  are  refreshed when using fwupdmgr refresh and when
     considering what updates	are available for each device. This value can be
     modified using fwupdmgr enable-remote.

     Title=

       The single line description to show in any UI tools.

     MetadataURI=

       The URL of AppStream metadata to download and use.  This  should  have  a
     suffix  of  .xml.gz  for	 legacy metadata and .xml.xz for the more modern
     format.	Only prefixes of http://, https://  and  file://  are  supported
     here.

     FirmwareBaseURI=

       The  optional  base  URL  of  the cabinet archives to download.	  If not
     specified the MetadataURI base URL is used.    Only  prefixes  of	http://,
     https:// and file:// are supported here.

     ApprovalRequired=false

       If  set	to  true  then	only releases allow-listed with fwupdmgr set-ap-
     proved-firmware will show	 in CLI and GUI tools.

     ReportURI=

       The endpoint to use for sending success	reports  for  firmware	obtained
     from this remote,	 or blank to disable this feature.

     AutomaticReports=false

       If  true,  automatically  sent success reports for firmware obtained from
     this remote after the   firmware update has completed.

     AutomaticSecurityReports=false

       If true, automatically sent HSI platform security  reports  when  running
     fwupdmgr security.

     NoPhasedUpdates=false

       If true, disregard the requirement check for random client phased deploy-
     ment.

       A  systems eligibility to a phased update is determined by seeding random
     number generator	with /etc/machine-id, the archive filename, and the  re-
     mote cache mtime. If the seed divides   by the metadata-provided phased_up-
     date  value  with no remainder then the release is considered.    This also
     implies that the seed will be different on a different machine, for a  dif-
     ferent update   or if the metadata is refreshed.

     OrderBefore=

       This  remote will be ordered before any remotes listed here, using commas
     as the delimiter.

       NOTE: When the same firmware release is available from multiple	remotes,
     the one with the	highest priority will be used.

     OrderAfter=

       This  remote  will be ordered after any remotes listed here, using commas
     as the delimiter.

     Username=

       The username to use for BASIC authentication  when  downloading	metadata
     and firmware from this   remote, and for uploading success reports.

     Password=

       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.

     RefreshInterval=

       The time in seconds after which the front end  tools  should  re-download
     the metadata signature,   or 0 to re-download every time.

NOTES
     The  basename  of the path without the extension is used for the remote ID.
     For instance, the /usr/local/etc/fwupd/remotes.d/lvfs.conf remote file will
     have ID of lvfs.

SEE ALSO
     <fwupd.conf(5)>

2.0.19							      fwupd-remotes.d(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=fwupd-remotes.d&sektion=5&manpath=FreeBSD+Ports+15.1.quarterly>

home | help