'\" t .\" Title: flatpak remote .\" Author: Alexander Larsson .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 03/11/2024 .\" Manual: flatpak remote .\" Source: flatpak .\" Language: English .\" .TH "FLATPAK REMOTE" "5" "" "flatpak" "flatpak remote" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" flatpak-remote \- Configuration for a remote .SH "DESCRIPTION" .PP Flatpak stores information about configured remotes for an installation location in $installation/repo/config\&. For example, the remotes for the default system\-wide installation are in $prefix/var/lib/flatpak/repo/config, and the remotes for the per\-user installation are in $HOME/\&.local/share/flatpak/repo/config\&. .PP Normally, it is not necessary to edit remote config files directly, the \fBflatpak remote\-modify\fR command should be used to change properties of remotes\&. .PP System\-wide remotes can be statically preconfigured by dropping flatpakref files into /etc/flatpak/remotes\&.d/\&. .SH "FILE FORMAT" .PP The remote config file format is using the same \&.ini file format that is used for systemd unit files or application \&.desktop files\&. .SS "[remote \&...]" .PP All the configuration for the the remote with name NAME is contained in the [remote "NAME"] group\&. .PP The following keys are recognized by OSTree, among others: .PP \fBurl\fR (string) .RS 4 The url for the remote\&. An URL of the form oci+https:// or oci+http:// is a Flatpak extension that indicates that the remote is not an ostree repository, but is rather an URL to an index of OCI images that are stored within a container image registry\&. .RE .PP \fBgpg\-verify\fR (boolean) .RS 4 Whether to use GPG verification for content from this remote\&. .RE .PP \fBgpg\-verify\-summary\fR (boolean) .RS 4 Whether to use GPG verification for the summary of this remote\&. .sp This is ignored if \fBcollection\-id\fR is set, as refs are verified in commit metadata in that case\&. Enabling \fBgpg\-verify\-summary\fR would break peer to peer distribution of refs\&. .RE .PP \fBcollection\-id\fR (string) .RS 4 The globally unique identifier for the upstream collection repository, to allow mirrors to be grouped\&. .RE .PP All flatpak\-specific keys have a xa\&. prefix: .PP \fBxa\&.disable\fR (boolean) .RS 4 Whether the remote is disabled\&. Defaults to false\&. .RE .PP \fBxa\&.prio\fR (integer) .RS 4 The priority for the remote\&. This is used when listing remotes, and when searching them for the runtime needed by an app\&. The remote providing the app is searched for its runtime before others with equal priority\&. Defaults to 1\&. .RE .PP \fBxa\&.noenumerate\fR (boolean) .RS 4 Whether this remote should be ignored when presenting available apps/runtimes, or when searching for a runtime dependency\&. Defaults to false\&. .RE .PP \fBxa\&.nodeps\fR (boolean) .RS 4 Whether this remote should be excluded when searching for dependencies\&. Defaults to false\&. .RE .PP \fBxa\&.title\fR (string) .RS 4 An optional title to use when presenting this remote in a UI\&. .RE .PP \fBxa\&.title\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.title\fR has been explicitly set\&. .RE .PP \fBxa\&.comment\fR (string) .RS 4 An optional single\-line comment to use when presenting this remote in a UI\&. .RE .PP \fBxa\&.comment\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.comment\fR has been explicitly set\&. .RE .PP \fBxa\&.description\fR (string) .RS 4 An optional full\-paragraph of text to use when presenting this remote in a UI\&. .RE .PP \fBxa\&.description\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.description\fR has been explicitly set\&. .RE .PP \fBxa\&.homepage\fR (string) .RS 4 An optional URL that points to a website for this repository to use when presenting this remote in a UI\&. .RE .PP \fBxa\&.homepage\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.homepage\fR has been explicitly set\&. .RE .PP \fBxa\&.icon\fR (string) .RS 4 An optional URL that points to an icon for this repository to use when presenting this remote in a UI\&. .RE .PP \fBxa\&.icon\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.icon\fR has been explicitly set\&. .RE .PP \fBxa\&.default\-branch\fR (string) .RS 4 The default branch to use when installing from this remote\&. .RE .PP \fBxa\&.default\-branch\-is\-set\fR (boolean) .RS 4 This key is set to true if \fBxa\&.default\-branch\fR has been explicitly set\&. .RE .PP \fBxa\&.main\-ref\fR (string) .RS 4 The main reference served by this remote\&. This is used for origin remotes of applications installed via a flatpakref file\&. .RE .SH "EXAMPLES" .sp .if n \{\ .RS 4 .\} .nf [remote "gnome\-nightly\-apps"] gpg\-verify=true gpg\-verify\-summary=true url=https://sdk\&.gnome\&.org/nightly/repo\-apps/ xa\&.title=GNOME Applications .fi .if n \{\ .RE .\} .sp .if n \{\ .RS 4 .\} .nf [remote "flathub"] gpg\-verify=true gpg\-verify\-summary=false collection\-id=org\&.flathub\&.Stable url=https://dl\&.flathub\&.org/repo/ xa\&.title=Flathub .fi .if n \{\ .RE .\} .SH "SEE ALSO" .PP \fBflatpak-remote-modify\fR(1)