X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=README;h=b8d1f42e254676193c6aeacc1385d0d98e22bd3f;hp=a5d569028dfb8750bb620bdbecf467d49eb13d67;hb=de1c301ed165eb4d04a0c9d4babe97912b5233bb;hpb=19d5d4cb6a89c844e298eb65bce6ba0fa9d58b91 diff --git a/README b/README index a5d569028..b8d1f42e2 100644 --- a/README +++ b/README @@ -31,24 +31,80 @@ AUTHOR: LICENSE: LGPLv2.1+ for all code - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT - - except src/udev/ which is GPLv2.0+ + - except src/udev/ which is (currently still) GPLv2+ REQUIREMENTS: Linux kernel >= 2.6.39 - with devtmpfs - with cgroups (but it's OK to disable all controllers) - optional but strongly recommended: autofs4, ipv6 + CONFIG_DEVTMPFS + CONFIG_CGROUPS (it's OK to disable all controllers) + CONFIG_INOTIFY_USER + CONFIG_SIGNALFD + CONFIG_TIMERFD + CONFIG_EPOLL + CONFIG_NET + CONFIG_SYSFS + + Linux kernel >= 3.8 for Smack support + + 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 + + Mount and bind mount handling might require it: + CONFIG_FHANDLE + + Optional but strongly recommended: + CONFIG_IPV6 + CONFIG_AUTOFS4_FS + CONFIG_TMPFS_POSIX_ACL + CONFIG_TMPFS_XATTR + CONFIG_SECCOMP + + For systemd-bootchart a kernel with procfs support and several + proc output options enabled is required: + CONFIG_PROC_FS + CONFIG_SCHEDSTATS + CONFIG_SCHED_DEBUG + + For UEFI systems: + CONFIG_EFI_VARS + CONFIG_EFI_PARTITION + dbus >= 1.4.0 libcap + libblkid >= 2.20 (from util-linux) (optional) + libkmod >= 5 (optional) PAM >= 1.1.2 (optional) libcryptsetup (optional) libaudit (optional) libacl (optional) + libattr (optional) libselinux (optional) liblzma (optional) tcpwrappers (optional) + libgcrypt (optional) + libqrencode (optional) + libmicrohttpd (optional) + libpython (optional) + make, gcc, and similar tools + + During runtime you need the following additional dependencies: + + util-linux >= v2.19 (requires fsck -l, agetty -s) + sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended) + dracut (optional) + PolicyKit (optional) - When you build from git you need the following additional dependencies: + When building from git you need the following additional dependencies: docbook-xsl xsltproc @@ -59,27 +115,51 @@ REQUIREMENTS: gperf gtkdocize (optional) python (optional) - make, gcc, and similar tools - - During runtime you need the following dependencies: - - util-linux > v2.18 (requires fsck -l, agetty -s) - sulogin (from sysvinit-tools, optional but recommended) - dracut (optional) + sphinx (optional) + python-lxml (entirely optional) 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 resolveable + dynamically changing hostnames the hostname stays resolvable under all circumstances. In fact, systemd-hostnamed will warn - if nss-myhostname is not installed. Packagers are encouraged to - add a dependency on nss-myhostname to the package that - includes systemd-hostnamed. + if nss-myhostname is not installed. Note that D-Bus can link against libsystemd-login.so, which results in a cyclic build dependency. To accommodate for this please build D-Bus without systemd first, then build systemd, then rebuild D-Bus with systemd support. + To build HTML documentation for python-systemd using sphinx, + please first install systemd (using 'make install'), and then + invoke sphinx-build with 'make sphinx-', with + 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: + + tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk + + During runtime the journal daemon requires the + "systemd-journal" system group to exist. New journal files will + be readable by this group (but not writable) which may be used + 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. + WARNINGS: systemd will warn you during boot if /etc/mtab is not a symlink to /proc/mounts. Please ensure that /etc/mtab is a @@ -99,12 +179,7 @@ WARNINGS: For more information on this issue consult http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken -ENGINEERING AND CONSULTING SERVICES: - ProFUSION offers professional - engineering and consulting services for systemd for embedded - and other use. Please contact Gustavo Barbieri - for more information. - - Disclaimer: This notice is not a recommendation or official - endorsement. However, ProFUSION's upstream work has been very - beneficial for the systemd project. + 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.