README

   1 systemd System and Service Manager
   2
   3 DETAILS:
   4         http://0pointer.de/blog/projects/systemd.html
   5
   6 WEB SITE:
   7         http://www.freedesktop.org/wiki/Software/systemd
   8
   9 GIT:
  10         git@github.com:systemd/systemd.git
  11         https://github.com/systemd/systemd.git
  12
  13 GITWEB:
  14         https://github.com/systemd/systemd
  15
  16 MAILING LIST:
  17         http://lists.freedesktop.org/mailman/listinfo/systemd-devel
  18         http://lists.freedesktop.org/mailman/listinfo/systemd-commits
  19
  20 IRC:
  21         #systemd on irc.freenode.org
  22
  23 BUG REPORTS:
  24         https://github.com/systemd/systemd/issues
  25
  26 AUTHOR:
  27         Lennart Poettering
  28         Kay Sievers
  29         ...and many others
  30
  31 LICENSE:
  32         LGPLv2.1+ for all code
  33         - except src/basic/MurmurHash2.c which is Public Domain
  34         - except src/basic/siphash24.c which is CC0 Public Domain
  35         - except src/journal/lookup3.c which is Public Domain
  36         - except src/udev/* which is (currently still) GPLv2, GPLv2+
  37
  38 REQUIREMENTS:
  39         Linux kernel >= 3.11
  40         Linux kernel >= 4.2 for unified cgroup hierarchy support
  41
  42         Kernel Config Options:
  43           CONFIG_DEVTMPFS
  44           CONFIG_CGROUPS (it is OK to disable all controllers)
  45           CONFIG_INOTIFY_USER
  46           CONFIG_SIGNALFD
  47           CONFIG_TIMERFD
  48           CONFIG_EPOLL
  49           CONFIG_NET
  50           CONFIG_SYSFS
  51           CONFIG_PROC_FS
  52           CONFIG_FHANDLE (libudev, mount and bind mount handling)
  53
  54         udev will fail to work with the legacy sysfs layout:
  55           CONFIG_SYSFS_DEPRECATED=n
  56
  57         Legacy hotplug slows down the system and confuses udev:
  58           CONFIG_UEVENT_HELPER_PATH=""
  59
  60         Userspace firmware loading is not supported and should
  61         be disabled in the kernel:
  62           CONFIG_FW_LOADER_USER_HELPER=n
  63
  64         Some udev rules and virtualization detection relies on it:
  65           CONFIG_DMIID
  66
  67         Support for some SCSI devices serial number retrieval, to
  68         create additional symlinks in /dev/disk/ and /dev/tape:
  69           CONFIG_BLK_DEV_BSG
  70
  71         Required for PrivateNetwork and PrivateDevices in service units:
  72           CONFIG_NET_NS
  73           CONFIG_DEVPTS_MULTIPLE_INSTANCES
  74         Note that systemd-localed.service and other systemd units use
  75         PrivateNetwork and PrivateDevices so this is effectively required.
  76
  77         Optional but strongly recommended:
  78           CONFIG_IPV6
  79           CONFIG_AUTOFS4_FS
  80           CONFIG_TMPFS_XATTR
  81           CONFIG_{TMPFS,EXT4,XFS,BTRFS_FS,...}_POSIX_ACL
  82           CONFIG_SECCOMP
  83           CONFIG_CHECKPOINT_RESTORE (for the kcmp() syscall)
  84
  85         Required for CPUShares= in resource control unit settings
  86           CONFIG_CGROUP_SCHED
  87           CONFIG_FAIR_GROUP_SCHED
  88
  89         Required for CPUQuota= in resource control unit settings
  90           CONFIG_CFS_BANDWIDTH
  91
  92         For systemd-bootchart, several proc debug interfaces are required:
  93           CONFIG_SCHEDSTATS
  94           CONFIG_SCHED_DEBUG
  95
  96         For UEFI systems:
  97           CONFIG_EFIVAR_FS
  98           CONFIG_EFI_PARTITION
  99
 100         We recommend to turn off Real-Time group scheduling in the
 101         kernel when using systemd. RT group scheduling effectively
 102         makes RT scheduling unavailable for most userspace, since it
 103         requires explicit assignment of RT budgets to each unit whose
 104         processes making use of RT. As there's no sensible way to
 105         assign these budgets automatically this cannot really be
 106         fixed, and it's best to disable group scheduling hence.
 107            CONFIG_RT_GROUP_SCHED=n
 108
 109         Note that kernel auditing is broken when used with systemd's
 110         container code. When using systemd in conjunction with
 111         containers, please make sure to either turn off auditing at
 112         runtime using the kernel command line option "audit=0", or
 113         turn it off at kernel compile time using:
 114           CONFIG_AUDIT=n
 115         If systemd is compiled with libseccomp support on
 116         architectures which do not use socketcall() and where seccomp
 117         is supported (this effectively means x86-64 and ARM, but
 118         excludes 32-bit x86!), then nspawn will now install a
 119         work-around seccomp filter that makes containers boot even
 120         with audit being enabled. This works correctly only on kernels
 121         3.14 and newer though. TL;DR: turn audit off, still.
 122
 123         glibc >= 2.16
 124         libcap
 125         libmount >= 2.20 (from util-linux)
 126         libseccomp >= 1.0.0 (optional)
 127         libblkid >= 2.24 (from util-linux) (optional)
 128         libkmod >= 15 (optional)
 129         PAM >= 1.1.2 (optional)
 130         libcryptsetup (optional)
 131         libaudit (optional)
 132         libacl (optional)
 133         libselinux (optional)
 134         liblzma (optional)
 135         liblz4 >= 119 (optional)
 136         libgcrypt (optional)
 137         libqrencode (optional)
 138         libmicrohttpd (optional)
 139         libpython (optional)
 140         libidn (optional)
 141         elfutils >= 158 (optional)
 142         make, gcc, and similar tools
 143
 144         During runtime, you need the following additional
 145         dependencies:
 146
 147         util-linux >= v2.26 required
 148         dbus >= 1.4.0 (strictly speaking optional, but recommended)
 149         dracut (optional)
 150         PolicyKit (optional)
 151
 152         When building from git, the following tools are needed:
 153
 154         pkg-config
 155         docbook-xsl
 156         xsltproc
 157         automake
 158         autoconf
 159         libtool
 160         intltool
 161         gperf
 162         python (optional)
 163         python-lxml (optional, but required to build the indices)
 164         sphinx (optional)
 165
 166         The build system is initialized with ./autogen.sh. A tar ball
 167         can be created with:
 168           git archive --format=tar --prefix=systemd-222/ v222 | xz > systemd-222.tar.xz
 169
 170         When systemd-hostnamed is used, it is strongly recommended to
 171         install nss-myhostname to ensure that, in a world of
 172         dynamically changing hostnames, the hostname stays resolvable
 173         under all circumstances. In fact, systemd-hostnamed will warn
 174         if nss-myhostname is not installed.
 175
 176         To build HTML documentation for python-systemd using sphinx,
 177         please first install systemd (using 'make install'), and then
 178         invoke sphinx-build with 'make sphinx-<target>', with <target>
 179         being 'html' or 'latexpdf'. If using DESTDIR for installation,
 180         pass the same DESTDIR to 'make sphinx-html' invocation.
 181
 182 USERS AND GROUPS:
 183         Default udev rules use the following standard system group
 184         names, which need to be resolvable by getgrnam() at any time,
 185         even in the very early boot stages, where no other databases
 186         and network are available:
 187
 188         audio, cdrom, dialout, disk, input, kmem, lp, tape, tty, video
 189
 190         During runtime, the journal daemon requires the
 191         "systemd-journal" system group to exist. New journal files will
 192         be readable by this group (but not writable), which may be used
 193         to grant specific users read access. In addition, system
 194         groups "wheel" and "adm" will be given read-only access to
 195         journal files using systemd-tmpfiles.service.
 196
 197         The journal gateway daemon requires the
 198         "systemd-journal-gateway" system user and group to
 199         exist. During execution this network facing service will drop
 200         privileges and assume this uid/gid for security reasons.
 201
 202         Similarly, the NTP daemon requires the "systemd-timesync" system
 203         user and group to exist.
 204
 205         Similarly, the network management daemon requires the
 206         "systemd-network" system user and group to exist.
 207
 208         Similarly, the name resolution daemon requires the
 209         "systemd-resolve" system user and group to exist.
 210
 211         Similarly, the kdbus dbus1 proxy daemon requires the
 212         "systemd-bus-proxy" system user and group to exist.
 213
 214 NSS:
 215         systemd ships with three NSS modules:
 216
 217         nss-myhostname resolves the local hostname to locally
 218         configured IP addresses, as well as "localhost" to
 219         127.0.0.1/::1.
 220
 221         nss-resolve enables DNS resolution via the systemd-resolved
 222         DNS/LLMNR caching stub resolver "systemd-resolved".
 223
 224         nss-mymachines enables resolution of all local containers
 225         registered with machined to their respective IP addresses.
 226
 227         To make use of these NSS modules, please add them to the
 228         "hosts: " line in /etc/nsswitch.conf. The "resolve" module
 229         should replace the glibc "dns" module in this file.
 230
 231         The three modules should be used in the following order:
 232
 233                 hosts: files mymachines resolve myhostname
 234
 235 SYSV INIT.D SCRIPTS:
 236         When calling "systemctl enable/disable/is-enabled" on a unit which is a
 237         SysV init.d script, it calls /usr/lib/systemd/systemd-sysv-install;
 238         this needs to translate the action into the distribution specific
 239         mechanism such as chkconfig or update-rc.d. Packagers need to provide
 240         this script if you need this functionality (you don't if you disabled
 241         SysV init support).
 242
 243         Please see src/systemctl/systemd-sysv-install.SKELETON for how this
 244         needs to look like, and provide an implementation at the marked places.
 245
 246 WARNINGS:
 247         systemd will freeze execution during boot if /etc/mtab exists
 248         but is not a symlink to /proc/mounts. Please ensure that
 249         /etc/mtab is a proper symlink.
 250
 251         systemd will warn you during boot if /usr is on a different
 252         file system than /. While in systemd itself very little will
 253         break if /usr is on a separate partition, many of its
 254         dependencies very likely will break sooner or later in one
 255         form or another. For example, udev rules tend to refer to
 256         binaries in /usr, binaries that link to libraries in /usr or
 257         binaries that refer to data files in /usr. Since these
 258         breakages are not always directly visible, systemd will warn
 259         about this, since this kind of file system setup is not really
 260         supported anymore by the basic set of Linux OS components.
 261
 262         systemd requires that the /run mount point exists. systemd also
 263         requires that /var/run is a symlink to /run.
 264
 265         For more information on this issue consult
 266         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
 267
 268         To run systemd under valgrind, compile with VALGRIND defined
 269         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
 270         false positives will be triggered by code which violates
 271         some rules but is actually safe.
 272
 273         Currently, systemd-timesyncd defaults to use the Google NTP
 274         servers if not specified otherwise at configure time. You
 275         really should not ship an OS or device with this default
 276         setting. See DISTRO_PORTING for details.