]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.exec.xml
man: document that PAMName= and NotifyAccess=all don't mix well.
[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>Implicit Dependencies</title>
85
86 <para>A few execution parameters result in additional, automatic dependencies to be added:</para>
87
88 <itemizedlist>
89 <listitem><para>Units with <varname>WorkingDirectory=</varname>, <varname>RootDirectory=</varname>, <varname>RootImage=</varname>,
90 <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
91 <varname>LogsDirectory=</varname> or <varname>ConfigurationDirectory=</varname> set automatically gain dependencies
92 of type <varname>Requires=</varname> and <varname>After=</varname> on all mount units required to access the specified paths.
93 This is equivalent to having them listed explicitly in <varname>RequiresMountsFor=</varname>.</para></listitem>
94
95 <listitem><para>Similar, units with <varname>PrivateTmp=</varname> enabled automatically get mount unit dependencies for all
96 mounts required to access <filename>/tmp</filename> and <filename>/var/tmp</filename>. They will also gain an
97 automatic <varname>After=</varname> dependency on
98 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
99
100 <listitem><para>Units whose standard output or error output is connected to <option>journal</option>, <option>syslog</option>
101 or <option>kmsg</option> (or their combinations with console output, see below) automatically acquire dependencies
102 of type <varname>After=</varname> on <filename>systemd-journald.socket</filename>.</para></listitem>
103 </itemizedlist>
104 </refsect1>
105
106 <!-- We don't have any default dependency here. -->
107
108 <refsect1>
109 <title>Options</title>
110
111 <variablelist class='unit-directives'>
112
113 <varlistentry>
114 <term><varname>WorkingDirectory=</varname></term>
115
116 <listitem><para>Takes a directory path relative to the service's root directory specified by
117 <varname>RootDirectory=</varname>, or the special value <literal>~</literal>. Sets the working directory for
118 executed processes. If set to <literal>~</literal>, the home directory of the user specified in
119 <varname>User=</varname> is used. If not set, defaults to the root directory when systemd is running as a
120 system instance and the respective user's home directory if run as user. If the setting is prefixed with the
121 <literal>-</literal> character, a missing working directory is not considered fatal. If
122 <varname>RootDirectory=</varname>/<varname>RootImage=</varname> is not set, then
123 <varname>WorkingDirectory=</varname> is relative to the root of the system running the service manager. Note
124 that setting this parameter might result in additional dependencies to be added to the unit (see
125 above).</para></listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term><varname>RootDirectory=</varname></term>
130
131 <listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system
132 running the service manager). Sets the root directory for executed processes, with the <citerefentry
133 project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
134 call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in
135 the <function>chroot()</function> jail. Note that setting this parameter might result in additional
136 dependencies to be added to the unit (see above).</para>
137
138 <para>The <varname>MountAPIVFS=</varname> and <varname>PrivateUsers=</varname> settings are particularly useful
139 in conjunction with <varname>RootDirectory=</varname>. For details, see below.</para></listitem>
140 </varlistentry>
141
142 <varlistentry>
143 <term><varname>RootImage=</varname></term>
144 <listitem><para>Takes a path to a block device node or regular file as argument. This call is similar to
145 <varname>RootDirectory=</varname> however mounts a file system hierarchy from a block device node or loopback
146 file instead of a directory. The device node or file system image file needs to contain a file system without a
147 partition table, or a file system within an MBR/MS-DOS or GPT partition table with only a single
148 Linux-compatible partition, or a set of file systems within a GPT partition table that follows the <ulink
149 url="https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable Partitions
150 Specification</ulink>.</para></listitem>
151 </varlistentry>
152
153 <varlistentry>
154 <term><varname>MountAPIVFS=</varname></term>
155
156 <listitem><para>Takes a boolean argument. If on, a private mount namespace for the unit's processes is created
157 and the API file systems <filename>/proc</filename>, <filename>/sys</filename>, and <filename>/dev</filename>
158 are mounted inside of it, unless they are already mounted. Note that this option has no effect unless used in
159 conjunction with <varname>RootDirectory=</varname>/<varname>RootImage=</varname> as these three mounts are
160 generally mounted in the host anyway, and unless the root directory is changed, the private mount namespace
161 will be a 1:1 copy of the host's, and include these three mounts. Note that the <filename>/dev</filename> file
162 system of the host is bind mounted if this option is used without <varname>PrivateDevices=</varname>. To run
163 the service with a private, minimal version of <filename>/dev/</filename>, combine this option with
164 <varname>PrivateDevices=</varname>.</para></listitem>
165 </varlistentry>
166
167 <varlistentry>
168 <term><varname>User=</varname></term>
169 <term><varname>Group=</varname></term>
170
171 <listitem><para>Set the UNIX user or group that the processes are executed as, respectively. Takes a single
172 user or group name, or a numeric ID as argument. For system services (services run by the system service manager,
173 i.e. managed by PID 1) and for user services of the root user (services managed by root's instance of
174 <command>systemd --user</command>), the default is <literal>root</literal>, but <varname>User=</varname> may be
175 used to specify a different user. For user services of any other user, switching user identity is not
176 permitted, hence the only valid setting is the same user the user's service manager is running as. If no group
177 is set, the default group of the user is used. This setting does not affect commands whose command line is
178 prefixed with <literal>+</literal>.</para>
179
180 <para>Note that restrictions on the user/group name syntax are enforced: the specified name must consist only
181 of the characters a-z, A-Z, 0-9, <literal>_</literal> and <literal>-</literal>, except for the first character
182 which must be one of a-z, A-Z or <literal>_</literal> (i.e. numbers and <literal>-</literal> are not permitted
183 as first character). The user/group name must have at least one character, and at most 31. These restrictions
184 are enforced in order to avoid ambiguities and to ensure user/group names and unit files remain portable among
185 Linux systems.</para>
186
187 <para>When used in conjunction with <varname>DynamicUser=</varname> the user/group name specified is
188 dynamically allocated at the time the service is started, and released at the time the service is stopped —
189 unless it is already allocated statically (see below). If <varname>DynamicUser=</varname> is not used the
190 specified user and group must have been created statically in the user database no later than the moment the
191 service is started, for example using the
192 <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> facility, which
193 is applied at boot or package install time.</para></listitem>
194 </varlistentry>
195
196 <varlistentry>
197 <term><varname>DynamicUser=</varname></term>
198
199 <listitem><para>Takes a boolean parameter. If set, a UNIX user and group pair is allocated dynamically when the
200 unit is started, and released as soon as it is stopped. The user and group will not be added to
201 <filename>/etc/passwd</filename> or <filename>/etc/group</filename>, but are managed transiently during
202 runtime. The <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
203 glibc NSS module provides integration of these dynamic users/groups into the system's user and group
204 databases. The user and group name to use may be configured via <varname>User=</varname> and
205 <varname>Group=</varname> (see above). If these options are not used and dynamic user/group allocation is
206 enabled for a unit, the name of the dynamic user/group is implicitly derived from the unit name. If the unit
207 name without the type suffix qualifies as valid user name it is used directly, otherwise a name incorporating a
208 hash of it is used. If a statically allocated user or group of the configured name already exists, it is used
209 and no dynamic user/group is allocated. Dynamic users/groups are allocated from the UID/GID range
210 6118465519. It is recommended to avoid this range for regular system or login users. At any point in time
211 each UID/GID from this range is only assigned to zero or one dynamically allocated users/groups in
212 use. However, UID/GIDs are recycled after a unit is terminated. Care should be taken that any processes running
213 as part of a unit for which dynamic users/groups are enabled do not leave files or directories owned by these
214 users/groups around, as a different unit might get the same UID/GID assigned later on, and thus gain access to
215 these files or directories. If <varname>DynamicUser=</varname> is enabled, <varname>RemoveIPC=</varname>,
216 <varname>PrivateTmp=</varname> are implied. This ensures that the lifetime of IPC objects and temporary files
217 created by the executed processes is bound to the runtime of the service, and hence the lifetime of the dynamic
218 user/group. Since <filename>/tmp</filename> and <filename>/var/tmp</filename> are usually the only
219 world-writable directories on a system this ensures that a unit making use of dynamic user/group allocation
220 cannot leave files around after unit termination. Moreover <varname>ProtectSystem=strict</varname> and
221 <varname>ProtectHome=read-only</varname> are implied, thus prohibiting the service to write to arbitrary file
222 system locations. In order to allow the service to write to certain directories, they have to be whitelisted
223 using <varname>ReadWritePaths=</varname>, but care must be taken so that UID/GID recycling doesn't
224 create security issues involving files created by the service. Use <varname>RuntimeDirectory=</varname> (see
225 below) in order to assign a writable runtime directory to a service, owned by the dynamic user/group and
226 removed automatically when the unit is terminated. Defaults to off.</para></listitem>
227 </varlistentry>
228
229 <varlistentry>
230 <term><varname>SupplementaryGroups=</varname></term>
231
232 <listitem><para>Sets the supplementary Unix groups the
233 processes are executed as. This takes a space-separated list
234 of group names or IDs. This option may be specified more than
235 once, in which case all listed groups are set as supplementary
236 groups. When the empty string is assigned, the list of
237 supplementary groups is reset, and all assignments prior to
238 this one will have no effect. In any way, this option does not
239 override, but extends the list of supplementary groups
240 configured in the system group database for the
241 user. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
242 </varlistentry>
243
244 <varlistentry>
245 <term><varname>RemoveIPC=</varname></term>
246
247 <listitem><para>Takes a boolean parameter. If set, all System V and POSIX IPC objects owned by the user and
248 group the processes of this unit are run as are removed when the unit is stopped. This setting only has an
249 effect if at least one of <varname>User=</varname>, <varname>Group=</varname> and
250 <varname>DynamicUser=</varname> are used. It has no effect on IPC objects owned by the root user. Specifically,
251 this removes System V semaphores, as well as System V and POSIX shared memory segments and message queues. If
252 multiple units use the same user or group the IPC objects are removed when the last of these units is
253 stopped. This setting is implied if <varname>DynamicUser=</varname> is set.</para></listitem>
254 </varlistentry>
255
256 <varlistentry>
257 <term><varname>Nice=</varname></term>
258
259 <listitem><para>Sets the default nice level (scheduling
260 priority) for executed processes. Takes an integer between -20
261 (highest priority) and 19 (lowest priority). See
262 <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>
263 for details.</para></listitem>
264 </varlistentry>
265
266 <varlistentry>
267 <term><varname>OOMScoreAdjust=</varname></term>
268
269 <listitem><para>Sets the adjustment level for the
270 Out-Of-Memory killer for executed processes. Takes an integer
271 between -1000 (to disable OOM killing for this process) and
272 1000 (to make killing of this process under memory pressure
273 very likely). See <ulink
274 url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
275 for details.</para></listitem>
276 </varlistentry>
277
278 <varlistentry>
279 <term><varname>IOSchedulingClass=</varname></term>
280
281 <listitem><para>Sets the I/O scheduling class for executed
282 processes. Takes an integer between 0 and 3 or one of the
283 strings <option>none</option>, <option>realtime</option>,
284 <option>best-effort</option> or <option>idle</option>. See
285 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
286 for details.</para></listitem>
287 </varlistentry>
288
289 <varlistentry>
290 <term><varname>IOSchedulingPriority=</varname></term>
291
292 <listitem><para>Sets the I/O scheduling priority for executed
293 processes. Takes an integer between 0 (highest priority) and 7
294 (lowest priority). The available priorities depend on the
295 selected I/O scheduling class (see above). See
296 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
297 for details.</para></listitem>
298 </varlistentry>
299
300 <varlistentry>
301 <term><varname>CPUSchedulingPolicy=</varname></term>
302
303 <listitem><para>Sets the CPU scheduling policy for executed
304 processes. Takes one of
305 <option>other</option>,
306 <option>batch</option>,
307 <option>idle</option>,
308 <option>fifo</option> or
309 <option>rr</option>. See
310 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
311 for details.</para></listitem>
312 </varlistentry>
313
314 <varlistentry>
315 <term><varname>CPUSchedulingPriority=</varname></term>
316
317 <listitem><para>Sets the CPU scheduling priority for executed
318 processes. The available priority range depends on the
319 selected CPU scheduling policy (see above). For real-time
320 scheduling policies an integer between 1 (lowest priority) and
321 99 (highest priority) can be used. See
322 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
323 for details. </para></listitem>
324 </varlistentry>
325
326 <varlistentry>
327 <term><varname>CPUSchedulingResetOnFork=</varname></term>
328
329 <listitem><para>Takes a boolean argument. If true, elevated
330 CPU scheduling priorities and policies will be reset when the
331 executed processes fork, and can hence not leak into child
332 processes. See
333 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
334 for details. Defaults to false.</para></listitem>
335 </varlistentry>
336
337 <varlistentry>
338 <term><varname>CPUAffinity=</varname></term>
339
340 <listitem><para>Controls the CPU affinity of the executed
341 processes. Takes a list of CPU indices or ranges separated by
342 either whitespace or commas. CPU ranges are specified by the
343 lower and upper CPU indices separated by a dash.
344 This option may be specified more than once, in which case the
345 specified CPU affinity masks are merged. If the empty string
346 is assigned, the mask is reset, all assignments prior to this
347 will have no effect. See
348 <citerefentry><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry>
349 for details.</para></listitem>
350 </varlistentry>
351
352 <varlistentry>
353 <term><varname>UMask=</varname></term>
354
355 <listitem><para>Controls the file mode creation mask. Takes an
356 access mode in octal notation. See
357 <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry>
358 for details. Defaults to 0022.</para></listitem>
359 </varlistentry>
360
361 <varlistentry>
362 <term><varname>Environment=</varname></term>
363
364 <listitem><para>Sets environment variables for executed
365 processes. Takes a space-separated list of variable
366 assignments. This option may be specified more than once, in
367 which case all listed variables will be set. If the same
368 variable is set twice, the later setting will override the
369 earlier setting. If the empty string is assigned to this
370 option, the list of environment variables is reset, all prior
371 assignments have no effect. Variable expansion is not
372 performed inside the strings, however, specifier expansion is
373 possible. The $ character has no special meaning. If you need
374 to assign a value containing spaces or the equals sign to a variable, use double
375 quotes (") for the assignment.</para>
376
377 <para>Example:
378 <programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
379 gives three variables <literal>VAR1</literal>,
380 <literal>VAR2</literal>, <literal>VAR3</literal>
381 with the values <literal>word1 word2</literal>,
382 <literal>word3</literal>, <literal>$word 5 6</literal>.
383 </para>
384
385 <para>
386 See
387 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
388 for details about environment variables.</para></listitem>
389 </varlistentry>
390 <varlistentry>
391 <term><varname>EnvironmentFile=</varname></term>
392 <listitem><para>Similar to <varname>Environment=</varname> but
393 reads the environment variables from a text file. The text
394 file should contain new-line-separated variable assignments.
395 Empty lines, lines without an <literal>=</literal> separator,
396 or lines starting with ; or # will be ignored,
397 which may be used for commenting. A line ending with a
398 backslash will be concatenated with the following one,
399 allowing multiline variable definitions. The parser strips
400 leading and trailing whitespace from the values of
401 assignments, unless you use double quotes (").</para>
402
403 <para>The argument passed should be an absolute filename or
404 wildcard expression, optionally prefixed with
405 <literal>-</literal>, which indicates that if the file does
406 not exist, it will not be read and no error or warning message
407 is logged. This option may be specified more than once in
408 which case all specified files are read. If the empty string
409 is assigned to this option, the list of file to read is reset,
410 all prior assignments have no effect.</para>
411
412 <para>The files listed with this directive will be read
413 shortly before the process is executed (more specifically,
414 after all processes from a previous unit state terminated.
415 This means you can generate these files in one unit state, and
416 read it with this option in the next).</para>
417
418 <para>Settings from these
419 files override settings made with
420 <varname>Environment=</varname>. If the same variable is set
421 twice from these files, the files will be read in the order
422 they are specified and the later setting will override the
423 earlier setting.</para></listitem>
424 </varlistentry>
425
426 <varlistentry>
427 <term><varname>PassEnvironment=</varname></term>
428
429 <listitem><para>Pass environment variables set for the system service manager to executed processes. Takes a
430 space-separated list of variable names. This option may be specified more than once, in which case all listed
431 variables will be passed. If the empty string is assigned to this option, the list of environment variables to
432 pass is reset, all prior assignments have no effect. Variables specified that are not set for the system
433 manager will not be passed and will be silently ignored. Note that this option is only relevant for the system
434 service manager, as system services by default do not automatically inherit any environment variables set for
435 the service manager itself. However, in case of the user service manager all environment variables are passed
436 to the executed processes anyway, hence this option is without effect for the user service manager.</para>
437
438 <para>Variables set for invoked processes due to this setting are subject to being overridden by those
439 configured with <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>.</para>
440
441 <para>Example:
442 <programlisting>PassEnvironment=VAR1 VAR2 VAR3</programlisting>
443 passes three variables <literal>VAR1</literal>,
444 <literal>VAR2</literal>, <literal>VAR3</literal>
445 with the values set for those variables in PID1.</para>
446
447 <para>
448 See
449 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
450 for details about environment variables.</para></listitem>
451 </varlistentry>
452
453 <varlistentry>
454 <term><varname>UnsetEnvironment=</varname></term>
455
456 <listitem><para>Explicitly unset environment variable assignments that would normally be passed from the
457 service manager to invoked processes of this unit. Takes a space-separated list of variable names or variable
458 assignments. This option may be specified more than once, in which case all listed variables/assignments will
459 be unset. If the empty string is assigned to this option, the list of environment variables/assignments to
460 unset is reset. If a variable assignment is specified (that is: a variable name, followed by
461 <literal>=</literal>, followed by its value), then any environment variable matching this precise assignment is
462 removed. If a variable name is specified (that is a variable name without any following <literal>=</literal> or
463 value), then any assignment matching the variable name, regardless of its value is removed. Note that the
464 effect of <varname>UnsetEnvironment=</varname> is applied as final step when the environment list passed to
465 executed processes is compiled. That means it may undo assignments from any configuration source, including
466 assignments made through <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>, inherited from
467 the system manager's global set of environment variables, inherited via <varname>PassEnvironment=</varname>,
468 set by the service manager itself (such as <varname>$NOTIFY_SOCKET</varname> and such), or set by a PAM module
469 (in case <varname>PAMName=</varname> is used).</para>
470
471 <para>
472 See
473 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
474 for details about environment variables.</para></listitem>
475 </varlistentry>
476
477 <varlistentry>
478 <term><varname>StandardInput=</varname></term>
479 <listitem><para>Controls where file descriptor 0 (STDIN) of
480 the executed processes is connected to. Takes one of
481 <option>null</option>,
482 <option>tty</option>,
483 <option>tty-force</option>,
484 <option>tty-fail</option>,
485 <option>socket</option> or
486 <option>fd</option>.</para>
487
488 <para>If <option>null</option> is selected, standard input
489 will be connected to <filename>/dev/null</filename>, i.e. all
490 read attempts by the process will result in immediate
491 EOF.</para>
492
493 <para>If <option>tty</option> is selected, standard input is
494 connected to a TTY (as configured by
495 <varname>TTYPath=</varname>, see below) and the executed
496 process becomes the controlling process of the terminal. If
497 the terminal is already being controlled by another process,
498 the executed process waits until the current controlling
499 process releases the terminal.</para>
500
501 <para><option>tty-force</option> is similar to
502 <option>tty</option>, but the executed process is forcefully
503 and immediately made the controlling process of the terminal,
504 potentially removing previous controlling processes from the
505 terminal.</para>
506
507 <para><option>tty-fail</option> is similar to
508 <option>tty</option> but if the terminal already has a
509 controlling process start-up of the executed process
510 fails.</para>
511
512 <para>The <option>socket</option> option is only valid in
513 socket-activated services, and only when the socket
514 configuration file (see
515 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
516 for details) specifies a single socket only. If this option is
517 set, standard input will be connected to the socket the
518 service was activated from, which is primarily useful for
519 compatibility with daemons designed for use with the
520 traditional
521 <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
522 daemon.</para>
523
524 <para>The <option>fd</option> option connects
525 the input stream to a single file descriptor provided by a socket unit.
526 A custom named file descriptor can be specified as part of this option,
527 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
528 If no name is specified, <literal>stdin</literal> is assumed
529 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdin</literal>).
530 At least one socket unit defining such name must be explicitly provided via the
531 <varname>Sockets=</varname> option, and file descriptor name may differ
532 from the name of its containing socket unit.
533 If multiple matches are found, the first one will be used.
534 See <varname>FileDescriptorName=</varname> in
535 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
536 for more details about named descriptors and ordering.</para>
537
538 <para>This setting defaults to
539 <option>null</option>.</para></listitem>
540 </varlistentry>
541
542 <varlistentry>
543 <term><varname>StandardOutput=</varname></term>
544 <listitem><para>Controls where file descriptor 1 (STDOUT) of
545 the executed processes is connected to. Takes one of
546 <option>inherit</option>,
547 <option>null</option>,
548 <option>tty</option>,
549 <option>journal</option>,
550 <option>syslog</option>,
551 <option>kmsg</option>,
552 <option>journal+console</option>,
553 <option>syslog+console</option>,
554 <option>kmsg+console</option>,
555 <option>socket</option> or
556 <option>fd</option>.</para>
557
558 <para><option>inherit</option> duplicates the file descriptor
559 of standard input for standard output.</para>
560
561 <para><option>null</option> connects standard output to
562 <filename>/dev/null</filename>, i.e. everything written to it
563 will be lost.</para>
564
565 <para><option>tty</option> connects standard output to a tty
566 (as configured via <varname>TTYPath=</varname>, see below). If
567 the TTY is used for output only, the executed process will not
568 become the controlling process of the terminal, and will not
569 fail or wait for other processes to release the
570 terminal.</para>
571
572 <para><option>journal</option> connects standard output with
573 the journal which is accessible via
574 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
575 Note that everything that is written to syslog or kmsg (see
576 below) is implicitly stored in the journal as well, the
577 specific two options listed below are hence supersets of this
578 one.</para>
579
580 <para><option>syslog</option> connects standard output to the
581 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
582 system syslog service, in addition to the journal. Note that
583 the journal daemon is usually configured to forward everything
584 it receives to syslog anyway, in which case this option is no
585 different from <option>journal</option>.</para>
586
587 <para><option>kmsg</option> connects standard output with the
588 kernel log buffer which is accessible via
589 <citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
590 in addition to the journal. The journal daemon might be
591 configured to send all logs to kmsg anyway, in which case this
592 option is no different from <option>journal</option>.</para>
593
594 <para><option>journal+console</option>,
595 <option>syslog+console</option> and
596 <option>kmsg+console</option> work in a similar way as the
597 three options above but copy the output to the system console
598 as well.</para>
599
600 <para><option>socket</option> connects standard output to a
601 socket acquired via socket activation. The semantics are
602 similar to the same option of
603 <varname>StandardInput=</varname>.</para>
604
605 <para>The <option>fd</option> option connects
606 the output stream to a single file descriptor provided by a socket unit.
607 A custom named file descriptor can be specified as part of this option,
608 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
609 If no name is specified, <literal>stdout</literal> is assumed
610 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdout</literal>).
611 At least one socket unit defining such name must be explicitly provided via the
612 <varname>Sockets=</varname> option, and file descriptor name may differ
613 from the name of its containing socket unit.
614 If multiple matches are found, the first one will be used.
615 See <varname>FileDescriptorName=</varname> in
616 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
617 for more details about named descriptors and ordering.</para>
618
619 <para>If the standard output (or error output, see below) of a unit is connected to the journal, syslog or the
620 kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname> on
621 <filename>systemd-journald.socket</filename> (also see the "Implicit Dependencies" section above).</para>
622
623 <para>This setting defaults to the value set with
624 <option>DefaultStandardOutput=</option> in
625 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
626 which defaults to <option>journal</option>. Note that setting
627 this parameter might result in additional dependencies to be
628 added to the unit (see above).</para></listitem>
629 </varlistentry>
630
631 <varlistentry>
632 <term><varname>StandardError=</varname></term>
633 <listitem><para>Controls where file descriptor 2 (STDERR) of
634 the executed processes is connected to. The available options
635 are identical to those of <varname>StandardOutput=</varname>,
636 with some exceptions: if set to <option>inherit</option> the
637 file descriptor used for standard output is duplicated for
638 standard error, while <option>fd</option> operates on the error
639 stream and will look by default for a descriptor named
640 <literal>stderr</literal>.</para>
641
642 <para>This setting defaults to the value set with
643 <option>DefaultStandardError=</option> in
644 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
645 which defaults to <option>inherit</option>. Note that setting
646 this parameter might result in additional dependencies to be
647 added to the unit (see above).</para></listitem>
648 </varlistentry>
649
650 <varlistentry>
651 <term><varname>TTYPath=</varname></term>
652 <listitem><para>Sets the terminal device node to use if
653 standard input, output, or error are connected to a TTY (see
654 above). Defaults to
655 <filename>/dev/console</filename>.</para></listitem>
656 </varlistentry>
657 <varlistentry>
658 <term><varname>TTYReset=</varname></term>
659 <listitem><para>Reset the terminal device specified with
660 <varname>TTYPath=</varname> before and after execution.
661 Defaults to <literal>no</literal>.</para></listitem>
662 </varlistentry>
663 <varlistentry>
664 <term><varname>TTYVHangup=</varname></term>
665 <listitem><para>Disconnect all clients which have opened the
666 terminal device specified with <varname>TTYPath=</varname>
667 before and after execution. Defaults to
668 <literal>no</literal>.</para></listitem>
669 </varlistentry>
670 <varlistentry>
671 <term><varname>TTYVTDisallocate=</varname></term>
672 <listitem><para>If the terminal device specified with
673 <varname>TTYPath=</varname> is a virtual console terminal, try
674 to deallocate the TTY before and after execution. This ensures
675 that the screen and scrollback buffer is cleared. Defaults to
676 <literal>no</literal>.</para></listitem>
677 </varlistentry>
678 <varlistentry>
679 <term><varname>SyslogIdentifier=</varname></term>
680 <listitem><para>Sets the process name to prefix log lines sent
681 to the logging system or the kernel log buffer with. If not
682 set, defaults to the process name of the executed process.
683 This option is only useful when
684 <varname>StandardOutput=</varname> or
685 <varname>StandardError=</varname> are set to
686 <option>syslog</option>, <option>journal</option> or
687 <option>kmsg</option> (or to the same settings in combination
688 with <option>+console</option>).</para></listitem>
689 </varlistentry>
690 <varlistentry>
691 <term><varname>SyslogFacility=</varname></term>
692 <listitem><para>Sets the syslog facility to use when logging
693 to syslog. One of <option>kern</option>,
694 <option>user</option>, <option>mail</option>,
695 <option>daemon</option>, <option>auth</option>,
696 <option>syslog</option>, <option>lpr</option>,
697 <option>news</option>, <option>uucp</option>,
698 <option>cron</option>, <option>authpriv</option>,
699 <option>ftp</option>, <option>local0</option>,
700 <option>local1</option>, <option>local2</option>,
701 <option>local3</option>, <option>local4</option>,
702 <option>local5</option>, <option>local6</option> or
703 <option>local7</option>. See
704 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
705 for details. This option is only useful when
706 <varname>StandardOutput=</varname> or
707 <varname>StandardError=</varname> are set to
708 <option>syslog</option>. Defaults to
709 <option>daemon</option>.</para></listitem>
710 </varlistentry>
711 <varlistentry>
712 <term><varname>SyslogLevel=</varname></term>
713 <listitem><para>The default syslog level to use when logging to
714 syslog or the kernel log buffer. One of
715 <option>emerg</option>,
716 <option>alert</option>,
717 <option>crit</option>,
718 <option>err</option>,
719 <option>warning</option>,
720 <option>notice</option>,
721 <option>info</option>,
722 <option>debug</option>. See
723 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
724 for details. This option is only useful when
725 <varname>StandardOutput=</varname> or
726 <varname>StandardError=</varname> are set to
727 <option>syslog</option> or <option>kmsg</option>. Note that
728 individual lines output by the daemon might be prefixed with a
729 different log level which can be used to override the default
730 log level specified here. The interpretation of these prefixes
731 may be disabled with <varname>SyslogLevelPrefix=</varname>,
732 see below. For details, see
733 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
734
735 Defaults to
736 <option>info</option>.</para></listitem>
737 </varlistentry>
738
739 <varlistentry>
740 <term><varname>SyslogLevelPrefix=</varname></term>
741 <listitem><para>Takes a boolean argument. If true and
742 <varname>StandardOutput=</varname> or
743 <varname>StandardError=</varname> are set to
744 <option>syslog</option>, <option>kmsg</option> or
745 <option>journal</option>, log lines written by the executed
746 process that are prefixed with a log level will be passed on
747 to syslog with this log level set but the prefix removed. If
748 set to false, the interpretation of these prefixes is disabled
749 and the logged lines are passed on as-is. For details about
750 this prefixing see
751 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
752 Defaults to true.</para></listitem>
753 </varlistentry>
754
755 <varlistentry>
756 <term><varname>TimerSlackNSec=</varname></term>
757 <listitem><para>Sets the timer slack in nanoseconds for the
758 executed processes. The timer slack controls the accuracy of
759 wake-ups triggered by timers. See
760 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
761 for more information. Note that in contrast to most other time
762 span definitions this parameter takes an integer value in
763 nano-seconds if no unit is specified. The usual time units are
764 understood too.</para></listitem>
765 </varlistentry>
766
767 <varlistentry>
768 <term><varname>LimitCPU=</varname></term>
769 <term><varname>LimitFSIZE=</varname></term>
770 <term><varname>LimitDATA=</varname></term>
771 <term><varname>LimitSTACK=</varname></term>
772 <term><varname>LimitCORE=</varname></term>
773 <term><varname>LimitRSS=</varname></term>
774 <term><varname>LimitNOFILE=</varname></term>
775 <term><varname>LimitAS=</varname></term>
776 <term><varname>LimitNPROC=</varname></term>
777 <term><varname>LimitMEMLOCK=</varname></term>
778 <term><varname>LimitLOCKS=</varname></term>
779 <term><varname>LimitSIGPENDING=</varname></term>
780 <term><varname>LimitMSGQUEUE=</varname></term>
781 <term><varname>LimitNICE=</varname></term>
782 <term><varname>LimitRTPRIO=</varname></term>
783 <term><varname>LimitRTTIME=</varname></term>
784 <listitem><para>Set soft and hard limits on various resources for executed processes. See
785 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details on
786 the resource limit concept. Resource limits may be specified in two formats: either as single value to set a
787 specific soft and hard limit to the same value, or as colon-separated pair <option>soft:hard</option> to set
788 both limits individually (e.g. <literal>LimitAS=4G:16G</literal>). Use the string <varname>infinity</varname>
789 to configure no limit on a specific resource. The multiplicative suffixes K, M, G, T, P and E (to the base
790 1024) may be used for resource limits measured in bytes (e.g. LimitAS=16G). For the limits referring to time
791 values, the usual time units ms, s, min, h and so on may be used (see
792 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
793 details). Note that if no time unit is specified for <varname>LimitCPU=</varname> the default unit of seconds
794 is implied, while for <varname>LimitRTTIME=</varname> the default unit of microseconds is implied. Also, note
795 that the effective granularity of the limits might influence their enforcement. For example, time limits
796 specified for <varname>LimitCPU=</varname> will be rounded up implicitly to multiples of 1s. For
797 <varname>LimitNICE=</varname> the value may be specified in two syntaxes: if prefixed with <literal>+</literal>
798 or <literal>-</literal>, the value is understood as regular Linux nice value in the range -20..19. If not
799 prefixed like this the value is understood as raw resource limit parameter in the range 0..40 (with 0 being
800 equivalent to 1).</para>
801
802 <para>Note that most process resource limits configured with
803 these options are per-process, and processes may fork in order
804 to acquire a new set of resources that are accounted
805 independently of the original process, and may thus escape
806 limits set. Also note that <varname>LimitRSS=</varname> is not
807 implemented on Linux, and setting it has no effect. Often it
808 is advisable to prefer the resource controls listed in
809 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
810 over these per-process limits, as they apply to services as a
811 whole, may be altered dynamically at runtime, and are
812 generally more expressive. For example,
813 <varname>MemoryLimit=</varname> is a more powerful (and
814 working) replacement for <varname>LimitRSS=</varname>.</para>
815
816 <para>For system units these resource limits may be chosen freely. For user units however (i.e. units run by a
817 per-user instance of
818 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>), these limits are
819 bound by (possibly more restrictive) per-user limits enforced by the OS.</para>
820
821 <para>Resource limits not configured explicitly for a unit default to the value configured in the various
822 <varname>DefaultLimitCPU=</varname>, <varname>DefaultLimitFSIZE=</varname>, … options available in
823 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and –
824 if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user
825 services, see above).</para>
826
827 <table>
828 <title>Resource limit directives, their equivalent <command>ulimit</command> shell commands and the unit used</title>
829
830 <tgroup cols='3'>
831 <colspec colname='directive' />
832 <colspec colname='equivalent' />
833 <colspec colname='unit' />
834 <thead>
835 <row>
836 <entry>Directive</entry>
837 <entry><command>ulimit</command> equivalent</entry>
838 <entry>Unit</entry>
839 </row>
840 </thead>
841 <tbody>
842 <row>
843 <entry>LimitCPU=</entry>
844 <entry>ulimit -t</entry>
845 <entry>Seconds</entry>
846 </row>
847 <row>
848 <entry>LimitFSIZE=</entry>
849 <entry>ulimit -f</entry>
850 <entry>Bytes</entry>
851 </row>
852 <row>
853 <entry>LimitDATA=</entry>
854 <entry>ulimit -d</entry>
855 <entry>Bytes</entry>
856 </row>
857 <row>
858 <entry>LimitSTACK=</entry>
859 <entry>ulimit -s</entry>
860 <entry>Bytes</entry>
861 </row>
862 <row>
863 <entry>LimitCORE=</entry>
864 <entry>ulimit -c</entry>
865 <entry>Bytes</entry>
866 </row>
867 <row>
868 <entry>LimitRSS=</entry>
869 <entry>ulimit -m</entry>
870 <entry>Bytes</entry>
871 </row>
872 <row>
873 <entry>LimitNOFILE=</entry>
874 <entry>ulimit -n</entry>
875 <entry>Number of File Descriptors</entry>
876 </row>
877 <row>
878 <entry>LimitAS=</entry>
879 <entry>ulimit -v</entry>
880 <entry>Bytes</entry>
881 </row>
882 <row>
883 <entry>LimitNPROC=</entry>
884 <entry>ulimit -u</entry>
885 <entry>Number of Processes</entry>
886 </row>
887 <row>
888 <entry>LimitMEMLOCK=</entry>
889 <entry>ulimit -l</entry>
890 <entry>Bytes</entry>
891 </row>
892 <row>
893 <entry>LimitLOCKS=</entry>
894 <entry>ulimit -x</entry>
895 <entry>Number of Locks</entry>
896 </row>
897 <row>
898 <entry>LimitSIGPENDING=</entry>
899 <entry>ulimit -i</entry>
900 <entry>Number of Queued Signals</entry>
901 </row>
902 <row>
903 <entry>LimitMSGQUEUE=</entry>
904 <entry>ulimit -q</entry>
905 <entry>Bytes</entry>
906 </row>
907 <row>
908 <entry>LimitNICE=</entry>
909 <entry>ulimit -e</entry>
910 <entry>Nice Level</entry>
911 </row>
912 <row>
913 <entry>LimitRTPRIO=</entry>
914 <entry>ulimit -r</entry>
915 <entry>Realtime Priority</entry>
916 </row>
917 <row>
918 <entry>LimitRTTIME=</entry>
919 <entry>No equivalent</entry>
920 <entry>Microseconds</entry>
921 </row>
922 </tbody>
923 </tgroup>
924 </table></listitem>
925 </varlistentry>
926
927 <varlistentry>
928 <term><varname>PAMName=</varname></term>
929 <listitem><para>Sets the PAM service name to set up a session as. If set, the executed process will be
930 registered as a PAM session under the specified service name. This is only useful in conjunction with the
931 <varname>User=</varname> setting, and is otherwise ignored. If not set, no PAM session will be opened for the
932 executed processes. See <citerefentry
933 project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
934 details.</para>
935
936 <para>Note that for each unit making use of this option a PAM session handler process will be maintained as
937 part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be
938 taken when the unit and hence the PAM session terminates. This process is named <literal>(sd-pam)</literal> and
939 is an immediate child process of the unit's main process.</para>
940
941 <para>Note that when this option is used for a unit it is very likely (depending on PAM configuration) that the
942 main unit process will be migrated to its own session scope unit when it is activated. This process will hence
943 be associated with two units: the unit it was originally started from (and for which
944 <varname>PAMName=</varname> was configured), and the session scope unit. Any child processes of that process
945 will however be associated with the session scope unit only. This has implications when used in combination
946 with <varname>NotifyAccess=</varname><option>all</option>, as these child processes will not be able to affect
947 changes in the original unit through notification messages. These messages will be considered belonging to the
948 session scope unit and not the original unit. It is hence not recommended to use <varname>PAMName=</varname> in
949 combination with <varname>NotifyAccess=</varname><option>all</option>.</para>
950 </listitem>
951 </varlistentry>
952
953 <varlistentry>
954 <term><varname>CapabilityBoundingSet=</varname></term>
955
956 <listitem><para>Controls which capabilities to include in the capability bounding set for the executed
957 process. See <citerefentry
958 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
959 details. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
960 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be
961 included in the bounding set, all others are removed. If the list of capabilities is prefixed with
962 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
963 inverted. Note that this option also affects the respective capabilities in the effective, permitted and
964 inheritable capability sets. If this option is not used, the capability bounding set is not modified on process
965 execution, hence no limits on the capabilities of the process are enforced. This option may appear more than
966 once, in which case the bounding sets are merged by <constant>AND</constant>, or by <constant>OR</constant>
967 if the lines are prefixed with <literal>~</literal> (see below). If the empty string is assigned
968 to this option, the bounding set is reset to the empty capability set, and all prior settings have no effect.
969 If set to <literal>~</literal> (without any further argument), the bounding set is reset to the full set of available
970 capabilities, also undoing any previous settings. This does not affect commands prefixed with
971 <literal>+</literal>.</para>
972
973 <para>Example: if a unit has the following,
974 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
975 CapabilityBoundingSet=CAP_B CAP_C</programlisting>
976 then <constant>CAP_A</constant>, <constant>CAP_B</constant>, and <constant>CAP_C</constant> are set.
977 If the second line is prefixed with <literal>~</literal>, e.g.,
978 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
979 CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
980 then, only <constant>CAP_A</constant> is set.</para></listitem>
981 </varlistentry>
982
983 <varlistentry>
984 <term><varname>AmbientCapabilities=</varname></term>
985
986 <listitem><para>Controls which capabilities to include in the ambient capability set for the executed
987 process. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
988 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. This option may appear more than
989 once in which case the ambient capability sets are merged (see the above examples in
990 <varname>CapabilityBoundingSet=</varname>). If the list of capabilities is prefixed with
991 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
992 inverted. If the empty string is assigned to this option, the ambient capability set is reset to the empty
993 capability set, and all prior settings have no effect. If set to <literal>~</literal> (without any further
994 argument), the ambient capability set is reset to the full set of available capabilities, also undoing any
995 previous settings. Note that adding capabilities to ambient capability set adds them to the process's inherited
996 capability set. </para><para> Ambient capability sets are useful if you want to execute a process as a
997 non-privileged user but still want to give it some capabilities. Note that in this case option
998 <constant>keep-caps</constant> is automatically added to <varname>SecureBits=</varname> to retain the
999 capabilities over the user change. <varname>AmbientCapabilities=</varname> does not affect commands prefixed
1000 with <literal>+</literal>.</para></listitem>
1001 </varlistentry>
1002
1003 <varlistentry>
1004 <term><varname>SecureBits=</varname></term>
1005 <listitem><para>Controls the secure bits set for the executed
1006 process. Takes a space-separated combination of options from
1007 the following list:
1008 <option>keep-caps</option>,
1009 <option>keep-caps-locked</option>,
1010 <option>no-setuid-fixup</option>,
1011 <option>no-setuid-fixup-locked</option>,
1012 <option>noroot</option>, and
1013 <option>noroot-locked</option>.
1014 This option may appear more than once, in which case the secure
1015 bits are ORed. If the empty string is assigned to this option,
1016 the bits are reset to 0. This does not affect commands prefixed with <literal>+</literal>.
1017 See <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1018 for details.</para></listitem>
1019 </varlistentry>
1020
1021 <varlistentry>
1022 <term><varname>ReadWritePaths=</varname></term>
1023 <term><varname>ReadOnlyPaths=</varname></term>
1024 <term><varname>InaccessiblePaths=</varname></term>
1025
1026 <listitem><para>Sets up a new file system namespace for executed processes. These options may be used to limit
1027 access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths
1028 relative to the host's root directory (i.e. the system running the service manager). Note that if paths
1029 contain symlinks, they are resolved relative to the root directory set with
1030 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>.</para>
1031
1032 <para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace with the same
1033 access modes as from outside of it. Paths listed in <varname>ReadOnlyPaths=</varname> are accessible for
1034 reading only, writing will be refused even if the usual file access controls would permit this. Nest
1035 <varname>ReadWritePaths=</varname> inside of <varname>ReadOnlyPaths=</varname> in order to provide writable
1036 subdirectories within read-only directories. Use <varname>ReadWritePaths=</varname> in order to whitelist
1037 specific paths for write access if <varname>ProtectSystem=strict</varname> is used. Paths listed in
1038 <varname>InaccessiblePaths=</varname> will be made inaccessible for processes inside the namespace (along with
1039 everything below them in the file system hierarchy).</para>
1040
1041 <para>Note that restricting access with these options does not extend to submounts of a directory that are
1042 created later on. Non-directory paths may be specified as well. These options may be specified more than once,
1043 in which case all paths listed will have limited access from within the namespace. If the empty string is
1044 assigned to this option, the specific list is reset, and all prior assignments have no effect.</para>
1045
1046 <para>Paths in <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname> and
1047 <varname>InaccessiblePaths=</varname> may be prefixed with <literal>-</literal>, in which case they will be
1048 ignored when they do not exist. If prefixed with <literal>+</literal> the paths are taken relative to the root
1049 directory of the unit, as configured with <varname>RootDirectory=</varname>/<varname>RootImage=</varname>,
1050 instead of relative to the root directory of the host (see above). When combining <literal>-</literal> and
1051 <literal>+</literal> on the same path make sure to specify <literal>-</literal> first, and <literal>+</literal>
1052 second.</para>
1053
1054 <para>Note that using this setting will disconnect propagation of mounts from the service to the host
1055 (propagation in the opposite direction continues to work). This means that this setting may not be used for
1056 services which shall be able to install mount points in the main mount namespace. Note that the effect of these
1057 settings may be undone by privileged processes. In order to set up an effective sandboxed environment for a
1058 unit it is thus recommended to combine these settings with either
1059 <varname>CapabilityBoundingSet=~CAP_SYS_ADMIN</varname> or
1060 <varname>SystemCallFilter=~@mount</varname>.</para></listitem>
1061 </varlistentry>
1062
1063 <varlistentry>
1064 <term><varname>BindPaths=</varname></term>
1065 <term><varname>BindReadOnlyPaths=</varname></term>
1066
1067 <listitem><para>Configures unit-specific bind mounts. A bind mount makes a particular file or directory
1068 available at an additional place in the unit's view of the file system. Any bind mounts created with this
1069 option are specific to the unit, and are not visible in the host's mount table. This option expects a
1070 whitespace separated list of bind mount definitions. Each definition consists of a colon-separated triple of
1071 source path, destination path and option string, where the latter two are optional. If only a source path is
1072 specified the source and destination is taken to be the same. The option string may be either
1073 <literal>rbind</literal> or <literal>norbind</literal> for configuring a recursive or non-recursive bind
1074 mount. If the destination path is omitted, the option string must be omitted too.</para>
1075
1076 <para><varname>BindPaths=</varname> creates regular writable bind mounts (unless the source file system mount
1077 is already marked read-only), while <varname>BindReadOnlyPaths=</varname> creates read-only bind mounts. These
1078 settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string
1079 is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note
1080 that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is
1081 used.</para>
1082
1083 <para>This option is particularly useful when <varname>RootDirectory=</varname>/<varname>RootImage=</varname>
1084 is used. In this case the source path refers to a path on the host file system, while the destination path
1085 refers to a path below the root directory of the unit.</para></listitem>
1086 </varlistentry>
1087
1088 <varlistentry>
1089 <term><varname>PrivateTmp=</varname></term>
1090
1091 <listitem><para>Takes a boolean argument. If true, sets up a new file system namespace for the executed
1092 processes and mounts private <filename>/tmp</filename> and <filename>/var/tmp</filename> directories inside it
1093 that is not shared by processes outside of the namespace. This is useful to secure access to temporary files of
1094 the process, but makes sharing between processes via <filename>/tmp</filename> or <filename>/var/tmp</filename>
1095 impossible. If this is enabled, all temporary files created by a service in these directories will be removed
1096 after the service is stopped. Defaults to false. It is possible to run two or more units within the same
1097 private <filename>/tmp</filename> and <filename>/var/tmp</filename> namespace by using the
1098 <varname>JoinsNamespaceOf=</varname> directive, see
1099 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1100 details. This setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same
1101 restrictions regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and
1102 related calls, see above. Enabling this setting has the side effect of adding <varname>Requires=</varname> and
1103 <varname>After=</varname> dependencies on all mount units necessary to access <filename>/tmp</filename> and
1104 <filename>/var/tmp</filename>. Moreover an implicitly <varname>After=</varname> ordering on
1105 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1106 is added.</para>
1107
1108 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces
1109 are not available), and the unit should be written in a way that does not solely rely on this setting for
1110 security.</para></listitem>
1111 </varlistentry>
1112
1113 <varlistentry>
1114 <term><varname>PrivateDevices=</varname></term>
1115
1116 <listitem><para>Takes a boolean argument. If true, sets up a new <filename>/dev</filename> mount for the
1117 executed processes and only adds API pseudo devices such as <filename>/dev/null</filename>,
1118 <filename>/dev/zero</filename> or
1119 <filename>/dev/random</filename> (as well as the pseudo TTY subsystem) to it, but no physical devices such as
1120 <filename>/dev/sda</filename>, system memory <filename>/dev/mem</filename>, system ports
1121 <filename>/dev/port</filename> and others. This is useful to securely turn off physical device access by the
1122 executed process. Defaults to false. Enabling this option will install a system call filter to block low-level
1123 I/O system calls that are grouped in the <varname>@raw-io</varname> set, will also remove
1124 <constant>CAP_MKNOD</constant> and <constant>CAP_SYS_RAWIO</constant> from the capability bounding set for
1125 the unit (see above), and set <varname>DevicePolicy=closed</varname> (see
1126 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1127 for details). Note that using this setting will disconnect propagation of mounts from the service to the host
1128 (propagation in the opposite direction continues to work). This means that this setting may not be used for
1129 services which shall be able to install mount points in the main mount namespace. The new <filename>/dev</filename>
1130 will be mounted read-only and 'noexec'. The latter may break old programs which try to set up executable memory by
1131 using <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> of
1132 <filename>/dev/zero</filename> instead of using <constant>MAP_ANON</constant>. For this setting the same restrictions
1133 regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
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> is implied.
1136 </para>
1137
1138 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces
1139 are not available), and the unit should be written in a way that does not solely rely on this setting for
1140 security.</para></listitem>
1141 </varlistentry>
1142
1143 <varlistentry>
1144 <term><varname>PrivateNetwork=</varname></term>
1145
1146 <listitem><para>Takes a boolean argument. If true, sets up a
1147 new network namespace for the executed processes and
1148 configures only the loopback network device
1149 <literal>lo</literal> inside it. No other network devices will
1150 be available to the executed process. This is useful to
1151 turn off network access by the executed process.
1152 Defaults to false. It is possible to run two or more units
1153 within the same private network namespace by using the
1154 <varname>JoinsNamespaceOf=</varname> directive, see
1155 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1156 for details. Note that this option will disconnect all socket
1157 families from the host, this includes AF_NETLINK and AF_UNIX.
1158 The latter has the effect that AF_UNIX sockets in the abstract
1159 socket namespace will become unavailable to the processes
1160 (however, those located in the file system will continue to be
1161 accessible).</para>
1162
1163 <para>Note that the implementation of this setting might be impossible (for example if network namespaces
1164 are not available), and the unit should be written in a way that does not solely rely on this setting for
1165 security.</para></listitem>
1166 </varlistentry>
1167
1168 <varlistentry>
1169 <term><varname>PrivateUsers=</varname></term>
1170
1171 <listitem><para>Takes a boolean argument. If true, sets up a new user namespace for the executed processes and
1172 configures a minimal user and group mapping, that maps the <literal>root</literal> user and group as well as
1173 the unit's own user and group to themselves and everything else to the <literal>nobody</literal> user and
1174 group. This is useful to securely detach the user and group databases used by the unit from the rest of the
1175 system, and thus to create an effective sandbox environment. All files, directories, processes, IPC objects and
1176 other resources owned by users/groups not equaling <literal>root</literal> or the unit's own will stay visible
1177 from within the unit but appear owned by the <literal>nobody</literal> user and group. If this mode is enabled,
1178 all unit processes are run without privileges in the host user namespace (regardless if the unit's own
1179 user/group is <literal>root</literal> or not). Specifically this means that the process will have zero process
1180 capabilities on the host's user namespace, but full capabilities within the service's user namespace. Settings
1181 such as <varname>CapabilityBoundingSet=</varname> will affect only the latter, and there's no way to acquire
1182 additional capabilities in the host's user namespace. Defaults to off.</para>
1183
1184 <para>This setting is particularly useful in conjunction with
1185 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>, as the need to synchronize the user and group
1186 databases in the root directory and on the host is reduced, as the only users and groups who need to be matched
1187 are <literal>root</literal>, <literal>nobody</literal> and the unit's own user and group.</para>
1188
1189 <para>Note that the implementation of this setting might be impossible (for example if user namespaces
1190 are not available), and the unit should be written in a way that does not solely rely on this setting for
1191 security.</para></listitem>
1192 </varlistentry>
1193
1194 <varlistentry>
1195 <term><varname>ProtectSystem=</varname></term>
1196
1197 <listitem><para>Takes a boolean argument or the special values <literal>full</literal> or
1198 <literal>strict</literal>. If true, mounts the <filename>/usr</filename> and <filename>/boot</filename>
1199 directories read-only for processes invoked by this unit. If set to <literal>full</literal>, the
1200 <filename>/etc</filename> directory is mounted read-only, too. If set to <literal>strict</literal> the entire
1201 file system hierarchy is mounted read-only, except for the API file system subtrees <filename>/dev</filename>,
1202 <filename>/proc</filename> and <filename>/sys</filename> (protect these directories using
1203 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1204 <varname>ProtectControlGroups=</varname>). This setting ensures that any modification of the vendor-supplied
1205 operating system (and optionally its configuration, and local mounts) is prohibited for the service. It is
1206 recommended to enable this setting for all long-running services, unless they are involved with system updates
1207 or need to modify the operating system in other ways. If this option is used,
1208 <varname>ReadWritePaths=</varname> may be used to exclude specific directories from being made read-only. This
1209 setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same restrictions regarding
1210 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
1211 above. Defaults to off.</para></listitem>
1212 </varlistentry>
1213
1214 <varlistentry>
1215 <term><varname>ProtectHome=</varname></term>
1216
1217 <listitem><para>Takes a boolean argument or <literal>read-only</literal>. If true, the directories
1218 <filename>/home</filename>, <filename>/root</filename> and <filename>/run/user</filename> are made inaccessible
1219 and empty for processes invoked by this unit. If set to <literal>read-only</literal>, the three directories are
1220 made read-only instead. It is recommended to enable this setting for all long-running services (in particular
1221 network-facing ones), to ensure they cannot get access to private user data, unless the services actually
1222 require access to the user's private data. This setting is implied if <varname>DynamicUser=</varname> is
1223 set. For this setting the same restrictions regarding mount propagation and privileges apply as for
1224 <varname>ReadOnlyPaths=</varname> and related calls, see above.</para></listitem>
1225 </varlistentry>
1226
1227 <varlistentry>
1228 <term><varname>ProtectKernelTunables=</varname></term>
1229
1230 <listitem><para>Takes a boolean argument. If true, kernel variables accessible through
1231 <filename>/proc/sys</filename>, <filename>/sys</filename>, <filename>/proc/sysrq-trigger</filename>,
1232 <filename>/proc/latency_stats</filename>, <filename>/proc/acpi</filename>,
1233 <filename>/proc/timer_stats</filename>, <filename>/proc/fs</filename> and <filename>/proc/irq</filename> will
1234 be made read-only to all processes of the unit. Usually, tunable kernel variables should be initialized only at
1235 boot-time, for example with the
1236 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> mechanism. Few
1237 services need to write to these at runtime; it is hence recommended to turn this on for most services. For this
1238 setting the same restrictions regarding mount propagation and privileges apply as for
1239 <varname>ReadOnlyPaths=</varname> and related calls, see above. Defaults to off. If turned on and if running
1240 in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. services
1241 for which <varname>User=</varname> is set), <varname>NoNewPrivileges=yes</varname> is implied. Note that this
1242 option does not prevent indirect changes to kernel tunables effected by IPC calls to other processes. However,
1243 <varname>InaccessiblePaths=</varname> may be used to make relevant IPC file system objects inaccessible. If
1244 <varname>ProtectKernelTunables=</varname> is set, <varname>MountAPIVFS=yes</varname> is
1245 implied.</para></listitem>
1246 </varlistentry>
1247
1248 <varlistentry>
1249 <term><varname>ProtectKernelModules=</varname></term>
1250
1251 <listitem><para>Takes a boolean argument. If true, explicit module loading will
1252 be denied. This allows to turn off module load and unload operations on modular
1253 kernels. It is recommended to turn this on for most services that do not need special
1254 file systems or extra kernel modules to work. Default to off. Enabling this option
1255 removes <constant>CAP_SYS_MODULE</constant> from the capability bounding set for
1256 the unit, and installs a system call filter to block module system calls,
1257 also <filename>/usr/lib/modules</filename> is made inaccessible. For this
1258 setting the same restrictions regarding mount propagation and privileges
1259 apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
1260 Note that limited automatic module loading due to user configuration or kernel
1261 mapping tables might still happen as side effect of requested user operations,
1262 both privileged and unprivileged. To disable module auto-load feature please see
1263 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1264 <constant>kernel.modules_disabled</constant> mechanism and
1265 <filename>/proc/sys/kernel/modules_disabled</filename> documentation.
1266 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1267 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1268 is implied.
1269 </para></listitem>
1270 </varlistentry>
1271
1272 <varlistentry>
1273 <term><varname>ProtectControlGroups=</varname></term>
1274
1275 <listitem><para>Takes a boolean argument. If true, the Linux Control Groups (<citerefentry
1276 project='man-pages'><refentrytitle>cgroups</refentrytitle><manvolnum>7</manvolnum></citerefentry>) hierarchies
1277 accessible through <filename>/sys/fs/cgroup</filename> will be made read-only to all processes of the
1278 unit. Except for container managers no services should require write access to the control groups hierarchies;
1279 it is hence recommended to turn this on for most services. For this setting the same restrictions regarding
1280 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
1281 above. Defaults to off. If <varname>ProtectControlGroups=</varname> is set, <varname>MountAPIVFS=yes</varname> is
1282 implied.</para></listitem>
1283 </varlistentry>
1284
1285 <varlistentry>
1286 <term><varname>MountFlags=</varname></term>
1287
1288 <listitem><para>Takes a mount propagation flag: <option>shared</option>, <option>slave</option> or
1289 <option>private</option>, which control whether mounts in the file system namespace set up for this unit's
1290 processes will receive or propagate mounts and unmounts. See <citerefentry
1291 project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
1292 details. Defaults to <option>shared</option>. Use <option>shared</option> to ensure that mounts and unmounts
1293 are propagated from systemd's namespace to the service's namespace and vice versa. Use <option>slave</option>
1294 to run processes so that none of their mounts and unmounts will propagate to the host. Use <option>private</option>
1295 to also ensure that no mounts and unmounts from the host will propagate into the unit processes' namespace.
1296 If this is set to <option>slave</option> or <option>private</option>, any mounts created by spawned processes
1297 will be unmounted after the completion of the current command line of <varname>ExecStartPre=</varname>,
1298 <varname>ExecStartPost=</varname>, <varname>ExecStart=</varname>,
1299 and <varname>ExecStopPost=</varname>. Note that
1300 <option>slave</option> means that file systems mounted on the host might stay mounted continuously in the
1301 unit's namespace, and thus keep the device busy. Note that the file system namespace related options
1302 (<varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>,
1303 <varname>ProtectHome=</varname>, <varname>ProtectKernelTunables=</varname>,
1304 <varname>ProtectControlGroups=</varname>, <varname>ReadOnlyPaths=</varname>,
1305 <varname>InaccessiblePaths=</varname>, <varname>ReadWritePaths=</varname>) require that mount and unmount
1306 propagation from the unit's file system namespace is disabled, and hence downgrade <option>shared</option> to
1307 <option>slave</option>. </para></listitem>
1308 </varlistentry>
1309
1310 <varlistentry>
1311 <term><varname>UtmpIdentifier=</varname></term>
1312
1313 <listitem><para>Takes a four character identifier string for
1314 an <citerefentry
1315 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1316 and wtmp entry for this service. This should only be
1317 set for services such as <command>getty</command>
1318 implementations (such as <citerefentry
1319 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1320 where utmp/wtmp entries must be created and cleared before and
1321 after execution, or for services that shall be executed as if
1322 they were run by a <command>getty</command> process (see
1323 below). If the configured string is longer than four
1324 characters, it is truncated and the terminal four characters
1325 are used. This setting interprets %I style string
1326 replacements. This setting is unset by default, i.e. no
1327 utmp/wtmp entries are created or cleaned up for this
1328 service.</para></listitem>
1329 </varlistentry>
1330
1331 <varlistentry>
1332 <term><varname>UtmpMode=</varname></term>
1333
1334 <listitem><para>Takes one of <literal>init</literal>,
1335 <literal>login</literal> or <literal>user</literal>. If
1336 <varname>UtmpIdentifier=</varname> is set, controls which
1337 type of <citerefentry
1338 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp
1339 entries for this service are generated. This setting has no
1340 effect unless <varname>UtmpIdentifier=</varname> is set
1341 too. If <literal>init</literal> is set, only an
1342 <constant>INIT_PROCESS</constant> entry is generated and the
1343 invoked process must implement a
1344 <command>getty</command>-compatible utmp/wtmp logic. If
1345 <literal>login</literal> is set, first an
1346 <constant>INIT_PROCESS</constant> entry, followed by a
1347 <constant>LOGIN_PROCESS</constant> entry is generated. In
1348 this case, the invoked process must implement a <citerefentry
1349 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
1350 utmp/wtmp logic. If <literal>user</literal> is set, first an
1351 <constant>INIT_PROCESS</constant> entry, then a
1352 <constant>LOGIN_PROCESS</constant> entry and finally a
1353 <constant>USER_PROCESS</constant> entry is generated. In this
1354 case, the invoked process may be any process that is suitable
1355 to be run as session leader. Defaults to
1356 <literal>init</literal>.</para></listitem>
1357 </varlistentry>
1358
1359 <varlistentry>
1360 <term><varname>SELinuxContext=</varname></term>
1361
1362 <listitem><para>Set the SELinux security context of the
1363 executed process. If set, this will override the automated
1364 domain transition. However, the policy still needs to
1365 authorize the transition. This directive is ignored if SELinux
1366 is disabled. If prefixed by <literal>-</literal>, all errors
1367 will be ignored. This does not affect commands prefixed with <literal>+</literal>.
1368 See <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1369 for details.</para></listitem>
1370 </varlistentry>
1371
1372 <varlistentry>
1373 <term><varname>AppArmorProfile=</varname></term>
1374
1375 <listitem><para>Takes a profile name as argument. The process
1376 executed by the unit will switch to this profile when started.
1377 Profiles must already be loaded in the kernel, or the unit
1378 will fail. This result in a non operation if AppArmor is not
1379 enabled. If prefixed by <literal>-</literal>, all errors will
1380 be ignored. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
1381 </varlistentry>
1382
1383 <varlistentry>
1384 <term><varname>SmackProcessLabel=</varname></term>
1385
1386 <listitem><para>Takes a <option>SMACK64</option> security
1387 label as argument. The process executed by the unit will be
1388 started under this label and SMACK will decide whether the
1389 process is allowed to run or not, based on it. The process
1390 will continue to run under the label specified here unless the
1391 executable has its own <option>SMACK64EXEC</option> label, in
1392 which case the process will transition to run under that
1393 label. When not specified, the label that systemd is running
1394 under is used. This directive is ignored if SMACK is
1395 disabled.</para>
1396
1397 <para>The value may be prefixed by <literal>-</literal>, in
1398 which case all errors will be ignored. An empty value may be
1399 specified to unset previous assignments. This does not affect
1400 commands prefixed with <literal>+</literal>.</para>
1401 </listitem>
1402 </varlistentry>
1403
1404 <varlistentry>
1405 <term><varname>IgnoreSIGPIPE=</varname></term>
1406
1407 <listitem><para>Takes a boolean argument. If true, causes
1408 <constant>SIGPIPE</constant> to be ignored in the executed
1409 process. Defaults to true because <constant>SIGPIPE</constant>
1410 generally is useful only in shell pipelines.</para></listitem>
1411 </varlistentry>
1412
1413 <varlistentry>
1414 <term><varname>NoNewPrivileges=</varname></term>
1415
1416 <listitem><para>Takes a boolean argument. If true, ensures that the service process and all its children can
1417 never gain new privileges through <function>execve()</function> (e.g. via setuid or setgid bits, or filesystem
1418 capabilities). This is the simplest and most effective way to ensure that a process and its children can never
1419 elevate privileges again. Defaults to false, but certain settings force
1420 <varname>NoNewPrivileges=yes</varname>, ignoring the value of this setting. This is the case when
1421 <varname>SystemCallFilter=</varname>, <varname>SystemCallArchitectures=</varname>,
1422 <varname>RestrictAddressFamilies=</varname>, <varname>RestrictNamespaces=</varname>,
1423 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1424 <varname>ProtectKernelModules=</varname>, <varname>MemoryDenyWriteExecute=</varname>, or
1425 <varname>RestrictRealtime=</varname> are specified.</para></listitem>
1426 </varlistentry>
1427
1428 <varlistentry>
1429 <term><varname>SystemCallFilter=</varname></term>
1430
1431 <listitem><para>Takes a space-separated list of system call names. If this setting is used, all system calls
1432 executed by the unit processes except for the listed ones will result in immediate process termination with the
1433 <constant>SIGSYS</constant> signal (whitelisting). If the first character of the list is <literal>~</literal>,
1434 the effect is inverted: only the listed system calls will result in immediate process termination
1435 (blacklisting). If running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1436 capability (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is
1437 implied. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel ('seccomp filtering')
1438 and is useful for enforcing a minimal sandboxing environment. Note that the <function>execve</function>,
1439 <function>exit</function>, <function>exit_group</function>, <function>getrlimit</function>,
1440 <function>rt_sigreturn</function>, <function>sigreturn</function> system calls and the system calls for
1441 querying time and sleeping are implicitly whitelisted and do not need to be listed explicitly. This option may
1442 be specified more than once, in which case the filter masks are merged. If the empty string is assigned, the
1443 filter is reset, all prior assignments will have no effect. This does not affect commands prefixed with
1444 <literal>+</literal>.</para>
1445
1446 <para>Note that on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off
1447 alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this
1448 option. Specifically, it is recommended to combine this option with
1449 <varname>SystemCallArchitectures=native</varname> or similar.</para>
1450
1451 <para>Note that strict system call filters may impact execution and error handling code paths of the service
1452 invocation. Specifically, access to the <function>execve</function> system call is required for the execution
1453 of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the
1454 service binary fails for some reason (for example: missing service executable), the error handling logic might
1455 require access to an additional set of system calls in order to process and log this failure correctly. It
1456 might be necessary to temporarily disable system call filters in order to simplify debugging of such
1457 failures.</para>
1458
1459 <para>If you specify both types of this option (i.e.
1460 whitelisting and blacklisting), the first encountered will
1461 take precedence and will dictate the default action
1462 (termination or approval of a system call). Then the next
1463 occurrences of this option will add or delete the listed
1464 system calls from the set of the filtered system calls,
1465 depending of its type and the default action. (For example, if
1466 you have started with a whitelisting of
1467 <function>read</function> and <function>write</function>, and
1468 right after it add a blacklisting of
1469 <function>write</function>, then <function>write</function>
1470 will be removed from the set.)</para>
1471
1472 <para>As the number of possible system
1473 calls is large, predefined sets of system calls are provided.
1474 A set starts with <literal>@</literal> character, followed by
1475 name of the set.
1476
1477 <table>
1478 <title>Currently predefined system call sets</title>
1479
1480 <tgroup cols='2'>
1481 <colspec colname='set' />
1482 <colspec colname='description' />
1483 <thead>
1484 <row>
1485 <entry>Set</entry>
1486 <entry>Description</entry>
1487 </row>
1488 </thead>
1489 <tbody>
1490 <row>
1491 <entry>@basic-io</entry>
1492 <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>
1493 </row>
1494 <row>
1495 <entry>@clock</entry>
1496 <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>
1497 </row>
1498 <row>
1499 <entry>@cpu-emulation</entry>
1500 <entry>System calls for CPU emulation functionality (<citerefentry project='man-pages'><refentrytitle>vm86</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1501 </row>
1502 <row>
1503 <entry>@credentials</entry>
1504 <entry>System calls for querying process credentials (<citerefentry project='man-pages'><refentrytitle>getuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>capget</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1505 </row>
1506 <row>
1507 <entry>@debug</entry>
1508 <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>
1509 </row>
1510 <row>
1511 <entry>@file-system</entry>
1512 <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>
1513 </row>
1514 <row>
1515 <entry>@io-event</entry>
1516 <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>
1517 </row>
1518 <row>
1519 <entry>@ipc</entry>
1520 <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>
1521 </row>
1522 <row>
1523 <entry>@keyring</entry>
1524 <entry>Kernel keyring access (<citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1525 </row>
1526 <row>
1527 <entry>@memlock</entry>
1528 <entry>Locking of memory into RAM (<citerefentry project='man-pages'><refentrytitle>mlock</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>mlockall</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1529 </row>
1530 <row>
1531 <entry>@module</entry>
1532 <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>
1533 </row>
1534 <row>
1535 <entry>@mount</entry>
1536 <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>
1537 </row>
1538 <row>
1539 <entry>@network-io</entry>
1540 <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>
1541 </row>
1542 <row>
1543 <entry>@obsolete</entry>
1544 <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>
1545 </row>
1546 <row>
1547 <entry>@privileged</entry>
1548 <entry>All system calls which need super-user capabilities (<citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
1549 </row>
1550 <row>
1551 <entry>@process</entry>
1552 <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>
1553 </row>
1554 <row>
1555 <entry>@raw-io</entry>
1556 <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>
1557 </row>
1558 <row>
1559 <entry>@reboot</entry>
1560 <entry>System calls for rebooting and reboot preparation (<citerefentry project='man-pages'><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>kexec()</function>, …)</entry>
1561 </row>
1562 <row>
1563 <entry>@resources</entry>
1564 <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>
1565 </row>
1566 <row>
1567 <entry>@setuid</entry>
1568 <entry>System calls for changing user ID and group ID credentials, (<citerefentry project='man-pages'><refentrytitle>setuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setgid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setresuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1569 </row>
1570 <row>
1571 <entry>@signal</entry>
1572 <entry>System calls for manipulating and handling process signals (<citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1573 </row>
1574 <row>
1575 <entry>@swap</entry>
1576 <entry>System calls for enabling/disabling swap devices (<citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>swapoff</refentrytitle><manvolnum>2</manvolnum></citerefentry>)</entry>
1577 </row>
1578 <row>
1579 <entry>@timer</entry>
1580 <entry>System calls for scheduling operations by time (<citerefentry project='man-pages'><refentrytitle>alarm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>timer_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1581 </row>
1582 </tbody>
1583 </tgroup>
1584 </table>
1585
1586 Note, that as new system calls are added to the kernel, additional system calls might be
1587 added to the groups above. Contents of the sets may also change between systemd
1588 versions. In addition, the list of system calls depends on the kernel version and
1589 architecture for which systemd was compiled. Use
1590 <command>systemd-analyze syscall-filter</command> to list the actual list of system calls in
1591 each filter.
1592 </para>
1593
1594 <para>It is recommended to combine the file system namespacing related options with
1595 <varname>SystemCallFilter=~@mount</varname>, in order to prohibit the unit's processes to undo the
1596 mappings. Specifically these are the options <varname>PrivateTmp=</varname>,
1597 <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, <varname>ProtectHome=</varname>,
1598 <varname>ProtectKernelTunables=</varname>, <varname>ProtectControlGroups=</varname>,
1599 <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname> and
1600 <varname>ReadWritePaths=</varname>.</para></listitem>
1601 </varlistentry>
1602
1603 <varlistentry>
1604 <term><varname>SystemCallErrorNumber=</varname></term>
1605
1606 <listitem><para>Takes an <literal>errno</literal> error number
1607 name to return when the system call filter configured with
1608 <varname>SystemCallFilter=</varname> is triggered, instead of
1609 terminating the process immediately. Takes an error name such
1610 as <constant>EPERM</constant>, <constant>EACCES</constant> or
1611 <constant>EUCLEAN</constant>. When this setting is not used,
1612 or when the empty string is assigned, the process will be
1613 terminated immediately when the filter is
1614 triggered.</para></listitem>
1615 </varlistentry>
1616
1617 <varlistentry>
1618 <term><varname>SystemCallArchitectures=</varname></term>
1619
1620 <listitem><para>Takes a space-separated list of architecture identifiers to include in the system call
1621 filter. The known architecture identifiers are the same as for <varname>ConditionArchitecture=</varname>
1622 described in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1623 as well as <constant>x32</constant>, <constant>mips64-n32</constant>, <constant>mips64-le-n32</constant>, and
1624 the special identifier <constant>native</constant>. Only system calls of the specified architectures will be
1625 permitted to processes of this unit. This is an effective way to disable compatibility with non-native
1626 architectures for processes, for example to prohibit execution of 32-bit x86 binaries on 64-bit x86-64
1627 systems. The special <constant>native</constant> identifier implicitly maps to the native architecture of the
1628 system (or more strictly: to the architecture the system manager is compiled for). If running in user mode, or
1629 in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1630 <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. Note that setting this
1631 option to a non-empty list implies that <constant>native</constant> is included too. By default, this option is
1632 set to the empty list, i.e. no system call architecture filtering is applied.</para>
1633
1634 <para>Note that system call filtering is not equally effective on all architectures. For example, on x86
1635 filtering of network socket-related calls is not possible, due to ABI limitations — a limitation that x86-64
1636 does not have, however. On systems supporting multiple ABIs at the same time — such as x86/x86-64 — it is hence
1637 recommended to limit the set of permitted system call architectures so that secondary ABIs may not be used to
1638 circumvent the restrictions applied to the native ABI of the system. In particular, setting
1639 <varname>SystemCallArchitectures=native</varname> is a good choice for disabling non-native ABIs.</para>
1640
1641 <para>System call architectures may also be restricted system-wide via the
1642 <varname>SystemCallArchitectures=</varname> option in the global configuration. See
1643 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1644 details.</para></listitem>
1645 </varlistentry>
1646
1647 <varlistentry>
1648 <term><varname>RestrictAddressFamilies=</varname></term>
1649
1650 <listitem><para>Restricts the set of socket address families accessible to the processes of this unit. Takes a
1651 space-separated list of address family names to whitelist, such as <constant>AF_UNIX</constant>,
1652 <constant>AF_INET</constant> or <constant>AF_INET6</constant>. When prefixed with <constant>~</constant> the
1653 listed address families will be applied as blacklist, otherwise as whitelist. Note that this restricts access
1654 to the <citerefentry
1655 project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call
1656 only. Sockets passed into the process by other means (for example, by using socket activation with socket
1657 units, see <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1658 are unaffected. Also, sockets created with <function>socketpair()</function> (which creates connected AF_UNIX
1659 sockets only) are unaffected. Note that this option has no effect on 32-bit x86, s390, s390x, mips, mips-le,
1660 ppc, ppc-le, pcc64, ppc64-le and is ignored (but works correctly on other ABIs, including x86-64). Note that on
1661 systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for
1662 services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is
1663 recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If
1664 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability
1665 (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. By default,
1666 no restrictions apply, all address families are accessible to processes. If assigned the empty string, any
1667 previous address familiy restriction changes are undone. This setting does not affect commands prefixed with
1668 <literal>+</literal>.</para>
1669
1670 <para>Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive
1671 network protocols, such as <constant>AF_PACKET</constant>. Note that in most cases, the local
1672 <constant>AF_UNIX</constant> address family should be included in the configured whitelist as it is frequently
1673 used for local communication, including for
1674 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1675 logging.</para></listitem>
1676 </varlistentry>
1677
1678 <varlistentry>
1679 <term><varname>RestrictNamespaces=</varname></term>
1680
1681 <listitem><para>Restricts access to Linux namespace functionality for the processes of this unit. For details
1682 about Linux namespaces, see
1683 <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Either takes a
1684 boolean argument, or a space-separated list of namespace type identifiers. If false (the default), no
1685 restrictions on namespace creation and switching are made. If true, access to any kind of namespacing is
1686 prohibited. Otherwise, a space-separated list of namespace type identifiers must be specified, consisting of
1687 any combination of: <constant>cgroup</constant>, <constant>ipc</constant>, <constant>net</constant>,
1688 <constant>mnt</constant>, <constant>pid</constant>, <constant>user</constant> and <constant>uts</constant>. Any
1689 namespace type listed is made accessible to the unit's processes, access to namespace types not listed is
1690 prohibited (whitelisting). By prepending the list with a single tilde character (<literal>~</literal>) the
1691 effect may be inverted: only the listed namespace types will be made inaccessible, all unlisted ones are
1692 permitted (blacklisting). If the empty string is assigned, the default namespace restrictions are applied,
1693 which is equivalent to false. Internally, this setting limits access to the
1694 <citerefentry><refentrytitle>unshare</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
1695 <citerefentry><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry> and
1696 <citerefentry><refentrytitle>setns</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls, taking
1697 the specified flags parameters into account. Note that — if this option is used — in addition to restricting
1698 creation and switching of the specified types of namespaces (or all of them, if true) access to the
1699 <function>setns()</function> system call with a zero flags parameter is prohibited. This setting is only
1700 supported on x86, x86-64, mips, mips-le, mips64, mips64-le, mips64-n32, mips64-le-n32, ppc64, ppc64-le,
1701 s390 and s390x, and enforces no restrictions on other architectures. If running in user
1702 mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1703 <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied. </para></listitem>
1704 </varlistentry>
1705
1706 <varlistentry>
1707 <term><varname>Personality=</varname></term>
1708
1709 <listitem><para>Controls which kernel architecture <citerefentry
1710 project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall report,
1711 when invoked by unit processes. Takes one of the architecture identifiers <constant>x86</constant>,
1712 <constant>x86-64</constant>, <constant>ppc</constant>, <constant>ppc-le</constant>, <constant>ppc64</constant>,
1713 <constant>ppc64-le</constant>, <constant>s390</constant> or <constant>s390x</constant>. Which personality
1714 architectures are supported depends on the system architecture. Usually the 64bit versions of the various
1715 system architectures support their immediate 32bit personality architecture counterpart, but no others. For
1716 example, <constant>x86-64</constant> systems support the <constant>x86-64</constant> and
1717 <constant>x86</constant> personalities but no others. The personality feature is useful when running 32-bit
1718 services on a 64-bit host system. If not specified, the personality is left unmodified and thus reflects the
1719 personality of the host system's kernel.</para></listitem>
1720 </varlistentry>
1721
1722 <varlistentry>
1723 <term><varname>LockPersonality=</varname></term>
1724
1725 <listitem><para>Takes a boolean argument. If set, locks down the <citerefentry
1726 project='man-pages'><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
1727 call so that the kernel execution domain may not be changed from the default or the personality selected with
1728 <varname>Personality=</varname> directive. This may be useful to improve security, because odd personality
1729 emulations may be poorly tested and source of vulnerabilities. If running in user mode, or in system mode, but
1730 without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
1731 <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
1732 </varlistentry>
1733
1734 <varlistentry>
1735 <term><varname>KeyringMode=</varname></term>
1736
1737 <listitem><para>Controls how the kernel session keyring is set up for the service (see <citerefentry
1738 project='man-pages'><refentrytitle>session-keyring</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
1739 details on the session keyring). Takes one of <option>inherit</option>, <option>private</option>,
1740 <option>shared</option>. If set to <option>inherit</option> no special keyring setup is done, and the kernel's
1741 default behaviour is applied. If <option>private</option> is used a new session keyring is allocated when a
1742 service process is invoked, and it is not linked up with any user keyring. This is the recommended setting for
1743 system services, as this ensures that multiple services running under the same system user ID (in particular
1744 the root user) do not share their key material among each other. If <option>shared</option> is used a new
1745 session keyring is allocated as for <option>private</option>, but the user keyring of the user configured with
1746 <varname>User=</varname> is linked into it, so that keys assigned to the user may be requested by the unit's
1747 processes. In this modes multiple units running processes under the same user ID may share key material. Unless
1748 <option>inherit</option> is selected the unique invocation ID for the unit (see below) is added as a protected
1749 key by the name <literal>invocation_id</literal> to the newly created session keyring. Defaults to
1750 <option>private</option> for the system service manager and to <option>inherit</option> for the user service
1751 manager.</para></listitem>
1752 </varlistentry>
1753
1754 <varlistentry>
1755 <term><varname>RuntimeDirectory=</varname></term>
1756
1757 <listitem><para>Takes a whitespace-separated list of directory names. The specified directory names must be
1758 relative, and may not include <literal>.</literal> or <literal>..</literal>. If set, one or more directories
1759 including their parents by the specified names will be created below <filename>/run</filename> (for system
1760 services) or below <varname>$XDG_RUNTIME_DIR</varname> (for user services) when the unit is started. The
1761 lowest subdirectories are removed when the unit is stopped. It is possible to preserve the directories if
1762 <varname>RuntimeDirectoryPreserve=</varname> is configured to <option>restart</option> or <option>yes</option>.
1763 The lowest subdirectories will have the access mode specified in <varname>RuntimeDirectoryMode=</varname>,
1764 and be owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>.
1765 This implies <varname>ReadWritePaths=</varname>, that is, the directories specified
1766 in this option are accessible with the access mode specified in <varname>RuntimeDirectoryMode=</varname>
1767 even if <varname>ProtectSystem=</varname> is set to <option>strict</option>.
1768 Use this to manage one or more runtime directories of the unit and bind their
1769 lifetime to the daemon runtime. This is particularly useful for unprivileged daemons that cannot create
1770 runtime directories in <filename>/run</filename> due to lack of privileges, and to make sure the runtime
1771 directory is cleaned up automatically after use. For runtime directories that require more complex or
1772 different configuration or lifetime guarantees, please consider using
1773 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1774
1775 <para>Example: if a system service unit has the following,
1776 <programlisting>RuntimeDirectory=foo/bar baz</programlisting>
1777 the service manager creates <filename>/run/foo</filename> (if it does not exist), <filename>/run/foo/bar</filename>,
1778 and <filename>/run/baz</filename>. The directories <filename>/run/foo/bar</filename> and <filename>/run/baz</filename>
1779 except <filename>/run/foo</filename> are owned by the user and group specified in <varname>User=</varname> and
1780 <varname>Group=</varname>, and removed when the service is stopped.
1781 </para></listitem>
1782 </varlistentry>
1783
1784 <varlistentry>
1785 <term><varname>StateDirectory=</varname></term>
1786 <term><varname>CacheDirectory=</varname></term>
1787 <term><varname>LogsDirectory=</varname></term>
1788 <term><varname>ConfigurationDirectory=</varname></term>
1789
1790 <listitem><para>Takes a whitespace-separated list of directory names. If set, as similar to
1791 <varname>RuntimeDirectory=</varname>, one or more directories including their parents by the specified names
1792 will be created below <filename>/var/lib</filename>, <filename>/var/cache</filename>, <filename>/var/log</filename>,
1793 or <filename>/etc</filename>, respectively, when the unit is started.
1794 Unlike <varname>RuntimeDirectory=</varname>, the directories are not removed when the unit is stopped.
1795 The lowest subdirectories will be owned by the user and group specified in <varname>User=</varname>
1796 and <varname>Group=</varname>. The options imply <varname>ReadWritePaths=</varname>.
1797 </para></listitem>
1798 </varlistentry>
1799
1800 <varlistentry>
1801 <term><varname>RuntimeDirectoryMode=</varname></term>
1802 <term><varname>StateDirectoryMode=</varname></term>
1803 <term><varname>CacheDirectoryMode=</varname></term>
1804 <term><varname>LogsDirectoryMode=</varname></term>
1805 <term><varname>ConfigurationDirectoryMode=</varname></term>
1806
1807 <listitem><para>Specifies the access mode of the directories specified in
1808 <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
1809 <varname>LogsDirectory=</varname>, or <varname>ConfigurationDirectory=</varname>, respectively, as an octal number.
1810 Defaults to <constant>0755</constant>. See "Permissions" in
1811 <citerefentry project='man-pages'><refentrytitle>path_resolution</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1812 for a discussion of the meaning of permission bits.
1813 </para></listitem>
1814 </varlistentry>
1815
1816 <varlistentry>
1817 <term><varname>RuntimeDirectoryPreserve=</varname></term>
1818
1819 <listitem><para>Takes a boolean argument or <option>restart</option>.
1820 If set to <option>no</option> (the default), the directories specified in <varname>RuntimeDirectory=</varname>
1821 are always removed when the service stops. If set to <option>restart</option> the directories are preserved
1822 when the service is both automatically and manually restarted. Here, the automatic restart means the operation
1823 specified in <varname>Restart=</varname>, and manual restart means the one triggered by
1824 <command>systemctl restart foo.service</command>. If set to <option>yes</option>, then the directories are not
1825 removed when the service is stopped. Note that since the runtime directory <filename>/run</filename> is a mount
1826 point of <literal>tmpfs</literal>, then for system services the directories specified in
1827 <varname>RuntimeDirectory=</varname> are removed when the system is rebooted.
1828 </para></listitem>
1829 </varlistentry>
1830
1831 <varlistentry>
1832 <term><varname>MemoryDenyWriteExecute=</varname></term>
1833
1834 <listitem><para>Takes a boolean argument. If set, attempts to create memory mappings that are writable and
1835 executable at the same time, or to change existing memory mappings to become executable, or mapping shared
1836 memory segments as executable are prohibited. Specifically, a system call filter is added that rejects
1837 <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with both
1838 <constant>PROT_EXEC</constant> and <constant>PROT_WRITE</constant> set,
1839 <citerefentry><refentrytitle>mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with
1840 <constant>PROT_EXEC</constant> set and
1841 <citerefentry><refentrytitle>shmat</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with
1842 <constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs and libraries that
1843 generate program code dynamically at runtime, including JIT execution engines, executable stacks, and code
1844 "trampoline" feature of various C compilers. This option improves service security, as it makes harder for
1845 software exploits to change running code dynamically. Note that this feature is fully available on x86-64, and
1846 partially on x86. Specifically, the <function>shmat()</function> protection is not available on x86. Note that
1847 on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for
1848 services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is
1849 recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If
1850 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability
1851 (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
1852 </varlistentry>
1853
1854 <varlistentry>
1855 <term><varname>RestrictRealtime=</varname></term>
1856
1857 <listitem><para>Takes a boolean argument. If set, any attempts to enable realtime scheduling in a process of
1858 the unit are refused. This restricts access to realtime task scheduling policies such as
1859 <constant>SCHED_FIFO</constant>, <constant>SCHED_RR</constant> or <constant>SCHED_DEADLINE</constant>. See
1860 <citerefentry project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details about
1861 these scheduling policies. If running in user mode, or in system mode, but
1862 without the <constant>CAP_SYS_ADMIN</constant> capability
1863 (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1864 is implied. Realtime scheduling policies may be used to monopolize CPU time for longer periods
1865 of time, and may hence be used to lock up or otherwise trigger Denial-of-Service situations on the system. It
1866 is hence recommended to restrict access to realtime scheduling to the few programs that actually require
1867 them. Defaults to off.</para></listitem>
1868 </varlistentry>
1869
1870 </variablelist>
1871 </refsect1>
1872
1873 <refsect1>
1874 <title>Environment variables in spawned processes</title>
1875
1876 <para>Processes started by the service manager are executed with an environment variable block assembled from
1877 multiple sources. Processes started by the system service manager generally do not inherit environment variables
1878 set for the service manager itself (but this may be altered via <varname>PassEnvironment=</varname>), but processes
1879 started by the user service manager instances generally do inherit all environment variables set for the service
1880 manager itself.</para>
1881
1882 <para>For each invoked process the list of environment variables set is compiled from the following sources:</para>
1883
1884 <itemizedlist>
1885 <listitem><para>Variables globally configured for the service manager, using the
1886 <varname>DefaultEnvironment=</varname> setting in
1887 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, the kernel command line option <varname>systemd.setenv=</varname> (see
1888 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>) or via
1889 <command>systemctl set-environment</command> (see <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).</para></listitem>
1890
1891 <listitem><para>Variables defined by the service manager itself (see the list below)</para></listitem>
1892
1893 <listitem><para>Variables set in the service manager's own environment variable block (subject to <varname>PassEnvironment=</varname> for the system service manager)</para></listitem>
1894
1895 <listitem><para>Variables set via <varname>Environment=</varname> in the unit file</para></listitem>
1896
1897 <listitem><para>Variables read from files specified via <varname>EnvironmentFiles=</varname> in the unit file</para></listitem>
1898
1899 <listitem><para>Variables set by any PAM modules in case <varname>PAMName=</varname> is in effect, cf. <citerefentry project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry></para></listitem>
1900 </itemizedlist>
1901
1902 <para>If the same environment variables are set by multiple of these sources, the later source — according to the
1903 order of the list above — wins. Note that as final step all variables listed in
1904 <varname>UnsetEnvironment=</varname> are removed again from the compiled environment variable list, immediately
1905 before it is passed to the executed process.</para>
1906
1907 <para>The following select environment variables are set by the service manager itself for each invoked process:</para>
1908
1909 <variablelist class='environment-variables'>
1910 <varlistentry>
1911 <term><varname>$PATH</varname></term>
1912
1913 <listitem><para>Colon-separated list of directories to use
1914 when launching executables. Systemd uses a fixed value of
1915 <filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename>:<filename>/sbin</filename>:<filename>/bin</filename>.
1916 </para></listitem>
1917 </varlistentry>
1918
1919 <varlistentry>
1920 <term><varname>$LANG</varname></term>
1921
1922 <listitem><para>Locale. Can be set in
1923 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1924 or on the kernel command line (see
1925 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1926 and
1927 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
1928 </para></listitem>
1929 </varlistentry>
1930
1931 <varlistentry>
1932 <term><varname>$USER</varname></term>
1933 <term><varname>$LOGNAME</varname></term>
1934 <term><varname>$HOME</varname></term>
1935 <term><varname>$SHELL</varname></term>
1936
1937 <listitem><para>User name (twice), home directory, and the
1938 login shell. The variables are set for the units that have
1939 <varname>User=</varname> set, which includes user
1940 <command>systemd</command> instances. See
1941 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1942 </para></listitem>
1943 </varlistentry>
1944
1945 <varlistentry>
1946 <term><varname>$INVOCATION_ID</varname></term>
1947
1948 <listitem><para>Contains a randomized, unique 128bit ID identifying each runtime cycle of the unit, formatted
1949 as 32 character hexadecimal string. A new ID is assigned each time the unit changes from an inactive state into
1950 an activating or active state, and may be used to identify this specific runtime cycle, in particular in data
1951 stored offline, such as the journal. The same ID is passed to all processes run as part of the
1952 unit.</para></listitem>
1953 </varlistentry>
1954
1955 <varlistentry>
1956 <term><varname>$XDG_RUNTIME_DIR</varname></term>
1957
1958 <listitem><para>The directory for volatile state. Set for the
1959 user <command>systemd</command> instance, and also in user
1960 sessions. See
1961 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1962 </para></listitem>
1963 </varlistentry>
1964
1965 <varlistentry>
1966 <term><varname>$XDG_SESSION_ID</varname></term>
1967 <term><varname>$XDG_SEAT</varname></term>
1968 <term><varname>$XDG_VTNR</varname></term>
1969
1970 <listitem><para>The identifier of the session, the seat name,
1971 and virtual terminal of the session. Set by
1972 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1973 for login sessions. <varname>$XDG_SEAT</varname> and
1974 <varname>$XDG_VTNR</varname> will only be set when attached to
1975 a seat and a tty.</para></listitem>
1976 </varlistentry>
1977
1978 <varlistentry>
1979 <term><varname>$MAINPID</varname></term>
1980
1981 <listitem><para>The PID of the unit's main process if it is
1982 known. This is only set for control processes as invoked by
1983 <varname>ExecReload=</varname> and similar. </para></listitem>
1984 </varlistentry>
1985
1986 <varlistentry>
1987 <term><varname>$MANAGERPID</varname></term>
1988
1989 <listitem><para>The PID of the user <command>systemd</command>
1990 instance, set for processes spawned by it. </para></listitem>
1991 </varlistentry>
1992
1993 <varlistentry>
1994 <term><varname>$LISTEN_FDS</varname></term>
1995 <term><varname>$LISTEN_PID</varname></term>
1996 <term><varname>$LISTEN_FDNAMES</varname></term>
1997
1998 <listitem><para>Information about file descriptors passed to a
1999 service for socket activation. See
2000 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2001 </para></listitem>
2002 </varlistentry>
2003
2004 <varlistentry>
2005 <term><varname>$NOTIFY_SOCKET</varname></term>
2006
2007 <listitem><para>The socket
2008 <function>sd_notify()</function> talks to. See
2009 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2010 </para></listitem>
2011 </varlistentry>
2012
2013 <varlistentry>
2014 <term><varname>$WATCHDOG_PID</varname></term>
2015 <term><varname>$WATCHDOG_USEC</varname></term>
2016
2017 <listitem><para>Information about watchdog keep-alive notifications. See
2018 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2019 </para></listitem>
2020 </varlistentry>
2021
2022 <varlistentry>
2023 <term><varname>$TERM</varname></term>
2024
2025 <listitem><para>Terminal type, set only for units connected to
2026 a terminal (<varname>StandardInput=tty</varname>,
2027 <varname>StandardOutput=tty</varname>, or
2028 <varname>StandardError=tty</varname>). See
2029 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2030 </para></listitem>
2031 </varlistentry>
2032
2033 <varlistentry>
2034 <term><varname>$JOURNAL_STREAM</varname></term>
2035
2036 <listitem><para>If the standard output or standard error output of the executed processes are connected to the
2037 journal (for example, by setting <varname>StandardError=journal</varname>) <varname>$JOURNAL_STREAM</varname>
2038 contains the device and inode numbers of the connection file descriptor, formatted in decimal, separated by a
2039 colon (<literal>:</literal>). This permits invoked processes to safely detect whether their standard output or
2040 standard error output are connected to the journal. The device and inode numbers of the file descriptors should
2041 be compared with the values set in the environment variable to determine whether the process output is still
2042 connected to the journal. Note that it is generally not sufficient to only check whether
2043 <varname>$JOURNAL_STREAM</varname> is set at all as services might invoke external processes replacing their
2044 standard output or standard error output, without unsetting the environment variable.</para>
2045
2046 <para>If both standard output and standard error of the executed processes are connected to the journal via a
2047 stream socket, this environment variable will contain information about the standard error stream, as that's
2048 usually the preferred destination for log data. (Note that typically the same stream is used for both standard
2049 output and standard error, hence very likely the environment variable contains device and inode information
2050 matching both stream file descriptors.)</para>
2051
2052 <para>This environment variable is primarily useful to allow services to optionally upgrade their used log
2053 protocol to the native journal protocol (using
2054 <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other
2055 functions) if their standard output or standard error output is connected to the journal anyway, thus enabling
2056 delivery of structured metadata along with logged messages.</para></listitem>
2057 </varlistentry>
2058
2059 <varlistentry>
2060 <term><varname>$SERVICE_RESULT</varname></term>
2061
2062 <listitem><para>Only defined for the service unit type, this environment variable is passed to all
2063 <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
2064 "result". Currently, the following values are defined:</para>
2065
2066 <table>
2067 <title>Defined <varname>$SERVICE_RESULT</varname> values</title>
2068 <tgroup cols='2'>
2069 <colspec colname='result'/>
2070 <colspec colname='meaning'/>
2071 <thead>
2072 <row>
2073 <entry>Value</entry>
2074 <entry>Meaning</entry>
2075 </row>
2076 </thead>
2077
2078 <tbody>
2079 <row>
2080 <entry><literal>success</literal></entry>
2081 <entry>The service ran successfully and exited cleanly.</entry>
2082 </row>
2083 <row>
2084 <entry><literal>protocol</literal></entry>
2085 <entry>A protocol violation occurred: the service did not take the steps required by its unit configuration (specifically what is configured in its <varname>Type=</varname> setting).</entry>
2086 </row>
2087 <row>
2088 <entry><literal>timeout</literal></entry>
2089 <entry>One of the steps timed out.</entry>
2090 </row>
2091 <row>
2092 <entry><literal>exit-code</literal></entry>
2093 <entry>Service process exited with a non-zero exit code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned.</entry>
2094 </row>
2095 <row>
2096 <entry><literal>signal</literal></entry>
2097 <entry>A service process was terminated abnormally by a signal, without dumping core. See <varname>$EXIT_CODE</varname> below for the actual signal causing the termination.</entry>
2098 </row>
2099 <row>
2100 <entry><literal>core-dump</literal></entry>
2101 <entry>A service process terminated abnormally with a signal and dumped core. See <varname>$EXIT_CODE</varname> below for the signal causing the termination.</entry>
2102 </row>
2103 <row>
2104 <entry><literal>watchdog</literal></entry>
2105 <entry>Watchdog keep-alive ping was enabled for the service, but the deadline was missed.</entry>
2106 </row>
2107 <row>
2108 <entry><literal>start-limit-hit</literal></entry>
2109 <entry>A start limit was defined for the unit and it was hit, causing the unit to fail to start. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> for details.</entry>
2110 </row>
2111 <row>
2112 <entry><literal>resources</literal></entry>
2113 <entry>A catch-all condition in case a system operation failed.</entry>
2114 </row>
2115 </tbody>
2116 </tgroup>
2117 </table>
2118
2119 <para>This environment variable is useful to monitor failure or successful termination of a service. Even
2120 though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it
2121 is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services
2122 that managed to start up correctly, and the latter covers both services that failed during their start-up and
2123 those which failed during their runtime.</para></listitem>
2124 </varlistentry>
2125
2126 <varlistentry>
2127 <term><varname>$EXIT_CODE</varname></term>
2128 <term><varname>$EXIT_STATUS</varname></term>
2129
2130 <listitem><para>Only defined for the service unit type, these environment variables are passed to all
2131 <varname>ExecStop=</varname>, <varname>ExecStopPost=</varname> processes and contain exit status/code
2132 information of the main process of the service. For the precise definition of the exit code and status, see
2133 <citerefentry><refentrytitle>wait</refentrytitle><manvolnum>2</manvolnum></citerefentry>. <varname>$EXIT_CODE</varname>
2134 is one of <literal>exited</literal>, <literal>killed</literal>,
2135 <literal>dumped</literal>. <varname>$EXIT_STATUS</varname> contains the numeric exit code formatted as string
2136 if <varname>$EXIT_CODE</varname> is <literal>exited</literal>, and the signal name in all other cases. Note
2137 that these environment variables are only set if the service manager succeeded to start and identify the main
2138 process of the service.</para>
2139
2140 <table>
2141 <title>Summary of possible service result variable values</title>
2142 <tgroup cols='3'>
2143 <colspec colname='result' />
2144 <colspec colname='code' />
2145 <colspec colname='status' />
2146 <thead>
2147 <row>
2148 <entry><varname>$SERVICE_RESULT</varname></entry>
2149 <entry><varname>$EXIT_CODE</varname></entry>
2150 <entry><varname>$EXIT_STATUS</varname></entry>
2151 </row>
2152 </thead>
2153
2154 <tbody>
2155 <row>
2156 <entry valign="top"><literal>success</literal></entry>
2157 <entry valign="top"><literal>exited</literal></entry>
2158 <entry><literal>0</literal></entry>
2159 </row>
2160 <row>
2161 <entry morerows="1" valign="top"><literal>protocol</literal></entry>
2162 <entry valign="top">not set</entry>
2163 <entry>not set</entry>
2164 </row>
2165 <row>
2166 <entry><literal>exited</literal></entry>
2167 <entry><literal>0</literal></entry>
2168 </row>
2169 <row>
2170 <entry morerows="1" valign="top"><literal>timeout</literal></entry>
2171 <entry valign="top"><literal>killed</literal></entry>
2172 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
2173 </row>
2174 <row>
2175 <entry valign="top"><literal>exited</literal></entry>
2176 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2177 >3</literal>, …, <literal>255</literal></entry>
2178 </row>
2179 <row>
2180 <entry valign="top"><literal>exit-code</literal></entry>
2181 <entry valign="top"><literal>exited</literal></entry>
2182 <entry><literal>1</literal>, <literal>2</literal>, <literal
2183 >3</literal>, …, <literal>255</literal></entry>
2184 </row>
2185 <row>
2186 <entry valign="top"><literal>signal</literal></entry>
2187 <entry valign="top"><literal>killed</literal></entry>
2188 <entry><literal>HUP</literal>, <literal>INT</literal>, <literal>KILL</literal>, …</entry>
2189 </row>
2190 <row>
2191 <entry valign="top"><literal>core-dump</literal></entry>
2192 <entry valign="top"><literal>dumped</literal></entry>
2193 <entry><literal>ABRT</literal>, <literal>SEGV</literal>, <literal>QUIT</literal>, …</entry>
2194 </row>
2195 <row>
2196 <entry morerows="2" valign="top"><literal>watchdog</literal></entry>
2197 <entry><literal>dumped</literal></entry>
2198 <entry><literal>ABRT</literal></entry>
2199 </row>
2200 <row>
2201 <entry><literal>killed</literal></entry>
2202 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
2203 </row>
2204 <row>
2205 <entry><literal>exited</literal></entry>
2206 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2207 >3</literal>, …, <literal>255</literal></entry>
2208 </row>
2209 <row>
2210 <entry><literal>start-limit-hit</literal></entry>
2211 <entry>not set</entry>
2212 <entry>not set</entry>
2213 </row>
2214 <row>
2215 <entry><literal>resources</literal></entry>
2216 <entry>any of the above</entry>
2217 <entry>any of the above</entry>
2218 </row>
2219 <row>
2220 <entry namest="results" nameend="status">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. Moreover, using <varname>SuccessExitStatus=</varname> additional exit statuses may be declared to indicate clean termination, which is not reflected by this table.</entry>
2221 </row>
2222 </tbody>
2223 </tgroup>
2224 </table>
2225
2226 </listitem>
2227 </varlistentry>
2228 </variablelist>
2229 </refsect1>
2230
2231 <refsect1>
2232 <title>Process exit codes</title>
2233
2234 <para>When invoking a unit process the service manager possibly fails to apply the execution parameters configured
2235 with the settings above. In that case the already created service process will exit with a non-zero exit code
2236 before the configured command line is executed. (Or in other words, the child process possibly exits with these
2237 error codes, after having been created by the <citerefentry
2238 project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, but
2239 before the matching <citerefentry
2240 project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call is
2241 called.) Specifically, exit codes defined by the C library, by the LSB specification and by the systemd service
2242 manager itself are used.</para>
2243
2244 <para>The following basic service exit codes are defined by the C library.</para>
2245
2246 <table>
2247 <title>Basic C library exit codes</title>
2248 <tgroup cols='3'>
2249 <thead>
2250 <row>
2251 <entry>Exit Code</entry>
2252 <entry>Symbolic Name</entry>
2253 <entry>Description</entry>
2254 </row>
2255 </thead>
2256 <tbody>
2257 <row>
2258 <entry>0</entry>
2259 <entry><constant>EXIT_SUCCESS</constant></entry>
2260 <entry>Generic success code.</entry>
2261 </row>
2262 <row>
2263 <entry>1</entry>
2264 <entry><constant>EXIT_FAILURE</constant></entry>
2265 <entry>Generic failure or unspecified error.</entry>
2266 </row>
2267 </tbody>
2268 </tgroup>
2269 </table>
2270
2271 <para>The following service exit codes are defined by the <ulink
2272 url="https://refspecs.linuxbase.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html">LSB specification
2273 </ulink>.
2274 </para>
2275
2276 <table>
2277 <title>LSB service exit codes</title>
2278 <tgroup cols='3'>
2279 <thead>
2280 <row>
2281 <entry>Exit Code</entry>
2282 <entry>Symbolic Name</entry>
2283 <entry>Description</entry>
2284 </row>
2285 </thead>
2286 <tbody>
2287 <row>
2288 <entry>2</entry>
2289 <entry><constant>EXIT_INVALIDARGUMENT</constant></entry>
2290 <entry>Invalid or excess arguments.</entry>
2291 </row>
2292 <row>
2293 <entry>3</entry>
2294 <entry><constant>EXIT_NOTIMPLEMENTED</constant></entry>
2295 <entry>Unimplemented feature.</entry>
2296 </row>
2297 <row>
2298 <entry>4</entry>
2299 <entry><constant>EXIT_NOPERMISSION</constant></entry>
2300 <entry>The user has insufficient privileges.</entry>
2301 </row>
2302 <row>
2303 <entry>5</entry>
2304 <entry><constant>EXIT_NOTINSTALLED</constant></entry>
2305 <entry>The program is not installed.</entry>
2306 </row>
2307 <row>
2308 <entry>6</entry>
2309 <entry><constant>EXIT_NOTCONFIGURED</constant></entry>
2310 <entry>The program is not configured.</entry>
2311 </row>
2312 <row>
2313 <entry>7</entry>
2314 <entry><constant>EXIT_NOTRUNNING</constant></entry>
2315 <entry>The program is not running.</entry>
2316 </row>
2317 </tbody>
2318 </tgroup>
2319 </table>
2320
2321 <para>
2322 The LSB specification suggests that error codes 200 and above are reserved for implementations. Some of them are
2323 used by the service manager to indicate problems during process invocation:
2324 </para>
2325 <table>
2326 <title>systemd-specific exit codes</title>
2327 <tgroup cols='3'>
2328 <thead>
2329 <row>
2330 <entry>Exit Code</entry>
2331 <entry>Symbolic Name</entry>
2332 <entry>Description</entry>
2333 </row>
2334 </thead>
2335 <tbody>
2336 <row>
2337 <entry>200</entry>
2338 <entry><constant>EXIT_CHDIR</constant></entry>
2339 <entry>Changing to the requested working directory failed. See <varname>WorkingDirectory=</varname> above.</entry>
2340 </row>
2341 <row>
2342 <entry>201</entry>
2343 <entry><constant>EXIT_NICE</constant></entry>
2344 <entry>Failed to set up process scheduling priority (nice level). See <varname>Nice=</varname> above.</entry>
2345 </row>
2346 <row>
2347 <entry>202</entry>
2348 <entry><constant>EXIT_FDS</constant></entry>
2349 <entry>Failed to close unwanted file descriptors, or to adjust passed file descriptors.</entry>
2350 </row>
2351 <row>
2352 <entry>203</entry>
2353 <entry><constant>EXIT_EXEC</constant></entry>
2354 <entry>The actual process execution failed (specifically, the <citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call). Most likely this is caused by a missing or non-accessible executable file.</entry>
2355 </row>
2356 <row>
2357 <entry>204</entry>
2358 <entry><constant>EXIT_MEMORY</constant></entry>
2359 <entry>Failed to perform an action due to memory shortage.</entry>
2360 </row>
2361 <row>
2362 <entry>205</entry>
2363 <entry><constant>EXIT_LIMITS</constant></entry>
2364 <entry>Failed to adjust resoure limits. See <varname>LimitCPU=</varname> and related settings above.</entry>
2365 </row>
2366 <row>
2367 <entry>206</entry>
2368 <entry><constant>EXIT_OOM_ADJUST</constant></entry>
2369 <entry>Failed to adjust the OOM setting. See <varname>OOMScoreAdjust=</varname> above.</entry>
2370 </row>
2371 <row>
2372 <entry>207</entry>
2373 <entry><constant>EXIT_SIGNAL_MASK</constant></entry>
2374 <entry>Failed to set process signal mask.</entry>
2375 </row>
2376 <row>
2377 <entry>208</entry>
2378 <entry><constant>EXIT_STDIN</constant></entry>
2379 <entry>Failed to set up standard input. See <varname>StandardInput=</varname> above.</entry>
2380 </row>
2381 <row>
2382 <entry>209</entry>
2383 <entry><constant>EXIT_STDOUT</constant></entry>
2384 <entry>Failed to set up standard output. See <varname>StandardOutput=</varname> above.</entry>
2385 </row>
2386 <row>
2387 <entry>210</entry>
2388 <entry><constant>EXIT_CHROOT</constant></entry>
2389 <entry>Failed to change root directory (<citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>). See <varname>RootDirectory=</varname>/<varname>RootImage=</varname> above.</entry>
2390 </row>
2391 <row>
2392 <entry>211</entry>
2393 <entry><constant>EXIT_IOPRIO</constant></entry>
2394 <entry>Failed to set up IO scheduling priority. See <varname>IOSchedulingClass=</varname>/<varname>IOSchedulingPriority=</varname> above.</entry>
2395 </row>
2396 <row>
2397 <entry>212</entry>
2398 <entry><constant>EXIT_TIMERSLACK</constant></entry>
2399 <entry>Failed to set up timer slack. See <varname>TimerSlackNSec=</varname> above.</entry>
2400 </row>
2401 <row>
2402 <entry>213</entry>
2403 <entry><constant>EXIT_SECUREBITS</constant></entry>
2404 <entry>Failed to set process secure bits. See <varname>SecureBits=</varname> above.</entry>
2405 </row>
2406 <row>
2407 <entry>214</entry>
2408 <entry><constant>EXIT_SETSCHEDULER</constant></entry>
2409 <entry>Failed to set up CPU scheduling. See <varname>CPUSchedulingPolicy=</varname>/<varname>CPUSchedulingPriority=</varname> above.</entry>
2410 </row>
2411 <row>
2412 <entry>215</entry>
2413 <entry><constant>EXIT_CPUAFFINITY</constant></entry>
2414 <entry>Failed to set up CPU affinity. See <varname>CPUAffinity=</varname> above.</entry>
2415 </row>
2416 <row>
2417 <entry>216</entry>
2418 <entry><constant>EXIT_GROUP</constant></entry>
2419 <entry>Failed to determine or change group credentials. See <varname>Group=</varname>/<varname>SupplementaryGroups=</varname> above.</entry>
2420 </row>
2421 <row>
2422 <entry>217</entry>
2423 <entry><constant>EXIT_USER</constant></entry>
2424 <entry>Failed to determine or change user credentials, or to set up user namespacing. See <varname>User=</varname>/<varname>PrivateUsers=</varname> above.</entry>
2425 </row>
2426 <row>
2427 <entry>218</entry>
2428 <entry><constant>EXIT_CAPABILITIES</constant></entry>
2429 <entry>Failed to drop capabilities, or apply ambient capabilities. See <varname>CapabilityBoundingSet=</varname>/<varname>AmbientCapabilities=</varname> above.</entry>
2430 </row>
2431 <row>
2432 <entry>219</entry>
2433 <entry><constant>EXIT_CGROUP</constant></entry>
2434 <entry>Setting up the service control group failed.</entry>
2435 </row>
2436 <row>
2437 <entry>220</entry>
2438 <entry><constant>EXIT_SETSID</constant></entry>
2439 <entry>Failed to create new process session.</entry>
2440 </row>
2441 <row>
2442 <entry>221</entry>
2443 <entry><constant>EXIT_CONFIRM</constant></entry>
2444 <entry>Execution has been cancelled by the user. See the <varname>systemd.confirm_spawn=</varname> kernel command line setting on <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.</entry>
2445 </row>
2446 <row>
2447 <entry>222</entry>
2448 <entry><constant>EXIT_STDERR</constant></entry>
2449 <entry>Failed to set up standard error output. See <varname>StandardError=</varname> above.</entry>
2450 </row>
2451 <row>
2452 <entry>224</entry>
2453 <entry><constant>EXIT_PAM</constant></entry>
2454 <entry>Failed to set up PAM session. See <varname>PAMName=</varname> above.</entry>
2455 </row>
2456 <row>
2457 <entry>225</entry>
2458 <entry><constant>EXIT_NETWORK</constant></entry>
2459 <entry>Failed to set up network namespacing. See <varname>PrivateNetwork=</varname> above.</entry>
2460 </row>
2461 <row>
2462 <entry>226</entry>
2463 <entry><constant>EXIT_NAMESPACE</constant></entry>
2464 <entry>Failed to set up mount namespacing. See <varname>ReadOnlyPaths=</varname> and related settings above.</entry>
2465 </row>
2466 <row>
2467 <entry>227</entry>
2468 <entry><constant>EXIT_NO_NEW_PRIVILEGES</constant></entry>
2469 <entry>Failed to disable new priviliges. See <varname>NoNewPrivileges=yes</varname> above.</entry>
2470 </row>
2471 <row>
2472 <entry>228</entry>
2473 <entry><constant>EXIT_SECCOMP</constant></entry>
2474 <entry>Failed to apply system call filters. See <varname>SystemCallFilter=</varname> and related settings above.</entry>
2475 </row>
2476 <row>
2477 <entry>229</entry>
2478 <entry><constant>EXIT_SELINUX_CONTEXT</constant></entry>
2479 <entry>Determining or changing SELinux context failed. See <varname>SELinuxContext=</varname> above.</entry>
2480 </row>
2481 <row>
2482 <entry>230</entry>
2483 <entry><constant>EXIT_PERSONALITY</constant></entry>
2484 <entry>Failed to set up a execution domain (personality). See <varname>Personality=</varname> above.</entry>
2485 </row>
2486 <row>
2487 <entry>231</entry>
2488 <entry><constant>EXIT_APPARMOR_PROFILE</constant></entry>
2489 <entry>Failed to prepare changing AppArmor profile. See <varname>AppArmorProfile=</varname> above.</entry>
2490 </row>
2491 <row>
2492 <entry>232</entry>
2493 <entry><constant>EXIT_ADDRESS_FAMILIES</constant></entry>
2494 <entry>Failed to restrict address families. See <varname>RestrictAddressFamilies=</varname> above.</entry>
2495 </row>
2496 <row>
2497 <entry>233</entry>
2498 <entry><constant>EXIT_RUNTIME_DIRECTORY</constant></entry>
2499 <entry>Setting up runtime directory failed. See <varname>RuntimeDirectory=</varname> and related settings above.</entry>
2500 </row>
2501 <row>
2502 <entry>235</entry>
2503 <entry><constant>EXIT_CHOWN</constant></entry>
2504 <entry>Failed to adjust socket ownership. Used for socket units only.</entry>
2505 </row>
2506 <row>
2507 <entry>236</entry>
2508 <entry><constant>EXIT_SMACK_PROCESS_LABEL</constant></entry>
2509 <entry>Failed to set SMACK label. See <varname>SmackProcessLabel=</varname> above.</entry>
2510 </row>
2511 <row>
2512 <entry>237</entry>
2513 <entry><constant>EXIT_KEYRING</constant></entry>
2514 <entry>Failed to set up kernel keyring.</entry>
2515 </row>
2516 <row>
2517 <entry>238</entry>
2518 <entry><constant>EXIT_STATE_DIRECTORY</constant></entry>
2519 <entry>Failed to set up a the unit's state directory. See <varname>StateDirectory=</varname> above.</entry>
2520 </row>
2521 <row>
2522 <entry>239</entry>
2523 <entry><constant>EXIT_CACHE_DIRECTORY</constant></entry>
2524 <entry>Failed to set up a the unit's cache directory. See <varname>CacheDirectory=</varname> above.</entry>
2525 </row>
2526 <row>
2527 <entry>240</entry>
2528 <entry><constant>EXIT_LOGS_DIRECTORY</constant></entry>
2529 <entry>Failed to set up a the unit's logging directory. See <varname>LogsDirectory=</varname> above.</entry>
2530 </row>
2531 <row>
2532 <entry>241</entry>
2533 <entry><constant>EXIT_CONFIGURATION_DIRECTORY</constant></entry>
2534 <entry>Failed to set up a the unit's configuration directory. See <varname>ConfigurationDirectory=</varname> above.</entry>
2535 </row>
2536 </tbody>
2537 </tgroup>
2538 </table>
2539 </refsect1>
2540
2541 <refsect1>
2542 <title>See Also</title>
2543 <para>
2544 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2545 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2546 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2547 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2548 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2549 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2550 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2551 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2552 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2553 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2554 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2555 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2556 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2557 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2558 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
2559 </para>
2560 </refsect1>
2561
2562
2563 </refentry>