journald: introduce new "systemd-journal" group and make it own the journal files

[elogind.git] / README

diff --git a/README b/README
index 3b248048cc557a7268032d43cec983883c505cc6..300a4cf8bc177770511e3c5170382eb6dd51f9e6 100644 (file)
--- a/README
+++ b/README
@@ -61,6 +61,14 @@ REQUIREMENTS:
         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:
+
+        CONFIG_PROC_FS
+        CONFIG_SCHEDSTATS
+        CONFIG_SCHED_DEBUG
 
         When building from git you need the following additional dependencies:
 
@@ -73,6 +81,7 @@ REQUIREMENTS:
         gperf
         gtkdocize (optional)
         python (optional)
+        sphinx (optional)
 
         When systemd-hostnamed is used it is strongly recommended to
         install nss-myhostname to ensure that in a world of
@@ -85,6 +94,25 @@ REQUIREMENTS:
         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:
+        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
@@ -108,13 +136,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.