man/journal-upload.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 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="journal-upload.conf" conditional='HAVE_MICROHTTPD'
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>journal-upload.conf</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>journal-upload.conf</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>journal-upload.conf</refname>
  20     <refname>journal-upload.conf.d</refname>
  21     <refpurpose>Configuration files for the journal upload service</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>/etc/systemd/journal-upload.conf</filename></para>
  26     <para><filename>/run/systemd/journal-upload.conf</filename></para>
  27     <para><filename>/usr/lib/systemd/journal-upload.conf</filename></para>
  28     <para><filename>/etc/systemd/journal-upload.conf.d/*.conf</filename></para>
  29     <para><filename>/run/systemd/journal-upload.conf.d/*.conf</filename></para>
  30     <para><filename>/usr/lib/systemd/journal-upload.conf.d/*.conf</filename></para>
  31   </refsynopsisdiv>
  32
  33   <refsect1>
  34     <title>Description</title>
  35
  36     <para>These files configure various parameters of
  37     <citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  38     See
  39     <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  40     for a general description of the syntax.</para>
  41   </refsect1>
  42
  43   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  44
  45   <refsect1>
  46     <title>Options</title>
  47
  48     <para>All options are configured in the [Upload] section:</para>
  49
  50     <variablelist class='config-directives'>
  51       <varlistentry>
  52         <term><varname>URL=</varname></term>
  53
  54         <listitem><para>The URL to upload the journal entries to. See the description
  55         of <option>--url=</option> option in
  56         <citerefentry><refentrytitle>systemd-journal-upload</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  57         for the description of possible values. There is no default value, so either this
  58         option or the command-line option must be always present to make an upload.</para>
  59
  60         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><varname>ServerKeyFile=</varname></term>
  65
  66         <listitem><para>SSL key in PEM format.</para>
  67
  68         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
  69       </varlistentry>
  70
  71       <varlistentry>
  72         <term><varname>ServerCertificateFile=</varname></term>
  73
  74         <listitem><para>SSL CA certificate in PEM format.</para>
  75
  76         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><varname>TrustedCertificateFile=</varname></term>
  81
  82         <listitem><para>SSL CA certificate.</para>
  83
  84         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term><varname>NetworkTimeoutSec=</varname></term>
  89
  90         <listitem><para>When network connectivity to the server is lost, this option
  91         configures the time to wait for the connectivity to get restored. If the server is
  92         not reachable over the network for the configured time, <command>systemd-journal-upload</command>
  93         exits. Takes a value in seconds (or in other time units if suffixed with "ms", "min", "h", etc).
  94         For details, see <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  95         </para>
  96
  97         <xi:include href="version-info.xml" xpointer="v249"/></listitem>
  98       </varlistentry>
  99
 100     </variablelist>
 101
 102   </refsect1>
 103
 104   <refsect1>
 105       <title>See Also</title>
 106       <para><simplelist type="inline">
 107         <member><citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 108         <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 109         <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 110       </simplelist></para>
 111   </refsect1>
 112
 113 </refentry>