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