blob: 4545e202449cbc3793886573e626d9a3f65621f5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-remote">
<refentryinfo>
<title>flatpak remote</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>alexl@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak remote</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-remote</refname>
<refpurpose>Configuration for a remote</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Flatpak stores information about configured remotes for an installation location in
<filename>$installation/repo/config</filename>. For example, the remotes for the
default system-wide installation are in
<filename>$prefix/var/lib/flatpak/repo/config</filename>, and the remotes for the
per-user installation are in <filename>$HOME/.local/share/flatpak/repo/config</filename>.
</para>
<para>
Normally, it is not necessary to edit remote config files directly, the
<command>flatpak remote-modify</command> command should be used to change properties of remotes.
</para>
<para>
System-wide remotes can be statically preconfigured by dropping
flatpakref files into <filename>/etc/flatpak/remotes.d/</filename>.
</para>
</refsect1>
<refsect1>
<title>File format</title>
<para>
The remote config file format is using the same .ini file format that is used for systemd
unit files or application .desktop files.
</para>
<refsect2>
<title>[remote …]</title>
<para>
All the configuration for the the remote with name NAME is contained in the
[remote "NAME"] group.
</para>
<para>
The following keys are recognized by OSTree, among others:
</para>
<variablelist>
<varlistentry>
<term><option>url</option> (string)</term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>gpg-verify</option> (boolean)</term>
<listitem><para>Whether to use GPG verification for content from this remote.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>gpg-verify-summary</option> (boolean)</term>
<listitem>
<para>Whether to use GPG verification for the summary of this remote.</para>
<para>This is ignored if <option>collection-id</option> is set, as refs are verified in commit metadata in that case. Enabling <option>gpg-verify-summary</option> would break peer to peer distribution of refs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>collection-id</option> (string)</term>
<listitem><para>The globally unique identifier for the upstream collection repository, to allow mirrors to be grouped.</para></listitem>
</varlistentry>
</variablelist>
<para>
All flatpak-specific keys have a xa. prefix:
</para>
<variablelist>
<varlistentry>
<term><option>xa.disable</option> (boolean)</term>
<listitem><para>Whether the remote is disabled. Defaults to false.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.prio</option> (integer)</term>
<listitem><para>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.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.noenumerate</option> (boolean)</term>
<listitem><para>Whether this remote should be used when presenting available contents. Defaults to true.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.nodeps</option> (boolean)</term>
<listitem><para>Whether this remote should be used when searching for dependencies. Defaults to true.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.title</option> (string)</term>
<listitem><para>An optional title to use when presenting this remote in a UI.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.title-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.title</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.comment</option> (string)</term>
<listitem><para>An optional single-line comment to use when presenting this remote in a UI.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.comment-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.comment</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.description</option> (string)</term>
<listitem><para>An optional full-paragraph of text to use when presenting this remote in a UI.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.description-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.description</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.homepage</option> (string)</term>
<listitem><para>An optional URL that points to a website for this repository to use when presenting this remote in a UI.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.homepage-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.homepage</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.icon</option> (string)</term>
<listitem><para>An optional URL that points to an icon for this repository to use when presenting this remote in a UI.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.icon-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.icon</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.default-branch</option> (string)</term>
<listitem><para>The default branch to use when installing from this remote.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.default-branch-is-set</option> (boolean)</term>
<listitem><para>This key is set to true if <option>xa.default-branch</option> has been explicitly set.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>xa.main-ref</option> (string)</term>
<listitem><para>The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>Examples</title>
<programlisting>
[remote "gnome-nightly-apps"]
gpg-verify=true
gpg-verify-summary=true
url=https://sdk.gnome.org/nightly/repo-apps/
xa.title=GNOME Applications
</programlisting>
<programlisting>
[remote "flathub"]
gpg-verify=true
gpg-verify-summary=false
collection-id=org.flathub.Stable
url=https://dl.flathub.org/repo/
xa.title=Flathub
</programlisting>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak-remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
