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