Debian Codegraph @

upstream/debian-unstable/man8/systemd-journal-upload.service.8

raw
1 '\" t
2 .TH "SYSTEMD\-JOURNAL\-UPLOAD\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-journal-upload.service"
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 systemd-journal-upload.service, systemd-journal-upload \- Send journal messages over the network
24 .SH "SYNOPSIS"
25 .PP
26 systemd\-journal\-upload\&.service
27 .HP \w'\fB/usr/lib/systemd/systemd\-journal\-upload\fR\ 'u
28 \fB/usr/lib/systemd/systemd\-journal\-upload\fR [OPTIONS...] [\-u/\-\-url=\fIURL\fR] [SOURCES...]
29 .SH "DESCRIPTION"
30 .PP
31 \fBsystemd\-journal\-upload\fR
32 will upload journal entries to the URL specified with
33 \fB\-\-url=\fR\&. This program reads journal entries from one or more journal files, similarly to
34 \fBjournalctl\fR(1)\&. Unless limited by one of the options specified below, all journal entries accessible to the user the program is running as will be uploaded, and then the program will wait and send new entries as they become available\&.
35 .PP
36 \fBsystemd\-journal\-upload\fR
37 transfers the raw content of journal file and uses HTTP as a transport protocol\&.
38 .PP
39 systemd\-journal\-upload\&.service
40 is a system service that uses
41 \fBsystemd\-journal\-upload\fR
42 to upload journal entries to a server\&. It uses the configuration in
43 \fBjournal-upload.conf\fR(5)\&. At least the
44 \fIURL=\fR
45 option must be specified\&.
46 .SH "OPTIONS"
47 .PP
48 \fB\-u\fR, \fB\-\-url=\fR\fB[https://]\fR\fB\fIURL\fR\fR\fB[:\fR\fB\fIPORT\fR\fR\fB]\fR, \fB\-\-url=\fR\fB[http://]\fR\fB\fIURL\fR\fR\fB[:\fR\fB\fIPORT\fR\fR\fB]\fR
49 .RS 4
50 Upload to the specified address\&.
51 \fIURL\fR
52 may specify either just the hostname or both the protocol and hostname\&.
53 \fBhttps\fR
54 is the default\&. The port number may be specified after a colon (":"), otherwise
55 \fB19532\fR
56 will be used by default\&.
57 .sp
58 Added in version 239\&.
59 .RE
60 .PP
61 \fB\-\-system\fR, \fB\-\-user\fR
62 .RS 4
63 Limit uploaded entries to entries from system services and the kernel, or to entries from services of current user\&. This has the same meaning as
64 \fB\-\-system\fR
65 and
66 \fB\-\-user\fR
67 options for
68 \fBjournalctl\fR(1)\&. If neither is specified, all accessible entries are uploaded\&.
69 .sp
70 Added in version 239\&.
71 .RE
72 .PP
73 \fB\-m\fR, \fB\-\-merge\fR
74 .RS 4
75 Upload entries interleaved from all available journals, including other machines\&. This has the same meaning as
76 \fB\-\-merge\fR
77 option for
78 \fBjournalctl\fR(1)\&.
79 .sp
80 Added in version 239\&.
81 .RE
82 .PP
83 \fB\-\-namespace=\fR\fB\fINAMESPACE\fR\fR
84 .RS 4
85 Takes a journal namespace identifier string as argument\&. Upload entries from the specified journal namespace
86 \fINAMESPACE\fR
87 instead of the default namespace\&. This has the same meaning as
88 \fB\-\-namespace=\fR
89 option for
90 \fBjournalctl\fR(1)\&.
91 .sp
92 Added in version 254\&.
93 .RE
94 .PP
95 \fB\-D\fR, \fB\-\-directory=\fR\fB\fIDIR\fR\fR
96 .RS 4
97 Takes a directory path as argument\&. Upload entries from the specified journal directory
98 \fIDIR\fR
99 instead of the default runtime and system journal paths\&. This has the same meaning as
100 \fB\-\-directory=\fR
101 option for
102 \fBjournalctl\fR(1)\&.
103 .sp
104 Added in version 239\&.
105 .RE
106 .PP
107 \fB\-\-file=\fR\fB\fIGLOB\fR\fR
108 .RS 4
109 Takes a file glob as an argument\&. Upload entries from the specified journal files matching
110 \fIGLOB\fR
111 instead of the default runtime and system journal paths\&. May be specified multiple times, in which case files will be suitably interleaved\&. This has the same meaning as
112 \fB\-\-file=\fR
113 option for
114 \fBjournalctl\fR(1)\&.
115 .sp
116 Added in version 239\&.
117 .RE
118 .PP
119 \fB\-\-cursor=\fR
120 .RS 4
121 Upload entries from the location in the journal specified by the passed cursor\&. This has the same meaning as
122 \fB\-\-cursor=\fR
123 option for
124 \fBjournalctl\fR(1)\&.
125 .sp
126 Added in version 239\&.
127 .RE
128 .PP
129 \fB\-\-after\-cursor=\fR
130 .RS 4
131 Upload entries from the location in the journal
132 \fIafter\fR
133 the location specified by the this cursor\&. This has the same meaning as
134 \fB\-\-after\-cursor=\fR
135 option for
136 \fBjournalctl\fR(1)\&.
137 .sp
138 Added in version 239\&.
139 .RE
140 .PP
141 \fB\-\-save\-state\fR[=\fIPATH\fR]
142 .RS 4
143 Upload entries from the location in the journal
144 \fIafter\fR
145 the location specified by the cursor saved in file at
146 \fIPATH\fR
147 (/var/lib/systemd/journal\-upload/state
148 by default)\&. After an entry is successfully uploaded, update this file with the cursor of that entry\&.
149 .sp
150 Added in version 239\&.
151 .RE
152 .PP
153 \fB\-\-follow\fR[=\fIBOOL\fR]
154 .RS 4
155 If set to yes, then
156 \fBsystemd\-journal\-upload\fR
157 waits for input\&.
158 .sp
159 Added in version 239\&.
160 .RE
161 .PP
162 \fB\-\-key=\fR
163 .RS 4
164 Takes a path to a SSL key file in PEM format, or
165 \fB\-\fR\&. If
166 \fB\-\fR
167 is set, then client certificate authentication checking will be disabled\&. Defaults to
168 /etc/ssl/private/journal\-upload\&.pem\&.
169 .sp
170 Added in version 239\&.
171 .RE
172 .PP
173 \fB\-\-cert=\fR
174 .RS 4
175 Takes a path to a SSL certificate file in PEM format, or
176 \fB\-\fR\&. If
177 \fB\-\fR
178 is set, then client certificate authentication checking will be disabled\&. Defaults to
179 /etc/ssl/certs/journal\-upload\&.pem\&.
180 .sp
181 Added in version 239\&.
182 .RE
183 .PP
184 \fB\-\-trust=\fR
185 .RS 4
186 Takes a path to a SSL CA certificate file in PEM format, or
187 \fB\-\fR/\fBall\fR\&. If
188 \fB\-\fR/\fBall\fR
189 is set, then certificate checking will be disabled\&. Defaults to
190 /etc/ssl/ca/trusted\&.pem\&.
191 .sp
192 Added in version 239\&.
193 .RE
194 .PP
195 \fB\-h\fR, \fB\-\-help\fR
196 .RS 4
197 Print a short help text and exit\&.
198 .RE
199 .PP
200 \fB\-\-version\fR
201 .RS 4
202 Print a short version string and exit\&.
203 .RE
204 .SH "EXIT STATUS"
205 .PP
206 On success, 0 is returned; otherwise, a non\-zero failure code is returned\&.
207 .SH "EXAMPLES"
208 .PP
209 \fBExample\ \&1.\ \&Setting up certificates for authentication\fR
210 .PP
211 Certificates signed by a trusted authority are used to verify that the server to which messages are uploaded is legitimate, and vice versa, that the client is trusted\&.
212 .PP
213 A suitable set of certificates can be generated with
214 \fBopenssl\fR\&. Note, 2048 bits of key length is minimally recommended to use for security reasons:
215 .sp
216 .if n \{\
217 .RS 4
218 .\}
219 .nf
220 openssl req \-newkey rsa:2048 \-days 3650 \-x509 \-nodes \e
221 \-out ca\&.pem \-keyout ca\&.key \-subj \*(Aq/CN=Certificate authority/\*(Aq
222
223 cat >ca\&.conf <<EOF
224 [ ca ]
225 default_ca = this
226
227 [ this ]
228 new_certs_dir = \&.
229 certificate = ca\&.pem
230 database = \&./index
231 private_key = ca\&.key
232 serial = \&./serial
233 default_days = 3650
234 default_md = default
235 policy = policy_anything
236
237 [ policy_anything ]
238 countryName = optional
239 stateOrProvinceName = optional
240 localityName = optional
241 organizationName = optional
242 organizationalUnitName = optional
243 commonName = supplied
244 emailAddress = optional
245 EOF
246
247 touch index
248 echo 0001 >serial
249
250 SERVER=server
251 CLIENT=client
252
253 openssl req \-newkey rsa:2048 \-nodes \-out $SERVER\&.csr \-keyout $SERVER\&.key \-subj "/CN=$SERVER/"
254 openssl ca \-batch \-config ca\&.conf \-notext \-in $SERVER\&.csr \-out $SERVER\&.pem
255
256 openssl req \-newkey rsa:2048 \-nodes \-out $CLIENT\&.csr \-keyout $CLIENT\&.key \-subj "/CN=$CLIENT/"
257 openssl ca \-batch \-config ca\&.conf \-notext \-in $CLIENT\&.csr \-out $CLIENT\&.pem
258 .fi
259 .if n \{\
260 .RE
261 .\}
262 .PP
263 Generated files
264 ca\&.pem,
265 server\&.pem, and
266 server\&.key
267 should be installed on server, and
268 ca\&.pem,
269 client\&.pem, and
270 client\&.key
271 on the client\&. The location of those files can be specified using
272 \fITrustedCertificateFile=\fR,
273 \fIServerCertificateFile=\fR, and
274 \fIServerKeyFile=\fR
275 in
276 /etc/systemd/journal\-remote\&.conf
277 and
278 /etc/systemd/journal\-upload\&.conf, respectively\&. The default locations can be queried by using
279 \fBsystemd\-journal\-remote \-\-help\fR
280 and
281 \fBsystemd\-journal\-upload \-\-help\fR\&.
282 .SH "SEE ALSO"
283 .PP
284 \fBjournal-upload.conf\fR(5), \fBsystemd-journal-remote.service\fR(8), \fBjournalctl\fR(1), \fBsystemd-journald.service\fR(8), \fBsystemd-journal-gatewayd.service\fR(8)