1OSTREE.REPO-CONFI(5)          ostree.repo-config          OSTREE.REPO-CONFI(5)
2
3
4

NAME

6       ostree.repo-config - OSTree repository configuration
7

DESCRIPTION

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
14       See ostree.repo(5) for more information about OSTree repositories.
15

[CORE] SECTION OPTIONS

17       Repository-global options. The following entries are defined:
18
19       mode
20           One of bare, bare-user, bare-user-only, or archive-z2 (note that
21           archive is used everywhere else.)
22
23       repo_version
24           Currently, this must be set to 1.
25
26       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
32       commit-update-summary
33           This option is deprecated. Use auto-update-summary instead, for
34           which this option is now an alias.
35
36       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
41           If you disable fsync, OSTree will no longer be robust against
42           kernel crashes or power loss.
43
44           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
49           For the system repository, you might choose to disable fsync if you
50           have uninterruptable power supplies and a well tested kernel.
51
52       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
59       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
65           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
71       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
77           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
84       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
90           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
96       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
100       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
105       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
111       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 30.
115
116       default-repo-finders
117           Semicolon separated default list of finders (sources for refs) to
118           use when pulling. This can be used to disable pulling from mounted
119           filesystems, peers on the local network, or the Internet. However
120           note that it only applies when a set of finders isn't explicitly
121           specified, either by a consumer of libostree API or on the command
122           line. Possible values: config, lan, and mount (or any combination
123           thereof). If unset, this defaults to config;mount; (since the LAN
124           finder is costly).
125
126       no-deltas-in-summary
127           Boolean value controlling whether OSTree should skip putting an
128           index of available deltas in the summary file. Defaults to false.
129
130           Since 2020.7 OSTree can use delta indexes outside the summary file,
131           making the summary file smaller (especially for larger
132           repositories). However by default we still create the index in the
133           summary file to make older clients work. If you know all clients
134           will be 2020.7 later you can enable this to save network bandwidth.
135

[REMOTE NAME"] SECTION OPTIONS"

137       Describes a remote repository location.
138
139       url
140           Must be present; declares URL for accessing metadata and content
141           for remote. See also contenturl. The supported schemes are
142           documented below.
143
144       contenturl
145           Declares URL for accessing content (filez, static delta parts).
146           When specified, url is used just for metadata: summary, static
147           delta "superblocks".
148
149       branches
150           A list of strings. Represents the default configured branches to
151           fetch from the remote when no specific branches are requested
152           during a pull operation.
153
154       proxy
155           A string value, if given should be a URL for a HTTP proxy to use
156           for access to this repository.
157
158       gpg-verify
159           A boolean value, defaults to true. Controls whether or not OSTree
160           will require commits to be signed by a known GPG key. For more
161           information, see the ostree(1) manual under GPG.
162
163       gpg-verify-summary
164           A boolean value, defaults to false. Controls whether or not OSTree
165           will check if the summary is signed by a known GPG key. For more
166           information, see the ostree(1) manual under GPG.
167
168       tls-permissive
169           A boolean value, defaults to false. By default, server TLS
170           certificates will be checked against the system certificate store.
171           If this variable is set, any certificate will be accepted.
172
173       tls-client-cert-path
174           Path to file for client-side certificate, to present when making
175           requests to this repository.
176
177       tls-client-key-path
178           Path to file containing client-side certificate key, to present
179           when making requests to this repository.
180
181       tls-ca-path
182           Path to file containing trusted anchors instead of the system CA
183           database.
184
185       http2
186           A boolean value, defaults to true. By default, libostree will use
187           HTTP2; setting this to false will disable it. May be useful to work
188           around broken servers.
189
190       unconfigured-state
191           If set, pulls from this remote will fail with the configured text.
192           This is intended for OS vendors which have a subscription process
193           to access content.
194

[SYSROOT] SECTION OPTIONS

196       Options for the sysroot, which contains the OSTree repository,
197       deployments, and stateroots. The following entries are defined:
198
199       bootloader
200           Configure the bootloader that OSTree uses when deploying the
201           sysroot. This may take the values bootloader=none, bootloader=auto,
202           bootloader=grub2, bootloader=syslinux, bootloader=uboot or
203           bootloader=zipl. Default is auto.
204
205           If none, then OSTree will generate only BLS (Boot Loader
206           Specification) fragments in sysroot/boot/loader/entries/ for the
207           deployment.
208
209           If auto, then in addition to generating BLS fragments, OSTree will
210           dynamically check for the existence of grub2, uboot, and syslinux
211           bootloaders. If one of the bootloaders is found, then OSTree will
212           generate a config for the bootloader found. For example,
213           grub2-mkconfig is run for the grub2 case.
214
215           A specific bootloader type may also be explicitly requested by
216           choosing grub2, syslinux, uboot or zipl.
217

/ETC/OSTREE/REMOTES.D

219       In addition to the /ostree/repo/config file, remotes may also be
220       specified in /etc/ostree/remotes.d. The remote configuration file must
221       end in .conf; files whose name does not end in .conf will be ignored.
222

REPOSITORY URL/CONTENTURL

224       Originally, OSTree had just a url option for remotes. Since then, the
225       contenturl option was introduced. Both of these support file, http, and
226       https schemes.
227
228       Additionally, both of these can be prefixed with the string
229       mirrorlist=, which instructs the client that the target url is a
230       "mirrorlist" format, which is a plain text file of newline-separated
231       URLs. Earlier URLs will be given precedence.
232
233       Note that currently, the tls-ca-path and tls-client-cert-path options
234       apply to every HTTP request, even when contenturl and/or mirrorlist are
235       in use. This may change in the future to only apply to metadata (i.e.
236       url, not contenturl) fetches.
237

PER-REMOTE GPG KEYRINGS AND VERIFICATION

239       OSTree supports a per-remote GPG keyring, as well as a gpgkeypath
240       option. For more information see ostree(1). in the section GPG
241       verification.
242

PER-REMOTE HTTP COOKIES

244       Some content providers may want to control access to remote
245       repositories via HTTP cookies. The ostree remote add-cookie and ostree
246       remote delete-cookie commands will update a per-remote lookaside cookie
247       jar, named $remotename.cookies.txt.
248

SEE ALSO

250       ostree(1), ostree.repo(5)
251

NOTES

253        1. XDG Desktop Entry Specification
254           http://standards.freedesktop.org/desktop-entry-spec/latest/
255
256
257
258OSTree                                                    OSTREE.REPO-CONFI(5)
Impressum