mirror of
https://github.com/ostreedev/ostree.git
synced 2024-10-26 08:55:19 +03:00
100 lines
3.5 KiB
XML
100 lines
3.5 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
<!--
|
|
Copyright 2014 Colin Walters <walters@verbum.org>
|
|
|
|
SPDX-License-Identifier: LGPL-2.0+
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library. If not, see <https://www.gnu.org/licenses/>.
|
|
-->
|
|
|
|
<refentry id="ostree.repo">
|
|
|
|
<refentryinfo>
|
|
<title>ostree.repo</title>
|
|
<productname>OSTree</productname>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Colin</firstname>
|
|
<surname>Walters</surname>
|
|
<email>walters@verbum.org</email>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>ostree.repo</refentrytitle>
|
|
<manvolnum>5</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>ostree.repo</refname>
|
|
<refpurpose>OSTree repository configuration and layout</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
An OSTree repository is structurally similar to a
|
|
git repository; it is a content-addressed object
|
|
store containing filesystem trees. However, unlike
|
|
git, ostree is designed to store operating system
|
|
binaries. It records the Unix uid and gid,
|
|
permissions, as well as extended attributes.
|
|
</para>
|
|
|
|
<para>
|
|
A repository can be in one of three modes;
|
|
<literal>bare</literal>, which is designed as a hard
|
|
link source for operating system checkouts,
|
|
<literal>bare-user</literal>, which is like
|
|
<literal>bare</literal> but works on systems that
|
|
run as non-root as well as non-root containers, and
|
|
<literal>archive-z2</literal>, which is designed for
|
|
static HTTP servers.
|
|
</para>
|
|
|
|
<para>
|
|
There is a system repository located at
|
|
<filename>/ostree/repo</filename>. If no repository
|
|
is specified -- either by a command-line option or the
|
|
<envar>OSTREE_REPO</envar> environment variable --
|
|
the <command>ostree</command> as well as many API
|
|
calls will use it by default.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Components of a repository</title>
|
|
|
|
<para>
|
|
The only user-editable component is the
|
|
<filename>config</filename> file. For more
|
|
information, see <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|