Debian Codegraph @

upstream/debian-unstable/man5/journal-remote.conf.5

raw
1 '\" t
2 .TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 261~rc3" "journal-remote.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-remote.conf, journal-remote.conf.d \- Configuration files for the service accepting remote journal uploads
24 .SH "SYNOPSIS"
25 .PP
26 .RS 4
27 /etc/systemd/journal\-remote\&.conf
28 .RE
29 .RS 4
30 /run/systemd/journal\-remote\&.conf
31 .RE
32 .RS 4
33 /usr/local/lib/systemd/journal\-remote\&.conf
34 .RE
35 .RS 4
36 /usr/lib/systemd/journal\-remote\&.conf
37 .RE
38 .RS 4
39 /etc/systemd/journal\-remote\&.conf\&.d/*\&.conf
40 .RE
41 .RS 4
42 /run/systemd/journal\-remote\&.conf\&.d/*\&.conf
43 .RE
44 .RS 4
45 /usr/local/lib/systemd/journal\-remote\&.conf\&.d/*\&.conf
46 .RE
47 .RS 4
48 /usr/lib/systemd/journal\-remote\&.conf\&.d/*\&.conf
49 .RE
50 .SH "DESCRIPTION"
51 .PP
52 These files configure various parameters of
53 \fBsystemd-journal-remote.service\fR(8)\&. See
54 \fBsystemd.syntax\fR(7)
55 for a general description of the syntax\&.
56 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
57 .PP
58 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:
59 /etc/systemd/,
60 /run/systemd/,
61 /usr/local/lib/systemd/
62 \&\s-2\u[1]\d\s+2,
63 /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
64 /etc/
65 if it is shipped under
66 /usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
67 .PP
68 In addition to the main configuration file, drop\-in configuration snippets are read from
69 /usr/lib/systemd/*\&.conf\&.d/,
70 /usr/local/lib/systemd/*\&.conf\&.d/, and
71 /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
72 *\&.conf\&.d/
73 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\&.
74 .PP
75 When packages need to customize the configuration, they can install drop\-ins under
76 /usr/\&. Files in
77 /etc/
78 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
79 /usr/
80 and the range 60\-90 for drop\-ins in
81 /etc/
82 and
83 /run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&.
84 .PP
85 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
86 /dev/null
87 in the configuration directory in
88 /etc/, with the same filename as the vendor configuration file\&.
89 .SH "OPTIONS"
90 .PP
91 All options are configured in the [Remote] section:
92 .PP
93 \fISeal=\fR
94 .RS 4
95 Periodically sign the data in the journal using Forward Secure Sealing\&.
96 .sp
97 Added in version 229\&.
98 .RE
99 .PP
100 \fISplitMode=\fR
101 .RS 4
102 One of
103 "host"
104 or
105 "none"\&.
106 .sp
107 Added in version 220\&.
108 .RE
109 .PP
110 \fIServerKeyFile=\fR
111 .RS 4
112 SSL key in PEM format\&.
113 .sp
114 Added in version 220\&.
115 .RE
116 .PP
117 \fIServerCertificateFile=\fR
118 .RS 4
119 SSL certificate in PEM format\&.
120 .sp
121 Added in version 220\&.
122 .RE
123 .PP
124 \fITrustedCertificateFile=\fR
125 .RS 4
126 SSL CA certificate\&.
127 .sp
128 Added in version 220\&.
129 .RE
130 .PP
131 \fIMaxUse=\fR, \fIKeepFree=\fR, \fIMaxFileSize=\fR, \fIMaxFiles=\fR
132 .RS 4
133 These are analogous to
134 \fISystemMaxUse=\fR,
135 \fISystemKeepFree=\fR,
136 \fISystemMaxFileSize=\fR
137 and
138 \fISystemMaxFiles=\fR
139 in
140 \fBjournald.conf\fR(5)\&.
141 .sp
142 \fIMaxUse=\fR
143 controls how much disk space the
144 \fBsystemd\-journal\-remote\fR
145 may use up at most\&.
146 \fIKeepFree=\fR
147 controls how much disk space
148 \fBsystemd\-journal\-remote\fR
149 shall leave free for other uses\&.
150 \fBsystemd\-journal\-remote\fR
151 will respect both limits and use the smaller of the two values\&.
152 .sp
153 \fIMaxFiles=\fR
154 controls how many individual journal files to keep at most\&. Note that only archived files are deleted to reduce the number of files until this limit is reached; active files will stay around\&. This means that, in effect, there might still be more journal files around in total than this limit after a vacuuming operation is complete\&.
155 .sp
156 Added in version 253\&.
157 .RE
158 .PP
159 \fICompression=\fR
160 .RS 4
161 Configurs acceptable compression algorithms to be announced through
162 "Accept\-Encoding"
163 HTTP header\&. The header suggests
164 \fBsystemd\-journal\-upload\fR
165 to compress data to be sent\&. Takes a space separated list of compression algorithms, or
166 "no"\&. Supported algorithms are
167 "zstd",
168 "xz", or
169 "lz4"\&. When a list of algorithms is specified,
170 "Accept\-Encoding"
171 header will be constructed with priorities based on the order of the algorithms in the list\&. When
172 "no",
173 "Accept\-Encoding"
174 header will not be sent\&. This option can be specified multiple times\&. If an empty string is assigned, then all the previous assignments are cleared\&. Defaults to unset and all supported compression algorithms will be listed in the header\&.
175 .sp
176 Example:
177 .sp
178 .if n \{\
179 .RS 4
180 .\}
181 .nf
182 Compression=zstd lz4
183 .fi
184 .if n \{\
185 .RE
186 .\}
187 .sp
188 Added in version 258\&.
189 .RE
190 .SH "SEE ALSO"
191 .PP
192 \fBjournald.conf\fR(5), \fBsystemd\fR(1), \fBsystemd-journal-remote.service\fR(8), \fBsystemd-journald.service\fR(8)
193 .SH "NOTES"
194 .IP " 1." 4
195 💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If
196 /usr/local/
197 is a separate partition, it may not be available during early boot, and must not be used for configuration.
198