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