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