chiark / gitweb /
README: add udev goups
[elogind.git] / README
diff --git a/README b/README
index bcb4371cc285a9dd21ff437470c52347d97761ea..889c687bacdbe1f6f88cb90ad28663faa2c7f119 100644 (file)
--- a/README
+++ b/README
@@ -40,8 +40,8 @@ REQUIREMENTS:
                 optional but strongly recommended: autofs4, ipv6
         dbus >= 1.4.0
         libcap
-        libblkid >= 2.20 (from util-linux)
-        libkmod >= 5
+        libblkid >= 2.20 (from util-linux) (optional)
+        libkmod >= 5 (optional)
         PAM >= 1.1.2 (optional)
         libcryptsetup (optional)
         libaudit (optional)
@@ -53,8 +53,24 @@ REQUIREMENTS:
         libgcrypt (optional)
         libqrencode (optional)
         libmicrohttpd (optional)
+        libpython (optional)
+        make, gcc, and similar tools
+
+        During runtime you need the following additional dependencies:
+
+        util-linux >= v2.19 (requires fsck -l, agetty -s)
+        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
+        dracut (optional)
+        PolicyKit (optional)
+
+        For systmed-bootchart a kernel with procfs support and several
+        proc output options enabled is required:
 
-        When you build from git you need the following additional dependencies:
+        CONFIG_PROC_FS
+        CONFIG_SCHEDSTATS
+        CONFIG_SCHED_DEBUG
+
+        When building from git you need the following additional dependencies:
 
         docbook-xsl
         xsltproc
@@ -65,27 +81,44 @@ REQUIREMENTS:
         gperf
         gtkdocize (optional)
         python (optional)
-        make, gcc, and similar tools
-
-        During runtime you need the following dependencies:
-
-        util-linux > v2.18 (requires fsck -l, agetty -s)
-        sulogin (from sysvinit-tools, optional but recommended)
-        dracut (optional)
+        sphinx (optional)
 
         When systemd-hostnamed is used it is strongly recommended to
         install nss-myhostname to ensure that in a world of
         dynamically changing hostnames the hostname stays resolvable
         under all circumstances. In fact, systemd-hostnamed will warn
-        if nss-myhostname is not installed. Packagers are encouraged to
-        add a dependency on nss-myhostname to the package that
-        includes systemd-hostnamed.
+        if nss-myhostname is not installed.
 
         Note that D-Bus can link against libsystemd-login.so, which
         results in a cyclic build dependency. To accommodate for this
         please build D-Bus without systemd first, then build systemd,
         then rebuild D-Bus with systemd support.
 
+        To build HTML documentation for python-systemd using sphinx,
+        please first install systemd (using 'make install'), and then
+        invoke sphinx-build with 'make sphinx-<target>', with <target>
+        being 'html' or 'latexpdf'. If using DESTDIR for installation,
+        pass the same DESTDIR to 'make sphinx-html' invocation.
+
+USERS AND GROUPS:
+        Default udev rules use the following standard system group names,\
+        which need to be resolvable by getgrnam() at any time, even in the
+        very early boot stages, where no other databases and network is
+        available:
+          tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
+
+        During runtime the journal daemon requires the
+        "system-journal" system group to exist. New journal files will
+        be readable by this group (but not writable) which may be used
+        to grant specific users read access.
+
+        It is also recommended to grant read access to all journal
+        files to the system groups "wheel" and "adm" with a command
+        like the following in the post installation script of the
+        package:
+
+        # setfacl -nm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/
+
 WARNINGS:
         systemd will warn you during boot if /etc/mtab is not a
         symlink to /proc/mounts. Please ensure that /etc/mtab is a
@@ -109,13 +142,3 @@ WARNINGS:
         (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
         false positives will be triggered by code which violates
         some rules but is actually safe.
-
-ENGINEERING AND CONSULTING SERVICES:
-        ProFUSION <http://profusion.mobi> offers professional
-        engineering and consulting services for systemd for embedded
-        and other use. Please contact Gustavo Barbieri
-        <barbieri@profusion.mobi> for more information.
-
-        Disclaimer: This notice is not a recommendation or official
-        endorsement. However, ProFUSION's upstream work has been very
-        beneficial for the systemd project.