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