Commit | Line | Data |
---|---|---|
4255d4e3 LC |
1 | -*- mode: org -*- |
2 | ||
e8d8ecde MB |
3 | [[https://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and |
4 | associated free software distribution, for the [[https://www.gnu.org/gnu/gnu.html][GNU system]]. In addition | |
c80e7e55 LC |
5 | to standard package management features, Guix supports transactional |
6 | upgrades and roll-backs, unprivileged package management, per-user | |
7 | profiles, and garbage collection. | |
b7a7f598 | 8 | |
e8d8ecde | 9 | It provides [[https://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded |
a65e3306 LC |
10 | domain-specific languages (EDSLs) to describe how packages are to be |
11 | built and composed. | |
b7a7f598 | 12 | |
a65e3306 LC |
13 | A user-land free software distribution for GNU/Linux comes as part of |
14 | Guix. | |
15 | ||
e8d8ecde | 16 | Guix is based on the [[https://nixos.org/nix/][Nix]] package manager. |
4255d4e3 LC |
17 | |
18 | ||
e9f6d6dd | 19 | * Requirements |
4255d4e3 | 20 | |
a65e3306 | 21 | GNU Guix currently depends on the following packages: |
4255d4e3 | 22 | |
1d84d7bf | 23 | - [[https://gnu.org/software/guile/][GNU Guile 2.2.x or 2.0.x]], version 2.0.13 or later |
ca719424 | 24 | - [[https://notabug.org/cwebber/guile-gcrypt][Guile-Gcrypt]] 0.1.0 or later |
e8d8ecde | 25 | - [[https://www.gnu.org/software/make/][GNU Make]] |
c5a2e1ff | 26 | - [[https://www.gnutls.org][GnuTLS]] compiled with guile support enabled |
60e1c109 | 27 | - [[https://notabug.org/guile-sqlite3/guile-sqlite3][Guile-SQLite3]], version 0.1.0 or later |
397cd9cc | 28 | - [[https://gitlab.com/guile-git/guile-git][Guile-Git]] |
06e3a518 | 29 | - [[http://www.zlib.net/][zlib]] |
6776af04 | 30 | - [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]] |
4255d4e3 | 31 | |
e9f6d6dd LC |
32 | Unless `--disable-daemon' was passed, the following packages are needed: |
33 | ||
ca719424 | 34 | - [[https://gnupg.org/][GNU libgcrypt]] |
e8d8ecde | 35 | - [[https://sqlite.org/][SQLite 3]] |
e8d8ecde | 36 | - [[https://gcc.gnu.org][GCC's g++]] |
06e3a518 | 37 | - optionally [[http://www.bzip.org][libbz2]] |
e9f6d6dd LC |
38 | |
39 | When `--disable-daemon' was passed, you instead need the following: | |
40 | ||
e8d8ecde | 41 | - [[https://nixos.org/nix/][Nix]] |
e9f6d6dd | 42 | |
8b2d9e5d | 43 | * Installation |
4255d4e3 | 44 | |
8b2d9e5d | 45 | See the manual for the installation instructions, either by running |
4255d4e3 | 46 | |
8efc35a8 | 47 | info -f doc/guix.info "Installation" |
7da7ae93 | 48 | |
e8d8ecde | 49 | or by checking the [[https://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]]. |
7da7ae93 | 50 | |
8c01b9d0 ML |
51 | For information on installation from a Git checkout, please see the section |
52 | "Building from Git" in the manual. | |
7da7ae93 | 53 | |
43d8f490 LC |
54 | * Installing Guix from Guix |
55 | ||
56 | You can re-build and re-install Guix using a system that already runs Guix. | |
57 | To do so: | |
58 | ||
230fda86 | 59 | - Start a shell with the development environment for Guix: |
8db351e3 | 60 | |
230fda86 | 61 | guix environment guix |
d4c74860 | 62 | |
fa747b27 | 63 | - Re-run the 'configure' script passing it the option |
fa747b27 LC |
64 | '--localstatedir=/somewhere', where '/somewhere' is the 'localstatedir' |
65 | value of the currently installed Guix (failing to do that would lead the | |
66 | new Guix to consider the store to be empty!). | |
d4c74860 | 67 | |
fa747b27 | 68 | - Run "make", "make check", and "make install". |
43d8f490 | 69 | |
4255d4e3 LC |
70 | * How It Works |
71 | ||
72 | Guix does the high-level preparation of a /derivation/. A derivation is | |
73 | the promise of a build; it is stored as a text file under | |
d17ef356 | 74 | =/gnu/store/xxx.drv=. The (guix derivations) module provides the |
4255d4e3 LC |
75 | `derivation' primitive, as well as higher-level wrappers such as |
76 | `build-expression->derivation'. | |
77 | ||
e1b7096a LC |
78 | Guix does remote procedure calls (RPCs) to the Guix or Nix daemon (the |
79 | =guix-daemon= or =nix-daemon= command), which in turn performs builds | |
80 | and accesses to the Nix store on its behalf. The RPCs are implemented | |
81 | in the (guix store) module. | |
82 | ||
83 | * Installing Guix as non-root | |
84 | ||
85 | The Guix daemon allows software builds to be performed under alternate | |
86 | user accounts, which are normally created specifically for this | |
87 | purpose. For instance, you may have a pool of accounts in the | |
88 | =guixbuild= group, and then you can instruct =guix-daemon= to use them | |
89 | like this: | |
90 | ||
91 | $ guix-daemon --build-users-group=guixbuild | |
92 | ||
93 | However, unless it is run as root, =guix-daemon= cannot switch users. | |
94 | In 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 | |
96 | you 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 | |
4255d4e3 LC |
101 | |
102 | * Contact | |
103 | ||
a65e3306 LC |
104 | GNU Guix is hosted at https://savannah.gnu.org/projects/guix/. |
105 | ||
106 | Please email <bug-guix@gnu.org> for bug reports or questions regarding | |
107 | Guix and its distribution; email <gnu-system-discuss@gnu.org> for | |
108 | general issues regarding the GNU system. | |
109 | ||
110 | Join #guix on irc.freenode.net. | |
111 | ||
112 | * Guix & Nix | |
113 | ||
e8d8ecde | 114 | GNU Guix is based on [[https://nixos.org/nix/][the Nix package manager]]. It implements the same |
a65e3306 LC |
115 | package deployment paradigm, and in fact it reuses some of its code. |
116 | Yet, different engineering decisions were made for Guix, as described | |
117 | below. | |
118 | ||
119 | Nix is really two things: a package build tool, implemented by a library | |
120 | and daemon, and a special-purpose programming language. GNU Guix relies | |
121 | on the former, but uses Scheme as a replacement for the latter. | |
122 | ||
123 | Using Scheme instead of a specific language allows us to get all the | |
124 | features and tooling that come with Guile (compiler, debugger, REPL, | |
125 | Unicode, libraries, etc.) And it means that we have a general-purpose | |
126 | language, on top of which we can have embedded domain-specific languages | |
127 | (EDSLs), such as the one used to define packages. This broadens what | |
128 | can be done in package recipes themselves, and what can be done around them. | |
129 | ||
130 | Technically, Guix makes remote procedure calls to the ‘nix-worker’ | |
131 | daemon to perform operations on the store. At the lowest level, Nix | |
132 | “derivations” represent promises of a build, stored in ‘.drv’ files in | |
133 | the store. Guix produces such derivations, which are then interpreted | |
134 | by the daemon to perform the build. Thus, Guix derivations can use | |
135 | derivations produced by Nix (and vice versa). | |
136 | ||
e8d8ecde | 137 | With Nix and the [[https://nixos.org/nixpkgs][Nixpkgs]] distribution, package composition happens at |
a65e3306 LC |
138 | the Nix language level, but builders are usually written in Bash. |
139 | Conversely, Guix encourages the use of Scheme for both package | |
140 | composition and builders. Likewise, the core functionality of Nix is | |
141 | written in C++ and Perl; Guix relies on some of the original C++ code, | |
142 | but exposes all the API as Scheme. | |
d38487e9 LC |
143 | |
144 | * Related software | |
145 | ||
e8d8ecde | 146 | - [[https://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated |
d38487e9 | 147 | software distribution, are the inspiration of Guix |
e8d8ecde | 148 | - [[https://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a |
d38487e9 | 149 | symlink tree to create user environments |
e8d8ecde | 150 | - [[https://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea |
d38487e9 LC |
151 | - [[https://live.gnome.org/OSTree/][GNOME's OSTree]] allows bootable system images to be built from a |
152 | specified set of packages | |
e8d8ecde | 153 | - The [[https://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software |
d38487e9 LC |
154 | distribution; unlike Guix, it relies on core tools available on the |
155 | host system |