]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.exec.xml
Merge pull request #4837 from ddstreet/master
[thirdparty/systemd.git] / man / systemd.exec.xml
1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 This file is part of systemd.
7
8 Copyright 2010 Lennart Poettering
9
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd.exec">
25 <refentryinfo>
26 <title>systemd.exec</title>
27 <productname>systemd</productname>
28
29 <authorgroup>
30 <author>
31 <contrib>Developer</contrib>
32 <firstname>Lennart</firstname>
33 <surname>Poettering</surname>
34 <email>lennart@poettering.net</email>
35 </author>
36 </authorgroup>
37 </refentryinfo>
38
39 <refmeta>
40 <refentrytitle>systemd.exec</refentrytitle>
41 <manvolnum>5</manvolnum>
42 </refmeta>
43
44 <refnamediv>
45 <refname>systemd.exec</refname>
46 <refpurpose>Execution environment configuration</refpurpose>
47 </refnamediv>
48
49 <refsynopsisdiv>
50 <para><filename><replaceable>service</replaceable>.service</filename>,
51 <filename><replaceable>socket</replaceable>.socket</filename>,
52 <filename><replaceable>mount</replaceable>.mount</filename>,
53 <filename><replaceable>swap</replaceable>.swap</filename></para>
54 </refsynopsisdiv>
55
56 <refsect1>
57 <title>Description</title>
58
59 <para>Unit configuration files for services, sockets, mount
60 points, and swap devices share a subset of configuration options
61 which define the execution environment of spawned
62 processes.</para>
63
64 <para>This man page lists the configuration options shared by
65 these four unit types. See
66 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
67 for the common options of all unit configuration files, and
68 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
69 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
70 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
71 and
72 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
73 for more information on the specific unit configuration files. The
74 execution specific configuration options are configured in the
75 [Service], [Socket], [Mount], or [Swap] sections, depending on the
76 unit type.</para>
77
78 <para>In addition, options which control resources through Linux Control Groups (cgroups) are listed in
79 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
80 Those options complement options listed here.</para>
81 </refsect1>
82
83 <refsect1>
84 <title>Automatic Dependencies</title>
85
86 <para>A few execution parameters result in additional, automatic
87 dependencies to be added.</para>
88
89 <para>Units with <varname>WorkingDirectory=</varname> or
90 <varname>RootDirectory=</varname> set automatically gain
91 dependencies of type <varname>Requires=</varname> and
92 <varname>After=</varname> on all mount units required to access
93 the specified paths. This is equivalent to having them listed
94 explicitly in <varname>RequiresMountsFor=</varname>.</para>
95
96 <para>Similar, units with <varname>PrivateTmp=</varname> enabled automatically get mount unit dependencies for all
97 mounts required to access <filename>/tmp</filename> and <filename>/var/tmp</filename>. They will also gain an
98 automatic <varname>After=</varname> dependency on
99 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
100
101 <para>Units whose standard output or error output is connected to <option>journal</option>, <option>syslog</option>
102 or <option>kmsg</option> (or their combinations with console output, see below) automatically acquire dependencies
103 of type <varname>After=</varname> on <filename>systemd-journald.socket</filename>.</para>
104 </refsect1>
105
106 <refsect1>
107 <title>Options</title>
108
109 <variablelist class='unit-directives'>
110
111 <varlistentry>
112 <term><varname>WorkingDirectory=</varname></term>
113
114 <listitem><para>Takes a directory path relative to the service's root directory specified by
115 <varname>RootDirectory=</varname>, or the special value <literal>~</literal>. Sets the working directory for
116 executed processes. If set to <literal>~</literal>, the home directory of the user specified in
117 <varname>User=</varname> is used. If not set, defaults to the root directory when systemd is running as a
118 system instance and the respective user's home directory if run as user. If the setting is prefixed with the
119 <literal>-</literal> character, a missing working directory is not considered fatal. If
120 <varname>RootDirectory=</varname> is not set, then <varname>WorkingDirectory=</varname> is relative to the root
121 of the system running the service manager. Note that setting this parameter might result in additional
122 dependencies to be added to the unit (see above).</para></listitem>
123 </varlistentry>
124
125 <varlistentry>
126 <term><varname>RootDirectory=</varname></term>
127
128 <listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system
129 running the service manager). Sets the root directory for executed processes, with the <citerefentry
130 project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
131 call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in
132 the <function>chroot()</function> jail. Note that setting this parameter might result in additional
133 dependencies to be added to the unit (see above).</para>
134
135 <para>The <varname>PrivateUsers=</varname> setting is particularly useful in conjunction with
136 <varname>RootDirectory=</varname>. For details, see below.</para></listitem>
137 </varlistentry>
138
139 <varlistentry>
140 <term><varname>User=</varname></term>
141 <term><varname>Group=</varname></term>
142
143 <listitem><para>Set the UNIX user or group that the processes are executed as, respectively. Takes a single
144 user or group name, or numeric ID as argument. For system services (services run by the system service manager,
145 i.e. managed by PID 1) and for user services of the root user (services managed by root's instance of
146 <command>systemd --user</command>), the default is <literal>root</literal>, but <varname>User=</varname> may be
147 used to specify a different user. For user services of any other user, switching user identity is not
148 permitted, hence the only valid setting is the same user the user's service manager is running as. If no group
149 is set, the default group of the user is used. This setting does not affect commands whose command line is
150 prefixed with <literal>+</literal>.</para></listitem>
151 </varlistentry>
152
153 <varlistentry>
154 <term><varname>DynamicUser=</varname></term>
155
156 <listitem><para>Takes a boolean parameter. If set, a UNIX user and group pair is allocated dynamically when the
157 unit is started, and released as soon as it is stopped. The user and group will not be added to
158 <filename>/etc/passwd</filename> or <filename>/etc/group</filename>, but are managed transiently during
159 runtime. The <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
160 glibc NSS module provides integration of these dynamic users/groups into the system's user and group
161 databases. The user and group name to use may be configured via <varname>User=</varname> and
162 <varname>Group=</varname> (see above). If these options are not used and dynamic user/group allocation is
163 enabled for a unit, the name of the dynamic user/group is implicitly derived from the unit name. If the unit
164 name without the type suffix qualifies as valid user name it is used directly, otherwise a name incorporating a
165 hash of it is used. If a statically allocated user or group of the configured name already exists, it is used
166 and no dynamic user/group is allocated. Dynamic users/groups are allocated from the UID/GID range
167 6118465519. It is recommended to avoid this range for regular system or login users. At any point in time
168 each UID/GID from this range is only assigned to zero or one dynamically allocated users/groups in
169 use. However, UID/GIDs are recycled after a unit is terminated. Care should be taken that any processes running
170 as part of a unit for which dynamic users/groups are enabled do not leave files or directories owned by these
171 users/groups around, as a different unit might get the same UID/GID assigned later on, and thus gain access to
172 these files or directories. If <varname>DynamicUser=</varname> is enabled, <varname>RemoveIPC=</varname>,
173 <varname>PrivateTmp=</varname> are implied. This ensures that the lifetime of IPC objects and temporary files
174 created by the executed processes is bound to the runtime of the service, and hence the lifetime of the dynamic
175 user/group. Since <filename>/tmp</filename> and <filename>/var/tmp</filename> are usually the only
176 world-writable directories on a system this ensures that a unit making use of dynamic user/group allocation
177 cannot leave files around after unit termination. Moreover <varname>ProtectSystem=strict</varname> and
178 <varname>ProtectHome=read-only</varname> are implied, thus prohibiting the service to write to arbitrary file
179 system locations. In order to allow the service to write to certain directories, they have to be whitelisted
180 using <varname>ReadWritePaths=</varname>, but care must be taken so that UID/GID recycling doesn't
181 create security issues involving files created by the service. Use <varname>RuntimeDirectory=</varname> (see
182 below) in order to assign a writable runtime directory to a service, owned by the dynamic user/group and
183 removed automatically when the unit is terminated. Defaults to off.</para></listitem>
184 </varlistentry>
185
186 <varlistentry>
187 <term><varname>SupplementaryGroups=</varname></term>
188
189 <listitem><para>Sets the supplementary Unix groups the
190 processes are executed as. This takes a space-separated list
191 of group names or IDs. This option may be specified more than
192 once, in which case all listed groups are set as supplementary
193 groups. When the empty string is assigned, the list of
194 supplementary groups is reset, and all assignments prior to
195 this one will have no effect. In any way, this option does not
196 override, but extends the list of supplementary groups
197 configured in the system group database for the
198 user. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
199 </varlistentry>
200
201 <varlistentry>
202 <term><varname>RemoveIPC=</varname></term>
203
204 <listitem><para>Takes a boolean parameter. If set, all System V and POSIX IPC objects owned by the user and
205 group the processes of this unit are run as are removed when the unit is stopped. This setting only has an
206 effect if at least one of <varname>User=</varname>, <varname>Group=</varname> and
207 <varname>DynamicUser=</varname> are used. It has no effect on IPC objects owned by the root user. Specifically,
208 this removes System V semaphores, as well as System V and POSIX shared memory segments and message queues. If
209 multiple units use the same user or group the IPC objects are removed when the last of these units is
210 stopped. This setting is implied if <varname>DynamicUser=</varname> is set.</para></listitem>
211 </varlistentry>
212
213 <varlistentry>
214 <term><varname>Nice=</varname></term>
215
216 <listitem><para>Sets the default nice level (scheduling
217 priority) for executed processes. Takes an integer between -20
218 (highest priority) and 19 (lowest priority). See
219 <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>
220 for details.</para></listitem>
221 </varlistentry>
222
223 <varlistentry>
224 <term><varname>OOMScoreAdjust=</varname></term>
225
226 <listitem><para>Sets the adjustment level for the
227 Out-Of-Memory killer for executed processes. Takes an integer
228 between -1000 (to disable OOM killing for this process) and
229 1000 (to make killing of this process under memory pressure
230 very likely). See <ulink
231 url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
232 for details.</para></listitem>
233 </varlistentry>
234
235 <varlistentry>
236 <term><varname>IOSchedulingClass=</varname></term>
237
238 <listitem><para>Sets the I/O scheduling class for executed
239 processes. Takes an integer between 0 and 3 or one of the
240 strings <option>none</option>, <option>realtime</option>,
241 <option>best-effort</option> or <option>idle</option>. See
242 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
243 for details.</para></listitem>
244 </varlistentry>
245
246 <varlistentry>
247 <term><varname>IOSchedulingPriority=</varname></term>
248
249 <listitem><para>Sets the I/O scheduling priority for executed
250 processes. Takes an integer between 0 (highest priority) and 7
251 (lowest priority). The available priorities depend on the
252 selected I/O scheduling class (see above). See
253 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
254 for details.</para></listitem>
255 </varlistentry>
256
257 <varlistentry>
258 <term><varname>CPUSchedulingPolicy=</varname></term>
259
260 <listitem><para>Sets the CPU scheduling policy for executed
261 processes. Takes one of
262 <option>other</option>,
263 <option>batch</option>,
264 <option>idle</option>,
265 <option>fifo</option> or
266 <option>rr</option>. See
267 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
268 for details.</para></listitem>
269 </varlistentry>
270
271 <varlistentry>
272 <term><varname>CPUSchedulingPriority=</varname></term>
273
274 <listitem><para>Sets the CPU scheduling priority for executed
275 processes. The available priority range depends on the
276 selected CPU scheduling policy (see above). For real-time
277 scheduling policies an integer between 1 (lowest priority) and
278 99 (highest priority) can be used. See
279 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
280 for details. </para></listitem>
281 </varlistentry>
282
283 <varlistentry>
284 <term><varname>CPUSchedulingResetOnFork=</varname></term>
285
286 <listitem><para>Takes a boolean argument. If true, elevated
287 CPU scheduling priorities and policies will be reset when the
288 executed processes fork, and can hence not leak into child
289 processes. See
290 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
291 for details. Defaults to false.</para></listitem>
292 </varlistentry>
293
294 <varlistentry>
295 <term><varname>CPUAffinity=</varname></term>
296
297 <listitem><para>Controls the CPU affinity of the executed
298 processes. Takes a list of CPU indices or ranges separated by
299 either whitespace or commas. CPU ranges are specified by the
300 lower and upper CPU indices separated by a dash.
301 This option may be specified more than once, in which case the
302 specified CPU affinity masks are merged. If the empty string
303 is assigned, the mask is reset, all assignments prior to this
304 will have no effect. See
305 <citerefentry><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry>
306 for details.</para></listitem>
307 </varlistentry>
308
309 <varlistentry>
310 <term><varname>UMask=</varname></term>
311
312 <listitem><para>Controls the file mode creation mask. Takes an
313 access mode in octal notation. See
314 <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry>
315 for details. Defaults to 0022.</para></listitem>
316 </varlistentry>
317
318 <varlistentry>
319 <term><varname>Environment=</varname></term>
320
321 <listitem><para>Sets environment variables for executed
322 processes. Takes a space-separated list of variable
323 assignments. This option may be specified more than once, in
324 which case all listed variables will be set. If the same
325 variable is set twice, the later setting will override the
326 earlier setting. If the empty string is assigned to this
327 option, the list of environment variables is reset, all prior
328 assignments have no effect. Variable expansion is not
329 performed inside the strings, however, specifier expansion is
330 possible. The $ character has no special meaning. If you need
331 to assign a value containing spaces to a variable, use double
332 quotes (") for the assignment.</para>
333
334 <para>Example:
335 <programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
336 gives three variables <literal>VAR1</literal>,
337 <literal>VAR2</literal>, <literal>VAR3</literal>
338 with the values <literal>word1 word2</literal>,
339 <literal>word3</literal>, <literal>$word 5 6</literal>.
340 </para>
341
342 <para>
343 See
344 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
345 for details about environment variables.</para></listitem>
346 </varlistentry>
347 <varlistentry>
348 <term><varname>EnvironmentFile=</varname></term>
349 <listitem><para>Similar to <varname>Environment=</varname> but
350 reads the environment variables from a text file. The text
351 file should contain new-line-separated variable assignments.
352 Empty lines, lines without an <literal>=</literal> separator,
353 or lines starting with ; or # will be ignored,
354 which may be used for commenting. A line ending with a
355 backslash will be concatenated with the following one,
356 allowing multiline variable definitions. The parser strips
357 leading and trailing whitespace from the values of
358 assignments, unless you use double quotes (").</para>
359
360 <para>The argument passed should be an absolute filename or
361 wildcard expression, optionally prefixed with
362 <literal>-</literal>, which indicates that if the file does
363 not exist, it will not be read and no error or warning message
364 is logged. This option may be specified more than once in
365 which case all specified files are read. If the empty string
366 is assigned to this option, the list of file to read is reset,
367 all prior assignments have no effect.</para>
368
369 <para>The files listed with this directive will be read
370 shortly before the process is executed (more specifically,
371 after all processes from a previous unit state terminated.
372 This means you can generate these files in one unit state, and
373 read it with this option in the next).</para>
374
375 <para>Settings from these
376 files override settings made with
377 <varname>Environment=</varname>. If the same variable is set
378 twice from these files, the files will be read in the order
379 they are specified and the later setting will override the
380 earlier setting.</para></listitem>
381 </varlistentry>
382
383 <varlistentry>
384 <term><varname>PassEnvironment=</varname></term>
385
386 <listitem><para>Pass environment variables from the systemd system
387 manager to executed processes. Takes a space-separated list of variable
388 names. This option may be specified more than once, in which case all
389 listed variables will be set. If the empty string is assigned to this
390 option, the list of environment variables is reset, all prior
391 assignments have no effect. Variables that are not set in the system
392 manager will not be passed and will be silently ignored.</para>
393
394 <para>Variables passed from this setting are overridden by those passed
395 from <varname>Environment=</varname> or
396 <varname>EnvironmentFile=</varname>.</para>
397
398 <para>Example:
399 <programlisting>PassEnvironment=VAR1 VAR2 VAR3</programlisting>
400 passes three variables <literal>VAR1</literal>,
401 <literal>VAR2</literal>, <literal>VAR3</literal>
402 with the values set for those variables in PID1.</para>
403
404 <para>
405 See
406 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
407 for details about environment variables.</para></listitem>
408 </varlistentry>
409
410 <varlistentry>
411 <term><varname>StandardInput=</varname></term>
412 <listitem><para>Controls where file descriptor 0 (STDIN) of
413 the executed processes is connected to. Takes one of
414 <option>null</option>,
415 <option>tty</option>,
416 <option>tty-force</option>,
417 <option>tty-fail</option>,
418 <option>socket</option> or
419 <option>fd</option>.</para>
420
421 <para>If <option>null</option> is selected, standard input
422 will be connected to <filename>/dev/null</filename>, i.e. all
423 read attempts by the process will result in immediate
424 EOF.</para>
425
426 <para>If <option>tty</option> is selected, standard input is
427 connected to a TTY (as configured by
428 <varname>TTYPath=</varname>, see below) and the executed
429 process becomes the controlling process of the terminal. If
430 the terminal is already being controlled by another process,
431 the executed process waits until the current controlling
432 process releases the terminal.</para>
433
434 <para><option>tty-force</option> is similar to
435 <option>tty</option>, but the executed process is forcefully
436 and immediately made the controlling process of the terminal,
437 potentially removing previous controlling processes from the
438 terminal.</para>
439
440 <para><option>tty-fail</option> is similar to
441 <option>tty</option> but if the terminal already has a
442 controlling process start-up of the executed process
443 fails.</para>
444
445 <para>The <option>socket</option> option is only valid in
446 socket-activated services, and only when the socket
447 configuration file (see
448 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
449 for details) specifies a single socket only. If this option is
450 set, standard input will be connected to the socket the
451 service was activated from, which is primarily useful for
452 compatibility with daemons designed for use with the
453 traditional
454 <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
455 daemon.</para>
456
457 <para>The <option>fd</option> option connects
458 the input stream to a single file descriptor provided by a socket unit.
459 A custom named file descriptor can be specified as part of this option,
460 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
461 If no name is specified, <literal>stdin</literal> is assumed
462 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdin</literal>).
463 At least one socket unit defining such name must be explicitly provided via the
464 <varname>Sockets=</varname> option, and file descriptor name may differ
465 from the name of its containing socket unit.
466 If multiple matches are found, the first one will be used.
467 See <varname>FileDescriptorName=</varname> in
468 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
469 for more details about named descriptors and ordering.</para>
470
471 <para>This setting defaults to
472 <option>null</option>.</para></listitem>
473 </varlistentry>
474
475 <varlistentry>
476 <term><varname>StandardOutput=</varname></term>
477 <listitem><para>Controls where file descriptor 1 (STDOUT) of
478 the executed processes is connected to. Takes one of
479 <option>inherit</option>,
480 <option>null</option>,
481 <option>tty</option>,
482 <option>journal</option>,
483 <option>syslog</option>,
484 <option>kmsg</option>,
485 <option>journal+console</option>,
486 <option>syslog+console</option>,
487 <option>kmsg+console</option>,
488 <option>socket</option> or
489 <option>fd</option>.</para>
490
491 <para><option>inherit</option> duplicates the file descriptor
492 of standard input for standard output.</para>
493
494 <para><option>null</option> connects standard output to
495 <filename>/dev/null</filename>, i.e. everything written to it
496 will be lost.</para>
497
498 <para><option>tty</option> connects standard output to a tty
499 (as configured via <varname>TTYPath=</varname>, see below). If
500 the TTY is used for output only, the executed process will not
501 become the controlling process of the terminal, and will not
502 fail or wait for other processes to release the
503 terminal.</para>
504
505 <para><option>journal</option> connects standard output with
506 the journal which is accessible via
507 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
508 Note that everything that is written to syslog or kmsg (see
509 below) is implicitly stored in the journal as well, the
510 specific two options listed below are hence supersets of this
511 one.</para>
512
513 <para><option>syslog</option> connects standard output to the
514 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
515 system syslog service, in addition to the journal. Note that
516 the journal daemon is usually configured to forward everything
517 it receives to syslog anyway, in which case this option is no
518 different from <option>journal</option>.</para>
519
520 <para><option>kmsg</option> connects standard output with the
521 kernel log buffer which is accessible via
522 <citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
523 in addition to the journal. The journal daemon might be
524 configured to send all logs to kmsg anyway, in which case this
525 option is no different from <option>journal</option>.</para>
526
527 <para><option>journal+console</option>,
528 <option>syslog+console</option> and
529 <option>kmsg+console</option> work in a similar way as the
530 three options above but copy the output to the system console
531 as well.</para>
532
533 <para><option>socket</option> connects standard output to a
534 socket acquired via socket activation. The semantics are
535 similar to the same option of
536 <varname>StandardInput=</varname>.</para>
537
538 <para>The <option>fd</option> option connects
539 the output stream to a single file descriptor provided by a socket unit.
540 A custom named file descriptor can be specified as part of this option,
541 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
542 If no name is specified, <literal>stdout</literal> is assumed
543 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdout</literal>).
544 At least one socket unit defining such name must be explicitly provided via the
545 <varname>Sockets=</varname> option, and file descriptor name may differ
546 from the name of its containing socket unit.
547 If multiple matches are found, the first one will be used.
548 See <varname>FileDescriptorName=</varname> in
549 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
550 for more details about named descriptors and ordering.</para>
551
552 <para>If the standard output (or error output, see below) of a unit is connected to the journal, syslog or the
553 kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname> on
554 <filename>systemd-journald.socket</filename> (also see the automatic dependencies section above).</para>
555
556 <para>This setting defaults to the value set with
557 <option>DefaultStandardOutput=</option> in
558 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
559 which defaults to <option>journal</option>. Note that setting
560 this parameter might result in additional dependencies to be
561 added to the unit (see above).</para></listitem>
562 </varlistentry>
563
564 <varlistentry>
565 <term><varname>StandardError=</varname></term>
566 <listitem><para>Controls where file descriptor 2 (STDERR) of
567 the executed processes is connected to. The available options
568 are identical to those of <varname>StandardOutput=</varname>,
569 with some exceptions: if set to <option>inherit</option> the
570 file descriptor used for standard output is duplicated for
571 standard error, while <option>fd</option> operates on the error
572 stream and will look by default for a descriptor named
573 <literal>stderr</literal>.</para>
574
575 <para>This setting defaults to the value set with
576 <option>DefaultStandardError=</option> in
577 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
578 which defaults to <option>inherit</option>. Note that setting
579 this parameter might result in additional dependencies to be
580 added to the unit (see above).</para></listitem>
581 </varlistentry>
582
583 <varlistentry>
584 <term><varname>TTYPath=</varname></term>
585 <listitem><para>Sets the terminal device node to use if
586 standard input, output, or error are connected to a TTY (see
587 above). Defaults to
588 <filename>/dev/console</filename>.</para></listitem>
589 </varlistentry>
590 <varlistentry>
591 <term><varname>TTYReset=</varname></term>
592 <listitem><para>Reset the terminal device specified with
593 <varname>TTYPath=</varname> before and after execution.
594 Defaults to <literal>no</literal>.</para></listitem>
595 </varlistentry>
596 <varlistentry>
597 <term><varname>TTYVHangup=</varname></term>
598 <listitem><para>Disconnect all clients which have opened the
599 terminal device specified with <varname>TTYPath=</varname>
600 before and after execution. Defaults to
601 <literal>no</literal>.</para></listitem>
602 </varlistentry>
603 <varlistentry>
604 <term><varname>TTYVTDisallocate=</varname></term>
605 <listitem><para>If the terminal device specified with
606 <varname>TTYPath=</varname> is a virtual console terminal, try
607 to deallocate the TTY before and after execution. This ensures
608 that the screen and scrollback buffer is cleared. Defaults to
609 <literal>no</literal>.</para></listitem>
610 </varlistentry>
611 <varlistentry>
612 <term><varname>SyslogIdentifier=</varname></term>
613 <listitem><para>Sets the process name to prefix log lines sent
614 to the logging system or the kernel log buffer with. If not
615 set, defaults to the process name of the executed process.
616 This option is only useful when
617 <varname>StandardOutput=</varname> or
618 <varname>StandardError=</varname> are set to
619 <option>syslog</option>, <option>journal</option> or
620 <option>kmsg</option> (or to the same settings in combination
621 with <option>+console</option>).</para></listitem>
622 </varlistentry>
623 <varlistentry>
624 <term><varname>SyslogFacility=</varname></term>
625 <listitem><para>Sets the syslog facility to use when logging
626 to syslog. One of <option>kern</option>,
627 <option>user</option>, <option>mail</option>,
628 <option>daemon</option>, <option>auth</option>,
629 <option>syslog</option>, <option>lpr</option>,
630 <option>news</option>, <option>uucp</option>,
631 <option>cron</option>, <option>authpriv</option>,
632 <option>ftp</option>, <option>local0</option>,
633 <option>local1</option>, <option>local2</option>,
634 <option>local3</option>, <option>local4</option>,
635 <option>local5</option>, <option>local6</option> or
636 <option>local7</option>. See
637 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
638 for details. This option is only useful when
639 <varname>StandardOutput=</varname> or
640 <varname>StandardError=</varname> are set to
641 <option>syslog</option>. Defaults to
642 <option>daemon</option>.</para></listitem>
643 </varlistentry>
644 <varlistentry>
645 <term><varname>SyslogLevel=</varname></term>
646 <listitem><para>The default syslog level to use when logging to
647 syslog or the kernel log buffer. One of
648 <option>emerg</option>,
649 <option>alert</option>,
650 <option>crit</option>,
651 <option>err</option>,
652 <option>warning</option>,
653 <option>notice</option>,
654 <option>info</option>,
655 <option>debug</option>. See
656 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
657 for details. This option is only useful when
658 <varname>StandardOutput=</varname> or
659 <varname>StandardError=</varname> are set to
660 <option>syslog</option> or <option>kmsg</option>. Note that
661 individual lines output by the daemon might be prefixed with a
662 different log level which can be used to override the default
663 log level specified here. The interpretation of these prefixes
664 may be disabled with <varname>SyslogLevelPrefix=</varname>,
665 see below. For details, see
666 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
667
668 Defaults to
669 <option>info</option>.</para></listitem>
670 </varlistentry>
671
672 <varlistentry>
673 <term><varname>SyslogLevelPrefix=</varname></term>
674 <listitem><para>Takes a boolean argument. If true and
675 <varname>StandardOutput=</varname> or
676 <varname>StandardError=</varname> are set to
677 <option>syslog</option>, <option>kmsg</option> or
678 <option>journal</option>, log lines written by the executed
679 process that are prefixed with a log level will be passed on
680 to syslog with this log level set but the prefix removed. If
681 set to false, the interpretation of these prefixes is disabled
682 and the logged lines are passed on as-is. For details about
683 this prefixing see
684 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
685 Defaults to true.</para></listitem>
686 </varlistentry>
687
688 <varlistentry>
689 <term><varname>TimerSlackNSec=</varname></term>
690 <listitem><para>Sets the timer slack in nanoseconds for the
691 executed processes. The timer slack controls the accuracy of
692 wake-ups triggered by timers. See
693 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
694 for more information. Note that in contrast to most other time
695 span definitions this parameter takes an integer value in
696 nano-seconds if no unit is specified. The usual time units are
697 understood too.</para></listitem>
698 </varlistentry>
699
700 <varlistentry>
701 <term><varname>LimitCPU=</varname></term>
702 <term><varname>LimitFSIZE=</varname></term>
703 <term><varname>LimitDATA=</varname></term>
704 <term><varname>LimitSTACK=</varname></term>
705 <term><varname>LimitCORE=</varname></term>
706 <term><varname>LimitRSS=</varname></term>
707 <term><varname>LimitNOFILE=</varname></term>
708 <term><varname>LimitAS=</varname></term>
709 <term><varname>LimitNPROC=</varname></term>
710 <term><varname>LimitMEMLOCK=</varname></term>
711 <term><varname>LimitLOCKS=</varname></term>
712 <term><varname>LimitSIGPENDING=</varname></term>
713 <term><varname>LimitMSGQUEUE=</varname></term>
714 <term><varname>LimitNICE=</varname></term>
715 <term><varname>LimitRTPRIO=</varname></term>
716 <term><varname>LimitRTTIME=</varname></term>
717 <listitem><para>Set soft and hard limits on various resources for executed processes. See
718 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details on
719 the resource limit concept. Resource limits may be specified in two formats: either as single value to set a
720 specific soft and hard limit to the same value, or as colon-separated pair <option>soft:hard</option> to set
721 both limits individually (e.g. <literal>LimitAS=4G:16G</literal>). Use the string <varname>infinity</varname>
722 to configure no limit on a specific resource. The multiplicative suffixes K, M, G, T, P and E (to the base
723 1024) may be used for resource limits measured in bytes (e.g. LimitAS=16G). For the limits referring to time
724 values, the usual time units ms, s, min, h and so on may be used (see
725 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
726 details). Note that if no time unit is specified for <varname>LimitCPU=</varname> the default unit of seconds
727 is implied, while for <varname>LimitRTTIME=</varname> the default unit of microseconds is implied. Also, note
728 that the effective granularity of the limits might influence their enforcement. For example, time limits
729 specified for <varname>LimitCPU=</varname> will be rounded up implicitly to multiples of 1s. For
730 <varname>LimitNICE=</varname> the value may be specified in two syntaxes: if prefixed with <literal>+</literal>
731 or <literal>-</literal>, the value is understood as regular Linux nice value in the range -20..19. If not
732 prefixed like this the value is understood as raw resource limit parameter in the range 0..40 (with 0 being
733 equivalent to 1).</para>
734
735 <para>Note that most process resource limits configured with
736 these options are per-process, and processes may fork in order
737 to acquire a new set of resources that are accounted
738 independently of the original process, and may thus escape
739 limits set. Also note that <varname>LimitRSS=</varname> is not
740 implemented on Linux, and setting it has no effect. Often it
741 is advisable to prefer the resource controls listed in
742 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
743 over these per-process limits, as they apply to services as a
744 whole, may be altered dynamically at runtime, and are
745 generally more expressive. For example,
746 <varname>MemoryLimit=</varname> is a more powerful (and
747 working) replacement for <varname>LimitRSS=</varname>.</para>
748
749 <para>For system units these resource limits may be chosen freely. For user units however (i.e. units run by a
750 per-user instance of
751 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>), these limits are
752 bound by (possibly more restrictive) per-user limits enforced by the OS.</para>
753
754 <para>Resource limits not configured explicitly for a unit default to the value configured in the various
755 <varname>DefaultLimitCPU=</varname>, <varname>DefaultLimitFSIZE=</varname>, … options available in
756 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and –
757 if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user
758 services, see above).</para>
759
760 <table>
761 <title>Resource limit directives, their equivalent <command>ulimit</command> shell commands and the unit used</title>
762
763 <tgroup cols='3'>
764 <colspec colname='directive' />
765 <colspec colname='equivalent' />
766 <colspec colname='unit' />
767 <thead>
768 <row>
769 <entry>Directive</entry>
770 <entry><command>ulimit</command> equivalent</entry>
771 <entry>Unit</entry>
772 </row>
773 </thead>
774 <tbody>
775 <row>
776 <entry>LimitCPU=</entry>
777 <entry>ulimit -t</entry>
778 <entry>Seconds</entry>
779 </row>
780 <row>
781 <entry>LimitFSIZE=</entry>
782 <entry>ulimit -f</entry>
783 <entry>Bytes</entry>
784 </row>
785 <row>
786 <entry>LimitDATA=</entry>
787 <entry>ulimit -d</entry>
788 <entry>Bytes</entry>
789 </row>
790 <row>
791 <entry>LimitSTACK=</entry>
792 <entry>ulimit -s</entry>
793 <entry>Bytes</entry>
794 </row>
795 <row>
796 <entry>LimitCORE=</entry>
797 <entry>ulimit -c</entry>
798 <entry>Bytes</entry>
799 </row>
800 <row>
801 <entry>LimitRSS=</entry>
802 <entry>ulimit -m</entry>
803 <entry>Bytes</entry>
804 </row>
805 <row>
806 <entry>LimitNOFILE=</entry>
807 <entry>ulimit -n</entry>
808 <entry>Number of File Descriptors</entry>
809 </row>
810 <row>
811 <entry>LimitAS=</entry>
812 <entry>ulimit -v</entry>
813 <entry>Bytes</entry>
814 </row>
815 <row>
816 <entry>LimitNPROC=</entry>
817 <entry>ulimit -u</entry>
818 <entry>Number of Processes</entry>
819 </row>
820 <row>
821 <entry>LimitMEMLOCK=</entry>
822 <entry>ulimit -l</entry>
823 <entry>Bytes</entry>
824 </row>
825 <row>
826 <entry>LimitLOCKS=</entry>
827 <entry>ulimit -x</entry>
828 <entry>Number of Locks</entry>
829 </row>
830 <row>
831 <entry>LimitSIGPENDING=</entry>
832 <entry>ulimit -i</entry>
833 <entry>Number of Queued Signals</entry>
834 </row>
835 <row>
836 <entry>LimitMSGQUEUE=</entry>
837 <entry>ulimit -q</entry>
838 <entry>Bytes</entry>
839 </row>
840 <row>
841 <entry>LimitNICE=</entry>
842 <entry>ulimit -e</entry>
843 <entry>Nice Level</entry>
844 </row>
845 <row>
846 <entry>LimitRTPRIO=</entry>
847 <entry>ulimit -r</entry>
848 <entry>Realtime Priority</entry>
849 </row>
850 <row>
851 <entry>LimitRTTIME=</entry>
852 <entry>No equivalent</entry>
853 <entry>Microseconds</entry>
854 </row>
855 </tbody>
856 </tgroup>
857 </table></listitem>
858 </varlistentry>
859
860 <varlistentry>
861 <term><varname>PAMName=</varname></term>
862 <listitem><para>Sets the PAM service name to set up a session as. If set, the executed process will be
863 registered as a PAM session under the specified service name. This is only useful in conjunction with the
864 <varname>User=</varname> setting, and is otherwise ignored. If not set, no PAM session will be opened for the
865 executed processes. See <citerefentry
866 project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
867 details.</para>
868
869 <para>Note that for each unit making use of this option a PAM session handler process will be maintained as
870 part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be
871 taken when the unit and hence the PAM session terminates. This process is named <literal>(sd-pam)</literal> and
872 is an immediate child process of the unit's main process.</para></listitem>
873 </varlistentry>
874
875 <varlistentry>
876 <term><varname>CapabilityBoundingSet=</varname></term>
877
878 <listitem><para>Controls which capabilities to include in the capability bounding set for the executed
879 process. See <citerefentry
880 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
881 details. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
882 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be
883 included in the bounding set, all others are removed. If the list of capabilities is prefixed with
884 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
885 inverted. Note that this option also affects the respective capabilities in the effective, permitted and
886 inheritable capability sets. If this option is not used, the capability bounding set is not modified on process
887 execution, hence no limits on the capabilities of the process are enforced. This option may appear more than
888 once, in which case the bounding sets are merged. If the empty string is assigned to this option, the bounding
889 set is reset to the empty capability set, and all prior settings have no effect. If set to
890 <literal>~</literal> (without any further argument), the bounding set is reset to the full set of available
891 capabilities, also undoing any previous settings. This does not affect commands prefixed with
892 <literal>+</literal>.</para></listitem>
893 </varlistentry>
894
895 <varlistentry>
896 <term><varname>AmbientCapabilities=</varname></term>
897
898 <listitem><para>Controls which capabilities to include in the ambient capability set for the executed
899 process. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
900 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. This option may appear more than
901 once in which case the ambient capability sets are merged. If the list of capabilities is prefixed with
902 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
903 inverted. If the empty string is assigned to this option, the ambient capability set is reset to the empty
904 capability set, and all prior settings have no effect. If set to <literal>~</literal> (without any further
905 argument), the ambient capability set is reset to the full set of available capabilities, also undoing any
906 previous settings. Note that adding capabilities to ambient capability set adds them to the process's inherited
907 capability set. </para><para> Ambient capability sets are useful if you want to execute a process as a
908 non-privileged user but still want to give it some capabilities. Note that in this case option
909 <constant>keep-caps</constant> is automatically added to <varname>SecureBits=</varname> to retain the
910 capabilities over the user change. <varname>AmbientCapabilities=</varname> does not affect commands prefixed
911 with <literal>+</literal>.</para></listitem>
912 </varlistentry>
913
914 <varlistentry>
915 <term><varname>SecureBits=</varname></term>
916 <listitem><para>Controls the secure bits set for the executed
917 process. Takes a space-separated combination of options from
918 the following list:
919 <option>keep-caps</option>,
920 <option>keep-caps-locked</option>,
921 <option>no-setuid-fixup</option>,
922 <option>no-setuid-fixup-locked</option>,
923 <option>noroot</option>, and
924 <option>noroot-locked</option>.
925 This option may appear more than once, in which case the secure
926 bits are ORed. If the empty string is assigned to this option,
927 the bits are reset to 0. This does not affect commands prefixed with <literal>+</literal>.
928 See <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
929 for details.</para></listitem>
930 </varlistentry>
931
932 <varlistentry>
933 <term><varname>ReadWritePaths=</varname></term>
934 <term><varname>ReadOnlyPaths=</varname></term>
935 <term><varname>InaccessiblePaths=</varname></term>
936
937 <listitem><para>Sets up a new file system namespace for executed processes. These options may be used to limit
938 access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths
939 relative to the host's root directory (i.e. the system running the service manager). Note that if paths
940 contain symlinks, they are resolved relative to the root directory set with
941 <varname>RootDirectory=</varname>.</para>
942
943 <para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace with the same
944 access modes as from outside of it. Paths listed in <varname>ReadOnlyPaths=</varname> are accessible for
945 reading only, writing will be refused even if the usual file access controls would permit this. Nest
946 <varname>ReadWritePaths=</varname> inside of <varname>ReadOnlyPaths=</varname> in order to provide writable
947 subdirectories within read-only directories. Use <varname>ReadWritePaths=</varname> in order to whitelist
948 specific paths for write access if <varname>ProtectSystem=strict</varname> is used. Paths listed in
949 <varname>InaccessiblePaths=</varname> will be made inaccessible for processes inside the namespace (along with
950 everything below them in the file system hierarchy).</para>
951
952 <para>Note that restricting access with these options does not extend to submounts of a directory that are
953 created later on. Non-directory paths may be specified as well. These options may be specified more than once,
954 in which case all paths listed will have limited access from within the namespace. If the empty string is
955 assigned to this option, the specific list is reset, and all prior assignments have no effect.</para>
956
957 <para>Paths in <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname> and
958 <varname>InaccessiblePaths=</varname> may be prefixed with <literal>-</literal>, in which case they will be
959 ignored when they do not exist. If prefixed with <literal>+</literal> the paths are taken relative to the root
960 directory of the unit, as configured with <varname>RootDirectory=</varname>, instead of relative to the root
961 directory of the host (see above). When combining <literal>-</literal> and <literal>+</literal> on the same
962 path make sure to specify <literal>-</literal> first, and <literal>+</literal> second.</para>
963
964 <para>Note that using this setting will disconnect propagation of mounts from the service to the host
965 (propagation in the opposite direction continues to work). This means that this setting may not be used for
966 services which shall be able to install mount points in the main mount namespace. Note that the effect of these
967 settings may be undone by privileged processes. In order to set up an effective sandboxed environment for a
968 unit it is thus recommended to combine these settings with either
969 <varname>CapabilityBoundingSet=~CAP_SYS_ADMIN</varname> or
970 <varname>SystemCallFilter=~@mount</varname>.</para></listitem>
971 </varlistentry>
972
973 <varlistentry>
974 <term><varname>BindPaths=</varname></term>
975 <term><varname>BindReadOnlyPaths=</varname></term>
976
977 <listitem><para>Configures unit-specific bind mounts. A bind mount makes a particular file or directory
978 available at an additional place in the unit's view of the file system. Any bind mounts created with this
979 option are specific to the unit, and are not visible in the host's mount table. This option expects a
980 whitespace separated list of bind mount definitions. Each definition consists of a colon-separated triple of
981 source path, destination path and option string, where the latter two are optional. If only a source path is
982 specified the source and destination is taken to be the same. The option string may be either
983 <literal>rbind</literal> or <literal>norbind</literal> for configuring a recursive or non-recursive bind
984 mount. If the destination parth is omitted, the option string must be omitted too.</para>
985
986 <para><varname>BindPaths=</varname> creates regular writable bind mounts (unless the source file system mount
987 is already marked read-only), while <varname>BindReadOnlyPaths=</varname> creates read-only bind mounts. These
988 settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string
989 is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note
990 that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is
991 used.</para>
992
993 <para>This option is particularly useful when <varname>RootDirectory=</varname> is used. In this case the
994 source path refers to a path on the host file system, while the destination path referes to a path below the
995 root directory of the unit.</para></listitem>
996 </varlistentry>
997
998 <varlistentry>
999 <term><varname>PrivateTmp=</varname></term>
1000
1001 <listitem><para>Takes a boolean argument. If true, sets up a new file system namespace for the executed
1002 processes and mounts private <filename>/tmp</filename> and <filename>/var/tmp</filename> directories inside it
1003 that is not shared by processes outside of the namespace. This is useful to secure access to temporary files of
1004 the process, but makes sharing between processes via <filename>/tmp</filename> or <filename>/var/tmp</filename>
1005 impossible. If this is enabled, all temporary files created by a service in these directories will be removed
1006 after the service is stopped. Defaults to false. It is possible to run two or more units within the same
1007 private <filename>/tmp</filename> and <filename>/var/tmp</filename> namespace by using the
1008 <varname>JoinsNamespaceOf=</varname> directive, see
1009 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1010 details. This setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same
1011 restrictions regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and
1012 related calls, see above. Enabling this setting has the side effect of adding <varname>Requires=</varname> and
1013 <varname>After=</varname> dependencies on all mount units necessary to access <filename>/tmp</filename> and
1014 <filename>/var/tmp</filename>. Moreover an implicitly <varname>After=</varname> ordering on
1015 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1016 is added.</para></listitem>
1017 </varlistentry>
1018
1019 <varlistentry>
1020 <term><varname>PrivateDevices=</varname></term>
1021
1022 <listitem><para>Takes a boolean argument. If true, sets up a new /dev namespace for the executed processes and
1023 only adds API pseudo devices such as <filename>/dev/null</filename>, <filename>/dev/zero</filename> or
1024 <filename>/dev/random</filename> (as well as the pseudo TTY subsystem) to it, but no physical devices such as
1025 <filename>/dev/sda</filename>, system memory <filename>/dev/mem</filename>, system ports
1026 <filename>/dev/port</filename> and others. This is useful to securely turn off physical device access by the
1027 executed process. Defaults to false. Enabling this option will install a system call filter to block low-level
1028 I/O system calls that are grouped in the <varname>@raw-io</varname> set, will also remove
1029 <constant>CAP_MKNOD</constant> and <constant>CAP_SYS_RAWIO</constant> from the capability bounding set for
1030 the unit (see above), and set <varname>DevicePolicy=closed</varname> (see
1031 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1032 for details). Note that using this setting will disconnect propagation of mounts from the service to the host
1033 (propagation in the opposite direction continues to work). This means that this setting may not be used for
1034 services which shall be able to install mount points in the main mount namespace. The /dev namespace will be
1035 mounted read-only and 'noexec'. The latter may break old programs which try to set up executable memory by
1036 using <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> of
1037 <filename>/dev/zero</filename> instead of using <constant>MAP_ANON</constant>. This setting is implied if
1038 <varname>DynamicUser=</varname> is set. For this setting the same restrictions regarding mount propagation and
1039 privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
1040 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1041 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1042 is implied.
1043 </para></listitem>
1044 </varlistentry>
1045
1046 <varlistentry>
1047 <term><varname>PrivateNetwork=</varname></term>
1048
1049 <listitem><para>Takes a boolean argument. If true, sets up a
1050 new network namespace for the executed processes and
1051 configures only the loopback network device
1052 <literal>lo</literal> inside it. No other network devices will
1053 be available to the executed process. This is useful to
1054 securely turn off network access by the executed process.
1055 Defaults to false. It is possible to run two or more units
1056 within the same private network namespace by using the
1057 <varname>JoinsNamespaceOf=</varname> directive, see
1058 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1059 for details. Note that this option will disconnect all socket
1060 families from the host, this includes AF_NETLINK and AF_UNIX.
1061 The latter has the effect that AF_UNIX sockets in the abstract
1062 socket namespace will become unavailable to the processes
1063 (however, those located in the file system will continue to be
1064 accessible).</para></listitem>
1065 </varlistentry>
1066
1067 <varlistentry>
1068 <term><varname>PrivateUsers=</varname></term>
1069
1070 <listitem><para>Takes a boolean argument. If true, sets up a new user namespace for the executed processes and
1071 configures a minimal user and group mapping, that maps the <literal>root</literal> user and group as well as
1072 the unit's own user and group to themselves and everything else to the <literal>nobody</literal> user and
1073 group. This is useful to securely detach the user and group databases used by the unit from the rest of the
1074 system, and thus to create an effective sandbox environment. All files, directories, processes, IPC objects and
1075 other resources owned by users/groups not equaling <literal>root</literal> or the unit's own will stay visible
1076 from within the unit but appear owned by the <literal>nobody</literal> user and group. If this mode is enabled,
1077 all unit processes are run without privileges in the host user namespace (regardless if the unit's own
1078 user/group is <literal>root</literal> or not). Specifically this means that the process will have zero process
1079 capabilities on the host's user namespace, but full capabilities within the service's user namespace. Settings
1080 such as <varname>CapabilityBoundingSet=</varname> will affect only the latter, and there's no way to acquire
1081 additional capabilities in the host's user namespace. Defaults to off.</para>
1082
1083 <para>This setting is particularly useful in conjunction with <varname>RootDirectory=</varname>, as the need to
1084 synchronize the user and group databases in the root directory and on the host is reduced, as the only users
1085 and groups who need to be matched are <literal>root</literal>, <literal>nobody</literal> and the unit's own
1086 user and group.</para></listitem>
1087 </varlistentry>
1088
1089 <varlistentry>
1090 <term><varname>ProtectSystem=</varname></term>
1091
1092 <listitem><para>Takes a boolean argument or the special values <literal>full</literal> or
1093 <literal>strict</literal>. If true, mounts the <filename>/usr</filename> and <filename>/boot</filename>
1094 directories read-only for processes invoked by this unit. If set to <literal>full</literal>, the
1095 <filename>/etc</filename> directory is mounted read-only, too. If set to <literal>strict</literal> the entire
1096 file system hierarchy is mounted read-only, except for the API file system subtrees <filename>/dev</filename>,
1097 <filename>/proc</filename> and <filename>/sys</filename> (protect these directories using
1098 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1099 <varname>ProtectControlGroups=</varname>). This setting ensures that any modification of the vendor-supplied
1100 operating system (and optionally its configuration, and local mounts) is prohibited for the service. It is
1101 recommended to enable this setting for all long-running services, unless they are involved with system updates
1102 or need to modify the operating system in other ways. If this option is used,
1103 <varname>ReadWritePaths=</varname> may be used to exclude specific directories from being made read-only. This
1104 setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same restrictions regarding
1105 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
1106 above. Defaults to off.</para></listitem>
1107 </varlistentry>
1108
1109 <varlistentry>
1110 <term><varname>ProtectHome=</varname></term>
1111
1112 <listitem><para>Takes a boolean argument or <literal>read-only</literal>. If true, the directories
1113 <filename>/home</filename>, <filename>/root</filename> and <filename>/run/user</filename> are made inaccessible
1114 and empty for processes invoked by this unit. If set to <literal>read-only</literal>, the three directories are
1115 made read-only instead. It is recommended to enable this setting for all long-running services (in particular
1116 network-facing ones), to ensure they cannot get access to private user data, unless the services actually
1117 require access to the user's private data. This setting is implied if <varname>DynamicUser=</varname> is
1118 set. For this setting the same restrictions regarding mount propagation and privileges apply as for
1119 <varname>ReadOnlyPaths=</varname> and related calls, see above.</para></listitem>
1120 </varlistentry>
1121
1122 <varlistentry>
1123 <term><varname>ProtectKernelTunables=</varname></term>
1124
1125 <listitem><para>Takes a boolean argument. If true, kernel variables accessible through
1126 <filename>/proc/sys</filename>, <filename>/sys</filename>, <filename>/proc/sysrq-trigger</filename>,
1127 <filename>/proc/latency_stats</filename>, <filename>/proc/acpi</filename>,
1128 <filename>/proc/timer_stats</filename>, <filename>/proc/fs</filename> and <filename>/proc/irq</filename> will
1129 be made read-only to all processes of the unit. Usually, tunable kernel variables should only be written at
1130 boot-time, with the <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1131 mechanism. Almost no services need to write to these at runtime; it is hence recommended to turn this on for
1132 most services. For this setting the same restrictions regarding mount propagation and privileges apply as for
1133 <varname>ReadOnlyPaths=</varname> and related calls, see above. Defaults to off.
1134 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1135 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1136 is implied. Note that this option does not prevent kernel tuning through IPC interfaces
1137 and external programs. However <varname>InaccessiblePaths=</varname> can be used to
1138 make some IPC file system objects inaccessible.</para></listitem>
1139 </varlistentry>
1140
1141 <varlistentry>
1142 <term><varname>ProtectKernelModules=</varname></term>
1143
1144 <listitem><para>Takes a boolean argument. If true, explicit module loading will
1145 be denied. This allows to turn off module load and unload operations on modular
1146 kernels. It is recommended to turn this on for most services that do not need special
1147 file systems or extra kernel modules to work. Default to off. Enabling this option
1148 removes <constant>CAP_SYS_MODULE</constant> from the capability bounding set for
1149 the unit, and installs a system call filter to block module system calls,
1150 also <filename>/usr/lib/modules</filename> is made inaccessible. For this
1151 setting the same restrictions regarding mount propagation and privileges
1152 apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
1153 Note that limited automatic module loading due to user configuration or kernel
1154 mapping tables might still happen as side effect of requested user operations,
1155 both privileged and unprivileged. To disable module auto-load feature please see
1156 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1157 <constant>kernel.modules_disabled</constant> mechanism and
1158 <filename>/proc/sys/kernel/modules_disabled</filename> documentation.
1159 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1160 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1161 is implied.
1162 </para></listitem>
1163 </varlistentry>
1164
1165 <varlistentry>
1166 <term><varname>ProtectControlGroups=</varname></term>
1167
1168 <listitem><para>Takes a boolean argument. If true, the Linux Control Groups (<citerefentry
1169 project='man-pages'><refentrytitle>cgroups</refentrytitle><manvolnum>7</manvolnum></citerefentry>) hierarchies
1170 accessible through <filename>/sys/fs/cgroup</filename> will be made read-only to all processes of the
1171 unit. Except for container managers no services should require write access to the control groups hierarchies;
1172 it is hence recommended to turn this on for most services. For this setting the same restrictions regarding
1173 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
1174 above. Defaults to off.</para></listitem>
1175 </varlistentry>
1176
1177 <varlistentry>
1178 <term><varname>MountFlags=</varname></term>
1179
1180 <listitem><para>Takes a mount propagation flag: <option>shared</option>, <option>slave</option> or
1181 <option>private</option>, which control whether mounts in the file system namespace set up for this unit's
1182 processes will receive or propagate mounts and unmounts. See <citerefentry
1183 project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
1184 details. Defaults to <option>shared</option>. Use <option>shared</option> to ensure that mounts and unmounts
1185 are propagated from systemd's namespace to the service's namespace and vice versa. Use <option>slave</option>
1186 to run processes so that none of their mounts and unmounts will propagate to the host. Use <option>private</option>
1187 to also ensure that no mounts and unmounts from the host will propagate into the unit processes' namespace.
1188 If this is set to <option>slave</option> or <option>private</option>, any mounts created by spawned processes
1189 will be unmounted after the completion of the current command line of <varname>ExecStartPre=</varname>,
1190 <varname>ExecStartPost=</varname>, <varname>ExecStart=</varname>,
1191 and <varname>ExecStopPost=</varname>. Note that
1192 <option>slave</option> means that file systems mounted on the host might stay mounted continuously in the
1193 unit's namespace, and thus keep the device busy. Note that the file system namespace related options
1194 (<varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>,
1195 <varname>ProtectHome=</varname>, <varname>ProtectKernelTunables=</varname>,
1196 <varname>ProtectControlGroups=</varname>, <varname>ReadOnlyPaths=</varname>,
1197 <varname>InaccessiblePaths=</varname>, <varname>ReadWritePaths=</varname>) require that mount and unmount
1198 propagation from the unit's file system namespace is disabled, and hence downgrade <option>shared</option> to
1199 <option>slave</option>. </para></listitem>
1200 </varlistentry>
1201
1202 <varlistentry>
1203 <term><varname>UtmpIdentifier=</varname></term>
1204
1205 <listitem><para>Takes a four character identifier string for
1206 an <citerefentry
1207 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1208 and wtmp entry for this service. This should only be
1209 set for services such as <command>getty</command>
1210 implementations (such as <citerefentry
1211 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1212 where utmp/wtmp entries must be created and cleared before and
1213 after execution, or for services that shall be executed as if
1214 they were run by a <command>getty</command> process (see
1215 below). If the configured string is longer than four
1216 characters, it is truncated and the terminal four characters
1217 are used. This setting interprets %I style string
1218 replacements. This setting is unset by default, i.e. no
1219 utmp/wtmp entries are created or cleaned up for this
1220 service.</para></listitem>
1221 </varlistentry>
1222
1223 <varlistentry>
1224 <term><varname>UtmpMode=</varname></term>
1225
1226 <listitem><para>Takes one of <literal>init</literal>,
1227 <literal>login</literal> or <literal>user</literal>. If
1228 <varname>UtmpIdentifier=</varname> is set, controls which
1229 type of <citerefentry
1230 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp
1231 entries for this service are generated. This setting has no
1232 effect unless <varname>UtmpIdentifier=</varname> is set
1233 too. If <literal>init</literal> is set, only an
1234 <constant>INIT_PROCESS</constant> entry is generated and the
1235 invoked process must implement a
1236 <command>getty</command>-compatible utmp/wtmp logic. If
1237 <literal>login</literal> is set, first an
1238 <constant>INIT_PROCESS</constant> entry, followed by a
1239 <constant>LOGIN_PROCESS</constant> entry is generated. In
1240 this case, the invoked process must implement a <citerefentry
1241 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
1242 utmp/wtmp logic. If <literal>user</literal> is set, first an
1243 <constant>INIT_PROCESS</constant> entry, then a
1244 <constant>LOGIN_PROCESS</constant> entry and finally a
1245 <constant>USER_PROCESS</constant> entry is generated. In this
1246 case, the invoked process may be any process that is suitable
1247 to be run as session leader. Defaults to
1248 <literal>init</literal>.</para></listitem>
1249 </varlistentry>
1250
1251 <varlistentry>
1252 <term><varname>SELinuxContext=</varname></term>
1253
1254 <listitem><para>Set the SELinux security context of the
1255 executed process. If set, this will override the automated
1256 domain transition. However, the policy still needs to
1257 authorize the transition. This directive is ignored if SELinux
1258 is disabled. If prefixed by <literal>-</literal>, all errors
1259 will be ignored. This does not affect commands prefixed with <literal>+</literal>.
1260 See <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1261 for details.</para></listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265 <term><varname>AppArmorProfile=</varname></term>
1266
1267 <listitem><para>Takes a profile name as argument. The process
1268 executed by the unit will switch to this profile when started.
1269 Profiles must already be loaded in the kernel, or the unit
1270 will fail. This result in a non operation if AppArmor is not
1271 enabled. If prefixed by <literal>-</literal>, all errors will
1272 be ignored. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
1273 </varlistentry>
1274
1275 <varlistentry>
1276 <term><varname>SmackProcessLabel=</varname></term>
1277
1278 <listitem><para>Takes a <option>SMACK64</option> security
1279 label as argument. The process executed by the unit will be
1280 started under this label and SMACK will decide whether the
1281 process is allowed to run or not, based on it. The process
1282 will continue to run under the label specified here unless the
1283 executable has its own <option>SMACK64EXEC</option> label, in
1284 which case the process will transition to run under that
1285 label. When not specified, the label that systemd is running
1286 under is used. This directive is ignored if SMACK is
1287 disabled.</para>
1288
1289 <para>The value may be prefixed by <literal>-</literal>, in
1290 which case all errors will be ignored. An empty value may be
1291 specified to unset previous assignments. This does not affect
1292 commands prefixed with <literal>+</literal>.</para>
1293 </listitem>
1294 </varlistentry>
1295
1296 <varlistentry>
1297 <term><varname>IgnoreSIGPIPE=</varname></term>
1298
1299 <listitem><para>Takes a boolean argument. If true, causes
1300 <constant>SIGPIPE</constant> to be ignored in the executed
1301 process. Defaults to true because <constant>SIGPIPE</constant>
1302 generally is useful only in shell pipelines.</para></listitem>
1303 </varlistentry>
1304
1305 <varlistentry>
1306 <term><varname>NoNewPrivileges=</varname></term>
1307
1308 <listitem><para>Takes a boolean argument. If true, ensures that the service process and all its children can
1309 never gain new privileges through <function>execve()</function> (e.g. via setuid or setgid bits, or filesystem
1310 capabilities). This is the simplest and most effective way to ensure that a process and its children can never
1311 elevate privileges again. Defaults to false, but certain settings force
1312 <varname>NoNewPrivileges=yes</varname>, ignoring the value of this setting. This is the case when
1313 <varname>SystemCallFilter=</varname>, <varname>SystemCallArchitectures=</varname>,
1314 <varname>RestrictAddressFamilies=</varname>, <varname>RestrictNamespaces=</varname>,
1315 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1316 <varname>ProtectKernelModules=</varname>, <varname>MemoryDenyWriteExecute=</varname>, or
1317 <varname>RestrictRealtime=</varname> are specified.</para></listitem>
1318 </varlistentry>
1319
1320 <varlistentry>
1321 <term><varname>SystemCallFilter=</varname></term>
1322
1323 <listitem><para>Takes a space-separated list of system call names. If this setting is used, all system calls
1324 executed by the unit processes except for the listed ones will result in immediate process termination with the
1325 <constant>SIGSYS</constant> signal (whitelisting). If the first character of the list is <literal>~</literal>,
1326 the effect is inverted: only the listed system calls will result in immediate process termination
1327 (blacklisting). If running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1328 capability (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is
1329 implied. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel ('seccomp filtering')
1330 and is useful for enforcing a minimal sandboxing environment. Note that the <function>execve</function>,
1331 <function>exit</function>, <function>exit_group</function>, <function>getrlimit</function>,
1332 <function>rt_sigreturn</function>, <function>sigreturn</function> system calls and the system calls for
1333 querying time and sleeping are implicitly whitelisted and do not need to be listed explicitly. This option may
1334 be specified more than once, in which case the filter masks are merged. If the empty string is assigned, the
1335 filter is reset, all prior assignments will have no effect. This does not affect commands prefixed with
1336 <literal>+</literal>.</para>
1337
1338 <para>Note that strict system call filters may impact execution and error handling code paths of the service
1339 invocation. Specifically, access to the <function>execve</function> system call is required for the execution
1340 of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the
1341 service binary fails for some reason (for example: missing service executable), the error handling logic might
1342 require access to an additional set of system calls in order to process and log this failure correctly. It
1343 might be necessary to temporarily disable system call filters in order to simplify debugging of such
1344 failures.</para>
1345
1346 <para>If you specify both types of this option (i.e.
1347 whitelisting and blacklisting), the first encountered will
1348 take precedence and will dictate the default action
1349 (termination or approval of a system call). Then the next
1350 occurrences of this option will add or delete the listed
1351 system calls from the set of the filtered system calls,
1352 depending of its type and the default action. (For example, if
1353 you have started with a whitelisting of
1354 <function>read</function> and <function>write</function>, and
1355 right after it add a blacklisting of
1356 <function>write</function>, then <function>write</function>
1357 will be removed from the set.)</para>
1358
1359 <para>As the number of possible system
1360 calls is large, predefined sets of system calls are provided.
1361 A set starts with <literal>@</literal> character, followed by
1362 name of the set.
1363
1364 <table>
1365 <title>Currently predefined system call sets</title>
1366
1367 <tgroup cols='2'>
1368 <colspec colname='set' />
1369 <colspec colname='description' />
1370 <thead>
1371 <row>
1372 <entry>Set</entry>
1373 <entry>Description</entry>
1374 </row>
1375 </thead>
1376 <tbody>
1377 <row>
1378 <entry>@basic-io</entry>
1379 <entry>System calls for basic I/O: reading, writing, seeking, file descriptor duplication and closing (<citerefentry project='man-pages'><refentrytitle>read</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>write</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1380 </row>
1381 <row>
1382 <entry>@clock</entry>
1383 <entry>System calls for changing the system clock (<citerefentry project='man-pages'><refentrytitle>adjtimex</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>settimeofday</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1384 </row>
1385 <row>
1386 <entry>@cpu-emulation</entry>
1387 <entry>System calls for CPU emulation functionality (<citerefentry project='man-pages'><refentrytitle>vm86</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1388 </row>
1389 <row>
1390 <entry>@debug</entry>
1391 <entry>Debugging, performance monitoring and tracing functionality (<citerefentry project='man-pages'><refentrytitle>ptrace</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>perf_event_open</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1392 </row>
1393 <row>
1394 <entry>@file-system</entry>
1395 <entry>File system operations: opening, creating files and directories for read and write, renaming and removing them, reading file properties, or creating hard and symbolic links.</entry>
1396 </row>
1397 <row>
1398 <entry>@io-event</entry>
1399 <entry>Event loop system calls (<citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>eventfd</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1400 </row>
1401 <row>
1402 <entry>@ipc</entry>
1403 <entry>Pipes, SysV IPC, POSIX Message Queues and other IPC (<citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>svipc</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
1404 </row>
1405 <row>
1406 <entry>@keyring</entry>
1407 <entry>Kernel keyring access (<citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1408 </row>
1409 <row>
1410 <entry>@module</entry>
1411 <entry>Loading and unloading of kernel modules (<citerefentry project='man-pages'><refentrytitle>init_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>delete_module</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1412 </row>
1413 <row>
1414 <entry>@mount</entry>
1415 <entry>Mounting and unmounting of file systems (<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1416 </row>
1417 <row>
1418 <entry>@network-io</entry>
1419 <entry>Socket I/O (including local AF_UNIX): <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></entry>
1420 </row>
1421 <row>
1422 <entry>@obsolete</entry>
1423 <entry>Unusual, obsolete or unimplemented (<citerefentry project='man-pages'><refentrytitle>create_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>gtty</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1424 </row>
1425 <row>
1426 <entry>@privileged</entry>
1427 <entry>All system calls which need super-user capabilities (<citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
1428 </row>
1429 <row>
1430 <entry>@process</entry>
1431 <entry>Process control, execution, namespaceing operations (<citerefentry project='man-pages'><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>, …</entry>
1432 </row>
1433 <row>
1434 <entry>@raw-io</entry>
1435 <entry>Raw I/O port access (<citerefentry project='man-pages'><refentrytitle>ioperm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>iopl</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>pciconfig_read()</function>, …)</entry>
1436 </row>
1437 <row>
1438 <entry>@resources</entry>
1439 <entry>System calls for changing resource limits, memory and scheduling parameters (<citerefentry project='man-pages'><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1440 </row>
1441 </tbody>
1442 </tgroup>
1443 </table>
1444
1445 Note, that as new system calls are added to the kernel, additional system calls might be
1446 added to the groups above. Contents of the sets may also change between systemd
1447 versions. In addition, the list of system calls depends on the kernel version and
1448 architecture for which systemd was compiled. Use
1449 <command>systemd-analyze syscall-filter</command> to list the actual list of system calls in
1450 each filter.
1451 </para>
1452
1453 <para>It is recommended to combine the file system namespacing related options with
1454 <varname>SystemCallFilter=~@mount</varname>, in order to prohibit the unit's processes to undo the
1455 mappings. Specifically these are the options <varname>PrivateTmp=</varname>,
1456 <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, <varname>ProtectHome=</varname>,
1457 <varname>ProtectKernelTunables=</varname>, <varname>ProtectControlGroups=</varname>,
1458 <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname> and
1459 <varname>ReadWritePaths=</varname>.</para></listitem>
1460 </varlistentry>
1461
1462 <varlistentry>
1463 <term><varname>SystemCallErrorNumber=</varname></term>
1464
1465 <listitem><para>Takes an <literal>errno</literal> error number
1466 name to return when the system call filter configured with
1467 <varname>SystemCallFilter=</varname> is triggered, instead of
1468 terminating the process immediately. Takes an error name such
1469 as <constant>EPERM</constant>, <constant>EACCES</constant> or
1470 <constant>EUCLEAN</constant>. When this setting is not used,
1471 or when the empty string is assigned, the process will be
1472 terminated immediately when the filter is
1473 triggered.</para></listitem>
1474 </varlistentry>
1475
1476 <varlistentry>
1477 <term><varname>SystemCallArchitectures=</varname></term>
1478
1479 <listitem><para>Takes a space-separated list of architecture identifiers to
1480 include in the system call filter. The known architecture identifiers are the same
1481 as for <varname>ConditionArchitecture=</varname> described in
1482 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1483 as well as <constant>x32</constant>, <constant>mips64-n32</constant>,
1484 <constant>mips64-le-n32</constant>, and the special identifier
1485 <constant>native</constant>. Only system calls of the specified architectures will
1486 be permitted to processes of this unit. This is an effective way to disable
1487 compatibility with non-native architectures for processes, for example to prohibit
1488 execution of 32-bit x86 binaries on 64-bit x86-64 systems. The special
1489 <constant>native</constant> identifier implicitly maps to the native architecture
1490 of the system (or more strictly: to the architecture the system manager is
1491 compiled for). If running in user mode, or in system mode, but without the
1492 <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1493 <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is
1494 implied. Note that setting this option to a non-empty list implies that
1495 <constant>native</constant> is included too. By default, this option is set to the
1496 empty list, i.e. no architecture system call filtering is applied.
1497 </para></listitem>
1498 </varlistentry>
1499
1500 <varlistentry>
1501 <term><varname>RestrictAddressFamilies=</varname></term>
1502
1503 <listitem><para>Restricts the set of socket address families
1504 accessible to the processes of this unit. Takes a
1505 space-separated list of address family names to whitelist,
1506 such as
1507 <constant>AF_UNIX</constant>,
1508 <constant>AF_INET</constant> or
1509 <constant>AF_INET6</constant>. When
1510 prefixed with <constant>~</constant> the listed address
1511 families will be applied as blacklist, otherwise as whitelist.
1512 Note that this restricts access to the
1513 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1514 system call only. Sockets passed into the process by other
1515 means (for example, by using socket activation with socket
1516 units, see
1517 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1518 are unaffected. Also, sockets created with
1519 <function>socketpair()</function> (which creates connected
1520 AF_UNIX sockets only) are unaffected. Note that this option
1521 has no effect on 32-bit x86 and is ignored (but works
1522 correctly on x86-64). If running in user mode, or in system
1523 mode, but without the <constant>CAP_SYS_ADMIN</constant>
1524 capability (e.g. setting <varname>User=nobody</varname>),
1525 <varname>NoNewPrivileges=yes</varname> is implied. By
1526 default, no restriction applies, all address families are
1527 accessible to processes. If assigned the empty string, any
1528 previous list changes are undone.</para>
1529
1530 <para>Use this option to limit exposure of processes to remote
1531 systems, in particular via exotic network protocols. Note that
1532 in most cases, the local <constant>AF_UNIX</constant> address
1533 family should be included in the configured whitelist as it is
1534 frequently used for local communication, including for
1535 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1536 logging. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
1537 </varlistentry>
1538
1539 <varlistentry>
1540 <term><varname>RestrictNamespaces=</varname></term>
1541
1542 <listitem><para>Restricts access to Linux namespace functionality for the processes of this unit. For details
1543 about Linux namespaces, see
1544 <citerefentry><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Either takes a
1545 boolean argument, or a space-separated list of namespace type identifiers. If false (the default), no
1546 restrictions on namespace creation and switching are made. If true, access to any kind of namespacing is
1547 prohibited. Otherwise, a space-separated list of namespace type identifiers must be specified, consisting of
1548 any combination of: <constant>cgroup</constant>, <constant>ipc</constant>, <constant>net</constant>,
1549 <constant>mnt</constant>, <constant>pid</constant>, <constant>user</constant> and <constant>uts</constant>. Any
1550 namespace type listed is made accessible to the unit's processes, access to namespace types not listed is
1551 prohibited (whitelisting). By prepending the list with a single tilda character (<literal>~</literal>) the
1552 effect may be inverted: only the listed namespace types will be made inaccessible, all unlisted ones are
1553 permitted (blacklisting). If the empty string is assigned, the default namespace restrictions are applied,
1554 which is equivalent to false. Internally, this setting limits access to the
1555 <citerefentry><refentrytitle>unshare</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
1556 <citerefentry><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry> and
1557 <citerefentry><refentrytitle>setns</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls, taking
1558 the specified flags parameters into account. Note that — if this option is used — in addition to restricting
1559 creation and switching of the specified types of namespaces (or all of them, if true) access to the
1560 <function>setns()</function> system call with a zero flags parameter is prohibited.
1561 If running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1562 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1563 is implied.
1564 </para></listitem>
1565 </varlistentry>
1566
1567 <varlistentry>
1568 <term><varname>Personality=</varname></term>
1569
1570 <listitem><para>Controls which kernel architecture <citerefentry
1571 project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall report,
1572 when invoked by unit processes. Takes one of the architecture identifiers <constant>x86</constant>,
1573 <constant>x86-64</constant>, <constant>ppc</constant>, <constant>ppc-le</constant>, <constant>ppc64</constant>,
1574 <constant>ppc64-le</constant>, <constant>s390</constant> or <constant>s390x</constant>. Which personality
1575 architectures are supported depends on the system architecture. Usually the 64bit versions of the various
1576 system architectures support their immediate 32bit personality architecture counterpart, but no others. For
1577 example, <constant>x86-64</constant> systems support the <constant>x86-64</constant> and
1578 <constant>x86</constant> personalities but no others. The personality feature is useful when running 32-bit
1579 services on a 64-bit host system. If not specified, the personality is left unmodified and thus reflects the
1580 personality of the host system's kernel.</para></listitem>
1581 </varlistentry>
1582
1583 <varlistentry>
1584 <term><varname>RuntimeDirectory=</varname></term>
1585 <term><varname>RuntimeDirectoryMode=</varname></term>
1586
1587 <listitem><para>Takes a list of directory names. If set, one
1588 or more directories by the specified names will be created
1589 below <filename>/run</filename> (for system services) or below
1590 <varname>$XDG_RUNTIME_DIR</varname> (for user services) when
1591 the unit is started, and removed when the unit is stopped. The
1592 directories will have the access mode specified in
1593 <varname>RuntimeDirectoryMode=</varname>, and will be owned by
1594 the user and group specified in <varname>User=</varname> and
1595 <varname>Group=</varname>. Use this to manage one or more
1596 runtime directories of the unit and bind their lifetime to the
1597 daemon runtime. The specified directory names must be
1598 relative, and may not include a <literal>/</literal>, i.e.
1599 must refer to simple directories to create or remove. This is
1600 particularly useful for unprivileged daemons that cannot
1601 create runtime directories in <filename>/run</filename> due to
1602 lack of privileges, and to make sure the runtime directory is
1603 cleaned up automatically after use. For runtime directories
1604 that require more complex or different configuration or
1605 lifetime guarantees, please consider using
1606 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
1607 </varlistentry>
1608
1609 <varlistentry>
1610 <term><varname>MemoryDenyWriteExecute=</varname></term>
1611
1612 <listitem><para>Takes a boolean argument. If set, attempts to create memory mappings that are writable and
1613 executable at the same time, or to change existing memory mappings to become executable, or mapping shared memory
1614 segments as executable are prohibited.
1615 Specifically, a system call filter is added that rejects
1616 <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1617 system calls with both <constant>PROT_EXEC</constant> and <constant>PROT_WRITE</constant> set,
1618 <citerefentry><refentrytitle>mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1619 system calls with <constant>PROT_EXEC</constant> set and
1620 <citerefentry><refentrytitle>shmat</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1621 system calls with <constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs
1622 that generate program code dynamically at runtime, such as JIT execution engines, or programs compiled making
1623 use of the code "trampoline" feature of various C compilers. This option improves service security, as it makes
1624 harder for software exploits to change running code dynamically.
1625 If running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1626 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1627 is implied.
1628 </para></listitem>
1629 </varlistentry>
1630
1631 <varlistentry>
1632 <term><varname>RestrictRealtime=</varname></term>
1633
1634 <listitem><para>Takes a boolean argument. If set, any attempts to enable realtime scheduling in a process of
1635 the unit are refused. This restricts access to realtime task scheduling policies such as
1636 <constant>SCHED_FIFO</constant>, <constant>SCHED_RR</constant> or <constant>SCHED_DEADLINE</constant>. See
1637 <citerefentry project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details about
1638 these scheduling policies. If running in user mode, or in system mode, but
1639 without the <constant>CAP_SYS_ADMIN</constant> capability
1640 (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1641 is implied. Realtime scheduling policies may be used to monopolize CPU time for longer periods
1642 of time, and may hence be used to lock up or otherwise trigger Denial-of-Service situations on the system. It
1643 is hence recommended to restrict access to realtime scheduling to the few programs that actually require
1644 them. Defaults to off.</para></listitem>
1645 </varlistentry>
1646
1647 </variablelist>
1648 </refsect1>
1649
1650 <refsect1>
1651 <title>Environment variables in spawned processes</title>
1652
1653 <para>Processes started by the system are executed in a clean
1654 environment in which select variables listed below are set. System
1655 processes started by systemd do not inherit variables from PID 1,
1656 but processes started by user systemd instances inherit all
1657 environment variables from the user systemd instance.
1658 </para>
1659
1660 <variablelist class='environment-variables'>
1661 <varlistentry>
1662 <term><varname>$PATH</varname></term>
1663
1664 <listitem><para>Colon-separated list of directories to use
1665 when launching executables. Systemd uses a fixed value of
1666 <filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename>:<filename>/sbin</filename>:<filename>/bin</filename>.
1667 </para></listitem>
1668 </varlistentry>
1669
1670 <varlistentry>
1671 <term><varname>$LANG</varname></term>
1672
1673 <listitem><para>Locale. Can be set in
1674 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1675 or on the kernel command line (see
1676 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1677 and
1678 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
1679 </para></listitem>
1680 </varlistentry>
1681
1682 <varlistentry>
1683 <term><varname>$USER</varname></term>
1684 <term><varname>$LOGNAME</varname></term>
1685 <term><varname>$HOME</varname></term>
1686 <term><varname>$SHELL</varname></term>
1687
1688 <listitem><para>User name (twice), home directory, and the
1689 login shell. The variables are set for the units that have
1690 <varname>User=</varname> set, which includes user
1691 <command>systemd</command> instances. See
1692 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1693 </para></listitem>
1694 </varlistentry>
1695
1696 <varlistentry>
1697 <term><varname>$INVOCATION_ID</varname></term>
1698
1699 <listitem><para>Contains a randomized, unique 128bit ID identifying each runtime cycle of the unit, formatted
1700 as 32 character hexadecimal string. A new ID is assigned each time the unit changes from an inactive state into
1701 an activating or active state, and may be used to identify this specific runtime cycle, in particular in data
1702 stored offline, such as the journal. The same ID is passed to all processes run as part of the
1703 unit.</para></listitem>
1704 </varlistentry>
1705
1706 <varlistentry>
1707 <term><varname>$XDG_RUNTIME_DIR</varname></term>
1708
1709 <listitem><para>The directory for volatile state. Set for the
1710 user <command>systemd</command> instance, and also in user
1711 sessions. See
1712 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1713 </para></listitem>
1714 </varlistentry>
1715
1716 <varlistentry>
1717 <term><varname>$XDG_SESSION_ID</varname></term>
1718 <term><varname>$XDG_SEAT</varname></term>
1719 <term><varname>$XDG_VTNR</varname></term>
1720
1721 <listitem><para>The identifier of the session, the seat name,
1722 and virtual terminal of the session. Set by
1723 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1724 for login sessions. <varname>$XDG_SEAT</varname> and
1725 <varname>$XDG_VTNR</varname> will only be set when attached to
1726 a seat and a tty.</para></listitem>
1727 </varlistentry>
1728
1729 <varlistentry>
1730 <term><varname>$MAINPID</varname></term>
1731
1732 <listitem><para>The PID of the unit's main process if it is
1733 known. This is only set for control processes as invoked by
1734 <varname>ExecReload=</varname> and similar. </para></listitem>
1735 </varlistentry>
1736
1737 <varlistentry>
1738 <term><varname>$MANAGERPID</varname></term>
1739
1740 <listitem><para>The PID of the user <command>systemd</command>
1741 instance, set for processes spawned by it. </para></listitem>
1742 </varlistentry>
1743
1744 <varlistentry>
1745 <term><varname>$LISTEN_FDS</varname></term>
1746 <term><varname>$LISTEN_PID</varname></term>
1747 <term><varname>$LISTEN_FDNAMES</varname></term>
1748
1749 <listitem><para>Information about file descriptors passed to a
1750 service for socket activation. See
1751 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1752 </para></listitem>
1753 </varlistentry>
1754
1755 <varlistentry>
1756 <term><varname>$NOTIFY_SOCKET</varname></term>
1757
1758 <listitem><para>The socket
1759 <function>sd_notify()</function> talks to. See
1760 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1761 </para></listitem>
1762 </varlistentry>
1763
1764 <varlistentry>
1765 <term><varname>$WATCHDOG_PID</varname></term>
1766 <term><varname>$WATCHDOG_USEC</varname></term>
1767
1768 <listitem><para>Information about watchdog keep-alive notifications. See
1769 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1770 </para></listitem>
1771 </varlistentry>
1772
1773 <varlistentry>
1774 <term><varname>$TERM</varname></term>
1775
1776 <listitem><para>Terminal type, set only for units connected to
1777 a terminal (<varname>StandardInput=tty</varname>,
1778 <varname>StandardOutput=tty</varname>, or
1779 <varname>StandardError=tty</varname>). See
1780 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1781 </para></listitem>
1782 </varlistentry>
1783
1784 <varlistentry>
1785 <term><varname>$JOURNAL_STREAM</varname></term>
1786
1787 <listitem><para>If the standard output or standard error output of the executed processes are connected to the
1788 journal (for example, by setting <varname>StandardError=journal</varname>) <varname>$JOURNAL_STREAM</varname>
1789 contains the device and inode numbers of the connection file descriptor, formatted in decimal, separated by a
1790 colon (<literal>:</literal>). This permits invoked processes to safely detect whether their standard output or
1791 standard error output are connected to the journal. The device and inode numbers of the file descriptors should
1792 be compared with the values set in the environment variable to determine whether the process output is still
1793 connected to the journal. Note that it is generally not sufficient to only check whether
1794 <varname>$JOURNAL_STREAM</varname> is set at all as services might invoke external processes replacing their
1795 standard output or standard error output, without unsetting the environment variable.</para>
1796
1797 <para>This environment variable is primarily useful to allow services to optionally upgrade their used log
1798 protocol to the native journal protocol (using
1799 <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other
1800 functions) if their standard output or standard error output is connected to the journal anyway, thus enabling
1801 delivery of structured metadata along with logged messages.</para></listitem>
1802 </varlistentry>
1803
1804 <varlistentry>
1805 <term><varname>$SERVICE_RESULT</varname></term>
1806
1807 <listitem><para>Only defined for the service unit type, this environment variable is passed to all
1808 <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
1809 "result". Currently, the following values are defined: <literal>protocol</literal> (in case of a protocol
1810 violation; if a service did not take the steps required by its unit configuration), <literal>timeout</literal>
1811 (in case of an operation timeout), <literal>exit-code</literal> (if a service process exited with a non-zero
1812 exit code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned), <literal>signal</literal>
1813 (if a service process was terminated abnormally by a signal; see <varname>$EXIT_CODE</varname> below for the
1814 actual signal used for the termination), <literal>core-dump</literal> (if a service process terminated
1815 abnormally and dumped core), <literal>watchdog</literal> (if the watchdog keep-alive ping was enabled for the
1816 service but it missed the deadline), or <literal>resources</literal> (a catch-all condition in case a system
1817 operation failed).</para>
1818
1819 <para>This environment variable is useful to monitor failure or successful termination of a service. Even
1820 though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it
1821 is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services
1822 that managed to start up correctly, and the latter covers both services that failed during their start-up and
1823 those which failed during their runtime.</para></listitem>
1824 </varlistentry>
1825
1826 <varlistentry>
1827 <term><varname>$EXIT_CODE</varname></term>
1828 <term><varname>$EXIT_STATUS</varname></term>
1829
1830 <listitem><para>Only defined for the service unit type, these environment variables are passed to all
1831 <varname>ExecStop=</varname>, <varname>ExecStopPost=</varname> processes and contain exit status/code
1832 information of the main process of the service. For the precise definition of the exit code and status, see
1833 <citerefentry><refentrytitle>wait</refentrytitle><manvolnum>2</manvolnum></citerefentry>. <varname>$EXIT_CODE</varname>
1834 is one of <literal>exited</literal>, <literal>killed</literal>,
1835 <literal>dumped</literal>. <varname>$EXIT_STATUS</varname> contains the numeric exit code formatted as string
1836 if <varname>$EXIT_CODE</varname> is <literal>exited</literal>, and the signal name in all other cases. Note
1837 that these environment variables are only set if the service manager succeeded to start and identify the main
1838 process of the service.</para>
1839
1840 <table>
1841 <title>Summary of possible service result variable values</title>
1842 <tgroup cols='3'>
1843 <colspec colname='result' />
1844 <colspec colname='code' />
1845 <colspec colname='status' />
1846 <thead>
1847 <row>
1848 <entry><varname>$SERVICE_RESULT</varname></entry>
1849 <entry><varname>$EXIT_CODE</varname></entry>
1850 <entry><varname>$EXIT_STATUS</varname></entry>
1851 </row>
1852 </thead>
1853
1854 <tbody>
1855 <row>
1856 <entry morerows="1" valign="top"><literal>protocol</literal></entry>
1857 <entry valign="top">not set</entry>
1858 <entry>not set</entry>
1859 </row>
1860 <row>
1861 <entry><literal>exited</literal></entry>
1862 <entry><literal>0</literal></entry>
1863 </row>
1864
1865 <row>
1866 <entry morerows="1" valign="top"><literal>timeout</literal></entry>
1867 <entry valign="top"><literal>killed</literal></entry>
1868 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
1869 </row>
1870 <row>
1871 <entry valign="top"><literal>exited</literal></entry>
1872 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
1873 >3</literal>, …, <literal>255</literal></entry>
1874 </row>
1875
1876 <row>
1877 <entry valign="top"><literal>exit-code</literal></entry>
1878 <entry valign="top"><literal>exited</literal></entry>
1879 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
1880 >3</literal>, …, <literal>255</literal></entry>
1881 </row>
1882
1883 <row>
1884 <entry valign="top"><literal>signal</literal></entry>
1885 <entry valign="top"><literal>killed</literal></entry>
1886 <entry><literal>HUP</literal>, <literal>INT</literal>, <literal>KILL</literal>, …</entry>
1887 </row>
1888
1889 <row>
1890 <entry valign="top"><literal>core-dump</literal></entry>
1891 <entry valign="top"><literal>dumped</literal></entry>
1892 <entry><literal>ABRT</literal>, <literal>SEGV</literal>, <literal>QUIT</literal>, …</entry>
1893 </row>
1894
1895 <row>
1896 <entry morerows="2" valign="top"><literal>watchdog</literal></entry>
1897 <entry><literal>dumped</literal></entry>
1898 <entry><literal>ABRT</literal></entry>
1899 </row>
1900 <row>
1901 <entry><literal>killed</literal></entry>
1902 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
1903 </row>
1904 <row>
1905 <entry><literal>exited</literal></entry>
1906 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
1907 >3</literal>, …, <literal>255</literal></entry>
1908 </row>
1909
1910 <row>
1911 <entry><literal>resources</literal></entry>
1912 <entry>any of the above</entry>
1913 <entry>any of the above</entry>
1914 </row>
1915
1916 <row>
1917 <entry namest="results" nameend="code">Note: the process may be also terminated by a signal not sent by systemd. In particular the process may send an arbitrary signal to itself in a handler for any of the non-maskable signals. Nevertheless, in the <literal>timeout</literal> and <literal>watchdog</literal> rows above only the signals that systemd sends have been included.</entry>
1918 </row>
1919 </tbody>
1920 </tgroup>
1921 </table>
1922
1923 </listitem>
1924 </varlistentry>
1925 </variablelist>
1926
1927 <para>Additional variables may be configured by the following
1928 means: for processes spawned in specific units, use the
1929 <varname>Environment=</varname>, <varname>EnvironmentFile=</varname>
1930 and <varname>PassEnvironment=</varname> options above; to specify
1931 variables globally, use <varname>DefaultEnvironment=</varname>
1932 (see
1933 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1934 or the kernel option <varname>systemd.setenv=</varname> (see
1935 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1936 Additional variables may also be set through PAM,
1937 cf. <citerefentry project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
1938 </refsect1>
1939
1940 <refsect1>
1941 <title>See Also</title>
1942 <para>
1943 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1944 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1945 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1946 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1947 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1948 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1949 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1950 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1951 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1952 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1953 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1954 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1955 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1956 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1957 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1958 </para>
1959 </refsect1>
1960
1961
1962 </refentry>