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