summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2019-09-04 21:18:11 +0200
committerLudovic Courtès <ludo@gnu.org>2019-09-04 23:41:07 +0200
commitf475c6e53e5b6912cc45663d50f1d03dadfb60b8 (patch)
tree993f86bc3e42e71bce1f5a736497388634afe354 /README
parentc26f562e5e22b07e61475cab7324e84f6fe70e57 (diff)
doc: Update 'README'.
* README: Update intro a bit. (Installing Guix as non-root): Remove as it's largely outdated. (Contact): Update.
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 8 insertions, 28 deletions
diff --git a/README b/README
index 296df415164..02d6f7190a7 100644
--- a/README
+++ b/README
@@ -10,8 +10,8 @@ It provides [[https://www.gnu.org/software/guile/][Guile]] Scheme APIs, includin
10domain-specific languages (EDSLs) to describe how packages are to be 10domain-specific languages (EDSLs) to describe how packages are to be
11built and composed. 11built and composed.
12 12
13A user-land free software distribution for GNU/Linux comes as part of 13GNU Guix can be used on top of an already-installed GNU/Linux distribution, or
14Guix. 14it can be used standalone (we call that “Guix System”).
15 15
16Guix is based on the [[https://nixos.org/nix/][Nix]] package manager. 16Guix is based on the [[https://nixos.org/nix/][Nix]] package manager.
17 17
@@ -75,37 +75,17 @@ the promise of a build; it is stored as a text file under
75`derivation' primitive, as well as higher-level wrappers such as 75`derivation' primitive, as well as higher-level wrappers such as
76`build-expression->derivation'. 76`build-expression->derivation'.
77 77
78Guix does remote procedure calls (RPCs) to the Guix or Nix daemon (the 78Guix does remote procedure calls (RPCs) to the build daemon (the =guix-daemon=
79=guix-daemon= or =nix-daemon= command), which in turn performs builds 79command), which in turn performs builds and accesses to the store on its
80and accesses to the Nix store on its behalf. The RPCs are implemented 80behalf. The RPCs are implemented in the (guix store) module.
81in the (guix store) module.
82
83* Installing Guix as non-root
84
85The Guix daemon allows software builds to be performed under alternate
86user accounts, which are normally created specifically for this
87purpose. For instance, you may have a pool of accounts in the
88=guixbuild= group, and then you can instruct =guix-daemon= to use them
89like this:
90
91 $ guix-daemon --build-users-group=guixbuild
92
93However, unless it is run as root, =guix-daemon= cannot switch users.
94In that case, it falls back to using a setuid-root helper program call
95=nix-setuid-helper=. That program is not setuid-root by default when
96you install it; instead you should run a command along these lines
97(assuming Guix is installed under /usr/local):
98
99 # chown root.root /usr/local/libexec/nix-setuid-helper
100 # chmod 4755 /usr/local/libexec/nix-setuid-helper
101 81
102* Contact 82* Contact
103 83
104GNU Guix is hosted at https://savannah.gnu.org/projects/guix/. 84GNU Guix is hosted at https://savannah.gnu.org/projects/guix/.
105 85
106Please email <bug-guix@gnu.org> for bug reports or questions regarding 86Please email <help-guix@gnu.org> for questions and <bug-guix@gnu.org> for bug
107Guix and its distribution; email <gnu-system-discuss@gnu.org> for 87reports; email <gnu-system-discuss@gnu.org> for general issues regarding the
108general issues regarding the GNU system. 88GNU system.
109 89
110Join #guix on irc.freenode.net. 90Join #guix on irc.freenode.net.
111 91