{"id":4702,"date":"2022-12-20T18:36:47","date_gmt":"2022-12-20T21:36:47","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/ostree-repoconfi-man5\/"},"modified":"2022-12-20T18:36:47","modified_gmt":"2022-12-20T21:36:47","slug":"ostree-repoconfi-man5","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/ostree-repoconfi-man5\/","title":{"rendered":"OSTREE.REPO&minus;CONFI (man5)"},"content":{"rendered":"<h1 align=\"center\">OSTREE.REPO\u2212CONFI<\/h1>\n<p> <a href=\"#NAME\">NAME<\/a><br \/> <a href=\"#DESCRIPTION\">DESCRIPTION<\/a><br \/> <a href=\"#[CORE] SECTION OPTIONS\">[CORE] SECTION OPTIONS<\/a><br \/> <a href=\"#[REMOTE NAME\"] SECTION OPTIONS\"\">[REMOTE NAME&#8221;] SECTION OPTIONS&#8221;<\/a><br \/> <a href=\"#[SYSROOT] SECTION OPTIONS\">[SYSROOT] SECTION OPTIONS<\/a><br \/> <a href=\"#\/ETC\/OSTREE\/REMOTES.D\">\/ETC\/OSTREE\/REMOTES.D<\/a><br \/> <a href=\"#REPOSITORY URL\/CONTENTURL\">REPOSITORY URL\/CONTENTURL<\/a><br \/> <a href=\"#PER\u2212REMOTE GPG KEYRINGS AND VERIFICATION\">PER\u2212REMOTE GPG KEYRINGS AND VERIFICATION<\/a><br \/> <a href=\"#PER\u2212REMOTE HTTP COOKIES\">PER\u2212REMOTE HTTP COOKIES<\/a><br \/> <a href=\"#SEE ALSO\">SEE ALSO<\/a><br \/> <a href=\"#NOTES\">NOTES<\/a> <\/p>\n<hr>\n<h2>NAME <a name=\"NAME\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\">ostree.repo-config \u2212 OSTree repository configuration<\/p>\n<h2>DESCRIPTION <a name=\"DESCRIPTION\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\">The config file in an OSTree repository is a &#8220;keyfile&#8221; in the <b><font color=\"#0000FF\">XDG Desktop Entry Specification<\/font><\/b> <small><font color=\"#000000\">[1]<\/font><\/small> <font color=\"#000000\">format. It has several global flags, as well as zero or more remote entries which describe how to access remote repositories.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">See <b>ostree.repo<\/b>(5) for more information about OSTree repositories.<\/font><\/p>\n<h2>[CORE] SECTION OPTIONS <a name=\"[CORE] SECTION OPTIONS\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Repository\u2212global options. The following entries are defined:<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>mode<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">One of bare, bare\u2212user or archive\u2212z2 (note that archive is used everywhere else.)<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>repo_version<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Currently, this must be set to 1.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>auto\u2212update\u2212summary<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Boolean value controlling whether or not to automatically update the summary file after any ref is added, removed, or updated. Other modifications which may render a summary file stale (like static deltas, or collection IDs) do not currently trigger an auto\u2212update.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>commit\u2212update\u2212summary<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">This option is deprecated. Use auto\u2212update\u2212summary instead, for which this option is now an alias.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>fsync<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Boolean value controlling whether or not to ensure files are on stable storage when performing operations such as commits, pulls, and checkouts. Defaults to true.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">If you disable fsync, OSTree will no longer be robust against kernel crashes or power loss.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">You might choose to disable this for local development repositories, under the assumption they can be recreated from source. Similarly, you could disable for a mirror where you could re\u2212pull.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">For the system repository, you might choose to disable fsync if you have uninterruptable power supplies and a well tested kernel.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>per\u2212object\u2212fsync<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">By default, OSTree will batch fsync() after writing everything; however, this can cause latency spikes for other processes which are also invoking fsync(). Turn on this boolean to reduce potential latency spikes, at the cost of slowing down OSTree updates. You most likely want this on by default for &#8220;background&#8221; OS updates.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>min\u2212free\u2212space\u2212percent<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Integer percentage value (0\u221299) that specifies a minimum percentage of total space (in blocks) in the underlying filesystem to keep free. The default value is 3, which is enforced when neither this option nor <i>min\u2212free\u2212space\u2212size<\/i> are set.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">If <i>min\u2212free\u2212space\u2212size<\/i> is set to a non\u2212zero value, <i>min\u2212free\u2212space\u2212percent<\/i> is ignored. Note that, <i>min\u2212free\u2212space\u2212percent<\/i> is not enforced on metadata objects. It is assumed that metadata objects are relatively small in size compared to content objects and thus kept outside the scope of this option.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>min\u2212free\u2212space\u2212size<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Value (in power\u2212of\u22122 MB, GB or TB) that specifies a minimum space in the underlying filesystem to keep free. Examples of acceptable values: 500MB (524\u00a0288\u00a0000 bytes), 1GB (1\u00a0073\u00a0741\u00a0824 bytes), 1TB (1\u00a0099\u00a0511\u00a0627\u00a0776 bytes).<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">If this option is set to a non\u2212zero value, and <i>min\u2212free\u2212space\u2212percent<\/i> is also set, this option takes priority. Note that, <i>min\u2212free\u2212space\u2212size<\/i> is not enforced on metadata objects. It is assumed that metadata objects are relatively small in size compared to content objects and thus kept outside the scope of this option.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>add\u2212remotes\u2212config\u2212dir<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Boolean value controlling whether new remotes will be added in the remotes configuration directory. Defaults to true for system ostree repositories. When this is false, remotes will be added in the repository&#8217;s config file.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">This only applies to repositories that use a remotes configuration directory such as system ostree repositories, which use \/etc\/ostree\/remotes.d. Non\u2212system repositories do not use a remotes configuration directory unless one is specified when the repository is opened.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>payload\u2212link\u2212threshold<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">An integer value that specifies a minimum file size for creating a payload link. By default it is disabled.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>collection\u2212id<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A reverse DNS domain name under your control, which enables peer to peer distribution of refs in this repository. See the \u2212\u2212collection\u2212id section in <b>ostree-init<\/b>(1)<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>locking<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Boolean value controlling whether or not OSTree does repository locking internally. This uses file locks and is hence for multiple process exclusion (e.g. Flatpak and OSTree writing to the same repository separately). This is enabled by default since 2018.5.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>lock\u2212timeout\u2212secs<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Integer value controlling the number of seconds to block while attempting to acquire a lock (see above). A value of \u22121 means block indefinitely. The default value is 30.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>default\u2212repo\u2212finders<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Semicolon separated default list of finders (sources for refs) to use when pulling. This can be used to disable pulling from mounted filesystems, peers on the local network, or the Internet. However note that it only applies when a set of finders isn&#8217;t explicitly specified, either by a consumer of libostree API or on the command line. Possible values: config, lan, and mount (or any combination thereof). If unset, this defaults to config;mount; (since the LAN finder is costly).<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>no\u2212deltas\u2212in\u2212summary<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Boolean value controlling whether OSTree should skip putting an index of available deltas in the summary file. Defaults to false.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">Since 2020.7 OSTree can use delta indexes outside the summary file, making the summary file smaller (especially for larger repositories). However by default we still create the index in the summary file to make older clients work. If you know all clients will be 2020.7 later you can enable this to save network bandwidth.<\/font><\/p>\n<h2>[REMOTE NAME&#8221;] SECTION OPTIONS&#8221; <a name=\"[REMOTE NAME\"] SECTION OPTIONS\"\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Describes a remote repository location.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>url<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Must be present; declares URL for accessing metadata and content for remote. See also contenturl. The supported schemes are documented below.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>contenturl<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Declares URL for accessing content (filez, static delta parts). When specified, url is used just for metadata: summary, static delta &#8220;superblocks&#8221;.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>branches<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A list of strings. Represents the default configured branches to fetch from the remote when no specific branches are requested during a pull operation.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>proxy<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A string value, if given should be a URL for a HTTP proxy to use for access to this repository.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>gpg\u2212verify<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A boolean value, defaults to true. Controls whether or not OSTree will require commits to be signed by a known GPG key. For more information, see the <b>ostree<\/b>(1) manual under GPG.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>gpg\u2212verify\u2212summary<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A boolean value, defaults to false. Controls whether or not OSTree will check if the summary is signed by a known GPG key. For more information, see the <b>ostree<\/b>(1) manual under GPG.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>tls\u2212permissive<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A boolean value, defaults to false. By default, server TLS certificates will be checked against the system certificate store. If this variable is set, any certificate will be accepted.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>tls\u2212client\u2212cert\u2212path<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Path to file for client\u2212side certificate, to present when making requests to this repository.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>tls\u2212client\u2212key\u2212path<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Path to file containing client\u2212side certificate key, to present when making requests to this repository.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>tls\u2212ca\u2212path<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Path to file containing trusted anchors instead of the system CA database.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>http2<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">A boolean value, defaults to true. By default, libostree will use HTTP2; setting this to false will disable it. May be useful to work around broken servers.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>unconfigured\u2212state<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">If set, pulls from this remote will fail with the configured text. This is intended for OS vendors which have a subscription process to access content.<\/font><\/p>\n<h2>[SYSROOT] SECTION OPTIONS <a name=\"[SYSROOT] SECTION OPTIONS\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Options for the sysroot, which contains the OSTree repository, deployments, and stateroots. The following entries are defined:<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><i>bootloader<\/i><\/font><\/p>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">Configure the bootloader that OSTree uses when deploying the sysroot. This may take the values bootloader=none, bootloader=auto, bootloader=grub2, bootloader=syslinux, bootloader=uboot or bootloader=zipl. Default is auto.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">If none, then OSTree will generate only BLS (Boot Loader Specification) fragments in sysroot\/boot\/loader\/entries\/ for the deployment.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">If auto, then in addition to generating BLS fragments, OSTree will dynamically check for the existence of grub2, uboot, and syslinux bootloaders. If one of the bootloaders is found, then OSTree will generate a config for the bootloader found. For example, grub2\u2212mkconfig is run for the grub2 case.<\/font><\/p>\n<p style=\"margin-left:17%; margin-top: 1em\"><font color=\"#000000\">A specific bootloader type may also be explicitly requested by choosing grub2, syslinux, uboot or zipl.<\/font><\/p>\n<h2>\/ETC\/OSTREE\/REMOTES.D <a name=\"\/ETC\/OSTREE\/REMOTES.D\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">In addition to the \/ostree\/repo\/config file, remotes may also be specified in \/etc\/ostree\/remotes.d. The remote configuration file must end in .conf; files whose name does not end in .conf will be ignored.<\/font><\/p>\n<h2>REPOSITORY URL\/CONTENTURL <a name=\"REPOSITORY URL\/CONTENTURL\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Originally, OSTree had just a url option for remotes. Since then, the contenturl option was introduced. Both of these support file, http, and https schemes.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Additionally, both of these can be prefixed with the string mirrorlist=, which instructs the client that the target url is a &#8220;mirrorlist&#8221; format, which is a plain text file of newline\u2212separated URLs. Earlier URLs will be given precedence.<\/font><\/p>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Note that currently, the tls\u2212ca\u2212path and tls\u2212client\u2212cert\u2212path options apply to every HTTP request, even when contenturl and\/or mirrorlist are in use. This may change in the future to only apply to metadata (i.e. url, not contenturl) fetches.<\/font><\/p>\n<h2>PER\u2212REMOTE GPG KEYRINGS AND VERIFICATION <a name=\"PER\u2212REMOTE GPG KEYRINGS AND VERIFICATION\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">OSTree supports a per\u2212remote GPG keyring, as well as a gpgkeypath option. For more information see <b>ostree<\/b>(1). in the section GPG verification.<\/font><\/p>\n<h2>PER\u2212REMOTE HTTP COOKIES <a name=\"PER\u2212REMOTE HTTP COOKIES\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\">Some content providers may want to control access to remote repositories via HTTP cookies. The <b>ostree remote add\u2212cookie<\/b> and <b>ostree remote delete\u2212cookie<\/b> commands will update a per\u2212remote lookaside cookie jar, named $remotename.cookies.txt.<\/font><\/p>\n<h2>SEE ALSO <a name=\"SEE ALSO\"><\/a> <\/h2>\n<p style=\"margin-left:11%; margin-top: 1em\"><font color=\"#000000\"><b>ostree<\/b>(1), <b>ostree.repo<\/b>(5)<\/font><\/p>\n<h2>NOTES <a name=\"NOTES\"><\/a> <\/h2>\n<table width=\"100%\" border=\"0\" rules=\"none\" frame=\"void\" cellspacing=\"0\" cellpadding=\"0\">\n<tr valign=\"top\" align=\"left\">\n<td width=\"12%\"><\/td>\n<td width=\"3%\">\n<p style=\"margin-top: 1em\"><font color=\"#000000\">1.<\/font><\/p>\n<\/td>\n<td width=\"2%\"><\/td>\n<td width=\"48%\">\n<p style=\"margin-top: 1em\"><font color=\"#000000\">XDG Desktop Entry Specification<\/font><\/p>\n<\/td>\n<td width=\"35%\"> <\/td>\n<\/tr>\n<\/table>\n<p style=\"margin-left:17%;\"><font color=\"#000000\">http:\/\/standards.freedesktop.org\/desktop-entry-spec\/latest\/<\/font><\/p>\n<hr>\n","protected":false},"excerpt":{"rendered":"<p>  ostree.repo-config \u2212 OSTree repository configuration <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[959],"tags":[961,1291,1310],"class_list":["post-4702","post","type-post","status-publish","format-standard","hentry","category-5-formatos-de-ficheros","tag-961","tag-man5","tag-ostree"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/4702","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=4702"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/4702\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=4702"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=4702"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=4702"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}