1FLATPAKREF(5)                     flatpakref                     FLATPAKREF(5)
2
3
4

NAME

6       flatpak-flatpakref - Reference to a remote for an application or
7       runtime
8

DESCRIPTION

10       Flatpak uses flatpakref files to share information about a remote for a
11       single application. The flatpakref file contains enough information to
12       add the remote and install the application. Use the flatpak install
13       --from command to do so.
14
15       flatpakref files may also contain additional information that is useful
16       when displaying the application to the user, e.g. in an app store.
17
18       The filename extension commonly used for flatpakref files is
19       .flatpakref.
20
21       A flatpakref file can also refer to a remote for a runtime.
22

FILE FORMAT

24       The flatpakref file is using the same .ini file format that is used for
25       systemd unit files or application .desktop files.
26
27   [Flatpak Ref]
28       All the information is contained in the [Flatpak Ref] group.
29
30       The following keys can be present in this group:
31
32       Version (uint64)
33           The version of the file format, must be 1 if present.
34
35       Name (string)
36           The fully qualified name of the runtime or application. This key is
37           mandatory.
38
39       Url (string)
40           The url for the remote. This key is mandatory.
41
42       Branch (string)
43           The name of the branch from which to install the application or
44           runtime. If this key is not specified, the "master" branch is used.
45
46       Title (string)
47           The title of the application or runtime. This should be a
48           user-friendly name that can be displayed e.g. in an app store.
49
50       Comment (string)
51           A short summary of the application or runtime, for display e.g. in
52           an app store.
53
54       Description (string)
55           A longer description of the application or runtime, for display
56           e.g. in an app store.
57
58       Icon (string)
59           The url for an icon that can be used to represent the application
60           or runtime.
61
62       Homepage (string)
63           The url of a webpage describing the application or runtime.
64
65       DeployCollectionID (string)
66           The collection ID of the remote, if it has one. This uniquely
67           identifies the collection of apps in the remote, to allow peer to
68           peer redistribution. It is recommended to use this key over
69           CollectionID because only newer clients pay attention to it (and
70           older clients don't handle collection IDs properly).
71
72       CollectionID (string)
73           This is deprecated but still supported for backwards compatibility.
74           Use DeployCollectionID instead.
75
76       IsRuntime (boolean)
77           Whether this file refers to a runtime. If this key is not
78           specified, the file is assumed to refer to an application.
79
80       GPGKey (string)
81           The base64-encoded gpg key for the remote.
82
83       RuntimeRepo (string)
84           The url for a .flatpakrepo file for the remote where the runtime
85           can be found. Note that if the runtime is available in the remote
86           providing the app, that remote may be used instead but the one
87           specified by this option will still be added.
88
89       SuggestRemoteName (string)
90           A suggested name for the remote.
91

EXAMPLE

93           [Flatpak Ref]
94           Title=gedit
95           Name=org.gnome.gedit
96           Branch=stable
97           Url=http://sdk.gnome.org/repo-apps/
98           IsRuntime=false
99           GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY=
100           DeployCollectionID=org.gnome.Apps
101

SEE ALSO

103       flatpak(1), flatpak-install(1) flatpak-flatpakrepo(5),
104
105
106
107flatpak                                                          FLATPAKREF(5)
Impressum