distro: expect: Provide the right path to `stty'.
[jackhill/guix/guix.git] / README
diff --git a/README b/README
index 9fdcc0e..0943358 100644 (file)
--- a/README
+++ b/README
@@ -16,14 +16,23 @@ Guix.
 Guix is based on the [[http://nixos.org/nix/][Nix]] package manager.
 
 
-* Hacking
+* Requirements
 
 GNU Guix currently depends on the following packages:
 
   - [[http://gnu.org/software/guile/][GNU Guile 2.0.x]]
-  - [[http://nixos.org/nix/][Nix]]
   - [[http://gnupg.org/][GNU libgcrypt]]
 
+Unless `--disable-daemon' was passed, the following packages are needed:
+
+  - [[http://sqlite.org/][SQLite 3]]
+  - [[http://www.bzip.org][libbz2]]
+  - [[http://gcc.gnu.org][GCC's g++]]
+
+When `--disable-daemon' was passed, you instead need the following:
+
+  - [[http://nixos.org/nix/][Nix]]
+
 Optionally, packages from Nixpkgs may be transparently reused from Guix.
 For this to work, you need to have a checkout of the Nixpkgs repository;
 the `--with-nixpkgs' option allows you to let `configure' know where the
@@ -50,10 +59,29 @@ the promise of a build; it is stored as a text file under
 `derivation' primitive, as well as higher-level wrappers such as
 `build-expression->derivation'.
 
-Guix does remote procedure calls (RPCs) to the Nix daemon (the
-=nix-worker --daemon= command), which in turn performs builds and
-accesses to the Nix store on its behalf.  The RPCs are implemented in
-the (guix store) module.
+Guix does remote procedure calls (RPCs) to the Guix or Nix daemon (the
+=guix-daemon= or =nix-daemon= command), which in turn performs builds
+and accesses to the Nix store on its behalf.  The RPCs are implemented
+in the (guix store) module.
+
+* Installing Guix as non-root
+
+The Guix daemon allows software builds to be performed under alternate
+user accounts, which are normally created specifically for this
+purpose.  For instance, you may have a pool of accounts in the
+=guixbuild= group, and then you can instruct =guix-daemon= to use them
+like this:
+
+  $ guix-daemon --build-users-group=guixbuild
+
+However, unless it is run as root, =guix-daemon= cannot switch users.
+In that case, it falls back to using a setuid-root helper program call
+=nix-setuid-helper=.  That program is not setuid-root by default when
+you install it; instead you should run a command along these lines
+(assuming Guix is installed under /usr/local):
+
+  # chown root.root /usr/local/libexec/nix-setuid-helper
+  # chmod 4755 /usr/local/libexec/nix-setuid-helper
 
 * Contact