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