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 GPLv2.0+
  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_HOTPLUG
  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
  69         For systemd-bootchart a kernel with procfs support and several
  70         proc output options enabled is required:
  71           CONFIG_PROC_FS
  72           CONFIG_SCHEDSTATS
  73           CONFIG_SCHED_DEBUG
  74
  75         dbus >= 1.4.0
  76         libcap
  77         libblkid >= 2.20 (from util-linux) (optional)
  78         libkmod >= 5 (optional)
  79         PAM >= 1.1.2 (optional)
  80         libcryptsetup (optional)
  81         libaudit (optional)
  82         libacl (optional)
  83         libattr (optional)
  84         libselinux (optional)
  85         liblzma (optional)
  86         tcpwrappers (optional)
  87         libgcrypt (optional)
  88         libqrencode (optional)
  89         libmicrohttpd (optional)
  90         libpython (optional)
  91         make, gcc, and similar tools
  92
  93         During runtime you need the following additional dependencies:
  94
  95         util-linux >= v2.19 (requires fsck -l, agetty -s)
  96         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
  97         dracut (optional)
  98         PolicyKit (optional)
  99
 100         When building from git you need the following additional dependencies:
 101
 102         docbook-xsl
 103         xsltproc
 104         automake
 105         autoconf
 106         libtool
 107         intltool
 108         gperf
 109         gtkdocize (optional)
 110         python (optional)
 111         sphinx (optional)
 112
 113         When systemd-hostnamed is used it is strongly recommended to
 114         install nss-myhostname to ensure that in a world of
 115         dynamically changing hostnames the hostname stays resolvable
 116         under all circumstances. In fact, systemd-hostnamed will warn
 117         if nss-myhostname is not installed.
 118
 119         Note that D-Bus can link against libsystemd-login.so, which
 120         results in a cyclic build dependency. To accommodate for this
 121         please build D-Bus without systemd first, then build systemd,
 122         then rebuild D-Bus with systemd support.
 123
 124         To build HTML documentation for python-systemd using sphinx,
 125         please first install systemd (using 'make install'), and then
 126         invoke sphinx-build with 'make sphinx-<target>', with <target>
 127         being 'html' or 'latexpdf'. If using DESTDIR for installation,
 128         pass the same DESTDIR to 'make sphinx-html' invocation.
 129
 130 USERS AND GROUPS:
 131         Default udev rules use the following standard system group
 132         names, which need to be resolvable by getgrnam() at any time,
 133         even in the very early boot stages, where no other databases
 134         and network are available:
 135
 136         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 137
 138         During runtime the journal daemon requires the
 139         "systemd-journal" system group to exist. New journal files will
 140         be readable by this group (but not writable) which may be used
 141         to grant specific users read access.
 142
 143         It is also recommended to grant read access to all journal
 144         files to the system groups "wheel" and "adm" with a command
 145         like the following in the post installation script of the
 146         package:
 147
 148         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
 149
 150         The journal gateway daemon requires the
 151         "systemd-journal-gateway" system user and group to
 152         exist. During execution this network facing service will drop
 153         privileges and assume this uid/gid for security reasons.
 154
 155 WARNINGS:
 156         systemd will warn you during boot if /etc/mtab is not a
 157         symlink to /proc/mounts. Please ensure that /etc/mtab is a
 158         proper symlink.
 159
 160         systemd will warn you during boot if /usr is on a different
 161         file system than /. While in systemd itself very little will
 162         break if /usr is on a separate partition many of its
 163         dependencies very likely will break sooner or later in one
 164         form or another. For example udev rules tend to refer to
 165         binaries in /usr, binaries that link to libraries in /usr or
 166         binaries that refer to data files in /usr. Since these
 167         breakages are not always directly visible systemd will warn
 168         about this, since this kind of file system setup is not really
 169         supported anymore by the basic set of Linux OS components.
 170
 171         For more information on this issue consult
 172         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
 173
 174         To run systemd under valgrind, compile with VALGRIND defined
 175         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
 176         false positives will be triggered by code which violates
 177         some rules but is actually safe.