man/systemd-system.conf.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   SPDX-License-Identifier: LGPL-2.1+
  10 -->
  11
  12 <refentry id="systemd-system.conf"
  13     xmlns:xi="http://www.w3.org/2001/XInclude">
  14   <refentryinfo>
  15     <title>systemd-system.conf</title>
  16     <productname>systemd</productname>
  17   </refentryinfo>
  18
  19   <refmeta>
  20     <refentrytitle>systemd-system.conf</refentrytitle>
  21     <manvolnum>5</manvolnum>
  22   </refmeta>
  23
  24   <refnamediv>
  25     <refname>systemd-system.conf</refname>
  26     <refname>system.conf.d</refname>
  27     <refname>systemd-user.conf</refname>
  28     <refname>user.conf.d</refname>
  29     <refpurpose>System and session service manager configuration files</refpurpose>
  30   </refnamediv>
  31
  32   <refsynopsisdiv>
  33     <para><filename>/etc/systemd/system.conf</filename>,
  34     <filename>/etc/systemd/system.conf.d/*.conf</filename>,
  35     <filename>/run/systemd/system.conf.d/*.conf</filename>,
  36     <filename>/usr/lib/systemd/system.conf.d/*.conf</filename></para>
  37     <para><filename>/etc/systemd/user.conf</filename>,
  38     <filename>/etc/systemd/user.conf.d/*.conf</filename>,
  39     <filename>/run/systemd/user.conf.d/*.conf</filename>,
  40     <filename>/usr/lib/systemd/user.conf.d/*.conf</filename></para>
  41   </refsynopsisdiv>
  42
  43   <refsect1>
  44     <title>Description</title>
  45
  46     <para>When run as a system instance, systemd interprets the
  47     configuration file <filename>system.conf</filename> and the files
  48     in <filename>system.conf.d</filename> directories; when run as a
  49     user instance, systemd interprets the configuration file
  50     <filename>user.conf</filename> and the files in
  51     <filename>user.conf.d</filename> directories. These configuration
  52     files contain a few settings controlling basic manager
  53     operations. See
  54     <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  55     for a general description of the syntax.</para>
  56   </refsect1>
  57
  58   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  59
  60   <refsect1>
  61     <title>Options</title>
  62
  63     <para>All options are configured in the
  64     <literal>[Manager]</literal> section:</para>
  65
  66     <variablelist class='config-directives'>
  67
  68       <varlistentry>
  69         <term><varname>LogLevel=</varname></term>
  70         <term><varname>LogTarget=</varname></term>
  71         <term><varname>LogColor=</varname></term>
  72         <term><varname>LogLocation=</varname></term>
  73         <term><varname>DumpCore=yes</varname></term>
  74         <term><varname>CrashChangeVT=no</varname></term>
  75         <term><varname>CrashShell=no</varname></term>
  76         <term><varname>CrashReboot=no</varname></term>
  77         <term><varname>ShowStatus=yes</varname></term>
  78         <term><varname>DefaultStandardOutput=journal</varname></term>
  79         <term><varname>DefaultStandardError=inherit</varname></term>
  80
  81         <listitem><para>Configures various parameters of basic manager operation. These options may be overridden by
  82         the respective process and kernel command line arguments. See
  83         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
  84         details.</para></listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term><varname>CtrlAltDelBurstAction=</varname></term>
  89
  90         <listitem><para>Defines what action will be performed
  91         if user presses Ctrl-Alt-Delete more than 7 times in 2s.
  92         Can be set to <literal>reboot-force</literal>, <literal>poweroff-force</literal>,
  93         <literal>reboot-immediate</literal>, <literal>poweroff-immediate</literal>
  94         or disabled with <literal>none</literal>. Defaults to
  95         <literal>reboot-force</literal>.
  96         </para></listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><varname>CPUAffinity=</varname></term>
 101
 102         <listitem><para>Configures the CPU affinity for the service manager as well as the default CPU affinity for all
 103         forked off processes. Takes a list of CPU indices or ranges separated by either whitespace or commas. CPU
 104         ranges are specified by the lower and upper CPU indices separated by a dash. Individual services may override
 105         the CPU affinity for their processes with the <varname>CPUAffinity=</varname> setting in unit files, see
 106         <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term><varname>RuntimeWatchdogSec=</varname></term>
 111         <term><varname>ShutdownWatchdogSec=</varname></term>
 112
 113         <listitem><para>Configure the hardware watchdog at runtime and at reboot. Takes a timeout value in seconds (or
 114         in other time units if suffixed with <literal>ms</literal>, <literal>min</literal>, <literal>h</literal>,
 115         <literal>d</literal>, <literal>w</literal>). If <varname>RuntimeWatchdogSec=</varname> is set to a non-zero
 116         value, the watchdog hardware (<filename>/dev/watchdog</filename> or the path specified with
 117         <varname>WatchdogDevice=</varname> or the kernel option <varname>systemd.watchdog-device=</varname>) will be
 118         programmed to automatically reboot the system if it is not contacted within the specified timeout interval. The
 119         system manager will ensure to contact it at least once in half the specified timeout interval. This feature
 120         requires a hardware watchdog device to be present, as it is commonly the case in embedded and server
 121         systems. Not all hardware watchdogs allow configuration of all possible reboot timeout values, in which case
 122         the closest available timeout is picked. <varname>ShutdownWatchdogSec=</varname> may be used to configure the
 123         hardware watchdog when the system is asked to reboot. It works as a safety net to ensure that the reboot takes
 124         place even if a clean reboot attempt times out. Note that the <varname>ShutdownWatchdogSec=</varname> timeout
 125         applies only to the second phase of the reboot, i.e. after all regular services are already terminated, and
 126         after the system and service manager process (PID 1) got replaced by the <filename>systemd-shutdown</filename>
 127         binary, see system <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 128         for details. During the first phase of the shutdown operation the system and service manager remains running
 129         and hence <varname>RuntimeWatchdogSec=</varname> is still honoured. In order to define a timeout on this first
 130         phase of system shutdown, configure <varname>JobTimeoutSec=</varname> and <varname>JobTimeoutAction=</varname>
 131         in the <literal>[Unit]</literal> section of the <filename>shutdown.target</filename> unit. By default
 132         <varname>RuntimeWatchdogSec=</varname> defaults to 0 (off), and <varname>ShutdownWatchdogSec=</varname> to
 133         10min. These settings have no effect if a hardware watchdog is not available.</para></listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term><varname>WatchdogDevice=</varname></term>
 138
 139         <listitem><para>Configure the hardware watchdog device that the
 140         runtime and shutdown watchdog timers will open and use. Defaults
 141         to <filename>/dev/watchdog</filename>. This setting has no
 142         effect if a hardware watchdog is not available.</para></listitem>
 143       </varlistentry>
 144
 145       <varlistentry>
 146         <term><varname>CapabilityBoundingSet=</varname></term>
 147
 148         <listitem><para>Controls which capabilities to include in the
 149         capability bounding set for PID 1 and its children. See
 150         <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 151         for details. Takes a whitespace-separated list of capability
 152         names as read by
 153         <citerefentry project='mankier'><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 154         Capabilities listed will be included in the bounding set, all
 155         others are removed. If the list of capabilities is prefixed
 156         with ~, all but the listed capabilities will be included, the
 157         effect of the assignment inverted. Note that this option also
 158         affects the respective capabilities in the effective,
 159         permitted and inheritable capability sets. The capability
 160         bounding set may also be individually configured for units
 161         using the <varname>CapabilityBoundingSet=</varname> directive
 162         for units, but note that capabilities dropped for PID 1 cannot
 163         be regained in individual units, they are lost for
 164         good.</para></listitem>
 165       </varlistentry>
 166
 167       <varlistentry>
 168         <term><varname>NoNewPrivileges=</varname></term>
 169
 170         <listitem><para>Takes a boolean argument. If true, ensures that PID 1
 171         and all its children can never gain new privileges through
 172         <citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 173         (e.g. via setuid or setgid bits, or filesystem capabilities).
 174         Defaults to false. General purpose distributions commonly rely
 175         on executables with setuid or setgid bits and will thus not
 176         function properly with this option enabled. Individual units
 177         cannot disable this option.
 178         Also see <ulink url="https://www.kernel.org/doc/html/latest/userspace-api/no_new_privs.html">No New Privileges Flag</ulink>.
 179         </para></listitem>
 180       </varlistentry>
 181
 182       <varlistentry>
 183         <term><varname>SystemCallArchitectures=</varname></term>
 184
 185         <listitem><para>Takes a space-separated list of architecture
 186         identifiers. Selects from which architectures system calls may
 187         be invoked on this system. This may be used as an effective
 188         way to disable invocation of non-native binaries system-wide,
 189         for example to prohibit execution of 32-bit x86 binaries on
 190         64-bit x86-64 systems. This option operates system-wide, and
 191         acts similar to the
 192         <varname>SystemCallArchitectures=</varname> setting of unit
 193         files, see
 194         <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 195         for details. This setting defaults to the empty list, in which
 196         case no filtering of system calls based on architecture is
 197         applied. Known architecture identifiers are
 198         <literal>x86</literal>, <literal>x86-64</literal>,
 199         <literal>x32</literal>, <literal>arm</literal> and the special
 200         identifier <literal>native</literal>. The latter implicitly
 201         maps to the native architecture of the system (or more
 202         specifically, the architecture the system manager was compiled
 203         for). Set this setting to <literal>native</literal> to
 204         prohibit execution of any non-native binaries. When a binary
 205         executes a system call of an architecture that is not listed
 206         in this setting, it will be immediately terminated with the
 207         SIGSYS signal.</para></listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term><varname>TimerSlackNSec=</varname></term>
 212
 213         <listitem><para>Sets the timer slack in nanoseconds for PID 1,
 214         which is inherited by all executed processes, unless
 215         overridden individually, for example with the
 216         <varname>TimerSlackNSec=</varname> setting in service units
 217         (for details see
 218         <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
 219         The timer slack controls the accuracy of wake-ups triggered by
 220         system timers. See
 221         <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 222         for more information. Note that in contrast to most other time
 223         span definitions this parameter takes an integer value in
 224         nano-seconds if no unit is specified. The usual time units are
 225         understood too.</para></listitem>
 226       </varlistentry>
 227
 228       <varlistentry>
 229         <term><varname>DefaultTimerAccuracySec=</varname></term>
 230
 231         <listitem><para>Sets the default accuracy of timer units. This
 232         controls the global default for the
 233         <varname>AccuracySec=</varname> setting of timer units, see
 234         <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 235         for details. <varname>AccuracySec=</varname> set in individual
 236         units override the global default for the specific unit.
 237         Defaults to 1min. Note that the accuracy of timer units is
 238         also affected by the configured timer slack for PID 1, see
 239         <varname>TimerSlackNSec=</varname> above.</para></listitem>
 240       </varlistentry>
 241
 242       <varlistentry>
 243         <term><varname>DefaultTimeoutStartSec=</varname></term>
 244         <term><varname>DefaultTimeoutStopSec=</varname></term>
 245         <term><varname>DefaultRestartSec=</varname></term>
 246
 247         <listitem><para>Configures the default timeouts for starting
 248         and stopping of units, as well as the default time to sleep
 249         between automatic restarts of units, as configured per-unit in
 250         <varname>TimeoutStartSec=</varname>,
 251         <varname>TimeoutStopSec=</varname> and
 252         <varname>RestartSec=</varname> (for services, see
 253         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 254         for details on the per-unit settings). Disabled by default, when
 255         service with <varname>Type=oneshot</varname> is used.
 256         For non-service units,
 257         <varname>DefaultTimeoutStartSec=</varname> sets the default
 258         <varname>TimeoutSec=</varname>
 259         value. <varname>DefaultTimeoutStartSec=</varname> and
 260         <varname>DefaultTimeoutStopSec=</varname> default to
 261         90s. <varname>DefaultRestartSec=</varname> defaults to
 262         100ms.</para></listitem>
 263       </varlistentry>
 264
 265       <varlistentry>
 266         <term><varname>DefaultStartLimitIntervalSec=</varname></term>
 267         <term><varname>DefaultStartLimitBurst=</varname></term>
 268
 269         <listitem><para>Configure the default unit start rate
 270         limiting, as configured per-service by
 271         <varname>StartLimitIntervalSec=</varname> and
 272         <varname>StartLimitBurst=</varname>. See
 273         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 274         for details on the per-service settings.
 275         <varname>DefaultStartLimitIntervalSec=</varname> defaults to
 276         10s. <varname>DefaultStartLimitBurst=</varname> defaults to
 277         5.</para></listitem>
 278       </varlistentry>
 279
 280       <varlistentry>
 281         <term><varname>DefaultEnvironment=</varname></term>
 282
 283         <listitem><para>Sets manager environment variables passed to
 284         all executed processes. Takes a space-separated list of
 285         variable assignments. See
 286         <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 287         for details about environment variables.</para>
 288
 289         <para>Example:
 290
 291         <programlisting>DefaultEnvironment="VAR1=word1 word2" VAR2=word3 "VAR3=word 5 6"</programlisting>
 292
 293         Sets three variables
 294         <literal>VAR1</literal>,
 295         <literal>VAR2</literal>,
 296         <literal>VAR3</literal>.</para></listitem>
 297       </varlistentry>
 298
 299       <varlistentry>
 300         <term><varname>DefaultCPUAccounting=</varname></term>
 301         <term><varname>DefaultBlockIOAccounting=</varname></term>
 302         <term><varname>DefaultMemoryAccounting=</varname></term>
 303         <term><varname>DefaultTasksAccounting=</varname></term>
 304         <term><varname>DefaultIOAccounting=</varname></term>
 305         <term><varname>DefaultIPAccounting=</varname></term>
 306
 307         <listitem><para>Configure the default resource accounting settings, as configured per-unit by
 308         <varname>CPUAccounting=</varname>, <varname>BlockIOAccounting=</varname>, <varname>MemoryAccounting=</varname>,
 309         <varname>TasksAccounting=</varname>, <varname>IOAccounting=</varname> and <varname>IPAccounting=</varname>. See
 310         <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 311         for details on the per-unit settings. <varname>DefaultTasksAccounting=</varname> defaults to yes,
 312         <varname>DefaultMemoryAccounting=</varname> to &MEMORY_ACCOUNTING_DEFAULT;. <varname>DefaultCPUAccounting=</varname>
 313         defaults to yes if enabling CPU accounting doesn't require the CPU controller to be enabled (Linux 4.15+ using the
 314         unified hierarchy for resource control), otherwise it defaults to no. The other three settings default to no.</para></listitem>
 315       </varlistentry>
 316
 317       <varlistentry>
 318         <term><varname>DefaultTasksMax=</varname></term>
 319
 320         <listitem><para>Configure the default value for the per-unit <varname>TasksMax=</varname> setting. See
 321         <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 322         for details. This setting applies to all unit types that support resource control settings, with the exception
 323         of slice units. Defaults to 15%, which equals 4915 with the kernel's defaults on the host, but might be smaller
 324         in OS containers.</para></listitem>
 325       </varlistentry>
 326
 327       <varlistentry>
 328         <term><varname>DefaultLimitCPU=</varname></term>
 329         <term><varname>DefaultLimitFSIZE=</varname></term>
 330         <term><varname>DefaultLimitDATA=</varname></term>
 331         <term><varname>DefaultLimitSTACK=</varname></term>
 332         <term><varname>DefaultLimitCORE=</varname></term>
 333         <term><varname>DefaultLimitRSS=</varname></term>
 334         <term><varname>DefaultLimitNOFILE=</varname></term>
 335         <term><varname>DefaultLimitAS=</varname></term>
 336         <term><varname>DefaultLimitNPROC=</varname></term>
 337         <term><varname>DefaultLimitMEMLOCK=</varname></term>
 338         <term><varname>DefaultLimitLOCKS=</varname></term>
 339         <term><varname>DefaultLimitSIGPENDING=</varname></term>
 340         <term><varname>DefaultLimitMSGQUEUE=</varname></term>
 341         <term><varname>DefaultLimitNICE=</varname></term>
 342         <term><varname>DefaultLimitRTPRIO=</varname></term>
 343         <term><varname>DefaultLimitRTTIME=</varname></term>
 344
 345         <listitem><para>These settings control various default
 346         resource limits for units. See
 347         <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 348         for details. The resource limit is possible to specify in two formats,
 349         <option>value</option> to set soft and hard limits to the same value,
 350         or <option>soft:hard</option> to set both limits individually (e.g. DefaultLimitAS=4G:16G).
 351         Use the string <varname>infinity</varname> to
 352         configure no limit on a specific resource. The multiplicative
 353         suffixes K (=1024), M (=1024*1024) and so on for G, T, P and E
 354         may be used for resource limits measured in bytes
 355         (e.g. DefaultLimitAS=16G). For the limits referring to time values,
 356         the usual time units ms, s, min, h and so on may be used (see
 357         <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 358         for details). Note that if no time unit is specified for
 359         <varname>DefaultLimitCPU=</varname> the default unit of seconds is
 360         implied, while for <varname>DefaultLimitRTTIME=</varname> the default
 361         unit of microseconds is implied. Also, note that the effective
 362         granularity of the limits might influence their
 363         enforcement. For example, time limits specified for
 364         <varname>DefaultLimitCPU=</varname> will be rounded up implicitly to
 365         multiples of 1s. These  settings may be overridden in individual units
 366         using the corresponding LimitXXX= directives. Note that these resource
 367         limits are only defaults for units, they are not applied to PID 1
 368         itself.</para></listitem>
 369       </varlistentry>
 370     </variablelist>
 371   </refsect1>
 372
 373   <refsect1>
 374       <title>See Also</title>
 375       <para>
 376         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 377         <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 378         <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 379         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 380         <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 381         <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 382       </para>
 383   </refsect1>
 384
 385 </refentry>