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 or archive-z2 (note that archive is used
21 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 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 If min-free-space-size is set to a non-zero value,
59 min-free-space-percent is ignored.
60 min-free-space-size
62 Value (in power-of-2 MB, GB or TB) that specifies a minimum space
63 in the underlying filesystem to keep free. Examples of acceptable
64 values: 500MB (524 288 000 bytes), 1GB (1 073 741 824 bytes), 1TB
65 (1 099 511 627 776 bytes).
66 If this option is set to a non-zero value, and
68 min-free-space-percent is also set, this option takes priority.
69 add-remotes-config-dir
71 Boolean value controlling whether new remotes will be added in the
72 remotes configuration directory. Defaults to true for system ostree
73 repositories. When this is false, remotes will be added in the
74 repository's config file.
75 This only applies to repositories that use a remotes configuration
77 directory such as system ostree repositories, which use
78 /etc/ostree/remotes.d. Non-system repositories do not use a remotes
79 configuration directory unless one is specified when the repository
80 is opened.
81 payload-link-threshold
83 An integer value that specifies a minimum file size for creating a
84 payload link. By default it is disabled.
85 collection-id
87 A reverse DNS domain name under your control, which enables peer to
88 peer distribution of refs in this repository. See the
89 --collection-id section in ostree-init(1)
90
92 Describes a remote repository location.
93 url
95 Must be present; declares URL for accessing metadata and content
96 for remote. See also contenturl. The supported schemes are
97 documented below.
98 contenturl
100 Declares URL for accessing content (filez, static delta parts).
101 When specified, url is used just for metadata: summary, static
102 delta "superblocks".
103 branches
105 A list of strings. Represents the default configured branches to
106 fetch from the remote when no specific branches are requested
107 during a pull operation.
108 proxy
110 A string value, if given should be a URL for a HTTP proxy to use
111 for access to this repository.
112 gpg-verify
114 A boolean value, defaults to true. Controls whether or not OSTree
115 will require commits to be signed by a known GPG key. For more
116 information, see the ostree(1) manual under GPG.
117 gpg-verify-summary
119 A boolean value, defaults to false. Controls whether or not OSTree
120 will check if the summary is signed by a known GPG key. For more
121 information, see the ostree(1) manual under GPG.
122 tls-permissive
124 A boolean value, defaults to false. By default, server TLS
125 certificates will be checked against the system certificate store.
126 If this variable is set, any certificate will be accepted.
127 tls-client-cert-path
129 Path to file for client-side certificate, to present when making
130 requests to this repository.
131 tls-client-key-path
133 Path to file containing client-side certificate key, to present
134 when making requests to this repository.
135 tls-ca-path
137 Path to file containing trusted anchors instead of the system CA
138 database.
139 http2
141 A boolean value, defaults to true. By default, libostree will use
142 HTTP2; setting this to false will disable it. May be useful to work
143 around broken servers.
144 unconfigured-state
146 If set, pulls from this remote will fail with the configured text.
147 This is intended for OS vendors which have a subscription process
148 to access content.
149
151 In addition to the /ostree/repo/config file, remotes may also be
152 specified in /etc/ostree/remotes.d. The remote configuration file must
153 end in .conf; files whose name does not end in .conf will be ignored.
154
156 Originally, OSTree had just a url option for remotes. Since then, the
157 contenturl option was introduced. Both of these support file, http, and
158 https schemes.
159 Additionally, both of these can be prefixed with the string
161 mirrorlist=, which instructs the client that the target url is a
162 "mirrorlist" format, which is a plain text file of newline-separated
163 URLs. Earlier URLs will be given precedence.
164 Note that currently, the tls-ca-path and tls-client-cert-path options
166 apply to every HTTP request, even when contenturl and/or mirrorlist are
167 in use. This may change in the future to only apply to metadata (i.e.
168 url, not contenturl) fetches.
169
171 OSTree supports a per-remote GPG keyring, as well as a gpgkeypath
172 option. For more information see ostree(1). in the section GPG
173 verification.
174
176 Some content providers may want to control access to remote
177 repositories via HTTP cookies. The ostree remote add-cookie and ostree
178 remote delete-cookie commands will update a per-remote lookaside cookie
179 jar, named $remotename.cookies.txt.
180
182 ostree(1), ostree.repo(5)
183
185 1. XDG Desktop Entry Specification
186 http://standards.freedesktop.org/desktop-entry-spec/latest/
187OSTree OSTREE.REPO-CONFI(5)