flatpak-remote(5)

1FLATPAK REMOTE(5)               flatpak remote               FLATPAK REMOTE(5)
2
3
4

NAME

6       flatpak-remote - Configuration for a remote
7

DESCRIPTION

9       Flatpak stores information about configured remotes for an installation
10       location in $installation/repo/config. For example, the remotes for the
11       default system-wide installation are in
12       $prefix/var/lib/flatpak/repo/config, and the remotes for the per-user
13       installation are in $HOME/.local/share/flatpak/repo/config.
14
15       Normally, it is not necessary to edit remote config files directly, the
16       flatpak remote-modify command should be used to change properties of
17       remotes.
18
19       System-wide remotes can be statically preconfigured by dropping
20       flatpakref files into /etc/flatpak/remotes.d/.
21

FILE FORMAT

23       The remote config file format is using the same .ini file format that
24       is used for systemd unit files or application .desktop files.
25
26   [remote ...]
27       All the configuration for the the remote with name NAME is contained in
28       the [remote "NAME"] group.
29
30       The following keys are recognized by OSTree, among others:
31
32       url (string)
33           The url for the remote. An URL of the form oci+https:// or
34           oci+http:// is a Flatpak extension that indicates that the remote
35           is not an ostree repository, but is rather an URL to an index of
36           OCI images that are stored within a container image registry.
37
38       gpg-verify (boolean)
39           Whether to use GPG verification for content from this remote.
40
41       gpg-verify-summary (boolean)
42           Whether to use GPG verification for the summary of this remote.
43
44           This is ignored if collection-id is set, as refs are verified in
45           commit metadata in that case. Enabling gpg-verify-summary would
46           break peer to peer distribution of refs.
47
48       collection-id (string)
49           The globally unique identifier for the upstream collection
50           repository, to allow mirrors to be grouped.
51
52       All flatpak-specific keys have a xa. prefix:
53
54       xa.disable (boolean)
55           Whether the remote is disabled. Defaults to false.
56
57       xa.prio (integer)
58           The priority for the remote. This is used when listing remotes, and
59           when searching them for the runtime needed by an app. The remote
60           providing the app is searched for its runtime before others with
61           equal priority. Defaults to 1.
62
63       xa.noenumerate (boolean)
64           Whether this remote should be ignored when presenting available
65           apps/runtimes, or when searching for a runtime dependency. Defaults
66           to false.
67
68       xa.nodeps (boolean)
69           Whether this remote should be excluded when searching for
70           dependencies. Defaults to false.
71
72       xa.title (string)
73           An optional title to use when presenting this remote in a UI.
74
75       xa.title-is-set (boolean)
76           This key is set to true if xa.title has been explicitly set.
77
78       xa.comment (string)
79           An optional single-line comment to use when presenting this remote
80           in a UI.
81
82       xa.comment-is-set (boolean)
83           This key is set to true if xa.comment has been explicitly set.
84
85       xa.description (string)
86           An optional full-paragraph of text to use when presenting this
87           remote in a UI.
88
89       xa.description-is-set (boolean)
90           This key is set to true if xa.description has been explicitly set.
91
92       xa.homepage (string)
93           An optional URL that points to a website for this repository to use
94           when presenting this remote in a UI.
95
96       xa.homepage-is-set (boolean)
97           This key is set to true if xa.homepage has been explicitly set.
98
99       xa.icon (string)
100           An optional URL that points to an icon for this repository to use
101           when presenting this remote in a UI.
102
103       xa.icon-is-set (boolean)
104           This key is set to true if xa.icon has been explicitly set.
105
106       xa.default-branch (string)
107           The default branch to use when installing from this remote.
108
109       xa.default-branch-is-set (boolean)
110           This key is set to true if xa.default-branch has been explicitly
111           set.
112
113       xa.main-ref (string)
114           The main reference served by this remote. This is used for origin
115           remotes of applications installed via a flatpakref file.
116

EXAMPLES

118           [remote "gnome-nightly-apps"]
119           gpg-verify=true
120           gpg-verify-summary=true
121           url=https://sdk.gnome.org/nightly/repo-apps/
122           xa.title=GNOME Applications
123
124           [remote "flathub"]
125           gpg-verify=true
126           gpg-verify-summary=false
127           collection-id=org.flathub.Stable
128           url=https://dl.flathub.org/repo/
129           xa.title=Flathub
130

NAME

DESCRIPTION

FILE FORMAT

EXAMPLES

SEE ALSO