]>
Commit | Line | Data |
---|---|---|
d657c51f | 1 | systemd System and Service Manager |
31cee6f6 LP |
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: | |
9fa2f410 KS |
10 | git://anongit.freedesktop.org/systemd/systemd |
11 | ssh://git.freedesktop.org/git/systemd/systemd | |
31cee6f6 LP |
12 | |
13 | GITWEB: | |
9fa2f410 | 14 | http://cgit.freedesktop.org/systemd/systemd |
31cee6f6 LP |
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: | |
5430f7f2 LP |
27 | Lennart Poettering |
28 | Kay Sievers | |
29 | ...and many others | |
31cee6f6 | 30 | |
673eab9b | 31 | LICENSE: |
5430f7f2 | 32 | LGPLv2.1+ for all code |
b67f541f LP |
33 | - except src/shared/MurmurHash2.c which is Public Domain |
34 | - except src/shared/siphash24.c which is CC0 Public Domain | |
85424725 KS |
35 | - except src/journal/lookup3.c which is Public Domain |
36 | - except src/udev/* which is (currently still) GPLv2, GPLv2+ | |
673eab9b | 37 | |
31cee6f6 | 38 | REQUIREMENTS: |
be2ea723 | 39 | Linux kernel >= 3.7 |
23aedd02 KS |
40 | Linux kernel >= 3.8 for Smack support |
41 | ||
42 | Kernel Config Options: | |
713bc0cf | 43 | CONFIG_DEVTMPFS |
d28315e4 | 44 | CONFIG_CGROUPS (it is OK to disable all controllers) |
713bc0cf KS |
45 | CONFIG_INOTIFY_USER |
46 | CONFIG_SIGNALFD | |
47 | CONFIG_TIMERFD | |
48 | CONFIG_EPOLL | |
41938693 | 49 | CONFIG_NET |
713bc0cf | 50 | CONFIG_SYSFS |
06d461ee | 51 | CONFIG_PROC_FS |
5d31974e | 52 | CONFIG_FHANDLE (libudev, mount and bind mount handling) |
713bc0cf | 53 | |
be2ea723 | 54 | udev will fail to work with the legacy sysfs layout: |
f28cbd03 | 55 | CONFIG_SYSFS_DEPRECATED=n |
713bc0cf KS |
56 | |
57 | Legacy hotplug slows down the system and confuses udev: | |
58 | CONFIG_UEVENT_HELPER_PATH="" | |
59 | ||
be2ea723 KS |
60 | Userspace firmware loading is not supported and should |
61 | be disabled in the kernel: | |
713bc0cf KS |
62 | CONFIG_FW_LOADER_USER_HELPER=n |
63 | ||
64 | Some udev rules and virtualization detection relies on it: | |
65 | CONFIG_DMIID | |
66 | ||
a5c724b2 KS |
67 | Support for some SCSI devices serial number retrieval, to |
68 | create additional symlinks in /dev/disk/ and /dev/tape: | |
69 | CONFIG_BLK_DEV_BSG | |
70 | ||
b52a4a3b | 71 | Required for PrivateNetwork and PrivateDevices in service units: |
13468826 | 72 | CONFIG_NET_NS |
b52a4a3b ZJS |
73 | CONFIG_DEVPTS_MULTIPLE_INSTANCES |
74 | Note that systemd-localed.service and other systemd units use | |
75 | PrivateNetwork and PrivateDevices so this is effectively required. | |
13468826 | 76 | |
713bc0cf KS |
77 | Optional but strongly recommended: |
78 | CONFIG_IPV6 | |
79 | CONFIG_AUTOFS4_FS | |
80 | CONFIG_TMPFS_POSIX_ACL | |
81 | CONFIG_TMPFS_XATTR | |
f28cbd03 | 82 | CONFIG_SECCOMP |
713bc0cf | 83 | |
a21b4670 UTL |
84 | Required for CPUShares in resource control unit settings |
85 | CONFIG_CGROUP_SCHED | |
86 | CONFIG_FAIR_GROUP_SCHED | |
87 | ||
0acd5a08 WC |
88 | Required for CPUQuota in resource control unit settings |
89 | CONFIG_CFS_BANDWIDTH | |
90 | ||
06d461ee | 91 | For systemd-bootchart, several proc debug interfaces are required: |
713bc0cf KS |
92 | CONFIG_SCHEDSTATS |
93 | CONFIG_SCHED_DEBUG | |
94 | ||
f28cbd03 | 95 | For UEFI systems: |
f33016ff | 96 | CONFIG_EFIVAR_FS |
f28cbd03 KS |
97 | CONFIG_EFI_PARTITION |
98 | ||
77b6e194 LP |
99 | Note that kernel auditing is broken when used with systemd's |
100 | container code. When using systemd in conjunction with | |
19aadacf | 101 | containers, please make sure to either turn off auditing at |
77b6e194 LP |
102 | runtime using the kernel command line option "audit=0", or |
103 | turn it off at kernel compile time using: | |
104 | CONFIG_AUDIT=n | |
a7b1c397 LP |
105 | If systemd is compiled with libseccomp support on |
106 | architectures which do not use socketcall() and where seccomp | |
107 | is supported (this effectively means x86-64 and ARM, but | |
70a44afe | 108 | excludes 32-bit x86!), then nspawn will now install a |
a7b1c397 LP |
109 | work-around seccomp filter that makes containers boot even |
110 | with audit being enabled. This works correctly only on kernels | |
111 | 3.14 and newer though. TL;DR: turn audit off, still. | |
77b6e194 | 112 | |
ff70c61b | 113 | glibc >= 2.14 |
3ede835a | 114 | libcap |
8d3ae2bd | 115 | libmount >= 2.20 (from util-linux) |
c0467cf3 | 116 | libseccomp >= 1.0.0 (optional) |
d47f6ca5 | 117 | libblkid >= 2.24 (from util-linux) (optional) |
a18535d9 | 118 | libkmod >= 15 (optional) |
3ede835a LP |
119 | PAM >= 1.1.2 (optional) |
120 | libcryptsetup (optional) | |
121 | libaudit (optional) | |
19d5d4cb | 122 | libacl (optional) |
3ede835a | 123 | libselinux (optional) |
19d5d4cb | 124 | liblzma (optional) |
a509e0e6 | 125 | liblz4 >= 119 (optional) |
7b17a7d7 LP |
126 | libgcrypt (optional) |
127 | libqrencode (optional) | |
128 | libmicrohttpd (optional) | |
2cc86f09 | 129 | libpython (optional) |
f9ffbca2 | 130 | libidn (optional) |
a900b827 | 131 | gobject-introspection > 1.40.0 (optional) |
5b244719 | 132 | elfutils >= 158 (optional) |
2cc86f09 ZJS |
133 | make, gcc, and similar tools |
134 | ||
19aadacf JE |
135 | During runtime, you need the following additional |
136 | dependencies: | |
2cc86f09 | 137 | |
fdbbad98 | 138 | util-linux >= v2.25 required |
df41776d | 139 | dbus >= 1.4.0 (strictly speaking optional, but recommended) |
2cc86f09 | 140 | dracut (optional) |
46ba8aae | 141 | PolicyKit (optional) |
3ede835a | 142 | |
19aadacf JE |
143 | When building from git, you need the following additional |
144 | dependencies: | |
3ede835a | 145 | |
3ede835a LP |
146 | docbook-xsl |
147 | xsltproc | |
148 | automake | |
149 | autoconf | |
150 | libtool | |
19d5d4cb | 151 | intltool |
b62cfcea | 152 | gperf |
19d5d4cb ZJS |
153 | gtkdocize (optional) |
154 | python (optional) | |
32dcef3a | 155 | python-lxml (optional, but required to build the indices) |
9015fa64 | 156 | sphinx (optional) |
21bc923a | 157 | |
19aadacf JE |
158 | When systemd-hostnamed is used, it is strongly recommended to |
159 | install nss-myhostname to ensure that, in a world of | |
160 | dynamically changing hostnames, the hostname stays resolvable | |
fff2e5b5 | 161 | under all circumstances. In fact, systemd-hostnamed will warn |
bf9e477c | 162 | if nss-myhostname is not installed. |
fff2e5b5 | 163 | |
9015fa64 ZJS |
164 | To build HTML documentation for python-systemd using sphinx, |
165 | please first install systemd (using 'make install'), and then | |
166 | invoke sphinx-build with 'make sphinx-<target>', with <target> | |
167 | being 'html' or 'latexpdf'. If using DESTDIR for installation, | |
168 | pass the same DESTDIR to 'make sphinx-html' invocation. | |
169 | ||
a24c64f0 | 170 | USERS AND GROUPS: |
37495eed LP |
171 | Default udev rules use the following standard system group |
172 | names, which need to be resolvable by getgrnam() at any time, | |
173 | even in the very early boot stages, where no other databases | |
174 | and network are available: | |
175 | ||
3dff3e00 | 176 | audio, cdrom, dialout, disk, input, kmem, lp, tape, tty, video |
37c0e8f3 | 177 | |
19aadacf | 178 | During runtime, the journal daemon requires the |
1a9ce3f7 | 179 | "systemd-journal" system group to exist. New journal files will |
19aadacf | 180 | be readable by this group (but not writable), which may be used |
a48a62a1 ZJS |
181 | to grant specific users read access. In addition, system |
182 | groups "wheel" and "adm" will be given read-only access to | |
183 | journal files using systemd-tmpfiles.service. | |
a24c64f0 | 184 | |
37495eed | 185 | The journal gateway daemon requires the |
1a9ce3f7 | 186 | "systemd-journal-gateway" system user and group to |
37495eed LP |
187 | exist. During execution this network facing service will drop |
188 | privileges and assume this uid/gid for security reasons. | |
189 | ||
8d0e0ddd | 190 | Similarly, the NTP daemon requires the "systemd-timesync" system |
323a2f0b LP |
191 | user and group to exist. |
192 | ||
8d0e0ddd | 193 | Similarly, the network management daemon requires the |
323a2f0b LP |
194 | "systemd-network" system user and group to exist. |
195 | ||
8d0e0ddd | 196 | Similarly, the name resolution daemon requires the |
323a2f0b LP |
197 | "systemd-resolve" system user and group to exist. |
198 | ||
8d0e0ddd | 199 | Similarly, the kdbus dbus1 proxy daemon requires the |
323a2f0b | 200 | "systemd-bus-proxy" system user and group to exist. |
682265d5 | 201 | |
a4a79605 LP |
202 | NSS: |
203 | systemd ships with three NSS modules: | |
204 | ||
205 | nss-myhostname resolves the local hostname to locally | |
206 | configured IP addresses, as well as "localhost" to | |
207 | 127.0.0.1/::1. | |
208 | ||
209 | nss-resolve enables DNS resolution via the systemd-resolved | |
210 | DNS/LLMNR caching stub resolver "systemd-resolved". | |
211 | ||
212 | nss-mymachines enables resolution of all local containers | |
213 | registered with machined to their respective IP addresses. | |
214 | ||
215 | To make use of these NSS modules, please add them to the | |
216 | "hosts: " line in /etc/nsswitch.conf. The "resolve" module | |
217 | should replace the glibc "dns" module in this file. | |
218 | ||
219 | The three modules should be used in the following order: | |
220 | ||
221 | hosts: files mymachines resolve myhostname | |
222 | ||
21bc923a LP |
223 | WARNINGS: |
224 | systemd will warn you during boot if /etc/mtab is not a | |
225 | symlink to /proc/mounts. Please ensure that /etc/mtab is a | |
226 | proper symlink. | |
227 | ||
228 | systemd will warn you during boot if /usr is on a different | |
229 | file system than /. While in systemd itself very little will | |
19aadacf | 230 | break if /usr is on a separate partition, many of its |
21bc923a | 231 | dependencies very likely will break sooner or later in one |
19aadacf | 232 | form or another. For example, udev rules tend to refer to |
21bc923a LP |
233 | binaries in /usr, binaries that link to libraries in /usr or |
234 | binaries that refer to data files in /usr. Since these | |
19aadacf | 235 | breakages are not always directly visible, systemd will warn |
21bc923a LP |
236 | about this, since this kind of file system setup is not really |
237 | supported anymore by the basic set of Linux OS components. | |
fc7a744c | 238 | |
47bc23c1 | 239 | systemd requires that the /run mount point exists. systemd also |
b8bde116 | 240 | requires that /var/run is a a symlink to /run. |
47bc23c1 | 241 | |
aa167132 LP |
242 | For more information on this issue consult |
243 | http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken | |
244 | ||
1b4bb4fd ZJS |
245 | To run systemd under valgrind, compile with VALGRIND defined |
246 | (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise, | |
247 | false positives will be triggered by code which violates | |
248 | some rules but is actually safe. | |
2b671e95 LP |
249 | |
250 | ENGINEERING AND CONSULTING SERVICES: | |
251 | ENDOCODE <https://endocode.com/> offers professional | |
252 | engineering and consulting services for systemd. Please | |
253 | contact Chris Kühl <chris@endocode.com> for more information. |