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://anongit.freedesktop.org/systemd/systemd
  11         ssh://git.freedesktop.org/git/systemd/systemd
  12
  13 GITWEB:
  14         http://cgit.freedesktop.org/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://bugs.freedesktop.org/enter_bug.cgi?product=systemd
  25
  26 AUTHOR:
  27         Lennart Poettering
  28         Kay Sievers
  29         ...and many others
  30
  31 LICENSE:
  32         LGPLv2.1+ for all code
  33         - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
  34         - except src/udev/ which is (currently still) GPLv2+
  35
  36 REQUIREMENTS:
  37         Linux kernel >= 2.6.39
  38           CONFIG_DEVTMPFS
  39           CONFIG_CGROUPS (it's OK to disable all controllers)
  40           CONFIG_INOTIFY_USER
  41           CONFIG_SIGNALFD
  42           CONFIG_TIMERFD
  43           CONFIG_EPOLL
  44           CONFIG_NET
  45           CONFIG_SYSFS
  46
  47         Udev will fail to work with the legacy layout:
  48           CONFIG_SYSFS_DEPRECATED=n
  49
  50         Legacy hotplug slows down the system and confuses udev:
  51           CONFIG_UEVENT_HELPER_PATH=""
  52
  53         Userspace firmware loading is deprecated, will go away, and
  54         sometimes causes problems:
  55           CONFIG_FW_LOADER_USER_HELPER=n
  56
  57         Some udev rules and virtualization detection relies on it:
  58           CONFIG_DMIID
  59
  60         Mount and bind mount handling might require it:
  61           CONFIG_FHANDLE
  62
  63         Optional but strongly recommended:
  64           CONFIG_IPV6
  65           CONFIG_AUTOFS4_FS
  66           CONFIG_TMPFS_POSIX_ACL
  67           CONFIG_TMPFS_XATTR
  68           CONFIG_SECCOMP
  69
  70         For systemd-bootchart a kernel with procfs support and several
  71         proc output options enabled is required:
  72           CONFIG_PROC_FS
  73           CONFIG_SCHEDSTATS
  74           CONFIG_SCHED_DEBUG
  75
  76         For UEFI systems:
  77           CONFIG_EFI_VARS
  78           CONFIG_EFI_PARTITION
  79
  80         dbus >= 1.4.0
  81         libcap
  82         libblkid >= 2.20 (from util-linux) (optional)
  83         libkmod >= 5 (optional)
  84         PAM >= 1.1.2 (optional)
  85         libcryptsetup (optional)
  86         libaudit (optional)
  87         libacl (optional)
  88         libattr (optional)
  89         libselinux (optional)
  90         liblzma (optional)
  91         tcpwrappers (optional)
  92         libgcrypt (optional)
  93         libqrencode (optional)
  94         libmicrohttpd (optional)
  95         libpython (optional)
  96         make, gcc, and similar tools
  97
  98         During runtime you need the following additional dependencies:
  99
 100         util-linux >= v2.19 (requires fsck -l, agetty -s)
 101         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
 102         dracut (optional)
 103         PolicyKit (optional)
 104
 105         When building from git you need the following additional dependencies:
 106
 107         docbook-xsl
 108         xsltproc
 109         automake
 110         autoconf
 111         libtool
 112         intltool
 113         gperf
 114         gtkdocize (optional)
 115         python (optional)
 116         sphinx (optional)
 117
 118         When systemd-hostnamed is used it is strongly recommended to
 119         install nss-myhostname to ensure that in a world of
 120         dynamically changing hostnames the hostname stays resolvable
 121         under all circumstances. In fact, systemd-hostnamed will warn
 122         if nss-myhostname is not installed.
 123
 124         Note that D-Bus can link against libsystemd-login.so, which
 125         results in a cyclic build dependency. To accommodate for this
 126         please build D-Bus without systemd first, then build systemd,
 127         then rebuild D-Bus with systemd support.
 128
 129         To build HTML documentation for python-systemd using sphinx,
 130         please first install systemd (using 'make install'), and then
 131         invoke sphinx-build with 'make sphinx-<target>', with <target>
 132         being 'html' or 'latexpdf'. If using DESTDIR for installation,
 133         pass the same DESTDIR to 'make sphinx-html' invocation.
 134
 135 USERS AND GROUPS:
 136         Default udev rules use the following standard system group
 137         names, which need to be resolvable by getgrnam() at any time,
 138         even in the very early boot stages, where no other databases
 139         and network are available:
 140
 141         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 142
 143         During runtime the journal daemon requires the
 144         "systemd-journal" system group to exist. New journal files will
 145         be readable by this group (but not writable) which may be used
 146         to grant specific users read access.
 147
 148         It is also recommended to grant read access to all journal
 149         files to the system groups "wheel" and "adm" with a command
 150         like the following in the post installation script of the
 151         package:
 152
 153         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
 154
 155         The journal gateway daemon requires the
 156         "systemd-journal-gateway" system user and group to
 157         exist. During execution this network facing service will drop
 158         privileges and assume this uid/gid for security reasons.
 159
 160 WARNINGS:
 161         systemd will warn you during boot if /etc/mtab is not a
 162         symlink to /proc/mounts. Please ensure that /etc/mtab is a
 163         proper symlink.
 164
 165         systemd will warn you during boot if /usr is on a different
 166         file system than /. While in systemd itself very little will
 167         break if /usr is on a separate partition many of its
 168         dependencies very likely will break sooner or later in one
 169         form or another. For example udev rules tend to refer to
 170         binaries in /usr, binaries that link to libraries in /usr or
 171         binaries that refer to data files in /usr. Since these
 172         breakages are not always directly visible systemd will warn
 173         about this, since this kind of file system setup is not really
 174         supported anymore by the basic set of Linux OS components.
 175
 176         For more information on this issue consult
 177         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
 178
 179         To run systemd under valgrind, compile with VALGRIND defined
 180         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
 181         false positives will be triggered by code which violates
 182         some rules but is actually safe.