204 lines
6.2 KiB
Groff
204 lines
6.2 KiB
Groff
'\" t
|
|
.\" Title: ostree.repo-config
|
|
.\" Author: Colin Walters <walters@verbum.org>
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 07/05/2017
|
|
.\" Manual: ostree.repo-config
|
|
.\" Source: OSTree
|
|
.\" Language: English
|
|
.\"
|
|
.TH "OSTREE\&.REPO\-CONFI" "5" "" "OSTree" "ostree.repo-config"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
ostree.repo-config \- OSTree repository configuration
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The
|
|
config
|
|
file in an OSTree repository is a "keyfile" in the
|
|
\m[blue]\fBXDG Desktop Entry Specification\fR\m[]\&\s-2\u[1]\d\s+2
|
|
format\&. It has several global flags, as well as zero or more remote entries which describe how to access remote repositories\&.
|
|
.PP
|
|
See
|
|
\fBostree.repo\fR(5)
|
|
for more information about OSTree repositories\&.
|
|
.SH "[CORE] SECTION OPTIONS"
|
|
.PP
|
|
Repository\-global options\&. The following entries are defined:
|
|
.PP
|
|
\fImode\fR
|
|
.RS 4
|
|
One of
|
|
bare,
|
|
bare\-user
|
|
or
|
|
archive\-z2\&.
|
|
.RE
|
|
.PP
|
|
\fIrepo_version\fR
|
|
.RS 4
|
|
Currently, this must be set to
|
|
1\&.
|
|
.RE
|
|
.PP
|
|
\fIcommit\-update\-summary\fR
|
|
.RS 4
|
|
Boolean value controlling whether or not to automatically update the summary file after a commit\&. Defaults to
|
|
false\&.
|
|
.RE
|
|
.PP
|
|
\fIfsync\fR
|
|
.RS 4
|
|
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\&.
|
|
.sp
|
|
If you disable fsync, OSTree will no longer be robust against kernel crashes or power loss\&.
|
|
.sp
|
|
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\&.
|
|
.sp
|
|
For the system repository, you might choose to disable fsync if you have uninterruptable power supplies and a well tested kernel\&.
|
|
.RE
|
|
.SH "[REMOTE "NAME"] SECTION OPTIONS"
|
|
.PP
|
|
Describes a remote repository location\&.
|
|
.PP
|
|
\fIurl\fR
|
|
.RS 4
|
|
Must be present; declares URL for accessing metadata and content for remote\&. See also
|
|
contenturl\&. The supported schemes are documented below\&.
|
|
.RE
|
|
.PP
|
|
\fIcontenturl\fR
|
|
.RS 4
|
|
Declares URL for accessing content (filez, static delta parts)\&. When specified,
|
|
url
|
|
is used just for metadata: summary, static delta "superblocks"\&.
|
|
.RE
|
|
.PP
|
|
\fIproxy\fR
|
|
.RS 4
|
|
A string value, if given should be a URL for a HTTP proxy to use for access to this repository\&.
|
|
.RE
|
|
.PP
|
|
\fIgpg\-verify\fR
|
|
.RS 4
|
|
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
|
|
\fBostree\fR(1)
|
|
manual under GPG\&.
|
|
.RE
|
|
.PP
|
|
\fIgpg\-verify\-summary\fR
|
|
.RS 4
|
|
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
|
|
\fBostree\fR(1)
|
|
manual under GPG\&.
|
|
.RE
|
|
.PP
|
|
\fItls\-permissive\fR
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.PP
|
|
\fItls\-client\-cert\-path\fR
|
|
.RS 4
|
|
Path to file for client\-side certificate, to present when making requests to this repository\&.
|
|
.RE
|
|
.PP
|
|
\fItls\-client\-key\-path\fR
|
|
.RS 4
|
|
Path to file containing client\-side certificate key, to present when making requests to this repository\&.
|
|
.RE
|
|
.PP
|
|
\fItls\-ca\-path\fR
|
|
.RS 4
|
|
Path to file containing trusted anchors instead of the system CA database\&.
|
|
.RE
|
|
.PP
|
|
\fIunconfigured\-state\fR
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.PP
|
|
\fImin\-free\-space\-percent\fR
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.SH "/ETC/OSTREE/REMOTES\&.D"
|
|
.PP
|
|
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\&.
|
|
.SH "REPOSITORY URL/CONTENTURL"
|
|
.PP
|
|
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\&.
|
|
.PP
|
|
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\&.
|
|
.PP
|
|
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\&.
|
|
.SH "PER\-REMOTE GPG KEYRINGS AND VERIFICATION"
|
|
.PP
|
|
OSTree supports a per\-remote GPG keyring, as well as a
|
|
gpgkeypath
|
|
option\&. For more information see
|
|
\fBostree\fR(1)\&. in the section
|
|
GPG verification\&.
|
|
.SH "PER\-REMOTE HTTP COOKIES"
|
|
.PP
|
|
Some content providers may want to control access to remote repositories via HTTP cookies\&. The
|
|
\fBostree remote add\-cookie\fR
|
|
and
|
|
\fBostree remote delete\-cookie\fR
|
|
commands will update a per\-remote lookaside cookie jar, named
|
|
$remotename\&.cookies\&.txt\&.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBostree\fR(1),
|
|
\fBostree.repo\fR(5)
|
|
.SH "NOTES"
|
|
.IP " 1." 4
|
|
XDG Desktop Entry Specification
|
|
.RS 4
|
|
\%http://standards.freedesktop.org/desktop-entry-spec/latest/
|
|
.RE
|