rpm-ostree/man/rpm-ostreed.conf.xml
Jonathan Lebon 51fb641305 Initial support for automatic updates
This patch introduces a new `AutomaticUpdatePolicy` configuration. This
was a long time coming for rpm-ostree, given that its update model makes
it extremely apt for such a feature.

The config supports a `check` mode, which should be very useful to
Atomic Workstation users, as well as a `reboot` mode, which could be
used in its present form in simple single node Atomic Host situations.

There is still a lot of work to be done, including integrating
advisories, and supporting a `deploy` mode. This feature hopefully will
be leveraged as well by higher-level projects like GNOME Software and
Cockpit.

Closes: #1147
Approved by: cgwalters
2018-01-27 23:52:43 +00:00

115 lines
3.4 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 (C) 2018 Red Hat, Inc.
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, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
-->
<refentry id="rpm-ostreed.conf">
<refentryinfo>
<title>rpm-ostreed.conf</title>
<productname>rpm-ostree</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Jonathan</firstname>
<surname>Lebon</surname>
<email>jlebon@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>rpm-ostreed.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>rpm-ostreed.conf</refname>
<refpurpose>RPM-OSTree daemon configuration file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>/etc/rpm-ostreed.conf</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This file configures the RPM-OSTree daemon.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
All options are configured in the "[Daemon]" section. Available options are:
</para>
<variablelist>
<varlistentry>
<term><varname>AutomaticUpdatePolicy=</varname></term>
<listitem>
<para>Controls the automatic update policy. Currently "none" or "check".
"none" disables automatic updates. "check" downloads just enough metadata to check
for updates and display them in <command>rpm-ostree status</command>. Defaults to
"none".</para>
<para>Automatic updates enablement and frequency are controlled by the
<command>rpm-ostreed-automatic.timer</command> unit. <!-- XXX: needs man page -->
See <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information on how to control systemd timers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IdleExitTimeout=</varname></term>
<listitem>
<para>Controls the time in seconds of inactivity before the daemon exits. Use 0 to
disable auto-exit. Defaults to 60.</para>
</listitem>
</varlistentry>
<!--
<varlistentry>
<term><varname>OptionName=</varname></term>
<listitem>
<para>Template for adding option names. Values are enumerated like "val1",
"val2".</para>
</listitem>
</varlistentry>
-->
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>rpm-ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>