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