chiark / gitweb /
bus: fix typo in systemd-bus-proxyd
[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                       v2.21 required for tests in test/
117         dbus >= 1.4.0 (strictly speaking optional, but recommended)
118         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
119                  required for tests in test/)
120         dracut (optional)
121         PolicyKit (optional)
122
123         When building from git, you need the following additional
124         dependencies:
125
126         docbook-xsl
127         xsltproc
128         automake
129         autoconf
130         libtool
131         intltool
132         gperf
133         gtkdocize (optional)
134         python (optional)
135         sphinx (optional)
136         python-lxml (entirely optional)
137
138         When systemd-hostnamed is used, it is strongly recommended to
139         install nss-myhostname to ensure that, in a world of
140         dynamically changing hostnames, the hostname stays resolvable
141         under all circumstances. In fact, systemd-hostnamed will warn
142         if nss-myhostname is not installed.
143
144         To build HTML documentation for python-systemd using sphinx,
145         please first install systemd (using 'make install'), and then
146         invoke sphinx-build with 'make sphinx-<target>', with <target>
147         being 'html' or 'latexpdf'. If using DESTDIR for installation,
148         pass the same DESTDIR to 'make sphinx-html' invocation.
149
150 USERS AND GROUPS:
151         Default udev rules use the following standard system group
152         names, which need to be resolvable by getgrnam() at any time,
153         even in the very early boot stages, where no other databases
154         and network are available:
155
156         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
157
158         During runtime, the journal daemon requires the
159         "systemd-journal" system group to exist. New journal files will
160         be readable by this group (but not writable), which may be used
161         to grant specific users read access.
162
163         It is also recommended to grant read access to all journal
164         files to the system groups "wheel" and "adm" with a command
165         like the following in the post installation script of the
166         package:
167
168         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
169
170         The journal gateway daemon requires the
171         "systemd-journal-gateway" system user and group to
172         exist. During execution this network facing service will drop
173         privileges and assume this uid/gid for security reasons.
174
175 WARNINGS:
176         systemd will warn you during boot if /etc/mtab is not a
177         symlink to /proc/mounts. Please ensure that /etc/mtab is a
178         proper symlink.
179
180         systemd will warn you during boot if /usr is on a different
181         file system than /. While in systemd itself very little will
182         break if /usr is on a separate partition, many of its
183         dependencies very likely will break sooner or later in one
184         form or another. For example, udev rules tend to refer to
185         binaries in /usr, binaries that link to libraries in /usr or
186         binaries that refer to data files in /usr. Since these
187         breakages are not always directly visible, systemd will warn
188         about this, since this kind of file system setup is not really
189         supported anymore by the basic set of Linux OS components.
190
191         For more information on this issue consult
192         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
193
194         To run systemd under valgrind, compile with VALGRIND defined
195         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
196         false positives will be triggered by code which violates
197         some rules but is actually safe.