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 or archive-z2 (note that archive is used
21           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       min-free-space-percent
53           Integer percentage value (0-99) that specifies a minimum percentage
54           of total space (in blocks) in the underlying filesystem to keep
55           free. The default value is 3, which is enforced when neither this
56           option nor min-free-space-size are set.
57
58           If min-free-space-size is set to a non-zero value,
59           min-free-space-percent is ignored. Note that,
60           min-free-space-percent is not enforced on metadata objects. It is
61           assumed that metadata objects are relatively small in size compared
62           to content objects and thus kept outside the scope of this option.
63
64       min-free-space-size
65           Value (in power-of-2 MB, GB or TB) that specifies a minimum space
66           in the underlying filesystem to keep free. Examples of acceptable
67           values: 500MB (524 288 000 bytes), 1GB (1 073 741 824 bytes), 1TB
68           (1 099 511 627 776 bytes).
69
70           If this option is set to a non-zero value, and
71           min-free-space-percent is also set, this option takes priority.
72           Note that, min-free-space-size is not enforced on metadata objects.
73           It is assumed that metadata objects are relatively small in size
74           compared to content objects and thus kept outside the scope of this
75           option.
76
77       add-remotes-config-dir
78           Boolean value controlling whether new remotes will be added in the
79           remotes configuration directory. Defaults to true for system ostree
80           repositories. When this is false, remotes will be added in the
81           repository's config file.
82
83           This only applies to repositories that use a remotes configuration
84           directory such as system ostree repositories, which use
85           /etc/ostree/remotes.d. Non-system repositories do not use a remotes
86           configuration directory unless one is specified when the repository
87           is opened.
88
89       payload-link-threshold
90           An integer value that specifies a minimum file size for creating a
91           payload link. By default it is disabled.
92
93       collection-id
94           A reverse DNS domain name under your control, which enables peer to
95           peer distribution of refs in this repository. See the
96           --collection-id section in ostree-init(1)
97
98       locking
99           Boolean value controlling whether or not OSTree does repository
100           locking internally. This uses file locks and is hence for multiple
101           process exclusion (e.g. Flatpak and OSTree writing to the same
102           repository separately). This is enabled by default since 2018.5.
103
104       lock-timeout-secs
105           Integer value controlling the number of seconds to block while
106           attempting to acquire a lock (see above). A value of -1 means block
107           indefinitely. The default value is 30.
108
109       default-repo-finders
110           Semicolon separated default list of finders (sources for refs) to
111           use when pulling. This can be used to disable pulling from mounted
112           filesystems, peers on the local network, or the Internet. However
113           note that it only applies when a set of finders isn't explicitly
114           specified, either by a consumer of libostree API or on the command
115           line. Possible values: config, lan, and mount (or any combination
116           thereof). If unset, this defaults to config;mount; (since the LAN
117           finder is costly).
118

[REMOTE NAME"] SECTION OPTIONS"

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

/ETC/OSTREE/REMOTES.D

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

REPOSITORY URL/CONTENTURL

184       Originally, OSTree had just a url option for remotes. Since then, the
185       contenturl option was introduced. Both of these support file, http, and
186       https schemes.
187
188       Additionally, both of these can be prefixed with the string
189       mirrorlist=, which instructs the client that the target url is a
190       "mirrorlist" format, which is a plain text file of newline-separated
191       URLs. Earlier URLs will be given precedence.
192
193       Note that currently, the tls-ca-path and tls-client-cert-path options
194       apply to every HTTP request, even when contenturl and/or mirrorlist are
195       in use. This may change in the future to only apply to metadata (i.e.
196       url, not contenturl) fetches.
197

PER-REMOTE GPG KEYRINGS AND VERIFICATION

199       OSTree supports a per-remote GPG keyring, as well as a gpgkeypath
200       option. For more information see ostree(1). in the section GPG
201       verification.
202

PER-REMOTE HTTP COOKIES

204       Some content providers may want to control access to remote
205       repositories via HTTP cookies. The ostree remote add-cookie and ostree
206       remote delete-cookie commands will update a per-remote lookaside cookie
207       jar, named $remotename.cookies.txt.
208

SEE ALSO

210       ostree(1), ostree.repo(5)
211

NOTES

213        1. XDG Desktop Entry Specification
214           http://standards.freedesktop.org/desktop-entry-spec/latest/
215
216
217
218OSTree                                                    OSTREE.REPO-CONFI(5)
Impressum