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