1FLATPAK METADATA(5)            flatpak metadata            FLATPAK METADATA(5)
2
3
4

NAME

6       flatpak-metadata - Information about an application or runtime
7

DESCRIPTION

9       Flatpak uses metadata files to describe applications and runtimes. The
10       metadata file for a deployed application or runtime is placed in the
11       toplevel deploy directory. For example, the metadata for the locally
12       installed application org.gnome.Calculator is in
13       ~/.local/share/flatpak/app/org.gnome.Calculator/current/active/metadata.
14
15       Most aspects of the metadata configuration can be overridden when
16       launching applications, either temporarily via options of the flatpak
17       run command, or permanently with the flatpak override command.
18
19       A metadata file describing the effective configuration is available
20       inside the running sandbox at /.flatpak-info. For compatibility with
21       older Flatpak versions, /run/user/$UID/flatpak-info is a symbolic link
22       to the same file.
23

FILE FORMAT

25       The metadata file is using the same .ini file format that is used for
26       systemd unit files or application .desktop files.
27
28   [Application] or [Runtime]
29       Metadata for applications starts with an [Application] group, metadata
30       for runtimes with a [Runtime] group.
31
32       The following keys can be present in these groups:
33
34       name (string)
35           The name of the application or runtime. This key is mandatory.
36
37       runtime (string)
38           The fully qualified name of the runtime that is used by the
39           application. This key is mandatory for applications.
40
41       sdk (string)
42           The fully qualified name of the sdk that matches the runtime.
43           Available since 0.1.
44
45       command (string)
46           The command to run. Only relevant for applications. Available since
47           0.1.
48
49       required-flatpak (string)
50           The required version of Flatpak to run this application or runtime.
51           For applications, this was available since 0.8.0. For runtimes,
52           this was available since 0.9.1, and backported to 0.8.3 for the
53           0.8.x branch.
54
55       tags (string list)
56           Tags to include in AppStream XML. Available since 0.4.12.
57
58   [Context]
59       This group determines various system resources that may be shared with
60       the application when it is run in a flatpak sandbox.
61
62       All keys in this group (and the group itself) are optional.
63
64       shared (list)
65           List of subsystems to share with the host system. Possible
66           subsystems: network, ipc. Available since 0.3.
67
68       sockets (list)
69           List of well-known sockets to make available in the sandbox.
70           Possible sockets: x11, wayland, fallback-x11, pulseaudio,
71           session-bus, system-bus, ssh-auth. When making a socket available,
72           flatpak also sets well-known environment variables like DISPLAY or
73           DBUS_SYSTEM_BUS_ADDRESS to let the application find sockets that
74           are not in a fixed location. Available since 0.3.
75
76       devices (list)
77           List of devices to make available in the sandbox. Possible values:
78
79           dri
80               Graphics direct rendering (/