man/systemd-system.conf.xml

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