2N/A<?
xml version='1.0'?>
<!--*-nxml-*--> 2N/A<!
DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 2N/A This file is part of systemd. 2N/A Copyright 2010 Lennart Poettering 2N/A systemd is free software; you can redistribute it and/or modify it 2N/A under the terms of the GNU General Public License as published by 2N/A the Free Software Foundation; either version 2 of the License, or 2N/A (at your option) any later version. 2N/A systemd is distributed in the hope that it will be useful, but 2N/A WITHOUT ANY WARRANTY; without even the implied warranty of 2N/A MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 2N/A General Public License for more details. 2N/A You should have received a copy of the GNU General Public License 2N/A <
productname>systemd</
productname>
12N/A <
contrib>Developer</
contrib>
12N/A <
firstname>Lennart</
firstname>
2N/A <
surname>Poettering</
surname>
2N/A <
email>lennart@poettering.net</
email>
38N/A <
manvolnum>5</
manvolnum>
26N/A <
refpurpose>systemd execution environment configuration</
refpurpose>
26N/A <
title>Description</
title>
26N/A <
para>Unit configuration files for services, sockets
26N/A mount points and swap devices share a subset of
26N/A configuration options which define the execution
2N/A environment of spawned processes.</
para>
26N/A <
para>This man page lists the configuration options
26N/A shared by these three unit types. See
26N/A <
citerefentry><
refentrytitle>
systemd.unit</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
26N/A for the common options of all unit configuration
26N/A <
citerefentry><
refentrytitle>
systemd.service</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
26N/A <
citerefentry><
refentrytitle>
systemd.socket</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
26N/A <
citerefentry><
refentrytitle>
systemd.swap</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
26N/A <
citerefentry><
refentrytitle>
systemd.mount</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
26N/A for more information on the specific unit
26N/A configuration files. The execution specific
2N/A configuration options are configured in the [Service],
26N/A [Socket], [Mount] resp. [Swap] section, depending on the unit
26N/A <
title>Options</
title>
26N/A <
term><
varname>WorkingDirectory=</
varname></
term>
2N/A <
listitem><
para>Takes an absolute
26N/A directory path. Sets the working
30N/A directory for executed
26N/A processes.</
para></
listitem>
27N/A <
term><
varname>RootDirectory=</
varname></
term>
38N/A <
listitem><
para>Takes an absolute
38N/A directory path. Sets the root
38N/A directory for executed processes, with
7N/A <
citerefentry><
refentrytitle>chroot</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
26N/A system call. If this is used it must
26N/A be ensured that the process and all
38N/A its auxiliary files are available in
26N/A the <
function>chroot()</
function>
26N/A jail.</
para></
listitem>
46N/A <
term><
varname>User=</
varname></
term>
46N/A <
term><
varname>Group=</
varname></
term>
26N/A <
listitem><
para>Sets the Unix user
26N/A resp. group the processes are executed
46N/A as. Takes a single user resp. group
46N/A name or ID as argument. If no group is
46N/A set the default group of the user is
2N/A chosen.</
para></
listitem>
46N/A <
term><
varname>SupplementaryGroups=</
varname></
term>
26N/A <
listitem><
para>Sets the supplementary
46N/A Unix groups the processes are executed
46N/A as. This takes a space separated list
46N/A of group names or IDs. This option may
53N/A be specified more than once in which
26N/A case all listed groups are set as
46N/A supplementary groups. This option does
46N/A not override but extends the list of
46N/A supplementary groups configured in the
53N/A system group database for the
46N/A user.</
para></
listitem>
46N/A <
term><
varname>Nice=</
varname></
term>
46N/A <
listitem><
para>Sets the default nice
53N/A level (scheduling priority) for
53N/A executed processes. Takes an integer
53N/A between -20 (highest priority) and 19
46N/A (lowest priority). See
38N/A <
citerefentry><
refentrytitle>setpriority</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
46N/A for details.</
para></
listitem>
46N/A <
term><
varname>OOMScoreAdjust=</
varname></
term>
38N/A <
listitem><
para>Sets the adjustment
26N/A level for the Out-Of-Memory killer for
2N/A executed processes. Takes an integer
32N/A between -1000 (to disable OOM killing
32N/A for this process) and 1000 (to make
32N/A killing of this process under memory
32N/A pressure very likely). See <
ulink 32N/A for details.</
para></
listitem>
32N/A <
term><
varname>IOSchedulingClass=</
varname></
term>
38N/A <
listitem><
para>Sets the IO scheduling
38N/A class for executed processes. Takes an
38N/A integer between 0 and 3 or one of the
38N/A strings <
option>none</
option>,
38N/A <
option>realtime</
option>,
38N/A <
option>best-effort</
option> or
38N/A <
option>idle</
option>. See
38N/A <
citerefentry><
refentrytitle>ioprio_set</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
38N/A for details.</
para></
listitem>
26N/A <
term><
varname>IOSchedulingPriority=</
varname></
term>
26N/A <
listitem><
para>Sets the IO scheduling
26N/A priority for executed processes. Takes
26N/A an integer between 0 (highest
26N/A priority) and 7 (lowest priority). The
26N/A available priorities depend on the
26N/A selected IO scheduling class (see
32N/A <
citerefentry><
refentrytitle>ioprio_set</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
32N/A for details.</
para></
listitem>
32N/A <
term><
varname>CPUSchedulingPolicy=</
varname></
term>
32N/A <
listitem><
para>Sets the CPU
38N/A scheduling policy for executed
38N/A processes. Takes one of
38N/A <
option>other</
option>,
32N/A <
option>batch</
option>,
<
citerefentry><
refentrytitle>sched_setscheduler</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>CPUSchedulingPriority=</
varname></
term>
<
listitem><
para>Sets the CPU
scheduling priority for executed
processes. Takes an integer between 1
(lowest priority) and 99 (highest
priority). The available priority
range depends on the selected CPU
scheduling policy (see above). See
<
citerefentry><
refentrytitle>sched_setscheduler</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>CPUSchedulingResetOnFork=</
varname></
term>
<
listitem><
para>Takes a boolean
argument. If true elevated CPU
scheduling priorities and policies
will be reset when the executed
processes fork, and can hence not leak
into child processes. See
<
citerefentry><
refentrytitle>sched_setscheduler</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for details. Defaults to false.</
para></
listitem>
<
term><
varname>CPUAffinity=</
varname></
term>
<
listitem><
para>Controls the CPU
processes. Takes a space-separated
<
citerefentry><
refentrytitle>sched_setaffinity</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>UMask=</
varname></
term>
<
listitem><
para>Controls the file mode
creation mask. Takes an access mode in
<
citerefentry><
refentrytitle>umask</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
<
term><
varname>Environment=</
varname></
term>
<
listitem><
para>Sets environment
processes. Takes a space-separated
list of variable assignments. This
option may be specified more than once
in which case all listed variables
will be set. If the same variable is
set twice the later setting will
override the earlier setting. See
<
citerefentry><
refentrytitle>environ</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>EnvironmentFile=</
varname></
term>
<
listitem><
para>Similar to
<
varname>Environment=</
varname> but
reads the environment variables from a
text file. The text file should
contain new-line separated variable
assignments. Empty lines and lines
starting with ; or # will be ignored,
which may be used for commenting. The
argument passed should be an absolute
file name, optionally prefixed with
"-", which indicates that if the file
does not exist it won't be read and no
error or warning message is
logged. The files listed with this
directive will be read shortly before
the process is executed. Settings from
these files override settings made
<
varname>Environment=</
varname>. If
the same variable is set twice from
these files the files will be read in
the order they are specified and the
later setting will override the
earlier setting. </
para></
listitem>
<
term><
varname>StandardInput=</
varname></
term>
<
listitem><
para>Controls where file
descriptor 0 (STDIN) of the executed
processes is connected to. Takes one
of <
option>null</
option>,
<
option>tty-force</
option>,
<
option>tty-fail</
option> or
<
option>socket</
option>. If
<
option>null</
option> is selected
standard input will be connected to
i.e. all read attempts by the process
will result in immediate EOF. If
<
option>tty</
option> is selected
standard input is connected to a TTY
<
varname>TTYPath=</
varname>, see
below) and the executed process
becomes the controlling process of the
terminal. If the terminal is already
being controlled by another process the
executed process waits until the current
controlling process releases the
<
option>tty-force</
option>
is similar to <
option>tty</
option>,
but the executed process is forcefully
and immediately made the controlling
process of the terminal, potentially
removing previous controlling
terminal. <
option>tty-fail</
option> is
similar to <
option>tty</
option> but if
the terminal already has a controlling
process start-up of the executed
<
option>socket</
option> option is only
valid in socket-activated services,
and only when the socket configuration
<
citerefentry><
refentrytitle>
systemd.socket</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
for details) specifies a single socket
only. If this option is set standard
input will be connected to the socket
the service was activated from, which
is primarily useful for compatibility
with daemons designed for use with the
<
citerefentry><
refentrytitle>inetd</
refentrytitle><
manvolnum>8</
manvolnum></
citerefentry>
daemon. This setting defaults to
<
option>null</
option>.</
para></
listitem>
<
term><
varname>StandardOutput=</
varname></
term>
<
listitem><
para>Controls where file
descriptor 1 (STDOUT) of the executed
processes is connected to. Takes one
of <
option>inherit</
option>,
<
option>kmsg+console</
option>,
<
option>syslog+console</
option> or
<
option>socket</
option>. If set to
<
option>inherit</
option> the file
descriptor of standard input is
duplicated for standard output. If set
to <
option>null</
option> standard
output will be connected to
i.e. everything written to it will be
lost. If set to <
option>tty</
option>
standard output will be connected to a
<
varname>TTYPath=</
varname>, see
below). If the TTY is used for output
only the executed process will not
become the controlling process of the
terminal, and will not fail or wait
for other processes to release the
terminal. <
option>syslog</
option>
connects standard output to the
<
citerefentry><
refentrytitle>syslog</
refentrytitle><
manvolnum>3</
manvolnum></
citerefentry>
system logger. <
option>kmsg</
option>
connects it with the kernel log buffer
<
citerefentry><
refentrytitle>dmesg</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>. <
option>syslog+console</
option>
and <
option>kmsg+console</
option> work
similarly but copy the output to the
well. <
option>socket</
option> connects
standard output to a socket from
socket activation, semantics are
similar to the respective option of
<
varname>StandardInput=</
varname>.
<
option>inherit</
option>.</
para></
listitem>
<
term><
varname>StandardError=</
varname></
term>
<
listitem><
para>Controls where file
descriptor 2 (STDERR) of the executed
processes is connected to. The
available options are identical to
<
varname>StandardOutput=</
varname>,
with one exception: if set to
<
option>inherit</
option> the file
descriptor used for standard output is
duplicated for standard error. This
<
option>inherit</
option>.</
para></
listitem>
<
term><
varname>TTYPath=</
varname></
term>
<
listitem><
para>Sets the terminal
device node to use if standard input,
output or stderr are connected to a
TTY (see above). Defaults to
<
filename>/
dev/
console</
filename>.</
para></
listitem>
<
term><
varname>SyslogIdentifier=</
varname></
term>
<
listitem><
para>Sets the process name
to prefix log lines sent to syslog or
the kernel log buffer with. If not set
defaults to the process name of the
executed process. This option is only
<
varname>StandardOutput=</
varname> or
<
varname>StandardError=</
varname> are
set to <
option>syslog</
option> or
<
option>kmsg</
option>.</
para></
listitem>
<
term><
varname>SyslogFacility=</
varname></
term>
<
listitem><
para>Sets the syslog
facility to use when logging to
syslog. One of <
option>kern</
option>,
<
option>authpriv</
option>,
<
option>local6</
option> or
<
option>local7</
option>. See
<
citerefentry><
refentrytitle>syslog</
refentrytitle><
manvolnum>3</
manvolnum></
citerefentry>
for details. This option is only
<
varname>StandardOutput=</
varname> or
<
varname>StandardError=</
varname> are
set to <
option>syslog</
option>.
<
option>daemon</
option>.</
para></
listitem>
<
term><
varname>SyslogLevel=</
varname></
term>
<
listitem><
para>Default syslog level
to use when logging to syslog or the
kernel log buffer. One of
<
option>warning</
option>,
<
option>debug</
option>. See
<
citerefentry><
refentrytitle>syslog</
refentrytitle><
manvolnum>3</
manvolnum></
citerefentry>
for details. This option is only
<
varname>StandardOutput=</
varname> or
<
varname>StandardError=</
varname> are
set to <
option>syslog</
option> or
<
option>kmsg</
option>. Note that
individual lines output by the daemon
might be prefixed with a different log
level which can be used to override
the default log level specified
here. The interpretation of these
prefixes may be disabled with
<
varname>SyslogLevelPrefix=</
varname>,
see below. For details see
<
citerefentry><
refentrytitle>sd-daemon</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>.
<
option>info</
option>.</
para></
listitem>
<
term><
varname>SyslogLevelPrefix=</
varname></
term>
<
listitem><
para>Takes a boolean
<
varname>StandardOutput=</
varname> or
<
varname>StandardError=</
varname> are
set to <
option>syslog</
option> or
<
option>kmsg</
option> log lines
written by the executed process that
are prefixed with a log level will be
passed on to syslog with this log
level set but the prefix removed. If
set to false, the interpretation of
these prefixes is disabled and the
logged lines are passed on as-is. For
details about this prefixing see
<
citerefentry><
refentrytitle>sd-daemon</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>.
Defaults to true.</
para></
listitem>
<
term><
varname>TimerSlackNSec=</
varname></
term>
<
listitem><
para>Sets the timer slack
in nanoseconds for the executed
processes. The timer slack controls the
accuracy of wake-ups triggered by
<
citerefentry><
refentrytitle>prctl</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for more information. Note that in
contrast to most other time span
definitions this parameter takes an
integer value in nano-seconds and does
<
term><
varname>LimitCPU=</
varname></
term>
<
term><
varname>LimitFSIZE=</
varname></
term>
<
term><
varname>LimitDATA=</
varname></
term>
<
term><
varname>LimitSTACK=</
varname></
term>
<
term><
varname>LimitCORE=</
varname></
term>
<
term><
varname>LimitRSS=</
varname></
term>
<
term><
varname>LimitNOFILE=</
varname></
term>
<
term><
varname>LimitAS=</
varname></
term>
<
term><
varname>LimitNPROC=</
varname></
term>
<
term><
varname>LimitMEMLOCK=</
varname></
term>
<
term><
varname>LimitLOCKS=</
varname></
term>
<
term><
varname>LimitSIGPENDING=</
varname></
term>
<
term><
varname>LimitMSGQUEUE=</
varname></
term>
<
term><
varname>LimitNICE=</
varname></
term>
<
term><
varname>LimitRTPRIO=</
varname></
term>
<
term><
varname>LimitRTTIME=</
varname></
term>
<
listitem><
para>These settings control
various resource limits for executed
<
citerefentry><
refentrytitle>setrlimit</
refentrytitle><
manvolnum>2</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>PAMName=</
varname></
term>
<
listitem><
para>Sets the PAM service
name to set up a session as. If set
the executed process will be
registered as a PAM session under the
specified service name. This is only
useful in conjunction with the
<
varname>User=</
varname> setting. If
not set no PAM session will be opened
for the executed processes. See
<
citerefentry><
refentrytitle>pam</
refentrytitle><
manvolnum>8</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>TCPWrapName=</
varname></
term>
<
listitem><
para>If this is a
socket-activated service this sets the
tcpwrap service name to check the
permission for the current connection
with. This is only useful in
conjunction with socket-activated
services, and stream sockets (TCP) in
particular. It has no effect on other
unrelated to socket-based
activation. If the tcpwrap
verification fails daemon start-up
will fail and the connection is
<
citerefentry><
refentrytitle>tcpd</
refentrytitle><
manvolnum>8</
manvolnum></
citerefentry>
for details.</
para></
listitem>
<
term><
varname>CapabilityBoundingSet=</
varname></
term>
<
listitem><
para>Controls which
capabilities to include in the
capability bounding set for the
<
citerefentry><
refentrytitle>capabilities</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>
for details. Takes a whitespace
seperated list of capability names as
<
citerefentry><
refentrytitle>cap_from_name</
refentrytitle><
manvolnum>3</
manvolnum></
citerefentry>.
Capabilities listed will be included
in the bounding set, all others are
removed. If the list of capabilities
is prefixed with ~ all but the listed
capabilities will be included, the
effect of this assignment
inverted. Note that this option does
not actually set or unset any
capabilities in the effective,
permitted or inherited capability
<
varname>Capabilities=</
varname> is
for. If this option is not used the
capability bounding set is not
modified on process execution, hence
no limits on the capabilities of the
process are enforced.</
para></
listitem>
<
term><
varname>SecureBits=</
varname></
term>
<
listitem><
para>Controls the secure
bits set for the executed process. See
<
citerefentry><
refentrytitle>capabilities</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>
for details. Takes a list of strings:
<
option>keep-caps</
option>,
<
option>keep-caps-locked</
option>,
<
option>no-setuid-fixup</
option>,
<
option>no-setuid-fixup-locked</
option>,
<
option>no-setuid-noroot</
option>
and/
or <
option>no-setuid-noroot-locked</
option>.
<
term><
varname>Capabilities=</
varname></
term>
<
listitem><
para>Controls the
<
citerefentry><
refentrytitle>capabilities</
refentrytitle><
manvolnum>7</
manvolnum></
citerefentry>
set for the executed process. Take a
capability string describing the
effective, permitted and inherited
capability sets as documented in
<
citerefentry><
refentrytitle>cap_from_text</
refentrytitle><
manvolnum>3</
manvolnum></
citerefentry>.
Note that these capability sets are
usually influenced by the capabilities
attached to the executed file. Due to
<
varname>CapabilityBoundingSet=</
varname>
is probably the much more useful
setting.</
para></
listitem>
<
term><
varname>ControlGroup=</
varname></
term>
<
listitem><
para>Controls the control
groups the executed processes shall be
space-separated list of cgroup
identifiers. A cgroup identifier has a
<
filename>cpu:/
foo/
bar</
filename>,
where "cpu" identifies the kernel
control group controller used, and
<
filename>/
foo/
bar</
filename> is the
control group path. The controller name
and ":" may be omitted in which case
the named systemd control group
hierarchy is implied. Alternatively,
the path and ":" may be omitted, in
which case the default control group
path for this unit is implied. This
option may be used to place executed
processes in arbitrary groups in
arbitrary hierachies -- which can be
configured externally with additional execution limits. By default
systemd will place all executed
processes in separate per-unit control
groups (named after the unit) in the
systemd named hierarchy. Since every
process can be in one group per
hierarchy only overriding the control group
path in the named systemd hierarchy
will disable automatic placement in
the default group. For details about control
<
term><
varname>ReadWriteDirectories=</
varname></
term>
<
term><
varname>ReadOnlyDirectories=</
varname></
term>
<
term><
varname>InaccessibleDirectories=</
varname></
term>
<
listitem><
para>Sets up a new
file-system name space for executed
processes. These options may be used
to limit access a process might have
hierarchy. Each setting takes a
space-separated list of absolute
directory paths. Directories listed in
<
varname>ReadWriteDirectories=</
varname>
are accessible from within the
namespace with the same access rights
as from outside. Directories listed in
<
varname>ReadOnlyDirectories=</
varname>
are accessible for reading only,
writing will be refused even if the
usual file access controls would
permit this. Directories listed in
<
varname>InaccessibleDirectories=</
varname>
will be made inaccesible for processes
inside the namespace. Note that
restricting access with these options
does not extend to submounts of a
directory. You must list submounts
separately in these settings to
ensure the same limited access. These
options may be specified more than
once in which case all directories
listed will have limited access from
namespace.</
para></
listitem>
<
term><
varname>PrivateTmp=</
varname></
term>
<
listitem><
para>Takes a boolean
argument. If true sets up a new
namespace for the executed processes
<
filename>/tmp</
filename> directory
inside it, that is not shared by
namespace. This is useful to secure
access to temporary files of the
process, but makes sharing between
<
filename>/tmp</
filename>
impossible. Defaults to false.</
para></
listitem>
<
term><
varname>MountFlags=</
varname></
term>
<
listitem><
para>Takes a mount
<
option>slave</
option> or
<
option>private</
option>, which
control whether namespaces set up with
<
varname>ReadWriteDirectories=</
varname>,
<
varname>ReadOnlyDirectories=</
varname>
<
varname>InaccessibleDirectories=</
varname>
receive or propagate new mounts
from/
to the main namespace. See
<
citerefentry><
refentrytitle>mount</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>
<
option>shared</
option>,
i.e. the new
namespace will both receive new mount
points from the main namespace as well
as propagate new mounts to
<
term><
varname>UtmpIdentifier=</
varname></
term>
<
listitem><
para>Takes a a four
character identifier string for an
should only be set for services such
as <
command>getty</
command>
entries must be created and cleared
before and after execution. If the
configured string is longer than four
characters it is truncated and the
terminal four characters are
used. This setting interprets %I style
string replacements. This setting is
entries are created or cleaned up for
this service.</
para></
listitem>
<
citerefentry><
refentrytitle>systemd</
refentrytitle><
manvolnum>1</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>systemctl</
refentrytitle><
manvolnum>8</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>
systemd.unit</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>
systemd.service</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>
systemd.socket</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>
systemd.swap</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>,
<
citerefentry><
refentrytitle>
systemd.mount</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>