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 config
20       fragments 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.
59           Defaults to 1.
60
61       xa.noenumerate (boolean)
62           Whether this remote should be used when presenting available
63           contents. Defaults to true.
64
65       xa.nodeps (boolean)
66           Whether this remote should be used when searching for dependencies.
67           Defaults to true.
68
69       xa.title (string)
70           An optional title to use when presenting this remote in a UI.
71
72       xa.title-is-set (boolean)
73           This key is set to true if xa.title has been explicitly set.
74
75       xa.default-branch (string)
76           The default branch to use when installing from this remote.
77
78       xa.default-branch-is-set (boolean)
79           This key is set to true if xa.default-branch has been explicitly
80           set.
81
82       xa.main-ref (string)
83           The main reference served by this remote. This is used for origin
84           remotes of applications installed via a flatpakref file.
85

EXAMPLES

87           [remote "gnome-nightly-apps"]
88           gpg-verify=true
89           gpg-verify-summary=true
90           url=https://sdk.gnome.org/nightly/repo-apps/
91           xa.title=GNOME Applications
92
93           [remote "flathub"]
94           gpg-verify=true
95           gpg-verify-summary=false
96           collection-id=org.flathub.Stable
97           url=https://dl.flathub.org/repo/
98           xa.title=Flathub
99

NAME

DESCRIPTION

FILE FORMAT

EXAMPLES

SEE ALSO