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/local/lib/systemd/journal-remote.conf</filename></member>
  34       <member><filename>/usr/lib/systemd/journal-remote.conf</filename></member>
  35       <member><filename>/etc/systemd/journal-remote.conf.d/*.conf</filename></member>
  36       <member><filename>/run/systemd/journal-remote.conf.d/*.conf</filename></member>
  37       <member><filename>/usr/local/lib/systemd/journal-remote.conf.d/*.conf</filename></member>
  38       <member><filename>/usr/lib/systemd/journal-remote.conf.d/*.conf</filename></member>
  39     </simplelist></para>
  40   </refsynopsisdiv>
  41
  42   <refsect1>
  43     <title>Description</title>
  44
  45     <para>These files configure various parameters of
  46     <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  47     See
  48     <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  49     for a general description of the syntax.</para>
  50   </refsect1>
  51
  52   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  53
  54   <refsect1>
  55     <title>Options</title>
  56
  57     <para>All options are configured in the
  58     [Remote] section:</para>
  59
  60     <variablelist class='config-directives'>
  61       <varlistentry>
  62         <term><varname>Seal=</varname></term>
  63
  64         <listitem><para>Periodically sign the data in the journal using Forward Secure Sealing.
  65         </para>
  66
  67         <xi:include href="version-info.xml" xpointer="v229"/></listitem>
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><varname>SplitMode=</varname></term>
  72
  73         <listitem><para>One of <literal>host</literal> or <literal>none</literal>.
  74         </para>
  75
  76         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><varname>ServerKeyFile=</varname></term>
  81
  82         <listitem><para>SSL key in PEM format.</para>
  83
  84         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term><varname>ServerCertificateFile=</varname></term>
  89
  90         <listitem><para>SSL certificate in PEM format.</para>
  91
  92         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><varname>TrustedCertificateFile=</varname></term>
  97
  98         <listitem><para>SSL CA certificate.</para>
  99
 100         <xi:include href="version-info.xml" xpointer="v220"/></listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term><varname>MaxUse=</varname></term>
 105         <term><varname>KeepFree=</varname></term>
 106         <term><varname>MaxFileSize=</varname></term>
 107         <term><varname>MaxFiles=</varname></term>
 108
 109         <listitem><para>These are analogous to <varname>SystemMaxUse=</varname>,
 110         <varname>SystemKeepFree=</varname>, <varname>SystemMaxFileSize=</varname>
 111         and <varname>SystemMaxFiles=</varname> in
 112         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 113
 114         <para><varname>MaxUse=</varname> controls how much disk space
 115         the <command>systemd-journal-remote</command> may use up at most.
 116         <varname>KeepFree=</varname> controls how much disk
 117         space <command>systemd-journal-remote</command> shall leave free for other uses.
 118         <command>systemd-journal-remote</command> will respect both limits
 119         and use the smaller of the two values.</para>
 120
 121         <para><varname>MaxFiles=</varname> controls how many
 122         individual journal files to keep at most. Note that only
 123         archived files are deleted to reduce the number of files until
 124         this limit is reached; active files will stay around. This
 125         means that, in effect, there might still be more journal files
 126         around in total than this limit after a vacuuming operation is
 127         complete.</para>
 128
 129         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 130       </varlistentry>
 131
 132     </variablelist>
 133
 134   </refsect1>
 135
 136   <refsect1>
 137       <title>See Also</title>
 138       <para><simplelist type="inline">
 139         <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 140         <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 141         <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 142         <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 143       </simplelist></para>
 144   </refsect1>
 145
 146 </refentry>