2018-01-12 01:04:08 +03:00
<?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 2018 Matthew Leeds <matthew.leeds @ e n d l e s s m . c o m >
2018-01-30 22:26:26 +03:00
SPDX-License-Identifier: LGPL-2.0+
2018-01-12 01:04:08 +03:00
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
2021-12-07 04:20:55 +03:00
License along with this library. If not, see <https: / / w w w . g n u . o r g / l i c e n s e s /> .
2018-01-12 01:04:08 +03:00
-->
<refentry id= "ostree" >
<refentryinfo >
<title > ostree find-remotes</title>
<productname > OSTree</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Matthew</firstname>
<surname > Leeds</surname>
<email > matthew.leeds@endlessm.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > ostree find-remotes</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > ostree-find-remotes</refname>
<refpurpose > Find remotes to serve the given refs</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
<command > ostree find-remotes</command> <arg choice= "opt" rep= "repeat" > OPTIONS</arg> <arg choice= "req" > COLLECTION-ID</arg> <arg choice= "req" > REF</arg> <arg choice= "opt" rep= "repeat" > COLLECTION-ID REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para >
2022-02-12 21:00:28 +03:00
OSTree has the ability to pull not just from the configured remote
2018-01-12 01:04:08 +03:00
servers but also from peer computers on the LAN and from mounted
Make P2P API public (no longer experimental)
Currently the API that allows P2P operations (e.g. pulling an ostree ref
from a LAN or USB source) is hidden behind the configure flag
--enable-experimental-api. This commit makes the API public and makes
that flag essentially a no-op (leaving it in place in case we want to
use it again in the future). The P2P API has been tested over the last
several months and proven to work.
This means that since we're no longer using the "experimental" feature
flag, P2P builds of Flatpak will fail when using versions of OSTree from
this commit onwards, until Flatpak is patched in the near future. If you
want to build Flatpak < 0.11.8 with P2P enabled and link against OSTree
2018.6, you'll have to patch Flatpak. However, since Flatpak won't yet
have a hard dependency on OSTree 2018.6, it needs a new way to determine
if the P2P API in OSTree is available, so this commit adds a "p2p"
feature flag. This way the feature set is more semantically correct than
if we had continued to use the "experimental" feature flag.
In addition to making the P2P API public, this commit makes the P2P unit
tests run by default, removes the f27-experimental CI instance that's no
longer needed, changes a few man pages to reflect the changes, and
updates the bash completion script to accept the new commands and
options.
Closes: #1596
Approved by: cgwalters
2018-05-23 01:55:14 +03:00
filesystems such as USB drives. This functionality requires the use
of collection IDs and GPG verification.
2018-01-12 01:04:08 +03:00
</para>
<para >
The <command > find-remotes</command> command searches for remotes
which claim to provide one or more of the given COLLECTION-ID REF
pairs and prints information about them, with remotes sorted by
latency (Mounts > LAN > Internet). By default, OSTree searches for
remotes in configuration files, on mounted filesystems (in a
well-known location), and on the LAN using Avahi. Searching for LAN
remotes requires OSTree to have been compiled with Avahi support,
and it requires an Avahi daemon to be running. You can override the
default set of finders (sources for remotes) using the
<option > --finders</option> option documented below.
</para>
2018-04-18 00:35:52 +03:00
<para >
The <command > create-usb</command> command is the recommended way to
put refs on a USB such that <command > find-remotes</command> will
discover them. See
<citerefentry > <refentrytitle > ostree-create-usb</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> .
</para>
2018-01-12 01:04:08 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
<variablelist >
2023-01-29 19:28:31 +03:00
<varlistentry >
<term > <option > --cache-dir</option> =DIR</term>
<listitem > <para >
Use an alternate cache directory in <literal > DIR</literal> .
</para> </listitem>
</varlistentry>
2018-01-12 01:04:08 +03:00
<varlistentry >
<term > <option > --disable-fsync</option> </term>
<listitem > <para >
Do not invoke fsync().
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > --finders</option> =FINDERS</term>
<listitem > <para >
Use the specified comma separated list of finders rather than
the default set. Possible values: <literal > config</literal> ,
<literal > lan</literal> , and <literal > mount</literal> (or any
combination thereof).
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --pull</option> </term>
<listitem > <para >
Pull the most recent commit found for each ref.
</para> </listitem>
</varlistentry>
2019-11-14 05:29:45 +03:00
<varlistentry >
<term > <option > --mirror</option> </term>
<listitem > <para >
Do a mirror pull (see the documentation for
<command > ostree pull --mirror</command> ). This option can
only be used in combination with <option > --pull</option> .
</para> </listitem>
</varlistentry>
2018-01-12 01:04:08 +03:00
</variablelist>
</refsect1>
<refsect1 >
<title > Example</title>
<para > <command > $ ostree find-remotes --finders=mount,lan com.exampleos.Os exampleos/x86_64/standard</command> </para>
<programlisting >
Result 0: http://10.0.64.202:43381/0
- Finder: OstreeRepoFinderAvahi
- Keyring: exampleos.trustedkeys.gpg
- Priority: 60
- Summary last modified: 2018-01-12T19:00:28Z
- Refs:
- (com.exampleos.Os, exampleos/x86_64/standard) = c91acd964b3fda561b87bfb7f7c80e36220d76b567f0ce90c0e60742ef33c360
1/1 refs were found.
</programlisting>
</refsect1>
</refentry>