chiark / gitweb /
Get rid of write_safe
[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/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 (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         libblkid >= 2.20 (from util-linux) (optional)
96         libkmod >= 15 (optional)
97         PAM >= 1.1.2 (optional)
98         libcryptsetup (optional)
99         libaudit (optional)
100         libacl (optional)
101         libattr (optional)
102         libselinux (optional)
103         liblzma (optional)
104         tcpwrappers (optional)
105         libgcrypt (optional)
106         libqrencode (optional)
107         libmicrohttpd (optional)
108         libpython (optional)
109         make, gcc, and similar tools
110
111         To sucessfully use --compat-libs, gcc >= 4.8 seems necessary.
112
113         During runtime, you need the following additional
114         dependencies:
115
116         util-linux >= v2.19 (requires fsck -l, agetty -s),
117                       v2.21 required for tests in test/
118         dbus >= 1.4.0 (strictly speaking optional, but recommended)
119         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended,
120                  required for tests in test/)
121         dracut (optional)
122         PolicyKit (optional)
123
124         When building from git, you need the following additional
125         dependencies:
126
127         docbook-xsl
128         xsltproc
129         automake
130         autoconf
131         libtool
132         intltool
133         gperf
134         gtkdocize (optional)
135         python (optional)
136         sphinx (optional)
137         python-lxml (entirely optional)
138
139         When systemd-hostnamed is used, it is strongly recommended to
140         install nss-myhostname to ensure that, in a world of
141         dynamically changing hostnames, the hostname stays resolvable
142         under all circumstances. In fact, systemd-hostnamed will warn
143         if nss-myhostname is not installed.
144
145         To build HTML documentation for python-systemd using sphinx,
146         please first install systemd (using 'make install'), and then
147         invoke sphinx-build with 'make sphinx-<target>', with <target>
148         being 'html' or 'latexpdf'. If using DESTDIR for installation,
149         pass the same DESTDIR to 'make sphinx-html' invocation.
150
151 USERS AND GROUPS:
152         Default udev rules use the following standard system group
153         names, which need to be resolvable by getgrnam() at any time,
154         even in the very early boot stages, where no other databases
155         and network are available:
156
157         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
158
159         During runtime, the journal daemon requires the
160         "systemd-journal" system group to exist. New journal files will
161         be readable by this group (but not writable), which may be used
162         to grant specific users read access.
163
164         It is also recommended to grant read access to all journal
165         files to the system groups "wheel" and "adm" with a command
166         like the following in the post installation script of the
167         package:
168
169         # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
170
171         The journal gateway daemon requires the
172         "systemd-journal-gateway" system user and group to
173         exist. During execution this network facing service will drop
174         privileges and assume this uid/gid for security reasons.
175
176 WARNINGS:
177         systemd will warn you during boot if /etc/mtab is not a
178         symlink to /proc/mounts. Please ensure that /etc/mtab is a
179         proper symlink.
180
181         systemd will warn you during boot if /usr is on a different
182         file system than /. While in systemd itself very little will
183         break if /usr is on a separate partition, many of its
184         dependencies very likely will break sooner or later in one
185         form or another. For example, udev rules tend to refer to
186         binaries in /usr, binaries that link to libraries in /usr or
187         binaries that refer to data files in /usr. Since these
188         breakages are not always directly visible, systemd will warn
189         about this, since this kind of file system setup is not really
190         supported anymore by the basic set of Linux OS components.
191
192         For more information on this issue consult
193         http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
194
195         To run systemd under valgrind, compile with VALGRIND defined
196         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
197         false positives will be triggered by code which violates
198         some rules but is actually safe.