1OSTREE.REPO-CONFI(5) ostree.repo-config OSTREE.REPO-CONFI(5)
2
6 ostree.repo-config - OSTree repository configuration
7
9 The config file in an OSTree repository is a "keyfile" in the XDG
10 Desktop Entry Specification[1] format. It has several global flags, as
11 well as zero or more remote entries which describe how to access remote
12 repositories.
13 See ostree.repo(5) for more information about OSTree repositories.
15
17 Repository-global options. The following entries are defined:
18 mode
20 One of bare, bare-user, bare-user-only, or archive-z2 (note that
21 archive is used everywhere else.)
22 repo_version
24 Currently, this must be set to 1.
25 auto-update-summary
27 Boolean value controlling whether or not to automatically update
28 the summary file after any ref is added, removed, or updated. Other
29 modifications which may render a summary file stale (like static
30 deltas, or collection IDs) do not currently trigger an auto-update.
31 commit-update-summary
33 This option is deprecated. Use auto-update-summary instead, for
34 which this option is now an alias.
35 fsync
37 Boolean value controlling whether or not to ensure files are on
38 stable storage when performing operations such as commits, pulls,
39 and checkouts. Defaults to true.
40 If you disable fsync, OSTree will no longer be robust against
42 kernel crashes or power loss.
43 You might choose to disable this for local development
45 repositories, under the assumption they can be recreated from
46 source. Similarly, you could disable for a mirror where you could
47 re-pull.
48 For the system repository, you might choose to disable fsync if you
50 have uninterruptable power supplies and a well tested kernel.
51 per-object-fsync
53 By default, OSTree will batch fsync() after writing everything;
54 however, this can cause latency spikes for other processes which
55 are also invoking fsync(). Turn on this boolean to reduce potential
56 latency spikes, at the cost of slowing down OSTree updates. You
57 most likely want this on by default for "background" OS updates.
58 min-free-space-percent
60 Integer percentage value (0-99) that specifies a minimum percentage
61 of total space (in blocks) in the underlying filesystem to keep
62 free. The default value is 3, which is enforced when neither this
63 option nor min-free-space-size are set.
64 If min-free-space-size is set to a non-zero value,
66 min-free-space-percent is ignored. Note that,
67 min-free-space-percent is not enforced on metadata objects. It is
68 assumed that metadata objects are relatively small in size compared
69 to content objects and thus kept outside the scope of this option.
70 min-free-space-size
72 Value (in power-of-2 MB, GB or TB) that specifies a minimum space
73 in the underlying filesystem to keep free. Examples of acceptable
74 values: 500MB (524 288 000 bytes), 1GB (1 073 741 824 bytes), 1TB
75 (1 099 511 627 776 bytes).
76 If this option is set to a non-zero value, and
78 min-free-space-percent is also set, this option takes priority.
79 Note that, min-free-space-size is not enforced on metadata objects.
80 It is assumed that metadata objects are relatively small in size
81 compared to content objects and thus kept outside the scope of this
82 option.
83 add-remotes-config-dir
85 Boolean value controlling whether new remotes will be added in the
86 remotes configuration directory. Defaults to true for system ostree
87 repositories. When this is false, remotes will be added in the
88 repository's config file.
89 This only applies to repositories that use a remotes configuration
91 directory such as system ostree repositories, which use
92 /etc/ostree/remotes.d. Non-system repositories do not use a remotes
93 configuration directory unless one is specified when the repository
94 is opened.
95 payload-link-threshold
97 An integer value that specifies a minimum file size for creating a
98 payload link. By default it is disabled.
99 collection-id
101 A reverse DNS domain name under your control, which enables peer to
102 peer distribution of refs in this repository. See the
103 --collection-id section in ostree-init(1)
104 locking
106 Boolean value controlling whether or not OSTree does repository
107 locking internally. This uses file locks and is hence for multiple
108 process exclusion (e.g. Flatpak and OSTree writing to the same
109 repository separately). This is enabled by default since 2018.5.
110 lock-timeout-secs
112 Integer value controlling the number of seconds to block while
113 attempting to acquire a lock (see above). A value of -1 means block
114 indefinitely. The default value is 300. This timeout is now
115 regarded as a mistake; because it's likely to cause flakes. It's
116 recommended to set it to -1, and have timeouts at a higher
117 application level if desired.
118 default-repo-finders
120 Semicolon separated default list of finders (sources for refs) to
121 use when pulling. This can be used to disable pulling from mounted
122 filesystems, peers on the local network, or the Internet. However
123 note that it only applies when a set of finders isn't explicitly
124 specified, either by a consumer of libostree API or on the command
125 line. Possible values: config, lan, and mount (or any combination
126 thereof). If unset, this defaults to config;mount; (since the LAN
127 finder is costly).
128 no-deltas-in-summary
130 Boolean value controlling whether OSTree should skip putting an
131 index of available deltas in the summary file. Defaults to false.
132 Since 2020.7 OSTree can use delta indexes outside the summary file,
134 making the summary file smaller (especially for larger
135 repositories). However by default we still create the index in the
136 summary file to make older clients work. If you know all clients
137 will be 2020.7 later you can enable this to save network bandwidth.
138
140 Describes a remote repository location.
141 url
143 Must be present; declares URL for accessing metadata and content
144 for remote. See also contenturl. The supported schemes are
145 documented below.
146 contenturl
148 Declares URL for accessing content (filez, static delta parts).
149 When specified, url is used just for metadata: summary, static
150 delta "superblocks".
151 branches
153 A list of strings. Represents the default configured branches to
154 fetch from the remote when no specific branches are requested
155 during a pull operation.
156 proxy
158 A string value, if given should be a URL for a HTTP proxy to use
159 for access to this repository.
160 gpg-verify
162 A boolean value, defaults to true. Controls whether or not OSTree
163 will require commits to be signed by a known GPG key. For more
164 information, see the ostree(1) manual under GPG.
165 gpg-verify-summary
167 A boolean value, defaults to false. Controls whether or not OSTree
168 will check if the summary is signed by a known GPG key. For more
169 information, see the ostree(1) manual under GPG.
170 tls-permissive
172 A boolean value, defaults to false. By default, server TLS
173 certificates will be checked against the system certificate store.
174 If this variable is set, any certificate will be accepted.
175 tls-client-cert-path
177 Path to file for client-side certificate, to present when making
178 requests to this repository.
179 tls-client-key-path
181 Path to file containing client-side certificate key, to present
182 when making requests to this repository.
183 tls-ca-path
185 Path to file containing trusted anchors instead of the system CA
186 database.
187 http2
189 A boolean value, defaults to true. By default, libostree will use
190 HTTP2; setting this to false will disable it. May be useful to work
191 around broken servers.
192 unconfigured-state
194 If set, pulls from this remote will fail with the configured text.
195 This is intended for OS vendors which have a subscription process
196 to access content.
197 custom-backend
199 If set, pulls from this remote via libostree will fail with an
200 error that mentions the value. It is recommended to make this a
201 software identifier token (e.g. "examplecorp-fetcher"), not
202 freeform text ("ExampleCorp Fetcher"). This is intended to be used
203 by higher level software that wants to fetch ostree commits via
204 some other mechanism, while still reusing the core libostree
205 infrastructure around e.g. signatures.
206
208 Options for the sysroot, which contains the OSTree repository,
209 deployments, and stateroots. The following entries are defined:
210 bootloader
212 Configure the bootloader that OSTree uses when deploying the
213 sysroot. This may take the values bootloader=none, bootloader=auto,
214 bootloader=grub2, bootloader=syslinux, bootloader=uboot or
215 bootloader=zipl. Default is auto.
216 If none, then OSTree will generate only BLS (Boot Loader
218 Specification) fragments in sysroot/boot/loader/entries/ for the
219 deployment.
220 If auto, then in addition to generating BLS fragments, OSTree will
222 dynamically check for the existence of grub2, uboot, and syslinux
223 bootloaders. If one of the bootloaders is found, then OSTree will
224 generate a config for the bootloader found. For example,
225 grub2-mkconfig is run for the grub2 case.
226 A specific bootloader type may also be explicitly requested by
228 choosing grub2, syslinux, uboot or zipl.
229 bls-append-except-default
231 A semicolon seperated string list of key-value pairs. For example:
232 bls-append-except-default=key1=value1;key2=value2. These key-value
233 pairs will be injected into the generated BLS fragments of the
234 non-default deployments. In other words, the BLS fragment of the
235 default deployment will be unaffected by bls-append-except-default.
236 bootprefix
238 A boolean value; defaults to false. If set to true, the bootloader
239 entries generated will include /boot as a prefix. This will likely
240 be turned on by default in the future.
241
243 The "ex-" prefix here signifies experimental options. The ex-integrity
244 section contains options related to system integrity. Information about
245 experimental options is canonically found in upstream tracking issues.
246
248 In addition to the /ostree/repo/config file, remotes may also be
249 specified in /etc/ostree/remotes.d. The remote configuration file must
250 end in .conf; files whose name does not end in .conf will be ignored.
251
253 Originally, OSTree had just a url option for remotes. Since then, the
254 contenturl option was introduced. Both of these support file, http, and
255 https schemes.
256 Additionally, both of these can be prefixed with the string
258 mirrorlist=, which instructs the client that the target url is a
259 "mirrorlist" format, which is a plain text file of newline-separated
260 URLs. Earlier URLs will be given precedence.
261 Note that currently, the tls-ca-path and tls-client-cert-path options
263 apply to every HTTP request, even when contenturl and/or mirrorlist are
264 in use. This may change in the future to only apply to metadata (i.e.
265 url, not contenturl) fetches.
266
268 OSTree supports a per-remote GPG keyring, as well as a gpgkeypath
269 option. For more information see ostree(1). in the section GPG
270 verification.
271
273 Some content providers may want to control access to remote
274 repositories via HTTP cookies. The ostree remote add-cookie and ostree
275 remote delete-cookie commands will update a per-remote lookaside cookie
276 jar, named $remotename.cookies.txt.
277
279 ostree(1), ostree.repo(5)
280
282 1. XDG Desktop Entry Specification
283 http://standards.freedesktop.org/desktop-entry-spec/latest/
284OSTree OSTREE.REPO-CONFI(5)