]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.exec.xml
Merge pull request #1783 from vcaputo/still_make_progress_when_throttling
[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
b938cb90 89 for executed processes. If set to <literal>~</literal>, the
5f5d8eab
LP
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
b938cb90
JE
126 once, in which case all listed groups are set as supplementary
127 groups. When the empty string is assigned, the list of
798d3a52
ZJS
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
b938cb90 160 <listitem><para>Sets the I/O scheduling class for executed
798d3a52
ZJS
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
b938cb90 171 <listitem><para>Sets the I/O scheduling priority for executed
798d3a52
ZJS
172 processes. Takes an integer between 0 (highest priority) and 7
173 (lowest priority). The available priorities depend on the
b938cb90 174 selected I/O scheduling class (see above). See
798d3a52
ZJS
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.
b938cb90 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
b938cb90 245 assignments. This option may be specified more than once, in
798d3a52
ZJS
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>
a8eaaee7 496 <listitem><para>The default syslog level to use when logging to
798d3a52
ZJS
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>,
b938cb90 515 see below. For details, see
798d3a52
ZJS
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
412ea7a9
KZ
571 configure no limit on a specific resource. The multiplicative suffixes
572 K (=1024), M (=1024*1024) and so on for G, T, P and E may be used for
573 resource limits measured in bytes (e.g. LimitAS=16G).</para></listitem>
798d3a52
ZJS
574
575 <table>
576 <title>Limit directives and their equivalent with ulimit</title>
577
578 <tgroup cols='2'>
579 <colspec colname='directive' />
580 <colspec colname='equivalent' />
581 <thead>
582 <row>
583 <entry>Directive</entry>
584 <entry>ulimit equivalent</entry>
585 </row>
586 </thead>
587 <tbody>
588 <row>
589 <entry>LimitCPU</entry>
590 <entry>ulimit -t</entry>
591 </row>
592 <row>
593 <entry>LimitFSIZE</entry>
594 <entry>ulimit -f</entry>
595 </row>
596 <row>
597 <entry>LimitDATA</entry>
598 <entry>ulimit -d</entry>
599 </row>
600 <row>
601 <entry>LimitSTACK</entry>
602 <entry>ulimit -s</entry>
603 </row>
604 <row>
605 <entry>LimitCORE</entry>
606 <entry>ulimit -c</entry>
607 </row>
608 <row>
609 <entry>LimitRSS</entry>
610 <entry>ulimit -m</entry>
611 </row>
612 <row>
613 <entry>LimitNOFILE</entry>
614 <entry>ulimit -n</entry>
615 </row>
616 <row>
617 <entry>LimitAS</entry>
618 <entry>ulimit -v</entry>
619 </row>
620 <row>
621 <entry>LimitNPROC</entry>
622 <entry>ulimit -u</entry>
623 </row>
624 <row>
625 <entry>LimitMEMLOCK</entry>
626 <entry>ulimit -l</entry>
627 </row>
628 <row>
629 <entry>LimitLOCKS</entry>
630 <entry>ulimit -x</entry>
631 </row>
632 <row>
633 <entry>LimitSIGPENDING</entry>
634 <entry>ulimit -i</entry>
635 </row>
636 <row>
637 <entry>LimitMSGQUEUE</entry>
638 <entry>ulimit -q</entry>
639 </row>
640 <row>
641 <entry>LimitNICE</entry>
642 <entry>ulimit -e</entry>
643 </row>
644 <row>
645 <entry>LimitRTPRIO</entry>
646 <entry>ulimit -r</entry>
647 </row>
648 <row>
649 <entry>LimitRTTIME</entry>
650 <entry>No equivalent</entry>
651 </row>
652 </tbody>
653 </tgroup>
654 </table>
655 </varlistentry>
656
657 <varlistentry>
658 <term><varname>PAMName=</varname></term>
659 <listitem><para>Sets the PAM service name to set up a session
660 as. If set, the executed process will be registered as a PAM
661 session under the specified service name. This is only useful
662 in conjunction with the <varname>User=</varname> setting. If
663 not set, no PAM session will be opened for the executed
664 processes. See
665 <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>
666 for details.</para></listitem>
667 </varlistentry>
668
669 <varlistentry>
670 <term><varname>CapabilityBoundingSet=</varname></term>
671
672 <listitem><para>Controls which capabilities to include in the
673 capability bounding set for the executed process. See
674 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
675 for details. Takes a whitespace-separated list of capability
676 names as read by
3ba3a79d 677 <citerefentry project='mankier'><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
798d3a52
ZJS
678 e.g. <constant>CAP_SYS_ADMIN</constant>,
679 <constant>CAP_DAC_OVERRIDE</constant>,
680 <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will
681 be included in the bounding set, all others are removed. If
682 the list of capabilities is prefixed with
683 <literal>~</literal>, all but the listed capabilities will be
684 included, the effect of the assignment inverted. Note that
685 this option also affects the respective capabilities in the
686 effective, permitted and inheritable capability sets, on top
687 of what <varname>Capabilities=</varname> does. If this option
688 is not used, the capability bounding set is not modified on
689 process execution, hence no limits on the capabilities of the
b938cb90 690 process are enforced. This option may appear more than once, in
798d3a52
ZJS
691 which case the bounding sets are merged. If the empty string
692 is assigned to this option, the bounding set is reset to the
693 empty capability set, and all prior settings have no effect.
694 If set to <literal>~</literal> (without any further argument),
695 the bounding set is reset to the full set of available
696 capabilities, also undoing any previous
697 settings.</para></listitem>
698 </varlistentry>
699
700 <varlistentry>
701 <term><varname>SecureBits=</varname></term>
702 <listitem><para>Controls the secure bits set for the executed
703 process. Takes a space-separated combination of options from
704 the following list:
705 <option>keep-caps</option>,
706 <option>keep-caps-locked</option>,
707 <option>no-setuid-fixup</option>,
708 <option>no-setuid-fixup-locked</option>,
709 <option>noroot</option>, and
710 <option>noroot-locked</option>.
b938cb90 711 This option may appear more than once, in which case the secure
798d3a52
ZJS
712 bits are ORed. If the empty string is assigned to this option,
713 the bits are reset to 0. See
714 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
715 for details.</para></listitem>
716 </varlistentry>
717
718 <varlistentry>
719 <term><varname>Capabilities=</varname></term>
720 <listitem><para>Controls the
721 <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
722 set for the executed process. Take a capability string
723 describing the effective, permitted and inherited capability
724 sets as documented in
3ba3a79d 725 <citerefentry project='mankier'><refentrytitle>cap_from_text</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
726 Note that these capability sets are usually influenced (and
727 filtered) by the capabilities attached to the executed file.
728 Due to that <varname>CapabilityBoundingSet=</varname> is
729 probably a much more useful setting.</para></listitem>
730 </varlistentry>
731
732 <varlistentry>
733 <term><varname>ReadWriteDirectories=</varname></term>
734 <term><varname>ReadOnlyDirectories=</varname></term>
735 <term><varname>InaccessibleDirectories=</varname></term>
736
737 <listitem><para>Sets up a new file system namespace for
738 executed processes. These options may be used to limit access
739 a process might have to the main file system hierarchy. Each
740 setting takes a space-separated list of absolute directory
741 paths. Directories listed in
742 <varname>ReadWriteDirectories=</varname> are accessible from
743 within the namespace with the same access rights as from
744 outside. Directories listed in
745 <varname>ReadOnlyDirectories=</varname> are accessible for
746 reading only, writing will be refused even if the usual file
747 access controls would permit this. Directories listed in
748 <varname>InaccessibleDirectories=</varname> will be made
749 inaccessible for processes inside the namespace. Note that
750 restricting access with these options does not extend to
751 submounts of a directory that are created later on. These
b938cb90 752 options may be specified more than once, in which case all
798d3a52
ZJS
753 directories listed will have limited access from within the
754 namespace. If the empty string is assigned to this option, the
755 specific list is reset, and all prior assignments have no
756 effect.</para>
757 <para>Paths in
758 <varname>ReadOnlyDirectories=</varname>
759 and
760 <varname>InaccessibleDirectories=</varname>
761 may be prefixed with
762 <literal>-</literal>, in which case
763 they will be ignored when they do not
764 exist. Note that using this
765 setting will disconnect propagation of
766 mounts from the service to the host
767 (propagation in the opposite direction
768 continues to work). This means that
769 this setting may not be used for
770 services which shall be able to
771 install mount points in the main mount
772 namespace.</para></listitem>
773 </varlistentry>
774
775 <varlistentry>
776 <term><varname>PrivateTmp=</varname></term>
777
778 <listitem><para>Takes a boolean argument. If true, sets up a
779 new file system namespace for the executed processes and
780 mounts private <filename>/tmp</filename> and
781 <filename>/var/tmp</filename> directories inside it that is
782 not shared by processes outside of the namespace. This is
783 useful to secure access to temporary files of the process, but
784 makes sharing between processes via <filename>/tmp</filename>
785 or <filename>/var/tmp</filename> impossible. If this is
786 enabled, all temporary files created by a service in these
787 directories will be removed after the service is stopped.
788 Defaults to false. It is possible to run two or more units
789 within the same private <filename>/tmp</filename> and
790 <filename>/var/tmp</filename> namespace by using the
791 <varname>JoinsNamespaceOf=</varname> directive, see
792 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
793 for details. Note that using this setting will disconnect
794 propagation of mounts from the service to the host
795 (propagation in the opposite direction continues to work).
796 This means that this setting may not be used for services
797 which shall be able to install mount points in the main mount
798 namespace.</para></listitem>
799 </varlistentry>
800
801 <varlistentry>
802 <term><varname>PrivateDevices=</varname></term>
803
804 <listitem><para>Takes a boolean argument. If true, sets up a
805 new /dev namespace for the executed processes and only adds
806 API pseudo devices such as <filename>/dev/null</filename>,
807 <filename>/dev/zero</filename> or
808 <filename>/dev/random</filename> (as well as the pseudo TTY
809 subsystem) to it, but no physical devices such as
810 <filename>/dev/sda</filename>. This is useful to securely turn
811 off physical device access by the executed process. Defaults
812 to false. Enabling this option will also remove
813 <constant>CAP_MKNOD</constant> from the capability bounding
814 set for the unit (see above), and set
815 <varname>DevicePolicy=closed</varname> (see
816 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
817 for details). Note that using this setting will disconnect
818 propagation of mounts from the service to the host
819 (propagation in the opposite direction continues to work).
820 This means that this setting may not be used for services
821 which shall be able to install mount points in the main mount
822 namespace.</para></listitem>
823 </varlistentry>
824
825 <varlistentry>
826 <term><varname>PrivateNetwork=</varname></term>
827
828 <listitem><para>Takes a boolean argument. If true, sets up a
829 new network namespace for the executed processes and
830 configures only the loopback network device
831 <literal>lo</literal> inside it. No other network devices will
832 be available to the executed process. This is useful to
833 securely turn off network access by the executed process.
834 Defaults to false. It is possible to run two or more units
835 within the same private network namespace by using the
836 <varname>JoinsNamespaceOf=</varname> directive, see
837 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
838 for details. Note that this option will disconnect all socket
839 families from the host, this includes AF_NETLINK and AF_UNIX.
840 The latter has the effect that AF_UNIX sockets in the abstract
841 socket namespace will become unavailable to the processes
842 (however, those located in the file system will continue to be
843 accessible).</para></listitem>
844 </varlistentry>
845
846 <varlistentry>
847 <term><varname>ProtectSystem=</varname></term>
848
849 <listitem><para>Takes a boolean argument or
850 <literal>full</literal>. If true, mounts the
851 <filename>/usr</filename> and <filename>/boot</filename>
852 directories read-only for processes invoked by this unit. If
853 set to <literal>full</literal>, the <filename>/etc</filename>
854 directory is mounted read-only, too. This setting ensures that
b938cb90 855 any modification of the vendor-supplied operating system (and
798d3a52
ZJS
856 optionally its configuration) is prohibited for the service.
857 It is recommended to enable this setting for all long-running
858 services, unless they are involved with system updates or need
859 to modify the operating system in other ways. Note however
860 that processes retaining the CAP_SYS_ADMIN capability can undo
861 the effect of this setting. This setting is hence particularly
862 useful for daemons which have this capability removed, for
863 example with <varname>CapabilityBoundingSet=</varname>.
864 Defaults to off.</para></listitem>
865 </varlistentry>
866
867 <varlistentry>
868 <term><varname>ProtectHome=</varname></term>
869
870 <listitem><para>Takes a boolean argument or
871 <literal>read-only</literal>. If true, the directories
58331437
CH
872 <filename>/home</filename>, <filename>/root</filename> and
873 <filename>/run/user</filename>
798d3a52 874 are made inaccessible and empty for processes invoked by this
58331437 875 unit. If set to <literal>read-only</literal>, the three
798d3a52
ZJS
876 directories are made read-only instead. It is recommended to
877 enable this setting for all long-running services (in
878 particular network-facing ones), to ensure they cannot get
879 access to private user data, unless the services actually
880 require access to the user's private data. Note however that
881 processes retaining the CAP_SYS_ADMIN capability can undo the
882 effect of this setting. This setting is hence particularly
883 useful for daemons which have this capability removed, for
884 example with <varname>CapabilityBoundingSet=</varname>.
885 Defaults to off.</para></listitem>
886 </varlistentry>
887
888 <varlistentry>
889 <term><varname>MountFlags=</varname></term>
890
891 <listitem><para>Takes a mount propagation flag:
892 <option>shared</option>, <option>slave</option> or
893 <option>private</option>, which control whether mounts in the
894 file system namespace set up for this unit's processes will
895 receive or propagate mounts or unmounts. See
3ba3a79d 896 <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
897 for details. Defaults to <option>shared</option>. Use
898 <option>shared</option> to ensure that mounts and unmounts are
899 propagated from the host to the container and vice versa. Use
900 <option>slave</option> to run processes so that none of their
901 mounts and unmounts will propagate to the host. Use
902 <option>private</option> to also ensure that no mounts and
903 unmounts from the host will propagate into the unit processes'
904 namespace. Note that <option>slave</option> means that file
905 systems mounted on the host might stay mounted continuously in
906 the unit's namespace, and thus keep the device busy. Note that
907 the file system namespace related options
908 (<varname>PrivateTmp=</varname>,
909 <varname>PrivateDevices=</varname>,
910 <varname>ProtectSystem=</varname>,
911 <varname>ProtectHome=</varname>,
912 <varname>ReadOnlyDirectories=</varname>,
913 <varname>InaccessibleDirectories=</varname> and
914 <varname>ReadWriteDirectories=</varname>) require that mount
915 and unmount propagation from the unit's file system namespace
916 is disabled, and hence downgrade <option>shared</option> to
917 <option>slave</option>. </para></listitem>
918 </varlistentry>
919
920 <varlistentry>
921 <term><varname>UtmpIdentifier=</varname></term>
922
923 <listitem><para>Takes a four character identifier string for
023a4f67
LP
924 an <citerefentry
925 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>
926 and wtmp entry for this service. This should only be
927 set for services such as <command>getty</command>
928 implementations (such as <citerefentry
929 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
798d3a52 930 where utmp/wtmp entries must be created and cleared before and
023a4f67
LP
931 after execution, or for services that shall be executed as if
932 they were run by a <command>getty</command> process (see
933 below). If the configured string is longer than four
798d3a52
ZJS
934 characters, it is truncated and the terminal four characters
935 are used. This setting interprets %I style string
936 replacements. This setting is unset by default, i.e. no
937 utmp/wtmp entries are created or cleaned up for this
938 service.</para></listitem>
939 </varlistentry>
940
023a4f67
LP
941 <varlistentry>
942 <term><varname>UtmpMode=</varname></term>
943
944 <listitem><para>Takes one of <literal>init</literal>,
945 <literal>login</literal> or <literal>user</literal>. If
946 <varname>UtmpIdentifier=</varname> is set, controls which
947 type of <citerefentry
948 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp
949 entries for this service are generated. This setting has no
950 effect unless <varname>UtmpIdentifier=</varname> is set
951 too. If <literal>init</literal> is set, only an
952 <constant>INIT_PROCESS</constant> entry is generated and the
6cd16034
LP
953 invoked process must implement a
954 <command>getty</command>-compatible utmp/wtmp logic. If
955 <literal>login</literal> is set, first an
a8eaaee7 956 <constant>INIT_PROCESS</constant> entry, followed by a
6cd16034 957 <constant>LOGIN_PROCESS</constant> entry is generated. In
b938cb90 958 this case, the invoked process must implement a <citerefentry
023a4f67
LP
959 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
960 utmp/wtmp logic. If <literal>user</literal> is set, first an
961 <constant>INIT_PROCESS</constant> entry, then a
a8eaaee7 962 <constant>LOGIN_PROCESS</constant> entry and finally a
023a4f67 963 <constant>USER_PROCESS</constant> entry is generated. In this
b938cb90 964 case, the invoked process may be any process that is suitable
023a4f67
LP
965 to be run as session leader. Defaults to
966 <literal>init</literal>.</para></listitem>
967 </varlistentry>
968
798d3a52
ZJS
969 <varlistentry>
970 <term><varname>SELinuxContext=</varname></term>
971
972 <listitem><para>Set the SELinux security context of the
973 executed process. If set, this will override the automated
974 domain transition. However, the policy still needs to
975 authorize the transition. This directive is ignored if SELinux
976 is disabled. If prefixed by <literal>-</literal>, all errors
977 will be ignored. See
3ba3a79d 978 <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
798d3a52
ZJS
979 for details.</para></listitem>
980 </varlistentry>
981
982 <varlistentry>
983 <term><varname>AppArmorProfile=</varname></term>
984
985 <listitem><para>Takes a profile name as argument. The process
986 executed by the unit will switch to this profile when started.
987 Profiles must already be loaded in the kernel, or the unit
988 will fail. This result in a non operation if AppArmor is not
989 enabled. If prefixed by <literal>-</literal>, all errors will
990 be ignored. </para></listitem>
991 </varlistentry>
992
993 <varlistentry>
994 <term><varname>SmackProcessLabel=</varname></term>
995
996 <listitem><para>Takes a <option>SMACK64</option> security
997 label as argument. The process executed by the unit will be
998 started under this label and SMACK will decide whether the
b938cb90 999 process is allowed to run or not, based on it. The process
798d3a52
ZJS
1000 will continue to run under the label specified here unless the
1001 executable has its own <option>SMACK64EXEC</option> label, in
1002 which case the process will transition to run under that
1003 label. When not specified, the label that systemd is running
1004 under is used. This directive is ignored if SMACK is
1005 disabled.</para>
1006
1007 <para>The value may be prefixed by <literal>-</literal>, in
1008 which case all errors will be ignored. An empty value may be
1009 specified to unset previous assignments.</para>
1010 </listitem>
1011 </varlistentry>
1012
1013 <varlistentry>
1014 <term><varname>IgnoreSIGPIPE=</varname></term>
1015
1016 <listitem><para>Takes a boolean argument. If true, causes
1017 <constant>SIGPIPE</constant> to be ignored in the executed
1018 process. Defaults to true because <constant>SIGPIPE</constant>
1019 generally is useful only in shell pipelines.</para></listitem>
1020 </varlistentry>
1021
1022 <varlistentry>
1023 <term><varname>NoNewPrivileges=</varname></term>
1024
1025 <listitem><para>Takes a boolean argument. If true, ensures
1026 that the service process and all its children can never gain
1027 new privileges. This option is more powerful than the
1028 respective secure bits flags (see above), as it also prohibits
1029 UID changes of any kind. This is the simplest, most effective
1030 way to ensure that a process and its children can never
1031 elevate privileges again.</para></listitem>
1032 </varlistentry>
1033
1034 <varlistentry>
1035 <term><varname>SystemCallFilter=</varname></term>
1036
1037 <listitem><para>Takes a space-separated list of system call
1038 names. If this setting is used, all system calls executed by
1039 the unit processes except for the listed ones will result in
1040 immediate process termination with the
1041 <constant>SIGSYS</constant> signal (whitelisting). If the
1042 first character of the list is <literal>~</literal>, the
1043 effect is inverted: only the listed system calls will result
1044 in immediate process termination (blacklisting). If running in
1045 user mode and this option is used,
1046 <varname>NoNewPrivileges=yes</varname> is implied. This
1047 feature makes use of the Secure Computing Mode 2 interfaces of
1048 the kernel ('seccomp filtering') and is useful for enforcing a
1049 minimal sandboxing environment. Note that the
1050 <function>execve</function>,
1051 <function>rt_sigreturn</function>,
1052 <function>sigreturn</function>,
1053 <function>exit_group</function>, <function>exit</function>
1054 system calls are implicitly whitelisted and do not need to be
b938cb90 1055 listed explicitly. This option may be specified more than once,
798d3a52
ZJS
1056 in which case the filter masks are merged. If the empty string
1057 is assigned, the filter is reset, all prior assignments will
1058 have no effect.</para>
1059
1060 <para>If you specify both types of this option (i.e.
1061 whitelisting and blacklisting), the first encountered will
1062 take precedence and will dictate the default action
1063 (termination or approval of a system call). Then the next
1064 occurrences of this option will add or delete the listed
1065 system calls from the set of the filtered system calls,
1066 depending of its type and the default action. (For example, if
1067 you have started with a whitelisting of
1068 <function>read</function> and <function>write</function>, and
1069 right after it add a blacklisting of
1070 <function>write</function>, then <function>write</function>
1071 will be removed from the set.) </para></listitem>
1072 </varlistentry>
1073
1074 <varlistentry>
1075 <term><varname>SystemCallErrorNumber=</varname></term>
1076
1077 <listitem><para>Takes an <literal>errno</literal> error number
1078 name to return when the system call filter configured with
1079 <varname>SystemCallFilter=</varname> is triggered, instead of
1080 terminating the process immediately. Takes an error name such
1081 as <constant>EPERM</constant>, <constant>EACCES</constant> or
1082 <constant>EUCLEAN</constant>. When this setting is not used,
1083 or when the empty string is assigned, the process will be
1084 terminated immediately when the filter is
1085 triggered.</para></listitem>
1086 </varlistentry>
1087
1088 <varlistentry>
1089 <term><varname>SystemCallArchitectures=</varname></term>
1090
b938cb90 1091 <listitem><para>Takes a space-separated list of architecture
798d3a52
ZJS
1092 identifiers to include in the system call filter. The known
1093 architecture identifiers are <constant>x86</constant>,
1094 <constant>x86-64</constant>, <constant>x32</constant>,
1095 <constant>arm</constant> as well as the special identifier
1096 <constant>native</constant>. Only system calls of the
1097 specified architectures will be permitted to processes of this
1098 unit. This is an effective way to disable compatibility with
1099 non-native architectures for processes, for example to
1100 prohibit execution of 32-bit x86 binaries on 64-bit x86-64
1101 systems. The special <constant>native</constant> identifier
1102 implicitly maps to the native architecture of the system (or
1103 more strictly: to the architecture the system manager is
1104 compiled for). If running in user mode and this option is
1105 used, <varname>NoNewPrivileges=yes</varname> is implied. Note
1106 that setting this option to a non-empty list implies that
1107 <constant>native</constant> is included too. By default, this
1108 option is set to the empty list, i.e. no architecture system
1109 call filtering is applied.</para></listitem>
1110 </varlistentry>
1111
1112 <varlistentry>
1113 <term><varname>RestrictAddressFamilies=</varname></term>
1114
1115 <listitem><para>Restricts the set of socket address families
1116 accessible to the processes of this unit. Takes a
1117 space-separated list of address family names to whitelist,
1118 such as
1119 <constant>AF_UNIX</constant>,
1120 <constant>AF_INET</constant> or
1121 <constant>AF_INET6</constant>. When
1122 prefixed with <constant>~</constant> the listed address
1123 families will be applied as blacklist, otherwise as whitelist.
1124 Note that this restricts access to the
3ba3a79d 1125 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
1126 system call only. Sockets passed into the process by other
1127 means (for example, by using socket activation with socket
1128 units, see
1129 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1130 are unaffected. Also, sockets created with
1131 <function>socketpair()</function> (which creates connected
1132 AF_UNIX sockets only) are unaffected. Note that this option
1133 has no effect on 32-bit x86 and is ignored (but works
1134 correctly on x86-64). If running in user mode and this option
1135 is used, <varname>NoNewPrivileges=yes</varname> is implied. By
1136 default, no restriction applies, all address families are
1137 accessible to processes. If assigned the empty string, any
1138 previous list changes are undone.</para>
1139
1140 <para>Use this option to limit exposure of processes to remote
1141 systems, in particular via exotic network protocols. Note that
1142 in most cases, the local <constant>AF_UNIX</constant> address
1143 family should be included in the configured whitelist as it is
1144 frequently used for local communication, including for
1145 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1146 logging.</para></listitem>
1147 </varlistentry>
1148
1149 <varlistentry>
1150 <term><varname>Personality=</varname></term>
1151
1152 <listitem><para>Controls which kernel architecture
3ba3a79d 1153 <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
798d3a52
ZJS
1154 shall report, when invoked by unit processes. Takes one of
1155 <constant>x86</constant> and <constant>x86-64</constant>. This
1156 is useful when running 32-bit services on a 64-bit host
1157 system. If not specified, the personality is left unmodified
1158 and thus reflects the personality of the host system's
1159 kernel.</para></listitem>
1160 </varlistentry>
1161
1162 <varlistentry>
1163 <term><varname>RuntimeDirectory=</varname></term>
1164 <term><varname>RuntimeDirectoryMode=</varname></term>
1165
1166 <listitem><para>Takes a list of directory names. If set, one
1167 or more directories by the specified names will be created
1168 below <filename>/run</filename> (for system services) or below
1169 <varname>$XDG_RUNTIME_DIR</varname> (for user services) when
1170 the unit is started, and removed when the unit is stopped. The
1171 directories will have the access mode specified in
1172 <varname>RuntimeDirectoryMode=</varname>, and will be owned by
1173 the user and group specified in <varname>User=</varname> and
1174 <varname>Group=</varname>. Use this to manage one or more
1175 runtime directories of the unit and bind their lifetime to the
1176 daemon runtime. The specified directory names must be
1177 relative, and may not include a <literal>/</literal>, i.e.
1178 must refer to simple directories to create or remove. This is
1179 particularly useful for unprivileged daemons that cannot
1180 create runtime directories in <filename>/run</filename> due to
1181 lack of privileges, and to make sure the runtime directory is
1182 cleaned up automatically after use. For runtime directories
1183 that require more complex or different configuration or
1184 lifetime guarantees, please consider using
1185 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
1186 </varlistentry>
1187
1188 </variablelist>
1189 </refsect1>
1190
1191 <refsect1>
1192 <title>Environment variables in spawned processes</title>
1193
1194 <para>Processes started by the system are executed in a clean
1195 environment in which select variables listed below are set. System
1196 processes started by systemd do not inherit variables from PID 1,
1197 but processes started by user systemd instances inherit all
1198 environment variables from the user systemd instance.
1199 </para>
1200
1201 <variablelist class='environment-variables'>
1202 <varlistentry>
1203 <term><varname>$PATH</varname></term>
1204
1205 <listitem><para>Colon-separated list of directories to use
1206 when launching executables. Systemd uses a fixed value of
1207 <filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename>:<filename>/sbin</filename>:<filename>/bin</filename>.
1208 </para></listitem>
1209 </varlistentry>
1210
1211 <varlistentry>
1212 <term><varname>$LANG</varname></term>
1213
1214 <listitem><para>Locale. Can be set in
3ba3a79d 1215 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52
ZJS
1216 or on the kernel command line (see
1217 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1218 and
1219 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
1220 </para></listitem>
1221 </varlistentry>
1222
1223 <varlistentry>
1224 <term><varname>$USER</varname></term>
1225 <term><varname>$LOGNAME</varname></term>
1226 <term><varname>$HOME</varname></term>
1227 <term><varname>$SHELL</varname></term>
1228
1229 <listitem><para>User name (twice), home directory, and the
1230 login shell. The variables are set for the units that have
1231 <varname>User=</varname> set, which includes user
1232 <command>systemd</command> instances. See
3ba3a79d 1233 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
798d3a52
ZJS
1234 </para></listitem>
1235 </varlistentry>
1236
1237 <varlistentry>
1238 <term><varname>$XDG_RUNTIME_DIR</varname></term>
1239
1240 <listitem><para>The directory for volatile state. Set for the
1241 user <command>systemd</command> instance, and also in user
1242 sessions. See
1243 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
1244 </para></listitem>
1245 </varlistentry>
1246
1247 <varlistentry>
1248 <term><varname>$XDG_SESSION_ID</varname></term>
1249 <term><varname>$XDG_SEAT</varname></term>
1250 <term><varname>$XDG_VTNR</varname></term>
1251
1252 <listitem><para>The identifier of the session, the seat name,
1253 and virtual terminal of the session. Set by
1254 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1255 for login sessions. <varname>$XDG_SEAT</varname> and
1256 <varname>$XDG_VTNR</varname> will only be set when attached to
1257 a seat and a tty.</para></listitem>
1258 </varlistentry>
1259
1260 <varlistentry>
1261 <term><varname>$MAINPID</varname></term>
1262
1263 <listitem><para>The PID of the units main process if it is
1264 known. This is only set for control processes as invoked by
1265 <varname>ExecReload=</varname> and similar. </para></listitem>
1266 </varlistentry>
1267
1268 <varlistentry>
1269 <term><varname>$MANAGERPID</varname></term>
1270
1271 <listitem><para>The PID of the user <command>systemd</command>
1272 instance, set for processes spawned by it. </para></listitem>
1273 </varlistentry>
1274
1275 <varlistentry>
1276 <term><varname>$LISTEN_FDS</varname></term>
1277 <term><varname>$LISTEN_PID</varname></term>
1278
1279 <listitem><para>Information about file descriptors passed to a
1280 service for socket activation. See
1281 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1282 </para></listitem>
1283 </varlistentry>
1284
1285 <varlistentry>
1286 <term><varname>$TERM</varname></term>
1287
1288 <listitem><para>Terminal type, set only for units connected to
1289 a terminal (<varname>StandardInput=tty</varname>,
1290 <varname>StandardOutput=tty</varname>, or
1291 <varname>StandardError=tty</varname>). See
1292 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1293 </para></listitem>
1294 </varlistentry>
1295 </variablelist>
1296
1297 <para>Additional variables may be configured by the following
1298 means: for processes spawned in specific units, use the
1299 <varname>Environment=</varname> and
1300 <varname>EnvironmentFile=</varname> options above; to specify
1301 variables globally, use <varname>DefaultEnvironment=</varname>
1302 (see
1303 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1304 or the kernel option <varname>systemd.setenv=</varname> (see
1305 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1306 Additional variables may also be set through PAM,
1307 cf. <citerefentry project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
1308 </refsect1>
1309
1310 <refsect1>
1311 <title>See Also</title>
1312 <para>
1313 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1314 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1315 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1316 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1317 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1318 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1319 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1320 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1321 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1322 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1323 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1324 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1325 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1326 </para>
1327 </refsect1>
dd1eb43b
LP
1328
1329</refentry>