]>
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: | |
19d9372b | 7 | https://www.freedesktop.org/wiki/Software/systemd |
31cee6f6 LP |
8 | |
9 | GIT: | |
eb0914fc | 10 | git@github.com:systemd/systemd.git |
eb0914fc | 11 | https://github.com/systemd/systemd |
31cee6f6 LP |
12 | |
13 | MAILING LIST: | |
19d9372b | 14 | https://lists.freedesktop.org/mailman/listinfo/systemd-devel |
31cee6f6 LP |
15 | |
16 | IRC: | |
17 | #systemd on irc.freenode.org | |
18 | ||
19 | BUG REPORTS: | |
eb0914fc | 20 | https://github.com/systemd/systemd/issues |
31cee6f6 LP |
21 | |
22 | AUTHOR: | |
5430f7f2 LP |
23 | Lennart Poettering |
24 | Kay Sievers | |
25 | ...and many others | |
31cee6f6 | 26 | |
673eab9b | 27 | LICENSE: |
5430f7f2 | 28 | LGPLv2.1+ for all code |
a095315b KS |
29 | - except src/basic/MurmurHash2.c which is Public Domain |
30 | - except src/basic/siphash24.c which is CC0 Public Domain | |
85424725 KS |
31 | - except src/journal/lookup3.c which is Public Domain |
32 | - except src/udev/* which is (currently still) GPLv2, GPLv2+ | |
673eab9b | 33 | |
31cee6f6 | 34 | REQUIREMENTS: |
dcce98a4 | 35 | Linux kernel >= 3.13 |
a0c3e16b | 36 | Linux kernel >= 4.2 for unified cgroup hierarchy support |
23aedd02 KS |
37 | |
38 | Kernel Config Options: | |
713bc0cf | 39 | CONFIG_DEVTMPFS |
d28315e4 | 40 | CONFIG_CGROUPS (it is OK to disable all controllers) |
713bc0cf KS |
41 | CONFIG_INOTIFY_USER |
42 | CONFIG_SIGNALFD | |
43 | CONFIG_TIMERFD | |
44 | CONFIG_EPOLL | |
41938693 | 45 | CONFIG_NET |
713bc0cf | 46 | CONFIG_SYSFS |
06d461ee | 47 | CONFIG_PROC_FS |
5d31974e | 48 | CONFIG_FHANDLE (libudev, mount and bind mount handling) |
713bc0cf | 49 | |
9c7f7d86 MG |
50 | Kernel crypto/hash API |
51 | CONFIG_CRYPTO_USER_API_HASH | |
52 | CONFIG_CRYPTO_HMAC | |
53 | CONFIG_CRYPTO_SHA256 | |
54 | ||
be2ea723 | 55 | udev will fail to work with the legacy sysfs layout: |
f28cbd03 | 56 | CONFIG_SYSFS_DEPRECATED=n |
713bc0cf KS |
57 | |
58 | Legacy hotplug slows down the system and confuses udev: | |
59 | CONFIG_UEVENT_HELPER_PATH="" | |
60 | ||
be2ea723 KS |
61 | Userspace firmware loading is not supported and should |
62 | be disabled in the kernel: | |
713bc0cf KS |
63 | CONFIG_FW_LOADER_USER_HELPER=n |
64 | ||
65 | Some udev rules and virtualization detection relies on it: | |
66 | CONFIG_DMIID | |
67 | ||
a5c724b2 KS |
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 | ||
45a582d5 | 72 | Required for PrivateNetwork= in service units: |
13468826 | 73 | CONFIG_NET_NS |
b52a4a3b | 74 | Note that systemd-localed.service and other systemd units use |
45a582d5 | 75 | PrivateNetwork so this is effectively required. |
13468826 | 76 | |
0ca48bb0 | 77 | Required for PrivateUsers= in service units: |
87fe1707 LW |
78 | CONFIG_USER_NS |
79 | ||
713bc0cf KS |
80 | Optional but strongly recommended: |
81 | CONFIG_IPV6 | |
82 | CONFIG_AUTOFS4_FS | |
713bc0cf | 83 | CONFIG_TMPFS_XATTR |
0ceced3d | 84 | CONFIG_{TMPFS,EXT4_FS,XFS,BTRFS_FS,...}_POSIX_ACL |
f28cbd03 | 85 | CONFIG_SECCOMP |
fd74fa79 | 86 | CONFIG_SECCOMP_FILTER (required for seccomp support) |
3b920d78 | 87 | CONFIG_CHECKPOINT_RESTORE (for the kcmp() syscall) |
713bc0cf | 88 | |
f4e74be1 | 89 | Required for CPUShares= in resource control unit settings |
a21b4670 UTL |
90 | CONFIG_CGROUP_SCHED |
91 | CONFIG_FAIR_GROUP_SCHED | |
92 | ||
f4e74be1 | 93 | Required for CPUQuota= in resource control unit settings |
0acd5a08 WC |
94 | CONFIG_CFS_BANDWIDTH |
95 | ||
b1b96380 AJ |
96 | Required for IPAddressDeny= and IPAddressAllow= in resource control |
97 | unit settings | |
98 | CONFIG_CGROUP_BPF | |
99 | ||
f28cbd03 | 100 | For UEFI systems: |
f33016ff | 101 | CONFIG_EFIVAR_FS |
f28cbd03 KS |
102 | CONFIG_EFI_PARTITION |
103 | ||
f4e74be1 LP |
104 | We recommend to turn off Real-Time group scheduling in the |
105 | kernel when using systemd. RT group scheduling effectively | |
106 | makes RT scheduling unavailable for most userspace, since it | |
107 | requires explicit assignment of RT budgets to each unit whose | |
108 | processes making use of RT. As there's no sensible way to | |
109 | assign these budgets automatically this cannot really be | |
110 | fixed, and it's best to disable group scheduling hence. | |
111 | CONFIG_RT_GROUP_SCHED=n | |
112 | ||
f5a93d5d LP |
113 | It's a good idea to disable the implicit creation of networking bonding |
114 | devices by the kernel networking bonding module, so that the | |
115 | automatically created "bond0" interface doesn't conflict with any such | |
582faeb4 DJL |
116 | device created by systemd-networkd (or other tools). Ideally there |
117 | would be a kernel compile-time option for this, but there currently | |
118 | isn't. The next best thing is to make this change through a modprobe.d | |
119 | drop-in. This is shipped by default, see modprobe.d/systemd.conf. | |
f5a93d5d | 120 | |
45a582d5 AJ |
121 | Required for systemd-nspawn: |
122 | CONFIG_DEVPTS_MULTIPLE_INSTANCES or Linux kernel >= 4.7 | |
123 | ||
77b6e194 LP |
124 | Note that kernel auditing is broken when used with systemd's |
125 | container code. When using systemd in conjunction with | |
19aadacf | 126 | containers, please make sure to either turn off auditing at |
77b6e194 LP |
127 | runtime using the kernel command line option "audit=0", or |
128 | turn it off at kernel compile time using: | |
129 | CONFIG_AUDIT=n | |
a7b1c397 LP |
130 | If systemd is compiled with libseccomp support on |
131 | architectures which do not use socketcall() and where seccomp | |
132 | is supported (this effectively means x86-64 and ARM, but | |
70a44afe | 133 | excludes 32-bit x86!), then nspawn will now install a |
a7b1c397 LP |
134 | work-around seccomp filter that makes containers boot even |
135 | with audit being enabled. This works correctly only on kernels | |
136 | 3.14 and newer though. TL;DR: turn audit off, still. | |
77b6e194 | 137 | |
3dd26f3e | 138 | glibc >= 2.16 |
3ede835a | 139 | libcap |
d6e80966 ZJS |
140 | libmount >= 2.30 (from util-linux) |
141 | (util-linux *must* be built without --enable-libmount-support-mtab) | |
6abfd303 | 142 | libseccomp >= 2.3.1 (optional) |
d47f6ca5 | 143 | libblkid >= 2.24 (from util-linux) (optional) |
a18535d9 | 144 | libkmod >= 15 (optional) |
3ede835a LP |
145 | PAM >= 1.1.2 (optional) |
146 | libcryptsetup (optional) | |
147 | libaudit (optional) | |
19d5d4cb | 148 | libacl (optional) |
3ede835a | 149 | libselinux (optional) |
19d5d4cb | 150 | liblzma (optional) |
e0a1d4b0 | 151 | liblz4 >= 1.3.0 / 130 (optional) |
7b17a7d7 LP |
152 | libgcrypt (optional) |
153 | libqrencode (optional) | |
154 | libmicrohttpd (optional) | |
2cc86f09 | 155 | libpython (optional) |
87057e24 | 156 | libidn2 or libidn (optional) |
096cbdce IT |
157 | gnutls >= 3.1.4 (optional, >= 3.5.3 is required to support DNS-over-TLS with gnutls) |
158 | openssl >= 1.1.0 (optional, required to support DNS-over-TLS with openssl) | |
5b244719 | 159 | elfutils >= 158 (optional) |
d79a2f5f | 160 | polkit (optional) |
72cdb3e7 | 161 | pkg-config |
8f968c73 | 162 | gperf |
72cdb3e7 ZJS |
163 | docbook-xsl (optional, required for documentation) |
164 | xsltproc (optional, required for documentation) | |
165 | python-lxml (optional, required to build the indices) | |
7a6397d2 | 166 | python >= 3.5, meson >= 0.46, ninja |
72cdb3e7 | 167 | gcc, awk, sed, grep, m4, and similar tools |
2cc86f09 | 168 | |
19aadacf JE |
169 | During runtime, you need the following additional |
170 | dependencies: | |
2cc86f09 | 171 | |
1d40ddbf | 172 | util-linux >= v2.27.1 required |
2b2b7228 | 173 | dbus >= 1.9.14 (strictly speaking optional, but recommended) |
ecf4f0a8 MG |
174 | NOTE: If using dbus < 1.9.18, you should override the default |
175 | policy directory (--with-dbuspolicydir=/etc/dbus-1/system.d). | |
2cc86f09 | 176 | dracut (optional) |
d35f51ea | 177 | polkit (optional) |
3ede835a | 178 | |
3e609a8a ZJS |
179 | To build in directory build/: |
180 | meson build/ && ninja -C build | |
181 | ||
182 | Any configuration options can be specfied as -Darg=value... arguments | |
183 | to meson. After the build directory is initially configured, meson will | |
184 | refuse to run again, and options must be changed with: | |
185 | mesonconf -Darg=value... | |
186 | mesonconf without any arguments will print out available options and | |
187 | their current values. | |
188 | ||
189 | Useful commands: | |
190 | ninja -v some/target | |
191 | ninja test | |
192 | sudo ninja install | |
193 | DESTDIR=... ninja install | |
194 | ||
72cdb3e7 | 195 | A tarball can be created with: |
82627069 KS |
196 | git archive --format=tar --prefix=systemd-222/ v222 | xz > systemd-222.tar.xz |
197 | ||
19aadacf JE |
198 | When systemd-hostnamed is used, it is strongly recommended to |
199 | install nss-myhostname to ensure that, in a world of | |
200 | dynamically changing hostnames, the hostname stays resolvable | |
fff2e5b5 | 201 | under all circumstances. In fact, systemd-hostnamed will warn |
bf9e477c | 202 | if nss-myhostname is not installed. |
fff2e5b5 | 203 | |
01c8938e LP |
204 | nss-systemd must be enabled on systemd systems, as that's required for |
205 | DynamicUser= to work. Note that we ship services out-of-the-box that | |
206 | make use of DynamicUser= now, hence enabling nss-systemd is not | |
207 | optional. | |
208 | ||
1815dfbb LP |
209 | Note that the build prefix for systemd must be /usr. (Moreover, |
210 | packages systemd relies on — such as D-Bus — really should use the same | |
211 | prefix, otherwise you are on your own.) -Dsplit-usr=false (which is the | |
212 | default and does not need to be specified) is the recommended setting, | |
213 | and -Dsplit-usr=true should be used on systems which have /usr on a | |
214 | separate partition. | |
01c8938e | 215 | |
a2fc3d87 ZJS |
216 | Additional packages are necessary to run some tests: |
217 | - busybox (used by test/TEST-13-NSPAWN-SMOKE) | |
218 | - nc (used by test/TEST-12-ISSUE-3171) | |
219 | - python3-pyparsing | |
220 | - python3-evdev (used by hwdb parsing tests) | |
221 | - strace (used by test/test-functions) | |
e94681ad | 222 | - capsh (optional, used by test-execute) |
a2fc3d87 | 223 | |
a24c64f0 | 224 | USERS AND GROUPS: |
37495eed LP |
225 | Default udev rules use the following standard system group |
226 | names, which need to be resolvable by getgrnam() at any time, | |
227 | even in the very early boot stages, where no other databases | |
228 | and network are available: | |
229 | ||
2422bd21 | 230 | audio, cdrom, dialout, disk, input, kmem, kvm, lp, render, tape, tty, video |
37c0e8f3 | 231 | |
19aadacf | 232 | During runtime, the journal daemon requires the |
1a9ce3f7 | 233 | "systemd-journal" system group to exist. New journal files will |
19aadacf | 234 | be readable by this group (but not writable), which may be used |
a48a62a1 ZJS |
235 | to grant specific users read access. In addition, system |
236 | groups "wheel" and "adm" will be given read-only access to | |
237 | journal files using systemd-tmpfiles.service. | |
a24c64f0 | 238 | |
f959c5c6 YW |
239 | The journal remote daemon requires the |
240 | "systemd-journal-remote" system user and group to | |
37495eed LP |
241 | exist. During execution this network facing service will drop |
242 | privileges and assume this uid/gid for security reasons. | |
243 | ||
8d0e0ddd | 244 | Similarly, the network management daemon requires the |
323a2f0b LP |
245 | "systemd-network" system user and group to exist. |
246 | ||
8d0e0ddd | 247 | Similarly, the name resolution daemon requires the |
323a2f0b LP |
248 | "systemd-resolve" system user and group to exist. |
249 | ||
888e378d LP |
250 | Similarly, the coredump support requires the |
251 | "systemd-coredump" system user and group to exist. | |
252 | ||
a4a79605 | 253 | NSS: |
409093fe | 254 | systemd ships with four glibc NSS modules: |
a4a79605 LP |
255 | |
256 | nss-myhostname resolves the local hostname to locally | |
257 | configured IP addresses, as well as "localhost" to | |
258 | 127.0.0.1/::1. | |
259 | ||
260 | nss-resolve enables DNS resolution via the systemd-resolved | |
261 | DNS/LLMNR caching stub resolver "systemd-resolved". | |
262 | ||
409093fe LP |
263 | nss-mymachines enables resolution of all local containers registered |
264 | with machined to their respective IP addresses. It also maps UID/GIDs | |
265 | ranges used by containers to useful names. | |
a4a79605 | 266 | |
409093fe LP |
267 | nss-systemd enables resolution of all dynamically allocated service |
268 | users. (See the DynamicUser= setting in unit files.) | |
a4a79605 | 269 | |
409093fe LP |
270 | To make use of these NSS modules, please add them to the "hosts:", |
271 | "passwd:" and "group:" lines in /etc/nsswitch.conf. The "resolve" | |
272 | module should replace the glibc "dns" module in this file (and don't | |
273 | worry, it chain-loads the "dns" module if it can't talk to resolved). | |
a4a79605 | 274 | |
409093fe LP |
275 | The four modules should be used in the following order: |
276 | ||
277 | passwd: compat mymachines systemd | |
278 | group: compat mymachines systemd | |
a42d4f57 | 279 | hosts: files mymachines resolve [!UNAVAIL=return] dns myhostname |
a4a79605 | 280 | |
0f0467e6 MP |
281 | SYSV INIT.D SCRIPTS: |
282 | When calling "systemctl enable/disable/is-enabled" on a unit which is a | |
283 | SysV init.d script, it calls /usr/lib/systemd/systemd-sysv-install; | |
284 | this needs to translate the action into the distribution specific | |
285 | mechanism such as chkconfig or update-rc.d. Packagers need to provide | |
286 | this script if you need this functionality (you don't if you disabled | |
287 | SysV init support). | |
288 | ||
289 | Please see src/systemctl/systemd-sysv-install.SKELETON for how this | |
290 | needs to look like, and provide an implementation at the marked places. | |
291 | ||
21bc923a | 292 | WARNINGS: |
9e93f6f0 LP |
293 | systemd will warn during early boot if /usr is not already mounted at |
294 | this point (that means: either located on the same file system as / or | |
295 | already mounted in the initrd). While in systemd itself very little | |
296 | will break if /usr is on a separate, late-mounted partition, many of | |
297 | its dependencies very likely will break sooner or later in one form or | |
298 | another. For example, udev rules tend to refer to binaries in /usr, | |
299 | binaries that link to libraries in /usr or binaries that refer to data | |
300 | files in /usr. Since these breakages are not always directly visible, | |
301 | systemd will warn about this, since this kind of file system setup is | |
302 | not really supported anymore by the basic set of Linux OS components. | |
fc7a744c | 303 | |
47bc23c1 | 304 | systemd requires that the /run mount point exists. systemd also |
8f42ccd2 | 305 | requires that /var/run is a symlink to /run. |
47bc23c1 | 306 | |
aa167132 | 307 | For more information on this issue consult |
c6749ba5 | 308 | https://www.freedesktop.org/wiki/Software/systemd/separate-usr-is-broken |
aa167132 | 309 | |
d18cb393 ZJS |
310 | To run systemd under valgrind, compile with meson option |
311 | -Dvalgrind=true and have valgrind development headers installed | |
312 | (i.e. valgrind-devel or equivalent). Otherwise, false positives will be | |
313 | triggered by code which violates some rules but is actually safe. Note | |
314 | that valgrind generates nice output only on exit(), hence on shutdown | |
315 | we don't execve() systemd-shutdown. | |
2b671e95 | 316 | |
94ac201a ZJS |
317 | STABLE BRANCHES AND BACKPORTS |
318 | ||
319 | Stable branches with backported patches are available in the | |
320 | systemd-stable repo at https://github.com/systemd/systemd-stable. | |
321 | ||
322 | Stable branches are started for certain releases of systemd and named | |
323 | after them, e.g. v238-stable. Stable branches are managed by | |
324 | distribution maintainers on an as needed basis. See | |
325 | https://www.freedesktop.org/wiki/Software/systemd/Backports/ for some | |
326 | more information and examples. | |
327 | ||
ada64a0c LP |
328 | ENGINEERING AND CONSULTING SERVICES: |
329 | Kinvolk (https://kinvolk.io) offers professional engineering | |
330 | and consulting services for systemd. Please contact Chris Kühl | |
331 | <chris@kinvolk.io> for more information. |