flatpak-flatpakrepo(5) — Linux manual page


FLATPAKREPO(5)                 flatpakrepo                FLATPAKREPO(5)

NAME         top

       flatpak-flatpakrepo - Reference to a remote

DESCRIPTION         top

       Flatpak uses flatpakrepo files to share information about
       remotes. The flatpakrepo file contains enough information to add
       the remote. Use the flatpak remote-add --from command to do so.

       flatpakrepo files may also contain additional information that is
       useful when displaying a remote to the user, e.g. in an app

       The filename extension commonly used for flatpakrepo files is

FILE FORMAT         top

       The flatpakrepo file is using the same .ini file format that is
       used for systemd unit files or application .desktop files.

   [Flatpak Repo]
       All the information is contained in the [Flatpak Repo] group.

       The following keys can be present in this group:

       Version (uint64)
           The version of the file format, must be 1 if present.

       Url (string)
           The url for the remote. This key is mandatory.

       GPGKey (string)
           The base64-encoded gpg key for the remote.

       DefaultBranch (string)
           The default branch to use for this remote.

       Subset (string)
           Limit the remote to the named subset of refs.

       Title (string)
           The title of the remote. This should be a user-friendly name
           that can be displayed e.g. in an app store.

       Comment (string)
           A short summary of the remote, for display e.g. in an app

       Description (string)
           A longer description of the remote, for display e.g. in an
           app store..

       Icon (string)
           The url for an icon that can be used to represent the remote.

       Homepage (string)
           The url of a webpage describing the remote.

       Filter (string)
           The path of a local file to use to filter remote refs. See
           flatpak-remote-add(1) for details on the format of the file.

           Note: This field is treated a bit special by flatpak
           remote-add. If you install a remote with --if-not-exists then
           and the remote is already configured, then the filter field
           of the remote configuration will be update anyway. And, if
           the filter field is *not* specified then any existing filters
           are cleared. The goal here is to allow a pre-configured
           filtered remote to be replaced with the regular one if you
           add the normal upstream (unfiltered) flatpakrepo file.

       DeployCollectionID (string)
           The collection ID of the remote, if it has one. This uniquely
           identifies the collection of apps in the remote, to allow
           peer to peer redistribution. It is recommended to use this
           key over CollectionID because only newer clients pay
           attention to it (and older clients don't handle collection
           IDs properly).

       CollectionID (string)
           This is deprecated but still supported for backwards
           compatibility. Use DeployCollectionID instead.

EXAMPLE         top

           [Flatpak Repo]

SEE ALSO         top

       flatpak(1), flatpak-remote-add(1), flatpak-flatpakref(5)

COLOPHON         top

       This page is part of the flatpak (a tool for building and
       distributing desktop applications on Linux) project.  Information
       about the project can be found at ⟨http://flatpak.org/⟩.  It is
       not known how to report bugs for this man page; if you know,
       please send a mail to man-pages@man7.org.  This page was obtained
       from the project's upstream Git repository
       ⟨https://github.com/flatpak/flatpak⟩ on 2021-08-27.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2021-08-26.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

flatpak                                                   FLATPAKREPO(5)

Pages that refer to this page: flatpak(1)flatpak-remote-add(1)flatpak-flatpakref(5)