NAME

       ostree.repo-config - OSTree repository configuration

DESCRIPTION

       The config file in an OSTree repository is a "keyfile" in the XDG Desktop Entry Specification[1] format.
       It has several global flags, as well as zero or more remote entries which describe how to access remote
       repositories.

       See ostree.repo(5) for more information about OSTree repositories.

[CORE] SECTION OPTIONS

       Repository-global options. The following entries are defined:

       mode
           One of bare, bare-user or archive-z2 (note that archive is used everywhere else.)

       repo_version
           Currently, this must be set to 1.

       auto-update-summary
           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-update.

       commit-update-summary
           This option is deprecated. Use auto-update-summary instead, for which this option is now an alias.

       fsync
           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.

           If you disable fsync, OSTree will no longer be robust against kernel crashes or power loss.

           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-pull.

           For the system repository, you might choose to disable fsync if you have uninterruptable power
           supplies and a well tested kernel.

       min-free-space-percent
           Integer percentage value (0-99) 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 min-free-space-size are set.

           If min-free-space-size is set to a non-zero value, min-free-space-percent is ignored.

       min-free-space-size
           Value (in power-of-2 MB, GB or TB) that specifies a minimum space in the underlying filesystem to
           keep free. Examples of acceptable values: 500MB (524 288 000 bytes), 1GB (1 073 741 824 bytes), 1TB
           (1 099 511 627 776 bytes).

           If this option is set to a non-zero value, and min-free-space-percent is also set, this option takes
           priority.

       add-remotes-config-dir
           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's config file.

           This only applies to repositories that use a remotes configuration directory such as system ostree
           repositories, which use /etc/ostree/remotes.d. Non-system repositories do not use a remotes
           configuration directory unless one is specified when the repository is opened.

       payload-link-threshold
           An integer value that specifies a minimum file size for creating a payload link. By default it is
           disabled.

       collection-id
           A reverse DNS domain name under your control, which enables peer to peer distribution of refs in this
           repository. See the --collection-id section in ostree-init(1)

[REMOTE NAME"] SECTION OPTIONS"

       Describes a remote repository location.

       url
           Must be present; declares URL for accessing metadata and content for remote. See also contenturl. The
           supported schemes are documented below.

       contenturl
           Declares URL for accessing content (filez, static delta parts). When specified, url is used just for
           metadata: summary, static delta "superblocks".

       branches
           A list of strings. Represents the default configured branches to fetch from the remote when no
           specific branches are requested during a pull operation.

       proxy
           A string value, if given should be a URL for a HTTP proxy to use for access to this repository.

       gpg-verify
           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 ostree(1) manual under GPG.

       gpg-verify-summary
           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 ostree(1) manual under GPG.

       tls-permissive
           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.

       tls-client-cert-path
           Path to file for client-side certificate, to present when making requests to this repository.

       tls-client-key-path
           Path to file containing client-side certificate key, to present when making requests to this
           repository.

       tls-ca-path
           Path to file containing trusted anchors instead of the system CA database.

       http2
           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.

       unconfigured-state
           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.

/ETC/OSTREE/REMOTES.D

       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.

REPOSITORY URL/CONTENTURL

       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.

       Additionally, both of these can be prefixed with the string mirrorlist=, which instructs the client that
       the target url is a "mirrorlist" format, which is a plain text file of newline-separated URLs. Earlier
       URLs will be given precedence.

       Note that currently, the tls-ca-path and tls-client-cert-path 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.

PER-REMOTE GPG KEYRINGS AND VERIFICATION

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

PER-REMOTE HTTP COOKIES

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

SEE ALSO

       ostree(1), ostree.repo(5)

NOTES

        1. XDG Desktop Entry Specification
           http://standards.freedesktop.org/desktop-entry-spec/latest/

OSTree                                                                                      OSTREE.REPO-CONFI(5)