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