summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man5/journal-remote.conf.5
blob: b4f43758c93effd9522043a9ceea16eff27c29ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
'\" t
.TH "JOURNAL\-REMOTE\&.CONF" "5" "" "systemd 254" "journal-remote.conf"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
journal-remote.conf, journal-remote.conf.d \- Configuration files for the service accepting remote journal uploads
.SH "SYNOPSIS"
.PP
/etc/systemd/journal\-remote\&.conf
.PP
/etc/systemd/journal\-remote\&.conf\&.d/*\&.conf
.PP
/run/systemd/journal\-remote\&.conf\&.d/*\&.conf
.PP
/usr/lib/systemd/journal\-remote\&.conf\&.d/*\&.conf
.SH "DESCRIPTION"
.PP
These files configure various parameters of
\fBsystemd-journal-remote.service\fR(8)\&. See
\fBsystemd.syntax\fR(7)
for a general description of the syntax\&.
.SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
.PP
The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. Initially, the main configuration file in
/etc/systemd/
contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by editing this file or by creating drop\-ins, as described below\&. Using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
.PP
In addition to the "main" configuration file, drop\-in configuration snippets are read from
/usr/lib/systemd/*\&.conf\&.d/,
/usr/local/lib/systemd/*\&.conf\&.d/, and
/etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
*\&.conf\&.d/
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\&.
.PP
When packages need to customize the configuration, they can install drop\-ins under
/usr/\&. Files in
/etc/
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 of the files\&.
.PP
To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
/dev/null
in the configuration directory in
/etc/, with the same filename as the vendor configuration file\&.
.SH "OPTIONS"
.PP
All options are configured in the [Remote] section:
.PP
\fISeal=\fR
.RS 4
Periodically sign the data in the journal using Forward Secure Sealing\&.
.RE
.PP
\fISplitMode=\fR
.RS 4
One of
"host"
or
"none"\&.
.RE
.PP
\fIServerKeyFile=\fR
.RS 4
SSL key in PEM format\&.
.RE
.PP
\fIServerCertificateFile=\fR
.RS 4
SSL certificate in PEM format\&.
.RE
.PP
\fITrustedCertificateFile=\fR
.RS 4
SSL CA certificate\&.
.RE
.PP
\fIMaxUse=\fR, \fIKeepFree=\fR, \fIMaxFileSize=\fR, \fIMaxFiles=\fR
.RS 4
These are analogous to
\fISystemMaxUse=\fR,
\fISystemKeepFree=\fR,
\fISystemMaxFileSize=\fR
and
\fISystemMaxFiles=\fR
in
\fBjournald.conf\fR(5)\&.
.sp
\fIMaxUse=\fR
controls how much disk space the
\fBsystemd\-journal\-remote\fR
may use up at most\&.
\fIKeepFree=\fR
controls how much disk space
\fBsystemd\-journal\-remote\fR
shall leave free for other uses\&.
\fBsystemd\-journal\-remote\fR
will respect both limits and use the smaller of the two values\&.
.sp
\fIMaxFiles=\fR
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\&.
.RE
.SH "SEE ALSO"
.PP
\fBjournald.conf\fR(5),
\fBsystemd\fR(1),
\fBsystemd-journal-remote.service\fR(8),
\fBsystemd-journald.service\fR(8)