]> git.ipfire.org Git - thirdparty/systemd.git/blame - README
logind: add a debug message in case the session already exists
[thirdparty/systemd.git] / README
CommitLineData
d657c51f 1systemd System and Service Manager
31cee6f6
LP
2
3DETAILS:
4 http://0pointer.de/blog/projects/systemd.html
5
6WEB SITE:
7 http://www.freedesktop.org/wiki/Software/systemd
8
9GIT:
9fa2f410
KS
10 git://anongit.freedesktop.org/systemd/systemd
11 ssh://git.freedesktop.org/git/systemd/systemd
31cee6f6
LP
12
13GITWEB:
9fa2f410 14 http://cgit.freedesktop.org/systemd/systemd
31cee6f6
LP
15
16MAILING LIST:
17 http://lists.freedesktop.org/mailman/listinfo/systemd-devel
18 http://lists.freedesktop.org/mailman/listinfo/systemd-commits
19
20IRC:
21 #systemd on irc.freenode.org
22
23BUG REPORTS:
24 https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
25
26AUTHOR:
5430f7f2
LP
27 Lennart Poettering
28 Kay Sievers
29 ...and many others
31cee6f6 30
673eab9b 31LICENSE:
5430f7f2 32 LGPLv2.1+ for all code
952d1536 33 - except sd-readahead.[ch] which is MIT
b67f541f
LP
34 - except src/shared/MurmurHash2.c which is Public Domain
35 - except src/shared/siphash24.c which is CC0 Public Domain
85424725
KS
36 - except src/journal/lookup3.c which is Public Domain
37 - except src/udev/* which is (currently still) GPLv2, GPLv2+
673eab9b 38
31cee6f6 39REQUIREMENTS:
e946948e 40 Linux kernel >= 3.0
713bc0cf
KS
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
41938693 47 CONFIG_NET
713bc0cf 48 CONFIG_SYSFS
06d461ee 49 CONFIG_PROC_FS
5d31974e 50 CONFIG_FHANDLE (libudev, mount and bind mount handling)
713bc0cf 51
ffbd2c4d
NC
52 Linux kernel >= 3.8 for Smack support
53
713bc0cf 54 Udev will fail to work with the legacy 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
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
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
713bc0cf
KS
71 Optional but strongly recommended:
72 CONFIG_IPV6
73 CONFIG_AUTOFS4_FS
74 CONFIG_TMPFS_POSIX_ACL
75 CONFIG_TMPFS_XATTR
f28cbd03 76 CONFIG_SECCOMP
713bc0cf 77
06d461ee 78 For systemd-bootchart, several proc debug interfaces are required:
713bc0cf
KS
79 CONFIG_SCHEDSTATS
80 CONFIG_SCHED_DEBUG
81
f28cbd03
KS
82 For UEFI systems:
83 CONFIG_EFI_VARS
84 CONFIG_EFI_PARTITION
85
77b6e194
LP
86 Note that kernel auditing is broken when used with systemd's
87 container code. When using systemd in conjunction with
19aadacf 88 containers, please make sure to either turn off auditing at
77b6e194
LP
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
ff70c61b 93 glibc >= 2.14
3ede835a 94 libcap
c0467cf3 95 libseccomp >= 1.0.0 (optional)
e3043162 96 libblkid >= 2.20 (from util-linux) (optional)
a18535d9 97 libkmod >= 15 (optional)
3ede835a
LP
98 PAM >= 1.1.2 (optional)
99 libcryptsetup (optional)
100 libaudit (optional)
19d5d4cb 101 libacl (optional)
fb0951b0 102 libattr (optional)
3ede835a 103 libselinux (optional)
19d5d4cb 104 liblzma (optional)
3ede835a 105 tcpwrappers (optional)
7b17a7d7
LP
106 libgcrypt (optional)
107 libqrencode (optional)
108 libmicrohttpd (optional)
2cc86f09
ZJS
109 libpython (optional)
110 make, gcc, and similar tools
111
39c4ead2
ZJS
112 To sucessfully use --compat-libs, gcc >= 4.8 seems necessary.
113
19aadacf
JE
114 During runtime, you need the following additional
115 dependencies:
2cc86f09 116
8be12848
ZJS
117 util-linux >= v2.19 (requires fsck -l, agetty -s),
118 v2.21 required for tests in test/
df41776d 119 dbus >= 1.4.0 (strictly speaking optional, but recommended)
8be12848
ZJS
120 sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
121 required for tests in test/)
2cc86f09 122 dracut (optional)
46ba8aae 123 PolicyKit (optional)
3ede835a 124
19aadacf
JE
125 When building from git, you need the following additional
126 dependencies:
3ede835a 127
3ede835a
LP
128 docbook-xsl
129 xsltproc
130 automake
131 autoconf
132 libtool
19d5d4cb 133 intltool
b62cfcea 134 gperf
19d5d4cb
ZJS
135 gtkdocize (optional)
136 python (optional)
32dcef3a 137 python-lxml (optional, but required to build the indices)
9015fa64 138 sphinx (optional)
21bc923a 139
19aadacf
JE
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
fff2e5b5 143 under all circumstances. In fact, systemd-hostnamed will warn
bf9e477c 144 if nss-myhostname is not installed.
fff2e5b5 145
9015fa64
ZJS
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
a24c64f0 152USERS AND GROUPS:
37495eed
LP
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
37c0e8f3 159
19aadacf 160 During runtime, the journal daemon requires the
1a9ce3f7 161 "systemd-journal" system group to exist. New journal files will
19aadacf 162 be readable by this group (but not writable), which may be used
a24c64f0
LP
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
37495eed 172 The journal gateway daemon requires the
1a9ce3f7 173 "systemd-journal-gateway" system user and group to
37495eed
LP
174 exist. During execution this network facing service will drop
175 privileges and assume this uid/gid for security reasons.
176
21bc923a
LP
177WARNINGS:
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
19aadacf 184 break if /usr is on a separate partition, many of its
21bc923a 185 dependencies very likely will break sooner or later in one
19aadacf 186 form or another. For example, udev rules tend to refer to
21bc923a
LP
187 binaries in /usr, binaries that link to libraries in /usr or
188 binaries that refer to data files in /usr. Since these
19aadacf 189 breakages are not always directly visible, systemd will warn
21bc923a
LP
190 about this, since this kind of file system setup is not really
191 supported anymore by the basic set of Linux OS components.
fc7a744c 192
47bc23c1
LP
193 systemd requires that the /run mount point exists. systemd also
194 requires that /var/run is a a symlink → /run.
195
aa167132
LP
196 For more information on this issue consult
197 http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
198
1b4bb4fd
ZJS
199 To run systemd under valgrind, compile with VALGRIND defined
200 (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
201 false positives will be triggered by code which violates
202 some rules but is actually safe.