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