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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
<?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-add">
<refentryinfo>
<title>flatpak remote-add</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-add</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-remote-add</refname>
<refpurpose>Add a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak remote-add</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">NAME</arg>
<arg choice="plain">LOCATION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Adds a remote repository to the flatpak repository configuration.
<arg choice="plain">NAME</arg> is the name for the new remote, and
<arg choice="plain">LOCATION</arg> is a url or pathname.
The <arg choice="plain">LOCATION</arg> is either a flatpak repository,
or a <filename>.flatpakrepo</filename> file which
describes a repository. In the former case you may also have to specify
extra options, such as the gpg key for the repo.
</para>
<para>
Unless overridden with the <option>--user</option> or <option>--installation</option> options, this command
changes the default system-wide installation.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--from</option></term>
<listitem><para>
Assume the URI is a .flatpakrepo file rather than the repository itself. This is enabled
by default if the extension is .flatpakrepo, so generally you don't need this option.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option></term>
<term><option>--user</option></term>
<listitem><para>
Modify the per-user configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Modify the default system-wide configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Modify a system-wide installation specified by <arg choice="plain">NAME</arg>
among those defined in <filename>/etc/flatpak/installations.d/</filename>.
Using <option>--installation=default</option> is equivalent to using
<option>--system</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-gpg-verify</option></term>
<listitem><para>
Disable GPG verification for the added remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--prio=PRIO</option></term>
<listitem><para>
Set the priority for the remote. Default is 1, higher is more prioritized. This is
mainly used for graphical installation tools. It is also used when searching for a
remote to provide an app's runtime. The app's origin is checked before other
remotes with the same priority.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subset=SUBSET</option></term>
<listitem><para>
Limit the refs available from the remote to those that are part of the named subset.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-enumerate</option></term>
<listitem><para>
Mark the remote as not enumerated. This means the remote will
not be used to list applications, for instance in graphical
installation tools.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-use-for-deps</option></term>
<listitem><para>
Mark the remote as not to be used for automatic runtime
dependency resolution.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--if-not-exists</option></term>
<listitem><para>
Do nothing if the provided remote already exists.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable</option></term>
<listitem><para>
Disable the added remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--title=TITLE</option></term>
<listitem><para>
A title for the remote, e.g. for display in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--comment=COMMENT</option></term>
<listitem><para>
A single-line comment for the remote, e.g. for display in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--description=DESCRIPTION</option></term>
<listitem><para>
A full-paragraph description for the remote, e.g. for display in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--homepage=URL</option></term>
<listitem><para>
URL for a website for the remote, e.g. for display in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--icon=URL</option></term>
<listitem><para>
URL for an icon for the remote, e.g. for display in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--default-branch=BRANCH</option></term>
<listitem><para>
A default branch for the remote, mainly for use in a UI.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--filter=PATH</option></term>
<listitem><para>
Add a local filter to the remote. A filter file is a list of lines, each
file starting with "allow" or "deny", and then a glob for the ref to
allow or disallow. The globs specify a partial ref (i.e. you can leave out
trailing parts which will then match everything), but otherwise only "*" is
special, matching anything in that part of the ref.
</para>
<para>
By default all refs are allowed, but if a ref
matches a deny rule it is disallowed unless it
specifically matches an allow rule. This means you
can use this to implement both allowlisting and blocklisting.
</para>
<para>
Here is an example filter file:
<programlisting>
# This is an allowlist style filter as it denies all first
deny *
allow runtime/org.freedesktop.*
allow org.some.app/arm
allow org.signal.Signal/*/stable
allow org.signal.Signal.*/*/stable
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-import=FILE</option></term>
<listitem><para>
Import gpg keys from the specified keyring file as
trusted for the new remote. If the file is - the
keyring is read from standard input.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--authenticator-name=NAME</option></term>
<listitem><para>
Specify the authenticator to use for the remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--authenticator-option=KEY=VALUE</option></term>
<listitem><para>
Specify an authenticator option for the remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--authenticator-install</option></term>
<listitem><para>
Enable auto-installation of authenticator.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-authenticator-install</option></term>
<listitem><para>
Disable auto-installation of authenticator.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-follow-redirect</option></term>
<listitem><para>
Do not follow xa.redirect-url defined in the summary file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak remote-add gnome https://sdk.gnome.org/gnome.flatpakrepo</command>
</para>
<para>
<command>$ flatpak --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remote-delete</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
