README 8.37 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
systemd System and Service Manager

DETAILS:
        http://0pointer.de/blog/projects/systemd.html

WEB SITE:
        http://www.freedesktop.org/wiki/Software/systemd

GIT:
        git://anongit.freedesktop.org/systemd/systemd
        ssh://git.freedesktop.org/git/systemd/systemd

GITWEB:
        http://cgit.freedesktop.org/systemd/systemd

MAILING LIST:
        http://lists.freedesktop.org/mailman/listinfo/systemd-devel
        http://lists.freedesktop.org/mailman/listinfo/systemd-commits

IRC:
        #systemd on irc.freenode.org

BUG REPORTS:
        https://bugs.freedesktop.org/enter_bug.cgi?product=systemd

AUTHOR:
        Lennart Poettering
        Kay Sievers
        ...and many others

LICENSE:
        LGPLv2.1+ for all code
33 34 35
        - except sd-readahead.[ch] which is MIT
        - except src/shared/MurmurHash2.c which is Public Domain
        - except src/shared/siphash24.c which is CC0 Public Domain
Michael Biebl's avatar
Michael Biebl committed
36 37
        - except src/journal/lookup3.c which is Public Domain
        - except src/udev/* which is (currently still) GPLv2, GPLv2+
38 39

REQUIREMENTS:
Michael Biebl's avatar
Michael Biebl committed
40
        Linux kernel >= 3.0
41 42 43 44
        Linux kernel >= 3.3 for loop device partition support features with nspawn
        Linux kernel >= 3.8 for Smack support

        Kernel Config Options:
45
          CONFIG_DEVTMPFS
46
          CONFIG_CGROUPS (it is OK to disable all controllers)
47 48 49 50 51 52
          CONFIG_INOTIFY_USER
          CONFIG_SIGNALFD
          CONFIG_TIMERFD
          CONFIG_EPOLL
          CONFIG_NET
          CONFIG_SYSFS
53 54
          CONFIG_PROC_FS
          CONFIG_FHANDLE (libudev, mount and bind mount handling)
55 56 57 58 59 60 61 62 63 64 65 66 67 68

        Udev will fail to work with the legacy layout:
          CONFIG_SYSFS_DEPRECATED=n

        Legacy hotplug slows down the system and confuses udev:
          CONFIG_UEVENT_HELPER_PATH=""

        Userspace firmware loading is deprecated, will go away, and
        sometimes causes problems:
          CONFIG_FW_LOADER_USER_HELPER=n

        Some udev rules and virtualization detection relies on it:
          CONFIG_DMIID

Michael Biebl's avatar
Michael Biebl committed
69 70 71 72
        Support for some SCSI devices serial number retrieval, to
        create additional symlinks in /dev/disk/ and /dev/tape:
          CONFIG_BLK_DEV_BSG

73 74 75
        Required for PrivateNetwork in service units:
          CONFIG_NET_NS

76 77 78 79 80 81 82
        Optional but strongly recommended:
          CONFIG_IPV6
          CONFIG_AUTOFS4_FS
          CONFIG_TMPFS_POSIX_ACL
          CONFIG_TMPFS_XATTR
          CONFIG_SECCOMP

83 84 85 86 87
        Required for CPUShares in resource control unit settings
          CONFIG_CGROUP_SCHED
          CONFIG_FAIR_GROUP_SCHED

        For systemd-bootchart, several proc debug interfaces are required:
88 89 90 91
          CONFIG_SCHEDSTATS
          CONFIG_SCHED_DEBUG

        For UEFI systems:
92
          CONFIG_EFIVAR_FS
93 94
          CONFIG_EFI_PARTITION

Michael Biebl's avatar
Michael Biebl committed
95 96
        Note that kernel auditing is broken when used with systemd's
        container code. When using systemd in conjunction with
97
        containers, please make sure to either turn off auditing at
Michael Biebl's avatar
Michael Biebl committed
98 99 100
        runtime using the kernel command line option "audit=0", or
        turn it off at kernel compile time using:
          CONFIG_AUDIT=n
101 102 103 104 105 106 107 108 109
        If systemd is compiled with libseccomp support on
        architectures which do not use socketcall() and where seccomp
        is supported (this effectively means x86-64 and ARM, but
        excludes 32-bit x86!), then nspawn will now install a
        work-around seccomp filter that makes containers boot even
        with audit being enabled. This works correctly only on kernels
        3.14 and newer though. TL;DR: turn audit off, still.

        glibc >= 2.14
110
        libcap
111
        libseccomp >= 1.0.0 (optional)
112
        libblkid >= 2.20 (from util-linux) (optional)
113
        libkmod >= 15 (optional)
114 115 116 117 118 119 120 121 122 123
        PAM >= 1.1.2 (optional)
        libcryptsetup (optional)
        libaudit (optional)
        libacl (optional)
        libselinux (optional)
        liblzma (optional)
        libgcrypt (optional)
        libqrencode (optional)
        libmicrohttpd (optional)
        libpython (optional)
Michael Biebl's avatar
Michael Biebl committed
124 125
        gobject-introspection > 1.40.0 (optional)
        elfutils >= 158 (optional)
126 127
        make, gcc, and similar tools

128 129
        During runtime, you need the following additional
        dependencies:
130

131 132 133 134 135
        util-linux >= v2.19 (requires fsck -l, agetty -s),
                      v2.21 required for tests in test/
        dbus >= 1.4.0 (strictly speaking optional, but recommended)
        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
                 required for tests in test/)
136 137 138
        dracut (optional)
        PolicyKit (optional)

139 140
        When building from git, you need the following additional
        dependencies:
141 142 143 144 145 146 147 148 149 150

        docbook-xsl
        xsltproc
        automake
        autoconf
        libtool
        intltool
        gperf
        gtkdocize (optional)
        python (optional)
151
        python-lxml (optional, but required to build the indices)
152 153
        sphinx (optional)

154 155 156
        When systemd-hostnamed is used, it is strongly recommended to
        install nss-myhostname to ensure that, in a world of
        dynamically changing hostnames, the hostname stays resolvable
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
        under all circumstances. In fact, systemd-hostnamed will warn
        if nss-myhostname is not installed.

        To build HTML documentation for python-systemd using sphinx,
        please first install systemd (using 'make install'), and then
        invoke sphinx-build with 'make sphinx-<target>', with <target>
        being 'html' or 'latexpdf'. If using DESTDIR for installation,
        pass the same DESTDIR to 'make sphinx-html' invocation.

USERS AND GROUPS:
        Default udev rules use the following standard system group
        names, which need to be resolvable by getgrnam() at any time,
        even in the very early boot stages, where no other databases
        and network are available:

Michael Biebl's avatar
Michael Biebl committed
172
        audio, cdrom, dialout, disk, input, kmem, lp, tape, tty, video
173

174
        During runtime, the journal daemon requires the
175
        "systemd-journal" system group to exist. New journal files will
176
        be readable by this group (but not writable), which may be used
177 178 179 180 181 182 183 184 185 186 187 188 189 190
        to grant specific users read access.

        It is also recommended to grant read access to all journal
        files to the system groups "wheel" and "adm" with a command
        like the following in the post installation script of the
        package:

        # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/

        The journal gateway daemon requires the
        "systemd-journal-gateway" system user and group to
        exist. During execution this network facing service will drop
        privileges and assume this uid/gid for security reasons.

Michael Biebl's avatar
Michael Biebl committed
191
        Similarly, the NTP daemon requires the "systemd-timesync" system
192 193
        user and group to exist.

Michael Biebl's avatar
Michael Biebl committed
194
        Similarly, the network management daemon requires the
195 196
        "systemd-network" system user and group to exist.

Michael Biebl's avatar
Michael Biebl committed
197
        Similarly, the name resolution daemon requires the
198 199
        "systemd-resolve" system user and group to exist.

Michael Biebl's avatar
Michael Biebl committed
200
        Similarly, the kdbus dbus1 proxy daemon requires the
201 202
        "systemd-bus-proxy" system user and group to exist.

203 204 205 206 207 208 209
WARNINGS:
        systemd will warn you during boot if /etc/mtab is not a
        symlink to /proc/mounts. Please ensure that /etc/mtab is a
        proper symlink.

        systemd will warn you during boot if /usr is on a different
        file system than /. While in systemd itself very little will
210
        break if /usr is on a separate partition, many of its
211
        dependencies very likely will break sooner or later in one
212
        form or another. For example, udev rules tend to refer to
213 214
        binaries in /usr, binaries that link to libraries in /usr or
        binaries that refer to data files in /usr. Since these
215
        breakages are not always directly visible, systemd will warn
216 217 218
        about this, since this kind of file system setup is not really
        supported anymore by the basic set of Linux OS components.

219 220 221
        systemd requires that the /run mount point exists. systemd also
        requires that /var/run is a a symlink to /run.

222 223 224 225 226 227 228
        For more information on this issue consult
        http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken

        To run systemd under valgrind, compile with VALGRIND defined
        (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
        false positives will be triggered by code which violates
        some rules but is actually safe.