]>
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: | |
eb0914fc JB |
10 | git@github.com:systemd/systemd.git |
11 | https://github.com/systemd/systemd.git | |
31cee6f6 LP |
12 | |
13 | GITWEB: | |
eb0914fc | 14 | https://github.com/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: | |
eb0914fc | 24 | https://github.com/systemd/systemd/issues |
31cee6f6 LP |
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 |
a095315b KS |
33 | - except src/basic/MurmurHash2.c which is Public Domain |
34 | - except src/basic/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 | |
713bc0cf | 80 | CONFIG_TMPFS_XATTR |
a6cccd8f | 81 | CONFIG_{TMPFS,EXT4,XFS,BTRFS_FS,...}_POSIX_ACL |
f28cbd03 | 82 | CONFIG_SECCOMP |
3b920d78 | 83 | CONFIG_CHECKPOINT_RESTORE (for the kcmp() syscall) |
713bc0cf | 84 | |
a21b4670 UTL |
85 | Required for CPUShares in resource control unit settings |
86 | CONFIG_CGROUP_SCHED | |
87 | CONFIG_FAIR_GROUP_SCHED | |
88 | ||
0acd5a08 WC |
89 | Required for CPUQuota in resource control unit settings |
90 | CONFIG_CFS_BANDWIDTH | |
91 | ||
06d461ee | 92 | For systemd-bootchart, several proc debug interfaces are required: |
713bc0cf KS |
93 | CONFIG_SCHEDSTATS |
94 | CONFIG_SCHED_DEBUG | |
95 | ||
f28cbd03 | 96 | For UEFI systems: |
f33016ff | 97 | CONFIG_EFIVAR_FS |
f28cbd03 KS |
98 | CONFIG_EFI_PARTITION |
99 | ||
77b6e194 LP |
100 | Note that kernel auditing is broken when used with systemd's |
101 | container code. When using systemd in conjunction with | |
19aadacf | 102 | containers, please make sure to either turn off auditing at |
77b6e194 LP |
103 | runtime using the kernel command line option "audit=0", or |
104 | turn it off at kernel compile time using: | |
105 | CONFIG_AUDIT=n | |
a7b1c397 LP |
106 | If systemd is compiled with libseccomp support on |
107 | architectures which do not use socketcall() and where seccomp | |
108 | is supported (this effectively means x86-64 and ARM, but | |
70a44afe | 109 | excludes 32-bit x86!), then nspawn will now install a |
a7b1c397 LP |
110 | work-around seccomp filter that makes containers boot even |
111 | with audit being enabled. This works correctly only on kernels | |
112 | 3.14 and newer though. TL;DR: turn audit off, still. | |
77b6e194 | 113 | |
3dd26f3e | 114 | glibc >= 2.16 |
3ede835a | 115 | libcap |
8d3ae2bd | 116 | libmount >= 2.20 (from util-linux) |
c0467cf3 | 117 | libseccomp >= 1.0.0 (optional) |
d47f6ca5 | 118 | libblkid >= 2.24 (from util-linux) (optional) |
a18535d9 | 119 | libkmod >= 15 (optional) |
3ede835a LP |
120 | PAM >= 1.1.2 (optional) |
121 | libcryptsetup (optional) | |
122 | libaudit (optional) | |
19d5d4cb | 123 | libacl (optional) |
3ede835a | 124 | libselinux (optional) |
19d5d4cb | 125 | liblzma (optional) |
a509e0e6 | 126 | liblz4 >= 119 (optional) |
7b17a7d7 LP |
127 | libgcrypt (optional) |
128 | libqrencode (optional) | |
129 | libmicrohttpd (optional) | |
2cc86f09 | 130 | libpython (optional) |
f9ffbca2 | 131 | libidn (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 | |
bf1d7ba7 | 138 | util-linux >= v2.26 required |
df41776d | 139 | dbus >= 1.4.0 (strictly speaking optional, but recommended) |
2cc86f09 | 140 | dracut (optional) |
46ba8aae | 141 | PolicyKit (optional) |
3ede835a | 142 | |
82627069 | 143 | When building from git, the following tools are needed: |
3ede835a | 144 | |
f4e5354a | 145 | pkg-config |
3ede835a LP |
146 | docbook-xsl |
147 | xsltproc | |
148 | automake | |
149 | autoconf | |
150 | libtool | |
19d5d4cb | 151 | intltool |
b62cfcea | 152 | gperf |
19d5d4cb | 153 | python (optional) |
32dcef3a | 154 | python-lxml (optional, but required to build the indices) |
9015fa64 | 155 | sphinx (optional) |
21bc923a | 156 | |
82627069 KS |
157 | The build system is initialized with ./autogen.sh. A tar ball |
158 | can be created with: | |
159 | git archive --format=tar --prefix=systemd-222/ v222 | xz > systemd-222.tar.xz | |
160 | ||
19aadacf JE |
161 | When systemd-hostnamed is used, it is strongly recommended to |
162 | install nss-myhostname to ensure that, in a world of | |
163 | dynamically changing hostnames, the hostname stays resolvable | |
fff2e5b5 | 164 | under all circumstances. In fact, systemd-hostnamed will warn |
bf9e477c | 165 | if nss-myhostname is not installed. |
fff2e5b5 | 166 | |
9015fa64 ZJS |
167 | To build HTML documentation for python-systemd using sphinx, |
168 | please first install systemd (using 'make install'), and then | |
169 | invoke sphinx-build with 'make sphinx-<target>', with <target> | |
170 | being 'html' or 'latexpdf'. If using DESTDIR for installation, | |
171 | pass the same DESTDIR to 'make sphinx-html' invocation. | |
172 | ||
a24c64f0 | 173 | USERS AND GROUPS: |
37495eed LP |
174 | Default udev rules use the following standard system group |
175 | names, which need to be resolvable by getgrnam() at any time, | |
176 | even in the very early boot stages, where no other databases | |
177 | and network are available: | |
178 | ||
3dff3e00 | 179 | audio, cdrom, dialout, disk, input, kmem, lp, tape, tty, video |
37c0e8f3 | 180 | |
19aadacf | 181 | During runtime, the journal daemon requires the |
1a9ce3f7 | 182 | "systemd-journal" system group to exist. New journal files will |
19aadacf | 183 | be readable by this group (but not writable), which may be used |
a48a62a1 ZJS |
184 | to grant specific users read access. In addition, system |
185 | groups "wheel" and "adm" will be given read-only access to | |
186 | journal files using systemd-tmpfiles.service. | |
a24c64f0 | 187 | |
37495eed | 188 | The journal gateway daemon requires the |
1a9ce3f7 | 189 | "systemd-journal-gateway" system user and group to |
37495eed LP |
190 | exist. During execution this network facing service will drop |
191 | privileges and assume this uid/gid for security reasons. | |
192 | ||
8d0e0ddd | 193 | Similarly, the NTP daemon requires the "systemd-timesync" system |
323a2f0b LP |
194 | user and group to exist. |
195 | ||
8d0e0ddd | 196 | Similarly, the network management daemon requires the |
323a2f0b LP |
197 | "systemd-network" system user and group to exist. |
198 | ||
8d0e0ddd | 199 | Similarly, the name resolution daemon requires the |
323a2f0b LP |
200 | "systemd-resolve" system user and group to exist. |
201 | ||
8d0e0ddd | 202 | Similarly, the kdbus dbus1 proxy daemon requires the |
323a2f0b | 203 | "systemd-bus-proxy" system user and group to exist. |
682265d5 | 204 | |
a4a79605 LP |
205 | NSS: |
206 | systemd ships with three NSS modules: | |
207 | ||
208 | nss-myhostname resolves the local hostname to locally | |
209 | configured IP addresses, as well as "localhost" to | |
210 | 127.0.0.1/::1. | |
211 | ||
212 | nss-resolve enables DNS resolution via the systemd-resolved | |
213 | DNS/LLMNR caching stub resolver "systemd-resolved". | |
214 | ||
215 | nss-mymachines enables resolution of all local containers | |
216 | registered with machined to their respective IP addresses. | |
217 | ||
218 | To make use of these NSS modules, please add them to the | |
219 | "hosts: " line in /etc/nsswitch.conf. The "resolve" module | |
220 | should replace the glibc "dns" module in this file. | |
221 | ||
222 | The three modules should be used in the following order: | |
223 | ||
224 | hosts: files mymachines resolve myhostname | |
225 | ||
0f0467e6 MP |
226 | SYSV INIT.D SCRIPTS: |
227 | When calling "systemctl enable/disable/is-enabled" on a unit which is a | |
228 | SysV init.d script, it calls /usr/lib/systemd/systemd-sysv-install; | |
229 | this needs to translate the action into the distribution specific | |
230 | mechanism such as chkconfig or update-rc.d. Packagers need to provide | |
231 | this script if you need this functionality (you don't if you disabled | |
232 | SysV init support). | |
233 | ||
234 | Please see src/systemctl/systemd-sysv-install.SKELETON for how this | |
235 | needs to look like, and provide an implementation at the marked places. | |
236 | ||
21bc923a LP |
237 | WARNINGS: |
238 | systemd will warn you during boot if /etc/mtab is not a | |
239 | symlink to /proc/mounts. Please ensure that /etc/mtab is a | |
240 | proper symlink. | |
241 | ||
242 | systemd will warn you during boot if /usr is on a different | |
243 | file system than /. While in systemd itself very little will | |
19aadacf | 244 | break if /usr is on a separate partition, many of its |
21bc923a | 245 | dependencies very likely will break sooner or later in one |
19aadacf | 246 | form or another. For example, udev rules tend to refer to |
21bc923a LP |
247 | binaries in /usr, binaries that link to libraries in /usr or |
248 | binaries that refer to data files in /usr. Since these | |
19aadacf | 249 | breakages are not always directly visible, systemd will warn |
21bc923a LP |
250 | about this, since this kind of file system setup is not really |
251 | supported anymore by the basic set of Linux OS components. | |
fc7a744c | 252 | |
47bc23c1 | 253 | systemd requires that the /run mount point exists. systemd also |
8f42ccd2 | 254 | requires that /var/run is a symlink to /run. |
47bc23c1 | 255 | |
aa167132 LP |
256 | For more information on this issue consult |
257 | http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken | |
258 | ||
1b4bb4fd ZJS |
259 | To run systemd under valgrind, compile with VALGRIND defined |
260 | (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise, | |
261 | false positives will be triggered by code which violates | |
262 | some rules but is actually safe. | |
2b671e95 LP |
263 | |
264 | ENGINEERING AND CONSULTING SERVICES: | |
265 | ENDOCODE <https://endocode.com/> offers professional | |
266 | engineering and consulting services for systemd. Please | |
267 | contact Chris Kühl <chris@endocode.com> for more information. |