]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.exec.xml
Merge pull request #1761 from ssahani/word
[thirdparty/systemd.git] / man / systemd.exec.xml
CommitLineData
023a4f67 1<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
dd1eb43b 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
dd1eb43b
LP
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
5430f7f2
LP
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
dd1eb43b
LP
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
5430f7f2 18 Lesser General Public License for more details.
dd1eb43b 19
5430f7f2 20 You should have received a copy of the GNU Lesser General Public License
dd1eb43b
LP
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22-->
23
24<refentry id="systemd.exec">
798d3a52
ZJS
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 </refsect1>
78
79 <refsect1>
80 <title>Options</title>
81
82 <variablelist class='unit-directives'>
83
84 <varlistentry>
85 <term><varname>WorkingDirectory=</varname></term>
86
5f5d8eab
LP
87 <listitem><para>Takes an absolute directory path, or the
88 special value <literal>~</literal>. Sets the working directory
89 for executed processes. If set to <literal>~</literal> the
90 home directory of the user specified in
91 <varname>User=</varname> is used. If not set, defaults to the
92 root directory when systemd is running as a system instance
93 and the respective user's home directory if run as user. If
94 the setting is prefixed with the <literal>-</literal>
95 character, a missing working directory is not considered
96 fatal.</para></listitem>
798d3a52
ZJS
97 </varlistentry>
98
99 <varlistentry>
100 <term><varname>RootDirectory=</varname></term>
101
102 <listitem><para>Takes an absolute directory path. Sets the
5f5d8eab
LP
103 root directory for executed processes, with the <citerefentry
104 project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52 105 system call. If this is used, it must be ensured that the
5f5d8eab
LP
106 process binary and all its auxiliary files are available in
107 the <function>chroot()</function> jail.</para></listitem>
798d3a52
ZJS
108 </varlistentry>
109
110 <varlistentry>
111 <term><varname>User=</varname></term>
112 <term><varname>Group=</varname></term>
113
114 <listitem><para>Sets the Unix user or group that the processes
115 are executed as, respectively. Takes a single user or group
116 name or ID as argument. If no group is set, the default group
117 of the user is chosen.</para></listitem>
118 </varlistentry>
119
120 <varlistentry>
121 <term><varname>SupplementaryGroups=</varname></term>
122
123 <listitem><para>Sets the supplementary Unix groups the
124 processes are executed as. This takes a space-separated list
125 of group names or IDs. This option may be specified more than
126 once in which case all listed groups are set as supplementary
127 groups. When the empty string is assigned the list of
128 supplementary groups is reset, and all assignments prior to
129 this one will have no effect. In any way, this option does not
130 override, but extends the list of supplementary groups
131 configured in the system group database for the
132 user.</para></listitem>
133 </varlistentry>
134
135 <varlistentry>
136 <term><varname>Nice=</varname></term>
137
138 <listitem><para>Sets the default nice level (scheduling
139 priority) for executed processes. Takes an integer between -20
140 (highest priority) and 19 (lowest priority). See
141 <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>
142 for details.</para></listitem>
143 </varlistentry>
144
145 <varlistentry>
146 <term><varname>OOMScoreAdjust=</varname></term>
147
148 <listitem><para>Sets the adjustment level for the
149 Out-Of-Memory killer for executed processes. Takes an integer
150 between -1000 (to disable OOM killing for this process) and
151 1000 (to make killing of this process under memory pressure
152 very likely). See <ulink
153 url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
154 for details.</para></listitem>
155 </varlistentry>
156
157 <varlistentry>
158 <term><varname>IOSchedulingClass=</varname></term>
159
160 <listitem><para>Sets the IO scheduling class for executed
161 processes. Takes an integer between 0 and 3 or one of the
162 strings <option>none</option>, <option>realtime</option>,
163 <option>best-effort</option> or <option>idle</option>. See
164 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
165 for details.</para></listitem>
166 </varlistentry>
167
168 <varlistentry>
169 <term><varname>IOSchedulingPriority=</varname></term>
170
171 <listitem><para>Sets the IO scheduling priority for executed
172 processes. Takes an integer between 0 (highest priority) and 7
173 (lowest priority). The available priorities depend on the
174 selected IO scheduling class (see above). See
175 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
176 for details.</para></listitem>
177 </varlistentry>
178
179 <varlistentry>
180 <term><varname>CPUSchedulingPolicy=</varname></term>
181
182 <listitem><para>Sets the CPU scheduling policy for executed
183 processes. Takes one of
184 <option>other</option>,
185 <option>batch</option>,
186 <option>idle</option>,
187 <option>fifo</option> or
188 <option>rr</option>. See
189 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
190 for details.</para></listitem>
191 </varlistentry>
192
193 <varlistentry>
194 <term><varname>CPUSchedulingPriority=</varname></term>
195
196 <listitem><para>Sets the CPU scheduling priority for executed
197 processes. The available priority range depends on the
198 selected CPU scheduling policy (see above). For real-time
199 scheduling policies an integer between 1 (lowest priority) and
200 99 (highest priority) can be used. See
201 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
202 for details. </para></listitem>
203 </varlistentry>
204
205 <varlistentry>
206 <term><varname>CPUSchedulingResetOnFork=</varname></term>
207
208 <listitem><para>Takes a boolean argument. If true, elevated
209 CPU scheduling priorities and policies will be reset when the
210 executed processes fork, and can hence not leak into child
211 processes. See
212 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
213 for details. Defaults to false.</para></listitem>
214 </varlistentry>
215
216 <varlistentry>
217 <term><varname>CPUAffinity=</varname></term>
218
219 <listitem><para>Controls the CPU affinity of the executed
71b1c27a
FB
220 processes. Takes a list of CPU indices or ranges separated by
221 either whitespace or commas. CPU ranges are specified by the
222 lower and upper CPU indices separated by a dash.
223 This option may be specified more than once in which case the
798d3a52
ZJS
224 specified CPU affinity masks are merged. If the empty string
225 is assigned, the mask is reset, all assignments prior to this
226 will have no effect. See
227 <citerefentry><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry>
228 for details.</para></listitem>
229 </varlistentry>
230
231 <varlistentry>
232 <term><varname>UMask=</varname></term>
233
234 <listitem><para>Controls the file mode creation mask. Takes an
235 access mode in octal notation. See
236 <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry>
237 for details. Defaults to 0022.</para></listitem>
238 </varlistentry>
239
240 <varlistentry>
241 <term><varname>Environment=</varname></term>
242
243 <listitem><para>Sets environment variables for executed
244 processes. Takes a space-separated list of variable
245 assignments. This option may be specified more than once in
246 which case all listed variables will be set. If the same
247 variable is set twice, the later setting will override the
248 earlier setting. If the empty string is assigned to this
249 option, the list of environment variables is reset, all prior
250 assignments have no effect. Variable expansion is not
251 performed inside the strings, however, specifier expansion is
252 possible. The $ character has no special meaning. If you need
253 to assign a value containing spaces to a variable, use double
254 quotes (") for the assignment.</para>
255
256 <para>Example:
257 <programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
258 gives three variables <literal>VAR1</literal>,
259 <literal>VAR2</literal>, <literal>VAR3</literal>
260 with the values <literal>word1 word2</literal>,
261 <literal>word3</literal>, <literal>$word 5 6</literal>.
262 </para>
263
264 <para>
265 See
266 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
267 for details about environment variables.</para></listitem>
268 </varlistentry>
269 <varlistentry>
270 <term><varname>EnvironmentFile=</varname></term>
271 <listitem><para>Similar to <varname>Environment=</varname> but
272 reads the environment variables from a text file. The text
273 file should contain new-line-separated variable assignments.
8f0d2981
RM
274 Empty lines, lines without an <literal>=</literal> separator,
275 or lines starting with ; or # will be ignored,
798d3a52
ZJS
276 which may be used for commenting. A line ending with a
277 backslash will be concatenated with the following one,
278 allowing multiline variable definitions. The parser strips
279 leading and trailing whitespace from the values of
280 assignments, unless you use double quotes (").</para>
281
282 <para>The argument passed should be an absolute filename or
283 wildcard expression, optionally prefixed with
284 <literal>-</literal>, which indicates that if the file does
285 not exist, it will not be read and no error or warning message
286 is logged. This option may be specified more than once in
287 which case all specified files are read. If the empty string
288 is assigned to this option, the list of file to read is reset,
289 all prior assignments have no effect.</para>
290
291 <para>The files listed with this directive will be read
292 shortly before the process is executed (more specifically,
293 after all processes from a previous unit state terminated.
294 This means you can generate these files in one unit state, and
f407824d
DH
295 read it with this option in the next).</para>
296
297 <para>Settings from these
798d3a52
ZJS
298 files override settings made with
299 <varname>Environment=</varname>. If the same variable is set
300 twice from these files, the files will be read in the order
301 they are specified and the later setting will override the
302 earlier setting.</para></listitem>
303 </varlistentry>
304
305 <varlistentry>
306 <term><varname>StandardInput=</varname></term>
307 <listitem><para>Controls where file descriptor 0 (STDIN) of
308 the executed processes is connected to. Takes one of
309 <option>null</option>,
310 <option>tty</option>,
311 <option>tty-force</option>,
312 <option>tty-fail</option> or
313 <option>socket</option>.</para>
314
315 <para>If <option>null</option> is selected, standard input
316 will be connected to <filename>/dev/null</filename>, i.e. all
317 read attempts by the process will result in immediate
318 EOF.</para>
319
320 <para>If <option>tty</option> is selected, standard input is
321 connected to a TTY (as configured by
322 <varname>TTYPath=</varname>, see below) and the executed
323 process becomes the controlling process of the terminal. If
324 the terminal is already being controlled by another process,
325 the executed process waits until the current controlling
326 process releases the terminal.</para>
327
328 <para><option>tty-force</option> is similar to
329 <option>tty</option>, but the executed process is forcefully
330 and immediately made the controlling process of the terminal,
331 potentially removing previous controlling processes from the
332 terminal.</para>
333
334 <para><option>tty-fail</option> is similar to
335 <option>tty</option> but if the terminal already has a
336 controlling process start-up of the executed process
337 fails.</para>
338
339 <para>The <option>socket</option> option is only valid in
340 socket-activated services, and only when the socket
341 configuration file (see
342 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
343 for details) specifies a single socket only. If this option is
344 set, standard input will be connected to the socket the
345 service was activated from, which is primarily useful for
346 compatibility with daemons designed for use with the
347 traditional
b5c7d097 348 <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
349 daemon.</para>
350
351 <para>This setting defaults to
352 <option>null</option>.</para></listitem>
353 </varlistentry>
354 <varlistentry>
355 <term><varname>StandardOutput=</varname></term>
356 <listitem><para>Controls where file descriptor 1 (STDOUT) of
357 the executed processes is connected to. Takes one of
358 <option>inherit</option>,
359 <option>null</option>,
360 <option>tty</option>,
361 <option>journal</option>,
362 <option>syslog</option>,
363 <option>kmsg</option>,
364 <option>journal+console</option>,
365 <option>syslog+console</option>,
366 <option>kmsg+console</option> or
367 <option>socket</option>.</para>
368
369 <para><option>inherit</option> duplicates the file descriptor
370 of standard input for standard output.</para>
371
372 <para><option>null</option> connects standard output to
373 <filename>/dev/null</filename>, i.e. everything written to it
374 will be lost.</para>
375
376 <para><option>tty</option> connects standard output to a tty
377 (as configured via <varname>TTYPath=</varname>, see below). If
378 the TTY is used for output only, the executed process will not
379 become the controlling process of the terminal, and will not
380 fail or wait for other processes to release the
381 terminal.</para>
382
383 <para><option>journal</option> connects standard output with
384 the journal which is accessible via
385 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
386 Note that everything that is written to syslog or kmsg (see
387 below) is implicitly stored in the journal as well, the
388 specific two options listed below are hence supersets of this
389 one.</para>
390
391 <para><option>syslog</option> connects standard output to the
392 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
393 system syslog service, in addition to the journal. Note that
394 the journal daemon is usually configured to forward everything
395 it receives to syslog anyway, in which case this option is no
396 different from <option>journal</option>.</para>
397
398 <para><option>kmsg</option> connects standard output with the
399 kernel log buffer which is accessible via
400 <citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
401 in addition to the journal. The journal daemon might be
402 configured to send all logs to kmsg anyway, in which case this
403 option is no different from <option>journal</option>.</para>
404
405 <para><option>journal+console</option>,
406 <option>syslog+console</option> and
407 <option>kmsg+console</option> work in a similar way as the
408 three options above but copy the output to the system console
409 as well.</para>
410
411 <para><option>socket</option> connects standard output to a
412 socket acquired via socket activation. The semantics are
413 similar to the same option of
414 <varname>StandardInput=</varname>.</para>
415
416 <para>This setting defaults to the value set with
417 <option>DefaultStandardOutput=</option> in
418 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
419 which defaults to <option>journal</option>.</para></listitem>
420 </varlistentry>
421 <varlistentry>
422 <term><varname>StandardError=</varname></term>
423 <listitem><para>Controls where file descriptor 2 (STDERR) of
424 the executed processes is connected to. The available options
425 are identical to those of <varname>StandardOutput=</varname>,
426 with one exception: if set to <option>inherit</option> the
427 file descriptor used for standard output is duplicated for
428 standard error. This setting defaults to the value set with
429 <option>DefaultStandardError=</option> in
430 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
431 which defaults to <option>inherit</option>.</para></listitem>
432 </varlistentry>
433 <varlistentry>
434 <term><varname>TTYPath=</varname></term>
435 <listitem><para>Sets the terminal device node to use if
436 standard input, output, or error are connected to a TTY (see
437 above). Defaults to
438 <filename>/dev/console</filename>.</para></listitem>
439 </varlistentry>
440 <varlistentry>
441 <term><varname>TTYReset=</varname></term>
442 <listitem><para>Reset the terminal device specified with
443 <varname>TTYPath=</varname> before and after execution.
444 Defaults to <literal>no</literal>.</para></listitem>
445 </varlistentry>
446 <varlistentry>
447 <term><varname>TTYVHangup=</varname></term>
448 <listitem><para>Disconnect all clients which have opened the
449 terminal device specified with <varname>TTYPath=</varname>
450 before and after execution. Defaults to
451 <literal>no</literal>.</para></listitem>
452 </varlistentry>
453 <varlistentry>
454 <term><varname>TTYVTDisallocate=</varname></term>
455 <listitem><para>If the terminal device specified with
456 <varname>TTYPath=</varname> is a virtual console terminal, try
457 to deallocate the TTY before and after execution. This ensures
458 that the screen and scrollback buffer is cleared. Defaults to
459 <literal>no</literal>.</para></listitem>
460 </varlistentry>
461 <varlistentry>
462 <term><varname>SyslogIdentifier=</varname></term>
463 <listitem><para>Sets the process name to prefix log lines sent
464 to the logging system or the kernel log buffer with. If not
465 set, defaults to the process name of the executed process.
466 This option is only useful when
467 <varname>StandardOutput=</varname> or
468 <varname>StandardError=</varname> are set to
469 <option>syslog</option>, <option>journal</option> or
470 <option>kmsg</option> (or to the same settings in combination
471 with <option>+console</option>).</para></listitem>
472 </varlistentry>
473 <varlistentry>
474 <term><varname>SyslogFacility=</varname></term>
475 <listitem><para>Sets the syslog facility to use when logging
476 to syslog. One of <option>kern</option>,
477 <option>user</option>, <option>mail</option>,
478 <option>daemon</option>, <option>auth</option>,
479 <option>syslog</option>, <option>lpr</option>,
480 <option>news</option>, <option>uucp</option>,
481 <option>cron</option>, <option>authpriv</option>,
482 <option>ftp</option>, <option>local0</option>,
483 <option>local1</option>, <option>local2</option>,
484 <option>local3</option>, <option>local4</option>,
485 <option>local5</option>, <option>local6</option> or
486 <option>local7</option>. See
487 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
488 for details. This option is only useful when
489 <varname>StandardOutput=</varname> or
490 <varname>StandardError=</varname> are set to
491 <option>syslog</option>. Defaults to
492 <option>daemon</option>.</para></listitem>
493 </varlistentry>
494 <varlistentry>
495 <term><varname>SyslogLevel=</varname></term>
496 <listitem><para>Default syslog level to use when logging to
497 syslog or the kernel log buffer. One of
498 <option>emerg</option>,
499 <option>alert</option>,
500 <option>crit</option>,
501 <option>err</option>,
502 <option>warning</option>,
503 <option>notice</option>,
504 <option>info</option>,
505 <option>debug</option>. See
506 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
507 for details. This option is only useful when
508 <varname>StandardOutput=</varname> or
509 <varname>StandardError=</varname> are set to
510 <option>syslog</option> or <option>kmsg</option>. Note that
511 individual lines output by the daemon might be prefixed with a
512 different log level which can be used to override the default
513 log level specified here. The interpretation of these prefixes
514 may be disabled with <varname>SyslogLevelPrefix=</varname>,
515 see below. For details see
516 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
517
518 Defaults to
519 <option>info</option>.</para></listitem>
520 </varlistentry>
521
522 <varlistentry>
523 <term><varname>SyslogLevelPrefix=</varname></term>
524 <listitem><para>Takes a boolean argument. If true and
525 <varname>StandardOutput=</varname> or
526 <varname>StandardError=</varname> are set to
527 <option>syslog</option>, <option>kmsg</option> or
528 <option>journal</option>, log lines written by the executed
529 process that are prefixed with a log level will be passed on
530 to syslog with this log level set but the prefix removed. If
531 set to false, the interpretation of these prefixes is disabled
532 and the logged lines are passed on as-is. For details about
533 this prefixing see
534 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
535 Defaults to true.</para></listitem>
536 </varlistentry>
537
538 <varlistentry>
539 <term><varname>TimerSlackNSec=</varname></term>
540 <listitem><para>Sets the timer slack in nanoseconds for the
541 executed processes. The timer slack controls the accuracy of
542 wake-ups triggered by timers. See
543 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
544 for more information. Note that in contrast to most other time
545 span definitions this parameter takes an integer value in
546 nano-seconds if no unit is specified. The usual time units are
547 understood too.</para></listitem>
548 </varlistentry>
549
550 <varlistentry>
551 <term><varname>LimitCPU=</varname></term>
552 <term><varname>LimitFSIZE=</varname></term>
553 <term><varname>LimitDATA=</varname></term>
554 <term><varname>LimitSTACK=</varname></term>
555 <term><varname>LimitCORE=</varname></term>
556 <term><varname>LimitRSS=</varname></term>
557 <term><varname>LimitNOFILE=</varname></term>
558 <term><varname>LimitAS=</varname></term>
559 <term><varname>LimitNPROC=</varname></term>
560 <term><varname>LimitMEMLOCK=</varname></term>
561 <term><varname>LimitLOCKS=</varname></term>
562 <term><varname>LimitSIGPENDING=</varname></term>
563 <term><varname>LimitMSGQUEUE=</varname></term>
564 <term><varname>LimitNICE=</varname></term>
565 <term><varname>LimitRTPRIO=</varname></term>
566 <term><varname>LimitRTTIME=</varname></term>
567 <listitem><para>These settings set both soft and hard limits
568 of various resources for executed processes. See
569 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
570 for details. Use the string <varname>infinity</varname> to
571 configure no limit on a specific resource.</para></listitem>
572
573 <table>
574 <title>Limit directives and their equivalent with ulimit</title>
575
576 <tgroup cols='2'>
577 <colspec colname='directive' />
578 <colspec colname='equivalent' />
579 <thead>
580 <row>
581 <entry>Directive</entry>
582 <entry>ulimit equivalent</entry>
583 </row>
584 </thead>
585 <tbody>
586 <row>
587 <entry>LimitCPU</entry>
588 <entry>ulimit -t</entry>
589 </row>
590 <row>
591 <entry>LimitFSIZE</entry>
592 <entry>ulimit -f</entry>
593 </row>
594 <row>
595 <entry>LimitDATA</entry>
596 <entry>ulimit -d</entry>
597 </row>
598 <row>
599 <entry>LimitSTACK</entry>
600 <entry>ulimit -s</entry>
601 </row>
602 <row>
603 <entry>LimitCORE</entry>
604 <entry>ulimit -c</entry>
605 </row>
606 <row>
607 <entry>LimitRSS</entry>
608 <entry>ulimit -m</entry>
609 </row>
610 <row>
611 <entry>LimitNOFILE</entry>
612 <entry>ulimit -n</entry>
613 </row>
614 <row>
615 <entry>LimitAS</entry>
616 <entry>ulimit -v</entry>
617 </row>
618 <row>
619 <entry>LimitNPROC</entry>
620 <entry>ulimit -u</entry>
621 </row>
622 <row>
623 <entry>LimitMEMLOCK</entry>
624 <entry>ulimit -l</entry>
625 </row>
626 <row>
627 <entry>LimitLOCKS</entry>
628 <entry>ulimit -x</entry>
629 </row>
630 <row>
631 <entry>LimitSIGPENDING</entry>
632 <entry>ulimit -i</entry>
633 </row>
634 <row>
635 <entry>LimitMSGQUEUE</entry>
636 <entry>ulimit -q</entry>
637 </row>
638 <row>
639 <entry>LimitNICE</entry>
640 <entry>ulimit -e</entry>
641 </row>
642 <row>
643 <entry>LimitRTPRIO</entry>
644 <entry>ulimit -r</entry>
645 </row>
646 <row>
647 <entry>LimitRTTIME</entry>
648 <entry>No equivalent</entry>
649 </row>
650 </tbody>
651 </tgroup>
652 </table>
653 </varlistentry>
654
655 <varlistentry>
656 <term><varname>PAMName=</varname></term>
657 <listitem><para>Sets the PAM service name to set up a session
658 as. If set, the executed process will be registered as a PAM
659 session under the specified service name. This is only useful
660 in conjunction with the <varname>User=</varname> setting. If
661 not set, no PAM session will be opened for the executed
662 processes. See
663 <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>
664 for details.</para></listitem>
665 </varlistentry>
666
667 <varlistentry>
668 <term><varname>CapabilityBoundingSet=</varname></term>
669
670 <listitem><para>Controls which capabilities to include in the
671 capability bounding set for the executed process. See
672 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
673 for details. Takes a whitespace-separated list of capability
674 names as read by
3ba3a79d 675 <citerefentry project='mankier'><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
798d3a52
ZJS
676 e.g. <constant>CAP_SYS_ADMIN</constant>,
677 <constant>CAP_DAC_OVERRIDE</constant>,
678 <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will
679 be included in the bounding set, all others are removed. If
680 the list of capabilities is prefixed with
681 <literal>~</literal>, all but the listed capabilities will be
682 included, the effect of the assignment inverted. Note that
683 this option also affects the respective capabilities in the
684 effective, permitted and inheritable capability sets, on top
685 of what <varname>Capabilities=</varname> does. If this option
686 is not used, the capability bounding set is not modified on
687 process execution, hence no limits on the capabilities of the
688 process are enforced. This option may appear more than once in
689 which case the bounding sets are merged. If the empty string
690 is assigned to this option, the bounding set is reset to the
691 empty capability set, and all prior settings have no effect.
692 If set to <literal>~</literal> (without any further argument),
693 the bounding set is reset to the full set of available
694 capabilities, also undoing any previous
695 settings.</para></listitem>
696 </varlistentry>
697
698 <varlistentry>
699 <term><varname>SecureBits=</varname></term>
700 <listitem><para>Controls the secure bits set for the executed
701 process. Takes a space-separated combination of options from
702 the following list:
703 <option>keep-caps</option>,
704 <option>keep-caps-locked</option>,
705 <option>no-setuid-fixup</option>,
706 <option>no-setuid-fixup-locked</option>,
707 <option>noroot</option>, and
708 <option>noroot-locked</option>.
709 This option may appear more than once in which case the secure
710 bits are ORed. If the empty string is assigned to this option,
711 the bits are reset to 0. See
712 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
713 for details.</para></listitem>
714 </varlistentry>
715
716 <varlistentry>
717 <term><varname>Capabilities=</varname></term>
718 <listitem><para>Controls the
719 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
720 set for the executed process. Take a capability string
721 describing the effective, permitted and inherited capability
722 sets as documented in
3ba3a79d 723 <citerefentry project='mankier'><refentrytitle>cap_from_text</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
724 Note that these capability sets are usually influenced (and
725 filtered) by the capabilities attached to the executed file.
726 Due to that <varname>CapabilityBoundingSet=</varname> is
727 probably a much more useful setting.</para></listitem>
728 </varlistentry>
729
730 <varlistentry>
731 <term><varname>ReadWriteDirectories=</varname></term>
732 <term><varname>ReadOnlyDirectories=</varname></term>
733 <term><varname>InaccessibleDirectories=</varname></term>
734
735 <listitem><para>Sets up a new file system namespace for
736 executed processes. These options may be used to limit access
737 a process might have to the main file system hierarchy. Each
738 setting takes a space-separated list of absolute directory
739 paths. Directories listed in
740 <varname>ReadWriteDirectories=</varname> are accessible from
741 within the namespace with the same access rights as from
742 outside. Directories listed in
743 <varname>ReadOnlyDirectories=</varname> are accessible for
744 reading only, writing will be refused even if the usual file
745 access controls would permit this. Directories listed in
746 <varname>InaccessibleDirectories=</varname> will be made
747 inaccessible for processes inside the namespace. Note that
748 restricting access with these options does not extend to
749 submounts of a directory that are created later on. These
750 options may be specified more than once in which case all
751 directories listed will have limited access from within the
752 namespace. If the empty string is assigned to this option, the
753 specific list is reset, and all prior assignments have no
754 effect.</para>
755 <para>Paths in
756 <varname>ReadOnlyDirectories=</varname>
757 and
758 <varname>InaccessibleDirectories=</varname>
759 may be prefixed with
760 <literal>-</literal>, in which case
761 they will be ignored when they do not
762 exist. Note that using this
763 setting will disconnect propagation of
764 mounts from the service to the host
765 (propagation in the opposite direction
766 continues to work). This means that
767 this setting may not be used for
768 services which shall be able to
769 install mount points in the main mount
770 namespace.</para></listitem>
771 </varlistentry>
772
773 <varlistentry>
774 <term><varname>PrivateTmp=</varname></term>
775
776 <listitem><para>Takes a boolean argument. If true, sets up a
777 new file system namespace for the executed processes and
778 mounts private <filename>/tmp</filename> and
779 <filename>/var/tmp</filename> directories inside it that is
780 not shared by processes outside of the namespace. This is
781 useful to secure access to temporary files of the process, but
782 makes sharing between processes via <filename>/tmp</filename>
783 or <filename>/var/tmp</filename> impossible. If this is
784 enabled, all temporary files created by a service in these
785 directories will be removed after the service is stopped.
786 Defaults to false. It is possible to run two or more units
787 within the same private <filename>/tmp</filename> and
788 <filename>/var/tmp</filename> namespace by using the
789 <varname>JoinsNamespaceOf=</varname> directive, see
790 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
791 for details. Note that using this setting will disconnect
792 propagation of mounts from the service to the host
793 (propagation in the opposite direction continues to work).
794 This means that this setting may not be used for services
795 which shall be able to install mount points in the main mount
796 namespace.</para></listitem>
797 </varlistentry>
798
799 <varlistentry>
800 <term><varname>PrivateDevices=</varname></term>
801
802 <listitem><para>Takes a boolean argument. If true, sets up a
803 new /dev namespace for the executed processes and only adds
804 API pseudo devices such as <filename>/dev/null</filename>,
805 <filename>/dev/zero</filename> or
806 <filename>/dev/random</filename> (as well as the pseudo TTY
807 subsystem) to it, but no physical devices such as
808 <filename>/dev/sda</filename>. This is useful to securely turn
809 off physical device access by the executed process. Defaults
810 to false. Enabling this option will also remove
811 <constant>CAP_MKNOD</constant> from the capability bounding
812 set for the unit (see above), and set
813 <varname>DevicePolicy=closed</varname> (see
814 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
815 for details). Note that using this setting will disconnect
816 propagation of mounts from the service to the host
817 (propagation in the opposite direction continues to work).
818 This means that this setting may not be used for services
819 which shall be able to install mount points in the main mount
820 namespace.</para></listitem>
821 </varlistentry>
822
823 <varlistentry>
824 <term><varname>PrivateNetwork=</varname></term>
825
826 <listitem><para>Takes a boolean argument. If true, sets up a
827 new network namespace for the executed processes and
828 configures only the loopback network device
829 <literal>lo</literal> inside it. No other network devices will
830 be available to the executed process. This is useful to
831 securely turn off network access by the executed process.
832 Defaults to false. It is possible to run two or more units
833 within the same private network namespace by using the
834 <varname>JoinsNamespaceOf=</varname> directive, see
835 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
836 for details. Note that this option will disconnect all socket
837 families from the host, this includes AF_NETLINK and AF_UNIX.
838 The latter has the effect that AF_UNIX sockets in the abstract
839 socket namespace will become unavailable to the processes
840 (however, those located in the file system will continue to be
841 accessible).</para></listitem>
842 </varlistentry>
843
844 <varlistentry>
845 <term><varname>ProtectSystem=</varname></term>
846
847 <listitem><para>Takes a boolean argument or
848 <literal>full</literal>. If true, mounts the
849 <filename>/usr</filename> and <filename>/boot</filename>
850 directories read-only for processes invoked by this unit. If
851 set to <literal>full</literal>, the <filename>/etc</filename>
852 directory is mounted read-only, too. This setting ensures that
853 any modification of the vendor supplied operating system (and
854 optionally its configuration) is prohibited for the service.
855 It is recommended to enable this setting for all long-running
856 services, unless they are involved with system updates or need
857 to modify the operating system in other ways. Note however
858 that processes retaining the CAP_SYS_ADMIN capability can undo
859 the effect of this setting. This setting is hence particularly
860 useful for daemons which have this capability removed, for
861 example with <varname>CapabilityBoundingSet=</varname>.
862 Defaults to off.</para></listitem>
863 </varlistentry>
864
865 <varlistentry>
866 <term><varname>ProtectHome=</varname></term>
867
868 <listitem><para>Takes a boolean argument or
869 <literal>read-only</literal>. If true, the directories
58331437
CH
870 <filename>/home</filename>, <filename>/root</filename> and
871 <filename>/run/user</filename>
798d3a52 872 are made inaccessible and empty for processes invoked by this
58331437 873 unit. If set to <literal>read-only</literal>, the three
798d3a52
ZJS
874 directories are made read-only instead. It is recommended to
875 enable this setting for all long-running services (in
876 particular network-facing ones), to ensure they cannot get
877 access to private user data, unless the services actually
878 require access to the user's private data. Note however that
879 processes retaining the CAP_SYS_ADMIN capability can undo the
880 effect of this setting. This setting is hence particularly
881 useful for daemons which have this capability removed, for
882 example with <varname>CapabilityBoundingSet=</varname>.
883 Defaults to off.</para></listitem>
884 </varlistentry>
885
886 <varlistentry>
887 <term><varname>MountFlags=</varname></term>
888
889 <listitem><para>Takes a mount propagation flag:
890 <option>shared</option>, <option>slave</option> or
891 <option>private</option>, which control whether mounts in the
892 file system namespace set up for this unit's processes will
893 receive or propagate mounts or unmounts. See
3ba3a79d 894 <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
895 for details. Defaults to <option>shared</option>. Use
896 <option>shared</option> to ensure that mounts and unmounts are
897 propagated from the host to the container and vice versa. Use
898 <option>slave</option> to run processes so that none of their
899 mounts and unmounts will propagate to the host. Use
900 <option>private</option> to also ensure that no mounts and
901 unmounts from the host will propagate into the unit processes'
902 namespace. Note that <option>slave</option> means that file
903 systems mounted on the host might stay mounted continuously in
904 the unit's namespace, and thus keep the device busy. Note that
905 the file system namespace related options
906 (<varname>PrivateTmp=</varname>,
907 <varname>PrivateDevices=</varname>,
908 <varname>ProtectSystem=</varname>,
909 <varname>ProtectHome=</varname>,
910 <varname>ReadOnlyDirectories=</varname>,
911 <varname>InaccessibleDirectories=</varname> and
912 <varname>ReadWriteDirectories=</varname>) require that mount
913 and unmount propagation from the unit's file system namespace
914 is disabled, and hence downgrade <option>shared</option> to
915 <option>slave</option>. </para></listitem>
916 </varlistentry>
917
918 <varlistentry>
919 <term><varname>UtmpIdentifier=</varname></term>
920
921 <listitem><para>Takes a four character identifier string for
023a4f67
LP
922 an <citerefentry
923 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>
924 and wtmp entry for this service. This should only be
925 set for services such as <command>getty</command>
926 implementations (such as <citerefentry
927 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
798d3a52 928 where utmp/wtmp entries must be created and cleared before and
023a4f67
LP
929 after execution, or for services that shall be executed as if
930 they were run by a <command>getty</command> process (see
931 below). If the configured string is longer than four
798d3a52
ZJS
932 characters, it is truncated and the terminal four characters
933 are used. This setting interprets %I style string
934 replacements. This setting is unset by default, i.e. no
935 utmp/wtmp entries are created or cleaned up for this
936 service.</para></listitem>
937 </varlistentry>
938
023a4f67
LP
939 <varlistentry>
940 <term><varname>UtmpMode=</varname></term>
941
942 <listitem><para>Takes one of <literal>init</literal>,
943 <literal>login</literal> or <literal>user</literal>. If
944 <varname>UtmpIdentifier=</varname> is set, controls which
945 type of <citerefentry
946 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp
947 entries for this service are generated. This setting has no
948 effect unless <varname>UtmpIdentifier=</varname> is set
949 too. If <literal>init</literal> is set, only an
950 <constant>INIT_PROCESS</constant> entry is generated and the
6cd16034
LP
951 invoked process must implement a
952 <command>getty</command>-compatible utmp/wtmp logic. If
953 <literal>login</literal> is set, first an
954 <constant>INIT_PROCESS</constant> entry, followed by an
955 <constant>LOGIN_PROCESS</constant> entry is generated. In
956 this case the invoked process must implement a <citerefentry
023a4f67
LP
957 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
958 utmp/wtmp logic. If <literal>user</literal> is set, first an
959 <constant>INIT_PROCESS</constant> entry, then a
960 <constant>LOGIN_PROCESS</constant> entry and finally an
961 <constant>USER_PROCESS</constant> entry is generated. In this
962 case the invoked process may be any process that is suitable
963 to be run as session leader. Defaults to
964 <literal>init</literal>.</para></listitem>
965 </varlistentry>
966
798d3a52
ZJS
967 <varlistentry>
968 <term><varname>SELinuxContext=</varname></term>
969
970 <listitem><para>Set the SELinux security context of the
971 executed process. If set, this will override the automated
972 domain transition. However, the policy still needs to
973 authorize the transition. This directive is ignored if SELinux
974 is disabled. If prefixed by <literal>-</literal>, all errors
975 will be ignored. See
3ba3a79d 976 <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
798d3a52
ZJS
977 for details.</para></listitem>
978 </varlistentry>
979
980 <varlistentry>
981 <term><varname>AppArmorProfile=</varname></term>
982
983 <listitem><para>Takes a profile name as argument. The process
984 executed by the unit will switch to this profile when started.
985 Profiles must already be loaded in the kernel, or the unit
986 will fail. This result in a non operation if AppArmor is not
987 enabled. If prefixed by <literal>-</literal>, all errors will
988 be ignored. </para></listitem>
989 </varlistentry>
990
991 <varlistentry>
992 <term><varname>SmackProcessLabel=</varname></term>
993
994 <listitem><para>Takes a <option>SMACK64</option> security
995 label as argument. The process executed by the unit will be
996 started under this label and SMACK will decide whether the
f2c624cb 997 process is allowed to run or not based on it. The process
798d3a52
ZJS
998 will continue to run under the label specified here unless the
999 executable has its own <option>SMACK64EXEC</option> label, in
1000 which case the process will transition to run under that
1001 label. When not specified, the label that systemd is running
1002 under is used. This directive is ignored if SMACK is
1003 disabled.</para>
1004
1005 <para>The value may be prefixed by <literal>-</literal>, in
1006 which case all errors will be ignored. An empty value may be
1007 specified to unset previous assignments.</para>
1008 </listitem>
1009 </varlistentry>
1010
1011 <varlistentry>
1012 <term><varname>IgnoreSIGPIPE=</varname></term>
1013
1014 <listitem><para>Takes a boolean argument. If true, causes
1015 <constant>SIGPIPE</constant> to be ignored in the executed
1016 process. Defaults to true because <constant>SIGPIPE</constant>
1017 generally is useful only in shell pipelines.</para></listitem>
1018 </varlistentry>
1019
1020 <varlistentry>
1021 <term><varname>NoNewPrivileges=</varname></term>
1022
1023 <listitem><para>Takes a boolean argument. If true, ensures
1024 that the service process and all its children can never gain
1025 new privileges. This option is more powerful than the
1026 respective secure bits flags (see above), as it also prohibits
1027 UID changes of any kind. This is the simplest, most effective
1028 way to ensure that a process and its children can never
1029 elevate privileges again.</para></listitem>
1030 </varlistentry>
1031
1032 <varlistentry>
1033 <term><varname>SystemCallFilter=</varname></term>
1034
1035 <listitem><para>Takes a space-separated list of system call
1036 names. If this setting is used, all system calls executed by
1037 the unit processes except for the listed ones will result in
1038 immediate process termination with the
1039 <constant>SIGSYS</constant> signal (whitelisting). If the
1040 first character of the list is <literal>~</literal>, the
1041 effect is inverted: only the listed system calls will result
1042 in immediate process termination (blacklisting). If running in
1043 user mode and this option is used,
1044 <varname>NoNewPrivileges=yes</varname> is implied. This
1045 feature makes use of the Secure Computing Mode 2 interfaces of
1046 the kernel ('seccomp filtering') and is useful for enforcing a
1047 minimal sandboxing environment. Note that the
1048 <function>execve</function>,
1049 <function>rt_sigreturn</function>,
1050 <function>sigreturn</function>,
1051 <function>exit_group</function>, <function>exit</function>
1052 system calls are implicitly whitelisted and do not need to be
1053 listed explicitly. This option may be specified more than once
1054 in which case the filter masks are merged. If the empty string
1055 is assigned, the filter is reset, all prior assignments will
1056 have no effect.</para>
1057
1058 <para>If you specify both types of this option (i.e.
1059 whitelisting and blacklisting), the first encountered will
1060 take precedence and will dictate the default action
1061 (termination or approval of a system call). Then the next
1062 occurrences of this option will add or delete the listed
1063 system calls from the set of the filtered system calls,
1064 depending of its type and the default action. (For example, if
1065 you have started with a whitelisting of
1066 <function>read</function> and <function>write</function>, and
1067 right after it add a blacklisting of
1068 <function>write</function>, then <function>write</function>
1069 will be removed from the set.) </para></listitem>
1070 </varlistentry>
1071
1072 <varlistentry>
1073 <term><varname>SystemCallErrorNumber=</varname></term>
1074
1075 <listitem><para>Takes an <literal>errno</literal> error number
1076 name to return when the system call filter configured with
1077 <varname>SystemCallFilter=</varname> is triggered, instead of
1078 terminating the process immediately. Takes an error name such
1079 as <constant>EPERM</constant>, <constant>EACCES</constant> or
1080 <constant>EUCLEAN</constant>. When this setting is not used,
1081 or when the empty string is assigned, the process will be
1082 terminated immediately when the filter is
1083 triggered.</para></listitem>
1084 </varlistentry>
1085
1086 <varlistentry>
1087 <term><varname>SystemCallArchitectures=</varname></term>
1088
1089 <listitem><para>Takes a space separated list of architecture
1090 identifiers to include in the system call filter. The known
1091 architecture identifiers are <constant>x86</constant>,
1092 <constant>x86-64</constant>, <constant>x32</constant>,
1093 <constant>arm</constant> as well as the special identifier
1094 <constant>native</constant>. Only system calls of the
1095 specified architectures will be permitted to processes of this
1096 unit. This is an effective way to disable compatibility with
1097 non-native architectures for processes, for example to
1098 prohibit execution of 32-bit x86 binaries on 64-bit x86-64
1099 systems. The special <constant>native</constant> identifier
1100 implicitly maps to the native architecture of the system (or
1101 more strictly: to the architecture the system manager is
1102 compiled for). If running in user mode and this option is
1103 used, <varname>NoNewPrivileges=yes</varname> is implied. Note
1104 that setting this option to a non-empty list implies that
1105 <constant>native</constant> is included too. By default, this
1106 option is set to the empty list, i.e. no architecture system
1107 call filtering is applied.</para></listitem>
1108 </varlistentry>
1109
1110 <varlistentry>
1111 <term><varname>RestrictAddressFamilies=</varname></term>
1112
1113 <listitem><para>Restricts the set of socket address families
1114 accessible to the processes of this unit. Takes a
1115 space-separated list of address family names to whitelist,
1116 such as
1117 <constant>AF_UNIX</constant>,
1118 <constant>AF_INET</constant> or
1119 <constant>AF_INET6</constant>. When
1120 prefixed with <constant>~</constant> the listed address
1121 families will be applied as blacklist, otherwise as whitelist.
1122 Note that this restricts access to the
3ba3a79d 1123 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
1124 system call only. Sockets passed into the process by other
1125 means (for example, by using socket activation with socket
1126 units, see
1127 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1128 are unaffected. Also, sockets created with
1129 <function>socketpair()</function> (which creates connected
1130 AF_UNIX sockets only) are unaffected. Note that this option
1131 has no effect on 32-bit x86 and is ignored (but works
1132 correctly on x86-64). If running in user mode and this option
1133 is used, <varname>NoNewPrivileges=yes</varname> is implied. By
1134 default, no restriction applies, all address families are
1135 accessible to processes. If assigned the empty string, any
1136 previous list changes are undone.</para>
1137
1138 <para>Use this option to limit exposure of processes to remote
1139 systems, in particular via exotic network protocols. Note that
1140 in most cases, the local <constant>AF_UNIX</constant> address
1141 family should be included in the configured whitelist as it is
1142 frequently used for local communication, including for
1143 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1144 logging.</para></listitem>
1145 </varlistentry>
1146
1147 <varlistentry>
1148 <term><varname>Personality=</varname></term>
1149
1150 <listitem><para>Controls which kernel architecture
3ba3a79d 1151 <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
1152 shall report, when invoked by unit processes. Takes one of
1153 <constant>x86</constant> and <constant>x86-64</constant>. This
1154 is useful when running 32-bit services on a 64-bit host
1155 system. If not specified, the personality is left unmodified
1156 and thus reflects the personality of the host system's
1157 kernel.</para></listitem>
1158 </varlistentry>
1159
1160 <varlistentry>
1161 <term><varname>RuntimeDirectory=</varname></term>
1162 <term><varname>RuntimeDirectoryMode=</varname></term>
1163
1164 <listitem><para>Takes a list of directory names. If set, one
1165 or more directories by the specified names will be created
1166 below <filename>/run</filename> (for system services) or below
1167 <varname>$XDG_RUNTIME_DIR</varname> (for user services) when
1168 the unit is started, and removed when the unit is stopped. The
1169 directories will have the access mode specified in
1170 <varname>RuntimeDirectoryMode=</varname>, and will be owned by
1171 the user and group specified in <varname>User=</varname> and
1172 <varname>Group=</varname>. Use this to manage one or more
1173 runtime directories of the unit and bind their lifetime to the
1174 daemon runtime. The specified directory names must be
1175 relative, and may not include a <literal>/</literal>, i.e.
1176 must refer to simple directories to create or remove. This is
1177 particularly useful for unprivileged daemons that cannot
1178 create runtime directories in <filename>/run</filename> due to
1179 lack of privileges, and to make sure the runtime directory is
1180 cleaned up automatically after use. For runtime directories
1181 that require more complex or different configuration or
1182 lifetime guarantees, please consider using
1183 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
1184 </varlistentry>
1185
1186 </variablelist>
1187 </refsect1>
1188
1189 <refsect1>
1190 <title>Environment variables in spawned processes</title>
1191
1192 <para>Processes started by the system are executed in a clean
1193 environment in which select variables listed below are set. System
1194 processes started by systemd do not inherit variables from PID 1,
1195 but processes started by user systemd instances inherit all
1196 environment variables from the user systemd instance.
1197 </para>
1198
1199 <variablelist class='environment-variables'>
1200 <varlistentry>
1201 <term><varname>$PATH</varname></term>
1202
1203 <listitem><para>Colon-separated list of directories to use
1204 when launching executables. Systemd uses a fixed value of
1205 <filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename>:<filename>/sbin</filename>:<filename>/bin</filename>.
1206 </para></listitem>
1207 </varlistentry>
1208
1209 <varlistentry>
1210 <term><varname>$LANG</varname></term>
1211
1212 <listitem><para>Locale. Can be set in
3ba3a79d 1213 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52
ZJS
1214 or on the kernel command line (see
1215 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1216 and
1217 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
1218 </para></listitem>
1219 </varlistentry>
1220
1221 <varlistentry>
1222 <term><varname>$USER</varname></term>
1223 <term><varname>$LOGNAME</varname></term>
1224 <term><varname>$HOME</varname></term>
1225 <term><varname>$SHELL</varname></term>
1226
1227 <listitem><para>User name (twice), home directory, and the
1228 login shell. The variables are set for the units that have
1229 <varname>User=</varname> set, which includes user
1230 <command>systemd</command> instances. See
3ba3a79d 1231 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
798d3a52
ZJS
1232 </para></listitem>
1233 </varlistentry>
1234
1235 <varlistentry>
1236 <term><varname>$XDG_RUNTIME_DIR</varname></term>
1237
1238 <listitem><para>The directory for volatile state. Set for the
1239 user <command>systemd</command> instance, and also in user
1240 sessions. See
1241 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1242 </para></listitem>
1243 </varlistentry>
1244
1245 <varlistentry>
1246 <term><varname>$XDG_SESSION_ID</varname></term>
1247 <term><varname>$XDG_SEAT</varname></term>
1248 <term><varname>$XDG_VTNR</varname></term>
1249
1250 <listitem><para>The identifier of the session, the seat name,
1251 and virtual terminal of the session. Set by
1252 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1253 for login sessions. <varname>$XDG_SEAT</varname> and
1254 <varname>$XDG_VTNR</varname> will only be set when attached to
1255 a seat and a tty.</para></listitem>
1256 </varlistentry>
1257
1258 <varlistentry>
1259 <term><varname>$MAINPID</varname></term>
1260
1261 <listitem><para>The PID of the units main process if it is
1262 known. This is only set for control processes as invoked by
1263 <varname>ExecReload=</varname> and similar. </para></listitem>
1264 </varlistentry>
1265
1266 <varlistentry>
1267 <term><varname>$MANAGERPID</varname></term>
1268
1269 <listitem><para>The PID of the user <command>systemd</command>
1270 instance, set for processes spawned by it. </para></listitem>
1271 </varlistentry>
1272
1273 <varlistentry>
1274 <term><varname>$LISTEN_FDS</varname></term>
1275 <term><varname>$LISTEN_PID</varname></term>
1276
1277 <listitem><para>Information about file descriptors passed to a
1278 service for socket activation. See
1279 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1280 </para></listitem>
1281 </varlistentry>
1282
1283 <varlistentry>
1284 <term><varname>$TERM</varname></term>
1285
1286 <listitem><para>Terminal type, set only for units connected to
1287 a terminal (<varname>StandardInput=tty</varname>,
1288 <varname>StandardOutput=tty</varname>, or
1289 <varname>StandardError=tty</varname>). See
1290 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1291 </para></listitem>
1292 </varlistentry>
1293 </variablelist>
1294
1295 <para>Additional variables may be configured by the following
1296 means: for processes spawned in specific units, use the
1297 <varname>Environment=</varname> and
1298 <varname>EnvironmentFile=</varname> options above; to specify
1299 variables globally, use <varname>DefaultEnvironment=</varname>
1300 (see
1301 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1302 or the kernel option <varname>systemd.setenv=</varname> (see
1303 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1304 Additional variables may also be set through PAM,
1305 cf. <citerefentry project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
1306 </refsect1>
1307
1308 <refsect1>
1309 <title>See Also</title>
1310 <para>
1311 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1312 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1313 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1314 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1315 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1316 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1317 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1318 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1319 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1320 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1321 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1322 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1323 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1324 </para>
1325 </refsect1>
dd1eb43b
LP
1326
1327</refentry>