# flatpakref

flatpakref

5

flatpak-flatpakref

Reference to a remote for an application or runtime

## Description

Flatpak uses flatpakref files to share information about a remote for a single application. The `flatpakref` file contains enough information to add the remote and install the application. Use the `flatpak install --from` command to do so.

The filename extension commonly used for flatpakref files is `.flatpakref`.

A flatpakref file can also refer to a remote for a runtime.

## File format

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

### [Flatpak Ref]

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

The following keys can be present in this group:

`Name` (string)

- The fully qualified name of the runtime that is used by the application. This key is mandatory.

`Url` (string)

- The url for the remote. This key is mandatory.

`Branch` (string)

- The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used.

`Title` (string)

- The title of the application or runtime. This should be a user-friendly name that can be displayed e.g. in an app store.

`IsRuntime` (boolean)

- Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.

`GPGKey` (string)

- The base64-encoded gpg key for the remote.

`RuntimeRepo` (string)

- The url for a .flatpakref file for the runtime.

## Example

    [Flatpak Ref]
    Title=GEdit
    Name=org.gnome.gedit
    Branch=stable
    Url=http://sdk.gnome.org/repo-apps/
    IsRuntime=False

## See also

flatpak

1,

flatpak-install

1

flatpak-flatpakrepo

5,