| 1 |
'\" t |
| 2 |
.TH "JOURNAL\-UPLOAD\&.CONF" "5" "" "systemd 261~rc3" "journal-upload.conf" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
journal-upload.conf, journal-upload.conf.d \- Configuration files for the journal upload service |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
/etc/systemd/journal\-upload\&.conf |
| 27 |
.PP |
| 28 |
/run/systemd/journal\-upload\&.conf |
| 29 |
.PP |
| 30 |
/usr/lib/systemd/journal\-upload\&.conf |
| 31 |
.PP |
| 32 |
/etc/systemd/journal\-upload\&.conf\&.d/*\&.conf |
| 33 |
.PP |
| 34 |
/run/systemd/journal\-upload\&.conf\&.d/*\&.conf |
| 35 |
.PP |
| 36 |
/usr/lib/systemd/journal\-upload\&.conf\&.d/*\&.conf |
| 37 |
.SH "DESCRIPTION" |
| 38 |
.PP |
| 39 |
These files configure various parameters of |
| 40 |
\fBsystemd-journal-upload.service\fR(8)\&. See |
| 41 |
\fBsystemd.syntax\fR(7) |
| 42 |
for a general description of the syntax\&. |
| 43 |
.SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" |
| 44 |
.PP |
| 45 |
The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: |
| 46 |
/etc/systemd/, |
| 47 |
/run/systemd/, |
| 48 |
/usr/local/lib/systemd/ |
| 49 |
\&\s-2\u[1]\d\s+2, |
| 50 |
/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in |
| 51 |
/etc/ |
| 52 |
if it is shipped under |
| 53 |
/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. |
| 54 |
.PP |
| 55 |
In addition to the main configuration file, drop\-in configuration snippets are read from |
| 56 |
/usr/lib/systemd/*\&.conf\&.d/, |
| 57 |
/usr/local/lib/systemd/*\&.conf\&.d/, and |
| 58 |
/etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the |
| 59 |
*\&.conf\&.d/ |
| 60 |
configuration subdirectories are sorted by their filename in lexicographic order, regardless of in which of the subdirectories they reside\&. When multiple files specify the same option, for options which accept just a single value, the entry in the file sorted last takes precedence, and for options which accept a list of values, entries are collected as they occur in the sorted files\&. |
| 61 |
.PP |
| 62 |
When packages need to customize the configuration, they can install drop\-ins under |
| 63 |
/usr/\&. Files in |
| 64 |
/etc/ |
| 65 |
are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in |
| 66 |
/usr/ |
| 67 |
and the range 60\-90 for drop\-ins in |
| 68 |
/etc/ |
| 69 |
and |
| 70 |
/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. |
| 71 |
.PP |
| 72 |
To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to |
| 73 |
/dev/null |
| 74 |
in the configuration directory in |
| 75 |
/etc/, with the same filename as the vendor configuration file\&. |
| 76 |
.SH "OPTIONS" |
| 77 |
.PP |
| 78 |
All options are configured in the [Upload] section: |
| 79 |
.PP |
| 80 |
\fIURL=\fR |
| 81 |
.RS 4 |
| 82 |
The URL to upload the journal entries to\&. See the description of |
| 83 |
\fB\-\-url=\fR |
| 84 |
option in |
| 85 |
\fBsystemd-journal-upload\fR(8) |
| 86 |
for the description of possible values\&. There is no default value, so either this option or the command\-line option must be always present to make an upload\&. |
| 87 |
.sp |
| 88 |
Added in version 232\&. |
| 89 |
.RE |
| 90 |
.PP |
| 91 |
\fIServerKeyFile=\fR |
| 92 |
.RS 4 |
| 93 |
SSL key in PEM format\&. |
| 94 |
.sp |
| 95 |
Added in version 232\&. |
| 96 |
.RE |
| 97 |
.PP |
| 98 |
\fIServerCertificateFile=\fR |
| 99 |
.RS 4 |
| 100 |
SSL CA certificate in PEM format\&. |
| 101 |
.sp |
| 102 |
Added in version 232\&. |
| 103 |
.RE |
| 104 |
.PP |
| 105 |
\fITrustedCertificateFile=\fR |
| 106 |
.RS 4 |
| 107 |
SSL CA certificate\&. |
| 108 |
.sp |
| 109 |
Added in version 232\&. |
| 110 |
.RE |
| 111 |
.PP |
| 112 |
\fINetworkTimeoutSec=\fR |
| 113 |
.RS 4 |
| 114 |
When network connectivity to the server is lost, this option configures the time to wait for the connectivity to get restored\&. If the server is not reachable over the network for the configured time, |
| 115 |
\fBsystemd\-journal\-upload\fR |
| 116 |
exits\&. Takes a value in seconds (or in other time units if suffixed with "ms", "min", "h", etc)\&. For details, see |
| 117 |
\fBsystemd.time\fR(7)\&. |
| 118 |
.sp |
| 119 |
Added in version 249\&. |
| 120 |
.RE |
| 121 |
.PP |
| 122 |
\fICompression=\fR |
| 123 |
.RS 4 |
| 124 |
Configures compression algorithm to be applied to logs data before sending\&. Takes a space separated list of compression algorithms, or |
| 125 |
"no"\&. Supported algorithms are |
| 126 |
"zstd", |
| 127 |
"xz", or |
| 128 |
"lz4"\&. Optionally, each algorithm followed by a colon (":") and its compression level, for example |
| 129 |
"zstd:4"\&. The compression level is expected to be a positive integer\&. When |
| 130 |
"no" |
| 131 |
is specified, no compression algorithm will be applied to data to be sent\&. This option can be specified multiple times\&. If an empty string is assigned, then all previous assignments are cleared\&. Defaults to unset, and all supported compression algorithms with their default compression levels are listed\&. |
| 132 |
.sp |
| 133 |
Example: |
| 134 |
.sp |
| 135 |
.if n \{\ |
| 136 |
.RS 4 |
| 137 |
.\} |
| 138 |
.nf |
| 139 |
Compression=zstd:4 lz4:2 |
| 140 |
.fi |
| 141 |
.if n \{\ |
| 142 |
.RE |
| 143 |
.\} |
| 144 |
.sp |
| 145 |
Even when compression is enabled, the initial requests are sent without compression\&. It becomes effective either if |
| 146 |
"ForceCompression=" |
| 147 |
is enabled, or the server response contains |
| 148 |
"Accept\-Encoding" |
| 149 |
headers with a list of compression algorithms that contains one of the algorithms specified in this option\&. |
| 150 |
.sp |
| 151 |
Added in version 258\&. |
| 152 |
.RE |
| 153 |
.PP |
| 154 |
\fIForceCompression=\fR |
| 155 |
.RS 4 |
| 156 |
Takes a boolean value, enforces using compression without content encoding negotiation\&. Defaults to |
| 157 |
"false"\&. |
| 158 |
.sp |
| 159 |
Added in version 258\&. |
| 160 |
.RE |
| 161 |
.PP |
| 162 |
\fIHeader=\fR |
| 163 |
.RS 4 |
| 164 |
Specifies an additional HTTP header to be added to each request to a URL\&. Takes a pair of header name and value separated with a colon(":"), e\&.g\&. |
| 165 |
"Name:Value"\&. Header name can contain alphanumeric values, |
| 166 |
"_" |
| 167 |
and |
| 168 |
"\-" |
| 169 |
symbols additionally\&. This option may be specified more than once, in which case all listed headers will be set\&. If the same header name is listed more than once, all its unique values will be concatenated with comma\&. Setting |
| 170 |
\fIHeader=\fR |
| 171 |
to empty string clears all previous assignments\&. |
| 172 |
.sp |
| 173 |
Example: |
| 174 |
.sp |
| 175 |
.if n \{\ |
| 176 |
.RS 4 |
| 177 |
.\} |
| 178 |
.nf |
| 179 |
Header=HeaderName: HeaderValue |
| 180 |
Header=HeaderName: NewValue |
| 181 |
Header=HeaderName: HeaderValue |
| 182 |
.fi |
| 183 |
.if n \{\ |
| 184 |
.RE |
| 185 |
.\} |
| 186 |
.sp |
| 187 |
adds |
| 188 |
"HeaderName" |
| 189 |
header with |
| 190 |
"HeaderValue, NewValue" |
| 191 |
to each HTTP request\&. |
| 192 |
.sp |
| 193 |
Added in version 258\&. |
| 194 |
.RE |
| 195 |
.SH "SEE ALSO" |
| 196 |
.PP |
| 197 |
\fBsystemd-journal-upload.service\fR(8), \fBsystemd\fR(1), \fBsystemd-journald.service\fR(8) |
| 198 |
.SH "NOTES" |
| 199 |
.IP " 1." 4 |
| 200 |
💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If |
| 201 |
/usr/local/ |
| 202 |
is a separate partition, it may not be available during early boot, and must not be used for configuration. |
| 203 |
|