man/journal-remote.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1-or-later
   7
   8   Copyright © 2015 Chris Morgan
   9 -->
  10
  11 <refentry id="journal-remote.conf" conditional='HAVE_MICROHTTPD'
  12           xmlns:xi="http://www.w3.org/2001/XInclude">
  13   <refentryinfo>
  14     <title>journal-remote.conf</title>
  15     <productname>systemd</productname>
  16   </refentryinfo>
  17
  18   <refmeta>
  19     <refentrytitle>journal-remote.conf</refentrytitle>
  20     <manvolnum>5</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>journal-remote.conf</refname>
  25     <refname>journal-remote.conf.d</refname>
  26     <refpurpose>Configuration files for the service accepting remote journal uploads</refpurpose>
  27   </refnamediv>
  28
  29   <refsynopsisdiv>
  30     <para><simplelist>
  31       <member><filename>/etc/systemd/journal-remote.conf</filename></member>
  32       <member><filename>/run/systemd/journal-remote.conf</filename></member>
  33       <member><filename>/usr/lib/systemd/journal-remote.conf</filename></member>
  34       <member><filename>/etc/systemd/journal-remote.conf.d/*.conf</filename></member>
  35       <member><filename>/run/systemd/journal-remote.conf.d/*.conf</filename></member>
  36       <member><filename>/usr/lib/systemd/journal-remote.conf.d/*.conf</filename></member>
  37     </simplelist></para>
  38   </refsynopsisdiv>
  39
  40   <refsect1>
  41     <title>Description</title>
  42
  43     <para>These files configure various parameters of
  44     <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  45     See
  46     <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  47     for a general description of the syntax.</para>
  48   </refsect1>
  49
  50   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  51
  52   <refsect1>
  53     <title>Options</title>
  54
  55     <para>All options are configured in the
  56     [Remote] section:</para>
  57
  58     <variablelist class='config-directives'>
  59       <varlistentry>
  60         <term><varname>Seal=</varname></term>
  61
  62         <listitem><para>Periodically sign the data in the journal using Forward Secure Sealing.
  63         </para>
  64
  65         <xi:include href="version-info.xml" xpointer="v229"/></listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term><varname>SplitMode=</varname></term>
  70
  71         <listitem><para>One of <literal>host</literal> or <literal>none</literal>.
  72         </para>
  73
  74         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><varname>ServerKeyFile=</varname></term>
  79
  80         <listitem><para>SSL key in PEM format.</para>
  81
  82         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term><varname>ServerCertificateFile=</varname></term>
  87
  88         <listitem><para>SSL certificate in PEM format.</para>
  89
  90         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term><varname>TrustedCertificateFile=</varname></term>
  95
  96         <listitem><para>SSL CA certificate.</para>
  97
  98         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  99       </varlistentry>
 100
 101       <varlistentry>
 102         <term><varname>MaxUse=</varname></term>
 103         <term><varname>KeepFree=</varname></term>
 104         <term><varname>MaxFileSize=</varname></term>
 105         <term><varname>MaxFiles=</varname></term>
 106
 107         <listitem><para>These are analogous to <varname>SystemMaxUse=</varname>,
 108         <varname>SystemKeepFree=</varname>, <varname>SystemMaxFileSize=</varname>
 109         and <varname>SystemMaxFiles=</varname> in
 110         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 111
 112         <para><varname>MaxUse=</varname> controls how much disk space
 113         the <command>systemd-journal-remote</command> may use up at most.
 114         <varname>KeepFree=</varname> controls how much disk
 115         space <command>systemd-journal-remote</command> shall leave free for other uses.
 116         <command>systemd-journal-remote</command> will respect both limits
 117         and use the smaller of the two values.</para>
 118
 119         <para><varname>MaxFiles=</varname> controls how many
 120         individual journal files to keep at most. Note that only
 121         archived files are deleted to reduce the number of files until
 122         this limit is reached; active files will stay around. This
 123         means that, in effect, there might still be more journal files
 124         around in total than this limit after a vacuuming operation is
 125         complete.</para>
 126
 127         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 128       </varlistentry>
 129
 130     </variablelist>
 131
 132   </refsect1>
 133
 134   <refsect1>
 135       <title>See Also</title>
 136       <para><simplelist type="inline">
 137         <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 138         <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 139         <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 140         <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 141       </simplelist></para>
 142   </refsect1>
 143
 144 </refentry>