1FLATPAK REMOTE-ADD(1) flatpak remote-add FLATPAK REMOTE-ADD(1)
2
3
4
6 flatpak-remote-add - Add a remote repository
7
9 flatpak remote-add [OPTION...] NAME LOCATION
10
12 Adds a remote repository to the flatpak repository configuration. NAME
13 is the name for the new remote, and LOCATION is a url or pathname. The
14 LOCATION is either a flatpak repository, or a .flatpakrepo file which
15 describes a repository. In the former case you may also have to specify
16 extra options, such as the gpg key for the repo.
17
18 Unless overridden with the --user or --installation options, this
19 command changes the default system-wide installation.
20
22 The following options are understood:
23
24 -h, --help
25 Show help options and exit.
26
27 --from
28 Assume the URI is a .flatpakrepo file rather than the repository
29 itself. This is enabled by default if the extension is
30 .flatpakrepo, so generally you don't need this option.
31
32 -u, --user
33 Modify the per-user configuration.
34
35 --system
36 Modify the default system-wide configuration.
37
38 --installation=NAME
39 Modify a system-wide installation specified by NAME among those
40 defined in /etc/flatpak/installations.d/. Using
41 --installation=default is equivalent to using --system.
42
43 --no-gpg-verify
44 Disable GPG verification for the added remote.
45
46 --prio=PRIO
47 Set the priority for the remote. Default is 1, higher is more
48 prioritized. This is mainly used for graphical installation tools.
49 It is also used when searching for a remote to provide an app's
50 runtime. The app's origin is checked before other remotes with the
51 same priority.
52
53 --subset=SUBSET
54 Limit the refs available from the remote to those that are part of
55 the named subset.
56
57 --no-enumerate
58 Mark the remote as not enumerated. This means the remote will not
59 be used to list applications, for instance in graphical
60 installation tools.
61
62 --no-use-for-deps
63 Mark the remote as not to be used for automatic runtime dependency
64 resolution.
65
66 --if-not-exists
67 Do nothing if the provided remote already exists.
68
69 --disable
70 Disable the added remote.
71
72 --title=TITLE
73 A title for the remote, e.g. for display in a UI.
74
75 --comment=COMMENT
76 A single-line comment for the remote, e.g. for display in a UI.
77
78 --description=DESCRIPTION
79 A full-paragraph description for the remote, e.g. for display in a
80 UI.
81
82 --homepage=URL
83 URL for a website for the remote, e.g. for display in a UI.
84
85 --icon=URL
86 URL for an icon for the remote, e.g. for display in a UI.
87
88 --default-branch=BRANCH
89 A default branch for the remote, mainly for use in a UI.
90
91 --filter=PATH
92 Add a local filter to the remote. A filter file is a list of lines,
93 each file starting with "allow" or "deny", and then a glob for the
94 ref to allow or disallow. The globs specify a partial ref (i.e. you
95 can leave out trailing parts which will then match everything), but
96 otherwise only "*" is special, matching anything in that part of
97 the ref.
98
99 By default all refs are allowed, but if a ref matches a deny rule
100 it is disallowed unless it specifically matches an allow rule. This
101 means you can use this to implement both allowlisting and
102 blocklisting.
103
104 Here is an example filter file:
105
106 # This is an allowlist style filter as it denies all first
107 deny *
108 allow runtime/org.freedesktop.*
109 allow org.some.app/arm
110 allow org.signal.Signal/*/stable
111 allow org.signal.Signal.*/*/stable
112
113
114 --gpg-import=FILE
115 Import gpg keys from the specified keyring file as trusted for the
116 new remote. If the file is - the keyring is read from standard
117 input.
118
119 --authenticator-name=NAME
120 Specify the authenticator to use for the remote.
121
122 --authenticator-option=KEY=VALUE
123 Specify an authenticator option for the remote.
124
125 --authenticator-install
126 Enable auto-installation of authenticator.
127
128 --no-authenticator-install
129 Disable auto-installation of authenticator.
130
131 --no-follow-redirect
132 Do not follow xa.redirect-url defined in the summary file.
133
134 -v, --verbose
135 Print debug information during command processing.
136
137 --ostree-verbose
138 Print OSTree debug information during command processing.
139
141 $ flatpak remote-add gnome https://sdk.gnome.org/gnome.flatpakrepo
142
143 $ flatpak --user remote-add --no-gpg-verify test-repo
144 https://people.gnome.org/~alexl/gnome-sdk/repo/
145
147 flatpak(1), flatpak-remote-modify(1), flatpak-remote-delete(1),
148 flatpak-remotes(1), flatpak-flatpakrepo(5)
149
150
151
152flatpak FLATPAK REMOTE-ADD(1)