Commit | Line | Data |
---|---|---|
568717fd LC |
1 | \input texinfo |
2 | @c -*-texinfo-*- | |
3 | ||
4 | @c %**start of header | |
5 | @setfilename guix.info | |
6 | @documentencoding UTF-8 | |
f8348b91 | 7 | @settitle GNU Guix Reference Manual |
568717fd LC |
8 | @c %**end of header |
9 | ||
10 | @include version.texi | |
7df7a74e | 11 | |
debc6360 | 12 | @c Identifier of the OpenPGP key used to sign tarballs and such. |
df671177 | 13 | @set OPENPGP-SIGNING-KEY-ID 3CE464558A84FDC69DB40CFB090B11993D9AEBB5 |
debc6360 | 14 | |
7df7a74e | 15 | @copying |
8de938d5 | 16 | Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017 Ludovic Courtès@* |
f97c9175 | 17 | Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* |
87eafdbd | 18 | Copyright @copyright{} 2013 Nikita Karetnikov@* |
1a3e6b15 | 19 | Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* |
1b846da8 | 20 | Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* |
8c01b9d0 | 21 | Copyright @copyright{} 2014 Pierre-Antoine Rault@* |
97d76250 | 22 | Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* |
8a9cffb2 | 23 | Copyright @copyright{} 2015, 2016, 2017 Leo Famulari@* |
afbc9419 | 24 | Copyright @copyright{} 2015, 2016, 2017 Ricardo Wurmus@* |
4d343a14 | 25 | Copyright @copyright{} 2016 Ben Woodcroft@* |
76192896 | 26 | Copyright @copyright{} 2016 Chris Marusich@* |
3b88f376 | 27 | Copyright @copyright{} 2016, 2017 Efraim Flashner@* |
d6a07ee6 | 28 | Copyright @copyright{} 2016 John Darrington@* |
92c03a87 | 29 | Copyright @copyright{} 2016 ng0@* |
9bb98bcf | 30 | Copyright @copyright{} 2016, 2017 Jan Nieuwenhuizen@* |
9747d189 | 31 | Copyright @copyright{} 2016 Julien Lepiller@* |
78cef99b | 32 | Copyright @copyright{} 2016 Alex ter Weele@* |
11b7717d | 33 | Copyright @copyright{} 2017 Clément Lassieur@* |
bc5844d1 | 34 | Copyright @copyright{} 2017 Mathieu Othacehe@* |
82ccc499 | 35 | Copyright @copyright{} 2017 Federico Beffa@* |
9260b9d1 | 36 | Copyright @copyright{} 2017 Carlo Zancanaro@* |
fc06b15e | 37 | Copyright @copyright{} 2017 Thomas Danckaert@* |
d7fa39cc | 38 | Copyright @copyright{} 2017 humanitiesNerd@* |
c80cd4df | 39 | Copyright @copyright{} 2017 Christopher Allan Webber@* |
5abfa08d | 40 | Copyright @copyright{} 2017 Marius Bakke@* |
4695472f | 41 | Copyright @copyright{} 2017 Hartmut Goebel@* |
352a5b63 TGR |
42 | Copyright @copyright{} 2017 Maxim Cournoyer@* |
43 | Copyright @copyright{} 2017 Tobias Geerinckx-Rice | |
7df7a74e NK |
44 | |
45 | Permission is granted to copy, distribute and/or modify this document | |
46 | under the terms of the GNU Free Documentation License, Version 1.3 or | |
47 | any later version published by the Free Software Foundation; with no | |
48 | Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | |
49 | copy of the license is included in the section entitled ``GNU Free | |
50 | Documentation License''. | |
51 | @end copying | |
568717fd | 52 | |
abd67856 | 53 | @dircategory System administration |
568717fd | 54 | @direntry |
abd67856 LC |
55 | * Guix: (guix). Manage installed software and system configuration. |
56 | * guix package: (guix)Invoking guix package. Installing, removing, and upgrading packages. | |
abd67856 LC |
57 | * guix gc: (guix)Invoking guix gc. Reclaiming unused disk space. |
58 | * guix pull: (guix)Invoking guix pull. Update the list of available packages. | |
59 | * guix system: (guix)Invoking guix system. Manage the operating system configuration. | |
568717fd | 60 | @end direntry |
568717fd | 61 | |
372c4bbc DT |
62 | @dircategory Software development |
63 | @direntry | |
abd67856 | 64 | * guix environment: (guix)Invoking guix environment. Building development environments with Guix. |
ad172c4a LC |
65 | * guix build: (guix)Invoking guix build. Building packages. |
66 | * guix pack: (guix)Invoking guix pack. Creating binary bundles. | |
372c4bbc DT |
67 | @end direntry |
68 | ||
568717fd | 69 | @titlepage |
7730d112 LC |
70 | @title GNU Guix Reference Manual |
71 | @subtitle Using the GNU Guix Functional Package Manager | |
2cbed07e | 72 | @author The GNU Guix Developers |
568717fd LC |
73 | |
74 | @page | |
75 | @vskip 0pt plus 1filll | |
76 | Edition @value{EDITION} @* | |
77 | @value{UPDATED} @* | |
78 | ||
7df7a74e | 79 | @insertcopying |
568717fd LC |
80 | @end titlepage |
81 | ||
568717fd LC |
82 | @contents |
83 | ||
84 | @c ********************************************************************* | |
85 | @node Top | |
f8348b91 | 86 | @top GNU Guix |
568717fd | 87 | |
f8348b91 LC |
88 | This document describes GNU Guix version @value{VERSION}, a functional |
89 | package management tool written for the GNU system. | |
568717fd LC |
90 | |
91 | @menu | |
92 | * Introduction:: What is Guix about? | |
bd5e766b | 93 | * Installation:: Installing Guix. |
eeaf4427 | 94 | * Package Management:: Package installation, upgrade, etc. |
568717fd LC |
95 | * Programming Interface:: Using Guix in Scheme. |
96 | * Utilities:: Package management commands. | |
a1ba8475 | 97 | * GNU Distribution:: Software for your friendly GNU system. |
9bf3c1a7 | 98 | * Contributing:: Your help needed! |
568717fd LC |
99 | |
100 | * Acknowledgments:: Thanks! | |
101 | * GNU Free Documentation License:: The license of this manual. | |
102 | * Concept Index:: Concepts. | |
a85b83d2 | 103 | * Programming Index:: Data types, functions, and variables. |
aaa3eaa9 LC |
104 | |
105 | @detailmenu | |
106 | --- The Detailed Node Listing --- | |
107 | ||
108 | Installation | |
109 | ||
1b2b8177 | 110 | * Binary Installation:: Getting Guix running in no time! |
aaa3eaa9 | 111 | * Requirements:: Software needed to build and run Guix. |
ec0339cd | 112 | * Running the Test Suite:: Testing Guix. |
aaa3eaa9 LC |
113 | * Setting Up the Daemon:: Preparing the build daemon's environment. |
114 | * Invoking guix-daemon:: Running the build daemon. | |
0e2d0213 | 115 | * Application Setup:: Application-specific setup. |
aaa3eaa9 LC |
116 | |
117 | Setting Up the Daemon | |
118 | ||
119 | * Build Environment Setup:: Preparing the isolated build environment. | |
120 | * Daemon Offload Setup:: Offloading builds to remote machines. | |
121 | ||
122 | Package Management | |
123 | ||
124 | * Features:: How Guix will make your life brighter. | |
125 | * Invoking guix package:: Package installation, removal, etc. | |
aaa3eaa9 LC |
126 | * Substitutes:: Downloading pre-built binaries. |
127 | * Packages with Multiple Outputs:: Single source package, multiple outputs. | |
128 | * Invoking guix gc:: Running the garbage collector. | |
129 | * Invoking guix pull:: Fetching the latest Guix and distribution. | |
239c2266 | 130 | * Invoking guix pack:: Creating software bundles. |
aaa3eaa9 LC |
131 | * Invoking guix archive:: Exporting and importing store files. |
132 | ||
133 | Programming Interface | |
134 | ||
135 | * Defining Packages:: Defining new packages. | |
136 | * Build Systems:: Specifying how packages are built. | |
137 | * The Store:: Manipulating the package store. | |
138 | * Derivations:: Low-level interface to package derivations. | |
139 | * The Store Monad:: Purely functional interface to the store. | |
140 | * G-Expressions:: Manipulating build expressions. | |
141 | ||
92492b23 LC |
142 | Defining Packages |
143 | ||
10f4353d | 144 | * package Reference :: The package data type. |
92492b23 LC |
145 | * origin Reference:: The origin data type. |
146 | ||
aaa3eaa9 LC |
147 | Utilities |
148 | ||
149 | * Invoking guix build:: Building packages from the command line. | |
fcc58db6 | 150 | * Invoking guix edit:: Editing package definitions. |
aaa3eaa9 LC |
151 | * Invoking guix download:: Downloading a file and printing its hash. |
152 | * Invoking guix hash:: Computing the cryptographic hash of a file. | |
153 | * Invoking guix import:: Importing package definitions. | |
154 | * Invoking guix refresh:: Updating package definitions. | |
155 | * Invoking guix lint:: Finding errors in package definitions. | |
fcc58db6 | 156 | * Invoking guix size:: Profiling disk usage. |
88856916 | 157 | * Invoking guix graph:: Visualizing the graph of packages. |
aaa3eaa9 | 158 | * Invoking guix environment:: Setting up development environments. |
aff8ce7c | 159 | * Invoking guix publish:: Sharing substitutes. |
d23c20f1 | 160 | * Invoking guix challenge:: Challenging substitute servers. |
f11c444d | 161 | * Invoking guix copy:: Copying to and from a remote store. |
32efa254 | 162 | * Invoking guix container:: Process isolation. |
585347d7 | 163 | * Invoking guix weather:: Assessing substitute availability. |
aaa3eaa9 | 164 | |
e3009f60 LC |
165 | Invoking @command{guix build} |
166 | ||
167 | * Common Build Options:: Build options for most commands. | |
f11c444d | 168 | * Package Transformation Options:: Creating variants of packages. |
e3009f60 | 169 | * Additional Build Options:: Options specific to 'guix build'. |
10f4353d | 170 | * Debugging Build Failures:: Real life packaging experience. |
e3009f60 | 171 | |
aaa3eaa9 LC |
172 | GNU Distribution |
173 | ||
174 | * System Installation:: Installing the whole operating system. | |
35ed9306 | 175 | * System Configuration:: Configuring the operating system. |
31f1f593 | 176 | * Documentation:: Browsing software user manuals. |
aaa3eaa9 LC |
177 | * Installing Debugging Files:: Feeding the debugger. |
178 | * Security Updates:: Deploying security fixes quickly. | |
179 | * Package Modules:: Packages from the programmer's viewpoint. | |
180 | * Packaging Guidelines:: Growing the distribution. | |
181 | * Bootstrapping:: GNU/Linux built from scratch. | |
182 | * Porting:: Targeting another platform or kernel. | |
183 | ||
e3009f60 LC |
184 | System Installation |
185 | ||
186 | * Limitations:: What you can expect. | |
187 | * Hardware Considerations:: Supported hardware. | |
188 | * USB Stick Installation:: Preparing the installation medium. | |
189 | * Preparing for Installation:: Networking, partitioning, etc. | |
190 | * Proceeding with the Installation:: The real thing. | |
c8b54374 | 191 | * Installing GuixSD in a VM:: GuixSD playground. |
e3009f60 LC |
192 | * Building the Installation Image:: How this comes to be. |
193 | ||
aaa3eaa9 LC |
194 | System Configuration |
195 | ||
196 | * Using the Configuration System:: Customizing your GNU system. | |
197 | * operating-system Reference:: Detail of operating-system declarations. | |
198 | * File Systems:: Configuring file system mounts. | |
199 | * Mapped Devices:: Block device extra processing. | |
200 | * User Accounts:: Specifying user accounts. | |
598e19dc | 201 | * Locales:: Language and cultural convention settings. |
aaa3eaa9 LC |
202 | * Services:: Specifying system services. |
203 | * Setuid Programs:: Programs running with root privileges. | |
1b2b8177 | 204 | * X.509 Certificates:: Authenticating HTTPS servers. |
996ed739 | 205 | * Name Service Switch:: Configuring libc's name service switch. |
aaa3eaa9 | 206 | * Initial RAM Disk:: Linux-Libre bootstrapping. |
74e64724 | 207 | * Bootloader Configuration:: Configuring the boot loader. |
aaa3eaa9 | 208 | * Invoking guix system:: Instantiating a system configuration. |
97d76250 | 209 | * Running GuixSD in a VM:: How to run GuixSD in a virtual machine. |
aaa3eaa9 LC |
210 | * Defining Services:: Adding new service definitions. |
211 | ||
212 | Services | |
213 | ||
214 | * Base Services:: Essential system services. | |
c311089b | 215 | * Scheduled Job Execution:: The mcron service. |
92c03a87 | 216 | * Log Rotation:: The rottlog service. |
aaa3eaa9 LC |
217 | * Networking Services:: Network setup, SSH daemon, etc. |
218 | * X Window:: Graphical display. | |
f11c444d | 219 | * Printing Services:: Local and remote printer support. |
1b2b8177 | 220 | * Desktop Services:: D-Bus and desktop services. |
29059262 | 221 | * Database Services:: SQL databases, key-value stores, etc. |
d8c18af8 | 222 | * Mail Services:: IMAP, POP3, SMTP, and all that. |
78cef99b | 223 | * Messaging Services:: Messaging services. |
730ed6ec | 224 | * Monitoring Services:: Monitoring services. |
859e367d | 225 | * Kerberos Services:: Kerberos services. |
cbd02397 | 226 | * Web Services:: Web servers. |
ba69e8f7 | 227 | * DNS Services:: DNS daemons. |
2be1b471 | 228 | * VPN Services:: VPN daemons. |
eb419bc9 | 229 | * Network File System:: NFS related services. |
f11c444d | 230 | * Continuous Integration:: The Cuirass service. |
bfbf6e1e | 231 | * Power management Services:: The TLP tool. |
06465d2b | 232 | * Audio Services:: The MPD. |
e6051057 | 233 | * Virtualization Services:: Virtualization services. |
dbc6d370 | 234 | * Miscellaneous Services:: Other services. |
aaa3eaa9 | 235 | |
0adfe95a LC |
236 | Defining Services |
237 | ||
238 | * Service Composition:: The model for composing services. | |
239 | * Service Types and Services:: Types and services. | |
240 | * Service Reference:: API reference. | |
dd17bc38 | 241 | * Shepherd Services:: A particular type of service. |
0adfe95a | 242 | |
aaa3eaa9 LC |
243 | Packaging Guidelines |
244 | ||
ec0339cd LC |
245 | * Software Freedom:: What may go into the distribution. |
246 | * Package Naming:: What's in a name? | |
247 | * Version Numbers:: When the name is not enough. | |
cbd02397 | 248 | * Synopses and Descriptions:: Helping users find the right package. |
fb4d6f6c | 249 | * Python Modules:: A touch of British comedy. |
ec0339cd | 250 | * Perl Modules:: Little pearls. |
e1c963bf | 251 | * Java Packages:: Coffee break. |
ec0339cd | 252 | * Fonts:: Fond of fonts. |
aaa3eaa9 | 253 | |
8c01b9d0 ML |
254 | Contributing |
255 | ||
256 | * Building from Git:: The latest and greatest. | |
257 | * Running Guix Before It Is Installed:: Hacker tricks. | |
258 | * The Perfect Setup:: The right tools. | |
259 | * Coding Style:: Hygiene of the contributor. | |
260 | * Submitting Patches:: Share your work. | |
261 | ||
262 | Coding Style | |
263 | ||
264 | * Programming Paradigm:: How to compose your elements. | |
265 | * Modules:: Where to store your code? | |
266 | * Data Types and Pattern Matching:: Implementing data structures. | |
267 | * Formatting Code:: Writing conventions. | |
268 | ||
aaa3eaa9 | 269 | @end detailmenu |
568717fd LC |
270 | @end menu |
271 | ||
272 | @c ********************************************************************* | |
273 | @node Introduction | |
274 | @chapter Introduction | |
275 | ||
6f773606 | 276 | @cindex purpose |
c80e7e55 | 277 | GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' |
6f773606 LC |
278 | using the international phonetic alphabet (IPA).} is a package |
279 | management tool for the GNU system. Guix makes it easy for unprivileged | |
280 | users to install, upgrade, or remove packages, to roll back to a | |
281 | previous package set, to build packages from source, and generally | |
282 | assists with the creation and maintenance of software environments. | |
283 | ||
284 | @cindex user interfaces | |
285 | Guix provides a command-line package management interface | |
286 | (@pxref{Invoking guix package}), a set of command-line utilities | |
deb6276d | 287 | (@pxref{Utilities}), as well as Scheme programming interfaces |
6f773606 LC |
288 | (@pxref{Programming Interface}). |
289 | @cindex build daemon | |
290 | Its @dfn{build daemon} is responsible for building packages on behalf of | |
291 | users (@pxref{Setting Up the Daemon}) and for downloading pre-built | |
292 | binaries from authorized sources (@pxref{Substitutes}). | |
293 | ||
294 | @cindex extensibility of the distribution | |
e32171ee | 295 | @cindex customization, of packages |
6f773606 LC |
296 | Guix includes package definitions for many GNU and non-GNU packages, all |
297 | of which @uref{https://www.gnu.org/philosophy/free-sw.html, respect the | |
298 | user's computing freedom}. It is @emph{extensible}: users can write | |
299 | their own package definitions (@pxref{Defining Packages}) and make them | |
300 | available as independent package modules (@pxref{Package Modules}). It | |
301 | is also @emph{customizable}: users can @emph{derive} specialized package | |
302 | definitions from existing ones, including from the command line | |
303 | (@pxref{Package Transformation Options}). | |
304 | ||
305 | @cindex Guix System Distribution | |
306 | @cindex GuixSD | |
307 | You can install GNU@tie{}Guix on top of an existing GNU/Linux system | |
308 | where it complements the available tools without interference | |
309 | (@pxref{Installation}), or you can use it as part of the standalone | |
310 | @dfn{Guix System Distribution} or GuixSD (@pxref{GNU Distribution}). | |
311 | With GNU@tie{}GuixSD, you @emph{declare} all aspects of the operating | |
312 | system configuration and Guix takes care of instantiating the | |
313 | configuration in a transactional, reproducible, and stateless fashion | |
314 | (@pxref{System Configuration}). | |
568717fd LC |
315 | |
316 | @cindex functional package management | |
6f773606 | 317 | Under the hood, Guix implements the @dfn{functional package management} |
136787cb LC |
318 | discipline pioneered by Nix (@pxref{Acknowledgments}). |
319 | In Guix, the package build and installation process is seen | |
6f773606 | 320 | as a @emph{function}, in the mathematical sense. That function takes inputs, |
4bfc4ea3 NK |
321 | such as build scripts, a compiler, and libraries, and |
322 | returns an installed package. As a pure function, its result depends | |
568717fd LC |
323 | solely on its inputs---for instance, it cannot refer to software or |
324 | scripts that were not explicitly passed as inputs. A build function | |
4bfc4ea3 | 325 | always produces the same result when passed a given set of inputs. It |
f97c9175 | 326 | cannot alter the environment of the running system in |
568717fd LC |
327 | any way; for instance, it cannot create, modify, or delete files outside |
328 | of its build and installation directories. This is achieved by running | |
e900c503 | 329 | build processes in isolated environments (or @dfn{containers}), where only their |
4bfc4ea3 | 330 | explicit inputs are visible. |
568717fd | 331 | |
e531ac2a | 332 | @cindex store |
568717fd | 333 | The result of package build functions is @dfn{cached} in the file |
e531ac2a | 334 | system, in a special directory called @dfn{the store} (@pxref{The |
f97c9175 | 335 | Store}). Each package is installed in a directory of its own in the |
834129e0 | 336 | store---by default under @file{/gnu/store}. The directory name contains |
568717fd LC |
337 | a hash of all the inputs used to build that package; thus, changing an |
338 | input yields a different directory name. | |
339 | ||
f97c9175 AE |
340 | This approach is the foundation for the salient features of Guix: support |
341 | for transactional package upgrade and rollback, per-user installation, and | |
eeaf4427 | 342 | garbage collection of packages (@pxref{Features}). |
568717fd | 343 | |
a1ba8475 | 344 | |
bd5e766b LC |
345 | @c ********************************************************************* |
346 | @node Installation | |
347 | @chapter Installation | |
348 | ||
e32171ee | 349 | @cindex installing Guix |
48febeb8 LC |
350 | GNU Guix is available for download from its website at |
351 | @url{http://www.gnu.org/software/guix/}. This section describes the | |
352 | software requirements of Guix, as well as how to install it and get | |
353 | ready to use it. | |
bd5e766b | 354 | |
5af6de3e LC |
355 | Note that this section is concerned with the installation of the package |
356 | manager, which can be done on top of a running GNU/Linux system. If, | |
357 | instead, you want to install the complete GNU operating system, | |
6621cdb6 | 358 | @pxref{System Installation}. |
5af6de3e | 359 | |
d23ef788 LC |
360 | @cindex foreign distro |
361 | When installed on a running GNU/Linux system---thereafter called a | |
362 | @dfn{foreign distro}---GNU@tie{}Guix complements the available tools | |
363 | without interference. Its data lives exclusively in two directories, | |
364 | usually @file{/gnu/store} and @file{/var/guix}; other files on your | |
365 | system, such as @file{/etc}, are left untouched. | |
366 | ||
7fcf2a0b LC |
367 | Once installed, Guix can be updated by running @command{guix pull} |
368 | (@pxref{Invoking guix pull}). | |
369 | ||
bd5e766b | 370 | @menu |
09722b11 | 371 | * Binary Installation:: Getting Guix running in no time! |
bd5e766b | 372 | * Requirements:: Software needed to build and run Guix. |
ec0339cd | 373 | * Running the Test Suite:: Testing Guix. |
bd5e766b LC |
374 | * Setting Up the Daemon:: Preparing the build daemon's environment. |
375 | * Invoking guix-daemon:: Running the build daemon. | |
0e2d0213 | 376 | * Application Setup:: Application-specific setup. |
bd5e766b LC |
377 | @end menu |
378 | ||
09722b11 LC |
379 | @node Binary Installation |
380 | @section Binary Installation | |
381 | ||
e32171ee | 382 | @cindex installing Guix from binaries |
09722b11 LC |
383 | This section describes how to install Guix on an arbitrary system from a |
384 | self-contained tarball providing binaries for Guix and for all its | |
385 | dependencies. This is often quicker than installing from source, which | |
386 | is described in the next sections. The only requirement is to have | |
387 | GNU@tie{}tar and Xz. | |
388 | ||
389 | Installing goes along these lines: | |
390 | ||
391 | @enumerate | |
392 | @item | |
e32171ee | 393 | @cindex downloading Guix binary |
09722b11 | 394 | Download the binary tarball from |
daa8922a LC |
395 | @indicateurl{ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz}, |
396 | where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine | |
397 | already running the kernel Linux, and so on. | |
398 | ||
debc6360 | 399 | @c The following is somewhat duplicated in ``System Installation''. |
daa8922a LC |
400 | Make sure to download the associated @file{.sig} file and to verify the |
401 | authenticity of the tarball against it, along these lines: | |
402 | ||
403 | @example | |
404 | $ wget ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig | |
405 | $ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig | |
406 | @end example | |
407 | ||
f97c9175 | 408 | If that command fails because you do not have the required public key, |
daa8922a LC |
409 | then run this command to import it: |
410 | ||
411 | @example | |
debc6360 | 412 | $ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID} |
daa8922a LC |
413 | @end example |
414 | ||
415 | @noindent | |
416 | and rerun the @code{gpg --verify} command. | |
debc6360 | 417 | @c end authentication part |
09722b11 LC |
418 | |
419 | @item | |
420 | As @code{root}, run: | |
421 | ||
422 | @example | |
5dc42964 | 423 | # cd /tmp |
254b1c2e LC |
424 | # tar --warning=no-timestamp -xf \ |
425 | guix-binary-@value{VERSION}.@var{system}.tar.xz | |
5dc42964 | 426 | # mv var/guix /var/ && mv gnu / |
09722b11 LC |
427 | @end example |
428 | ||
7acd3439 LC |
429 | This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. |
430 | The latter contains a ready-to-use profile for @code{root} (see next | |
431 | step.) | |
09722b11 | 432 | |
5dc3ce5f LC |
433 | Do @emph{not} unpack the tarball on a working Guix system since that |
434 | would overwrite its own essential files. | |
435 | ||
254b1c2e | 436 | The @code{--warning=no-timestamp} option makes sure GNU@tie{}tar does |
e9ba6357 LC |
437 | not emit warnings about ``implausibly old time stamps'' (such |
438 | warnings were triggered by GNU@tie{}tar 1.26 and older; recent | |
439 | versions are fine.) | |
440 | They stem from the fact that all the | |
254b1c2e LC |
441 | files in the archive have their modification time set to zero (which |
442 | means January 1st, 1970.) This is done on purpose to make sure the | |
443 | archive content is independent of its creation time, thus making it | |
444 | reproducible. | |
445 | ||
7acd3439 LC |
446 | @item |
447 | Make @code{root}'s profile available under @file{~/.guix-profile}: | |
448 | ||
449 | @example | |
450 | # ln -sf /var/guix/profiles/per-user/root/guix-profile \ | |
451 | ~root/.guix-profile | |
452 | @end example | |
453 | ||
1165b08f LC |
454 | Source @file{etc/profile} to augment @code{PATH} and other relevant |
455 | environment variables: | |
456 | ||
457 | @example | |
458 | # GUIX_PROFILE=$HOME/.guix-profile \ | |
459 | source $GUIX_PROFILE/etc/profile | |
460 | @end example | |
461 | ||
43c33047 LC |
462 | @item |
463 | Create the group and user accounts for build users as explained below | |
464 | (@pxref{Build Environment Setup}). | |
465 | ||
09722b11 | 466 | @item |
bf98aea9 | 467 | Run the daemon, and set it to automatically start on boot. |
c8e26887 | 468 | |
bf98aea9 LC |
469 | If your host distro uses the systemd init system, this can be achieved |
470 | with these commands: | |
c8e26887 | 471 | |
b812da70 LF |
472 | @c Versions of systemd that supported symlinked service files are not |
473 | @c yet widely deployed, so we should suggest that users copy the service | |
474 | @c files into place. | |
475 | @c | |
476 | @c See this thread for more information: | |
477 | @c http://lists.gnu.org/archive/html/guix-devel/2017-01/msg01199.html | |
478 | ||
c8e26887 | 479 | @example |
b812da70 | 480 | # cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \ |
c8e26887 GC |
481 | /etc/systemd/system/ |
482 | # systemctl start guix-daemon && systemctl enable guix-daemon | |
483 | @end example | |
484 | ||
485 | If your host distro uses the Upstart init system: | |
09722b11 LC |
486 | |
487 | @example | |
4a780bdf | 488 | # initctl reload-configuration |
b812da70 | 489 | # cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/ |
bf98aea9 | 490 | # start guix-daemon |
09722b11 LC |
491 | @end example |
492 | ||
c8e26887 GC |
493 | Otherwise, you can still start the daemon manually with: |
494 | ||
495 | @example | |
496 | # ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild | |
497 | @end example | |
d2825c96 | 498 | |
09722b11 LC |
499 | @item |
500 | Make the @command{guix} command available to other users on the machine, | |
501 | for instance with: | |
502 | ||
503 | @example | |
504 | # mkdir -p /usr/local/bin | |
505 | # cd /usr/local/bin | |
d72d05f9 | 506 | # ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix |
09722b11 | 507 | @end example |
39f8ed14 | 508 | |
aca738f3 LC |
509 | It is also a good idea to make the Info version of this manual available |
510 | there: | |
511 | ||
512 | @example | |
513 | # mkdir -p /usr/local/share/info | |
514 | # cd /usr/local/share/info | |
515 | # for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ; | |
516 | do ln -s $i ; done | |
517 | @end example | |
518 | ||
519 | That way, assuming @file{/usr/local/share/info} is in the search path, | |
520 | running @command{info guix} will open this manual (@pxref{Other Info | |
521 | Directories,,, texinfo, GNU Texinfo}, for more details on changing the | |
522 | Info search path.) | |
523 | ||
39f8ed14 | 524 | @item |
e32171ee | 525 | @cindex substitutes, authorization thereof |
df061d07 LC |
526 | To use substitutes from @code{hydra.gnu.org} or one of its mirrors |
527 | (@pxref{Substitutes}), authorize them: | |
39f8ed14 LC |
528 | |
529 | @example | |
7acd3439 | 530 | # guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub |
39f8ed14 | 531 | @end example |
7f608a9b LC |
532 | |
533 | @item | |
534 | Each user may need to perform a few additional steps to make their Guix | |
535 | environment ready for use, @pxref{Application Setup}. | |
09722b11 LC |
536 | @end enumerate |
537 | ||
7f608a9b | 538 | Voilà, the installation is complete! |
09722b11 | 539 | |
c8e26887 GC |
540 | You can confirm that Guix is working by installing a sample package into |
541 | the root profile: | |
09722b11 LC |
542 | |
543 | @example | |
c8e26887 | 544 | # guix package -i hello |
09722b11 LC |
545 | @end example |
546 | ||
c8e26887 GC |
547 | The @code{guix} package must remain available in @code{root}'s profile, |
548 | or it would become subject to garbage collection---in which case you | |
549 | would find yourself badly handicapped by the lack of the @command{guix} | |
bf98aea9 LC |
550 | command. In other words, do not remove @code{guix} by running |
551 | @code{guix package -r guix}. | |
552 | ||
553 | The binary installation tarball can be (re)produced and verified simply | |
554 | by running the following command in the Guix source tree: | |
555 | ||
556 | @example | |
557 | make guix-binary.@var{system}.tar.xz | |
558 | @end example | |
c8e26887 | 559 | |
239c2266 LC |
560 | @noindent |
561 | ... which, in turn, runs: | |
562 | ||
563 | @example | |
6b63c43e | 564 | guix pack -s @var{system} --localstatedir guix |
239c2266 LC |
565 | @end example |
566 | ||
567 | @xref{Invoking guix pack}, for more info on this handy tool. | |
09722b11 | 568 | |
bd5e766b LC |
569 | @node Requirements |
570 | @section Requirements | |
571 | ||
09722b11 LC |
572 | This section lists requirements when building Guix from source. The |
573 | build procedure for Guix is the same as for other GNU software, and is | |
574 | not covered here. Please see the files @file{README} and @file{INSTALL} | |
575 | in the Guix source tree for additional details. | |
576 | ||
bd5e766b LC |
577 | GNU Guix depends on the following packages: |
578 | ||
579 | @itemize | |
36626c55 | 580 | @item @url{http://gnu.org/software/guile/, GNU Guile}, version 2.0.9 or |
608e42e7 | 581 | later, including 2.2.x; |
288dca55 | 582 | @item @url{http://gnupg.org/, GNU libgcrypt}; |
1dbe3a8d LC |
583 | @item |
584 | @uref{http://gnutls.org/, GnuTLS}, specifically its Guile bindings | |
585 | (@pxref{Guile Preparations, how to install the GnuTLS bindings for | |
586 | Guile,, gnutls-guile, GnuTLS-Guile}); | |
7441f1db LC |
587 | @item |
588 | @c FIXME: Specify a version number once a release has been made. | |
589 | @uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, from August | |
590 | 2017 or later; | |
f0b98b84 | 591 | @item @url{http://www.gnu.org/software/make/, GNU Make}. |
8a96bd4b ID |
592 | @end itemize |
593 | ||
594 | The following dependencies are optional: | |
595 | ||
596 | @itemize | |
288dca55 | 597 | @item |
8a96bd4b | 598 | Installing |
288dca55 | 599 | @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} will |
2f7d2d91 LC |
600 | allow you to use the @command{guix import pypi} command (@pxref{Invoking |
601 | guix import}). It is of | |
288dca55 | 602 | interest primarily for developers and not for casual users. |
4591c02e | 603 | |
21531add LC |
604 | @item |
605 | @c Note: We need at least 0.10.2 for 'channel-send-eof'. | |
f11c444d LC |
606 | Support for build offloading (@pxref{Daemon Offload Setup}) and |
607 | @command{guix copy} (@pxref{Invoking guix copy}) depends on | |
21531add LC |
608 | @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, |
609 | version 0.10.2 or later. | |
610 | ||
4591c02e LC |
611 | @item |
612 | When @url{http://zlib.net, zlib} is available, @command{guix publish} | |
613 | can compress build byproducts (@pxref{Invoking guix publish}). | |
bd5e766b LC |
614 | @end itemize |
615 | ||
616 | Unless @code{--disable-daemon} was passed to @command{configure}, the | |
617 | following packages are also needed: | |
618 | ||
619 | @itemize | |
368d08f7 LC |
620 | @item @url{http://sqlite.org, SQLite 3}; |
621 | @item @url{http://www.bzip.org, libbz2}; | |
622 | @item @url{http://gcc.gnu.org, GCC's g++}, with support for the | |
623 | C++11 standard. | |
bd5e766b LC |
624 | @end itemize |
625 | ||
e32171ee | 626 | @cindex state directory |
ef5f5c86 LC |
627 | When configuring Guix on a system that already has a Guix installation, |
628 | be sure to specify the same state directory as the existing installation | |
629 | using the @code{--localstatedir} option of the @command{configure} | |
630 | script (@pxref{Directory Variables, @code{localstatedir},, standards, | |
631 | GNU Coding Standards}). The @command{configure} script protects against | |
632 | unintended misconfiguration of @var{localstatedir} so you do not | |
633 | inadvertently corrupt your store (@pxref{The Store}). | |
634 | ||
e32171ee | 635 | @cindex Nix, compatibility |
4bfc4ea3 NK |
636 | When a working installation of @url{http://nixos.org/nix/, the Nix package |
637 | manager} is available, you | |
bd5e766b | 638 | can instead configure Guix with @code{--disable-daemon}. In that case, |
4bfc4ea3 | 639 | Nix replaces the three dependencies above. |
bd5e766b | 640 | |
b22a12fd LC |
641 | Guix is compatible with Nix, so it is possible to share the same store |
642 | between both. To do so, you must pass @command{configure} not only the | |
643 | same @code{--with-store-dir} value, but also the same | |
4bfc4ea3 NK |
644 | @code{--localstatedir} value. The latter is essential because it |
645 | specifies where the database that stores metadata about the store is | |
834129e0 | 646 | located, among other things. The default values for Nix are |
b22a12fd | 647 | @code{--with-store-dir=/nix/store} and @code{--localstatedir=/nix/var}. |
4bfc4ea3 NK |
648 | Note that @code{--disable-daemon} is not required if |
649 | your goal is to share the store with Nix. | |
b22a12fd | 650 | |
ec0339cd LC |
651 | @node Running the Test Suite |
652 | @section Running the Test Suite | |
653 | ||
e32171ee | 654 | @cindex test suite |
ec0339cd LC |
655 | After a successful @command{configure} and @code{make} run, it is a good |
656 | idea to run the test suite. It can help catch issues with the setup or | |
657 | environment, or bugs in Guix itself---and really, reporting test | |
658 | failures is a good way to help improve the software. To run the test | |
659 | suite, type: | |
660 | ||
661 | @example | |
662 | make check | |
663 | @end example | |
664 | ||
665 | Test cases can run in parallel: you can use the @code{-j} option of | |
666 | GNU@tie{}make to speed things up. The first run may take a few minutes | |
667 | on a recent machine; subsequent runs will be faster because the store | |
668 | that is created for test purposes will already have various things in | |
669 | cache. | |
670 | ||
a887fd8d LC |
671 | It is also possible to run a subset of the tests by defining the |
672 | @code{TESTS} makefile variable as in this example: | |
673 | ||
674 | @example | |
675 | make check TESTS="tests/store.scm tests/cpio.scm" | |
676 | @end example | |
677 | ||
a9edb211 ML |
678 | By default, tests results are displayed at a file level. In order to |
679 | see the details of every individual test cases, it is possible to define | |
680 | the @code{SCM_LOG_DRIVER_FLAGS} makefile variable as in this example: | |
681 | ||
682 | @example | |
683 | make check TESTS="tests/base64.scm" SCM_LOG_DRIVER_FLAGS="--brief=no" | |
684 | @end example | |
685 | ||
ec0339cd | 686 | Upon failure, please email @email{bug-guix@@gnu.org} and attach the |
a9edb211 ML |
687 | @file{test-suite.log} file. Please specify the Guix version being used |
688 | as well as version numbers of the dependencies (@pxref{Requirements}) in | |
689 | your message. | |
ec0339cd | 690 | |
0a2f2848 LC |
691 | Guix also comes with a whole-system test suite that tests complete |
692 | GuixSD operating system instances. It can only run on systems where | |
693 | Guix is already installed, using: | |
694 | ||
695 | @example | |
696 | make check-system | |
697 | @end example | |
698 | ||
699 | @noindent | |
700 | or, again, by defining @code{TESTS} to select a subset of tests to run: | |
701 | ||
702 | @example | |
703 | make check-system TESTS="basic mcron" | |
704 | @end example | |
705 | ||
706 | These system tests are defined in the @code{(gnu tests @dots{})} | |
707 | modules. They work by running the operating systems under test with | |
708 | lightweight instrumentation in a virtual machine (VM). They can be | |
709 | computationally intensive or rather cheap, depending on whether | |
710 | substitutes are available for their dependencies (@pxref{Substitutes}). | |
711 | Some of them require a lot of storage space to hold VM images. | |
712 | ||
713 | Again in case of test failures, please send @email{bug-guix@@gnu.org} | |
714 | all the details. | |
715 | ||
bd5e766b LC |
716 | @node Setting Up the Daemon |
717 | @section Setting Up the Daemon | |
718 | ||
719 | @cindex daemon | |
720 | Operations such as building a package or running the garbage collector | |
49e6291a | 721 | are all performed by a specialized process, the @dfn{build daemon}, on |
bd5e766b LC |
722 | behalf of clients. Only the daemon may access the store and its |
723 | associated database. Thus, any operation that manipulates the store | |
724 | goes through the daemon. For instance, command-line tools such as | |
e49951eb | 725 | @command{guix package} and @command{guix build} communicate with the |
bd5e766b LC |
726 | daemon (@i{via} remote procedure calls) to instruct it what to do. |
727 | ||
49e6291a | 728 | The following sections explain how to prepare the build daemon's |
f97c9175 | 729 | environment. See also @ref{Substitutes}, for information on how to allow |
225dafde | 730 | the daemon to download pre-built binaries. |
49e6291a LC |
731 | |
732 | @menu | |
733 | * Build Environment Setup:: Preparing the isolated build environment. | |
734 | * Daemon Offload Setup:: Offloading builds to remote machines. | |
735 | @end menu | |
736 | ||
737 | @node Build Environment Setup | |
738 | @subsection Build Environment Setup | |
739 | ||
e32171ee | 740 | @cindex build environment |
bd5e766b LC |
741 | In a standard multi-user setup, Guix and its daemon---the |
742 | @command{guix-daemon} program---are installed by the system | |
834129e0 | 743 | administrator; @file{/gnu/store} is owned by @code{root} and |
bd5e766b LC |
744 | @command{guix-daemon} runs as @code{root}. Unprivileged users may use |
745 | Guix tools to build packages or otherwise access the store, and the | |
746 | daemon will do it on their behalf, ensuring that the store is kept in a | |
747 | consistent state, and allowing built packages to be shared among users. | |
748 | ||
749 | @cindex build users | |
750 | When @command{guix-daemon} runs as @code{root}, you may not want package | |
751 | build processes themselves to run as @code{root} too, for obvious | |
752 | security reasons. To avoid that, a special pool of @dfn{build users} | |
753 | should be created for use by build processes started by the daemon. | |
754 | These build users need not have a shell and a home directory: they will | |
755 | just be used when the daemon drops @code{root} privileges in build | |
756 | processes. Having several such users allows the daemon to launch | |
757 | distinct build processes under separate UIDs, which guarantees that they | |
758 | do not interfere with each other---an essential feature since builds are | |
759 | regarded as pure functions (@pxref{Introduction}). | |
760 | ||
761 | On a GNU/Linux system, a build user pool may be created like this (using | |
762 | Bash syntax and the @code{shadow} commands): | |
763 | ||
091196b3 LC |
764 | @c See http://lists.gnu.org/archive/html/bug-guix/2013-01/msg00239.html |
765 | @c for why `-G' is needed. | |
bd5e766b | 766 | @example |
cfc149dc LC |
767 | # groupadd --system guixbuild |
768 | # for i in `seq -w 1 10`; | |
bd5e766b | 769 | do |
cfc149dc LC |
770 | useradd -g guixbuild -G guixbuild \ |
771 | -d /var/empty -s `which nologin` \ | |
772 | -c "Guix build user $i" --system \ | |
773 | guixbuilder$i; | |
bd5e766b LC |
774 | done |
775 | @end example | |
776 | ||
777 | @noindent | |
54eb03ab LC |
778 | The number of build users determines how many build jobs may run in |
779 | parallel, as specified by the @option{--max-jobs} option | |
eca69fc0 LC |
780 | (@pxref{Invoking guix-daemon, @option{--max-jobs}}). To use |
781 | @command{guix system vm} and related commands, you may need to add the | |
782 | build users to the @code{kvm} group so they can access @file{/dev/kvm}, | |
783 | using @code{-G guixbuild,kvm} instead of @code{-G guixbuild} | |
784 | (@pxref{Invoking guix system}). | |
785 | ||
786 | The @code{guix-daemon} program may then be run as @code{root} with the | |
d2825c96 LC |
787 | following command@footnote{If your machine uses the systemd init system, |
788 | dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} | |
789 | file in @file{/etc/systemd/system} will ensure that | |
ad227484 MDRS |
790 | @command{guix-daemon} is automatically started. Similarly, if your |
791 | machine uses the Upstart init system, drop the | |
792 | @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} | |
793 | file in @file{/etc/init}.}: | |
bd5e766b LC |
794 | |
795 | @example | |
cfc149dc | 796 | # guix-daemon --build-users-group=guixbuild |
bd5e766b LC |
797 | @end example |
798 | ||
e900c503 | 799 | @cindex chroot |
b095792f LC |
800 | @noindent |
801 | This way, the daemon starts build processes in a chroot, under one of | |
cfc149dc | 802 | the @code{guixbuilder} users. On GNU/Linux, by default, the chroot |
6dc99317 LC |
803 | environment contains nothing but: |
804 | ||
805 | @c Keep this list in sync with libstore/build.cc! ----------------------- | |
806 | @itemize | |
807 | @item | |
4743a4da LC |
808 | a minimal @code{/dev} directory, created mostly independently from the |
809 | host @code{/dev}@footnote{``Mostly'', because while the set of files | |
810 | that appear in the chroot's @code{/dev} is fixed, most of these files | |
811 | can only be created if the host has them.}; | |
812 | ||
813 | @item | |
f97c9175 | 814 | the @code{/proc} directory; it only shows the processes of the container |
4743a4da | 815 | since a separate PID name space is used; |
6dc99317 LC |
816 | |
817 | @item | |
818 | @file{/etc/passwd} with an entry for the current user and an entry for | |
819 | user @file{nobody}; | |
820 | ||
821 | @item | |
822 | @file{/etc/group} with an entry for the user's group; | |
823 | ||
824 | @item | |
825 | @file{/etc/hosts} with an entry that maps @code{localhost} to | |
826 | @code{127.0.0.1}; | |
827 | ||
828 | @item | |
829 | a writable @file{/tmp} directory. | |
830 | @end itemize | |
b095792f | 831 | |
cb960102 ED |
832 | You can influence the directory where the daemon stores build trees |
833 | @i{via} the @code{TMPDIR} environment variable. However, the build tree | |
f97c9175 | 834 | within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, |
cb960102 ED |
835 | where @var{name} is the derivation name---e.g., @code{coreutils-8.24}. |
836 | This way, the value of @code{TMPDIR} does not leak inside build | |
837 | environments, which avoids discrepancies in cases where build processes | |
838 | capture the name of their build tree. | |
839 | ||
e0c941fe LC |
840 | @vindex http_proxy |
841 | The daemon also honors the @code{http_proxy} environment variable for | |
842 | HTTP downloads it performs, be it for fixed-output derivations | |
843 | (@pxref{Derivations}) or for substitutes (@pxref{Substitutes}). | |
844 | ||
1e2644bb LC |
845 | If you are installing Guix as an unprivileged user, it is still possible |
846 | to run @command{guix-daemon} provided you pass @code{--disable-chroot}. | |
847 | However, build processes will not be isolated from one another, and not | |
848 | from the rest of the system. Thus, build processes may interfere with | |
849 | each other, and may access programs, libraries, and other files | |
850 | available on the system---making it much harder to view them as | |
851 | @emph{pure} functions. | |
bd5e766b | 852 | |
49e6291a LC |
853 | |
854 | @node Daemon Offload Setup | |
855 | @subsection Using the Offload Facility | |
856 | ||
857 | @cindex offloading | |
4ec2e92d | 858 | @cindex build hook |
21531add LC |
859 | When desired, the build daemon can @dfn{offload} derivation builds to |
860 | other machines running Guix, using the @code{offload} @dfn{build | |
861 | hook}@footnote{This feature is available only when | |
862 | @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH} is | |
863 | present.}. When that | |
49e6291a | 864 | feature is enabled, a list of user-specified build machines is read from |
f97c9175 | 865 | @file{/etc/guix/machines.scm}; every time a build is requested, for |
49e6291a | 866 | instance via @code{guix build}, the daemon attempts to offload it to one |
f97c9175 | 867 | of the machines that satisfy the constraints of the derivation, in |
49e6291a LC |
868 | particular its system type---e.g., @file{x86_64-linux}. Missing |
869 | prerequisites for the build are copied over SSH to the target machine, | |
870 | which then proceeds with the build; upon success the output(s) of the | |
871 | build are copied back to the initial machine. | |
872 | ||
4ec2e92d | 873 | The @file{/etc/guix/machines.scm} file typically looks like this: |
49e6291a LC |
874 | |
875 | @example | |
876 | (list (build-machine | |
877 | (name "eightysix.example.org") | |
878 | (system "x86_64-linux") | |
21531add | 879 | (host-key "ssh-ed25519 AAAAC3Nza@dots{}") |
49e6291a | 880 | (user "bob") |
21531add | 881 | (speed 2.)) ;incredibly fast! |
49e6291a LC |
882 | |
883 | (build-machine | |
884 | (name "meeps.example.org") | |
885 | (system "mips64el-linux") | |
21531add | 886 | (host-key "ssh-rsa AAAAB3Nza@dots{}") |
49e6291a LC |
887 | (user "alice") |
888 | (private-key | |
889 | (string-append (getenv "HOME") | |
21531add | 890 | "/.ssh/identity-for-guix")))) |
49e6291a LC |
891 | @end example |
892 | ||
893 | @noindent | |
894 | In the example above we specify a list of two build machines, one for | |
895 | the @code{x86_64} architecture and one for the @code{mips64el} | |
4ec2e92d LC |
896 | architecture. |
897 | ||
898 | In fact, this file is---not surprisingly!---a Scheme file that is | |
899 | evaluated when the @code{offload} hook is started. Its return value | |
900 | must be a list of @code{build-machine} objects. While this example | |
901 | shows a fixed list of build machines, one could imagine, say, using | |
902 | DNS-SD to return a list of potential build machines discovered in the | |
903 | local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using | |
c678a4ee LC |
904 | Avahi in Guile Scheme Programs}). The @code{build-machine} data type is |
905 | detailed below. | |
4ec2e92d | 906 | |
c678a4ee | 907 | @deftp {Data Type} build-machine |
f97c9175 AE |
908 | This data type represents build machines to which the daemon may offload |
909 | builds. The important fields are: | |
49e6291a LC |
910 | |
911 | @table @code | |
912 | ||
913 | @item name | |
f97c9175 | 914 | The host name of the remote machine. |
49e6291a LC |
915 | |
916 | @item system | |
f97c9175 | 917 | The system type of the remote machine---e.g., @code{"x86_64-linux"}. |
49e6291a LC |
918 | |
919 | @item user | |
920 | The user account to use when connecting to the remote machine over SSH. | |
921 | Note that the SSH key pair must @emph{not} be passphrase-protected, to | |
922 | allow non-interactive logins. | |
923 | ||
21531add LC |
924 | @item host-key |
925 | This must be the machine's SSH @dfn{public host key} in OpenSSH format. | |
926 | This is used to authenticate the machine when we connect to it. It is a | |
927 | long string that looks like this: | |
928 | ||
929 | @example | |
930 | ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org | |
931 | @end example | |
932 | ||
933 | If the machine is running the OpenSSH daemon, @command{sshd}, the host | |
934 | key can be found in a file such as | |
935 | @file{/etc/ssh/ssh_host_ed25519_key.pub}. | |
936 | ||
937 | If the machine is running the SSH daemon of GNU@tie{}lsh, | |
938 | @command{lshd}, the host key is in @file{/etc/lsh/host-key.pub} or a | |
939 | similar file. It can be converted to the OpenSSH format using | |
940 | @command{lsh-export-key} (@pxref{Converting keys,,, lsh, LSH Manual}): | |
941 | ||
942 | @example | |
943 | $ lsh-export-key --openssh < /etc/lsh/host-key.pub | |
944 | ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{} | |
945 | @end example | |
946 | ||
49e6291a LC |
947 | @end table |
948 | ||
4ec2e92d | 949 | A number of optional fields may be specified: |
49e6291a | 950 | |
21531add | 951 | @table @asis |
49e6291a | 952 | |
21531add LC |
953 | @item @code{port} (default: @code{22}) |
954 | Port number of SSH server on the machine. | |
cecd72d5 | 955 | |
dde1e152 | 956 | @item @code{private-key} (default: @file{~root/.ssh/id_rsa}) |
21531add LC |
957 | The SSH private key file to use when connecting to the machine, in |
958 | OpenSSH format. | |
49e6291a | 959 | |
dde1e152 OP |
960 | Note that the default value is the private key @emph{of the root |
961 | account}. Make sure it exists if you use the default. | |
962 | ||
1d48cf94 LC |
963 | @item @code{compression} (default: @code{"zlib@@openssh.com,zlib"}) |
964 | @itemx @code{compression-level} (default: @code{3}) | |
965 | The SSH-level compression methods and compression level requested. | |
966 | ||
967 | Note that offloading relies on SSH compression to reduce bandwidth usage | |
968 | when transferring files to and from build machines. | |
969 | ||
cf283dd9 LC |
970 | @item @code{daemon-socket} (default: @code{"/var/guix/daemon-socket/socket"}) |
971 | File name of the Unix-domain socket @command{guix-daemon} is listening | |
972 | to on that machine. | |
c4fdfd6f | 973 | |
21531add LC |
974 | @item @code{parallel-builds} (default: @code{1}) |
975 | The number of builds that may run in parallel on the machine. | |
49e6291a | 976 | |
21531add | 977 | @item @code{speed} (default: @code{1.0}) |
49e6291a LC |
978 | A ``relative speed factor''. The offload scheduler will tend to prefer |
979 | machines with a higher speed factor. | |
980 | ||
21531add | 981 | @item @code{features} (default: @code{'()}) |
49e6291a LC |
982 | A list of strings denoting specific features supported by the machine. |
983 | An example is @code{"kvm"} for machines that have the KVM Linux modules | |
984 | and corresponding hardware support. Derivations can request features by | |
985 | name, and they will be scheduled on matching build machines. | |
986 | ||
987 | @end table | |
c678a4ee | 988 | @end deftp |
49e6291a | 989 | |
aebaee95 LC |
990 | The @code{guile} command must be in the search path on the build |
991 | machines. In addition, the Guix modules must be in | |
c4fdfd6f LC |
992 | @code{$GUILE_LOAD_PATH} on the build machine---you can check whether |
993 | this is the case by running: | |
994 | ||
995 | @example | |
21531add | 996 | ssh build-machine guile -c "'(use-modules (guix config))'" |
c4fdfd6f | 997 | @end example |
49e6291a | 998 | |
f97c9175 | 999 | There is one last thing to do once @file{machines.scm} is in place. As |
49e6291a | 1000 | explained above, when offloading, files are transferred back and forth |
c4fdfd6f LC |
1001 | between the machine stores. For this to work, you first need to |
1002 | generate a key pair on each machine to allow the daemon to export signed | |
1003 | archives of files from the store (@pxref{Invoking guix archive}): | |
49e6291a LC |
1004 | |
1005 | @example | |
1006 | # guix archive --generate-key | |
1007 | @end example | |
1008 | ||
1009 | @noindent | |
c4fdfd6f LC |
1010 | Each build machine must authorize the key of the master machine so that |
1011 | it accepts store items it receives from the master: | |
1012 | ||
1013 | @example | |
1014 | # guix archive --authorize < master-public-key.txt | |
1015 | @end example | |
1016 | ||
1017 | @noindent | |
1018 | Likewise, the master machine must authorize the key of each build machine. | |
1019 | ||
1020 | All the fuss with keys is here to express pairwise mutual trust | |
1021 | relations between the master and the build machines. Concretely, when | |
1022 | the master receives files from a build machine (and @i{vice versa}), its | |
1023 | build daemon can make sure they are genuine, have not been tampered | |
1024 | with, and that they are signed by an authorized key. | |
49e6291a | 1025 | |
aebaee95 LC |
1026 | @cindex offload test |
1027 | To test whether your setup is operational, run this command on the | |
1028 | master node: | |
1029 | ||
1030 | @example | |
1031 | # guix offload test | |
1032 | @end example | |
1033 | ||
1034 | This will attempt to connect to each of the build machines specified in | |
1035 | @file{/etc/guix/machines.scm}, make sure Guile and the Guix modules are | |
1036 | available on each machine, attempt to export to the machine and import | |
1037 | from it, and report any error in the process. | |
1038 | ||
1039 | If you want to test a different machine file, just specify it on the | |
1040 | command line: | |
1041 | ||
1042 | @example | |
1043 | # guix offload test machines-qualif.scm | |
1044 | @end example | |
1045 | ||
27991c97 LC |
1046 | Last, you can test the subset of the machines whose name matches a |
1047 | regular expression like this: | |
1048 | ||
1049 | @example | |
1050 | # guix offload test machines.scm '\.gnu\.org$' | |
1051 | @end example | |
49e6291a | 1052 | |
bd5e766b LC |
1053 | @node Invoking guix-daemon |
1054 | @section Invoking @command{guix-daemon} | |
1055 | ||
1056 | The @command{guix-daemon} program implements all the functionality to | |
1057 | access the store. This includes launching build processes, running the | |
1058 | garbage collector, querying the availability of a build result, etc. It | |
1059 | is normally run as @code{root} like this: | |
1060 | ||
1061 | @example | |
cfc149dc | 1062 | # guix-daemon --build-users-group=guixbuild |
bd5e766b LC |
1063 | @end example |
1064 | ||
1065 | @noindent | |
081145cf | 1066 | For details on how to set it up, @pxref{Setting Up the Daemon}. |
bd5e766b | 1067 | |
e900c503 LC |
1068 | @cindex chroot |
1069 | @cindex container, build environment | |
1070 | @cindex build environment | |
1071 | @cindex reproducible builds | |
bd5e766b LC |
1072 | By default, @command{guix-daemon} launches build processes under |
1073 | different UIDs, taken from the build group specified with | |
1074 | @code{--build-users-group}. In addition, each build process is run in a | |
1075 | chroot environment that only contains the subset of the store that the | |
1076 | build process depends on, as specified by its derivation | |
1077 | (@pxref{Programming Interface, derivation}), plus a set of specific | |
1078 | system directories. By default, the latter contains @file{/dev} and | |
e900c503 LC |
1079 | @file{/dev/pts}. Furthermore, on GNU/Linux, the build environment is a |
1080 | @dfn{container}: in addition to having its own file system tree, it has | |
1081 | a separate mount name space, its own PID name space, network name space, | |
1082 | etc. This helps achieve reproducible builds (@pxref{Features}). | |
bd5e766b | 1083 | |
cbc538fe LC |
1084 | When the daemon performs a build on behalf of the user, it creates a |
1085 | build directory under @file{/tmp} or under the directory specified by | |
1086 | its @code{TMPDIR} environment variable; this directory is shared with | |
1087 | the container for the duration of the build. Be aware that using a | |
1088 | directory other than @file{/tmp} can affect build results---for example, | |
1089 | with a longer directory name, a build process that uses Unix-domain | |
1090 | sockets might hit the name length limitation for @code{sun_path}, which | |
1091 | it would otherwise not hit. | |
1092 | ||
1093 | The build directory is automatically deleted upon completion, unless the | |
1094 | build failed and the client specified @option{--keep-failed} | |
1095 | (@pxref{Invoking guix build, @option{--keep-failed}}). | |
1096 | ||
bd5e766b LC |
1097 | The following command-line options are supported: |
1098 | ||
1099 | @table @code | |
1100 | @item --build-users-group=@var{group} | |
1101 | Take users from @var{group} to run build processes (@pxref{Setting Up | |
1102 | the Daemon, build users}). | |
1103 | ||
6858f9d1 | 1104 | @item --no-substitutes |
b5385b52 | 1105 | @cindex substitutes |
6858f9d1 | 1106 | Do not use substitutes for build products. That is, always build things |
c4202d60 LC |
1107 | locally instead of allowing downloads of pre-built binaries |
1108 | (@pxref{Substitutes}). | |
6858f9d1 | 1109 | |
b5385b52 LC |
1110 | By default substitutes are used, unless the client---such as the |
1111 | @command{guix package} command---is explicitly invoked with | |
1112 | @code{--no-substitutes}. | |
1113 | ||
1114 | When the daemon runs with @code{--no-substitutes}, clients can still | |
1115 | explicitly enable substitution @i{via} the @code{set-build-options} | |
1116 | remote procedure call (@pxref{The Store}). | |
1117 | ||
9176607e | 1118 | @item --substitute-urls=@var{urls} |
f8a8e0fe | 1119 | @anchor{daemon-substitute-urls} |
9176607e | 1120 | Consider @var{urls} the default whitespace-separated list of substitute |
df061d07 LC |
1121 | source URLs. When this option is omitted, |
1122 | @indicateurl{https://mirror.hydra.gnu.org https://hydra.gnu.org} is used | |
1123 | (@code{mirror.hydra.gnu.org} is a mirror of @code{hydra.gnu.org}). | |
9176607e LC |
1124 | |
1125 | This means that substitutes may be downloaded from @var{urls}, as long | |
1126 | as they are signed by a trusted signature (@pxref{Substitutes}). | |
1127 | ||
4ec2e92d LC |
1128 | @cindex build hook |
1129 | @item --no-build-hook | |
1130 | Do not use the @dfn{build hook}. | |
1131 | ||
1132 | The build hook is a helper program that the daemon can start and to | |
1133 | which it submits build requests. This mechanism is used to offload | |
1134 | builds to other machines (@pxref{Daemon Offload Setup}). | |
1135 | ||
bd5e766b LC |
1136 | @item --cache-failures |
1137 | Cache build failures. By default, only successful builds are cached. | |
1138 | ||
30d9aa54 LC |
1139 | When this option is used, @command{guix gc --list-failures} can be used |
1140 | to query the set of store items marked as failed; @command{guix gc | |
1141 | --clear-failures} removes store items from the set of cached failures. | |
1142 | @xref{Invoking guix gc}. | |
1143 | ||
bd5e766b LC |
1144 | @item --cores=@var{n} |
1145 | @itemx -c @var{n} | |
1146 | Use @var{n} CPU cores to build each derivation; @code{0} means as many | |
1147 | as available. | |
1148 | ||
6efc160e | 1149 | The default value is @code{0}, but it may be overridden by clients, such |
e49951eb MW |
1150 | as the @code{--cores} option of @command{guix build} (@pxref{Invoking |
1151 | guix build}). | |
bd5e766b LC |
1152 | |
1153 | The effect is to define the @code{NIX_BUILD_CORES} environment variable | |
1154 | in the build process, which can then use it to exploit internal | |
1155 | parallelism---for instance, by running @code{make -j$NIX_BUILD_CORES}. | |
1156 | ||
1157 | @item --max-jobs=@var{n} | |
1158 | @itemx -M @var{n} | |
1159 | Allow at most @var{n} build jobs in parallel. The default value is | |
f6526eb3 LC |
1160 | @code{1}. Setting it to @code{0} means that no builds will be performed |
1161 | locally; instead, the daemon will offload builds (@pxref{Daemon Offload | |
1162 | Setup}), or simply fail. | |
bd5e766b | 1163 | |
2ca9f51e LC |
1164 | @item --max-silent-time=@var{seconds} |
1165 | When the build or substitution process remains silent for more than | |
1166 | @var{seconds}, terminate it and report a build failure. | |
1167 | ||
1168 | The default value is @code{0}, which disables the timeout. | |
1169 | ||
1170 | The value specified here can be overridden by clients (@pxref{Common | |
1171 | Build Options, @code{--max-silent-time}}). | |
1172 | ||
1173 | @item --timeout=@var{seconds} | |
1174 | Likewise, when the build or substitution process lasts for more than | |
1175 | @var{seconds}, terminate it and report a build failure. | |
1176 | ||
1177 | The default value is @code{0}, which disables the timeout. | |
1178 | ||
1179 | The value specified here can be overridden by clients (@pxref{Common | |
1180 | Build Options, @code{--timeout}}). | |
1181 | ||
ecf84b7c LC |
1182 | @item --rounds=@var{N} |
1183 | Build each derivation @var{n} times in a row, and raise an error if | |
1184 | consecutive build results are not bit-for-bit identical. Note that this | |
1185 | setting can be overridden by clients such as @command{guix build} | |
1186 | (@pxref{Invoking guix build}). | |
1187 | ||
b4528110 ED |
1188 | When used in conjunction with @option{--keep-failed}, the differing |
1189 | output is kept in the store, under @file{/gnu/store/@dots{}-check}. | |
1190 | This makes it easy to look for differences between the two results. | |
1191 | ||
bd5e766b LC |
1192 | @item --debug |
1193 | Produce debugging output. | |
1194 | ||
1195 | This is useful to debug daemon start-up issues, but then it may be | |
1196 | overridden by clients, for example the @code{--verbosity} option of | |
e49951eb | 1197 | @command{guix build} (@pxref{Invoking guix build}). |
bd5e766b LC |
1198 | |
1199 | @item --chroot-directory=@var{dir} | |
1200 | Add @var{dir} to the build chroot. | |
1201 | ||
1202 | Doing this may change the result of build processes---for instance if | |
1203 | they use optional dependencies found in @var{dir} when it is available, | |
1204 | and not otherwise. For that reason, it is not recommended to do so. | |
1205 | Instead, make sure that each derivation declares all the inputs that it | |
1206 | needs. | |
1207 | ||
1208 | @item --disable-chroot | |
1209 | Disable chroot builds. | |
1210 | ||
1211 | Using this option is not recommended since, again, it would allow build | |
1e2644bb LC |
1212 | processes to gain access to undeclared dependencies. It is necessary, |
1213 | though, when @command{guix-daemon} is running under an unprivileged user | |
1214 | account. | |
bd5e766b LC |
1215 | |
1216 | @item --disable-log-compression | |
1217 | Disable compression of the build logs. | |
1218 | ||
1da983b9 LC |
1219 | Unless @code{--lose-logs} is used, all the build logs are kept in the |
1220 | @var{localstatedir}. To save space, the daemon automatically compresses | |
1221 | them with bzip2 by default. This option disables that. | |
1222 | ||
ab3893d7 LC |
1223 | @item --disable-deduplication |
1224 | @cindex deduplication | |
bd5e766b LC |
1225 | Disable automatic file ``deduplication'' in the store. |
1226 | ||
1da983b9 | 1227 | By default, files added to the store are automatically ``deduplicated'': |
ab3893d7 LC |
1228 | if a newly added file is identical to another one found in the store, |
1229 | the daemon makes the new file a hard link to the other file. This can | |
4988dd40 | 1230 | noticeably reduce disk usage, at the expense of slightly increased |
ab3893d7 LC |
1231 | input/output load at the end of a build process. This option disables |
1232 | this optimization. | |
1da983b9 | 1233 | |
6e37066e LC |
1234 | @item --gc-keep-outputs[=yes|no] |
1235 | Tell whether the garbage collector (GC) must keep outputs of live | |
1236 | derivations. | |
1237 | ||
1238 | When set to ``yes'', the GC will keep the outputs of any live derivation | |
1239 | available in the store---the @code{.drv} files. The default is ``no'', | |
1240 | meaning that derivation outputs are kept only if they are GC roots. | |
1241 | ||
1242 | @item --gc-keep-derivations[=yes|no] | |
1243 | Tell whether the garbage collector (GC) must keep derivations | |
1244 | corresponding to live outputs. | |
1245 | ||
1246 | When set to ``yes'', as is the case by default, the GC keeps | |
1247 | derivations---i.e., @code{.drv} files---as long as at least one of their | |
1248 | outputs is live. This allows users to keep track of the origins of | |
1249 | items in their store. Setting it to ``no'' saves a bit of disk space. | |
1250 | ||
1251 | Note that when both @code{--gc-keep-derivations} and | |
1252 | @code{--gc-keep-outputs} are used, the effect is to keep all the build | |
1253 | prerequisites (the sources, compiler, libraries, and other build-time | |
1254 | tools) of live objects in the store, regardless of whether these | |
1255 | prerequisites are live. This is convenient for developers since it | |
1256 | saves rebuilds or downloads. | |
1257 | ||
bd5e766b LC |
1258 | @item --impersonate-linux-2.6 |
1259 | On Linux-based systems, impersonate Linux 2.6. This means that the | |
1260 | kernel's @code{uname} system call will report 2.6 as the release number. | |
1261 | ||
1262 | This might be helpful to build programs that (usually wrongfully) depend | |
1263 | on the kernel version number. | |
1264 | ||
1265 | @item --lose-logs | |
1266 | Do not keep build logs. By default they are kept under | |
ce33631f | 1267 | @code{@var{localstatedir}/guix/log}. |
bd5e766b LC |
1268 | |
1269 | @item --system=@var{system} | |
1270 | Assume @var{system} as the current system type. By default it is the | |
1271 | architecture/kernel pair found at configure time, such as | |
1272 | @code{x86_64-linux}. | |
b8d2aa26 | 1273 | |
1071f781 LC |
1274 | @item --listen=@var{endpoint} |
1275 | Listen for connections on @var{endpoint}. @var{endpoint} is interpreted | |
1276 | as the file name of a Unix-domain socket if it starts with | |
1277 | @code{/} (slash sign). Otherwise, @var{endpoint} is interpreted as a | |
1278 | host name or host name and port to listen to. Here are a few examples: | |
1279 | ||
1280 | @table @code | |
1281 | @item --listen=/gnu/var/daemon | |
1282 | Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, | |
1283 | creating it if needed. | |
1284 | ||
1285 | @item --listen=localhost | |
1286 | @cindex daemon, remote access | |
1287 | @cindex remote access to the daemon | |
1288 | @cindex daemon, cluster setup | |
1289 | @cindex clusters, daemon setup | |
1290 | Listen for TCP connections on the network interface corresponding to | |
1291 | @code{localhost}, on port 44146. | |
1292 | ||
1293 | @item --listen=128.0.0.42:1234 | |
1294 | Listen for TCP connections on the network interface corresponding to | |
1295 | @code{128.0.0.42}, on port 1234. | |
1296 | @end table | |
1297 | ||
1298 | This option can be repeated multiple times, in which case | |
1299 | @command{guix-daemon} accepts connections on all the specified | |
1300 | endpoints. Users can tell client commands what endpoint to connect to | |
1301 | by setting the @code{GUIX_DAEMON_SOCKET} environment variable | |
1302 | (@pxref{The Store, @code{GUIX_DAEMON_SOCKET}}). | |
1303 | ||
1304 | @quotation Note | |
1305 | The daemon protocol is @emph{unauthenticated and unencrypted}. Using | |
1306 | @code{--listen=@var{host}} is suitable on local networks, such as | |
1307 | clusters, where only trusted nodes may connect to the build daemon. In | |
1308 | other cases where remote access to the daemon is needed, we recommend | |
1309 | using Unix-domain sockets along with SSH. | |
1310 | @end quotation | |
1311 | ||
1312 | When @code{--listen} is omitted, @command{guix-daemon} listens for | |
1313 | connections on the Unix-domain socket located at | |
1314 | @file{@var{localstatedir}/daemon-socket/socket}. | |
bd5e766b LC |
1315 | @end table |
1316 | ||
1317 | ||
0e2d0213 LC |
1318 | @node Application Setup |
1319 | @section Application Setup | |
1320 | ||
d23ef788 | 1321 | @cindex foreign distro |
85e57214 LC |
1322 | When using Guix on top of GNU/Linux distribution other than GuixSD---a |
1323 | so-called @dfn{foreign distro}---a few additional steps are needed to | |
1324 | get everything in place. Here are some of them. | |
0e2d0213 LC |
1325 | |
1326 | @subsection Locales | |
1327 | ||
5c3c1427 | 1328 | @anchor{locales-and-locpath} |
0e2d0213 | 1329 | @cindex locales, when not on GuixSD |
5c3c1427 | 1330 | @vindex LOCPATH |
85e57214 | 1331 | @vindex GUIX_LOCPATH |
f97c9175 AE |
1332 | Packages installed @i{via} Guix will not use the locale data of the |
1333 | host system. Instead, you must first install one of the locale packages | |
85e57214 LC |
1334 | available with Guix and then define the @code{GUIX_LOCPATH} environment |
1335 | variable: | |
0e2d0213 LC |
1336 | |
1337 | @example | |
1338 | $ guix package -i glibc-locales | |
85e57214 | 1339 | $ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale |
0e2d0213 LC |
1340 | @end example |
1341 | ||
1342 | Note that the @code{glibc-locales} package contains data for all the | |
1343 | locales supported by the GNU@tie{}libc and weighs in at around | |
f97c9175 | 1344 | 110@tie{}MiB. Alternatively, the @code{glibc-utf8-locales} is smaller but |
0e2d0213 LC |
1345 | limited to a few UTF-8 locales. |
1346 | ||
85e57214 LC |
1347 | The @code{GUIX_LOCPATH} variable plays a role similar to @code{LOCPATH} |
1348 | (@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C Library Reference | |
1349 | Manual}). There are two important differences though: | |
1350 | ||
1351 | @enumerate | |
1352 | @item | |
f97c9175 | 1353 | @code{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc |
85e57214 | 1354 | provided by foreign distros. Thus, using @code{GUIX_LOCPATH} allows you |
f97c9175 | 1355 | to make sure the programs of the foreign distro will not end up loading |
85e57214 LC |
1356 | incompatible locale data. |
1357 | ||
1358 | @item | |
1359 | libc suffixes each entry of @code{GUIX_LOCPATH} with @code{/X.Y}, where | |
1360 | @code{X.Y} is the libc version---e.g., @code{2.22}. This means that, | |
1361 | should your Guix profile contain a mixture of programs linked against | |
1362 | different libc version, each libc version will only try to load locale | |
1363 | data in the right format. | |
1364 | @end enumerate | |
1365 | ||
1366 | This is important because the locale data format used by different libc | |
1367 | versions may be incompatible. | |
1368 | ||
9a5187b6 LC |
1369 | @subsection Name Service Switch |
1370 | ||
1371 | @cindex name service switch, glibc | |
1372 | @cindex NSS (name service switch), glibc | |
1373 | @cindex nscd (name service caching daemon) | |
1374 | @cindex name service caching daemon (nscd) | |
1375 | When using Guix on a foreign distro, we @emph{strongly recommend} that | |
1376 | the system run the GNU C library's @dfn{name service cache daemon}, | |
1377 | @command{nscd}, which should be listening on the | |
1378 | @file{/var/run/nscd/socket} socket. Failing to do that, applications | |
1379 | installed with Guix may fail to look up host names or user accounts, or | |
1380 | may even crash. The next paragraphs explain why. | |
1381 | ||
1382 | @cindex @file{nsswitch.conf} | |
1383 | The GNU C library implements a @dfn{name service switch} (NSS), which is | |
1384 | an extensible mechanism for ``name lookups'' in general: host name | |
1385 | resolution, user accounts, and more (@pxref{Name Service Switch,,, libc, | |
1386 | The GNU C Library Reference Manual}). | |
1387 | ||
1388 | @cindex Network information service (NIS) | |
1389 | @cindex NIS (Network information service) | |
1390 | Being extensible, the NSS supports @dfn{plugins}, which provide new name | |
1391 | lookup implementations: for example, the @code{nss-mdns} plugin allow | |
1392 | resolution of @code{.local} host names, the @code{nis} plugin allows | |
1393 | user account lookup using the Network information service (NIS), and so | |
1394 | on. These extra ``lookup services'' are configured system-wide in | |
1395 | @file{/etc/nsswitch.conf}, and all the programs running on the system | |
1396 | honor those settings (@pxref{NSS Configuration File,,, libc, The GNU C | |
1397 | Reference Manual}). | |
1398 | ||
1399 | When they perform a name lookup---for instance by calling the | |
1400 | @code{getaddrinfo} function in C---applications first try to connect to | |
1401 | the nscd; on success, nscd performs name lookups on their behalf. If | |
1402 | the nscd is not running, then they perform the name lookup by | |
1403 | themselves, by loading the name lookup services into their own address | |
1404 | space and running it. These name lookup services---the | |
1405 | @file{libnss_*.so} files---are @code{dlopen}'d, but they may come from | |
1406 | the host system's C library, rather than from the C library the | |
1407 | application is linked against (the C library coming from Guix). | |
1408 | ||
1409 | And this is where the problem is: if your application is linked against | |
1410 | Guix's C library (say, glibc 2.24) and tries to load NSS plugins from | |
1411 | another C library (say, @code{libnss_mdns.so} for glibc 2.22), it will | |
1412 | likely crash or have its name lookups fail unexpectedly. | |
1413 | ||
1414 | Running @command{nscd} on the system, among other advantages, eliminates | |
1415 | this binary incompatibility problem because those @code{libnss_*.so} | |
1416 | files are loaded in the @command{nscd} process, not in applications | |
1417 | themselves. | |
1418 | ||
0e2d0213 LC |
1419 | @subsection X11 Fonts |
1420 | ||
e32171ee | 1421 | @cindex fonts |
4988dd40 | 1422 | The majority of graphical applications use Fontconfig to locate and |
f97c9175 AE |
1423 | load fonts and perform X11-client-side rendering. The @code{fontconfig} |
1424 | package in Guix looks for fonts in @file{$HOME/.guix-profile} | |
0e2d0213 | 1425 | by default. Thus, to allow graphical applications installed with Guix |
f97c9175 | 1426 | to display fonts, you have to install fonts with Guix as well. |
0e2d0213 | 1427 | Essential font packages include @code{gs-fonts}, @code{font-dejavu}, and |
8fe5b1d1 | 1428 | @code{font-gnu-freefont-ttf}. |
0e2d0213 | 1429 | |
5c36edc8 LC |
1430 | To display text written in Chinese languages, Japanese, or Korean in |
1431 | graphical applications, consider installing | |
1432 | @code{font-adobe-source-han-sans} or @code{font-wqy-zenhei}. The former | |
1433 | has multiple outputs, one per language family (@pxref{Packages with | |
1434 | Multiple Outputs}). For instance, the following command installs fonts | |
1435 | for Chinese languages: | |
1436 | ||
1437 | @example | |
1438 | guix package -i font-adobe-source-han-sans:cn | |
1439 | @end example | |
1440 | ||
e32171ee | 1441 | @cindex @code{xterm} |
1a3e6b15 AK |
1442 | Older programs such as @command{xterm} do not use Fontconfig and instead |
1443 | rely on server-side font rendering. Such programs require to specify a | |
1444 | full name of a font using XLFD (X Logical Font Description), like this: | |
1445 | ||
1446 | @example | |
1447 | -*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1 | |
1448 | @end example | |
1449 | ||
1450 | To be able to use such full names for the TrueType fonts installed in | |
1451 | your Guix profile, you need to extend the font path of the X server: | |
1452 | ||
1453 | @example | |
1454 | xset +fp ~/.guix-profile/share/fonts/truetype | |
1455 | @end example | |
1456 | ||
e32171ee | 1457 | @cindex @code{xlsfonts} |
1a3e6b15 AK |
1458 | After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) |
1459 | to make sure your TrueType fonts are listed there. | |
1460 | ||
e5942cbf RW |
1461 | @cindex @code{fc-cache} |
1462 | @cindex font cache | |
1463 | After installing fonts you may have to refresh the font cache to use | |
1464 | them in applications. The same applies when applications installed via | |
1465 | Guix do not seem to find fonts. To force rebuilding of the font cache | |
1466 | run @code{fc-cache -f}. The @code{fc-cache} command is provided by the | |
1467 | @code{fontconfig} package. | |
1468 | ||
b3129f2b LC |
1469 | @subsection X.509 Certificates |
1470 | ||
e32171ee | 1471 | @cindex @code{nss-certs} |
b3129f2b LC |
1472 | The @code{nss-certs} package provides X.509 certificates, which allow |
1473 | programs to authenticate Web servers accessed over HTTPS. | |
1474 | ||
1475 | When using Guix on a foreign distro, you can install this package and | |
1476 | define the relevant environment variables so that packages know where to | |
80d944b7 | 1477 | look for certificates. @xref{X.509 Certificates}, for detailed |
b3129f2b LC |
1478 | information. |
1479 | ||
6d97319c AK |
1480 | @subsection Emacs Packages |
1481 | ||
e32171ee | 1482 | @cindex @code{emacs} |
6d97319c AK |
1483 | When you install Emacs packages with Guix, the elisp files may be placed |
1484 | either in @file{$HOME/.guix-profile/share/emacs/site-lisp/} or in | |
1485 | sub-directories of | |
1486 | @file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/}. The latter | |
1487 | directory exists because potentially there may exist thousands of Emacs | |
1488 | packages and storing all their files in a single directory may be not | |
1489 | reliable (because of name conflicts). So we think using a separate | |
1490 | directory for each package is a good idea. It is very similar to how | |
1491 | the Emacs package system organizes the file structure (@pxref{Package | |
1492 | Files,,, emacs, The GNU Emacs Manual}). | |
1493 | ||
1494 | By default, Emacs (installed with Guix) ``knows'' where these packages | |
f97c9175 | 1495 | are placed, so you do not need to perform any configuration. If, for |
6d97319c | 1496 | some reason, you want to avoid auto-loading Emacs packages installed |
f97c9175 | 1497 | with Guix, you can do so by running Emacs with @code{--no-site-file} |
6d97319c AK |
1498 | option (@pxref{Init File,,, emacs, The GNU Emacs Manual}). |
1499 | ||
2f0c4b82 RW |
1500 | @subsection The GCC toolchain |
1501 | ||
1502 | @cindex GCC | |
1503 | @cindex ld-wrapper | |
1504 | ||
1505 | Guix offers individual compiler packages such as @code{gcc} but if you | |
1506 | are in need of a complete toolchain for compiling and linking source | |
1507 | code what you really want is the @code{gcc-toolchain} package. This | |
1508 | package provides a complete GCC toolchain for C/C++ development, | |
1509 | including GCC itself, the GNU C Library (headers and binaries, plus | |
1510 | debugging symbols in the @code{debug} output), Binutils, and a linker | |
1511 | wrapper. | |
1512 | ||
1513 | @cindex attempt to use impure library, error message | |
1514 | ||
1515 | The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches | |
1516 | passed to the linker, add corresponding @code{-rpath} arguments, and | |
1517 | invoke the actual linker with this new set of arguments. By default, | |
1518 | the linker wrapper refuses to link to libraries outside the store to | |
1519 | ensure ``purity''. This can be annoying when using the toolchain to | |
1520 | link with local libraries. To allow references to libraries outside the | |
1521 | store you need to define the environment variable | |
1522 | @code{GUIX_LD_WRAPPER_ALLOW_IMPURITIES}. | |
1523 | ||
0e2d0213 LC |
1524 | @c TODO What else? |
1525 | ||
eeaf4427 LC |
1526 | @c ********************************************************************* |
1527 | @node Package Management | |
1528 | @chapter Package Management | |
1529 | ||
e32171ee | 1530 | @cindex packages |
f8348b91 | 1531 | The purpose of GNU Guix is to allow users to easily install, upgrade, and |
eeaf4427 | 1532 | remove software packages, without having to know about their build |
f97c9175 | 1533 | procedures or dependencies. Guix also goes beyond this obvious set of |
eeaf4427 LC |
1534 | features. |
1535 | ||
8ca0c88a AK |
1536 | This chapter describes the main features of Guix, as well as the |
1537 | package management tools it provides. Along with the command-line | |
1538 | interface described below (@pxref{Invoking guix package, @code{guix | |
1539 | package}}), you may also use Emacs Interface (@pxref{Top,,, | |
1540 | emacs-guix, The Emacs-Guix Reference Manual}), after installing | |
1541 | @code{emacs-guix} package (run @kbd{M-x guix-help} command to start | |
1542 | with it): | |
deb6276d AK |
1543 | |
1544 | @example | |
1545 | guix package -i emacs-guix | |
1546 | @end example | |
eeaf4427 LC |
1547 | |
1548 | @menu | |
1549 | * Features:: How Guix will make your life brighter. | |
e49951eb | 1550 | * Invoking guix package:: Package installation, removal, etc. |
c4202d60 | 1551 | * Substitutes:: Downloading pre-built binaries. |
760c60d6 | 1552 | * Packages with Multiple Outputs:: Single source package, multiple outputs. |
e49951eb | 1553 | * Invoking guix gc:: Running the garbage collector. |
f651b477 | 1554 | * Invoking guix pull:: Fetching the latest Guix and distribution. |
239c2266 | 1555 | * Invoking guix pack:: Creating software bundles. |
760c60d6 | 1556 | * Invoking guix archive:: Exporting and importing store files. |
eeaf4427 LC |
1557 | @end menu |
1558 | ||
1559 | @node Features | |
1560 | @section Features | |
1561 | ||
1562 | When using Guix, each package ends up in the @dfn{package store}, in its | |
1563 | own directory---something that resembles | |
deb6276d | 1564 | @file{/gnu/store/xxx-package-1.2}, where @code{xxx} is a base32 string. |
eeaf4427 LC |
1565 | |
1566 | Instead of referring to these directories, users have their own | |
1567 | @dfn{profile}, which points to the packages that they actually want to | |
821b0015 LC |
1568 | use. These profiles are stored within each user's home directory, at |
1569 | @code{$HOME/.guix-profile}. | |
eeaf4427 | 1570 | |
821b0015 | 1571 | For example, @code{alice} installs GCC 4.7.2. As a result, |
eeaf4427 | 1572 | @file{/home/alice/.guix-profile/bin/gcc} points to |
834129e0 | 1573 | @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Now, on the same machine, |
821b0015 LC |
1574 | @code{bob} had already installed GCC 4.8.0. The profile of @code{bob} |
1575 | simply continues to point to | |
834129e0 | 1576 | @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC |
821b0015 | 1577 | coexist on the same system without any interference. |
eeaf4427 | 1578 | |
e49951eb | 1579 | The @command{guix package} command is the central tool to manage |
f97c9175 | 1580 | packages (@pxref{Invoking guix package}). It operates on the per-user |
821b0015 | 1581 | profiles, and can be used @emph{with normal user privileges}. |
eeaf4427 | 1582 | |
e32171ee | 1583 | @cindex transactions |
eeaf4427 LC |
1584 | The command provides the obvious install, remove, and upgrade |
1585 | operations. Each invocation is actually a @emph{transaction}: either | |
ba55b1cb | 1586 | the specified operation succeeds, or nothing happens. Thus, if the |
e49951eb | 1587 | @command{guix package} process is terminated during the transaction, |
eeaf4427 LC |
1588 | or if a power outage occurs during the transaction, then the user's |
1589 | profile remains in its previous state, and remains usable. | |
1590 | ||
1591 | In addition, any package transaction may be @emph{rolled back}. So, if, | |
1592 | for example, an upgrade installs a new version of a package that turns | |
1593 | out to have a serious bug, users may roll back to the previous instance | |
4af2447e | 1594 | of their profile, which was known to work well. Similarly, the global |
6f773606 LC |
1595 | system configuration on GuixSD is subject to |
1596 | transactional upgrades and roll-back | |
4af2447e | 1597 | (@pxref{Using the Configuration System}). |
eeaf4427 | 1598 | |
f97c9175 AE |
1599 | All packages in the package store may be @emph{garbage-collected}. |
1600 | Guix can determine which packages are still referenced by user | |
fe8ff028 | 1601 | profiles, and remove those that are provably no longer referenced |
e49951eb | 1602 | (@pxref{Invoking guix gc}). Users may also explicitly remove old |
fe8ff028 LC |
1603 | generations of their profile so that the packages they refer to can be |
1604 | collected. | |
eeaf4427 | 1605 | |
e900c503 LC |
1606 | @cindex reproducibility |
1607 | @cindex reproducible builds | |
eeaf4427 LC |
1608 | Finally, Guix takes a @dfn{purely functional} approach to package |
1609 | management, as described in the introduction (@pxref{Introduction}). | |
834129e0 | 1610 | Each @file{/gnu/store} package directory name contains a hash of all the |
eeaf4427 LC |
1611 | inputs that were used to build that package---compiler, libraries, build |
1612 | scripts, etc. This direct correspondence allows users to make sure a | |
1613 | given package installation matches the current state of their | |
e900c503 LC |
1614 | distribution. It also helps maximize @dfn{build reproducibility}: |
1615 | thanks to the isolated build environments that are used, a given build | |
1616 | is likely to yield bit-identical files when performed on different | |
1617 | machines (@pxref{Invoking guix-daemon, container}). | |
eeaf4427 | 1618 | |
c4202d60 | 1619 | @cindex substitutes |
eeaf4427 | 1620 | This foundation allows Guix to support @dfn{transparent binary/source |
c4202d60 | 1621 | deployment}. When a pre-built binary for a @file{/gnu/store} item is |
18f2887b | 1622 | available from an external source---a @dfn{substitute}, Guix just |
c4202d60 LC |
1623 | downloads it and unpacks it; |
1624 | otherwise, it builds the package from source, locally | |
bf9eacd2 LC |
1625 | (@pxref{Substitutes}). Because build results are usually bit-for-bit |
1626 | reproducible, users do not have to trust servers that provide | |
1627 | substitutes: they can force a local build and @emph{challenge} providers | |
1628 | (@pxref{Invoking guix challenge}). | |
eeaf4427 | 1629 | |
f5fd4fd2 LC |
1630 | Control over the build environment is a feature that is also useful for |
1631 | developers. The @command{guix environment} command allows developers of | |
1632 | a package to quickly set up the right development environment for their | |
f97c9175 AE |
1633 | package, without having to manually install the dependencies of the |
1634 | package into their profile (@pxref{Invoking guix environment}). | |
f5fd4fd2 | 1635 | |
e49951eb MW |
1636 | @node Invoking guix package |
1637 | @section Invoking @command{guix package} | |
eeaf4427 | 1638 | |
e32171ee JD |
1639 | @cindex installing packages |
1640 | @cindex removing packages | |
1641 | @cindex package installation | |
1642 | @cindex package removal | |
e49951eb | 1643 | The @command{guix package} command is the tool that allows users to |
eeaf4427 LC |
1644 | install, upgrade, and remove packages, as well as rolling back to |
1645 | previous configurations. It operates only on the user's own profile, | |
1646 | and works with normal user privileges (@pxref{Features}). Its syntax | |
1647 | is: | |
1648 | ||
1649 | @example | |
e49951eb | 1650 | guix package @var{options} |
eeaf4427 | 1651 | @end example |
e32171ee | 1652 | @cindex transactions |
ba55b1cb | 1653 | Primarily, @var{options} specifies the operations to be performed during |
eeaf4427 | 1654 | the transaction. Upon completion, a new profile is created, but |
99bd74d5 | 1655 | previous @dfn{generations} of the profile remain available, should the user |
eeaf4427 LC |
1656 | want to roll back. |
1657 | ||
6447738c MW |
1658 | For example, to remove @code{lua} and install @code{guile} and |
1659 | @code{guile-cairo} in a single transaction: | |
1660 | ||
1661 | @example | |
1662 | guix package -r lua -i guile guile-cairo | |
1663 | @end example | |
1664 | ||
99bd74d5 LC |
1665 | @command{guix package} also supports a @dfn{declarative approach} |
1666 | whereby the user specifies the exact set of packages to be available and | |
1667 | passes it @i{via} the @option{--manifest} option | |
1668 | (@pxref{profile-manifest, @option{--manifest}}). | |
1669 | ||
e32171ee | 1670 | @cindex profile |
b9e5c0a9 | 1671 | For each user, a symlink to the user's default profile is automatically |
0ec1af59 | 1672 | created in @file{$HOME/.guix-profile}. This symlink always points to the |
b9e5c0a9 LC |
1673 | current generation of the user's default profile. Thus, users can add |
1674 | @file{$HOME/.guix-profile/bin} to their @code{PATH} environment | |
1675 | variable, and so on. | |
d664f1b4 LC |
1676 | @cindex search paths |
1677 | If you are not using the Guix System Distribution, consider adding the | |
1678 | following lines to your @file{~/.bash_profile} (@pxref{Bash Startup | |
1679 | Files,,, bash, The GNU Bash Reference Manual}) so that newly-spawned | |
1680 | shells get all the right environment variable definitions: | |
1681 | ||
1682 | @example | |
1683 | GUIX_PROFILE="$HOME/.guix-profile" \ | |
1684 | source "$HOME/.guix-profile/etc/profile" | |
1685 | @end example | |
b9e5c0a9 | 1686 | |
4379c35b LC |
1687 | In a multi-user setup, user profiles are stored in a place registered as |
1688 | a @dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points | |
1689 | to (@pxref{Invoking guix gc}). That directory is normally | |
0ec1af59 LC |
1690 | @code{@var{localstatedir}/profiles/per-user/@var{user}}, where |
1691 | @var{localstatedir} is the value passed to @code{configure} as | |
4379c35b LC |
1692 | @code{--localstatedir}, and @var{user} is the user name. The |
1693 | @file{per-user} directory is created when @command{guix-daemon} is | |
1694 | started, and the @var{user} sub-directory is created by @command{guix | |
1695 | package}. | |
0ec1af59 LC |
1696 | |
1697 | The @var{options} can be among the following: | |
1698 | ||
eeaf4427 LC |
1699 | @table @code |
1700 | ||
6447738c MW |
1701 | @item --install=@var{package} @dots{} |
1702 | @itemx -i @var{package} @dots{} | |
1703 | Install the specified @var{package}s. | |
eeaf4427 | 1704 | |
6447738c | 1705 | Each @var{package} may specify either a simple package name, such as |
1b846da8 ML |
1706 | @code{guile}, or a package name followed by an at-sign and version number, |
1707 | such as @code{guile@@1.8.8} or simply @code{guile@@1.8} (in the latter | |
724311a2 LC |
1708 | case, the newest version prefixed by @code{1.8} is selected.) |
1709 | ||
1710 | If no version number is specified, the | |
dc5669cd MW |
1711 | newest available version will be selected. In addition, @var{package} |
1712 | may contain a colon, followed by the name of one of the outputs of the | |
1b846da8 | 1713 | package, as in @code{gcc:doc} or @code{binutils@@2.22:lib} |
e7f34eb0 LC |
1714 | (@pxref{Packages with Multiple Outputs}). Packages with a corresponding |
1715 | name (and optionally version) are searched for among the GNU | |
1716 | distribution modules (@pxref{Package Modules}). | |
eeaf4427 | 1717 | |
461572cc LC |
1718 | @cindex propagated inputs |
1719 | Sometimes packages have @dfn{propagated inputs}: these are dependencies | |
21461f27 LC |
1720 | that automatically get installed along with the required package |
1721 | (@pxref{package-propagated-inputs, @code{propagated-inputs} in | |
1722 | @code{package} objects}, for information about propagated inputs in | |
1723 | package definitions). | |
461572cc | 1724 | |
21461f27 | 1725 | @anchor{package-cmd-propagated-inputs} |
461572cc LC |
1726 | An example is the GNU MPC library: its C header files refer to those of |
1727 | the GNU MPFR library, which in turn refer to those of the GMP library. | |
1728 | Thus, when installing MPC, the MPFR and GMP libraries also get installed | |
1729 | in the profile; removing MPC also removes MPFR and GMP---unless they had | |
f97c9175 | 1730 | also been explicitly installed by the user. |
461572cc | 1731 | |
ba7ea5ce | 1732 | Besides, packages sometimes rely on the definition of environment |
5924080d | 1733 | variables for their search paths (see explanation of |
ba7ea5ce | 1734 | @code{--search-paths} below). Any missing or possibly incorrect |
5924080d LC |
1735 | environment variable definitions are reported here. |
1736 | ||
5d4b411f LC |
1737 | @item --install-from-expression=@var{exp} |
1738 | @itemx -e @var{exp} | |
1739 | Install the package @var{exp} evaluates to. | |
1740 | ||
1741 | @var{exp} must be a Scheme expression that evaluates to a | |
1742 | @code{<package>} object. This option is notably useful to disambiguate | |
1743 | between same-named variants of a package, with expressions such as | |
1744 | @code{(@@ (gnu packages base) guile-final)}. | |
1745 | ||
1746 | Note that this option installs the first output of the specified | |
1747 | package, which may be insufficient when needing a specific output of a | |
1748 | multiple-output package. | |
1749 | ||
0d279400 DT |
1750 | @item --install-from-file=@var{file} |
1751 | @itemx -f @var{file} | |
1752 | Install the package that the code within @var{file} evaluates to. | |
1753 | ||
1754 | As an example, @var{file} might contain a definition like this | |
1755 | (@pxref{Defining Packages}): | |
1756 | ||
1757 | @example | |
1758 | @verbatiminclude package-hello.scm | |
1759 | @end example | |
1760 | ||
baacf042 | 1761 | Developers may find it useful to include such a @file{guix.scm} file |
f97c9175 | 1762 | in the root of their project source tree that can be used to test |
0d279400 DT |
1763 | development snapshots and create reproducible development environments |
1764 | (@pxref{Invoking guix environment}). | |
1765 | ||
6447738c MW |
1766 | @item --remove=@var{package} @dots{} |
1767 | @itemx -r @var{package} @dots{} | |
1768 | Remove the specified @var{package}s. | |
eeaf4427 | 1769 | |
6447738c | 1770 | As for @code{--install}, each @var{package} may specify a version number |
13ed095c LC |
1771 | and/or output name in addition to the package name. For instance, |
1772 | @code{-r glibc:debug} would remove the @code{debug} output of | |
1773 | @code{glibc}. | |
1774 | ||
6447738c MW |
1775 | @item --upgrade[=@var{regexp} @dots{}] |
1776 | @itemx -u [@var{regexp} @dots{}] | |
e32171ee | 1777 | @cindex upgrading packages |
6447738c MW |
1778 | Upgrade all the installed packages. If one or more @var{regexp}s are |
1779 | specified, upgrade only installed packages whose name matches a | |
d5f01e48 | 1780 | @var{regexp}. Also see the @code{--do-not-upgrade} option below. |
eeaf4427 | 1781 | |
f651b477 LC |
1782 | Note that this upgrades package to the latest version of packages found |
1783 | in the distribution currently installed. To update your distribution, | |
1784 | you should regularly run @command{guix pull} (@pxref{Invoking guix | |
1785 | pull}). | |
1786 | ||
d5f01e48 MW |
1787 | @item --do-not-upgrade[=@var{regexp} @dots{}] |
1788 | When used together with the @code{--upgrade} option, do @emph{not} | |
1789 | upgrade any packages whose name matches a @var{regexp}. For example, to | |
1790 | upgrade all packages in the current profile except those containing the | |
1791 | substring ``emacs'': | |
1792 | ||
1793 | @example | |
1794 | $ guix package --upgrade . --do-not-upgrade emacs | |
1795 | @end example | |
1796 | ||
99bd74d5 | 1797 | @item @anchor{profile-manifest}--manifest=@var{file} |
1b676447 | 1798 | @itemx -m @var{file} |
99bd74d5 LC |
1799 | @cindex profile declaration |
1800 | @cindex profile manifest | |
1801 | Create a new generation of the profile from the manifest object | |
1b676447 DT |
1802 | returned by the Scheme code in @var{file}. |
1803 | ||
99bd74d5 LC |
1804 | This allows you to @emph{declare} the profile's contents rather than |
1805 | constructing it through a sequence of @code{--install} and similar | |
1806 | commands. The advantage is that @var{file} can be put under version | |
1807 | control, copied to different machines to reproduce the same profile, and | |
1808 | so on. | |
1809 | ||
1810 | @c FIXME: Add reference to (guix profile) documentation when available. | |
1811 | @var{file} must return a @dfn{manifest} object, which is roughly a list | |
1812 | of packages: | |
1b676447 | 1813 | |
99bd74d5 | 1814 | @findex packages->manifest |
1b676447 | 1815 | @example |
99bd74d5 | 1816 | (use-package-modules guile emacs) |
1b676447 DT |
1817 | |
1818 | (packages->manifest | |
99bd74d5 LC |
1819 | (list emacs |
1820 | guile-2.0 | |
1b676447 | 1821 | ;; Use a specific package output. |
99bd74d5 | 1822 | (list guile-2.0 "debug"))) |
1b676447 DT |
1823 | @end example |
1824 | ||
c08ea55e | 1825 | @findex specifications->manifest |
6cd10593 LC |
1826 | In this example we have to know which modules define the @code{emacs} |
1827 | and @code{guile-2.0} variables to provide the right | |
1828 | @code{use-package-modules} line, which can be cumbersome. We can | |
1829 | instead provide regular package specifications and let | |
c08ea55e | 1830 | @code{specifications->manifest} look up the corresponding package |
6cd10593 LC |
1831 | objects, like this: |
1832 | ||
1833 | @example | |
c08ea55e LC |
1834 | (specifications->manifest |
1835 | '("emacs" "guile@@2.2" "guile@@2.2:debug")) | |
6cd10593 LC |
1836 | @end example |
1837 | ||
24e262f0 | 1838 | @item --roll-back |
e32171ee JD |
1839 | @cindex rolling back |
1840 | @cindex undoing transactions | |
1841 | @cindex transactions, undoing | |
24e262f0 LC |
1842 | Roll back to the previous @dfn{generation} of the profile---i.e., undo |
1843 | the last transaction. | |
1844 | ||
1845 | When combined with options such as @code{--install}, roll back occurs | |
1846 | before any other actions. | |
1847 | ||
d9307267 | 1848 | When rolling back from the first generation that actually contains |
4b2bc804 | 1849 | installed packages, the profile is made to point to the @dfn{zeroth |
f97c9175 | 1850 | generation}, which contains no files apart from its own metadata. |
d9307267 | 1851 | |
f97c9175 AE |
1852 | After having rolled back, installing, removing, or upgrading packages |
1853 | overwrites previous future generations. Thus, the history of the | |
1854 | generations in a profile is always linear. | |
82fe08ed | 1855 | |
b3bb82f1 AK |
1856 | @item --switch-generation=@var{pattern} |
1857 | @itemx -S @var{pattern} | |
e32171ee | 1858 | @cindex generations |
b3bb82f1 AK |
1859 | Switch to a particular generation defined by @var{pattern}. |
1860 | ||
1861 | @var{pattern} may be either a generation number or a number prefixed | |
1862 | with ``+'' or ``-''. The latter means: move forward/backward by a | |
1863 | specified number of generations. For example, if you want to return to | |
1864 | the latest generation after @code{--roll-back}, use | |
1865 | @code{--switch-generation=+1}. | |
1866 | ||
1867 | The difference between @code{--roll-back} and | |
1868 | @code{--switch-generation=-1} is that @code{--switch-generation} will | |
1869 | not make a zeroth generation, so if a specified generation does not | |
1870 | exist, the current generation will not be changed. | |
1871 | ||
dbc31ab2 | 1872 | @item --search-paths[=@var{kind}] |
5924080d LC |
1873 | @cindex search paths |
1874 | Report environment variable definitions, in Bash syntax, that may be | |
1875 | needed in order to use the set of installed packages. These environment | |
1876 | variables are used to specify @dfn{search paths} for files used by some | |
1877 | of the installed packages. | |
1878 | ||
1879 | For example, GCC needs the @code{CPATH} and @code{LIBRARY_PATH} | |
1880 | environment variables to be defined so it can look for headers and | |
1881 | libraries in the user's profile (@pxref{Environment Variables,,, gcc, | |
1882 | Using the GNU Compiler Collection (GCC)}). If GCC and, say, the C | |
1883 | library are installed in the profile, then @code{--search-paths} will | |
1884 | suggest setting these variables to @code{@var{profile}/include} and | |
1885 | @code{@var{profile}/lib}, respectively. | |
1886 | ||
dbc31ab2 LC |
1887 | The typical use case is to define these environment variables in the |
1888 | shell: | |
1889 | ||
1890 | @example | |
1891 | $ eval `guix package --search-paths` | |
1892 | @end example | |
1893 | ||
1894 | @var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, | |
1895 | meaning that the returned environment variable definitions will either | |
1896 | be exact settings, or prefixes or suffixes of the current value of these | |
1897 | variables. When omitted, @var{kind} defaults to @code{exact}. | |
1898 | ||
fc2d2339 LC |
1899 | This option can also be used to compute the @emph{combined} search paths |
1900 | of several profiles. Consider this example: | |
1901 | ||
1902 | @example | |
1903 | $ guix package -p foo -i guile | |
1904 | $ guix package -p bar -i guile-json | |
1905 | $ guix package -p foo -p bar --search-paths | |
1906 | @end example | |
1907 | ||
1908 | The last command above reports about the @code{GUILE_LOAD_PATH} | |
1909 | variable, even though, taken individually, neither @file{foo} nor | |
1910 | @file{bar} would lead to that recommendation. | |
1911 | ||
1912 | ||
eeaf4427 LC |
1913 | @item --profile=@var{profile} |
1914 | @itemx -p @var{profile} | |
1915 | Use @var{profile} instead of the user's default profile. | |
1916 | ||
70915c1a | 1917 | @item --verbose |
f97c9175 AE |
1918 | Produce verbose output. In particular, emit the build log of the |
1919 | environment on the standard error port. | |
70915c1a | 1920 | |
eeaf4427 LC |
1921 | @item --bootstrap |
1922 | Use the bootstrap Guile to build the profile. This option is only | |
1923 | useful to distribution developers. | |
1924 | ||
1925 | @end table | |
1926 | ||
f97c9175 | 1927 | In addition to these actions, @command{guix package} supports the |
733b4130 LC |
1928 | following options to query the current state of a profile, or the |
1929 | availability of packages: | |
eeaf4427 | 1930 | |
733b4130 LC |
1931 | @table @option |
1932 | ||
acc08466 NK |
1933 | @item --search=@var{regexp} |
1934 | @itemx -s @var{regexp} | |
b110869d | 1935 | @cindex searching for packages |
5763ad92 | 1936 | List the available packages whose name, synopsis, or description matches |
4e863eb3 | 1937 | @var{regexp}, sorted by relevance. Print all the metadata of matching packages in |
299112d3 LC |
1938 | @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, |
1939 | GNU recutils manual}). | |
acc08466 | 1940 | |
299112d3 LC |
1941 | This allows specific fields to be extracted using the @command{recsel} |
1942 | command, for instance: | |
1943 | ||
1944 | @example | |
4e863eb3 LC |
1945 | $ guix package -s malloc | recsel -p name,version,relevance |
1946 | name: jemalloc | |
1947 | version: 4.5.0 | |
1948 | relevance: 6 | |
1949 | ||
299112d3 | 1950 | name: glibc |
4e863eb3 LC |
1951 | version: 2.25 |
1952 | relevance: 1 | |
299112d3 LC |
1953 | |
1954 | name: libgc | |
4e863eb3 LC |
1955 | version: 7.6.0 |
1956 | relevance: 1 | |
299112d3 | 1957 | @end example |
acc08466 | 1958 | |
a12d92f5 LC |
1959 | Similarly, to show the name of all the packages available under the |
1960 | terms of the GNU@tie{}LGPL version 3: | |
1961 | ||
1962 | @example | |
1963 | $ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"' | |
1964 | name: elfutils | |
1965 | ||
1966 | name: gmp | |
1967 | @dots{} | |
1968 | @end example | |
1969 | ||
db5a9444 LC |
1970 | It is also possible to refine search results using several @code{-s} |
1971 | flags. For example, the following command returns a list of board | |
1972 | games: | |
1973 | ||
1974 | @example | |
1975 | $ guix package -s '\<board\>' -s game | recsel -p name | |
1976 | name: gnubg | |
1977 | @dots{} | |
1978 | @end example | |
1979 | ||
1980 | If we were to omit @code{-s game}, we would also get software packages | |
1981 | that deal with printed circuit boards; removing the angle brackets | |
1982 | around @code{board} would further add packages that have to do with | |
1983 | keyboards. | |
1984 | ||
b110869d LC |
1985 | And now for a more elaborate example. The following command searches |
1986 | for cryptographic libraries, filters out Haskell, Perl, Python, and Ruby | |
1987 | libraries, and prints the name and synopsis of the matching packages: | |
1988 | ||
1989 | @example | |
1990 | $ guix package -s crypto -s library | \ | |
1991 | recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis | |
1992 | @end example | |
1993 | ||
1994 | @noindent | |
1995 | @xref{Selection Expressions,,, recutils, GNU recutils manual}, for more | |
1996 | information on @dfn{selection expressions} for @code{recsel -e}. | |
1997 | ||
2aa6efb0 CR |
1998 | @item --show=@var{package} |
1999 | Show details about @var{package}, taken from the list of available packages, in | |
2000 | @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU | |
2001 | recutils manual}). | |
2002 | ||
2003 | @example | |
2004 | $ guix package --show=python | recsel -p name,version | |
2005 | name: python | |
2006 | version: 2.7.6 | |
2007 | ||
2008 | name: python | |
2009 | version: 3.3.5 | |
2010 | @end example | |
2011 | ||
2012 | You may also specify the full name of a package to only get details about a | |
2013 | specific version of it: | |
2014 | @example | |
ea206df4 | 2015 | $ guix package --show=python@@3.4 | recsel -p name,version |
2aa6efb0 | 2016 | name: python |
ea206df4 | 2017 | version: 3.4.3 |
2aa6efb0 CR |
2018 | @end example |
2019 | ||
2020 | ||
2021 | ||
733b4130 LC |
2022 | @item --list-installed[=@var{regexp}] |
2023 | @itemx -I [@var{regexp}] | |
bd9bde1c LC |
2024 | List the currently installed packages in the specified profile, with the |
2025 | most recently installed packages shown last. When @var{regexp} is | |
2026 | specified, list only installed packages whose name matches @var{regexp}. | |
733b4130 LC |
2027 | |
2028 | For each installed package, print the following items, separated by | |
2029 | tabs: the package name, its version string, the part of the package that | |
2030 | is installed (for instance, @code{out} for the default output, | |
2031 | @code{include} for its headers, etc.), and the path of this package in | |
2032 | the store. | |
2033 | ||
64fc89b6 LC |
2034 | @item --list-available[=@var{regexp}] |
2035 | @itemx -A [@var{regexp}] | |
5763ad92 | 2036 | List packages currently available in the distribution for this system |
a1ba8475 LC |
2037 | (@pxref{GNU Distribution}). When @var{regexp} is specified, list only |
2038 | installed packages whose name matches @var{regexp}. | |
64fc89b6 LC |
2039 | |
2040 | For each package, print the following items separated by tabs: its name, | |
6e721c4d LC |
2041 | its version string, the parts of the package (@pxref{Packages with |
2042 | Multiple Outputs}), and the source location of its definition. | |
64fc89b6 | 2043 | |
f566d765 LC |
2044 | @item --list-generations[=@var{pattern}] |
2045 | @itemx -l [@var{pattern}] | |
e32171ee | 2046 | @cindex generations |
f566d765 LC |
2047 | Return a list of generations along with their creation dates; for each |
2048 | generation, show the installed packages, with the most recently | |
4b2bc804 NK |
2049 | installed packages shown last. Note that the zeroth generation is never |
2050 | shown. | |
f566d765 LC |
2051 | |
2052 | For each installed package, print the following items, separated by | |
2053 | tabs: the name of a package, its version string, the part of the package | |
2054 | that is installed (@pxref{Packages with Multiple Outputs}), and the | |
2055 | location of this package in the store. | |
2056 | ||
2057 | When @var{pattern} is used, the command returns only matching | |
2058 | generations. Valid patterns include: | |
2059 | ||
2060 | @itemize | |
2061 | @item @emph{Integers and comma-separated integers}. Both patterns denote | |
2062 | generation numbers. For instance, @code{--list-generations=1} returns | |
2063 | the first one. | |
2064 | ||
2065 | And @code{--list-generations=1,8,2} outputs three generations in the | |
2066 | specified order. Neither spaces nor trailing commas are allowed. | |
2067 | ||
2068 | @item @emph{Ranges}. @code{--list-generations=2..9} prints the | |
2069 | specified generations and everything in between. Note that the start of | |
f97c9175 | 2070 | a range must be smaller than its end. |
f566d765 LC |
2071 | |
2072 | It is also possible to omit the endpoint. For example, | |
2073 | @code{--list-generations=2..}, returns all generations starting from the | |
2074 | second one. | |
2075 | ||
2076 | @item @emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks, | |
2077 | or months by passing an integer along with the first letter of the | |
d7ddb257 LC |
2078 | duration. For example, @code{--list-generations=20d} lists generations |
2079 | that are up to 20 days old. | |
f566d765 LC |
2080 | @end itemize |
2081 | ||
b7884ca3 NK |
2082 | @item --delete-generations[=@var{pattern}] |
2083 | @itemx -d [@var{pattern}] | |
d7ddb257 LC |
2084 | When @var{pattern} is omitted, delete all generations except the current |
2085 | one. | |
b7884ca3 NK |
2086 | |
2087 | This command accepts the same patterns as @option{--list-generations}. | |
d7ddb257 LC |
2088 | When @var{pattern} is specified, delete the matching generations. When |
2089 | @var{pattern} specifies a duration, generations @emph{older} than the | |
2090 | specified duration match. For instance, @code{--delete-generations=1m} | |
2091 | deletes generations that are more than one month old. | |
2092 | ||
391bdd8f LC |
2093 | If the current generation matches, it is @emph{not} deleted. Also, the |
2094 | zeroth generation is never deleted. | |
b7884ca3 | 2095 | |
f97c9175 | 2096 | Note that deleting generations prevents rolling back to them. |
1bb9900a LC |
2097 | Consequently, this command must be used with care. |
2098 | ||
733b4130 | 2099 | @end table |
eeaf4427 | 2100 | |
70ee5642 | 2101 | Finally, since @command{guix package} may actually start build |
ccd7158d | 2102 | processes, it supports all the common build options (@pxref{Common Build |
f97c9175 | 2103 | Options}). It also supports package transformation options, such as |
b8638f03 LC |
2104 | @option{--with-source} (@pxref{Package Transformation Options}). |
2105 | However, note that package transformations are lost when upgrading; to | |
f97c9175 | 2106 | preserve transformations across upgrades, you should define your own |
b8638f03 LC |
2107 | package variant in a Guile module and add it to @code{GUIX_PACKAGE_PATH} |
2108 | (@pxref{Defining Packages}). | |
2109 | ||
70ee5642 | 2110 | |
c4202d60 LC |
2111 | @node Substitutes |
2112 | @section Substitutes | |
2113 | ||
2114 | @cindex substitutes | |
2115 | @cindex pre-built binaries | |
2116 | Guix supports transparent source/binary deployment, which means that it | |
2117 | can either build things locally, or download pre-built items from a | |
2118 | server. We call these pre-built items @dfn{substitutes}---they are | |
2119 | substitutes for local build results. In many cases, downloading a | |
2120 | substitute is much faster than building things locally. | |
2121 | ||
2122 | Substitutes can be anything resulting from a derivation build | |
2123 | (@pxref{Derivations}). Of course, in the common case, they are | |
2124 | pre-built package binaries, but source tarballs, for instance, which | |
2125 | also result from derivation builds, can be available as substitutes. | |
2126 | ||
2127 | The @code{hydra.gnu.org} server is a front-end to a build farm that | |
2128 | builds packages from the GNU distribution continuously for some | |
deb6276d | 2129 | architectures, and makes them available as substitutes. This is the |
f8a8e0fe LC |
2130 | default source of substitutes; it can be overridden by passing the |
2131 | @option{--substitute-urls} option either to @command{guix-daemon} | |
2132 | (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) | |
2133 | or to client tools such as @command{guix package} | |
2134 | (@pxref{client-substitute-urls,, client @option{--substitute-urls} | |
2135 | option}). | |
c4202d60 | 2136 | |
1dbe3a8d | 2137 | Substitute URLs can be either HTTP or HTTPS. |
9b7bd1b1 LC |
2138 | HTTPS is recommended because communications are encrypted; conversely, |
2139 | using HTTP makes all communications visible to an eavesdropper, who | |
2140 | could use the information gathered to determine, for instance, whether | |
2141 | your system has unpatched security vulnerabilities. | |
2142 | ||
c4202d60 LC |
2143 | @cindex security |
2144 | @cindex digital signatures | |
e32171ee | 2145 | @cindex substitutes, authorization thereof |
a9468b42 LC |
2146 | @cindex access control list (ACL), for substitutes |
2147 | @cindex ACL (access control list), for substitutes | |
df061d07 LC |
2148 | To allow Guix to download substitutes from @code{hydra.gnu.org} or a |
2149 | mirror thereof, you | |
c4202d60 LC |
2150 | must add its public key to the access control list (ACL) of archive |
2151 | imports, using the @command{guix archive} command (@pxref{Invoking guix | |
2152 | archive}). Doing so implies that you trust @code{hydra.gnu.org} to not | |
2153 | be compromised and to serve genuine substitutes. | |
2154 | ||
2155 | This public key is installed along with Guix, in | |
2156 | @code{@var{prefix}/share/guix/hydra.gnu.org.pub}, where @var{prefix} is | |
2157 | the installation prefix of Guix. If you installed Guix from source, | |
2158 | make sure you checked the GPG signature of | |
2159 | @file{guix-@value{VERSION}.tar.gz}, which contains this public key file. | |
2160 | Then, you can run something like this: | |
2161 | ||
2162 | @example | |
2163 | # guix archive --authorize < hydra.gnu.org.pub | |
2164 | @end example | |
2165 | ||
2166 | Once this is in place, the output of a command like @code{guix build} | |
2167 | should change from something like: | |
2168 | ||
2169 | @example | |
2170 | $ guix build emacs --dry-run | |
2171 | The following derivations would be built: | |
2172 | /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv | |
2173 | /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv | |
2174 | /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv | |
2175 | /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv | |
2176 | @dots{} | |
2177 | @end example | |
2178 | ||
2179 | @noindent | |
2180 | to something like: | |
2181 | ||
2182 | @example | |
2183 | $ guix build emacs --dry-run | |
2184 | The following files would be downloaded: | |
2185 | /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3 | |
2186 | /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d | |
2187 | /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16 | |
2188 | /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7 | |
2189 | @dots{} | |
2190 | @end example | |
2191 | ||
2192 | @noindent | |
2193 | This indicates that substitutes from @code{hydra.gnu.org} are usable and | |
2194 | will be downloaded, when possible, for future builds. | |
2195 | ||
a9468b42 LC |
2196 | Guix detects and raises an error when attempting to use a substitute |
2197 | that has been tampered with. Likewise, it ignores substitutes that are | |
2198 | not signed, or that are not signed by one of the keys listed in the ACL. | |
2199 | ||
2200 | There is one exception though: if an unauthorized server provides | |
2201 | substitutes that are @emph{bit-for-bit identical} to those provided by | |
2202 | an authorized server, then the unauthorized server becomes eligible for | |
2203 | downloads. For example, assume we have chosen two substitute servers | |
2204 | with this option: | |
2205 | ||
2206 | @example | |
2207 | --substitute-urls="https://a.example.org https://b.example.org" | |
2208 | @end example | |
2209 | ||
2210 | @noindent | |
2211 | @cindex reproducible builds | |
2212 | If the ACL contains only the key for @code{b.example.org}, and if | |
2213 | @code{a.example.org} happens to serve the @emph{exact same} substitutes, | |
2214 | then Guix will download substitutes from @code{a.example.org} because it | |
2215 | comes first in the list and can be considered a mirror of | |
2216 | @code{b.example.org}. In practice, independent build machines usually | |
2217 | produce the same binaries, thanks to bit-reproducible builds (see | |
2218 | below). | |
c4202d60 | 2219 | |
e0c941fe | 2220 | @vindex http_proxy |
9b7bd1b1 LC |
2221 | Substitutes are downloaded over HTTP or HTTPS. |
2222 | The @code{http_proxy} environment | |
e0c941fe LC |
2223 | variable can be set in the environment of @command{guix-daemon} and is |
2224 | honored for downloads of substitutes. Note that the value of | |
2225 | @code{http_proxy} in the environment where @command{guix build}, | |
2226 | @command{guix package}, and other client commands are run has | |
2227 | @emph{absolutely no effect}. | |
2228 | ||
9b7bd1b1 LC |
2229 | When using HTTPS, the server's X.509 certificate is @emph{not} validated |
2230 | (in other words, the server is not authenticated), contrary to what | |
2231 | HTTPS clients such as Web browsers usually do. This is because Guix | |
2232 | authenticates substitute information itself, as explained above, which | |
2233 | is what we care about (whereas X.509 certificates are about | |
2234 | authenticating bindings between domain names and public keys.) | |
2235 | ||
585347d7 LC |
2236 | You can get statistics on the substitutes provided by a server using the |
2237 | @command{guix weather} command (@pxref{Invoking guix weather}). | |
2238 | ||
c4202d60 LC |
2239 | The substitute mechanism can be disabled globally by running |
2240 | @code{guix-daemon} with @code{--no-substitutes} (@pxref{Invoking | |
2241 | guix-daemon}). It can also be disabled temporarily by passing the | |
2242 | @code{--no-substitutes} option to @command{guix package}, @command{guix | |
2243 | build}, and other command-line tools. | |
2244 | ||
2245 | ||
9b7bd1b1 LC |
2246 | @unnumberedsubsec On Trusting Binaries |
2247 | ||
c4202d60 LC |
2248 | Today, each individual's control over their own computing is at the |
2249 | mercy of institutions, corporations, and groups with enough power and | |
2250 | determination to subvert the computing infrastructure and exploit its | |
2251 | weaknesses. While using @code{hydra.gnu.org} substitutes can be | |
2252 | convenient, we encourage users to also build on their own, or even run | |
2253 | their own build farm, such that @code{hydra.gnu.org} is less of an | |
8ce229fc LC |
2254 | interesting target. One way to help is by publishing the software you |
2255 | build using @command{guix publish} so that others have one more choice | |
2256 | of server to download substitutes from (@pxref{Invoking guix publish}). | |
c4202d60 LC |
2257 | |
2258 | Guix has the foundations to maximize build reproducibility | |
2259 | (@pxref{Features}). In most cases, independent builds of a given | |
2260 | package or derivation should yield bit-identical results. Thus, through | |
2261 | a diverse set of independent package builds, we can strengthen the | |
d23c20f1 LC |
2262 | integrity of our systems. The @command{guix challenge} command aims to |
2263 | help users assess substitute servers, and to assist developers in | |
2264 | finding out about non-deterministic package builds (@pxref{Invoking guix | |
a8d65643 LC |
2265 | challenge}). Similarly, the @option{--check} option of @command{guix |
2266 | build} allows users to check whether previously-installed substitutes | |
2267 | are genuine by rebuilding them locally (@pxref{build-check, | |
2268 | @command{guix build --check}}). | |
c4202d60 LC |
2269 | |
2270 | In the future, we want Guix to have support to publish and retrieve | |
2271 | binaries to/from other users, in a peer-to-peer fashion. If you would | |
2272 | like to discuss this project, join us on @email{guix-devel@@gnu.org}. | |
2273 | ||
2274 | ||
6e721c4d LC |
2275 | @node Packages with Multiple Outputs |
2276 | @section Packages with Multiple Outputs | |
2277 | ||
2278 | @cindex multiple-output packages | |
2279 | @cindex package outputs | |
e32171ee | 2280 | @cindex outputs |
6e721c4d LC |
2281 | |
2282 | Often, packages defined in Guix have a single @dfn{output}---i.e., the | |
f97c9175 | 2283 | source package leads to exactly one directory in the store. When running |
6e721c4d LC |
2284 | @command{guix package -i glibc}, one installs the default output of the |
2285 | GNU libc package; the default output is called @code{out}, but its name | |
2286 | can be omitted as shown in this command. In this particular case, the | |
2287 | default output of @code{glibc} contains all the C header files, shared | |
2288 | libraries, static libraries, Info documentation, and other supporting | |
2289 | files. | |
2290 | ||
2291 | Sometimes it is more appropriate to separate the various types of files | |
2292 | produced from a single source package into separate outputs. For | |
2293 | instance, the GLib C library (used by GTK+ and related packages) | |
2294 | installs more than 20 MiB of reference documentation as HTML pages. | |
2295 | To save space for users who do not need it, the documentation goes to a | |
2296 | separate output, called @code{doc}. To install the main GLib output, | |
2297 | which contains everything but the documentation, one would run: | |
2298 | ||
2299 | @example | |
2300 | guix package -i glib | |
2301 | @end example | |
2302 | ||
e32171ee | 2303 | @cindex documentation |
6e721c4d LC |
2304 | The command to install its documentation is: |
2305 | ||
2306 | @example | |
2307 | guix package -i glib:doc | |
2308 | @end example | |
2309 | ||
2310 | Some packages install programs with different ``dependency footprints''. | |
f97c9175 | 2311 | For instance, the WordNet package installs both command-line tools and |
6e721c4d LC |
2312 | graphical user interfaces (GUIs). The former depend solely on the C |
2313 | library, whereas the latter depend on Tcl/Tk and the underlying X | |
2314 | libraries. In this case, we leave the command-line tools in the default | |
2315 | output, whereas the GUIs are in a separate output. This allows users | |
fcc58db6 LC |
2316 | who do not need the GUIs to save space. The @command{guix size} command |
2317 | can help find out about such situations (@pxref{Invoking guix size}). | |
88856916 | 2318 | @command{guix graph} can also be helpful (@pxref{Invoking guix graph}). |
6e721c4d LC |
2319 | |
2320 | There are several such multiple-output packages in the GNU distribution. | |
91ef73d4 LC |
2321 | Other conventional output names include @code{lib} for libraries and |
2322 | possibly header files, @code{bin} for stand-alone programs, and | |
2323 | @code{debug} for debugging information (@pxref{Installing Debugging | |
2324 | Files}). The outputs of a packages are listed in the third column of | |
2325 | the output of @command{guix package --list-available} (@pxref{Invoking | |
2326 | guix package}). | |
6e721c4d | 2327 | |
eeaf4427 | 2328 | |
e49951eb MW |
2329 | @node Invoking guix gc |
2330 | @section Invoking @command{guix gc} | |
fe8ff028 LC |
2331 | |
2332 | @cindex garbage collector | |
e32171ee | 2333 | @cindex disk space |
f97c9175 | 2334 | Packages that are installed, but not used, may be @dfn{garbage-collected}. |
e49951eb | 2335 | The @command{guix gc} command allows users to explicitly run the garbage |
c22eb992 LC |
2336 | collector to reclaim space from the @file{/gnu/store} directory. It is |
2337 | the @emph{only} way to remove files from @file{/gnu/store}---removing | |
2338 | files or directories manually may break it beyond repair! | |
fe8ff028 LC |
2339 | |
2340 | The garbage collector has a set of known @dfn{roots}: any file under | |
834129e0 | 2341 | @file{/gnu/store} reachable from a root is considered @dfn{live} and |
fe8ff028 LC |
2342 | cannot be deleted; any other file is considered @dfn{dead} and may be |
2343 | deleted. The set of garbage collector roots includes default user | |
e49951eb MW |
2344 | profiles, and may be augmented with @command{guix build --root}, for |
2345 | example (@pxref{Invoking guix build}). | |
fe8ff028 | 2346 | |
1bb9900a LC |
2347 | Prior to running @code{guix gc --collect-garbage} to make space, it is |
2348 | often useful to remove old generations from user profiles; that way, old | |
2349 | package builds referenced by those generations can be reclaimed. This | |
2350 | is achieved by running @code{guix package --delete-generations} | |
2351 | (@pxref{Invoking guix package}). | |
2352 | ||
457103b9 LC |
2353 | Our recommendation is to run a garbage collection periodically, or when |
2354 | you are short on disk space. For instance, to guarantee that at least | |
2355 | 5@tie{}GB are available on your disk, simply run: | |
2356 | ||
2357 | @example | |
2358 | guix gc -F 5G | |
2359 | @end example | |
2360 | ||
2361 | It is perfectly safe to run as a non-interactive periodic job | |
2362 | (@pxref{Scheduled Job Execution}, for how to set up such a job on | |
2363 | GuixSD). Running @command{guix gc} with no arguments will collect as | |
2364 | much garbage as it can, but that is often inconvenient: you may find | |
2365 | yourself having to rebuild or re-download software that is ``dead'' from | |
2366 | the GC viewpoint but that is necessary to build other pieces of | |
2367 | software---e.g., the compiler tool chain. | |
2368 | ||
e49951eb | 2369 | The @command{guix gc} command has three modes of operation: it can be |
fe8ff028 | 2370 | used to garbage-collect any dead files (the default), to delete specific |
7770aafc LC |
2371 | files (the @code{--delete} option), to print garbage-collector |
2372 | information, or for more advanced queries. The garbage collection | |
2373 | options are as follows: | |
fe8ff028 LC |
2374 | |
2375 | @table @code | |
2376 | @item --collect-garbage[=@var{min}] | |
2377 | @itemx -C [@var{min}] | |
834129e0 | 2378 | Collect garbage---i.e., unreachable @file{/gnu/store} files and |
fe8ff028 LC |
2379 | sub-directories. This is the default operation when no option is |
2380 | specified. | |
2381 | ||
2382 | When @var{min} is given, stop once @var{min} bytes have been collected. | |
2383 | @var{min} may be a number of bytes, or it may include a unit as a | |
4a44d7bb LC |
2384 | suffix, such as @code{MiB} for mebibytes and @code{GB} for gigabytes |
2385 | (@pxref{Block size, size specifications,, coreutils, GNU Coreutils}). | |
fe8ff028 LC |
2386 | |
2387 | When @var{min} is omitted, collect all the garbage. | |
2388 | ||
0054e470 LC |
2389 | @item --free-space=@var{free} |
2390 | @itemx -F @var{free} | |
2391 | Collect garbage until @var{free} space is available under | |
2392 | @file{/gnu/store}, if possible; @var{free} denotes storage space, such | |
2393 | as @code{500MiB}, as described above. | |
2394 | ||
2395 | When @var{free} or more is already available in @file{/gnu/store}, do | |
2396 | nothing and exit immediately. | |
2397 | ||
fe8ff028 LC |
2398 | @item --delete |
2399 | @itemx -d | |
2400 | Attempt to delete all the store files and directories specified as | |
2401 | arguments. This fails if some of the files are not in the store, or if | |
2402 | they are still live. | |
2403 | ||
30d9aa54 LC |
2404 | @item --list-failures |
2405 | List store items corresponding to cached build failures. | |
2406 | ||
2407 | This prints nothing unless the daemon was started with | |
2408 | @option{--cache-failures} (@pxref{Invoking guix-daemon, | |
2409 | @option{--cache-failures}}). | |
2410 | ||
2411 | @item --clear-failures | |
2412 | Remove the specified store items from the failed-build cache. | |
2413 | ||
2414 | Again, this option only makes sense when the daemon is started with | |
2415 | @option{--cache-failures}. Otherwise, it does nothing. | |
2416 | ||
fe8ff028 LC |
2417 | @item --list-dead |
2418 | Show the list of dead files and directories still present in the | |
2419 | store---i.e., files and directories no longer reachable from any root. | |
2420 | ||
2421 | @item --list-live | |
2422 | Show the list of live store files and directories. | |
ba8b732d LC |
2423 | |
2424 | @end table | |
2425 | ||
2426 | In addition, the references among existing store files can be queried: | |
2427 | ||
2428 | @table @code | |
2429 | ||
2430 | @item --references | |
2431 | @itemx --referrers | |
e32171ee | 2432 | @cindex package dependencies |
ba8b732d LC |
2433 | List the references (respectively, the referrers) of store files given |
2434 | as arguments. | |
2435 | ||
8e59fdd5 LC |
2436 | @item --requisites |
2437 | @itemx -R | |
fcc58db6 | 2438 | @cindex closure |
8e59fdd5 LC |
2439 | List the requisites of the store files passed as arguments. Requisites |
2440 | include the store files themselves, their references, and the references | |
2441 | of these, recursively. In other words, the returned list is the | |
2442 | @dfn{transitive closure} of the store files. | |
2443 | ||
f97c9175 AE |
2444 | @xref{Invoking guix size}, for a tool to profile the size of the closure |
2445 | of an element. @xref{Invoking guix graph}, for a tool to visualize | |
88856916 | 2446 | the graph of references. |
fcc58db6 | 2447 | |
fe8ff028 LC |
2448 | @end table |
2449 | ||
7770aafc LC |
2450 | Lastly, the following options allow you to check the integrity of the |
2451 | store and to control disk usage. | |
2452 | ||
2453 | @table @option | |
2454 | ||
2455 | @item --verify[=@var{options}] | |
2456 | @cindex integrity, of the store | |
2457 | @cindex integrity checking | |
2458 | Verify the integrity of the store. | |
2459 | ||
2460 | By default, make sure that all the store items marked as valid in the | |
f97c9175 | 2461 | database of the daemon actually exist in @file{/gnu/store}. |
7770aafc | 2462 | |
f97c9175 | 2463 | When provided, @var{options} must be a comma-separated list containing one |
7770aafc LC |
2464 | or more of @code{contents} and @code{repair}. |
2465 | ||
7414de0a | 2466 | When passing @option{--verify=contents}, the daemon computes the |
f97c9175 | 2467 | content hash of each store item and compares it against its hash in the |
7770aafc LC |
2468 | database. Hash mismatches are reported as data corruptions. Because it |
2469 | traverses @emph{all the files in the store}, this command can take a | |
2470 | long time, especially on systems with a slow disk drive. | |
2471 | ||
2472 | @cindex repairing the store | |
6da5bb7b | 2473 | @cindex corruption, recovering from |
7770aafc LC |
2474 | Using @option{--verify=repair} or @option{--verify=contents,repair} |
2475 | causes the daemon to try to repair corrupt store items by fetching | |
2476 | substitutes for them (@pxref{Substitutes}). Because repairing is not | |
2477 | atomic, and thus potentially dangerous, it is available only to the | |
6da5bb7b LC |
2478 | system administrator. A lightweight alternative, when you know exactly |
2479 | which items in the store are corrupt, is @command{guix build --repair} | |
2480 | (@pxref{Invoking guix build}). | |
7770aafc LC |
2481 | |
2482 | @item --optimize | |
2483 | @cindex deduplication | |
2484 | Optimize the store by hard-linking identical files---this is | |
2485 | @dfn{deduplication}. | |
2486 | ||
2487 | The daemon performs deduplication after each successful build or archive | |
2488 | import, unless it was started with @code{--disable-deduplication} | |
2489 | (@pxref{Invoking guix-daemon, @code{--disable-deduplication}}). Thus, | |
2490 | this option is primarily useful when the daemon was running with | |
2491 | @code{--disable-deduplication}. | |
2492 | ||
2493 | @end table | |
eeaf4427 | 2494 | |
f651b477 LC |
2495 | @node Invoking guix pull |
2496 | @section Invoking @command{guix pull} | |
2497 | ||
e32171ee | 2498 | @cindex upgrading Guix |
7fcf2a0b | 2499 | @cindex updating Guix |
e32171ee JD |
2500 | @cindex @command{guix pull} |
2501 | @cindex pull | |
f651b477 LC |
2502 | Packages are installed or upgraded to the latest version available in |
2503 | the distribution currently available on your local machine. To update | |
2504 | that distribution, along with the Guix tools, you must run @command{guix | |
2505 | pull}: the command downloads the latest Guix source code and package | |
59a16275 LC |
2506 | descriptions, and deploys it. Source code is downloaded from a |
2507 | @uref{https://git-scm.com, Git} repository. | |
f651b477 LC |
2508 | |
2509 | On completion, @command{guix package} will use packages and package | |
2510 | versions from this just-retrieved copy of Guix. Not only that, but all | |
2511 | the Guix commands and Scheme modules will also be taken from that latest | |
2512 | version. New @command{guix} sub-commands added by the update also | |
cb05108a LC |
2513 | become available. |
2514 | ||
2515 | Any user can update their Guix copy using @command{guix pull}, and the | |
2516 | effect is limited to the user who run @command{guix pull}. For | |
2517 | instance, when user @code{root} runs @command{guix pull}, this has no | |
2518 | effect on the version of Guix that user @code{alice} sees, and vice | |
2519 | versa@footnote{Under the hood, @command{guix pull} updates the | |
2520 | @file{~/.config/guix/latest} symbolic link to point to the latest Guix, | |
5e2017ed CM |
2521 | and the @command{guix} command loads code from there. Currently, the |
2522 | only way to roll back an invocation of @command{guix pull} is to | |
2523 | manually update this symlink to point to the previous Guix.}. | |
f651b477 LC |
2524 | |
2525 | The @command{guix pull} command is usually invoked with no arguments, | |
2526 | but it supports the following options: | |
2527 | ||
2528 | @table @code | |
2529 | @item --verbose | |
2530 | Produce verbose output, writing build logs to the standard error output. | |
2531 | ||
ab5d72ad | 2532 | @item --url=@var{url} |
59a16275 | 2533 | Download Guix from the Git repository at @var{url}. |
ab5d72ad | 2534 | |
cca6941f | 2535 | @vindex GUIX_PULL_URL |
59a16275 | 2536 | By default, the source is taken from its canonical Git repository at |
cca6941f OP |
2537 | @code{gnu.org}, for the stable branch of Guix. To use a different source, |
2538 | set the @code{GUIX_PULL_URL} environment variable. | |
ab5d72ad | 2539 | |
59a16275 LC |
2540 | @item --commit=@var{commit} |
2541 | Deploy @var{commit}, a valid Git commit ID represented as a hexadecimal | |
2542 | string. | |
8a9cffb2 | 2543 | |
59a16275 LC |
2544 | @item --branch=@var{branch} |
2545 | Deploy the tip of @var{branch}, the name of a Git branch available on | |
2546 | the repository at @var{url}. | |
8a9cffb2 | 2547 | |
f651b477 LC |
2548 | @item --bootstrap |
2549 | Use the bootstrap Guile to build the latest Guix. This option is only | |
2550 | useful to Guix developers. | |
2551 | @end table | |
2552 | ||
4902d3c4 LC |
2553 | In addition, @command{guix pull} supports all the common build options |
2554 | (@pxref{Common Build Options}). | |
760c60d6 | 2555 | |
239c2266 LC |
2556 | @node Invoking guix pack |
2557 | @section Invoking @command{guix pack} | |
2558 | ||
2559 | Occasionally you want to pass software to people who are not (yet!) | |
2560 | lucky enough to be using Guix. You'd tell them to run @command{guix | |
2561 | package -i @var{something}}, but that's not possible in this case. This | |
2562 | is where @command{guix pack} comes in. | |
2563 | ||
2564 | @cindex pack | |
2565 | @cindex bundle | |
2566 | @cindex application bundle | |
2567 | @cindex software bundle | |
2568 | The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or | |
2569 | @dfn{software bundle}: it creates a tarball or some other archive | |
2570 | containing the binaries of the software you're interested in, and all | |
2571 | its dependencies. The resulting archive can be used on any machine that | |
2572 | does not have Guix, and people can run the exact same binaries as those | |
107b8da6 LC |
2573 | you have with Guix. The pack itself is created in a bit-reproducible |
2574 | fashion, so anyone can verify that it really contains the build results | |
2575 | that you pretend to be shipping. | |
239c2266 LC |
2576 | |
2577 | For example, to create a bundle containing Guile, Emacs, Geiser, and all | |
2578 | their dependencies, you can run: | |
2579 | ||
2580 | @example | |
2581 | $ guix pack guile emacs geiser | |
2582 | @dots{} | |
2583 | /gnu/store/@dots{}-pack.tar.gz | |
2584 | @end example | |
2585 | ||
2586 | The result here is a tarball containing a @file{/gnu/store} directory | |
2587 | with all the relevant packages. The resulting tarball contains a | |
2588 | @dfn{profile} with the three packages of interest; the profile is the | |
2589 | same as would be created by @command{guix package -i}. It is this | |
2590 | mechanism that is used to create Guix's own standalone binary tarball | |
2591 | (@pxref{Binary Installation}). | |
2592 | ||
5895ec8a LC |
2593 | Users of this pack would have to run |
2594 | @file{/gnu/store/@dots{}-profile/bin/guile} to run Guile, which you may | |
2595 | find inconvenient. To work around it, you can create, say, a | |
2596 | @file{/opt/gnu/bin} symlink to the profile: | |
2597 | ||
2598 | @example | |
2599 | guix pack -S /opt/gnu/bin=bin guile emacs geiser | |
2600 | @end example | |
2601 | ||
2602 | @noindent | |
2603 | That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy. | |
2604 | ||
708b54a9 LC |
2605 | Alternatively, you can produce a pack in the Docker image format using |
2606 | the following command: | |
b1edfbc3 LC |
2607 | |
2608 | @example | |
2609 | guix pack -f docker guile emacs geiser | |
2610 | @end example | |
2611 | ||
2612 | @noindent | |
2613 | The result is a tarball that can be passed to the @command{docker load} | |
2614 | command. See the | |
2615 | @uref{https://docs.docker.com/engine/reference/commandline/load/, Docker | |
2616 | documentation} for more information. | |
2617 | ||
239c2266 LC |
2618 | Several command-line options allow you to customize your pack: |
2619 | ||
2620 | @table @code | |
708b54a9 LC |
2621 | @item --format=@var{format} |
2622 | @itemx -f @var{format} | |
2623 | Produce a pack in the given @var{format}. | |
2624 | ||
2625 | The available formats are: | |
2626 | ||
2627 | @table @code | |
2628 | @item tarball | |
2629 | This is the default format. It produces a tarball containing all the | |
7b14c48b | 2630 | specified binaries and symlinks. |
708b54a9 LC |
2631 | |
2632 | @item docker | |
2633 | This produces a tarball that follows the | |
2634 | @uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, | |
2635 | Docker Image Specification}. | |
2636 | @end table | |
2637 | ||
83cfa024 LC |
2638 | @item --expression=@var{expr} |
2639 | @itemx -e @var{expr} | |
2640 | Consider the package @var{expr} evaluates to. | |
2641 | ||
2642 | This has the same purpose as the same-named option in @command{guix | |
2643 | build} (@pxref{Additional Build Options, @code{--expression} in | |
2644 | @command{guix build}}). | |
2645 | ||
239c2266 LC |
2646 | @item --system=@var{system} |
2647 | @itemx -s @var{system} | |
2648 | Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of | |
2649 | the system type of the build host. | |
2650 | ||
5461115e LC |
2651 | @item --target=@var{triplet} |
2652 | @cindex cross-compilation | |
2653 | Cross-build for @var{triplet}, which must be a valid GNU triplet, such | |
2654 | as @code{"mips64el-linux-gnu"} (@pxref{Specifying target triplets, GNU | |
2655 | configuration triplets,, autoconf, Autoconf}). | |
2656 | ||
239c2266 LC |
2657 | @item --compression=@var{tool} |
2658 | @itemx -C @var{tool} | |
2659 | Compress the resulting tarball using @var{tool}---one of @code{gzip}, | |
af735661 | 2660 | @code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression. |
6b63c43e | 2661 | |
5895ec8a LC |
2662 | @item --symlink=@var{spec} |
2663 | @itemx -S @var{spec} | |
2664 | Add the symlinks specified by @var{spec} to the pack. This option can | |
2665 | appear several times. | |
2666 | ||
2667 | @var{spec} has the form @code{@var{source}=@var{target}}, where | |
2668 | @var{source} is the symlink that will be created and @var{target} is the | |
2669 | symlink target. | |
2670 | ||
2671 | For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} | |
2672 | symlink pointing to the @file{bin} sub-directory of the profile. | |
2673 | ||
6b63c43e LC |
2674 | @item --localstatedir |
2675 | Include the ``local state directory'', @file{/var/guix}, in the | |
2676 | resulting pack. | |
2677 | ||
2678 | @file{/var/guix} contains the store database (@pxref{The Store}) as well | |
2679 | as garbage-collector roots (@pxref{Invoking guix gc}). Providing it in | |
2680 | the pack means that the store is ``complete'' and manageable by Guix; | |
2681 | not providing it pack means that the store is ``dead'': items cannot be | |
2682 | added to it or removed from it after extraction of the pack. | |
2683 | ||
2684 | One use case for this is the Guix self-contained binary tarball | |
2685 | (@pxref{Binary Installation}). | |
239c2266 LC |
2686 | @end table |
2687 | ||
2688 | In addition, @command{guix pack} supports all the common build options | |
2689 | (@pxref{Common Build Options}) and all the package transformation | |
2690 | options (@pxref{Package Transformation Options}). | |
2691 | ||
2692 | ||
760c60d6 LC |
2693 | @node Invoking guix archive |
2694 | @section Invoking @command{guix archive} | |
2695 | ||
e32171ee JD |
2696 | @cindex @command{guix archive} |
2697 | @cindex archive | |
760c60d6 LC |
2698 | The @command{guix archive} command allows users to @dfn{export} files |
2699 | from the store into a single archive, and to later @dfn{import} them. | |
2700 | In particular, it allows store files to be transferred from one machine | |
4d4c4816 AE |
2701 | to the store on another machine. |
2702 | ||
e32171ee | 2703 | @cindex exporting store items |
4d4c4816 AE |
2704 | To export store files as an archive to standard output, run: |
2705 | ||
2706 | @example | |
2707 | guix archive --export @var{options} @var{specifications}... | |
2708 | @end example | |
2709 | ||
2710 | @var{specifications} may be either store file names or package | |
2711 | specifications, as for @command{guix package} (@pxref{Invoking guix | |
2712 | package}). For instance, the following command creates an archive | |
2713 | containing the @code{gui} output of the @code{git} package and the main | |
2714 | output of @code{emacs}: | |
2715 | ||
2716 | @example | |
2717 | guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar | |
2718 | @end example | |
2719 | ||
2720 | If the specified packages are not built yet, @command{guix archive} | |
2721 | automatically builds them. The build process may be controlled with the | |
2722 | common build options (@pxref{Common Build Options}). | |
2723 | ||
2724 | To transfer the @code{emacs} package to a machine connected over SSH, | |
2725 | one would run: | |
760c60d6 LC |
2726 | |
2727 | @example | |
56607088 | 2728 | guix archive --export -r emacs | ssh the-machine guix archive --import |
760c60d6 LC |
2729 | @end example |
2730 | ||
87236aed | 2731 | @noindent |
56607088 LC |
2732 | Similarly, a complete user profile may be transferred from one machine |
2733 | to another like this: | |
2734 | ||
2735 | @example | |
2736 | guix archive --export -r $(readlink -f ~/.guix-profile) | \ | |
2737 | ssh the-machine guix-archive --import | |
2738 | @end example | |
2739 | ||
2740 | @noindent | |
2741 | However, note that, in both examples, all of @code{emacs} and the | |
2742 | profile as well as all of their dependencies are transferred (due to | |
f97c9175 AE |
2743 | @code{-r}), regardless of what is already available in the store on the |
2744 | target machine. The @code{--missing} option can help figure out which | |
f11c444d LC |
2745 | items are missing from the target store. The @command{guix copy} |
2746 | command simplifies and optimizes this whole process, so this is probably | |
2747 | what you should use in this case (@pxref{Invoking guix copy}). | |
87236aed | 2748 | |
5597b3ae LC |
2749 | @cindex nar, archive format |
2750 | @cindex normalized archive (nar) | |
b1edfbc3 | 2751 | Archives are stored in the ``normalized archive'' or ``nar'' format, which is |
5597b3ae | 2752 | comparable in spirit to `tar', but with differences |
0dbd88db | 2753 | that make it more appropriate for our purposes. First, rather than |
5597b3ae | 2754 | recording all Unix metadata for each file, the nar format only mentions |
0dbd88db LC |
2755 | the file type (regular, directory, or symbolic link); Unix permissions |
2756 | and owner/group are dismissed. Second, the order in which directory | |
2757 | entries are stored always follows the order of file names according to | |
2758 | the C locale collation order. This makes archive production fully | |
2759 | deterministic. | |
2760 | ||
2761 | When exporting, the daemon digitally signs the contents of the archive, | |
2762 | and that digital signature is appended. When importing, the daemon | |
2763 | verifies the signature and rejects the import in case of an invalid | |
2764 | signature or if the signing key is not authorized. | |
760c60d6 LC |
2765 | @c FIXME: Add xref to daemon doc about signatures. |
2766 | ||
2767 | The main options are: | |
2768 | ||
2769 | @table @code | |
2770 | @item --export | |
2771 | Export the specified store files or packages (see below.) Write the | |
2772 | resulting archive to the standard output. | |
2773 | ||
56607088 LC |
2774 | Dependencies are @emph{not} included in the output, unless |
2775 | @code{--recursive} is passed. | |
2776 | ||
2777 | @item -r | |
2778 | @itemx --recursive | |
2779 | When combined with @code{--export}, this instructs @command{guix | |
2780 | archive} to include dependencies of the given items in the archive. | |
2781 | Thus, the resulting archive is self-contained: it contains the closure | |
2782 | of the exported store items. | |
2783 | ||
760c60d6 LC |
2784 | @item --import |
2785 | Read an archive from the standard input, and import the files listed | |
2786 | therein into the store. Abort if the archive has an invalid digital | |
f82cc5fd LC |
2787 | signature, or if it is signed by a public key not among the authorized |
2788 | keys (see @code{--authorize} below.) | |
554f26ec | 2789 | |
87236aed LC |
2790 | @item --missing |
2791 | Read a list of store file names from the standard input, one per line, | |
2792 | and write on the standard output the subset of these files missing from | |
2793 | the store. | |
2794 | ||
554f26ec | 2795 | @item --generate-key[=@var{parameters}] |
f82cc5fd | 2796 | @cindex signing, archives |
f97c9175 | 2797 | Generate a new key pair for the daemon. This is a prerequisite before |
554f26ec LC |
2798 | archives can be exported with @code{--export}. Note that this operation |
2799 | usually takes time, because it needs to gather enough entropy to | |
2800 | generate the key pair. | |
2801 | ||
2802 | The generated key pair is typically stored under @file{/etc/guix}, in | |
2803 | @file{signing-key.pub} (public key) and @file{signing-key.sec} (private | |
867d8473 LC |
2804 | key, which must be kept secret.) When @var{parameters} is omitted, |
2805 | an ECDSA key using the Ed25519 curve is generated, or, for Libgcrypt | |
2806 | versions before 1.6.0, it is a 4096-bit RSA key. | |
f97c9175 | 2807 | Alternatively, @var{parameters} can specify |
554f26ec LC |
2808 | @code{genkey} parameters suitable for Libgcrypt (@pxref{General |
2809 | public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The | |
2810 | Libgcrypt Reference Manual}). | |
f82cc5fd LC |
2811 | |
2812 | @item --authorize | |
2813 | @cindex authorizing, archives | |
2814 | Authorize imports signed by the public key passed on standard input. | |
2815 | The public key must be in ``s-expression advanced format''---i.e., the | |
2816 | same format as the @file{signing-key.pub} file. | |
2817 | ||
2818 | The list of authorized keys is kept in the human-editable file | |
2819 | @file{/etc/guix/acl}. The file contains | |
2820 | @url{http://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format | |
2821 | s-expressions''} and is structured as an access-control list in the | |
2822 | @url{http://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure | |
2823 | (SPKI)}. | |
c6f8e9dd LC |
2824 | |
2825 | @item --extract=@var{directory} | |
2826 | @itemx -x @var{directory} | |
2827 | Read a single-item archive as served by substitute servers | |
2828 | (@pxref{Substitutes}) and extract it to @var{directory}. This is a | |
2829 | low-level operation needed in only very narrow use cases; see below. | |
2830 | ||
2831 | For example, the following command extracts the substitute for Emacs | |
2832 | served by @code{hydra.gnu.org} to @file{/tmp/emacs}: | |
2833 | ||
2834 | @example | |
2835 | $ wget -O - \ | |
df061d07 | 2836 | https://hydra.gnu.org/nar/@dots{}-emacs-24.5 \ |
c6f8e9dd LC |
2837 | | bunzip2 | guix archive -x /tmp/emacs |
2838 | @end example | |
2839 | ||
2840 | Single-item archives are different from multiple-item archives produced | |
2841 | by @command{guix archive --export}; they contain a single store item, | |
2842 | and they do @emph{not} embed a signature. Thus this operation does | |
2843 | @emph{no} signature verification and its output should be considered | |
2844 | unsafe. | |
2845 | ||
2846 | The primary purpose of this operation is to facilitate inspection of | |
2847 | archive contents coming from possibly untrusted substitute servers. | |
2848 | ||
760c60d6 LC |
2849 | @end table |
2850 | ||
568717fd LC |
2851 | @c ********************************************************************* |
2852 | @node Programming Interface | |
2853 | @chapter Programming Interface | |
2854 | ||
3dc1970d LC |
2855 | GNU Guix provides several Scheme programming interfaces (APIs) to |
2856 | define, build, and query packages. The first interface allows users to | |
2857 | write high-level package definitions. These definitions refer to | |
2858 | familiar packaging concepts, such as the name and version of a package, | |
2859 | its build system, and its dependencies. These definitions can then be | |
2860 | turned into concrete build actions. | |
2861 | ||
ba55b1cb | 2862 | Build actions are performed by the Guix daemon, on behalf of users. In a |
3dc1970d | 2863 | standard setup, the daemon has write access to the store---the |
834129e0 | 2864 | @file{/gnu/store} directory---whereas users do not. The recommended |
3dc1970d LC |
2865 | setup also has the daemon perform builds in chroots, under a specific |
2866 | build users, to minimize interference with the rest of the system. | |
2867 | ||
2868 | @cindex derivation | |
2869 | Lower-level APIs are available to interact with the daemon and the | |
2870 | store. To instruct the daemon to perform a build action, users actually | |
2871 | provide it with a @dfn{derivation}. A derivation is a low-level | |
2872 | representation of the build actions to be taken, and the environment in | |
2873 | which they should occur---derivations are to package definitions what | |
49ad317a LC |
2874 | assembly is to C programs. The term ``derivation'' comes from the fact |
2875 | that build results @emph{derive} from them. | |
3dc1970d LC |
2876 | |
2877 | This chapter describes all these APIs in turn, starting from high-level | |
2878 | package definitions. | |
2879 | ||
568717fd | 2880 | @menu |
b860f382 | 2881 | * Defining Packages:: Defining new packages. |
7458bd0a | 2882 | * Build Systems:: Specifying how packages are built. |
b860f382 LC |
2883 | * The Store:: Manipulating the package store. |
2884 | * Derivations:: Low-level interface to package derivations. | |
2885 | * The Store Monad:: Purely functional interface to the store. | |
21b679f6 | 2886 | * G-Expressions:: Manipulating build expressions. |
568717fd LC |
2887 | @end menu |
2888 | ||
2889 | @node Defining Packages | |
2890 | @section Defining Packages | |
2891 | ||
3dc1970d LC |
2892 | The high-level interface to package definitions is implemented in the |
2893 | @code{(guix packages)} and @code{(guix build-system)} modules. As an | |
2894 | example, the package definition, or @dfn{recipe}, for the GNU Hello | |
2895 | package looks like this: | |
2896 | ||
2897 | @example | |
e7f34eb0 LC |
2898 | (define-module (gnu packages hello) |
2899 | #:use-module (guix packages) | |
2900 | #:use-module (guix download) | |
2901 | #:use-module (guix build-system gnu) | |
a6dcdcac SB |
2902 | #:use-module (guix licenses) |
2903 | #:use-module (gnu packages gawk)) | |
b22a12fd | 2904 | |
79f5dd59 | 2905 | (define-public hello |
3dc1970d LC |
2906 | (package |
2907 | (name "hello") | |
17d8e33f | 2908 | (version "2.10") |
3dc1970d | 2909 | (source (origin |
17d8e33f ML |
2910 | (method url-fetch) |
2911 | (uri (string-append "mirror://gnu/hello/hello-" version | |
2912 | ".tar.gz")) | |
2913 | (sha256 | |
2914 | (base32 | |
2915 | "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) | |
3dc1970d | 2916 | (build-system gnu-build-system) |
654c0d97 | 2917 | (arguments '(#:configure-flags '("--enable-silent-rules"))) |
3dc1970d | 2918 | (inputs `(("gawk" ,gawk))) |
7458bd0a LC |
2919 | (synopsis "Hello, GNU world: An example GNU package") |
2920 | (description "Guess what GNU Hello prints!") | |
3dc1970d | 2921 | (home-page "http://www.gnu.org/software/hello/") |
b22a12fd | 2922 | (license gpl3+))) |
3dc1970d LC |
2923 | @end example |
2924 | ||
2925 | @noindent | |
2926 | Without being a Scheme expert, the reader may have guessed the meaning | |
f97c9175 AE |
2927 | of the various fields here. This expression binds the variable |
2928 | @code{hello} to a @code{<package>} object, which is essentially a record | |
3dc1970d LC |
2929 | (@pxref{SRFI-9, Scheme records,, guile, GNU Guile Reference Manual}). |
2930 | This package object can be inspected using procedures found in the | |
2931 | @code{(guix packages)} module; for instance, @code{(package-name hello)} | |
2932 | returns---surprise!---@code{"hello"}. | |
2933 | ||
2f7d2d91 LC |
2934 | With luck, you may be able to import part or all of the definition of |
2935 | the package you are interested in from another repository, using the | |
2936 | @code{guix import} command (@pxref{Invoking guix import}). | |
2937 | ||
f97c9175 | 2938 | In the example above, @var{hello} is defined in a module of its own, |
e7f34eb0 LC |
2939 | @code{(gnu packages hello)}. Technically, this is not strictly |
2940 | necessary, but it is convenient to do so: all the packages defined in | |
2941 | modules under @code{(gnu packages @dots{})} are automatically known to | |
2942 | the command-line tools (@pxref{Package Modules}). | |
2943 | ||
3dc1970d LC |
2944 | There are a few points worth noting in the above package definition: |
2945 | ||
2946 | @itemize | |
2947 | @item | |
a2bf4907 LC |
2948 | The @code{source} field of the package is an @code{<origin>} object |
2949 | (@pxref{origin Reference}, for the complete reference). | |
3dc1970d LC |
2950 | Here, the @code{url-fetch} method from @code{(guix download)} is used, |
2951 | meaning that the source is a file to be downloaded over FTP or HTTP. | |
2952 | ||
2953 | The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of | |
2954 | the GNU mirrors defined in @code{(guix download)}. | |
2955 | ||
2956 | The @code{sha256} field specifies the expected SHA256 hash of the file | |
2957 | being downloaded. It is mandatory, and allows Guix to check the | |
2958 | integrity of the file. The @code{(base32 @dots{})} form introduces the | |
6c365eca | 2959 | base32 representation of the hash. You can obtain this information with |
210cc920 LC |
2960 | @code{guix download} (@pxref{Invoking guix download}) and @code{guix |
2961 | hash} (@pxref{Invoking guix hash}). | |
3dc1970d | 2962 | |
f9cc8971 LC |
2963 | @cindex patches |
2964 | When needed, the @code{origin} form can also have a @code{patches} field | |
2965 | listing patches to be applied, and a @code{snippet} field giving a | |
2966 | Scheme expression to modify the source code. | |
2967 | ||
3dc1970d LC |
2968 | @item |
2969 | @cindex GNU Build System | |
7458bd0a LC |
2970 | The @code{build-system} field specifies the procedure to build the |
2971 | package (@pxref{Build Systems}). Here, @var{gnu-build-system} | |
2972 | represents the familiar GNU Build System, where packages may be | |
2973 | configured, built, and installed with the usual @code{./configure && | |
2974 | make && make check && make install} command sequence. | |
2975 | ||
2976 | @item | |
2977 | The @code{arguments} field specifies options for the build system | |
2978 | (@pxref{Build Systems}). Here it is interpreted by | |
2979 | @var{gnu-build-system} as a request run @file{configure} with the | |
2980 | @code{--enable-silent-rules} flag. | |
3dc1970d | 2981 | |
654c0d97 LC |
2982 | @cindex quote |
2983 | @cindex quoting | |
2984 | @findex ' | |
2985 | @findex quote | |
2986 | What about these quote (@code{'}) characters? They are Scheme syntax to | |
2987 | introduce a literal list; @code{'} is synonymous with @code{quote}. | |
2988 | @xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, | |
2989 | for details. Here the value of the @code{arguments} field is a list of | |
2990 | arguments passed to the build system down the road, as with @code{apply} | |
2991 | (@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference | |
2992 | Manual}). | |
2993 | ||
2994 | The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} | |
2995 | (@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and | |
2996 | @code{#:configure-flags} is a keyword used to pass a keyword argument | |
2997 | to the build system (@pxref{Coding With Keywords,,, guile, GNU Guile | |
2998 | Reference Manual}). | |
2999 | ||
3dc1970d LC |
3000 | @item |
3001 | The @code{inputs} field specifies inputs to the build process---i.e., | |
3002 | build-time or run-time dependencies of the package. Here, we define an | |
3003 | input called @code{"gawk"} whose value is that of the @var{gawk} | |
3004 | variable; @var{gawk} is itself bound to a @code{<package>} object. | |
3005 | ||
654c0d97 LC |
3006 | @cindex backquote (quasiquote) |
3007 | @findex ` | |
3008 | @findex quasiquote | |
3009 | @cindex comma (unquote) | |
3010 | @findex , | |
3011 | @findex unquote | |
3012 | @findex ,@@ | |
3013 | @findex unquote-splicing | |
3014 | Again, @code{`} (a backquote, synonymous with @code{quasiquote}) allows | |
3015 | us to introduce a literal list in the @code{inputs} field, while | |
3016 | @code{,} (a comma, synonymous with @code{unquote}) allows us to insert a | |
3017 | value in that list (@pxref{Expression Syntax, unquote,, guile, GNU Guile | |
3018 | Reference Manual}). | |
3019 | ||
3dc1970d LC |
3020 | Note that GCC, Coreutils, Bash, and other essential tools do not need to |
3021 | be specified as inputs here. Instead, @var{gnu-build-system} takes care | |
7458bd0a | 3022 | of ensuring that they are present (@pxref{Build Systems}). |
3dc1970d LC |
3023 | |
3024 | However, any other dependencies need to be specified in the | |
3025 | @code{inputs} field. Any dependency not specified here will simply be | |
3026 | unavailable to the build process, possibly leading to a build failure. | |
3027 | @end itemize | |
3028 | ||
87eafdbd TUBK |
3029 | @xref{package Reference}, for a full description of possible fields. |
3030 | ||
2f7d2d91 | 3031 | Once a package definition is in place, the |
e49951eb | 3032 | package may actually be built using the @code{guix build} command-line |
fc06b15e AP |
3033 | tool (@pxref{Invoking guix build}), troubleshooting any build failures |
3034 | you encounter (@pxref{Debugging Build Failures}). You can easily jump back to the | |
39bee8a2 LC |
3035 | package definition using the @command{guix edit} command |
3036 | (@pxref{Invoking guix edit}). | |
3037 | @xref{Packaging Guidelines}, for | |
b4f5e0e8 CR |
3038 | more information on how to test package definitions, and |
3039 | @ref{Invoking guix lint}, for information on how to check a definition | |
3040 | for style conformance. | |
b7ebcfe3 LC |
3041 | @vindex GUIX_PACKAGE_PATH |
3042 | Lastly, @pxref{Package Modules}, for information | |
3043 | on how to extend the distribution by adding your own package definitions | |
3044 | to @code{GUIX_PACKAGE_PATH}. | |
b4f5e0e8 | 3045 | |
f97c9175 | 3046 | Finally, updating the package definition to a new upstream version |
7458bd0a LC |
3047 | can be partly automated by the @command{guix refresh} command |
3048 | (@pxref{Invoking guix refresh}). | |
3dc1970d LC |
3049 | |
3050 | Behind the scenes, a derivation corresponding to the @code{<package>} | |
3051 | object is first computed by the @code{package-derivation} procedure. | |
834129e0 | 3052 | That derivation is stored in a @code{.drv} file under @file{/gnu/store}. |
ba55b1cb | 3053 | The build actions it prescribes may then be realized by using the |
3dc1970d LC |
3054 | @code{build-derivations} procedure (@pxref{The Store}). |
3055 | ||
3056 | @deffn {Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}] | |
59688fc4 LC |
3057 | Return the @code{<derivation>} object of @var{package} for @var{system} |
3058 | (@pxref{Derivations}). | |
3dc1970d LC |
3059 | |
3060 | @var{package} must be a valid @code{<package>} object, and @var{system} | |
3061 | must be a string denoting the target system type---e.g., | |
3062 | @code{"x86_64-linux"} for an x86_64 Linux-based GNU system. @var{store} | |
3063 | must be a connection to the daemon, which operates on the store | |
3064 | (@pxref{The Store}). | |
3065 | @end deffn | |
568717fd | 3066 | |
9c1edabd LC |
3067 | @noindent |
3068 | @cindex cross-compilation | |
3069 | Similarly, it is possible to compute a derivation that cross-builds a | |
3070 | package for some other system: | |
3071 | ||
3072 | @deffn {Scheme Procedure} package-cross-derivation @var{store} @ | |
3073 | @var{package} @var{target} [@var{system}] | |
59688fc4 LC |
3074 | Return the @code{<derivation>} object of @var{package} cross-built from |
3075 | @var{system} to @var{target}. | |
9c1edabd LC |
3076 | |
3077 | @var{target} must be a valid GNU triplet denoting the target hardware | |
3078 | and operating system, such as @code{"mips64el-linux-gnu"} | |
3079 | (@pxref{Configuration Names, GNU configuration triplets,, configure, GNU | |
3080 | Configure and Build System}). | |
3081 | @end deffn | |
3082 | ||
2a75b0b6 LC |
3083 | @cindex package transformations |
3084 | @cindex input rewriting | |
3085 | @cindex dependency tree rewriting | |
3086 | Packages can be manipulated in arbitrary ways. An example of a useful | |
3087 | transformation is @dfn{input rewriting}, whereby the dependency tree of | |
3088 | a package is rewritten by replacing specific inputs by others: | |
3089 | ||
3090 | @deffn {Scheme Procedure} package-input-rewriting @var{replacements} @ | |
3091 | [@var{rewrite-name}] | |
3092 | Return a procedure that, when passed a package, replaces its direct and | |
3093 | indirect dependencies (but not its implicit inputs) according to | |
3094 | @var{replacements}. @var{replacements} is a list of package pairs; the | |
3095 | first element of each pair is the package to replace, and the second one | |
3096 | is the replacement. | |
3097 | ||
3098 | Optionally, @var{rewrite-name} is a one-argument procedure that takes | |
3099 | the name of a package and returns its new name after rewrite. | |
3100 | @end deffn | |
3101 | ||
3102 | @noindent | |
3103 | Consider this example: | |
3104 | ||
3105 | @example | |
3106 | (define libressl-instead-of-openssl | |
3107 | ;; This is a procedure to replace OPENSSL by LIBRESSL, | |
3108 | ;; recursively. | |
3109 | (package-input-rewriting `((,openssl . ,libressl)))) | |
3110 | ||
3111 | (define git-with-libressl | |
3112 | (libressl-instead-of-openssl git)) | |
3113 | @end example | |
3114 | ||
3115 | @noindent | |
3116 | Here we first define a rewriting procedure that replaces @var{openssl} | |
3117 | with @var{libressl}. Then we use it to define a @dfn{variant} of the | |
3118 | @var{git} package that uses @var{libressl} instead of @var{openssl}. | |
3119 | This is exactly what the @option{--with-input} command-line option does | |
3120 | (@pxref{Package Transformation Options, @option{--with-input}}). | |
3121 | ||
f37f2b83 LC |
3122 | A more generic procedure to rewrite a package dependency graph is |
3123 | @code{package-mapping}: it supports arbitrary changes to nodes in the | |
3124 | graph. | |
3125 | ||
3126 | @deffn {Scheme Procedure} package-mapping @var{proc} [@var{cut?}] | |
3127 | Return a procedure that, given a package, applies @var{proc} to all the packages | |
3128 | depended on and returns the resulting package. The procedure stops recursion | |
3129 | when @var{cut?} returns true for a given package. | |
3130 | @end deffn | |
3131 | ||
87eafdbd TUBK |
3132 | @menu |
3133 | * package Reference :: The package data type. | |
3134 | * origin Reference:: The origin data type. | |
3135 | @end menu | |
3136 | ||
3137 | ||
3138 | @node package Reference | |
3139 | @subsection @code{package} Reference | |
3140 | ||
3141 | This section summarizes all the options available in @code{package} | |
3142 | declarations (@pxref{Defining Packages}). | |
3143 | ||
3144 | @deftp {Data Type} package | |
3145 | This is the data type representing a package recipe. | |
3146 | ||
3147 | @table @asis | |
3148 | @item @code{name} | |
3149 | The name of the package, as a string. | |
3150 | ||
3151 | @item @code{version} | |
3152 | The version of the package, as a string. | |
3153 | ||
3154 | @item @code{source} | |
da675305 LC |
3155 | An object telling how the source code for the package should be |
3156 | acquired. Most of the time, this is an @code{origin} object, which | |
3157 | denotes a file fetched from the Internet (@pxref{origin Reference}). It | |
3158 | can also be any other ``file-like'' object such as a @code{local-file}, | |
3159 | which denotes a file from the local file system (@pxref{G-Expressions, | |
3160 | @code{local-file}}). | |
87eafdbd TUBK |
3161 | |
3162 | @item @code{build-system} | |
3163 | The build system that should be used to build the package (@pxref{Build | |
3164 | Systems}). | |
3165 | ||
3166 | @item @code{arguments} (default: @code{'()}) | |
3167 | The arguments that should be passed to the build system. This is a | |
3168 | list, typically containing sequential keyword-value pairs. | |
3169 | ||
3170 | @item @code{inputs} (default: @code{'()}) | |
70650c68 LC |
3171 | @itemx @code{native-inputs} (default: @code{'()}) |
3172 | @itemx @code{propagated-inputs} (default: @code{'()}) | |
3173 | @cindex inputs, of packages | |
3174 | These fields list dependencies of the package. Each one is a list of | |
3175 | tuples, where each tuple has a label for the input (a string) as its | |
3176 | first element, a package, origin, or derivation as its second element, | |
3177 | and optionally the name of the output thereof that should be used, which | |
3178 | defaults to @code{"out"} (@pxref{Packages with Multiple Outputs}, for | |
f97c9175 | 3179 | more on package outputs). For example, the list below specifies three |
70650c68 | 3180 | inputs: |
87eafdbd | 3181 | |
70650c68 LC |
3182 | @example |
3183 | `(("libffi" ,libffi) | |
3184 | ("libunistring" ,libunistring) | |
3185 | ("glib:bin" ,glib "bin")) ;the "bin" output of Glib | |
3186 | @end example | |
3187 | ||
3188 | @cindex cross compilation, package dependencies | |
3189 | The distinction between @code{native-inputs} and @code{inputs} is | |
3190 | necessary when considering cross-compilation. When cross-compiling, | |
3191 | dependencies listed in @code{inputs} are built for the @emph{target} | |
3192 | architecture; conversely, dependencies listed in @code{native-inputs} | |
3193 | are built for the architecture of the @emph{build} machine. | |
3194 | ||
f97c9175 AE |
3195 | @code{native-inputs} is typically used to list tools needed at |
3196 | build time, but not at run time, such as Autoconf, Automake, pkg-config, | |
70650c68 LC |
3197 | Gettext, or Bison. @command{guix lint} can report likely mistakes in |
3198 | this area (@pxref{Invoking guix lint}). | |
3199 | ||
3200 | @anchor{package-propagated-inputs} | |
3201 | Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the | |
f97c9175 AE |
3202 | specified packages will be automatically installed alongside the package |
3203 | they belong to (@pxref{package-cmd-propagated-inputs, @command{guix | |
70650c68 LC |
3204 | package}}, for information on how @command{guix package} deals with |
3205 | propagated inputs.) | |
21461f27 | 3206 | |
e0508b6b LC |
3207 | For example this is necessary when a C/C++ library needs headers of |
3208 | another library to compile, or when a pkg-config file refers to another | |
3209 | one @i{via} its @code{Requires} field. | |
3210 | ||
f97c9175 AE |
3211 | Another example where @code{propagated-inputs} is useful is for languages |
3212 | that lack a facility to record the run-time search path akin to the | |
c8ebb4c4 | 3213 | @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and |
e0508b6b LC |
3214 | more. To ensure that libraries written in those languages can find |
3215 | library code they depend on at run time, run-time dependencies must be | |
3216 | listed in @code{propagated-inputs} rather than @code{inputs}. | |
87eafdbd | 3217 | |
87eafdbd TUBK |
3218 | @item @code{self-native-input?} (default: @code{#f}) |
3219 | This is a Boolean field telling whether the package should use itself as | |
3220 | a native input when cross-compiling. | |
3221 | ||
3222 | @item @code{outputs} (default: @code{'("out")}) | |
3223 | The list of output names of the package. @xref{Packages with Multiple | |
3224 | Outputs}, for typical uses of additional outputs. | |
3225 | ||
3226 | @item @code{native-search-paths} (default: @code{'()}) | |
3227 | @itemx @code{search-paths} (default: @code{'()}) | |
3228 | A list of @code{search-path-specification} objects describing | |
3229 | search-path environment variables honored by the package. | |
3230 | ||
3231 | @item @code{replacement} (default: @code{#f}) | |
f97c9175 | 3232 | This must be either @code{#f} or a package object that will be used as a |
87eafdbd TUBK |
3233 | @dfn{replacement} for this package. @xref{Security Updates, grafts}, |
3234 | for details. | |
3235 | ||
3236 | @item @code{synopsis} | |
3237 | A one-line description of the package. | |
3238 | ||
3239 | @item @code{description} | |
3240 | A more elaborate description of the package. | |
3241 | ||
3242 | @item @code{license} | |
e32171ee | 3243 | @cindex license, of packages |
f97c9175 AE |
3244 | The license of the package; a value from @code{(guix licenses)}, |
3245 | or a list of such values. | |
87eafdbd TUBK |
3246 | |
3247 | @item @code{home-page} | |
3248 | The URL to the home-page of the package, as a string. | |
3249 | ||
3250 | @item @code{supported-systems} (default: @var{%supported-systems}) | |
3251 | The list of systems supported by the package, as strings of the form | |
3252 | @code{architecture-kernel}, for example @code{"x86_64-linux"}. | |
3253 | ||
3254 | @item @code{maintainers} (default: @code{'()}) | |
3255 | The list of maintainers of the package, as @code{maintainer} objects. | |
3256 | ||
3257 | @item @code{location} (default: source location of the @code{package} form) | |
f97c9175 | 3258 | The source location of the package. It is useful to override this when |
87eafdbd TUBK |
3259 | inheriting from another package, in which case this field is not |
3260 | automatically corrected. | |
3261 | @end table | |
3262 | @end deftp | |
3263 | ||
3264 | ||
3265 | @node origin Reference | |
3266 | @subsection @code{origin} Reference | |
3267 | ||
3268 | This section summarizes all the options available in @code{origin} | |
3269 | declarations (@pxref{Defining Packages}). | |
3270 | ||
3271 | @deftp {Data Type} origin | |
3272 | This is the data type representing a source code origin. | |
3273 | ||
3274 | @table @asis | |
3275 | @item @code{uri} | |
3276 | An object containing the URI of the source. The object type depends on | |
3277 | the @code{method} (see below). For example, when using the | |
3278 | @var{url-fetch} method of @code{(guix download)}, the valid @code{uri} | |
3279 | values are: a URL represented as a string, or a list thereof. | |
3280 | ||
3281 | @item @code{method} | |
f97c9175 | 3282 | A procedure that handles the URI. |
87eafdbd TUBK |
3283 | |
3284 | Examples include: | |
3285 | ||
3286 | @table @asis | |
3287 | @item @var{url-fetch} from @code{(guix download)} | |
f97c9175 | 3288 | download a file from the HTTP, HTTPS, or FTP URL specified in the |
87eafdbd TUBK |
3289 | @code{uri} field; |
3290 | ||
db97a03a | 3291 | @vindex git-fetch |
87eafdbd TUBK |
3292 | @item @var{git-fetch} from @code{(guix git-download)} |
3293 | clone the Git version control repository, and check out the revision | |
3294 | specified in the @code{uri} field as a @code{git-reference} object; a | |
3295 | @code{git-reference} looks like this: | |
3296 | ||
3297 | @example | |
3298 | (git-reference | |
3299 | (url "git://git.debian.org/git/pkg-shadow/shadow") | |
3300 | (commit "v4.1.5.1")) | |
3301 | @end example | |
3302 | @end table | |
3303 | ||
3304 | @item @code{sha256} | |
3305 | A bytevector containing the SHA-256 hash of the source. Typically the | |
3306 | @code{base32} form is used here to generate the bytevector from a | |
3307 | base-32 string. | |
3308 | ||
db97a03a LC |
3309 | You can obtain this information using @code{guix download} |
3310 | (@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking | |
3311 | guix hash}). | |
3312 | ||
87eafdbd TUBK |
3313 | @item @code{file-name} (default: @code{#f}) |
3314 | The file name under which the source code should be saved. When this is | |
3315 | @code{#f}, a sensible default value will be used in most cases. In case | |
3316 | the source is fetched from a URL, the file name from the URL will be | |
f97c9175 | 3317 | used. For version control checkouts, it is recommended to provide the |
87eafdbd TUBK |
3318 | file name explicitly because the default is not very descriptive. |
3319 | ||
3320 | @item @code{patches} (default: @code{'()}) | |
ec5495ba LC |
3321 | A list of file names, origins, or file-like objects (@pxref{G-Expressions, |
3322 | file-like objects}) pointing to patches to be applied to the source. | |
87eafdbd | 3323 | |
0dfebdaa LC |
3324 | This list of patches must be unconditional. In particular, it cannot |
3325 | depend on the value of @code{%current-system} or | |
3326 | @code{%current-target-system}. | |
3327 | ||
87eafdbd | 3328 | @item @code{snippet} (default: @code{#f}) |
1929fdba LC |
3329 | A G-expression (@pxref{G-Expressions}) or S-expression that will be run |
3330 | in the source directory. This is a convenient way to modify the source, | |
3331 | sometimes more convenient than a patch. | |
87eafdbd TUBK |
3332 | |
3333 | @item @code{patch-flags} (default: @code{'("-p1")}) | |
3334 | A list of command-line flags that should be passed to the @code{patch} | |
3335 | command. | |
3336 | ||
3337 | @item @code{patch-inputs} (default: @code{#f}) | |
3338 | Input packages or derivations to the patching process. When this is | |
3339 | @code{#f}, the usual set of inputs necessary for patching are provided, | |
3340 | such as GNU@tie{}Patch. | |
3341 | ||
3342 | @item @code{modules} (default: @code{'()}) | |
3343 | A list of Guile modules that should be loaded during the patching | |
3344 | process and while running the code in the @code{snippet} field. | |
3345 | ||
87eafdbd TUBK |
3346 | @item @code{patch-guile} (default: @code{#f}) |
3347 | The Guile package that should be used in the patching process. When | |
3348 | this is @code{#f}, a sensible default is used. | |
3349 | @end table | |
3350 | @end deftp | |
3351 | ||
9c1edabd | 3352 | |
7458bd0a LC |
3353 | @node Build Systems |
3354 | @section Build Systems | |
3355 | ||
3356 | @cindex build system | |
3357 | Each package definition specifies a @dfn{build system} and arguments for | |
3358 | that build system (@pxref{Defining Packages}). This @code{build-system} | |
f97c9175 | 3359 | field represents the build procedure of the package, as well as implicit |
7458bd0a LC |
3360 | dependencies of that build procedure. |
3361 | ||
3362 | Build systems are @code{<build-system>} objects. The interface to | |
3363 | create and manipulate them is provided by the @code{(guix build-system)} | |
3364 | module, and actual build systems are exported by specific modules. | |
3365 | ||
f5fd4fd2 | 3366 | @cindex bag (low-level package representation) |
0d5a559f LC |
3367 | Under the hood, build systems first compile package objects to |
3368 | @dfn{bags}. A @dfn{bag} is like a package, but with less | |
3369 | ornamentation---in other words, a bag is a lower-level representation of | |
3370 | a package, which includes all the inputs of that package, including some | |
3371 | that were implicitly added by the build system. This intermediate | |
3372 | representation is then compiled to a derivation (@pxref{Derivations}). | |
3373 | ||
7458bd0a LC |
3374 | Build systems accept an optional list of @dfn{arguments}. In package |
3375 | definitions, these are passed @i{via} the @code{arguments} field | |
3376 | (@pxref{Defining Packages}). They are typically keyword arguments | |
3377 | (@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU | |
3378 | Guile Reference Manual}). The value of these arguments is usually | |
3379 | evaluated in the @dfn{build stratum}---i.e., by a Guile process launched | |
3380 | by the daemon (@pxref{Derivations}). | |
3381 | ||
3382 | The main build system is @var{gnu-build-system}, which implements the | |
f97c9175 | 3383 | standard build procedure for GNU and many other packages. It |
7458bd0a LC |
3384 | is provided by the @code{(guix build-system gnu)} module. |
3385 | ||
3386 | @defvr {Scheme Variable} gnu-build-system | |
3387 | @var{gnu-build-system} represents the GNU Build System, and variants | |
3388 | thereof (@pxref{Configuration, configuration and makefile conventions,, | |
3389 | standards, GNU Coding Standards}). | |
3390 | ||
3391 | @cindex build phases | |
f97c9175 | 3392 | In a nutshell, packages using it are configured, built, and installed with |
7458bd0a LC |
3393 | the usual @code{./configure && make && make check && make install} |
3394 | command sequence. In practice, a few additional steps are often needed. | |
3395 | All these steps are split up in separate @dfn{phases}, | |
3396 | notably@footnote{Please see the @code{(guix build gnu-build-system)} | |
3397 | modules for more details about the build phases.}: | |
3398 | ||
3399 | @table @code | |
3400 | @item unpack | |
3401 | Unpack the source tarball, and change the current directory to the | |
3402 | extracted source tree. If the source is actually a directory, copy it | |
3403 | to the build tree, and enter that directory. | |
3404 | ||
3405 | @item patch-source-shebangs | |
3406 | Patch shebangs encountered in source files so they refer to the right | |
3407 | store file names. For instance, this changes @code{#!/bin/sh} to | |
3408 | @code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}. | |
3409 | ||
3410 | @item configure | |
3411 | Run the @file{configure} script with a number of default options, such | |
3412 | as @code{--prefix=/gnu/store/@dots{}}, as well as the options specified | |
3413 | by the @code{#:configure-flags} argument. | |
3414 | ||
3415 | @item build | |
3416 | Run @code{make} with the list of flags specified with | |
0917e80e | 3417 | @code{#:make-flags}. If the @code{#:parallel-build?} argument is true |
7458bd0a LC |
3418 | (the default), build with @code{make -j}. |
3419 | ||
3420 | @item check | |
3421 | Run @code{make check}, or some other target specified with | |
3422 | @code{#:test-target}, unless @code{#:tests? #f} is passed. If the | |
3423 | @code{#:parallel-tests?} argument is true (the default), run @code{make | |
3424 | check -j}. | |
3425 | ||
3426 | @item install | |
3427 | Run @code{make install} with the flags listed in @code{#:make-flags}. | |
3428 | ||
3429 | @item patch-shebangs | |
3430 | Patch shebangs on the installed executable files. | |
3431 | ||
3432 | @item strip | |
3433 | Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} | |
3434 | is false), copying them to the @code{debug} output when available | |
3435 | (@pxref{Installing Debugging Files}). | |
3436 | @end table | |
3437 | ||
3438 | @vindex %standard-phases | |
3439 | The build-side module @code{(guix build gnu-build-system)} defines | |
3440 | @var{%standard-phases} as the default list of build phases. | |
3441 | @var{%standard-phases} is a list of symbol/procedure pairs, where the | |
3442 | procedure implements the actual phase. | |
3443 | ||
3444 | The list of phases used for a particular package can be changed with the | |
3445 | @code{#:phases} parameter. For instance, passing: | |
3446 | ||
3447 | @example | |
c2c5dc79 | 3448 | #:phases (modify-phases %standard-phases (delete 'configure)) |
7458bd0a LC |
3449 | @end example |
3450 | ||
9bf404e9 | 3451 | means that all the phases described above will be used, except the |
7458bd0a LC |
3452 | @code{configure} phase. |
3453 | ||
3454 | In addition, this build system ensures that the ``standard'' environment | |
3455 | for GNU packages is available. This includes tools such as GCC, libc, | |
3456 | Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix | |
f97c9175 AE |
3457 | build-system gnu)} module for a complete list). We call these the |
3458 | @dfn{implicit inputs} of a package, because package definitions do not | |
7458bd0a LC |
3459 | have to mention them. |
3460 | @end defvr | |
3461 | ||
3462 | Other @code{<build-system>} objects are defined to support other | |
3463 | conventions and tools used by free software packages. They inherit most | |
3464 | of @var{gnu-build-system}, and differ mainly in the set of inputs | |
3465 | implicitly added to the build process, and in the list of phases | |
3466 | executed. Some of these build systems are listed below. | |
3467 | ||
5f7a1a4d RW |
3468 | @defvr {Scheme Variable} ant-build-system |
3469 | This variable is exported by @code{(guix build-system ant)}. It | |
3470 | implements the build procedure for Java packages that can be built with | |
3471 | @url{http://ant.apache.org/, Ant build tool}. | |
3472 | ||
3473 | It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as | |
3474 | provided by the @code{icedtea} package to the set of inputs. Different | |
3475 | packages can be specified with the @code{#:ant} and @code{#:jdk} | |
3476 | parameters, respectively. | |
3477 | ||
3478 | When the original package does not provide a suitable Ant build file, | |
3479 | the parameter @code{#:jar-name} can be used to generate a minimal Ant | |
3480 | build file @file{build.xml} with tasks to build the specified jar | |
8df64f73 HG |
3481 | archive. In this case the parameter @code{#:source-dir} can be used to |
3482 | specify the source sub-directory, defaulting to ``src''. | |
5f7a1a4d | 3483 | |
8df1faa0 JL |
3484 | The @code{#:main-class} parameter can be used with the minimal ant |
3485 | buildfile to specify the main class of the resulting jar. This makes the | |
f403d7ab JL |
3486 | jar file executable. The @code{#:test-include} parameter can be used to |
3487 | specify the list of junit tests to run. It defaults to | |
3488 | @code{(list "**/*Test.java")}. The @code{#:test-exclude} can be used to | |
3489 | disable some tests. It defaults to @code{(list "**/Abstract*.java")}, | |
3490 | because abstract classes cannot be run as tests. | |
8df1faa0 | 3491 | |
5f7a1a4d RW |
3492 | The parameter @code{#:build-target} can be used to specify the Ant task |
3493 | that should be run during the @code{build} phase. By default the | |
3494 | ``jar'' task will be run. | |
3495 | ||
3496 | @end defvr | |
3497 | ||
a1b30f99 AP |
3498 | @defvr {Scheme Variable} asdf-build-system/source |
3499 | @defvrx {Scheme Variable} asdf-build-system/sbcl | |
3500 | @defvrx {Scheme Variable} asdf-build-system/ecl | |
3501 | ||
3502 | These variables, exported by @code{(guix build-system asdf)}, implement | |
3503 | build procedures for Common Lisp packages using | |
3504 | @url{https://common-lisp.net/project/asdf/, ``ASDF''}. ASDF is a system | |
3505 | definition facility for Common Lisp programs and libraries. | |
3506 | ||
3507 | The @code{asdf-build-system/source} system installs the packages in | |
3508 | source form, and can be loaded using any common lisp implementation, via | |
3509 | ASDF. The others, such as @code{asdf-build-system/sbcl}, install binary | |
3510 | systems in the format which a particular implementation understands. | |
3511 | These build systems can also be used to produce executable programs, or | |
3512 | lisp images which contain a set of packages pre-loaded. | |
3513 | ||
3514 | The build system uses naming conventions. For binary packages, the | |
8a3814cd AP |
3515 | package name should be prefixed with the lisp implementation, such as |
3516 | @code{sbcl-} for @code{asdf-build-system/sbcl}. | |
a1b30f99 AP |
3517 | |
3518 | Additionally, the corresponding source package should be labeled using | |
3519 | the same convention as python packages (see @ref{Python Modules}), using | |
3520 | the @code{cl-} prefix. | |
3521 | ||
3522 | For binary packages, each system should be defined as a Guix package. | |
3523 | If one package @code{origin} contains several systems, package variants | |
3524 | can be created in order to build all the systems. Source packages, | |
3525 | which use @code{asdf-build-system/source}, may contain several systems. | |
3526 | ||
3527 | In order to create executable programs and images, the build-side | |
3528 | procedures @code{build-program} and @code{build-image} can be used. | |
3529 | They should be called in a build phase after the @code{create-symlinks} | |
3530 | phase, so that the system which was just built can be used within the | |
3531 | resulting image. @code{build-program} requires a list of Common Lisp | |
3532 | expressions to be passed as the @code{#:entry-program} argument. | |
3533 | ||
3534 | If the system is not defined within its own @code{.asd} file of the same | |
3535 | name, then the @code{#:asd-file} parameter should be used to specify | |
8a3814cd AP |
3536 | which file the system is defined in. Furthermore, if the package |
3537 | defines a system for its tests in a separate file, it will be loaded | |
3538 | before the tests are run if it is specified by the | |
3539 | @code{#:test-asd-file} parameter. If it is not set, the files | |
3540 | @code{<system>-tests.asd}, @code{<system>-test.asd}, @code{tests.asd}, | |
3541 | and @code{test.asd} will be tried if they exist. | |
3542 | ||
3543 | If for some reason the package must be named in a different way than the | |
3544 | naming conventions suggest, the @code{#:asd-system-name} parameter can | |
3545 | be used to specify the name of the system. | |
a1b30f99 AP |
3546 | |
3547 | @end defvr | |
3548 | ||
1ec34dd7 LC |
3549 | @defvr {Scheme Variable} cargo-build-system |
3550 | @cindex Rust programming language | |
3551 | @cindex Cargo (Rust build system) | |
3552 | This variable is exported by @code{(guix build-system cargo)}. It | |
3553 | supports builds of packages using Cargo, the build tool of the | |
3554 | @uref{https://www.rust-lang.org, Rust programming language}. | |
3555 | ||
3556 | In its @code{configure} phase, this build system replaces dependencies | |
3557 | specified in the @file{Carto.toml} file with inputs to the Guix package. | |
3558 | The @code{install} phase installs the binaries, and it also installs the | |
3559 | source code and @file{Cargo.toml} file. | |
3560 | @end defvr | |
3561 | ||
7458bd0a LC |
3562 | @defvr {Scheme Variable} cmake-build-system |
3563 | This variable is exported by @code{(guix build-system cmake)}. It | |
3564 | implements the build procedure for packages using the | |
3565 | @url{http://www.cmake.org, CMake build tool}. | |
3566 | ||
3567 | It automatically adds the @code{cmake} package to the set of inputs. | |
3568 | Which package is used can be specified with the @code{#:cmake} | |
3569 | parameter. | |
9849cfc1 LC |
3570 | |
3571 | The @code{#:configure-flags} parameter is taken as a list of flags | |
3572 | passed to the @command{cmake} command. The @code{#:build-type} | |
3573 | parameter specifies in abstract terms the flags passed to the compiler; | |
3574 | it defaults to @code{"RelWithDebInfo"} (short for ``release mode with | |
3575 | debugging information''), which roughly means that code is compiled with | |
3576 | @code{-O2 -g}, as is the case for Autoconf-based packages by default. | |
7458bd0a LC |
3577 | @end defvr |
3578 | ||
3afcf52b FB |
3579 | @defvr {Scheme Variable} glib-or-gtk-build-system |
3580 | This variable is exported by @code{(guix build-system glib-or-gtk)}. It | |
3581 | is intended for use with packages making use of GLib or GTK+. | |
3582 | ||
3583 | This build system adds the following two phases to the ones defined by | |
3584 | @var{gnu-build-system}: | |
3585 | ||
3586 | @table @code | |
3587 | @item glib-or-gtk-wrap | |
f97c9175 AE |
3588 | The phase @code{glib-or-gtk-wrap} ensures that programs in |
3589 | @file{bin/} are able to find GLib ``schemas'' and | |
3afcf52b FB |
3590 | @uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ |
3591 | modules}. This is achieved by wrapping the programs in launch scripts | |
3592 | that appropriately set the @code{XDG_DATA_DIRS} and @code{GTK_PATH} | |
3593 | environment variables. | |
3594 | ||
73aa8ddb LC |
3595 | It is possible to exclude specific package outputs from that wrapping |
3596 | process by listing their names in the | |
3597 | @code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful | |
3598 | when an output is known not to contain any GLib or GTK+ binaries, and | |
3599 | where wrapping would gratuitously add a dependency of that output on | |
3600 | GLib and GTK+. | |
3601 | ||
3afcf52b | 3602 | @item glib-or-gtk-compile-schemas |
f97c9175 | 3603 | The phase @code{glib-or-gtk-compile-schemas} makes sure that all |
3afcf52b | 3604 | @uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, |
f97c9175 | 3605 | GSettings schemas} of GLib are compiled. Compilation is performed by the |
3afcf52b FB |
3606 | @command{glib-compile-schemas} program. It is provided by the package |
3607 | @code{glib:bin} which is automatically imported by the build system. | |
3608 | The @code{glib} package providing @command{glib-compile-schemas} can be | |
3609 | specified with the @code{#:glib} parameter. | |
3610 | @end table | |
3611 | ||
3612 | Both phases are executed after the @code{install} phase. | |
3613 | @end defvr | |
3614 | ||
88c8f247 RW |
3615 | @defvr {Scheme Variable} minify-build-system |
3616 | This variable is exported by @code{(guix build-system minify)}. It | |
3617 | implements a minification procedure for simple JavaScript packages. | |
3618 | ||
3619 | It adds @code{uglify-js} to the set of inputs and uses it to compress | |
3620 | all JavaScript files in the @file{src} directory. A different minifier | |
3621 | package can be specified with the @code{#:uglify-js} parameter, but it | |
3622 | is expected that the package writes the minified code to the standard | |
3623 | output. | |
3624 | ||
3625 | When the input JavaScript files are not all located in the @file{src} | |
3626 | directory, the parameter @code{#:javascript-files} can be used to | |
3627 | specify a list of file names to feed to the minifier. | |
3628 | @end defvr | |
3629 | ||
3184f14a | 3630 | @defvr {Scheme Variable} ocaml-build-system |
9fc221b5 | 3631 | This variable is exported by @code{(guix build-system ocaml)}. It implements |
3184f14a JL |
3632 | a build procedure for @uref{https://ocaml.org, OCaml} packages, which consists |
3633 | of choosing the correct set of commands to run for each package. OCaml | |
3634 | packages can expect many different commands to be run. This build system will | |
3635 | try some of them. | |
3636 | ||
3637 | When the package has a @file{setup.ml} file present at the top-level, it will | |
3638 | run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and | |
3639 | @code{ocaml setup.ml -install}. The build system will assume that this file | |
3640 | was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will take | |
3641 | care of setting the prefix and enabling tests if they are not disabled. You | |
3642 | can pass configure and build flags with the @code{#:configure-flags} and | |
3643 | @code{#:build-flags}. The @code{#:test-flags} key can be passed to change the | |
3644 | set of flags used to enable tests. The @code{#:use-make?} key can be used to | |
3645 | bypass this system in the build and install phases. | |
3646 | ||
3647 | When the package has a @file{configure} file, it is assumed that it is a | |
3648 | hand-made configure script that requires a different argument format than | |
3649 | in the @code{gnu-build-system}. You can add more flags with the | |
3650 | @code{#:configure-flags} key. | |
3651 | ||
3652 | When the package has a @file{Makefile} file (or @code{#:use-make?} is | |
3653 | @code{#t}), it will be used and more flags can be passed to the build and | |
3654 | install phases with the @code{#:make-flags} key. | |
3655 | ||
3656 | Finally, some packages do not have these files and use a somewhat standard | |
3657 | location for its build system. In that case, the build system will run | |
3658 | @code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of | |
3659 | providing the path to the required findlib module. Additional flags can | |
3660 | be passed via the @code{#:build-flags} key. Install is taken care of by | |
3661 | @command{opam-installer}. In this case, the @code{opam} package must | |
3662 | be added to the @code{native-inputs} field of the package definition. | |
3663 | ||
3664 | Note that most OCaml packages assume they will be installed in the same | |
88ba7852 | 3665 | directory as OCaml, which is not what we want in guix. In particular, they |
3184f14a | 3666 | will install @file{.so} files in their module's directory, which is usually |
88ba7852 | 3667 | fine because it is in the OCaml compiler directory. In guix though, these |
3184f14a JL |
3668 | libraries cannot be found and we use @code{CAML_LD_LIBRARY_PATH}. This |
3669 | variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where | |
3670 | @file{.so} libraries should be installed. | |
3671 | @end defvr | |
3672 | ||
7458bd0a LC |
3673 | @defvr {Scheme Variable} python-build-system |
3674 | This variable is exported by @code{(guix build-system python)}. It | |
3675 | implements the more or less standard build procedure used by Python | |
3676 | packages, which consists in running @code{python setup.py build} and | |
3677 | then @code{python setup.py install --prefix=/gnu/store/@dots{}}. | |
3678 | ||
3679 | For packages that install stand-alone Python programs under @code{bin/}, | |
f97c9175 | 3680 | it takes care of wrapping these programs so that their @code{PYTHONPATH} |
7458bd0a LC |
3681 | environment variable points to all the Python libraries they depend on. |
3682 | ||
8a46205b CM |
3683 | Which Python package is used to perform the build can be specified with |
3684 | the @code{#:python} parameter. This is a useful way to force a package | |
3685 | to be built for a specific version of the Python interpreter, which | |
3686 | might be necessary if the package is only compatible with a single | |
3687 | interpreter version. | |
5f7565d1 HG |
3688 | |
3689 | By default guix calls @code{setup.py} under control of | |
3690 | @code{setuptools}, much like @command{pip} does. Some packages are not | |
3691 | compatible with setuptools (and pip), thus you can disable this by | |
3692 | setting the @code{#:use-setuptools} parameter to @code{#f}. | |
7458bd0a LC |
3693 | @end defvr |
3694 | ||
3695 | @defvr {Scheme Variable} perl-build-system | |
3696 | This variable is exported by @code{(guix build-system perl)}. It | |
2d2a53fc EB |
3697 | implements the standard build procedure for Perl packages, which either |
3698 | consists in running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, | |
3699 | followed by @code{Build} and @code{Build install}; or in running | |
3700 | @code{perl Makefile.PL PREFIX=/gnu/store/@dots{}}, followed by | |
f97c9175 | 3701 | @code{make} and @code{make install}, depending on which of |
2d2a53fc EB |
3702 | @code{Build.PL} or @code{Makefile.PL} is present in the package |
3703 | distribution. Preference is given to the former if both @code{Build.PL} | |
3704 | and @code{Makefile.PL} exist in the package distribution. This | |
3705 | preference can be reversed by specifying @code{#t} for the | |
3706 | @code{#:make-maker?} parameter. | |
3707 | ||
3708 | The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation | |
3709 | passes flags specified by the @code{#:make-maker-flags} or | |
3710 | @code{#:module-build-flags} parameter, respectively. | |
7458bd0a LC |
3711 | |
3712 | Which Perl package is used can be specified with @code{#:perl}. | |
3713 | @end defvr | |
3714 | ||
f8f3bef6 RW |
3715 | @defvr {Scheme Variable} r-build-system |
3716 | This variable is exported by @code{(guix build-system r)}. It | |
3717 | implements the build procedure used by @uref{http://r-project.org, R} | |
3718 | packages, which essentially is little more than running @code{R CMD | |
3719 | INSTALL --library=/gnu/store/@dots{}} in an environment where | |
3720 | @code{R_LIBS_SITE} contains the paths to all R package inputs. Tests | |
3721 | are run after installation using the R function | |
3722 | @code{tools::testInstalledPackage}. | |
3723 | @end defvr | |
3724 | ||
205794c8 RW |
3725 | @defvr {Scheme Variable} texlive-build-system |
3726 | This variable is exported by @code{(guix build-system texlive)}. It is | |
3727 | used to build TeX packages in batch mode with a specified engine. The | |
3728 | build system sets the @code{TEXINPUTS} variable to find all TeX source | |
3729 | files in the inputs. | |
3730 | ||
3731 | By default it runs @code{luatex} on all files ending on @code{ins}. A | |
3732 | different engine and format can be specified with the | |
3733 | @code{#:tex-format} argument. Different build targets can be specified | |
3734 | with the @code{#:build-targets} argument, which expects a list of file | |
3735 | names. The build system adds only @code{texlive-bin} and | |
3736 | @code{texlive-latex-base} (both from @code{(gnu packages tex}) to the | |
3737 | inputs. Both can be overridden with the arguments @code{#:texlive-bin} | |
3738 | and @code{#:texlive-latex-base}, respectively. | |
3739 | ||
3740 | The @code{#:tex-directory} parameter tells the build system where to | |
3741 | install the built files under the texmf tree. | |
3742 | @end defvr | |
3743 | ||
c08f9818 DT |
3744 | @defvr {Scheme Variable} ruby-build-system |
3745 | This variable is exported by @code{(guix build-system ruby)}. It | |
3746 | implements the RubyGems build procedure used by Ruby packages, which | |
3747 | involves running @code{gem build} followed by @code{gem install}. | |
3748 | ||
5dc87623 DT |
3749 | The @code{source} field of a package that uses this build system |
3750 | typically references a gem archive, since this is the format that Ruby | |
3751 | developers use when releasing their software. The build system unpacks | |
3752 | the gem archive, potentially patches the source, runs the test suite, | |
3753 | repackages the gem, and installs it. Additionally, directories and | |
3754 | tarballs may be referenced to allow building unreleased gems from Git or | |
3755 | a traditional source release tarball. | |
e83c6d00 | 3756 | |
c08f9818 | 3757 | Which Ruby package is used can be specified with the @code{#:ruby} |
6e9f2913 PP |
3758 | parameter. A list of additional flags to be passed to the @command{gem} |
3759 | command can be specified with the @code{#:gem-flags} parameter. | |
c08f9818 | 3760 | @end defvr |
7458bd0a | 3761 | |
a677c726 RW |
3762 | @defvr {Scheme Variable} waf-build-system |
3763 | This variable is exported by @code{(guix build-system waf)}. It | |
3764 | implements a build procedure around the @code{waf} script. The common | |
3765 | phases---@code{configure}, @code{build}, and @code{install}---are | |
3766 | implemented by passing their names as arguments to the @code{waf} | |
3767 | script. | |
3768 | ||
3769 | The @code{waf} script is executed by the Python interpreter. Which | |
3770 | Python package is used to run the script can be specified with the | |
3771 | @code{#:python} parameter. | |
3772 | @end defvr | |
3773 | ||
14dfdf2e FB |
3774 | @defvr {Scheme Variable} haskell-build-system |
3775 | This variable is exported by @code{(guix build-system haskell)}. It | |
3776 | implements the Cabal build procedure used by Haskell packages, which | |
3777 | involves running @code{runhaskell Setup.hs configure | |
3778 | --prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. | |
3779 | Instead of installing the package by running @code{runhaskell Setup.hs | |
3780 | install}, to avoid trying to register libraries in the read-only | |
3781 | compiler store directory, the build system uses @code{runhaskell | |
3782 | Setup.hs copy}, followed by @code{runhaskell Setup.hs register}. In | |
3783 | addition, the build system generates the package documentation by | |
3784 | running @code{runhaskell Setup.hs haddock}, unless @code{#:haddock? #f} | |
3785 | is passed. Optional Haddock parameters can be passed with the help of | |
3786 | the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} is | |
3787 | not found, the build system looks for @code{Setup.lhs} instead. | |
3788 | ||
3789 | Which Haskell compiler is used can be specified with the @code{#:haskell} | |
a54bd6d7 | 3790 | parameter which defaults to @code{ghc}. |
14dfdf2e FB |
3791 | @end defvr |
3792 | ||
65e862d1 DM |
3793 | @defvr {Scheme Variable} dub-build-system |
3794 | This variable is exported by @code{(guix build-system dub)}. It | |
3795 | implements the Dub build procedure used by D packages, which | |
3796 | involves running @code{dub build} and @code{dub run}. | |
3797 | Installation is done by copying the files manually. | |
3798 | ||
3799 | Which D compiler is used can be specified with the @code{#:ldc} | |
3800 | parameter which defaults to @code{ldc}. | |
3801 | @end defvr | |
3802 | ||
e9137a53 FB |
3803 | @defvr {Scheme Variable} emacs-build-system |
3804 | This variable is exported by @code{(guix build-system emacs)}. It | |
f97c9175 AE |
3805 | implements an installation procedure similar to the packaging system |
3806 | of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual}). | |
e9137a53 FB |
3807 | |
3808 | It first creates the @code{@var{package}-autoloads.el} file, then it | |
3809 | byte compiles all Emacs Lisp files. Differently from the Emacs | |
3810 | packaging system, the Info documentation files are moved to the standard | |
3811 | documentation directory and the @file{dir} file is deleted. Each | |
3812 | package is installed in its own directory under | |
3813 | @file{share/emacs/site-lisp/guix.d}. | |
3814 | @end defvr | |
3815 | ||
3d90fa98 AI |
3816 | @defvr {Scheme Variable} font-build-system |
3817 | This variable is exported by @code{(guix build-system font)}. It | |
3818 | implements an installation procedure for font packages where upstream | |
3819 | provides pre-compiled TrueType, OpenType, etc. font files that merely | |
3820 | need to be copied into place. It copies font files to standard | |
3821 | locations in the output directory. | |
3822 | @end defvr | |
3823 | ||
07c101e2 PM |
3824 | @defvr {Scheme Variable} meson-build-system |
3825 | This variable is exported by @code{(guix build-system meson)}. It | |
3826 | implements the build procedure for packages that use | |
3827 | @url{http://mesonbuild.com, Meson} as their build system. | |
3828 | ||
3829 | It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set | |
3830 | of inputs, and they can be changed with the parameters @code{#:meson} | |
3831 | and @code{#:ninja} if needed. The default Meson is | |
3832 | @code{meson-for-build}, which is special because it doesn't clear the | |
3833 | @code{RUNPATH} of binaries and libraries when they are installed. | |
3834 | ||
3835 | This build system is an extension of @var{gnu-build-system}, but with the | |
3836 | following phases changed to some specific for Meson: | |
3837 | ||
3838 | @table @code | |
3839 | ||
3840 | @item configure | |
3841 | The phase runs @code{meson} with the flags specified in | |
3842 | @code{#:configure-flags}. The flag @code{--build-type} is always set to | |
3843 | @code{plain} unless something else is specified in @code{#:build-type}. | |
3844 | ||
3845 | @item build | |
3846 | The phase runs @code{ninja} to build the package in parallel by default, but | |
3847 | this can be changed with @code{#:parallel-build?}. | |
3848 | ||
3849 | @item check | |
3850 | The phase runs @code{ninja} with the target specified in @code{#:test-target}, | |
3851 | which is @code{"test"} by default. | |
3852 | ||
3853 | @item install | |
3854 | The phase runs @code{ninja install} and can not be changed. | |
3855 | @end table | |
3856 | ||
3857 | Apart from that, the build system also adds the following phases: | |
3858 | ||
3859 | @table @code | |
3860 | ||
3861 | @item fix-runpath | |
3862 | This phase tries to locate the local directories in the package being build, | |
3863 | which has libraries that some of the binaries need. If any are found, they will | |
3864 | be added to the programs @code{RUNPATH}. It is needed because | |
3865 | @code{meson-for-build} keeps the @code{RUNPATH} of binaries and libraries from | |
3866 | when they are build, but often that is not the @code{RUNPATH} we want. | |
3867 | Therefor it is also shrinked to the minimum needed by the program. | |
3868 | ||
3869 | @item glib-or-gtk-wrap | |
3870 | This phase is the phase provided by @code{glib-or-gtk-build-system}, and it | |
3871 | is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}. | |
3872 | ||
3873 | @item glib-or-gtk-compile-schemas | |
3874 | This phase is the phase provided by @code{glib-or-gtk-build-system}, and it | |
3875 | is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}. | |
3876 | @end table | |
3877 | @end defvr | |
3878 | ||
7458bd0a LC |
3879 | Lastly, for packages that do not need anything as sophisticated, a |
3880 | ``trivial'' build system is provided. It is trivial in the sense that | |
3881 | it provides basically no support: it does not pull any implicit inputs, | |
3882 | and does not have a notion of build phases. | |
3883 | ||
3884 | @defvr {Scheme Variable} trivial-build-system | |
3885 | This variable is exported by @code{(guix build-system trivial)}. | |
3886 | ||
3887 | This build system requires a @code{#:builder} argument. This argument | |
f97c9175 | 3888 | must be a Scheme expression that builds the package output(s)---as |
7458bd0a LC |
3889 | with @code{build-expression->derivation} (@pxref{Derivations, |
3890 | @code{build-expression->derivation}}). | |
3891 | @end defvr | |
3892 | ||
568717fd LC |
3893 | @node The Store |
3894 | @section The Store | |
3895 | ||
e531ac2a | 3896 | @cindex store |
1ddee424 | 3897 | @cindex store items |
e531ac2a LC |
3898 | @cindex store paths |
3899 | ||
f97c9175 AE |
3900 | Conceptually, the @dfn{store} is the place where derivations that have |
3901 | been built successfully are stored---by default, @file{/gnu/store}. | |
1ddee424 LC |
3902 | Sub-directories in the store are referred to as @dfn{store items} or |
3903 | sometimes @dfn{store paths}. The store has an associated database that | |
3904 | contains information such as the store paths referred to by each store | |
3905 | path, and the list of @emph{valid} store items---results of successful | |
ef5f5c86 LC |
3906 | builds. This database resides in @file{@var{localstatedir}/guix/db}, |
3907 | where @var{localstatedir} is the state directory specified @i{via} | |
3908 | @option{--localstatedir} at configure time, usually @file{/var}. | |
1ddee424 LC |
3909 | |
3910 | The store is @emph{always} accessed by the daemon on behalf of its clients | |
e531ac2a | 3911 | (@pxref{Invoking guix-daemon}). To manipulate the store, clients |
f97c9175 AE |
3912 | connect to the daemon over a Unix-domain socket, send requests to it, |
3913 | and read the result---these are remote procedure calls, or RPCs. | |
e531ac2a | 3914 | |
1ddee424 LC |
3915 | @quotation Note |
3916 | Users must @emph{never} modify files under @file{/gnu/store} directly. | |
3917 | This would lead to inconsistencies and break the immutability | |
3918 | assumptions of Guix's functional model (@pxref{Introduction}). | |
3919 | ||
3920 | @xref{Invoking guix gc, @command{guix gc --verify}}, for information on | |
3921 | how to check the integrity of the store and attempt recovery from | |
3922 | accidental modifications. | |
3923 | @end quotation | |
3924 | ||
e531ac2a | 3925 | The @code{(guix store)} module provides procedures to connect to the |
1397b422 LC |
3926 | daemon, and to perform RPCs. These are described below. By default, |
3927 | @code{open-connection}, and thus all the @command{guix} commands, | |
3928 | connect to the local daemon or to the URI specified by the | |
3929 | @code{GUIX_DAEMON_SOCKET} environment variable. | |
e531ac2a | 3930 | |
1397b422 LC |
3931 | @defvr {Environment Variable} GUIX_DAEMON_SOCKET |
3932 | When set, the value of this variable should be a file name or a URI | |
3933 | designating the daemon endpoint. When it is a file name, it denotes a | |
3934 | Unix-domain socket to connect to. In addition to file names, the | |
3935 | supported URI schemes are: | |
3936 | ||
3937 | @table @code | |
3938 | @item file | |
3939 | @itemx unix | |
3940 | These are for Unix-domain sockets. | |
3941 | @code{file:///var/guix/daemon-socket/socket} is equivalent to | |
3942 | @file{/var/guix/daemon-socket/socket}. | |
3dff90ce LC |
3943 | |
3944 | @item guix | |
1071f781 LC |
3945 | @cindex daemon, remote access |
3946 | @cindex remote access to the daemon | |
3947 | @cindex daemon, cluster setup | |
3948 | @cindex clusters, daemon setup | |
3dff90ce | 3949 | These URIs denote connections over TCP/IP, without encryption nor |
5df1395a LC |
3950 | authentication of the remote host. The URI must specify the host name |
3951 | and optionally a port number (by default port 44146 is used): | |
3dff90ce LC |
3952 | |
3953 | @example | |
3954 | guix://master.guix.example.org:1234 | |
3955 | @end example | |
3956 | ||
3957 | This setup is suitable on local networks, such as clusters, where only | |
3958 | trusted nodes may connect to the build daemon at | |
3959 | @code{master.guix.example.org}. | |
285f63e8 | 3960 | |
1071f781 LC |
3961 | The @code{--listen} option of @command{guix-daemon} can be used to |
3962 | instruct it to listen for TCP connections (@pxref{Invoking guix-daemon, | |
3963 | @code{--listen}}). | |
3964 | ||
285f63e8 LC |
3965 | @item ssh |
3966 | @cindex SSH access to build daemons | |
3967 | These URIs allow you to connect to a remote daemon over | |
3968 | SSH@footnote{This feature requires Guile-SSH (@pxref{Requirements}).}. | |
3969 | A typical URL might look like this: | |
3970 | ||
3971 | @example | |
3972 | ssh://charlie@@guix.example.org:22 | |
3973 | @end example | |
3974 | ||
3975 | As for @command{guix copy}, the usual OpenSSH client configuration files | |
3976 | are honored (@pxref{Invoking guix copy}). | |
1397b422 LC |
3977 | @end table |
3978 | ||
3979 | Additional URI schemes may be supported in the future. | |
285f63e8 LC |
3980 | |
3981 | @c XXX: Remove this note when the protocol incurs fewer round trips | |
3982 | @c and when (guix derivations) no longer relies on file system access. | |
3983 | @quotation Note | |
3984 | The ability to connect to remote build daemons is considered | |
3985 | experimental as of @value{VERSION}. Please get in touch with us to | |
3986 | share any problems or suggestions you may have (@pxref{Contributing}). | |
3987 | @end quotation | |
1397b422 LC |
3988 | @end defvr |
3989 | ||
3990 | @deffn {Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t] | |
3991 | Connect to the daemon over the Unix-domain socket at @var{uri} (a string). When | |
e531ac2a LC |
3992 | @var{reserve-space?} is true, instruct it to reserve a little bit of |
3993 | extra space on the file system so that the garbage collector can still | |
f97c9175 | 3994 | operate should the disk become full. Return a server object. |
e531ac2a LC |
3995 | |
3996 | @var{file} defaults to @var{%default-socket-path}, which is the normal | |
3997 | location given the options that were passed to @command{configure}. | |
3998 | @end deffn | |
3999 | ||
4000 | @deffn {Scheme Procedure} close-connection @var{server} | |
4001 | Close the connection to @var{server}. | |
4002 | @end deffn | |
4003 | ||
4004 | @defvr {Scheme Variable} current-build-output-port | |
4005 | This variable is bound to a SRFI-39 parameter, which refers to the port | |
4006 | where build and error logs sent by the daemon should be written. | |
4007 | @end defvr | |
4008 | ||
4009 | Procedures that make RPCs all take a server object as their first | |
4010 | argument. | |
4011 | ||
4012 | @deffn {Scheme Procedure} valid-path? @var{server} @var{path} | |
06b76acc LC |
4013 | @cindex invalid store items |
4014 | Return @code{#t} when @var{path} designates a valid store item and | |
4015 | @code{#f} otherwise (an invalid item may exist on disk but still be | |
4016 | invalid, for instance because it is the result of an aborted or failed | |
4017 | build.) | |
4018 | ||
4019 | A @code{&nix-protocol-error} condition is raised if @var{path} is not | |
4020 | prefixed by the store directory (@file{/gnu/store}). | |
e531ac2a LC |
4021 | @end deffn |
4022 | ||
cfbf9160 | 4023 | @deffn {Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}] |
e531ac2a LC |
4024 | Add @var{text} under file @var{name} in the store, and return its store |
4025 | path. @var{references} is the list of store paths referred to by the | |
4026 | resulting store path. | |
4027 | @end deffn | |
4028 | ||
874e6874 | 4029 | @deffn {Scheme Procedure} build-derivations @var{server} @var{derivations} |
59688fc4 LC |
4030 | Build @var{derivations} (a list of @code{<derivation>} objects or |
4031 | derivation paths), and return when the worker is done building them. | |
4032 | Return @code{#t} on success. | |
874e6874 LC |
4033 | @end deffn |
4034 | ||
b860f382 LC |
4035 | Note that the @code{(guix monads)} module provides a monad as well as |
4036 | monadic versions of the above procedures, with the goal of making it | |
4037 | more convenient to work with code that accesses the store (@pxref{The | |
4038 | Store Monad}). | |
4039 | ||
e531ac2a LC |
4040 | @c FIXME |
4041 | @i{This section is currently incomplete.} | |
568717fd LC |
4042 | |
4043 | @node Derivations | |
4044 | @section Derivations | |
4045 | ||
874e6874 LC |
4046 | @cindex derivations |
4047 | Low-level build actions and the environment in which they are performed | |
70458ed5 | 4048 | are represented by @dfn{derivations}. A derivation contains the |
874e6874 LC |
4049 | following pieces of information: |
4050 | ||
4051 | @itemize | |
4052 | @item | |
4053 | The outputs of the derivation---derivations produce at least one file or | |
4054 | directory in the store, but may produce more. | |
4055 | ||
4056 | @item | |
4057 | The inputs of the derivations, which may be other derivations or plain | |
4058 | files in the store (patches, build scripts, etc.) | |
4059 | ||
4060 | @item | |
4061 | The system type targeted by the derivation---e.g., @code{x86_64-linux}. | |
4062 | ||
4063 | @item | |
4064 | The file name of a build script in the store, along with the arguments | |
4065 | to be passed. | |
4066 | ||
4067 | @item | |
4068 | A list of environment variables to be defined. | |
4069 | ||
4070 | @end itemize | |
4071 | ||
4072 | @cindex derivation path | |
4073 | Derivations allow clients of the daemon to communicate build actions to | |
4074 | the store. They exist in two forms: as an in-memory representation, | |
4075 | both on the client- and daemon-side, and as files in the store whose | |
4076 | name end in @code{.drv}---these files are referred to as @dfn{derivation | |
4077 | paths}. Derivations paths can be passed to the @code{build-derivations} | |
4078 | procedure to perform the build actions they prescribe (@pxref{The | |
4079 | Store}). | |
4080 | ||
4081 | The @code{(guix derivations)} module provides a representation of | |
4082 | derivations as Scheme objects, along with procedures to create and | |
4083 | otherwise manipulate derivations. The lowest-level primitive to create | |
4084 | a derivation is the @code{derivation} procedure: | |
4085 | ||
1909431c LC |
4086 | @deffn {Scheme Procedure} derivation @var{store} @var{name} @var{builder} @ |
4087 | @var{args} [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | |
2096ef47 | 4088 | [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ |
1909431c | 4089 | [#:system (%current-system)] [#:references-graphs #f] @ |
35b5ca78 LC |
4090 | [#:allowed-references #f] [#:disallowed-references #f] @ |
4091 | [#:leaked-env-vars #f] [#:local-build? #f] @ | |
4a6aeb67 | 4092 | [#:substitutable? #t] |
59688fc4 LC |
4093 | Build a derivation with the given arguments, and return the resulting |
4094 | @code{<derivation>} object. | |
874e6874 | 4095 | |
2096ef47 | 4096 | When @var{hash} and @var{hash-algo} are given, a |
874e6874 | 4097 | @dfn{fixed-output derivation} is created---i.e., one whose result is |
36bbbbd1 LC |
4098 | known in advance, such as a file download. If, in addition, |
4099 | @var{recursive?} is true, then that fixed output may be an executable | |
4100 | file or a directory and @var{hash} must be the hash of an archive | |
4101 | containing this output. | |
5b0c9d16 | 4102 | |
858e9282 | 4103 | When @var{references-graphs} is true, it must be a list of file |
5b0c9d16 LC |
4104 | name/store path pairs. In that case, the reference graph of each store |
4105 | path is exported in the build environment in the corresponding file, in | |
4106 | a simple text format. | |
1909431c | 4107 | |
b53be755 | 4108 | When @var{allowed-references} is true, it must be a list of store items |
35b5ca78 LC |
4109 | or outputs that the derivation's output may refer to. Likewise, |
4110 | @var{disallowed-references}, if true, must be a list of things the | |
4111 | outputs may @emph{not} refer to. | |
b53be755 | 4112 | |
c0468155 LC |
4113 | When @var{leaked-env-vars} is true, it must be a list of strings |
4114 | denoting environment variables that are allowed to ``leak'' from the | |
4115 | daemon's environment to the build environment. This is only applicable | |
4116 | to fixed-output derivations---i.e., when @var{hash} is true. The main | |
4117 | use is to allow variables such as @code{http_proxy} to be passed to | |
4118 | derivations that download files. | |
4119 | ||
1909431c LC |
4120 | When @var{local-build?} is true, declare that the derivation is not a |
4121 | good candidate for offloading and should rather be built locally | |
4122 | (@pxref{Daemon Offload Setup}). This is the case for small derivations | |
4123 | where the costs of data transfers would outweigh the benefits. | |
4a6aeb67 LC |
4124 | |
4125 | When @var{substitutable?} is false, declare that substitutes of the | |
4126 | derivation's output should not be used (@pxref{Substitutes}). This is | |
4127 | useful, for instance, when building packages that capture details of the | |
4128 | host CPU instruction set. | |
874e6874 LC |
4129 | @end deffn |
4130 | ||
4131 | @noindent | |
4132 | Here's an example with a shell script as its builder, assuming | |
4133 | @var{store} is an open connection to the daemon, and @var{bash} points | |
4134 | to a Bash executable in the store: | |
4135 | ||
4136 | @lisp | |
4137 | (use-modules (guix utils) | |
4138 | (guix store) | |
4139 | (guix derivations)) | |
4140 | ||
59688fc4 LC |
4141 | (let ((builder ; add the Bash script to the store |
4142 | (add-text-to-store store "my-builder.sh" | |
4143 | "echo hello world > $out\n" '()))) | |
4144 | (derivation store "foo" | |
4145 | bash `("-e" ,builder) | |
21b679f6 | 4146 | #:inputs `((,bash) (,builder)) |
59688fc4 | 4147 | #:env-vars '(("HOME" . "/homeless")))) |
834129e0 | 4148 | @result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo> |
874e6874 LC |
4149 | @end lisp |
4150 | ||
21b679f6 LC |
4151 | As can be guessed, this primitive is cumbersome to use directly. A |
4152 | better approach is to write build scripts in Scheme, of course! The | |
4153 | best course of action for that is to write the build code as a | |
4154 | ``G-expression'', and to pass it to @code{gexp->derivation}. For more | |
6621cdb6 | 4155 | information, @pxref{G-Expressions}. |
21b679f6 | 4156 | |
f2fadbc1 AE |
4157 | Once upon a time, @code{gexp->derivation} did not exist and constructing |
4158 | derivations with build code written in Scheme was achieved with | |
4159 | @code{build-expression->derivation}, documented below. This procedure | |
4160 | is now deprecated in favor of the much nicer @code{gexp->derivation}. | |
4161 | ||
4162 | @deffn {Scheme Procedure} build-expression->derivation @var{store} @ | |
4163 | @var{name} @var{exp} @ | |
4164 | [#:system (%current-system)] [#:inputs '()] @ | |
4165 | [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | |
4166 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ | |
4167 | [#:references-graphs #f] [#:allowed-references #f] @ | |
35b5ca78 | 4168 | [#:disallowed-references #f] @ |
f2fadbc1 AE |
4169 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] |
4170 | Return a derivation that executes Scheme expression @var{exp} as a | |
4171 | builder for derivation @var{name}. @var{inputs} must be a list of | |
4172 | @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, | |
4173 | @code{"out"} is assumed. @var{modules} is a list of names of Guile | |
4174 | modules from the current search path to be copied in the store, | |
4175 | compiled, and made available in the load path during the execution of | |
4176 | @var{exp}---e.g., @code{((guix build utils) (guix build | |
4177 | gnu-build-system))}. | |
4178 | ||
4179 | @var{exp} is evaluated in an environment where @code{%outputs} is bound | |
4180 | to a list of output/path pairs, and where @code{%build-inputs} is bound | |
4181 | to a list of string/output-path pairs made from @var{inputs}. | |
4182 | Optionally, @var{env-vars} is a list of string pairs specifying the name | |
4183 | and value of environment variables visible to the builder. The builder | |
4184 | terminates by passing the result of @var{exp} to @code{exit}; thus, when | |
4185 | @var{exp} returns @code{#f}, the build is considered to have failed. | |
4186 | ||
4187 | @var{exp} is built using @var{guile-for-build} (a derivation). When | |
4188 | @var{guile-for-build} is omitted or is @code{#f}, the value of the | |
4189 | @code{%guile-for-build} fluid is used instead. | |
4190 | ||
4191 | See the @code{derivation} procedure for the meaning of | |
35b5ca78 LC |
4192 | @var{references-graphs}, @var{allowed-references}, |
4193 | @var{disallowed-references}, @var{local-build?}, and | |
4194 | @var{substitutable?}. | |
f2fadbc1 AE |
4195 | @end deffn |
4196 | ||
4197 | @noindent | |
4198 | Here's an example of a single-output derivation that creates a directory | |
4199 | containing one file: | |
4200 | ||
4201 | @lisp | |
4202 | (let ((builder '(let ((out (assoc-ref %outputs "out"))) | |
4203 | (mkdir out) ; create /gnu/store/@dots{}-goo | |
4204 | (call-with-output-file (string-append out "/test") | |
4205 | (lambda (p) | |
4206 | (display '(hello guix) p)))))) | |
4207 | (build-expression->derivation store "goo" builder)) | |
4208 | ||
4209 | @result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}> | |
4210 | @end lisp | |
4211 | ||
568717fd | 4212 | |
b860f382 LC |
4213 | @node The Store Monad |
4214 | @section The Store Monad | |
4215 | ||
4216 | @cindex monad | |
4217 | ||
4218 | The procedures that operate on the store described in the previous | |
4219 | sections all take an open connection to the build daemon as their first | |
4220 | argument. Although the underlying model is functional, they either have | |
4221 | side effects or depend on the current state of the store. | |
4222 | ||
4223 | The former is inconvenient: the connection to the build daemon has to be | |
4224 | carried around in all those functions, making it impossible to compose | |
4225 | functions that do not take that parameter with functions that do. The | |
4226 | latter can be problematic: since store operations have side effects | |
4227 | and/or depend on external state, they have to be properly sequenced. | |
4228 | ||
4229 | @cindex monadic values | |
4230 | @cindex monadic functions | |
4231 | This is where the @code{(guix monads)} module comes in. This module | |
4232 | provides a framework for working with @dfn{monads}, and a particularly | |
4233 | useful monad for our uses, the @dfn{store monad}. Monads are a | |
4234 | construct that allows two things: associating ``context'' with values | |
4235 | (in our case, the context is the store), and building sequences of | |
4827b36d | 4236 | computations (here computations include accesses to the store). Values |
b860f382 LC |
4237 | in a monad---values that carry this additional context---are called |
4238 | @dfn{monadic values}; procedures that return such values are called | |
4239 | @dfn{monadic procedures}. | |
4240 | ||
4241 | Consider this ``normal'' procedure: | |
4242 | ||
4243 | @example | |
45adbd62 LC |
4244 | (define (sh-symlink store) |
4245 | ;; Return a derivation that symlinks the 'bash' executable. | |
4246 | (let* ((drv (package-derivation store bash)) | |
4247 | (out (derivation->output-path drv)) | |
4248 | (sh (string-append out "/bin/bash"))) | |
4249 | (build-expression->derivation store "sh" | |
4250 | `(symlink ,sh %output)))) | |
b860f382 LC |
4251 | @end example |
4252 | ||
c6f30b81 LC |
4253 | Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten |
4254 | as a monadic function: | |
b860f382 LC |
4255 | |
4256 | @example | |
45adbd62 | 4257 | (define (sh-symlink) |
b860f382 | 4258 | ;; Same, but return a monadic value. |
c6f30b81 LC |
4259 | (mlet %store-monad ((drv (package->derivation bash))) |
4260 | (gexp->derivation "sh" | |
4261 | #~(symlink (string-append #$drv "/bin/bash") | |
4262 | #$output)))) | |
b860f382 LC |
4263 | @end example |
4264 | ||
4827b36d | 4265 | There are several things to note in the second version: the @code{store} |
c6f30b81 LC |
4266 | parameter is now implicit and is ``threaded'' in the calls to the |
4267 | @code{package->derivation} and @code{gexp->derivation} monadic | |
4268 | procedures, and the monadic value returned by @code{package->derivation} | |
4269 | is @dfn{bound} using @code{mlet} instead of plain @code{let}. | |
4270 | ||
4271 | As it turns out, the call to @code{package->derivation} can even be | |
4272 | omitted since it will take place implicitly, as we will see later | |
4273 | (@pxref{G-Expressions}): | |
4274 | ||
4275 | @example | |
4276 | (define (sh-symlink) | |
4277 | (gexp->derivation "sh" | |
4278 | #~(symlink (string-append #$bash "/bin/bash") | |
4279 | #$output))) | |
4280 | @end example | |
b860f382 | 4281 | |
7ce21611 | 4282 | @c See |
a01ad638 | 4283 | @c <https://syntaxexclamation.wordpress.com/2014/06/26/escaping-continuations/> |
7ce21611 LC |
4284 | @c for the funny quote. |
4285 | Calling the monadic @code{sh-symlink} has no effect. As someone once | |
4286 | said, ``you exit a monad like you exit a building on fire: by running''. | |
4287 | So, to exit the monad and get the desired effect, one must use | |
4288 | @code{run-with-store}: | |
b860f382 LC |
4289 | |
4290 | @example | |
8e9aa37f CAW |
4291 | (run-with-store (open-connection) (sh-symlink)) |
4292 | @result{} /gnu/store/...-sh-symlink | |
b860f382 LC |
4293 | @end example |
4294 | ||
f97c9175 | 4295 | Note that the @code{(guix monad-repl)} module extends the Guile REPL with |
b9b86078 | 4296 | new ``meta-commands'' to make it easier to deal with monadic procedures: |
f97c9175 | 4297 | @code{run-in-store}, and @code{enter-store-monad}. The former is used |
b9b86078 LC |
4298 | to ``run'' a single monadic value through the store: |
4299 | ||
4300 | @example | |
4301 | scheme@@(guile-user)> ,run-in-store (package->derivation hello) | |
4302 | $1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> | |
4303 | @end example | |
4304 | ||
4305 | The latter enters a recursive REPL, where all the return values are | |
4306 | automatically run through the store: | |
4307 | ||
4308 | @example | |
4309 | scheme@@(guile-user)> ,enter-store-monad | |
4310 | store-monad@@(guile-user) [1]> (package->derivation hello) | |
4311 | $2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> | |
4312 | store-monad@@(guile-user) [1]> (text-file "foo" "Hello!") | |
4313 | $3 = "/gnu/store/@dots{}-foo" | |
4314 | store-monad@@(guile-user) [1]> ,q | |
4315 | scheme@@(guile-user)> | |
4316 | @end example | |
4317 | ||
4318 | @noindent | |
4319 | Note that non-monadic values cannot be returned in the | |
4320 | @code{store-monad} REPL. | |
4321 | ||
e87f0591 LC |
4322 | The main syntactic forms to deal with monads in general are provided by |
4323 | the @code{(guix monads)} module and are described below. | |
b860f382 LC |
4324 | |
4325 | @deffn {Scheme Syntax} with-monad @var{monad} @var{body} ... | |
4326 | Evaluate any @code{>>=} or @code{return} forms in @var{body} as being | |
4327 | in @var{monad}. | |
4328 | @end deffn | |
4329 | ||
4330 | @deffn {Scheme Syntax} return @var{val} | |
4331 | Return a monadic value that encapsulates @var{val}. | |
4332 | @end deffn | |
4333 | ||
751630c9 | 4334 | @deffn {Scheme Syntax} >>= @var{mval} @var{mproc} ... |
b860f382 | 4335 | @dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic |
751630c9 LC |
4336 | procedures @var{mproc}@dots{}@footnote{This operation is commonly |
4337 | referred to as ``bind'', but that name denotes an unrelated procedure in | |
4338 | Guile. Thus we use this somewhat cryptic symbol inherited from the | |
4339 | Haskell language.}. There can be one @var{mproc} or several of them, as | |
4340 | in this example: | |
4341 | ||
4342 | @example | |
4343 | (run-with-state | |
4344 | (with-monad %state-monad | |
4345 | (>>= (return 1) | |
4346 | (lambda (x) (return (+ 1 x))) | |
4347 | (lambda (x) (return (* 2 x))))) | |
4348 | 'some-state) | |
4349 | ||
4350 | @result{} 4 | |
4351 | @result{} some-state | |
4352 | @end example | |
b860f382 LC |
4353 | @end deffn |
4354 | ||
4355 | @deffn {Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @ | |
4356 | @var{body} ... | |
4357 | @deffnx {Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @ | |
4358 | @var{body} ... | |
4359 | Bind the variables @var{var} to the monadic values @var{mval} in | |
8bc2183f CM |
4360 | @var{body}, which is a sequence of expressions. As with the bind |
4361 | operator, this can be thought of as ``unpacking'' the raw, non-monadic | |
4362 | value ``contained'' in @var{mval} and making @var{var} refer to that | |
4363 | raw, non-monadic value within the scope of the @var{body}. The form | |
4364 | (@var{var} -> @var{val}) binds @var{var} to the ``normal'' value | |
4365 | @var{val}, as per @code{let}. The binding operations occur in sequence | |
4366 | from left to right. The last expression of @var{body} must be a monadic | |
4367 | expression, and its result will become the result of the @code{mlet} or | |
4368 | @code{mlet*} when run in the @var{monad}. | |
b860f382 LC |
4369 | |
4370 | @code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} | |
4371 | (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual}). | |
4372 | @end deffn | |
4373 | ||
405a9d4e LC |
4374 | @deffn {Scheme System} mbegin @var{monad} @var{mexp} ... |
4375 | Bind @var{mexp} and the following monadic expressions in sequence, | |
8bc2183f CM |
4376 | returning the result of the last expression. Every expression in the |
4377 | sequence must be a monadic expression. | |
405a9d4e LC |
4378 | |
4379 | This is akin to @code{mlet}, except that the return values of the | |
4380 | monadic expressions are ignored. In that sense, it is analogous to | |
4381 | @code{begin}, but applied to monadic expressions. | |
4382 | @end deffn | |
4383 | ||
60a9fcb1 CM |
4384 | @deffn {Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ... |
4385 | When @var{condition} is true, evaluate the sequence of monadic | |
4386 | expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When | |
4387 | @var{condition} is false, return @code{*unspecified*} in the current | |
4388 | monad. Every expression in the sequence must be a monadic expression. | |
4389 | @end deffn | |
4390 | ||
4391 | @deffn {Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ... | |
4392 | When @var{condition} is false, evaluate the sequence of monadic | |
4393 | expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When | |
4394 | @var{condition} is true, return @code{*unspecified*} in the current | |
4395 | monad. Every expression in the sequence must be a monadic expression. | |
4396 | @end deffn | |
4397 | ||
561fb6c3 LC |
4398 | @cindex state monad |
4399 | The @code{(guix monads)} module provides the @dfn{state monad}, which | |
4400 | allows an additional value---the state---to be @emph{threaded} through | |
4401 | monadic procedure calls. | |
4402 | ||
4403 | @defvr {Scheme Variable} %state-monad | |
4404 | The state monad. Procedures in the state monad can access and change | |
4405 | the state that is threaded. | |
4406 | ||
4407 | Consider the example below. The @code{square} procedure returns a value | |
4408 | in the state monad. It returns the square of its argument, but also | |
4409 | increments the current state value: | |
4410 | ||
4411 | @example | |
4412 | (define (square x) | |
4413 | (mlet %state-monad ((count (current-state))) | |
4414 | (mbegin %state-monad | |
4415 | (set-current-state (+ 1 count)) | |
4416 | (return (* x x))))) | |
4417 | ||
4418 | (run-with-state (sequence %state-monad (map square (iota 3))) 0) | |
4419 | @result{} (0 1 4) | |
4420 | @result{} 3 | |
4421 | @end example | |
4422 | ||
4423 | When ``run'' through @var{%state-monad}, we obtain that additional state | |
4424 | value, which is the number of @code{square} calls. | |
4425 | @end defvr | |
4426 | ||
4427 | @deffn {Monadic Procedure} current-state | |
4428 | Return the current state as a monadic value. | |
4429 | @end deffn | |
4430 | ||
4431 | @deffn {Monadic Procedure} set-current-state @var{value} | |
4432 | Set the current state to @var{value} and return the previous state as a | |
4433 | monadic value. | |
4434 | @end deffn | |
4435 | ||
4436 | @deffn {Monadic Procedure} state-push @var{value} | |
4437 | Push @var{value} to the current state, which is assumed to be a list, | |
4438 | and return the previous state as a monadic value. | |
4439 | @end deffn | |
4440 | ||
4441 | @deffn {Monadic Procedure} state-pop | |
4442 | Pop a value from the current state and return it as a monadic value. | |
4443 | The state is assumed to be a list. | |
4444 | @end deffn | |
4445 | ||
4446 | @deffn {Scheme Procedure} run-with-state @var{mval} [@var{state}] | |
4447 | Run monadic value @var{mval} starting with @var{state} as the initial | |
4448 | state. Return two values: the resulting value, and the resulting state. | |
4449 | @end deffn | |
4450 | ||
e87f0591 LC |
4451 | The main interface to the store monad, provided by the @code{(guix |
4452 | store)} module, is as follows. | |
b860f382 LC |
4453 | |
4454 | @defvr {Scheme Variable} %store-monad | |
561fb6c3 LC |
4455 | The store monad---an alias for @var{%state-monad}. |
4456 | ||
4457 | Values in the store monad encapsulate accesses to the store. When its | |
4458 | effect is needed, a value of the store monad must be ``evaluated'' by | |
4459 | passing it to the @code{run-with-store} procedure (see below.) | |
b860f382 LC |
4460 | @end defvr |
4461 | ||
4462 | @deffn {Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)] | |
4463 | Run @var{mval}, a monadic value in the store monad, in @var{store}, an | |
4464 | open store connection. | |
4465 | @end deffn | |
4466 | ||
ad372953 | 4467 | @deffn {Monadic Procedure} text-file @var{name} @var{text} [@var{references}] |
b860f382 | 4468 | Return as a monadic value the absolute file name in the store of the file |
ad372953 LC |
4469 | containing @var{text}, a string. @var{references} is a list of store items that the |
4470 | resulting text file refers to; it defaults to the empty list. | |
45adbd62 LC |
4471 | @end deffn |
4472 | ||
0a90af15 | 4473 | @deffn {Monadic Procedure} interned-file @var{file} [@var{name}] @ |
1ec32f4a | 4474 | [#:recursive? #t] [#:select? (const #t)] |
0a90af15 LC |
4475 | Return the name of @var{file} once interned in the store. Use |
4476 | @var{name} as its store name, or the basename of @var{file} if | |
4477 | @var{name} is omitted. | |
4478 | ||
4479 | When @var{recursive?} is true, the contents of @var{file} are added | |
4480 | recursively; if @var{file} designates a flat file and @var{recursive?} | |
4481 | is true, its contents are added, and its permission bits are kept. | |
4482 | ||
1ec32f4a LC |
4483 | When @var{recursive?} is true, call @code{(@var{select?} @var{file} |
4484 | @var{stat})} for each directory entry, where @var{file} is the entry's | |
4485 | absolute file name and @var{stat} is the result of @code{lstat}; exclude | |
4486 | entries for which @var{select?} does not return true. | |
4487 | ||
0a90af15 LC |
4488 | The example below adds a file to the store, under two different names: |
4489 | ||
4490 | @example | |
4491 | (run-with-store (open-connection) | |
4492 | (mlet %store-monad ((a (interned-file "README")) | |
4493 | (b (interned-file "README" "LEGU-MIN"))) | |
4494 | (return (list a b)))) | |
4495 | ||
4496 | @result{} ("/gnu/store/rwm@dots{}-README" "/gnu/store/44i@dots{}-LEGU-MIN") | |
4497 | @end example | |
4498 | ||
4499 | @end deffn | |
4500 | ||
e87f0591 LC |
4501 | The @code{(guix packages)} module exports the following package-related |
4502 | monadic procedures: | |
4503 | ||
b860f382 | 4504 | @deffn {Monadic Procedure} package-file @var{package} [@var{file}] @ |
4231f05b | 4505 | [#:system (%current-system)] [#:target #f] @ |
f97c9175 AE |
4506 | [#:output "out"] |
4507 | Return as a monadic | |
b860f382 LC |
4508 | value in the absolute file name of @var{file} within the @var{output} |
4509 | directory of @var{package}. When @var{file} is omitted, return the name | |
4231f05b LC |
4510 | of the @var{output} directory of @var{package}. When @var{target} is |
4511 | true, use it as a cross-compilation target triplet. | |
b860f382 LC |
4512 | @end deffn |
4513 | ||
b860f382 | 4514 | @deffn {Monadic Procedure} package->derivation @var{package} [@var{system}] |
4231f05b LC |
4515 | @deffnx {Monadic Procedure} package->cross-derivation @var{package} @ |
4516 | @var{target} [@var{system}] | |
4517 | Monadic version of @code{package-derivation} and | |
4518 | @code{package-cross-derivation} (@pxref{Defining Packages}). | |
b860f382 LC |
4519 | @end deffn |
4520 | ||
4521 | ||
21b679f6 LC |
4522 | @node G-Expressions |
4523 | @section G-Expressions | |
4524 | ||
4525 | @cindex G-expression | |
4526 | @cindex build code quoting | |
4527 | So we have ``derivations'', which represent a sequence of build actions | |
4528 | to be performed to produce an item in the store (@pxref{Derivations}). | |
f97c9175 | 4529 | These build actions are performed when asking the daemon to actually |
21b679f6 LC |
4530 | build the derivations; they are run by the daemon in a container |
4531 | (@pxref{Invoking guix-daemon}). | |
4532 | ||
4533 | @cindex strata of code | |
f97c9175 | 4534 | It should come as no surprise that we like to write these build actions |
21b679f6 LC |
4535 | in Scheme. When we do that, we end up with two @dfn{strata} of Scheme |
4536 | code@footnote{The term @dfn{stratum} in this context was coined by | |
ef4ab0a4 LC |
4537 | Manuel Serrano et al.@: in the context of their work on Hop. Oleg |
4538 | Kiselyov, who has written insightful | |
4539 | @url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code | |
4540 | on this topic}, refers to this kind of code generation as | |
4541 | @dfn{staging}.}: the ``host code''---code that defines packages, talks | |
4542 | to the daemon, etc.---and the ``build code''---code that actually | |
4543 | performs build actions, such as making directories, invoking | |
4544 | @command{make}, etc. | |
21b679f6 LC |
4545 | |
4546 | To describe a derivation and its build actions, one typically needs to | |
4547 | embed build code inside host code. It boils down to manipulating build | |
f97c9175 | 4548 | code as data, and the homoiconicity of Scheme---code has a direct |
21b679f6 | 4549 | representation as data---comes in handy for that. But we need more than |
f97c9175 | 4550 | the normal @code{quasiquote} mechanism in Scheme to construct build |
21b679f6 LC |
4551 | expressions. |
4552 | ||
4553 | The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of | |
4554 | S-expressions adapted to build expressions. G-expressions, or | |
f97c9175 | 4555 | @dfn{gexps}, consist essentially of three syntactic forms: @code{gexp}, |
21b679f6 | 4556 | @code{ungexp}, and @code{ungexp-splicing} (or simply: @code{#~}, |
f97c9175 AE |
4557 | @code{#$}, and @code{#$@@}), which are comparable to |
4558 | @code{quasiquote}, @code{unquote}, and @code{unquote-splicing}, | |
4827b36d | 4559 | respectively (@pxref{Expression Syntax, @code{quasiquote},, guile, |
f97c9175 | 4560 | GNU Guile Reference Manual}). However, there are major differences: |
21b679f6 LC |
4561 | |
4562 | @itemize | |
4563 | @item | |
4564 | Gexps are meant to be written to a file and run or manipulated by other | |
4565 | processes. | |
4566 | ||
4567 | @item | |
b39fc6f7 LC |
4568 | When a high-level object such as a package or derivation is unquoted |
4569 | inside a gexp, the result is as if its output file name had been | |
4570 | introduced. | |
ff40e9b7 | 4571 | |
21b679f6 LC |
4572 | @item |
4573 | Gexps carry information about the packages or derivations they refer to, | |
4574 | and these dependencies are automatically added as inputs to the build | |
4575 | processes that use them. | |
4576 | @end itemize | |
4577 | ||
c2b84676 | 4578 | @cindex lowering, of high-level objects in gexps |
343eacbe LC |
4579 | This mechanism is not limited to package and derivation |
4580 | objects: @dfn{compilers} able to ``lower'' other high-level objects to | |
c2b84676 LC |
4581 | derivations or files in the store can be defined, |
4582 | such that these objects can also be inserted | |
f97c9175 | 4583 | into gexps. For example, a useful type of high-level objects that can be |
343eacbe | 4584 | inserted in a gexp is ``file-like objects'', which make it easy to |
f97c9175 | 4585 | add files to the store and to refer to them in |
558e8b11 LC |
4586 | derivations and such (see @code{local-file} and @code{plain-file} |
4587 | below.) | |
b39fc6f7 | 4588 | |
21b679f6 LC |
4589 | To illustrate the idea, here is an example of a gexp: |
4590 | ||
4591 | @example | |
4592 | (define build-exp | |
4593 | #~(begin | |
4594 | (mkdir #$output) | |
4595 | (chdir #$output) | |
aff8ce7c | 4596 | (symlink (string-append #$coreutils "/bin/ls") |
21b679f6 LC |
4597 | "list-files"))) |
4598 | @end example | |
4599 | ||
4600 | This gexp can be passed to @code{gexp->derivation}; we obtain a | |
4601 | derivation that builds a directory containing exactly one symlink to | |
4602 | @file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}: | |
4603 | ||
4604 | @example | |
4605 | (gexp->derivation "the-thing" build-exp) | |
4606 | @end example | |
4607 | ||
e20fd1bf | 4608 | As one would expect, the @code{"/gnu/store/@dots{}-coreutils-8.22"} string is |
21b679f6 LC |
4609 | substituted to the reference to the @var{coreutils} package in the |
4610 | actual build code, and @var{coreutils} is automatically made an input to | |
4611 | the derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp | |
f97c9175 AE |
4612 | output)}) is replaced by a string containing the directory name of the |
4613 | output of the derivation. | |
667b2508 LC |
4614 | |
4615 | @cindex cross compilation | |
4616 | In a cross-compilation context, it is useful to distinguish between | |
4617 | references to the @emph{native} build of a package---that can run on the | |
4618 | host---versus references to cross builds of a package. To that end, the | |
4619 | @code{#+} plays the same role as @code{#$}, but is a reference to a | |
4620 | native package build: | |
4621 | ||
4622 | @example | |
4623 | (gexp->derivation "vi" | |
4624 | #~(begin | |
4625 | (mkdir #$output) | |
4626 | (system* (string-append #+coreutils "/bin/ln") | |
4627 | "-s" | |
4628 | (string-append #$emacs "/bin/emacs") | |
4629 | (string-append #$output "/bin/vi"))) | |
4a3b6aa5 | 4630 | #:target "mips64el-linux-gnu") |
667b2508 LC |
4631 | @end example |
4632 | ||
4633 | @noindent | |
4634 | In the example above, the native build of @var{coreutils} is used, so | |
4635 | that @command{ln} can actually run on the host; but then the | |
4636 | cross-compiled build of @var{emacs} is referenced. | |
4637 | ||
0bb9929e LC |
4638 | @cindex imported modules, for gexps |
4639 | @findex with-imported-modules | |
4640 | Another gexp feature is @dfn{imported modules}: sometimes you want to be | |
4641 | able to use certain Guile modules from the ``host environment'' in the | |
4642 | gexp, so those modules should be imported in the ``build environment''. | |
4643 | The @code{with-imported-modules} form allows you to express that: | |
4644 | ||
4645 | @example | |
4646 | (let ((build (with-imported-modules '((guix build utils)) | |
4647 | #~(begin | |
4648 | (use-modules (guix build utils)) | |
4649 | (mkdir-p (string-append #$output "/bin")))))) | |
4650 | (gexp->derivation "empty-dir" | |
4651 | #~(begin | |
4652 | #$build | |
4653 | (display "success!\n") | |
4654 | #t))) | |
4655 | @end example | |
4656 | ||
4657 | @noindent | |
4658 | In this example, the @code{(guix build utils)} module is automatically | |
4659 | pulled into the isolated build environment of our gexp, such that | |
4660 | @code{(use-modules (guix build utils))} works as expected. | |
4661 | ||
7ca87354 LC |
4662 | @cindex module closure |
4663 | @findex source-module-closure | |
4664 | Usually you want the @emph{closure} of the module to be imported---i.e., | |
4665 | the module itself and all the modules it depends on---rather than just | |
4666 | the module; failing to do that, attempts to use the module will fail | |
4667 | because of missing dependent modules. The @code{source-module-closure} | |
4668 | procedure computes the closure of a module by looking at its source file | |
4669 | headers, which comes in handy in this case: | |
4670 | ||
4671 | @example | |
4672 | (use-modules (guix modules)) ;for 'source-module-closure' | |
4673 | ||
4674 | (with-imported-modules (source-module-closure | |
4675 | '((guix build utils) | |
4676 | (gnu build vm))) | |
4677 | (gexp->derivation "something-with-vms" | |
4678 | #~(begin | |
4679 | (use-modules (guix build utils) | |
4680 | (gnu build vm)) | |
4681 | @dots{}))) | |
4682 | @end example | |
4683 | ||
667b2508 | 4684 | The syntactic form to construct gexps is summarized below. |
21b679f6 LC |
4685 | |
4686 | @deffn {Scheme Syntax} #~@var{exp} | |
4687 | @deffnx {Scheme Syntax} (gexp @var{exp}) | |
4688 | Return a G-expression containing @var{exp}. @var{exp} may contain one | |
4689 | or more of the following forms: | |
4690 | ||
4691 | @table @code | |
4692 | @item #$@var{obj} | |
4693 | @itemx (ungexp @var{obj}) | |
b39fc6f7 LC |
4694 | Introduce a reference to @var{obj}. @var{obj} may have one of the |
4695 | supported types, for example a package or a | |
21b679f6 LC |
4696 | derivation, in which case the @code{ungexp} form is replaced by its |
4697 | output file name---e.g., @code{"/gnu/store/@dots{}-coreutils-8.22}. | |
4698 | ||
b39fc6f7 LC |
4699 | If @var{obj} is a list, it is traversed and references to supported |
4700 | objects are substituted similarly. | |
21b679f6 LC |
4701 | |
4702 | If @var{obj} is another gexp, its contents are inserted and its | |
4703 | dependencies are added to those of the containing gexp. | |
4704 | ||
4705 | If @var{obj} is another kind of object, it is inserted as is. | |
4706 | ||
b39fc6f7 LC |
4707 | @item #$@var{obj}:@var{output} |
4708 | @itemx (ungexp @var{obj} @var{output}) | |
21b679f6 | 4709 | This is like the form above, but referring explicitly to the |
b39fc6f7 LC |
4710 | @var{output} of @var{obj}---this is useful when @var{obj} produces |
4711 | multiple outputs (@pxref{Packages with Multiple Outputs}). | |
21b679f6 | 4712 | |
667b2508 LC |
4713 | @item #+@var{obj} |
4714 | @itemx #+@var{obj}:output | |
4715 | @itemx (ungexp-native @var{obj}) | |
4716 | @itemx (ungexp-native @var{obj} @var{output}) | |
4717 | Same as @code{ungexp}, but produces a reference to the @emph{native} | |
4718 | build of @var{obj} when used in a cross compilation context. | |
4719 | ||
21b679f6 LC |
4720 | @item #$output[:@var{output}] |
4721 | @itemx (ungexp output [@var{output}]) | |
4722 | Insert a reference to derivation output @var{output}, or to the main | |
4723 | output when @var{output} is omitted. | |
4724 | ||
4725 | This only makes sense for gexps passed to @code{gexp->derivation}. | |
4726 | ||
4727 | @item #$@@@var{lst} | |
4728 | @itemx (ungexp-splicing @var{lst}) | |
4729 | Like the above, but splices the contents of @var{lst} inside the | |
4730 | containing list. | |
4731 | ||
667b2508 LC |
4732 | @item #+@@@var{lst} |
4733 | @itemx (ungexp-native-splicing @var{lst}) | |
4734 | Like the above, but refers to native builds of the objects listed in | |
4735 | @var{lst}. | |
4736 | ||
21b679f6 LC |
4737 | @end table |
4738 | ||
4739 | G-expressions created by @code{gexp} or @code{#~} are run-time objects | |
4740 | of the @code{gexp?} type (see below.) | |
4741 | @end deffn | |
4742 | ||
0bb9929e LC |
4743 | @deffn {Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{} |
4744 | Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} | |
d938a58b LC |
4745 | in their execution environment. |
4746 | ||
4747 | Each item in @var{modules} can be the name of a module, such as | |
4748 | @code{(guix build utils)}, or it can be a module name, followed by an | |
4749 | arrow, followed by a file-like object: | |
4750 | ||
4751 | @example | |
4752 | `((guix build utils) | |
4753 | (guix gcrypt) | |
4754 | ((guix config) => ,(scheme-file "config.scm" | |
4755 | #~(define-module @dots{})))) | |
4756 | @end example | |
4757 | ||
4758 | @noindent | |
4759 | In the example above, the first two modules are taken from the search | |
4760 | path, and the last one is created from the given file-like object. | |
0bb9929e LC |
4761 | |
4762 | This form has @emph{lexical} scope: it has an effect on the gexps | |
4763 | directly defined in @var{body}@dots{}, but not on those defined, say, in | |
4764 | procedures called from @var{body}@dots{}. | |
4765 | @end deffn | |
4766 | ||
21b679f6 LC |
4767 | @deffn {Scheme Procedure} gexp? @var{obj} |
4768 | Return @code{#t} if @var{obj} is a G-expression. | |
4769 | @end deffn | |
4770 | ||
4771 | G-expressions are meant to be written to disk, either as code building | |
4772 | some derivation, or as plain files in the store. The monadic procedures | |
4773 | below allow you to do that (@pxref{The Store Monad}, for more | |
4774 | information about monads.) | |
4775 | ||
4776 | @deffn {Monadic Procedure} gexp->derivation @var{name} @var{exp} @ | |
ce45eb4c | 4777 | [#:system (%current-system)] [#:target #f] [#:graft? #t] @ |
21b679f6 LC |
4778 | [#:hash #f] [#:hash-algo #f] @ |
4779 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ | |
4684f301 | 4780 | [#:module-path @var{%load-path}] @ |
c8351d9a | 4781 | [#:references-graphs #f] [#:allowed-references #f] @ |
3f4ecf32 | 4782 | [#:disallowed-references #f] @ |
c0468155 | 4783 | [#:leaked-env-vars #f] @ |
0309e1b0 | 4784 | [#:script-name (string-append @var{name} "-builder")] @ |
4a6aeb67 | 4785 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] |
21b679f6 | 4786 | Return a derivation @var{name} that runs @var{exp} (a gexp) with |
0309e1b0 LC |
4787 | @var{guile-for-build} (a derivation) on @var{system}; @var{exp} is |
4788 | stored in a file called @var{script-name}. When @var{target} is true, | |
4789 | it is used as the cross-compilation target triplet for packages referred | |
4790 | to by @var{exp}. | |
21b679f6 | 4791 | |
0bb9929e LC |
4792 | @var{modules} is deprecated in favor of @code{with-imported-modules}. |
4793 | Its meaning is to | |
4794 | make @var{modules} available in the evaluation context of @var{exp}; | |
ce45eb4c LC |
4795 | @var{modules} is a list of names of Guile modules searched in |
4796 | @var{module-path} to be copied in the store, compiled, and made available in | |
21b679f6 LC |
4797 | the load path during the execution of @var{exp}---e.g., @code{((guix |
4798 | build utils) (guix build gnu-build-system))}. | |
4799 | ||
ce45eb4c LC |
4800 | @var{graft?} determines whether packages referred to by @var{exp} should be grafted when |
4801 | applicable. | |
4802 | ||
b53833b2 LC |
4803 | When @var{references-graphs} is true, it must be a list of tuples of one of the |
4804 | following forms: | |
4805 | ||
4806 | @example | |
4807 | (@var{file-name} @var{package}) | |
4808 | (@var{file-name} @var{package} @var{output}) | |
4809 | (@var{file-name} @var{derivation}) | |
4810 | (@var{file-name} @var{derivation} @var{output}) | |
4811 | (@var{file-name} @var{store-item}) | |
4812 | @end example | |
4813 | ||
4814 | The right-hand-side of each element of @var{references-graphs} is automatically made | |
4815 | an input of the build process of @var{exp}. In the build environment, each | |
4816 | @var{file-name} contains the reference graph of the corresponding item, in a simple | |
4817 | text format. | |
4818 | ||
c8351d9a LC |
4819 | @var{allowed-references} must be either @code{#f} or a list of output names and packages. |
4820 | In the latter case, the list denotes store items that the result is allowed to | |
4821 | refer to. Any reference to another store item will lead to a build error. | |
3f4ecf32 LC |
4822 | Similarly for @var{disallowed-references}, which can list items that must not be |
4823 | referenced by the outputs. | |
c8351d9a | 4824 | |
e20fd1bf | 4825 | The other arguments are as for @code{derivation} (@pxref{Derivations}). |
21b679f6 LC |
4826 | @end deffn |
4827 | ||
343eacbe | 4828 | @cindex file-like objects |
e1c153e0 LC |
4829 | The @code{local-file}, @code{plain-file}, @code{computed-file}, |
4830 | @code{program-file}, and @code{scheme-file} procedures below return | |
4831 | @dfn{file-like objects}. That is, when unquoted in a G-expression, | |
4832 | these objects lead to a file in the store. Consider this G-expression: | |
343eacbe LC |
4833 | |
4834 | @example | |
a9e5e92f | 4835 | #~(system* #$(file-append glibc "/sbin/nscd") "-f" |
343eacbe LC |
4836 | #$(local-file "/tmp/my-nscd.conf")) |
4837 | @end example | |
4838 | ||
4839 | The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it | |
4840 | to the store. Once expanded, for instance @i{via} | |
4841 | @code{gexp->derivation}, the G-expression refers to that copy under | |
4842 | @file{/gnu/store}; thus, modifying or removing the file in @file{/tmp} | |
4843 | does not have any effect on what the G-expression does. | |
4844 | @code{plain-file} can be used similarly; it differs in that the file | |
4845 | content is directly passed as a string. | |
4846 | ||
d9ae938f | 4847 | @deffn {Scheme Procedure} local-file @var{file} [@var{name}] @ |
0687fc9c | 4848 | [#:recursive? #f] [#:select? (const #t)] |
d9ae938f | 4849 | Return an object representing local file @var{file} to add to the store; this |
9d3994f7 LC |
4850 | object can be used in a gexp. If @var{file} is a relative file name, it is looked |
4851 | up relative to the source file where this form appears. @var{file} will be added to | |
4852 | the store under @var{name}--by default the base name of @var{file}. | |
d9ae938f LC |
4853 | |
4854 | When @var{recursive?} is true, the contents of @var{file} are added recursively; if @var{file} | |
4855 | designates a flat file and @var{recursive?} is true, its contents are added, and its | |
4856 | permission bits are kept. | |
4857 | ||
0687fc9c LC |
4858 | When @var{recursive?} is true, call @code{(@var{select?} @var{file} |
4859 | @var{stat})} for each directory entry, where @var{file} is the entry's | |
4860 | absolute file name and @var{stat} is the result of @code{lstat}; exclude | |
4861 | entries for which @var{select?} does not return true. | |
4862 | ||
d9ae938f LC |
4863 | This is the declarative counterpart of the @code{interned-file} monadic |
4864 | procedure (@pxref{The Store Monad, @code{interned-file}}). | |
4865 | @end deffn | |
4866 | ||
558e8b11 LC |
4867 | @deffn {Scheme Procedure} plain-file @var{name} @var{content} |
4868 | Return an object representing a text file called @var{name} with the given | |
4869 | @var{content} (a string) to be added to the store. | |
4870 | ||
4871 | This is the declarative counterpart of @code{text-file}. | |
4872 | @end deffn | |
4873 | ||
91937029 | 4874 | @deffn {Scheme Procedure} computed-file @var{name} @var{gexp} @ |
a769bffb | 4875 | [#:options '(#:local-build? #t)] |
91937029 | 4876 | Return an object representing the store item @var{name}, a file or |
a769bffb | 4877 | directory computed by @var{gexp}. @var{options} |
91937029 LC |
4878 | is a list of additional arguments to pass to @code{gexp->derivation}. |
4879 | ||
4880 | This is the declarative counterpart of @code{gexp->derivation}. | |
4881 | @end deffn | |
4882 | ||
21b679f6 LC |
4883 | @deffn {Monadic Procedure} gexp->script @var{name} @var{exp} |
4884 | Return an executable script @var{name} that runs @var{exp} using | |
9c14a487 | 4885 | @var{guile}, with @var{exp}'s imported modules in its search path. |
21b679f6 LC |
4886 | |
4887 | The example below builds a script that simply invokes the @command{ls} | |
4888 | command: | |
4889 | ||
4890 | @example | |
4891 | (use-modules (guix gexp) (gnu packages base)) | |
4892 | ||
4893 | (gexp->script "list-files" | |
a9e5e92f | 4894 | #~(execl #$(file-append coreutils "/bin/ls") |
21b679f6 LC |
4895 | "ls")) |
4896 | @end example | |
4897 | ||
4898 | When ``running'' it through the store (@pxref{The Store Monad, | |
e20fd1bf | 4899 | @code{run-with-store}}), we obtain a derivation that produces an |
21b679f6 LC |
4900 | executable file @file{/gnu/store/@dots{}-list-files} along these lines: |
4901 | ||
4902 | @example | |
4903 | #!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds | |
4904 | !# | |
a9e5e92f | 4905 | (execl "/gnu/store/@dots{}-coreutils-8.22"/bin/ls" "ls") |
21b679f6 LC |
4906 | @end example |
4907 | @end deffn | |
4908 | ||
15a01c72 | 4909 | @deffn {Scheme Procedure} program-file @var{name} @var{exp} @ |
9c14a487 | 4910 | [#:guile #f] |
15a01c72 LC |
4911 | Return an object representing the executable store item @var{name} that |
4912 | runs @var{gexp}. @var{guile} is the Guile package used to execute that | |
9c14a487 | 4913 | script. |
15a01c72 LC |
4914 | |
4915 | This is the declarative counterpart of @code{gexp->script}. | |
4916 | @end deffn | |
4917 | ||
2b418579 LC |
4918 | @deffn {Monadic Procedure} gexp->file @var{name} @var{exp} @ |
4919 | [#:set-load-path? #t] | |
21b679f6 | 4920 | Return a derivation that builds a file @var{name} containing @var{exp}. |
2b418579 LC |
4921 | When @var{set-load-path?} is true, emit code in the resulting file to |
4922 | set @code{%load-path} and @code{%load-compiled-path} to honor | |
4923 | @var{exp}'s imported modules. | |
21b679f6 LC |
4924 | |
4925 | The resulting file holds references to all the dependencies of @var{exp} | |
4926 | or a subset thereof. | |
4927 | @end deffn | |
1ed19464 | 4928 | |
e1c153e0 LC |
4929 | @deffn {Scheme Procedure} scheme-file @var{name} @var{exp} |
4930 | Return an object representing the Scheme file @var{name} that contains | |
4931 | @var{exp}. | |
4932 | ||
4933 | This is the declarative counterpart of @code{gexp->file}. | |
4934 | @end deffn | |
4935 | ||
1ed19464 LC |
4936 | @deffn {Monadic Procedure} text-file* @var{name} @var{text} @dots{} |
4937 | Return as a monadic value a derivation that builds a text file | |
4938 | containing all of @var{text}. @var{text} may list, in addition to | |
d9ae938f LC |
4939 | strings, objects of any type that can be used in a gexp: packages, |
4940 | derivations, local file objects, etc. The resulting store file holds | |
4941 | references to all these. | |
1ed19464 LC |
4942 | |
4943 | This variant should be preferred over @code{text-file} anytime the file | |
4944 | to create will reference items from the store. This is typically the | |
4945 | case when building a configuration file that embeds store file names, | |
4946 | like this: | |
4947 | ||
4948 | @example | |
4949 | (define (profile.sh) | |
4950 | ;; Return the name of a shell script in the store that | |
4951 | ;; initializes the 'PATH' environment variable. | |
4952 | (text-file* "profile.sh" | |
4953 | "export PATH=" coreutils "/bin:" | |
4954 | grep "/bin:" sed "/bin\n")) | |
4955 | @end example | |
4956 | ||
4957 | In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file | |
b7899749 | 4958 | will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby |
1ed19464 LC |
4959 | preventing them from being garbage-collected during its lifetime. |
4960 | @end deffn | |
21b679f6 | 4961 | |
b751cde3 LC |
4962 | @deffn {Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{} |
4963 | Return an object representing store file @var{name} containing | |
4964 | @var{text}. @var{text} is a sequence of strings and file-like objects, | |
4965 | as in: | |
4966 | ||
4967 | @example | |
4968 | (mixed-text-file "profile" | |
4969 | "export PATH=" coreutils "/bin:" grep "/bin") | |
4970 | @end example | |
4971 | ||
4972 | This is the declarative counterpart of @code{text-file*}. | |
4973 | @end deffn | |
4974 | ||
a9e5e92f LC |
4975 | @deffn {Scheme Procedure} file-append @var{obj} @var{suffix} @dots{} |
4976 | Return a file-like object that expands to the concatenation of @var{obj} | |
4977 | and @var{suffix}, where @var{obj} is a lowerable object and each | |
4978 | @var{suffix} is a string. | |
4979 | ||
4980 | As an example, consider this gexp: | |
4981 | ||
4982 | @example | |
4983 | (gexp->script "run-uname" | |
4984 | #~(system* #$(file-append coreutils | |
4985 | "/bin/uname"))) | |
4986 | @end example | |
4987 | ||
4988 | The same effect could be achieved with: | |
4989 | ||
4990 | @example | |
4991 | (gexp->script "run-uname" | |
4992 | #~(system* (string-append #$coreutils | |
4993 | "/bin/uname"))) | |
4994 | @end example | |
4995 | ||
4996 | There is one difference though: in the @code{file-append} case, the | |
4997 | resulting script contains the absolute file name as a string, whereas in | |
4998 | the second case, the resulting script contains a @code{(string-append | |
4999 | @dots{})} expression to construct the file name @emph{at run time}. | |
5000 | @end deffn | |
5001 | ||
5002 | ||
21b679f6 LC |
5003 | Of course, in addition to gexps embedded in ``host'' code, there are |
5004 | also modules containing build tools. To make it clear that they are | |
5005 | meant to be used in the build stratum, these modules are kept in the | |
5006 | @code{(guix build @dots{})} name space. | |
5007 | ||
c2b84676 LC |
5008 | @cindex lowering, of high-level objects in gexps |
5009 | Internally, high-level objects are @dfn{lowered}, using their compiler, | |
5010 | to either derivations or store items. For instance, lowering a package | |
5011 | yields a derivation, and lowering a @code{plain-file} yields a store | |
5012 | item. This is achieved using the @code{lower-object} monadic procedure. | |
5013 | ||
5014 | @deffn {Monadic Procedure} lower-object @var{obj} [@var{system}] @ | |
5015 | [#:target #f] | |
5016 | Return as a value in @var{%store-monad} the derivation or store item | |
5017 | corresponding to @var{obj} for @var{system}, cross-compiling for | |
5018 | @var{target} if @var{target} is true. @var{obj} must be an object that | |
5019 | has an associated gexp compiler, such as a @code{<package>}. | |
5020 | @end deffn | |
5021 | ||
21b679f6 | 5022 | |
568717fd LC |
5023 | @c ********************************************************************* |
5024 | @node Utilities | |
5025 | @chapter Utilities | |
5026 | ||
6f773606 LC |
5027 | This section describes Guix command-line utilities. Some of them are |
5028 | primarily targeted at developers and users who write new package | |
5029 | definitions, while others are more generally useful. They complement | |
5030 | the Scheme programming interface of Guix in a convenient way. | |
210cc920 | 5031 | |
568717fd | 5032 | @menu |
37166310 | 5033 | * Invoking guix build:: Building packages from the command line. |
39bee8a2 | 5034 | * Invoking guix edit:: Editing package definitions. |
210cc920 | 5035 | * Invoking guix download:: Downloading a file and printing its hash. |
37166310 | 5036 | * Invoking guix hash:: Computing the cryptographic hash of a file. |
2f7d2d91 | 5037 | * Invoking guix import:: Importing package definitions. |
37166310 | 5038 | * Invoking guix refresh:: Updating package definitions. |
b4f5e0e8 | 5039 | * Invoking guix lint:: Finding errors in package definitions. |
fcc58db6 | 5040 | * Invoking guix size:: Profiling disk usage. |
88856916 | 5041 | * Invoking guix graph:: Visualizing the graph of packages. |
372c4bbc | 5042 | * Invoking guix environment:: Setting up development environments. |
aff8ce7c | 5043 | * Invoking guix publish:: Sharing substitutes. |
d23c20f1 | 5044 | * Invoking guix challenge:: Challenging substitute servers. |
f11c444d | 5045 | * Invoking guix copy:: Copying to and from a remote store. |
32efa254 | 5046 | * Invoking guix container:: Process isolation. |
585347d7 | 5047 | * Invoking guix weather:: Assessing substitute availability. |
568717fd LC |
5048 | @end menu |
5049 | ||
e49951eb MW |
5050 | @node Invoking guix build |
5051 | @section Invoking @command{guix build} | |
568717fd | 5052 | |
e32171ee JD |
5053 | @cindex package building |
5054 | @cindex @command{guix build} | |
e49951eb | 5055 | The @command{guix build} command builds packages or derivations and |
6798a8e4 LC |
5056 | their dependencies, and prints the resulting store paths. Note that it |
5057 | does not modify the user's profile---this is the job of the | |
e49951eb | 5058 | @command{guix package} command (@pxref{Invoking guix package}). Thus, |
6798a8e4 LC |
5059 | it is mainly useful for distribution developers. |
5060 | ||
5061 | The general syntax is: | |
c78bd12b LC |
5062 | |
5063 | @example | |
e49951eb | 5064 | guix build @var{options} @var{package-or-derivation}@dots{} |
c78bd12b LC |
5065 | @end example |
5066 | ||
f97c9175 | 5067 | As an example, the following command builds the latest versions of Emacs |
ccd7158d LC |
5068 | and of Guile, displays their build logs, and finally displays the |
5069 | resulting directories: | |
5070 | ||
5071 | @example | |
5072 | guix build emacs guile | |
5073 | @end example | |
5074 | ||
5075 | Similarly, the following command builds all the available packages: | |
5076 | ||
5077 | @example | |
5284339d | 5078 | guix build --quiet --keep-going \ |
ccd7158d LC |
5079 | `guix package -A | cut -f1,2 --output-delimiter=@@` |
5080 | @end example | |
5081 | ||
c78bd12b | 5082 | @var{package-or-derivation} may be either the name of a package found in |
5401dd75 | 5083 | the software distribution such as @code{coreutils} or |
e1a65ae5 | 5084 | @code{coreutils@@8.20}, or a derivation such as |
834129e0 | 5085 | @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the former case, a |
e7f34eb0 LC |
5086 | package with the corresponding name (and optionally version) is searched |
5087 | for among the GNU distribution modules (@pxref{Package Modules}). | |
5088 | ||
5089 | Alternatively, the @code{--expression} option may be used to specify a | |
5090 | Scheme expression that evaluates to a package; this is useful when | |
b7899749 | 5091 | disambiguating among several same-named packages or package variants is |
e7f34eb0 | 5092 | needed. |
c78bd12b | 5093 | |
ccd7158d LC |
5094 | There may be zero or more @var{options}. The available options are |
5095 | described in the subsections below. | |
5096 | ||
5097 | @menu | |
5098 | * Common Build Options:: Build options for most commands. | |
f11c444d | 5099 | * Package Transformation Options:: Creating variants of packages. |
ccd7158d | 5100 | * Additional Build Options:: Options specific to 'guix build'. |
10f4353d | 5101 | * Debugging Build Failures:: Real life packaging experience. |
ccd7158d LC |
5102 | @end menu |
5103 | ||
5104 | @node Common Build Options | |
5105 | @subsection Common Build Options | |
5106 | ||
5107 | A number of options that control the build process are common to | |
5108 | @command{guix build} and other commands that can spawn builds, such as | |
5109 | @command{guix package} or @command{guix archive}. These are the | |
5110 | following: | |
5111 | ||
5112 | @table @code | |
5113 | ||
5114 | @item --load-path=@var{directory} | |
5115 | @itemx -L @var{directory} | |
5116 | Add @var{directory} to the front of the package module search path | |
5117 | (@pxref{Package Modules}). | |
5118 | ||
5119 | This allows users to define their own packages and make them visible to | |
5120 | the command-line tools. | |
5121 | ||
5122 | @item --keep-failed | |
5123 | @itemx -K | |
b7899749 | 5124 | Keep the build tree of failed builds. Thus, if a build fails, its build |
ccd7158d LC |
5125 | tree is kept under @file{/tmp}, in a directory whose name is shown at |
5126 | the end of the build log. This is useful when debugging build issues. | |
fc06b15e AP |
5127 | @xref{Debugging Build Failures}, for tips and tricks on how to debug |
5128 | build issues. | |
ccd7158d LC |
5129 | |
5130 | @item --keep-going | |
5131 | @itemx -k | |
5132 | Keep going when some of the derivations fail to build; return only once | |
5133 | all the builds have either completed or failed. | |
5134 | ||
5135 | The default behavior is to stop as soon as one of the specified | |
5136 | derivations has failed. | |
5137 | ||
5138 | @item --dry-run | |
5139 | @itemx -n | |
5140 | Do not build the derivations. | |
5141 | ||
5142 | @item --fallback | |
5143 | When substituting a pre-built binary fails, fall back to building | |
5144 | packages locally. | |
5145 | ||
5146 | @item --substitute-urls=@var{urls} | |
5147 | @anchor{client-substitute-urls} | |
5148 | Consider @var{urls} the whitespace-separated list of substitute source | |
5149 | URLs, overriding the default list of URLs of @command{guix-daemon} | |
5150 | (@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs}). | |
5151 | ||
5152 | This means that substitutes may be downloaded from @var{urls}, provided | |
5153 | they are signed by a key authorized by the system administrator | |
5154 | (@pxref{Substitutes}). | |
5155 | ||
71e2065a LC |
5156 | When @var{urls} is the empty string, substitutes are effectively |
5157 | disabled. | |
5158 | ||
ccd7158d LC |
5159 | @item --no-substitutes |
5160 | Do not use substitutes for build products. That is, always build things | |
5161 | locally instead of allowing downloads of pre-built binaries | |
5162 | (@pxref{Substitutes}). | |
5163 | ||
7573d30f LC |
5164 | @item --no-grafts |
5165 | Do not ``graft'' packages. In practice, this means that package updates | |
5166 | available as grafts are not applied. @xref{Security Updates}, for more | |
5167 | information on grafts. | |
5168 | ||
ccd7158d LC |
5169 | @item --rounds=@var{n} |
5170 | Build each derivation @var{n} times in a row, and raise an error if | |
5171 | consecutive build results are not bit-for-bit identical. | |
5172 | ||
5173 | This is a useful way to detect non-deterministic builds processes. | |
5174 | Non-deterministic build processes are a problem because they make it | |
5175 | practically impossible for users to @emph{verify} whether third-party | |
5176 | binaries are genuine. @xref{Invoking guix challenge}, for more. | |
5177 | ||
5178 | Note that, currently, the differing build results are not kept around, | |
5179 | so you will have to manually investigate in case of an error---e.g., by | |
e66d1f59 ML |
5180 | stashing one of the build results with @code{guix archive --export} |
5181 | (@pxref{Invoking guix archive}), then rebuilding, and finally comparing | |
5182 | the two results. | |
ccd7158d LC |
5183 | |
5184 | @item --no-build-hook | |
f97c9175 | 5185 | Do not attempt to offload builds @i{via} the ``build hook'' of the daemon |
ccd7158d LC |
5186 | (@pxref{Daemon Offload Setup}). That is, always build things locally |
5187 | instead of offloading builds to remote machines. | |
5188 | ||
5189 | @item --max-silent-time=@var{seconds} | |
5190 | When the build or substitution process remains silent for more than | |
5191 | @var{seconds}, terminate it and report a build failure. | |
5192 | ||
2ca9f51e LC |
5193 | By default, the daemon's setting is honored (@pxref{Invoking |
5194 | guix-daemon, @code{--max-silent-time}}). | |
5195 | ||
ccd7158d LC |
5196 | @item --timeout=@var{seconds} |
5197 | Likewise, when the build or substitution process lasts for more than | |
5198 | @var{seconds}, terminate it and report a build failure. | |
5199 | ||
2ca9f51e LC |
5200 | By default, the daemon's setting is honored (@pxref{Invoking |
5201 | guix-daemon, @code{--timeout}}). | |
ccd7158d LC |
5202 | |
5203 | @item --verbosity=@var{level} | |
5204 | Use the given verbosity level. @var{level} must be an integer between 0 | |
5205 | and 5; higher means more verbose output. Setting a level of 4 or more | |
5206 | may be helpful when debugging setup issues with the build daemon. | |
5207 | ||
5208 | @item --cores=@var{n} | |
5209 | @itemx -c @var{n} | |
5210 | Allow the use of up to @var{n} CPU cores for the build. The special | |
5211 | value @code{0} means to use as many CPU cores as available. | |
5212 | ||
5213 | @item --max-jobs=@var{n} | |
5214 | @itemx -M @var{n} | |
5215 | Allow at most @var{n} build jobs in parallel. @xref{Invoking | |
5216 | guix-daemon, @code{--max-jobs}}, for details about this option and the | |
5217 | equivalent @command{guix-daemon} option. | |
5218 | ||
5219 | @end table | |
5220 | ||
5221 | Behind the scenes, @command{guix build} is essentially an interface to | |
5222 | the @code{package-derivation} procedure of the @code{(guix packages)} | |
5223 | module, and to the @code{build-derivations} procedure of the @code{(guix | |
5224 | derivations)} module. | |
5225 | ||
5226 | In addition to options explicitly passed on the command line, | |
5227 | @command{guix build} and other @command{guix} commands that support | |
5228 | building honor the @code{GUIX_BUILD_OPTIONS} environment variable. | |
5229 | ||
5230 | @defvr {Environment Variable} GUIX_BUILD_OPTIONS | |
5231 | Users can define this variable to a list of command line options that | |
5232 | will automatically be used by @command{guix build} and other | |
5233 | @command{guix} commands that can perform builds, as in the example | |
5234 | below: | |
5235 | ||
5236 | @example | |
5237 | $ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /foo/bar" | |
5238 | @end example | |
5239 | ||
5240 | These options are parsed independently, and the result is appended to | |
5241 | the parsed command-line options. | |
5242 | @end defvr | |
5243 | ||
88ad6ded LC |
5244 | |
5245 | @node Package Transformation Options | |
5246 | @subsection Package Transformation Options | |
5247 | ||
5248 | @cindex package variants | |
5249 | Another set of command-line options supported by @command{guix build} | |
b8638f03 | 5250 | and also @command{guix package} are @dfn{package transformation |
f97c9175 | 5251 | options}. These are options that make it possible to define @dfn{package |
b8638f03 LC |
5252 | variants}---for instance, packages built from different source code. |
5253 | This is a convenient way to create customized packages on the fly | |
5254 | without having to type in the definitions of package variants | |
5255 | (@pxref{Defining Packages}). | |
88ad6ded LC |
5256 | |
5257 | @table @code | |
5258 | ||
5259 | @item --with-source=@var{source} | |
5260 | Use @var{source} as the source of the corresponding package. | |
5261 | @var{source} must be a file name or a URL, as for @command{guix | |
5262 | download} (@pxref{Invoking guix download}). | |
5263 | ||
f97c9175 AE |
5264 | The ``corresponding package'' is taken to be the one specified on the |
5265 | command line the name of which matches the base of @var{source}---e.g., | |
5266 | if @var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding | |
88ad6ded | 5267 | package is @code{guile}. Likewise, the version string is inferred from |
f97c9175 | 5268 | @var{source}; in the previous example, it is @code{2.0.10}. |
88ad6ded LC |
5269 | |
5270 | This option allows users to try out versions of packages other than the | |
5271 | one provided by the distribution. The example below downloads | |
5272 | @file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for | |
5273 | the @code{ed} package: | |
5274 | ||
5275 | @example | |
5276 | guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz | |
5277 | @end example | |
5278 | ||
5279 | As a developer, @code{--with-source} makes it easy to test release | |
5280 | candidates: | |
5281 | ||
5282 | @example | |
5283 | guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz | |
5284 | @end example | |
5285 | ||
5286 | @dots{} or to build from a checkout in a pristine environment: | |
5287 | ||
5288 | @example | |
5289 | $ git clone git://git.sv.gnu.org/guix.git | |
5290 | $ guix build guix --with-source=./guix | |
5291 | @end example | |
5292 | ||
47c0f92c LC |
5293 | @item --with-input=@var{package}=@var{replacement} |
5294 | Replace dependency on @var{package} by a dependency on | |
5295 | @var{replacement}. @var{package} must be a package name, and | |
5296 | @var{replacement} must be a package specification such as @code{guile} | |
5297 | or @code{guile@@1.8}. | |
5298 | ||
f97c9175 | 5299 | For instance, the following command builds Guix, but replaces its |
47c0f92c | 5300 | dependency on the current stable version of Guile with a dependency on |
f6396d86 | 5301 | the legacy version of Guile, @code{guile@@2.0}: |
47c0f92c LC |
5302 | |
5303 | @example | |
f6396d86 | 5304 | guix build --with-input=guile=guile@@2.0 guix |
47c0f92c LC |
5305 | @end example |
5306 | ||
5307 | This is a recursive, deep replacement. So in this example, both | |
5308 | @code{guix} and its dependency @code{guile-json} (which also depends on | |
f6396d86 | 5309 | @code{guile}) get rebuilt against @code{guile@@2.0}. |
47c0f92c | 5310 | |
2a75b0b6 LC |
5311 | This is implemented using the @code{package-input-rewriting} Scheme |
5312 | procedure (@pxref{Defining Packages, @code{package-input-rewriting}}). | |
645b9df8 LC |
5313 | |
5314 | @item --with-graft=@var{package}=@var{replacement} | |
5315 | This is similar to @code{--with-input} but with an important difference: | |
9b4ec573 | 5316 | instead of rebuilding the whole dependency chain, @var{replacement} is |
645b9df8 LC |
5317 | built and then @dfn{grafted} onto the binaries that were initially |
5318 | referring to @var{package}. @xref{Security Updates}, for more | |
5319 | information on grafts. | |
5320 | ||
5321 | For example, the command below grafts version 3.5.4 of GnuTLS onto Wget | |
5322 | and all its dependencies, replacing references to the version of GnuTLS | |
5323 | they currently refer to: | |
5324 | ||
5325 | @example | |
5326 | guix build --with-graft=gnutls=gnutls@@3.5.4 wget | |
5327 | @end example | |
5328 | ||
5329 | This has the advantage of being much faster than rebuilding everything. | |
5330 | But there is a caveat: it works if and only if @var{package} and | |
5331 | @var{replacement} are strictly compatible---for example, if they provide | |
5332 | a library, the application binary interface (ABI) of those libraries | |
5333 | must be compatible. If @var{replacement} is somehow incompatible with | |
5334 | @var{package}, then the resulting package may be unusable. Use with | |
5335 | care! | |
5336 | ||
88ad6ded LC |
5337 | @end table |
5338 | ||
ccd7158d LC |
5339 | @node Additional Build Options |
5340 | @subsection Additional Build Options | |
5341 | ||
5342 | The command-line options presented below are specific to @command{guix | |
5343 | build}. | |
c78bd12b LC |
5344 | |
5345 | @table @code | |
5346 | ||
5284339d LC |
5347 | @item --quiet |
5348 | @itemx -q | |
5349 | Build quietly, without displaying the build log. Upon completion, the | |
5350 | build log is kept in @file{/var} (or similar) and can always be | |
5351 | retrieved using the @option{--log-file} option. | |
5352 | ||
34a1783f DT |
5353 | @item --file=@var{file} |
5354 | @itemx -f @var{file} | |
5355 | ||
5356 | Build the package or derivation that the code within @var{file} | |
5357 | evaluates to. | |
5358 | ||
5359 | As an example, @var{file} might contain a package definition like this | |
5360 | (@pxref{Defining Packages}): | |
5361 | ||
5362 | @example | |
5363 | @verbatiminclude package-hello.scm | |
5364 | @end example | |
5365 | ||
c78bd12b LC |
5366 | @item --expression=@var{expr} |
5367 | @itemx -e @var{expr} | |
ac5de156 | 5368 | Build the package or derivation @var{expr} evaluates to. |
c78bd12b | 5369 | |
5401dd75 | 5370 | For example, @var{expr} may be @code{(@@ (gnu packages guile) |
c78bd12b LC |
5371 | guile-1.8)}, which unambiguously designates this specific variant of |
5372 | version 1.8 of Guile. | |
5373 | ||
f97c9175 | 5374 | Alternatively, @var{expr} may be a G-expression, in which case it is used |
56b82106 LC |
5375 | as a build program passed to @code{gexp->derivation} |
5376 | (@pxref{G-Expressions}). | |
5377 | ||
5378 | Lastly, @var{expr} may refer to a zero-argument monadic procedure | |
ac5de156 LC |
5379 | (@pxref{The Store Monad}). The procedure must return a derivation as a |
5380 | monadic value, which is then passed through @code{run-with-store}. | |
5381 | ||
c78bd12b LC |
5382 | @item --source |
5383 | @itemx -S | |
f97c9175 | 5384 | Build the source derivations of the packages, rather than the packages |
c78bd12b LC |
5385 | themselves. |
5386 | ||
e49951eb | 5387 | For instance, @code{guix build -S gcc} returns something like |
f97c9175 AE |
5388 | @file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC |
5389 | source tarball. | |
c78bd12b | 5390 | |
f9cc8971 | 5391 | The returned source tarball is the result of applying any patches and |
f97c9175 | 5392 | code snippets specified in the package @code{origin} (@pxref{Defining |
f9cc8971 LC |
5393 | Packages}). |
5394 | ||
2cdfe13d EB |
5395 | @item --sources |
5396 | Fetch and return the source of @var{package-or-derivation} and all their | |
5397 | dependencies, recursively. This is a handy way to obtain a local copy | |
5398 | of all the source code needed to build @var{packages}, allowing you to | |
5399 | eventually build them even without network access. It is an extension | |
5400 | of the @code{--source} option and can accept one of the following | |
5401 | optional argument values: | |
5402 | ||
5403 | @table @code | |
5404 | @item package | |
5405 | This value causes the @code{--sources} option to behave in the same way | |
5406 | as the @code{--source} option. | |
5407 | ||
5408 | @item all | |
f97c9175 AE |
5409 | Build the source derivations of all packages, including any source that |
5410 | might be listed as @code{inputs}. This is the default value. | |
2cdfe13d EB |
5411 | |
5412 | @example | |
5413 | $ guix build --sources tzdata | |
5414 | The following derivations will be built: | |
5415 | /gnu/store/@dots{}-tzdata2015b.tar.gz.drv | |
5416 | /gnu/store/@dots{}-tzcode2015b.tar.gz.drv | |
5417 | @end example | |
5418 | ||
5419 | @item transitive | |
f97c9175 AE |
5420 | Build the source derivations of all packages, as well of all transitive |
5421 | inputs to the packages. This can be used e.g. to | |
2cdfe13d EB |
5422 | prefetch package source for later offline building. |
5423 | ||
5424 | @example | |
5425 | $ guix build --sources=transitive tzdata | |
5426 | The following derivations will be built: | |
5427 | /gnu/store/@dots{}-tzcode2015b.tar.gz.drv | |
5428 | /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv | |
5429 | /gnu/store/@dots{}-grep-2.21.tar.xz.drv | |
5430 | /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv | |
5431 | /gnu/store/@dots{}-make-4.1.tar.xz.drv | |
5432 | /gnu/store/@dots{}-bash-4.3.tar.xz.drv | |
5433 | @dots{} | |
5434 | @end example | |
5435 | ||
5436 | @end table | |
5437 | ||
c78bd12b LC |
5438 | @item --system=@var{system} |
5439 | @itemx -s @var{system} | |
5440 | Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of | |
f97c9175 | 5441 | the system type of the build host. |
c78bd12b LC |
5442 | |
5443 | An example use of this is on Linux-based systems, which can emulate | |
5444 | different personalities. For instance, passing | |
5445 | @code{--system=i686-linux} on an @code{x86_64-linux} system allows users | |
5446 | to build packages in a complete 32-bit environment. | |
5447 | ||
e55ec43d LC |
5448 | @item --target=@var{triplet} |
5449 | @cindex cross-compilation | |
5450 | Cross-build for @var{triplet}, which must be a valid GNU triplet, such | |
5461115e LC |
5451 | as @code{"mips64el-linux-gnu"} (@pxref{Specifying target triplets, GNU |
5452 | configuration triplets,, autoconf, Autoconf}). | |
e55ec43d | 5453 | |
a8d65643 LC |
5454 | @anchor{build-check} |
5455 | @item --check | |
5456 | @cindex determinism, checking | |
5457 | @cindex reproducibility, checking | |
5458 | Rebuild @var{package-or-derivation}, which are already available in the | |
5459 | store, and raise an error if the build results are not bit-for-bit | |
5460 | identical. | |
5461 | ||
f97c9175 AE |
5462 | This mechanism allows you to check whether previously installed |
5463 | substitutes are genuine (@pxref{Substitutes}), or whether the build result | |
5464 | of a package is deterministic. @xref{Invoking guix challenge}, for more | |
a8d65643 LC |
5465 | background information and tools. |
5466 | ||
7f3b2510 ED |
5467 | When used in conjunction with @option{--keep-failed}, the differing |
5468 | output is kept in the store, under @file{/gnu/store/@dots{}-check}. | |
5469 | This makes it easy to look for differences between the two results. | |
5470 | ||
6da5bb7b LC |
5471 | @item --repair |
5472 | @cindex repairing store items | |
5473 | @cindex corruption, recovering from | |
5474 | Attempt to repair the specified store items, if they are corrupt, by | |
5475 | re-downloading or rebuilding them. | |
5476 | ||
5477 | This operation is not atomic and thus restricted to @code{root}. | |
5478 | ||
c78bd12b LC |
5479 | @item --derivations |
5480 | @itemx -d | |
5481 | Return the derivation paths, not the output paths, of the given | |
5482 | packages. | |
5483 | ||
70ee5642 LC |
5484 | @item --root=@var{file} |
5485 | @itemx -r @var{file} | |
5486 | Make @var{file} a symlink to the result, and register it as a garbage | |
5487 | collector root. | |
5488 | ||
5489 | @item --log-file | |
3f208ad7 | 5490 | Return the build log file names or URLs for the given |
f97c9175 | 5491 | @var{package-or-derivation}, or raise an error if build logs are |
70ee5642 LC |
5492 | missing. |
5493 | ||
5494 | This works regardless of how packages or derivations are specified. For | |
5495 | instance, the following invocations are equivalent: | |
5496 | ||
5497 | @example | |
5498 | guix build --log-file `guix build -d guile` | |
5499 | guix build --log-file `guix build guile` | |
5500 | guix build --log-file guile | |
5501 | guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)' | |
5502 | @end example | |
5503 | ||
3f208ad7 LC |
5504 | If a log is unavailable locally, and unless @code{--no-substitutes} is |
5505 | passed, the command looks for a corresponding log on one of the | |
5506 | substitute servers (as specified with @code{--substitute-urls}.) | |
70ee5642 | 5507 | |
f97c9175 AE |
5508 | So for instance, imagine you want to see the build log of GDB on MIPS, |
5509 | but you are actually on an @code{x86_64} machine: | |
3f208ad7 LC |
5510 | |
5511 | @example | |
a01ad638 | 5512 | $ guix build --log-file gdb -s mips64el-linux |
df061d07 | 5513 | https://hydra.gnu.org/log/@dots{}-gdb-7.10 |
3f208ad7 LC |
5514 | @end example |
5515 | ||
5516 | You can freely access a huge library of build logs! | |
70ee5642 LC |
5517 | @end table |
5518 | ||
fc06b15e AP |
5519 | @node Debugging Build Failures |
5520 | @subsection Debugging Build Failures | |
5521 | ||
5522 | @cindex build failures, debugging | |
5523 | When defining a new package (@pxref{Defining Packages}), you will | |
5524 | probably find yourself spending some time debugging and tweaking the | |
5525 | build until it succeeds. To do that, you need to operate the build | |
5526 | commands yourself in an environment as close as possible to the one the | |
5527 | build daemon uses. | |
5528 | ||
5529 | To that end, the first thing to do is to use the @option{--keep-failed} | |
5530 | or @option{-K} option of @command{guix build}, which will keep the | |
5531 | failed build tree in @file{/tmp} or whatever directory you specified as | |
5532 | @code{TMPDIR} (@pxref{Invoking guix build, @code{--keep-failed}}). | |
5533 | ||
5534 | From there on, you can @command{cd} to the failed build tree and source | |
5535 | the @file{environment-variables} file, which contains all the | |
5536 | environment variable definitions that were in place when the build | |
5537 | failed. So let's say you're debugging a build failure in package | |
5538 | @code{foo}; a typical session would look like this: | |
5539 | ||
5540 | @example | |
5541 | $ guix build foo -K | |
5542 | @dots{} @i{build fails} | |
5543 | $ cd /tmp/guix-build-foo.drv-0 | |
5544 | $ source ./environment-variables | |
5545 | $ cd foo-1.2 | |
5546 | @end example | |
5547 | ||
5548 | Now, you can invoke commands as if you were the daemon (almost) and | |
5549 | troubleshoot your build process. | |
5550 | ||
5551 | Sometimes it happens that, for example, a package's tests pass when you | |
5552 | run them manually but they fail when the daemon runs them. This can | |
5553 | happen because the daemon runs builds in containers where, unlike in our | |
5554 | environment above, network access is missing, @file{/bin/sh} does not | |
5555 | exist, etc. (@pxref{Build Environment Setup}). | |
5556 | ||
5557 | In such cases, you may need to run inspect the build process from within | |
5558 | a container similar to the one the build daemon creates: | |
5559 | ||
5560 | @example | |
5561 | $ guix build -K foo | |
5562 | @dots{} | |
5563 | $ cd /tmp/guix-build-foo.drv-0 | |
fa511e29 | 5564 | $ guix environment --no-grafts -C foo --ad-hoc strace gdb |
fc06b15e AP |
5565 | [env]# source ./environment-variables |
5566 | [env]# cd foo-1.2 | |
5567 | @end example | |
5568 | ||
5569 | Here, @command{guix environment -C} creates a container and spawns a new | |
5570 | shell in it (@pxref{Invoking guix environment}). The @command{--ad-hoc | |
5571 | strace gdb} part adds the @command{strace} and @command{gdb} commands to | |
fa511e29 LC |
5572 | the container, which would may find handy while debugging. The |
5573 | @option{--no-grafts} option makes sure we get the exact same | |
5574 | environment, with ungrafted packages (@pxref{Security Updates}, for more | |
5575 | info on grafts). | |
fc06b15e AP |
5576 | |
5577 | To get closer to a container like that used by the build daemon, we can | |
5578 | remove @file{/bin/sh}: | |
5579 | ||
5580 | @example | |
5581 | [env]# rm /bin/sh | |
5582 | @end example | |
5583 | ||
5584 | (Don't worry, this is harmless: this is all happening in the throw-away | |
5585 | container created by @command{guix environment}.) | |
5586 | ||
5587 | The @command{strace} command is probably not in the search path, but we | |
5588 | can run: | |
5589 | ||
5590 | @example | |
5591 | [env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check | |
5592 | @end example | |
5593 | ||
5594 | In this way, not only you will have reproduced the environment variables | |
5595 | the daemon uses, you will also be running the build process in a container | |
5596 | similar to the one the daemon uses. | |
5597 | ||
16eb115e | 5598 | |
39bee8a2 LC |
5599 | @node Invoking guix edit |
5600 | @section Invoking @command{guix edit} | |
5601 | ||
e32171ee | 5602 | @cindex @command{guix edit} |
39bee8a2 LC |
5603 | @cindex package definition, editing |
5604 | So many packages, so many source files! The @command{guix edit} command | |
424a323e GC |
5605 | facilitates the life of users and packagers by pointing their editor at |
5606 | the source file containing the definition of the specified packages. | |
5607 | For instance: | |
39bee8a2 LC |
5608 | |
5609 | @example | |
7b9a66e5 | 5610 | guix edit gcc@@4.9 vim |
39bee8a2 LC |
5611 | @end example |
5612 | ||
5613 | @noindent | |
6237b9fa | 5614 | launches the program specified in the @code{VISUAL} or in the |
424a323e | 5615 | @code{EDITOR} environment variable to view the recipe of GCC@tie{}4.9.3 |
6237b9fa | 5616 | and that of Vim. |
39bee8a2 | 5617 | |
424a323e GC |
5618 | If you are using a Guix Git checkout (@pxref{Building from Git}), or |
5619 | have created your own packages on @code{GUIX_PACKAGE_PATH} | |
5620 | (@pxref{Defining Packages}), you will be able to edit the package | |
5621 | recipes. Otherwise, you will be able to examine the read-only recipes | |
5622 | for packages currently in the store. | |
5623 | ||
39bee8a2 | 5624 | |
210cc920 LC |
5625 | @node Invoking guix download |
5626 | @section Invoking @command{guix download} | |
5627 | ||
e32171ee JD |
5628 | @cindex @command{guix download} |
5629 | @cindex downloading package sources | |
210cc920 | 5630 | When writing a package definition, developers typically need to download |
f97c9175 | 5631 | a source tarball, compute its SHA256 hash, and write that |
210cc920 LC |
5632 | hash in the package definition (@pxref{Defining Packages}). The |
5633 | @command{guix download} tool helps with this task: it downloads a file | |
5634 | from the given URI, adds it to the store, and prints both its file name | |
5635 | in the store and its SHA256 hash. | |
5636 | ||
5637 | The fact that the downloaded file is added to the store saves bandwidth: | |
5638 | when the developer eventually tries to build the newly defined package | |
5639 | with @command{guix build}, the source tarball will not have to be | |
5640 | downloaded again because it is already in the store. It is also a | |
5641 | convenient way to temporarily stash files, which may be deleted | |
5642 | eventually (@pxref{Invoking guix gc}). | |
5643 | ||
5644 | The @command{guix download} command supports the same URIs as used in | |
5645 | package definitions. In particular, it supports @code{mirror://} URIs. | |
5646 | @code{https} URIs (HTTP over TLS) are supported @emph{provided} the | |
5647 | Guile bindings for GnuTLS are available in the user's environment; when | |
537c8bb3 LC |
5648 | they are not available, an error is raised. @xref{Guile Preparations, |
5649 | how to install the GnuTLS bindings for Guile,, gnutls-guile, | |
5650 | GnuTLS-Guile}, for more information. | |
210cc920 | 5651 | |
bc3c41ce LC |
5652 | @command{guix download} verifies HTTPS server certificates by loading |
5653 | the certificates of X.509 authorities from the directory pointed to by | |
5654 | the @code{SSL_CERT_DIR} environment variable (@pxref{X.509 | |
64b8695c | 5655 | Certificates}), unless @option{--no-check-certificate} is used. |
bc3c41ce | 5656 | |
64b8695c | 5657 | The following options are available: |
210cc920 LC |
5658 | |
5659 | @table @code | |
5660 | @item --format=@var{fmt} | |
5661 | @itemx -f @var{fmt} | |
5662 | Write the hash in the format specified by @var{fmt}. For more | |
081145cf | 5663 | information on the valid values for @var{fmt}, @pxref{Invoking guix hash}. |
64b8695c LC |
5664 | |
5665 | @item --no-check-certificate | |
5666 | Do not validate the X.509 certificates of HTTPS servers. | |
5667 | ||
5668 | When using this option, you have @emph{absolutely no guarantee} that you | |
5669 | are communicating with the authentic server responsible for the given | |
5670 | URL, which makes you vulnerable to ``man-in-the-middle'' attacks. | |
5671 | ||
1bcc87bb LC |
5672 | @item --output=@var{file} |
5673 | @itemx -o @var{file} | |
5674 | Save the downloaded file to @var{file} instead of adding it to the | |
5675 | store. | |
210cc920 LC |
5676 | @end table |
5677 | ||
6c365eca NK |
5678 | @node Invoking guix hash |
5679 | @section Invoking @command{guix hash} | |
5680 | ||
e32171ee | 5681 | @cindex @command{guix hash} |
210cc920 | 5682 | The @command{guix hash} command computes the SHA256 hash of a file. |
6c365eca NK |
5683 | It is primarily a convenience tool for anyone contributing to the |
5684 | distribution: it computes the cryptographic hash of a file, which can be | |
5685 | used in the definition of a package (@pxref{Defining Packages}). | |
5686 | ||
5687 | The general syntax is: | |
5688 | ||
5689 | @example | |
5690 | guix hash @var{option} @var{file} | |
5691 | @end example | |
5692 | ||
343dc117 LC |
5693 | When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the |
5694 | hash of data read from standard input. @command{guix hash} has the | |
5695 | following options: | |
6c365eca NK |
5696 | |
5697 | @table @code | |
5698 | ||
5699 | @item --format=@var{fmt} | |
5700 | @itemx -f @var{fmt} | |
210cc920 | 5701 | Write the hash in the format specified by @var{fmt}. |
6c365eca NK |
5702 | |
5703 | Supported formats: @code{nix-base32}, @code{base32}, @code{base16} | |
5704 | (@code{hex} and @code{hexadecimal} can be used as well). | |
5705 | ||
5706 | If the @option{--format} option is not specified, @command{guix hash} | |
5707 | will output the hash in @code{nix-base32}. This representation is used | |
5708 | in the definitions of packages. | |
5709 | ||
3140f2df LC |
5710 | @item --recursive |
5711 | @itemx -r | |
5712 | Compute the hash on @var{file} recursively. | |
5713 | ||
5714 | In this case, the hash is computed on an archive containing @var{file}, | |
f97c9175 AE |
5715 | including its children if it is a directory. Some of the metadata of |
5716 | @var{file} is part of the archive; for instance, when @var{file} is a | |
3140f2df | 5717 | regular file, the hash is different depending on whether @var{file} is |
f97c9175 | 5718 | executable or not. Metadata such as time stamps has no impact on the |
3140f2df LC |
5719 | hash (@pxref{Invoking guix archive}). |
5720 | @c FIXME: Replace xref above with xref to an ``Archive'' section when | |
5721 | @c it exists. | |
5722 | ||
392a4e12 JN |
5723 | @item --exclude-vcs |
5724 | @itemx -x | |
5725 | When combined with @option{--recursive}, exclude version control system | |
5726 | directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.) | |
5727 | ||
db97a03a LC |
5728 | @vindex git-fetch |
5729 | As an example, here is how you would compute the hash of a Git checkout, | |
5730 | which is useful when using the @code{git-fetch} method (@pxref{origin | |
5731 | Reference}): | |
5732 | ||
5733 | @example | |
5734 | $ git clone http://example.org/foo.git | |
5735 | $ cd foo | |
392a4e12 | 5736 | $ guix hash -rx . |
db97a03a | 5737 | @end example |
6c365eca NK |
5738 | @end table |
5739 | ||
2f7d2d91 LC |
5740 | @node Invoking guix import |
5741 | @section Invoking @command{guix import} | |
5742 | ||
5743 | @cindex importing packages | |
5744 | @cindex package import | |
5745 | @cindex package conversion | |
e32171ee | 5746 | @cindex Invoking @command{guix import} |
f97c9175 AE |
5747 | The @command{guix import} command is useful for people who would like to |
5748 | add a package to the distribution with as little work as | |
5749 | possible---a legitimate demand. The command knows of a few | |
5750 | repositories from which it can ``import'' package metadata. The result | |
2f7d2d91 LC |
5751 | is a package definition, or a template thereof, in the format we know |
5752 | (@pxref{Defining Packages}). | |
5753 | ||
5754 | The general syntax is: | |
5755 | ||
5756 | @example | |
5757 | guix import @var{importer} @var{options}@dots{} | |
5758 | @end example | |
5759 | ||
5760 | @var{importer} specifies the source from which to import package | |
f97c9175 | 5761 | metadata, and @var{options} specifies a package identifier and other |
2f7d2d91 LC |
5762 | options specific to @var{importer}. Currently, the available |
5763 | ``importers'' are: | |
5764 | ||
5765 | @table @code | |
5766 | @item gnu | |
f97c9175 | 5767 | Import metadata for the given GNU package. This provides a template |
2f7d2d91 LC |
5768 | for the latest version of that GNU package, including the hash of its |
5769 | source tarball, and its canonical synopsis and description. | |
5770 | ||
f97c9175 | 5771 | Additional information such as the package dependencies and its |
2f7d2d91 LC |
5772 | license needs to be figured out manually. |
5773 | ||
5774 | For example, the following command returns a package definition for | |
5775 | GNU@tie{}Hello: | |
5776 | ||
5777 | @example | |
5778 | guix import gnu hello | |
5779 | @end example | |
5780 | ||
5781 | Specific command-line options are: | |
5782 | ||
5783 | @table @code | |
5784 | @item --key-download=@var{policy} | |
5785 | As for @code{guix refresh}, specify the policy to handle missing OpenPGP | |
f97c9175 | 5786 | keys when verifying the package signature. @xref{Invoking guix |
2f7d2d91 LC |
5787 | refresh, @code{--key-download}}. |
5788 | @end table | |
5789 | ||
5790 | @item pypi | |
5791 | @cindex pypi | |
f97c9175 | 5792 | Import metadata from the @uref{https://pypi.python.org/, Python Package |
2f7d2d91 LC |
5793 | Index}@footnote{This functionality requires Guile-JSON to be installed. |
5794 | @xref{Requirements}.}. Information is taken from the JSON-formatted | |
5795 | description available at @code{pypi.python.org} and usually includes all | |
266785d2 CR |
5796 | the relevant information, including package dependencies. For maximum |
5797 | efficiency, it is recommended to install the @command{unzip} utility, so | |
5798 | that the importer can unzip Python wheels and gather data from them. | |
2f7d2d91 | 5799 | |
f97c9175 | 5800 | The command below imports metadata for the @code{itsdangerous} Python |
2f7d2d91 LC |
5801 | package: |
5802 | ||
5803 | @example | |
5804 | guix import pypi itsdangerous | |
5805 | @end example | |
5806 | ||
3aae8145 DT |
5807 | @item gem |
5808 | @cindex gem | |
f97c9175 | 5809 | Import metadata from @uref{https://rubygems.org/, |
3aae8145 DT |
5810 | RubyGems}@footnote{This functionality requires Guile-JSON to be |
5811 | installed. @xref{Requirements}.}. Information is taken from the | |
5812 | JSON-formatted description available at @code{rubygems.org} and includes | |
5813 | most relevant information, including runtime dependencies. There are | |
f97c9175 | 5814 | some caveats, however. The metadata doesn't distinguish between |
3aae8145 DT |
5815 | synopses and descriptions, so the same string is used for both fields. |
5816 | Additionally, the details of non-Ruby dependencies required to build | |
5817 | native extensions is unavailable and left as an exercise to the | |
5818 | packager. | |
5819 | ||
f97c9175 | 5820 | The command below imports metadata for the @code{rails} Ruby package: |
3aae8145 DT |
5821 | |
5822 | @example | |
5823 | guix import gem rails | |
5824 | @end example | |
5825 | ||
d45dc6da EB |
5826 | @item cpan |
5827 | @cindex CPAN | |
3c192e4e AE |
5828 | Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}@footnote{This |
5829 | functionality requires Guile-JSON to be installed. | |
5830 | @xref{Requirements}.}. | |
f97c9175 | 5831 | Information is taken from the JSON-formatted metadata provided through |
d45dc6da | 5832 | @uref{https://api.metacpan.org/, MetaCPAN's API} and includes most |
66392e47 EB |
5833 | relevant information, such as module dependencies. License information |
5834 | should be checked closely. If Perl is available in the store, then the | |
5835 | @code{corelist} utility will be used to filter core modules out of the | |
5836 | list of dependencies. | |
d45dc6da | 5837 | |
f97c9175 | 5838 | The command command below imports metadata for the @code{Acme::Boolean} |
d45dc6da EB |
5839 | Perl module: |
5840 | ||
5841 | @example | |
5842 | guix import cpan Acme::Boolean | |
5843 | @end example | |
5844 | ||
e1248602 RW |
5845 | @item cran |
5846 | @cindex CRAN | |
d0bd632f | 5847 | @cindex Bioconductor |
f97c9175 | 5848 | Import metadata from @uref{http://cran.r-project.org/, CRAN}, the |
e1248602 RW |
5849 | central repository for the @uref{http://r-project.org, GNU@tie{}R |
5850 | statistical and graphical environment}. | |
5851 | ||
f97c9175 | 5852 | Information is extracted from the @code{DESCRIPTION} file of the package. |
e1248602 | 5853 | |
f97c9175 | 5854 | The command command below imports metadata for the @code{Cairo} |
e1248602 RW |
5855 | R package: |
5856 | ||
5857 | @example | |
5858 | guix import cran Cairo | |
5859 | @end example | |
5860 | ||
64ce53eb RW |
5861 | When @code{--recursive} is added, the importer will traverse the |
5862 | dependency graph of the given upstream package recursively and generate | |
5863 | package expressions for all those packages that are not yet in Guix. | |
5864 | ||
f97c9175 | 5865 | When @code{--archive=bioconductor} is added, metadata is imported from |
d0bd632f RW |
5866 | @uref{http://www.bioconductor.org/, Bioconductor}, a repository of R |
5867 | packages for for the analysis and comprehension of high-throughput | |
5868 | genomic data in bioinformatics. | |
5869 | ||
f97c9175 | 5870 | Information is extracted from the @code{DESCRIPTION} file of a package |
d0bd632f RW |
5871 | published on the web interface of the Bioconductor SVN repository. |
5872 | ||
f97c9175 | 5873 | The command below imports metadata for the @code{GenomicRanges} |
d0bd632f RW |
5874 | R package: |
5875 | ||
5876 | @example | |
5877 | guix import cran --archive=bioconductor GenomicRanges | |
5878 | @end example | |
5879 | ||
afbc9419 RW |
5880 | @item texlive |
5881 | @cindex TeX Live | |
5882 | @cindex CTAN | |
5883 | Import metadata from @uref{http://www.ctan.org/, CTAN}, the | |
5884 | comprehensive TeX archive network for TeX packages that are part of the | |
5885 | @uref{https://www.tug.org/texlive/, TeX Live distribution}. | |
5886 | ||
5887 | Information about the package is obtained through the XML API provided | |
5888 | by CTAN, while the source code is downloaded from the SVN repository of | |
5889 | the Tex Live project. This is done because the CTAN does not keep | |
5890 | versioned archives. | |
5891 | ||
5892 | The command command below imports metadata for the @code{fontspec} | |
5893 | TeX package: | |
5894 | ||
5895 | @example | |
5896 | guix import texlive fontspec | |
5897 | @end example | |
5898 | ||
5899 | When @code{--archive=DIRECTORY} is added, the source code is downloaded | |
5900 | not from the @file{latex} sub-directory of the @file{texmf-dist/source} | |
5901 | tree in the TeX Live SVN repository, but from the specified sibling | |
5902 | directory under the same root. | |
5903 | ||
5904 | The command below imports metadata for the @code{ifxetex} package from | |
5905 | CTAN while fetching the sources from the directory | |
5906 | @file{texmf/source/generic}: | |
5907 | ||
5908 | @example | |
5909 | guix import texlive --archive=generic ifxetex | |
5910 | @end example | |
5911 | ||
fb1db385 RW |
5912 | @item json |
5913 | @cindex JSON, import | |
5914 | Import package metadata from a local JSON file@footnote{This | |
5915 | functionality requires Guile-JSON to be installed. | |
5916 | @xref{Requirements}.}. Consider the following example package | |
5917 | definition in JSON format: | |
5918 | ||
5919 | @example | |
5920 | @{ | |
5921 | "name": "hello", | |
5922 | "version": "2.10", | |
5923 | "source": "mirror://gnu/hello/hello-2.10.tar.gz", | |
5924 | "build-system": "gnu", | |
5925 | "home-page": "https://www.gnu.org/software/hello/", | |
5926 | "synopsis": "Hello, GNU world: An example GNU package", | |
5927 | "description": "GNU Hello prints a greeting.", | |
5928 | "license": "GPL-3.0+", | |
5929 | "native-inputs": ["gcc@@6"] | |
5930 | @} | |
5931 | @end example | |
5932 | ||
5933 | The field names are the same as for the @code{<package>} record | |
5934 | (@xref{Defining Packages}). References to other packages are provided | |
5935 | as JSON lists of quoted package specification strings such as | |
5936 | @code{guile} or @code{guile@@2.0}. | |
5937 | ||
5938 | The importer also supports a more explicit source definition using the | |
5939 | common fields for @code{<origin>} records: | |
5940 | ||
5941 | @example | |
5942 | @{ | |
5943 | @dots{} | |
5944 | "source": @{ | |
5945 | "method": "url-fetch", | |
5946 | "uri": "mirror://gnu/hello/hello-2.10.tar.gz", | |
5947 | "sha256": @{ | |
5948 | "base32": "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i" | |
5949 | @} | |
5950 | @} | |
5951 | @dots{} | |
5952 | @} | |
5953 | @end example | |
5954 | ||
5955 | The command below reads metadata from the JSON file @code{hello.json} | |
5956 | and outputs a package expression: | |
5957 | ||
5958 | @example | |
5959 | guix import json hello.json | |
5960 | @end example | |
5961 | ||
2f7d2d91 | 5962 | @item nix |
f97c9175 | 5963 | Import metadata from a local copy of the source of the |
2f7d2d91 LC |
5964 | @uref{http://nixos.org/nixpkgs/, Nixpkgs distribution}@footnote{This |
5965 | relies on the @command{nix-instantiate} command of | |
5966 | @uref{http://nixos.org/nix/, Nix}.}. Package definitions in Nixpkgs are | |
5967 | typically written in a mixture of Nix-language and Bash code. This | |
5968 | command only imports the high-level package structure that is written in | |
5969 | the Nix language. It normally includes all the basic fields of a | |
5970 | package definition. | |
5971 | ||
5972 | When importing a GNU package, the synopsis and descriptions are replaced | |
5973 | by their canonical upstream variant. | |
5974 | ||
961d0d2d LC |
5975 | Usually, you will first need to do: |
5976 | ||
5977 | @example | |
5978 | export NIX_REMOTE=daemon | |
5979 | @end example | |
5980 | ||
5981 | @noindent | |
5982 | so that @command{nix-instantiate} does not try to open the Nix database. | |
5983 | ||
2f7d2d91 LC |
5984 | As an example, the command below imports the package definition of |
5985 | LibreOffice (more precisely, it imports the definition of the package | |
5986 | bound to the @code{libreoffice} top-level attribute): | |
5987 | ||
5988 | @example | |
5989 | guix import nix ~/path/to/nixpkgs libreoffice | |
5990 | @end example | |
863af4e1 FB |
5991 | |
5992 | @item hackage | |
5993 | @cindex hackage | |
f97c9175 | 5994 | Import metadata from the Haskell community's central package archive |
863af4e1 FB |
5995 | @uref{https://hackage.haskell.org/, Hackage}. Information is taken from |
5996 | Cabal files and includes all the relevant information, including package | |
5997 | dependencies. | |
5998 | ||
5999 | Specific command-line options are: | |
6000 | ||
6001 | @table @code | |
a4154748 FB |
6002 | @item --stdin |
6003 | @itemx -s | |
f97c9175 | 6004 | Read a Cabal file from standard input. |
863af4e1 FB |
6005 | @item --no-test-dependencies |
6006 | @itemx -t | |
f97c9175 | 6007 | Do not include dependencies required only by the test suites. |
a4154748 FB |
6008 | @item --cabal-environment=@var{alist} |
6009 | @itemx -e @var{alist} | |
6010 | @var{alist} is a Scheme alist defining the environment in which the | |
6011 | Cabal conditionals are evaluated. The accepted keys are: @code{os}, | |
6012 | @code{arch}, @code{impl} and a string representing the name of a flag. | |
6013 | The value associated with a flag has to be either the symbol | |
6014 | @code{true} or @code{false}. The value associated with other keys | |
6015 | has to conform to the Cabal file format definition. The default value | |
6016 | associated with the keys @code{os}, @code{arch} and @code{impl} is | |
f97c9175 | 6017 | @samp{linux}, @samp{x86_64} and @samp{ghc}, respectively. |
863af4e1 FB |
6018 | @end table |
6019 | ||
f97c9175 | 6020 | The command below imports metadata for the latest version of the |
a4154748 FB |
6021 | @code{HTTP} Haskell package without including test dependencies and |
6022 | specifying the value of the flag @samp{network-uri} as @code{false}: | |
863af4e1 FB |
6023 | |
6024 | @example | |
a4154748 | 6025 | guix import hackage -t -e "'((\"network-uri\" . false))" HTTP |
863af4e1 FB |
6026 | @end example |
6027 | ||
6028 | A specific package version may optionally be specified by following the | |
1b846da8 | 6029 | package name by an at-sign and a version number as in the following example: |
863af4e1 FB |
6030 | |
6031 | @example | |
1b846da8 | 6032 | guix import hackage mtl@@2.1.3.1 |
863af4e1 | 6033 | @end example |
7f74a931 | 6034 | |
bc5844d1 FB |
6035 | @item stackage |
6036 | @cindex stackage | |
6037 | The @code{stackage} importer is a wrapper around the @code{hackage} one. | |
6038 | It takes a package name, looks up the package version included in a | |
6039 | long-term support (LTS) @uref{https://www.stackage.org, Stackage} | |
6040 | release and uses the @code{hackage} importer to retrieve its metadata. | |
6041 | Note that it is up to you to select an LTS release compatible with the | |
6042 | GHC compiler used by Guix. | |
6043 | ||
6044 | Specific command-line options are: | |
6045 | ||
6046 | @table @code | |
6047 | @item --no-test-dependencies | |
6048 | @itemx -t | |
6049 | Do not include dependencies required only by the test suites. | |
6050 | @item --lts-version=@var{version} | |
6051 | @itemx -r @var{version} | |
6052 | @var{version} is the desired LTS release version. If omitted the latest | |
6053 | release is used. | |
6054 | @end table | |
6055 | ||
6056 | The command below imports metadata for the @code{HTTP} Haskell package | |
6057 | included in the LTS Stackage release version 7.18: | |
6058 | ||
6059 | @example | |
6060 | guix import stackage --lts-version=7.18 HTTP | |
6061 | @end example | |
6062 | ||
7f74a931 FB |
6063 | @item elpa |
6064 | @cindex elpa | |
f97c9175 | 6065 | Import metadata from an Emacs Lisp Package Archive (ELPA) package |
7f74a931 FB |
6066 | repository (@pxref{Packages,,, emacs, The GNU Emacs Manual}). |
6067 | ||
6068 | Specific command-line options are: | |
6069 | ||
6070 | @table @code | |
6071 | @item --archive=@var{repo} | |
6072 | @itemx -a @var{repo} | |
6073 | @var{repo} identifies the archive repository from which to retrieve the | |
6074 | information. Currently the supported repositories and their identifiers | |
6075 | are: | |
6076 | @itemize - | |
6077 | @item | |
840bd1d3 | 6078 | @uref{http://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} |
7f74a931 FB |
6079 | identifier. This is the default. |
6080 | ||
624144e0 LC |
6081 | Packages from @code{elpa.gnu.org} are signed with one of the keys |
6082 | contained in the GnuPG keyring at | |
6083 | @file{share/emacs/25.1/etc/package-keyring.gpg} (or similar) in the | |
6084 | @code{emacs} package (@pxref{Package Installation, ELPA package | |
6085 | signatures,, emacs, The GNU Emacs Manual}). | |
6086 | ||
7f74a931 | 6087 | @item |
840bd1d3 | 6088 | @uref{http://stable.melpa.org/packages, MELPA-Stable}, selected by the |
7f74a931 FB |
6089 | @code{melpa-stable} identifier. |
6090 | ||
6091 | @item | |
840bd1d3 | 6092 | @uref{http://melpa.org/packages, MELPA}, selected by the @code{melpa} |
7f74a931 FB |
6093 | identifier. |
6094 | @end itemize | |
6095 | @end table | |
3e0c0365 DC |
6096 | |
6097 | @item crate | |
6098 | @cindex crate | |
6099 | Import metadata from the crates.io Rust package repository | |
6100 | @uref{https://crates.io, crates.io}. | |
2f7d2d91 LC |
6101 | @end table |
6102 | ||
6103 | The structure of the @command{guix import} code is modular. It would be | |
6104 | useful to have more importers for other package formats, and your help | |
6105 | is welcome here (@pxref{Contributing}). | |
6106 | ||
37166310 LC |
6107 | @node Invoking guix refresh |
6108 | @section Invoking @command{guix refresh} | |
6109 | ||
e32171ee | 6110 | @cindex @command {guix refresh} |
37166310 LC |
6111 | The primary audience of the @command{guix refresh} command is developers |
6112 | of the GNU software distribution. By default, it reports any packages | |
6113 | provided by the distribution that are outdated compared to the latest | |
6114 | upstream version, like this: | |
6115 | ||
6116 | @example | |
6117 | $ guix refresh | |
6118 | gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1 | |
6119 | gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0 | |
6120 | @end example | |
6121 | ||
e9c72306 LC |
6122 | Alternately, one can specify packages to consider, in which case a |
6123 | warning is emitted for packages that lack an updater: | |
6124 | ||
6125 | @example | |
6126 | $ guix refresh coreutils guile guile-ssh | |
6127 | gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh | |
6128 | gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13 | |
6129 | @end example | |
6130 | ||
6131 | @command{guix refresh} browses the upstream repository of each package and determines | |
6132 | the highest version number of the releases therein. The command | |
bcb571cb | 6133 | knows how to update specific types of packages: GNU packages, ELPA |
e9c72306 | 6134 | packages, etc.---see the documentation for @option{--type} below. There |
bcb571cb LC |
6135 | are many packages, though, for which it lacks a method to determine |
6136 | whether a new upstream release is available. However, the mechanism is | |
6137 | extensible, so feel free to get in touch with us to add a new method! | |
37166310 LC |
6138 | |
6139 | When passed @code{--update}, it modifies distribution source files to | |
f97c9175 | 6140 | update the version numbers and source tarball hashes of those package |
37166310 LC |
6141 | recipes (@pxref{Defining Packages}). This is achieved by downloading |
6142 | each package's latest source tarball and its associated OpenPGP | |
6143 | signature, authenticating the downloaded tarball against its signature | |
6144 | using @command{gpg}, and finally computing its hash. When the public | |
6145 | key used to sign the tarball is missing from the user's keyring, an | |
6146 | attempt is made to automatically retrieve it from a public key server; | |
f97c9175 | 6147 | when this is successful, the key is added to the user's keyring; otherwise, |
37166310 LC |
6148 | @command{guix refresh} reports an error. |
6149 | ||
6150 | The following options are supported: | |
6151 | ||
6152 | @table @code | |
6153 | ||
2d7fc7da LC |
6154 | @item --expression=@var{expr} |
6155 | @itemx -e @var{expr} | |
6156 | Consider the package @var{expr} evaluates to. | |
6157 | ||
6158 | This is useful to precisely refer to a package, as in this example: | |
6159 | ||
6160 | @example | |
6161 | guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)' | |
6162 | @end example | |
6163 | ||
6164 | This command lists the dependents of the ``final'' libc (essentially all | |
6165 | the packages.) | |
6166 | ||
37166310 LC |
6167 | @item --update |
6168 | @itemx -u | |
38e16b49 LC |
6169 | Update distribution source files (package recipes) in place. This is |
6170 | usually run from a checkout of the Guix source tree (@pxref{Running | |
6171 | Guix Before It Is Installed}): | |
6172 | ||
6173 | @example | |
e9c72306 | 6174 | $ ./pre-inst-env guix refresh -s non-core -u |
38e16b49 LC |
6175 | @end example |
6176 | ||
081145cf | 6177 | @xref{Defining Packages}, for more information on package definitions. |
37166310 LC |
6178 | |
6179 | @item --select=[@var{subset}] | |
6180 | @itemx -s @var{subset} | |
6181 | Select all the packages in @var{subset}, one of @code{core} or | |
6182 | @code{non-core}. | |
6183 | ||
6184 | The @code{core} subset refers to all the packages at the core of the | |
6185 | distribution---i.e., packages that are used to build ``everything | |
6186 | else''. This includes GCC, libc, Binutils, Bash, etc. Usually, | |
6187 | changing one of these packages in the distribution entails a rebuild of | |
6188 | all the others. Thus, such updates are an inconvenience to users in | |
6189 | terms of build time or bandwidth used to achieve the upgrade. | |
6190 | ||
6191 | The @code{non-core} subset refers to the remaining packages. It is | |
6192 | typically useful in cases where an update of the core packages would be | |
6193 | inconvenient. | |
6194 | ||
1335ac31 MO |
6195 | @item --manifest=@var{file} |
6196 | @itemx -m @var{file} | |
6197 | Select all the packages from the manifest in @var{file}. This is useful to | |
6198 | check if any packages of the user manifest can be updated. | |
6199 | ||
bcb571cb LC |
6200 | @item --type=@var{updater} |
6201 | @itemx -t @var{updater} | |
7191adc5 AK |
6202 | Select only packages handled by @var{updater} (may be a comma-separated |
6203 | list of updaters). Currently, @var{updater} may be one of: | |
bcb571cb LC |
6204 | |
6205 | @table @code | |
6206 | @item gnu | |
6207 | the updater for GNU packages; | |
e80c0f85 LC |
6208 | @item gnome |
6209 | the updater for GNOME packages; | |
9c97afe8 DC |
6210 | @item kde |
6211 | the updater for KDE packages; | |
62061d6b AW |
6212 | @item xorg |
6213 | the updater for X.org packages; | |
2fd370e8 LC |
6214 | @item kernel.org |
6215 | the updater for packages hosted on kernel.org; | |
bcb571cb | 6216 | @item elpa |
d882c235 LC |
6217 | the updater for @uref{http://elpa.gnu.org/, ELPA} packages; |
6218 | @item cran | |
b9d044ef | 6219 | the updater for @uref{http://cran.r-project.org/, CRAN} packages; |
d0bd632f RW |
6220 | @item bioconductor |
6221 | the updater for @uref{http://www.bioconductor.org/, Bioconductor} R packages; | |
200cdf81 EB |
6222 | @item cpan |
6223 | the updater for @uref{http://www.cpan.org/, CPAN} packages; | |
bab020d7 | 6224 | @item pypi |
b9d044ef | 6225 | the updater for @uref{https://pypi.python.org, PyPI} packages. |
fbc5b815 BW |
6226 | @item gem |
6227 | the updater for @uref{https://rubygems.org, RubyGems} packages. | |
917a2a58 BW |
6228 | @item github |
6229 | the updater for @uref{https://github.com, GitHub} packages. | |
42efe27a EB |
6230 | @item hackage |
6231 | the updater for @uref{https://hackage.haskell.org, Hackage} packages. | |
bc5844d1 FB |
6232 | @item stackage |
6233 | the updater for @uref{https://www.stackage.org, Stackage} packages. | |
8ac52987 DC |
6234 | @item crate |
6235 | the updater for @uref{https://crates.io, Crates} packages. | |
bcb571cb LC |
6236 | @end table |
6237 | ||
f97c9175 AE |
6238 | For instance, the following command only checks for updates of Emacs |
6239 | packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages: | |
bcb571cb LC |
6240 | |
6241 | @example | |
7191adc5 | 6242 | $ guix refresh --type=elpa,cran |
d882c235 | 6243 | gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0 |
bcb571cb LC |
6244 | gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9 |
6245 | @end example | |
6246 | ||
37166310 LC |
6247 | @end table |
6248 | ||
6249 | In addition, @command{guix refresh} can be passed one or more package | |
6250 | names, as in this example: | |
6251 | ||
6252 | @example | |
e9c72306 | 6253 | $ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8 |
37166310 LC |
6254 | @end example |
6255 | ||
6256 | @noindent | |
6257 | The command above specifically updates the @code{emacs} and | |
6258 | @code{idutils} packages. The @code{--select} option would have no | |
6259 | effect in this case. | |
6260 | ||
7d193ec3 EB |
6261 | When considering whether to upgrade a package, it is sometimes |
6262 | convenient to know which packages would be affected by the upgrade and | |
6263 | should be checked for compatibility. For this the following option may | |
6264 | be used when passing @command{guix refresh} one or more package names: | |
6265 | ||
6266 | @table @code | |
6267 | ||
6ffa706b AK |
6268 | @item --list-updaters |
6269 | @itemx -L | |
6270 | List available updaters and exit (see @option{--type} above.) | |
6271 | ||
3676f892 LC |
6272 | For each updater, display the fraction of packages it covers; at the |
6273 | end, display the fraction of packages covered by all these updaters. | |
6274 | ||
7d193ec3 EB |
6275 | @item --list-dependent |
6276 | @itemx -l | |
6277 | List top-level dependent packages that would need to be rebuilt as a | |
6278 | result of upgrading one or more packages. | |
6279 | ||
b96a0640 LC |
6280 | @xref{Invoking guix graph, the @code{reverse-package} type of |
6281 | @command{guix graph}}, for information on how to visualize the list of | |
6282 | dependents of a package. | |
6283 | ||
7d193ec3 EB |
6284 | @end table |
6285 | ||
6286 | Be aware that the @code{--list-dependent} option only | |
6287 | @emph{approximates} the rebuilds that would be required as a result of | |
6288 | an upgrade. More rebuilds might be required under some circumstances. | |
6289 | ||
6290 | @example | |
7779ab61 LC |
6291 | $ guix refresh --list-dependent flex |
6292 | Building the following 120 packages would ensure 213 dependent packages are rebuilt: | |
6d1a5e5f | 6293 | hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{} |
7d193ec3 EB |
6294 | @end example |
6295 | ||
6296 | The command above lists a set of packages that could be built to check | |
6297 | for compatibility with an upgraded @code{flex} package. | |
6298 | ||
f9230085 LC |
6299 | The following options can be used to customize GnuPG operation: |
6300 | ||
6301 | @table @code | |
6302 | ||
f9230085 LC |
6303 | @item --gpg=@var{command} |
6304 | Use @var{command} as the GnuPG 2.x command. @var{command} is searched | |
6305 | for in @code{$PATH}. | |
6306 | ||
2bc53ba9 LC |
6307 | @item --key-download=@var{policy} |
6308 | Handle missing OpenPGP keys according to @var{policy}, which may be one | |
6309 | of: | |
6310 | ||
6311 | @table @code | |
6312 | @item always | |
6313 | Always download missing OpenPGP keys from the key server, and add them | |
6314 | to the user's GnuPG keyring. | |
6315 | ||
6316 | @item never | |
6317 | Never try to download missing OpenPGP keys. Instead just bail out. | |
6318 | ||
6319 | @item interactive | |
6320 | When a package signed with an unknown OpenPGP key is encountered, ask | |
6321 | the user whether to download it or not. This is the default behavior. | |
6322 | @end table | |
6323 | ||
6324 | @item --key-server=@var{host} | |
6325 | Use @var{host} as the OpenPGP key server when importing a public key. | |
6326 | ||
f9230085 LC |
6327 | @end table |
6328 | ||
917a2a58 BW |
6329 | The @code{github} updater uses the |
6330 | @uref{https://developer.github.com/v3/, GitHub API} to query for new | |
6331 | releases. When used repeatedly e.g. when refreshing all packages, | |
6332 | GitHub will eventually refuse to answer any further API requests. By | |
6333 | default 60 API requests per hour are allowed, and a full refresh on all | |
6334 | GitHub packages in Guix requires more than this. Authentication with | |
6335 | GitHub through the use of an API token alleviates these limits. To use | |
6336 | an API token, set the environment variable @code{GUIX_GITHUB_TOKEN} to a | |
6337 | token procured from @uref{https://github.com/settings/tokens} or | |
6338 | otherwise. | |
6339 | ||
6340 | ||
b4f5e0e8 CR |
6341 | @node Invoking guix lint |
6342 | @section Invoking @command{guix lint} | |
e32171ee JD |
6343 | |
6344 | @cindex @command{guix lint} | |
6345 | @cindex package, checking for errors | |
f97c9175 AE |
6346 | The @command{guix lint} command is meant to help package developers avoid |
6347 | common errors and use a consistent style. It runs a number of checks on | |
6348 | a given set of packages in order to find common mistakes in their | |
873c4085 LC |
6349 | definitions. Available @dfn{checkers} include (see |
6350 | @code{--list-checkers} for a complete list): | |
6351 | ||
6352 | @table @code | |
6353 | @item synopsis | |
6354 | @itemx description | |
6355 | Validate certain typographical and stylistic rules about package | |
6356 | descriptions and synopses. | |
6357 | ||
6358 | @item inputs-should-be-native | |
6359 | Identify inputs that should most likely be native inputs. | |
6360 | ||
6361 | @item source | |
6362 | @itemx home-page | |
fac46e3f | 6363 | @itemx mirror-url |
50f5c46d | 6364 | @itemx source-file-name |
873c4085 | 6365 | Probe @code{home-page} and @code{source} URLs and report those that are |
fac46e3f LC |
6366 | invalid. Suggest a @code{mirror://} URL when applicable. Check that |
6367 | the source file name is meaningful, e.g. is not | |
f97c9175 AE |
6368 | just a version number or ``git-checkout'', without a declared |
6369 | @code{file-name} (@pxref{origin Reference}). | |
40a7d4e5 | 6370 | |
5432734b | 6371 | @item cve |
09866b39 LC |
6372 | @cindex security vulnerabilities |
6373 | @cindex CVE, Common Vulnerabilities and Exposures | |
5432734b | 6374 | Report known vulnerabilities found in the Common Vulnerabilities and |
09866b39 | 6375 | Exposures (CVE) databases of the current and past year |
5432734b LC |
6376 | @uref{https://nvd.nist.gov/download.cfm#CVE_FEED, published by the US |
6377 | NIST}. | |
6378 | ||
09866b39 LC |
6379 | To view information about a particular vulnerability, visit pages such as: |
6380 | ||
6381 | @itemize | |
6382 | @item | |
6383 | @indicateurl{https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD} | |
6384 | @item | |
6385 | @indicateurl{https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD} | |
6386 | @end itemize | |
6387 | ||
6388 | @noindent | |
6389 | where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., | |
6390 | @code{CVE-2015-7554}. | |
6391 | ||
99effc8f LC |
6392 | Package developers can specify in package recipes the |
6393 | @uref{https://nvd.nist.gov/cpe.cfm,Common Platform Enumeration (CPE)} | |
6394 | name and version of the package when they differ from the name that Guix | |
6395 | uses, as in this example: | |
6396 | ||
6397 | @example | |
6398 | (package | |
6399 | (name "grub") | |
6400 | ;; @dots{} | |
6401 | ;; CPE calls this package "grub2". | |
6402 | (properties '((cpe-name . "grub2")))) | |
6403 | @end example | |
6404 | ||
40a7d4e5 LC |
6405 | @item formatting |
6406 | Warn about obvious source code formatting issues: trailing white space, | |
6407 | use of tabulations, etc. | |
873c4085 | 6408 | @end table |
b4f5e0e8 CR |
6409 | |
6410 | The general syntax is: | |
6411 | ||
6412 | @example | |
6413 | guix lint @var{options} @var{package}@dots{} | |
6414 | @end example | |
6415 | ||
6416 | If no package is given on the command line, then all packages are checked. | |
6417 | The @var{options} may be zero or more of the following: | |
6418 | ||
6419 | @table @code | |
f97c9175 AE |
6420 | @item --list-checkers |
6421 | @itemx -l | |
6422 | List and describe all the available checkers that will be run on packages | |
6423 | and exit. | |
b4f5e0e8 | 6424 | |
dd7c013d CR |
6425 | @item --checkers |
6426 | @itemx -c | |
6427 | Only enable the checkers specified in a comma-separated list using the | |
6428 | names returned by @code{--list-checkers}. | |
6429 | ||
b4f5e0e8 | 6430 | @end table |
37166310 | 6431 | |
fcc58db6 LC |
6432 | @node Invoking guix size |
6433 | @section Invoking @command{guix size} | |
6434 | ||
e32171ee JD |
6435 | @cindex size |
6436 | @cindex package size | |
6437 | @cindex closure | |
6438 | @cindex @command{guix size} | |
fcc58db6 LC |
6439 | The @command{guix size} command helps package developers profile the |
6440 | disk usage of packages. It is easy to overlook the impact of an | |
6441 | additional dependency added to a package, or the impact of using a | |
6442 | single output for a package that could easily be split (@pxref{Packages | |
f97c9175 | 6443 | with Multiple Outputs}). Such are the typical issues that |
fcc58db6 LC |
6444 | @command{guix size} can highlight. |
6445 | ||
e1a65ae5 | 6446 | The command can be passed a package specification such as @code{gcc@@4.8} |
fcc58db6 LC |
6447 | or @code{guile:debug}, or a file name in the store. Consider this |
6448 | example: | |
6449 | ||
6450 | @example | |
6451 | $ guix size coreutils | |
6452 | store item total self | |
6453 | /gnu/store/@dots{}-coreutils-8.23 70.0 13.9 19.8% | |
6454 | /gnu/store/@dots{}-gmp-6.0.0a 55.3 2.5 3.6% | |
6455 | /gnu/store/@dots{}-acl-2.2.52 53.7 0.5 0.7% | |
6456 | /gnu/store/@dots{}-attr-2.4.46 53.2 0.3 0.5% | |
6457 | /gnu/store/@dots{}-gcc-4.8.4-lib 52.9 15.7 22.4% | |
6458 | /gnu/store/@dots{}-glibc-2.21 37.2 37.2 53.1% | |
6459 | @end example | |
6460 | ||
6461 | @cindex closure | |
6462 | The store items listed here constitute the @dfn{transitive closure} of | |
6463 | Coreutils---i.e., Coreutils and all its dependencies, recursively---as | |
6464 | would be returned by: | |
6465 | ||
6466 | @example | |
6467 | $ guix gc -R /gnu/store/@dots{}-coreutils-8.23 | |
6468 | @end example | |
6469 | ||
f97c9175 | 6470 | Here the output shows three columns next to store items. The first column, |
fcc58db6 LC |
6471 | labeled ``total'', shows the size in mebibytes (MiB) of the closure of |
6472 | the store item---that is, its own size plus the size of all its | |
6473 | dependencies. The next column, labeled ``self'', shows the size of the | |
f97c9175 AE |
6474 | item itself. The last column shows the ratio of the size of the item |
6475 | itself to the space occupied by all the items listed here. | |
fcc58db6 LC |
6476 | |
6477 | In this example, we see that the closure of Coreutils weighs in at | |
6478 | 70@tie{}MiB, half of which is taken by libc. (That libc represents a | |
6479 | large fraction of the closure is not a problem @i{per se} because it is | |
6480 | always available on the system anyway.) | |
6481 | ||
6482 | When the package passed to @command{guix size} is available in the | |
6483 | store, @command{guix size} queries the daemon to determine its | |
6484 | dependencies, and measures its size in the store, similar to @command{du | |
6485 | -ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU | |
6486 | Coreutils}). | |
6487 | ||
6488 | When the given package is @emph{not} in the store, @command{guix size} | |
f97c9175 AE |
6489 | reports information based on the available substitutes |
6490 | (@pxref{Substitutes}). This makes it possible it to profile disk usage of | |
6491 | store items that are not even on disk, only available remotely. | |
fcc58db6 | 6492 | |
db761534 LC |
6493 | You can also specify several package names: |
6494 | ||
6495 | @example | |
6496 | $ guix size coreutils grep sed bash | |
6497 | store item total self | |
6498 | /gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4% | |
6499 | /gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8% | |
6500 | /gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6% | |
6501 | /gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2% | |
6502 | @dots{} | |
6503 | total: 102.3 MiB | |
6504 | @end example | |
6505 | ||
6506 | @noindent | |
6507 | In this example we see that the combination of the four packages takes | |
6508 | 102.3@tie{}MiB in total, which is much less than the sum of each closure | |
6509 | since they have a lot of dependencies in common. | |
6510 | ||
a8f996c6 | 6511 | The available options are: |
fcc58db6 LC |
6512 | |
6513 | @table @option | |
6514 | ||
d490d06e LC |
6515 | @item --substitute-urls=@var{urls} |
6516 | Use substitute information from @var{urls}. | |
6517 | @xref{client-substitute-urls, the same option for @code{guix build}}. | |
6518 | ||
a6c1fe82 LC |
6519 | @item --sort=@var{key} |
6520 | Sort lines according to @var{key}, one of the following options: | |
6521 | ||
6522 | @table @code | |
a6c1fe82 | 6523 | @item self |
fb255088 LC |
6524 | the size of each item (the default); |
6525 | @item closure | |
6526 | the total size of the item's closure. | |
a6c1fe82 LC |
6527 | @end table |
6528 | ||
a8f996c6 | 6529 | @item --map-file=@var{file} |
f97c9175 | 6530 | Write a graphical map of disk usage in PNG format to @var{file}. |
a8f996c6 LC |
6531 | |
6532 | For the example above, the map looks like this: | |
6533 | ||
6534 | @image{images/coreutils-size-map,5in,, map of Coreutils disk usage | |
6535 | produced by @command{guix size}} | |
6536 | ||
6537 | This option requires that | |
6538 | @uref{http://wingolog.org/software/guile-charting/, Guile-Charting} be | |
6539 | installed and visible in Guile's module search path. When that is not | |
6540 | the case, @command{guix size} fails as it tries to load it. | |
6541 | ||
fcc58db6 LC |
6542 | @item --system=@var{system} |
6543 | @itemx -s @var{system} | |
6544 | Consider packages for @var{system}---e.g., @code{x86_64-linux}. | |
6545 | ||
6546 | @end table | |
6547 | ||
88856916 LC |
6548 | @node Invoking guix graph |
6549 | @section Invoking @command{guix graph} | |
6550 | ||
6551 | @cindex DAG | |
e32171ee JD |
6552 | @cindex @command{guix graph} |
6553 | @cindex package dependencies | |
88856916 LC |
6554 | Packages and their dependencies form a @dfn{graph}, specifically a |
6555 | directed acyclic graph (DAG). It can quickly become difficult to have a | |
f97c9175 | 6556 | mental model of the package DAG, so the @command{guix graph} command |
9ea36197 LC |
6557 | provides a visual representation of the DAG. By default, |
6558 | @command{guix graph} emits a DAG representation in the input format of | |
88856916 | 6559 | @uref{http://www.graphviz.org/, Graphviz}, so its output can be passed |
9ea36197 LC |
6560 | directly to the @command{dot} command of Graphviz. It can also emit an |
6561 | HTML page with embedded JavaScript code to display a ``chord diagram'' | |
5899fafb RJ |
6562 | in a Web browser, using the @uref{https://d3js.org/, d3.js} library, or |
6563 | emit Cypher queries to construct a graph in a graph database supporting | |
6564 | the @uref{http://www.opencypher.org/, openCypher} query language. | |
9ea36197 | 6565 | The general syntax is: |
88856916 LC |
6566 | |
6567 | @example | |
6568 | guix graph @var{options} @var{package}@dots{} | |
6569 | @end example | |
6570 | ||
6571 | For example, the following command generates a PDF file representing the | |
6572 | package DAG for the GNU@tie{}Core Utilities, showing its build-time | |
6573 | dependencies: | |
6574 | ||
6575 | @example | |
6576 | guix graph coreutils | dot -Tpdf > dag.pdf | |
6577 | @end example | |
6578 | ||
6579 | The output looks like this: | |
6580 | ||
6581 | @image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils} | |
6582 | ||
6583 | Nice little graph, no? | |
6584 | ||
f97c9175 | 6585 | But there is more than one graph! The one above is concise: it is the |
88856916 | 6586 | graph of package objects, omitting implicit inputs such as GCC, libc, |
f97c9175 AE |
6587 | grep, etc. It is often useful to have such a concise graph, but |
6588 | sometimes one may want to see more details. @command{guix graph} supports | |
6589 | several types of graphs, allowing you to choose the level of detail: | |
88856916 LC |
6590 | |
6591 | @table @code | |
6592 | @item package | |
f97c9175 | 6593 | This is the default type used in the example above. It shows the DAG of |
88856916 LC |
6594 | package objects, excluding implicit dependencies. It is concise, but |
6595 | filters out many details. | |
6596 | ||
b96a0640 LC |
6597 | @item reverse-package |
6598 | This shows the @emph{reverse} DAG of packages. For example: | |
6599 | ||
6600 | @example | |
6601 | guix graph --type=reverse-package ocaml | |
6602 | @end example | |
6603 | ||
6604 | ... yields the graph of packages that depend on OCaml. | |
6605 | ||
6606 | Note that for core packages this can yield huge graphs. If all you want | |
6607 | is to know the number of packages that depend on a given package, use | |
6608 | @command{guix refresh --list-dependent} (@pxref{Invoking guix refresh, | |
6609 | @option{--list-dependent}}). | |
6610 | ||
88856916 LC |
6611 | @item bag-emerged |
6612 | This is the package DAG, @emph{including} implicit inputs. | |
6613 | ||
6614 | For instance, the following command: | |
6615 | ||
6616 | @example | |
6617 | guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf | |
6618 | @end example | |
6619 | ||
6620 | ... yields this bigger graph: | |
6621 | ||
6622 | @image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils} | |
6623 | ||
6624 | At the bottom of the graph, we see all the implicit inputs of | |
6625 | @var{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}}). | |
6626 | ||
f97c9175 | 6627 | Now, note that the dependencies of these implicit inputs---that is, the |
88856916 LC |
6628 | @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown |
6629 | here, for conciseness. | |
6630 | ||
6631 | @item bag | |
6632 | Similar to @code{bag-emerged}, but this time including all the bootstrap | |
6633 | dependencies. | |
6634 | ||
38b92daa LC |
6635 | @item bag-with-origins |
6636 | Similar to @code{bag}, but also showing origins and their dependencies. | |
6637 | ||
88856916 LC |
6638 | @item derivations |
6639 | This is the most detailed representation: It shows the DAG of | |
6640 | derivations (@pxref{Derivations}) and plain store items. Compared to | |
6641 | the above representation, many additional nodes are visible, including | |
f97c9175 | 6642 | build scripts, patches, Guile modules, etc. |
88856916 | 6643 | |
a773c314 LC |
6644 | For this type of graph, it is also possible to pass a @file{.drv} file |
6645 | name instead of a package name, as in: | |
6646 | ||
6647 | @example | |
6648 | guix graph -t derivation `guix system build -d my-config.scm` | |
6649 | @end example | |
88856916 LC |
6650 | @end table |
6651 | ||
f97c9175 | 6652 | All the types above correspond to @emph{build-time dependencies}. The |
88856916 LC |
6653 | following graph type represents the @emph{run-time dependencies}: |
6654 | ||
6655 | @table @code | |
6656 | @item references | |
6657 | This is the graph of @dfn{references} of a package output, as returned | |
6658 | by @command{guix gc --references} (@pxref{Invoking guix gc}). | |
6659 | ||
6660 | If the given package output is not available in the store, @command{guix | |
6661 | graph} attempts to obtain dependency information from substitutes. | |
a773c314 LC |
6662 | |
6663 | Here you can also pass a store file name instead of a package name. For | |
6664 | example, the command below produces the reference graph of your profile | |
6665 | (which can be big!): | |
6666 | ||
6667 | @example | |
6668 | guix graph -t references `readlink -f ~/.guix-profile` | |
6669 | @end example | |
7f8fec0f LC |
6670 | |
6671 | @item referrers | |
6672 | This is the graph of the @dfn{referrers} of a store item, as returned by | |
6673 | @command{guix gc --referrers} (@pxref{Invoking guix gc}). | |
6674 | ||
6675 | This relies exclusively on local information from your store. For | |
6676 | instance, let us suppose that the current Inkscape is available in 10 | |
6677 | profiles on your machine; @command{guix graph -t referrers inkscape} | |
6678 | will show a graph rooted at Inkscape and with those 10 profiles linked | |
6679 | to it. | |
6680 | ||
6681 | It can help determine what is preventing a store item from being garbage | |
6682 | collected. | |
6683 | ||
88856916 LC |
6684 | @end table |
6685 | ||
6686 | The available options are the following: | |
6687 | ||
6688 | @table @option | |
6689 | @item --type=@var{type} | |
6690 | @itemx -t @var{type} | |
6691 | Produce a graph output of @var{type}, where @var{type} must be one of | |
6692 | the values listed above. | |
6693 | ||
6694 | @item --list-types | |
6695 | List the supported graph types. | |
4c8f997a | 6696 | |
642339dc RW |
6697 | @item --backend=@var{backend} |
6698 | @itemx -b @var{backend} | |
6699 | Produce a graph using the selected @var{backend}. | |
6700 | ||
6701 | @item --list-backends | |
6702 | List the supported graph backends. | |
6703 | ||
9ea36197 LC |
6704 | Currently, the available backends are Graphviz and d3.js. |
6705 | ||
4c8f997a LC |
6706 | @item --expression=@var{expr} |
6707 | @itemx -e @var{expr} | |
6708 | Consider the package @var{expr} evaluates to. | |
6709 | ||
6710 | This is useful to precisely refer to a package, as in this example: | |
6711 | ||
6712 | @example | |
6713 | guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)' | |
6714 | @end example | |
88856916 LC |
6715 | @end table |
6716 | ||
6717 | ||
372c4bbc DT |
6718 | @node Invoking guix environment |
6719 | @section Invoking @command{guix environment} | |
6720 | ||
f5fd4fd2 | 6721 | @cindex reproducible build environments |
fe36d84e | 6722 | @cindex development environments |
e32171ee JD |
6723 | @cindex @command{guix environment} |
6724 | @cindex environment, package build environment | |
372c4bbc DT |
6725 | The purpose of @command{guix environment} is to assist hackers in |
6726 | creating reproducible development environments without polluting their | |
6727 | package profile. The @command{guix environment} tool takes one or more | |
f97c9175 | 6728 | packages, builds all of their inputs, and creates a shell |
372c4bbc DT |
6729 | environment to use them. |
6730 | ||
6731 | The general syntax is: | |
6732 | ||
6733 | @example | |
6734 | guix environment @var{options} @var{package}@dots{} | |
6735 | @end example | |
6736 | ||
fe36d84e LC |
6737 | The following example spawns a new shell set up for the development of |
6738 | GNU@tie{}Guile: | |
372c4bbc DT |
6739 | |
6740 | @example | |
6741 | guix environment guile | |
6742 | @end example | |
6743 | ||
f97c9175 AE |
6744 | If the needed dependencies are not built yet, @command{guix environment} |
6745 | automatically builds them. The environment of the new shell is an augmented | |
372c4bbc DT |
6746 | version of the environment that @command{guix environment} was run in. |
6747 | It contains the necessary search paths for building the given package | |
6748 | added to the existing environment variables. To create a ``pure'' | |
f97c9175 | 6749 | environment, in which the original environment variables have been unset, |
50500f7c LC |
6750 | use the @code{--pure} option@footnote{Users sometimes wrongfully augment |
6751 | environment variables such as @code{PATH} in their @file{~/.bashrc} | |
6752 | file. As a consequence, when @code{guix environment} launches it, Bash | |
6753 | may read @file{~/.bashrc}, thereby introducing ``impurities'' in these | |
6754 | environment variables. It is an error to define such environment | |
6755 | variables in @file{.bashrc}; instead, they should be defined in | |
6756 | @file{.bash_profile}, which is sourced only by log-in shells. | |
6757 | @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for | |
6758 | details on Bash start-up files.}. | |
372c4bbc | 6759 | |
28de8d25 LC |
6760 | @vindex GUIX_ENVIRONMENT |
6761 | @command{guix environment} defines the @code{GUIX_ENVIRONMENT} | |
20185522 LC |
6762 | variable in the shell it spawns; its value is the file name of the |
6763 | profile of this environment. This allows users to, say, define a | |
28de8d25 LC |
6764 | specific prompt for development environments in their @file{.bashrc} |
6765 | (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}): | |
6766 | ||
6767 | @example | |
6768 | if [ -n "$GUIX_ENVIRONMENT" ] | |
6769 | then | |
6770 | export PS1="\u@@\h \w [dev]\$ " | |
6771 | fi | |
6772 | @end example | |
6773 | ||
20185522 LC |
6774 | @noindent |
6775 | ... or to browse the profile: | |
6776 | ||
6777 | @example | |
6778 | $ ls "$GUIX_ENVIRONMENT/bin" | |
6779 | @end example | |
6780 | ||
372c4bbc DT |
6781 | Additionally, more than one package may be specified, in which case the |
6782 | union of the inputs for the given packages are used. For example, the | |
6783 | command below spawns a shell where all of the dependencies of both Guile | |
6784 | and Emacs are available: | |
6785 | ||
6786 | @example | |
6787 | guix environment guile emacs | |
6788 | @end example | |
6789 | ||
1de2fe95 DT |
6790 | Sometimes an interactive shell session is not desired. An arbitrary |
6791 | command may be invoked by placing the @code{--} token to separate the | |
6792 | command from the rest of the arguments: | |
372c4bbc DT |
6793 | |
6794 | @example | |
1de2fe95 | 6795 | guix environment guile -- make -j4 |
372c4bbc DT |
6796 | @end example |
6797 | ||
fe36d84e LC |
6798 | In other situations, it is more convenient to specify the list of |
6799 | packages needed in the environment. For example, the following command | |
6800 | runs @command{python} from an environment containing Python@tie{}2.7 and | |
6801 | NumPy: | |
6802 | ||
6803 | @example | |
1de2fe95 | 6804 | guix environment --ad-hoc python2-numpy python-2.7 -- python |
fe36d84e LC |
6805 | @end example |
6806 | ||
cc90fbbf DT |
6807 | Furthermore, one might want the dependencies of a package and also some |
6808 | additional packages that are not build-time or runtime dependencies, but | |
6809 | are useful when developing nonetheless. Because of this, the | |
6810 | @code{--ad-hoc} flag is positional. Packages appearing before | |
6811 | @code{--ad-hoc} are interpreted as packages whose dependencies will be | |
6812 | added to the environment. Packages appearing after are interpreted as | |
6813 | packages that will be added to the environment directly. For example, | |
6814 | the following command creates a Guix development environment that | |
6815 | additionally includes Git and strace: | |
6816 | ||
6817 | @example | |
6818 | guix environment guix --ad-hoc git strace | |
6819 | @end example | |
6820 | ||
f535dcbe DT |
6821 | Sometimes it is desirable to isolate the environment as much as |
6822 | possible, for maximal purity and reproducibility. In particular, when | |
6823 | using Guix on a host distro that is not GuixSD, it is desirable to | |
6824 | prevent access to @file{/usr/bin} and other system-wide resources from | |
6825 | the development environment. For example, the following command spawns | |
6826 | a Guile REPL in a ``container'' where only the store and the current | |
6827 | working directory are mounted: | |
6828 | ||
6829 | @example | |
6830 | guix environment --ad-hoc --container guile -- guile | |
6831 | @end example | |
6832 | ||
0f252e26 | 6833 | @quotation Note |
cfd35b4e | 6834 | The @code{--container} option requires Linux-libre 3.19 or newer. |
0f252e26 DT |
6835 | @end quotation |
6836 | ||
fe36d84e | 6837 | The available options are summarized below. |
372c4bbc DT |
6838 | |
6839 | @table @code | |
f943c317 LC |
6840 | @item --root=@var{file} |
6841 | @itemx -r @var{file} | |
6842 | @cindex persistent environment | |
6843 | @cindex garbage collector root, for environments | |
6844 | Make @var{file} a symlink to the profile for this environment, and | |
6845 | register it as a garbage collector root. | |
6846 | ||
6847 | This is useful if you want to protect your environment from garbage | |
6848 | collection, to make it ``persistent''. | |
6849 | ||
6850 | When this option is omitted, the environment is protected from garbage | |
6851 | collection only for the duration of the @command{guix environment} | |
6852 | session. This means that next time you recreate the same environment, | |
6853 | you could have to rebuild or re-download packages. | |
6854 | ||
372c4bbc DT |
6855 | @item --expression=@var{expr} |
6856 | @itemx -e @var{expr} | |
c9c282ce DT |
6857 | Create an environment for the package or list of packages that |
6858 | @var{expr} evaluates to. | |
372c4bbc | 6859 | |
fe36d84e LC |
6860 | For example, running: |
6861 | ||
6862 | @example | |
6863 | guix environment -e '(@@ (gnu packages maths) petsc-openmpi)' | |
6864 | @end example | |
6865 | ||
6866 | starts a shell with the environment for this specific variant of the | |
6867 | PETSc package. | |
6868 | ||
c9c282ce DT |
6869 | Running: |
6870 | ||
6871 | @example | |
5c2b2f00 | 6872 | guix environment --ad-hoc -e '(@@ (gnu) %base-packages)' |
c9c282ce DT |
6873 | @end example |
6874 | ||
6875 | starts a shell with all the GuixSD base packages available. | |
6876 | ||
fa445d64 | 6877 | The above commands only use the default output of the given packages. |
779aa003 DT |
6878 | To select other outputs, two element tuples can be specified: |
6879 | ||
6880 | @example | |
6881 | guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")' | |
6882 | @end example | |
6883 | ||
372c4bbc DT |
6884 | @item --load=@var{file} |
6885 | @itemx -l @var{file} | |
c9c282ce DT |
6886 | Create an environment for the package or list of packages that the code |
6887 | within @var{file} evaluates to. | |
372c4bbc | 6888 | |
fe36d84e LC |
6889 | As an example, @var{file} might contain a definition like this |
6890 | (@pxref{Defining Packages}): | |
6891 | ||
6892 | @example | |
6893 | @verbatiminclude environment-gdb.scm | |
6894 | @end example | |
6895 | ||
a54bd6d7 DT |
6896 | @item --ad-hoc |
6897 | Include all specified packages in the resulting environment, as if an | |
6898 | @i{ad hoc} package were defined with them as inputs. This option is | |
6899 | useful for quickly creating an environment without having to write a | |
6900 | package expression to contain the desired inputs. | |
6901 | ||
6902 | For instance, the command: | |
6903 | ||
6904 | @example | |
1de2fe95 | 6905 | guix environment --ad-hoc guile guile-sdl -- guile |
a54bd6d7 DT |
6906 | @end example |
6907 | ||
6908 | runs @command{guile} in an environment where Guile and Guile-SDL are | |
6909 | available. | |
6910 | ||
417c39f1 | 6911 | Note that this example implicitly asks for the default output of |
f97c9175 | 6912 | @code{guile} and @code{guile-sdl}, but it is possible to ask for a |
417c39f1 LC |
6913 | specific output---e.g., @code{glib:bin} asks for the @code{bin} output |
6914 | of @code{glib} (@pxref{Packages with Multiple Outputs}). | |
6915 | ||
cc90fbbf DT |
6916 | This option may be composed with the default behavior of @command{guix |
6917 | environment}. Packages appearing before @code{--ad-hoc} are interpreted | |
6918 | as packages whose dependencies will be added to the environment, the | |
6919 | default behavior. Packages appearing after are interpreted as packages | |
6920 | that will be added to the environment directly. | |
6921 | ||
372c4bbc DT |
6922 | @item --pure |
6923 | Unset existing environment variables when building the new environment. | |
6924 | This has the effect of creating an environment in which search paths | |
6925 | only contain package inputs. | |
6926 | ||
6927 | @item --search-paths | |
6928 | Display the environment variable definitions that make up the | |
6929 | environment. | |
ce367ef3 LC |
6930 | |
6931 | @item --system=@var{system} | |
6932 | @itemx -s @var{system} | |
6933 | Attempt to build for @var{system}---e.g., @code{i686-linux}. | |
f535dcbe DT |
6934 | |
6935 | @item --container | |
6936 | @itemx -C | |
6937 | @cindex container | |
6938 | Run @var{command} within an isolated container. The current working | |
a01ad638 DT |
6939 | directory outside the container is mapped inside the container. |
6940 | Additionally, a dummy home directory is created that matches the current | |
6941 | user's home directory, and @file{/etc/passwd} is configured accordingly. | |
6942 | The spawned process runs as the current user outside the container, but | |
6943 | has root privileges in the context of the container. | |
f535dcbe DT |
6944 | |
6945 | @item --network | |
6946 | @itemx -N | |
6947 | For containers, share the network namespace with the host system. | |
6948 | Containers created without this flag only have access to the loopback | |
6949 | device. | |
6950 | ||
6951 | @item --expose=@var{source}[=@var{target}] | |
6952 | For containers, expose the file system @var{source} from the host system | |
6953 | as the read-only file system @var{target} within the container. If | |
6954 | @var{target} is not specified, @var{source} is used as the target mount | |
6955 | point in the container. | |
6956 | ||
6957 | The example below spawns a Guile REPL in a container in which the user's | |
6958 | home directory is accessible read-only via the @file{/exchange} | |
6959 | directory: | |
6960 | ||
6961 | @example | |
da31b9c7 | 6962 | guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile |
f535dcbe DT |
6963 | @end example |
6964 | ||
5c2b2f00 | 6965 | @item --share=@var{source}[=@var{target}] |
f535dcbe DT |
6966 | For containers, share the file system @var{source} from the host system |
6967 | as the writable file system @var{target} within the container. If | |
6968 | @var{target} is not specified, @var{source} is used as the target mount | |
6969 | point in the container. | |
6970 | ||
6971 | The example below spawns a Guile REPL in a container in which the user's | |
6972 | home directory is accessible for both reading and writing via the | |
6973 | @file{/exchange} directory: | |
6974 | ||
6975 | @example | |
da31b9c7 | 6976 | guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile |
f535dcbe | 6977 | @end example |
372c4bbc DT |
6978 | @end table |
6979 | ||
fdcb04af HG |
6980 | @command{guix environment} |
6981 | also supports all of the common build options that @command{guix | |
ccd7158d | 6982 | build} supports (@pxref{Common Build Options}). |
372c4bbc | 6983 | |
fdcb04af | 6984 | |
aff8ce7c DT |
6985 | @node Invoking guix publish |
6986 | @section Invoking @command{guix publish} | |
6987 | ||
e32171ee | 6988 | @cindex @command{guix publish} |
aff8ce7c | 6989 | The purpose of @command{guix publish} is to enable users to easily share |
f97c9175 | 6990 | their store with others, who can then use it as a substitute server |
8ce229fc LC |
6991 | (@pxref{Substitutes}). |
6992 | ||
6993 | When @command{guix publish} runs, it spawns an HTTP server which allows | |
6994 | anyone with network access to obtain substitutes from it. This means | |
6995 | that any machine running Guix can also act as if it were a build farm, | |
6996 | since the HTTP interface is compatible with Hydra, the software behind | |
6997 | the @code{hydra.gnu.org} build farm. | |
aff8ce7c DT |
6998 | |
6999 | For security, each substitute is signed, allowing recipients to check | |
7000 | their authenticity and integrity (@pxref{Substitutes}). Because | |
f97c9175 | 7001 | @command{guix publish} uses the signing key of the system, which is only |
5463fe51 LC |
7002 | readable by the system administrator, it must be started as root; the |
7003 | @code{--user} option makes it drop root privileges early on. | |
aff8ce7c | 7004 | |
b18812b6 LC |
7005 | The signing key pair must be generated before @command{guix publish} is |
7006 | launched, using @command{guix archive --generate-key} (@pxref{Invoking | |
7007 | guix archive}). | |
7008 | ||
aff8ce7c DT |
7009 | The general syntax is: |
7010 | ||
7011 | @example | |
7012 | guix publish @var{options}@dots{} | |
7013 | @end example | |
7014 | ||
7015 | Running @command{guix publish} without any additional arguments will | |
7016 | spawn an HTTP server on port 8080: | |
7017 | ||
7018 | @example | |
7019 | guix publish | |
7020 | @end example | |
7021 | ||
7022 | Once a publishing server has been authorized (@pxref{Invoking guix | |
7023 | archive}), the daemon may download substitutes from it: | |
7024 | ||
7025 | @example | |
7026 | guix-daemon --substitute-urls=http://example.org:8080 | |
7027 | @end example | |
7028 | ||
00753f70 LC |
7029 | By default, @command{guix publish} compresses archives on the fly as it |
7030 | serves them. This ``on-the-fly'' mode is convenient in that it requires | |
7031 | no setup and is immediately available. However, when serving lots of | |
7032 | clients, we recommend using the @option{--cache} option, which enables | |
7033 | caching of the archives before they are sent to clients---see below for | |
585347d7 LC |
7034 | details. The @command{guix weather} command provides a handy way to |
7035 | check what a server provides (@pxref{Invoking guix weather}). | |
00753f70 | 7036 | |
ff6638d1 LC |
7037 | As a bonus, @command{guix publish} also serves as a content-addressed |
7038 | mirror for source files referenced in @code{origin} records | |
7039 | (@pxref{origin Reference}). For instance, assuming @command{guix | |
7040 | publish} is running on @code{example.org}, the following URL returns the | |
7041 | raw @file{hello-2.10.tar.gz} file with the given SHA256 hash | |
7042 | (represented in @code{nix-base32} format, @pxref{Invoking guix hash}): | |
7043 | ||
7044 | @example | |
7045 | http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i | |
7046 | @end example | |
7047 | ||
7048 | Obviously, these URLs only work for files that are in the store; in | |
7049 | other cases, they return 404 (``Not Found''). | |
7050 | ||
aff8ce7c DT |
7051 | The following options are available: |
7052 | ||
7053 | @table @code | |
7054 | @item --port=@var{port} | |
7055 | @itemx -p @var{port} | |
7056 | Listen for HTTP requests on @var{port}. | |
7057 | ||
9e2292ef LC |
7058 | @item --listen=@var{host} |
7059 | Listen on the network interface for @var{host}. The default is to | |
7060 | accept connections from any interface. | |
7061 | ||
5463fe51 LC |
7062 | @item --user=@var{user} |
7063 | @itemx -u @var{user} | |
7064 | Change privileges to @var{user} as soon as possible---i.e., once the | |
7065 | server socket is open and the signing key has been read. | |
7066 | ||
4a1fc562 LC |
7067 | @item --compression[=@var{level}] |
7068 | @itemx -C [@var{level}] | |
7069 | Compress data using the given @var{level}. When @var{level} is zero, | |
7070 | disable compression. The range 1 to 9 corresponds to different gzip | |
7071 | compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). | |
7072 | The default is 3. | |
7073 | ||
00753f70 LC |
7074 | Unless @option{--cache} is used, compression occurs on the fly and |
7075 | the compressed streams are not | |
4a1fc562 | 7076 | cached. Thus, to reduce load on the machine that runs @command{guix |
00753f70 LC |
7077 | publish}, it may be a good idea to choose a low compression level, to |
7078 | run @command{guix publish} behind a caching proxy, or to use | |
7079 | @option{--cache}. Using @option{--cache} has the advantage that it | |
7080 | allows @command{guix publish} to add @code{Content-Length} HTTP header | |
7081 | to its responses. | |
7082 | ||
7083 | @item --cache=@var{directory} | |
7084 | @itemx -c @var{directory} | |
7085 | Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} | |
7086 | and only serve archives that are in cache. | |
7087 | ||
7088 | When this option is omitted, archives and meta-data are created | |
7089 | on-the-fly. This can reduce the available bandwidth, especially when | |
7090 | compression is enabled, since this may become CPU-bound. Another | |
7091 | drawback of the default mode is that the length of archives is not known | |
7092 | in advance, so @command{guix publish} does not add a | |
7093 | @code{Content-Length} HTTP header to its responses, which in turn | |
7094 | prevents clients from knowing the amount of data being downloaded. | |
7095 | ||
7096 | Conversely, when @option{--cache} is used, the first request for a store | |
7097 | item (@i{via} a @code{.narinfo} URL) returns 404 and triggers a | |
7098 | background process to @dfn{bake} the archive---computing its | |
7099 | @code{.narinfo} and compressing the archive, if needed. Once the | |
7100 | archive is cached in @var{directory}, subsequent requests succeed and | |
7101 | are served directly from the cache, which guarantees that clients get | |
7102 | the best possible bandwidth. | |
7103 | ||
7104 | The ``baking'' process is performed by worker threads. By default, one | |
7105 | thread per CPU core is created, but this can be customized. See | |
7106 | @option{--workers} below. | |
7107 | ||
d72b4206 LC |
7108 | When @option{--ttl} is used, cached entries are automatically deleted |
7109 | when they have expired. | |
7110 | ||
00753f70 LC |
7111 | @item --workers=@var{N} |
7112 | When @option{--cache} is used, request the allocation of @var{N} worker | |
7113 | threads to ``bake'' archives. | |
4a1fc562 | 7114 | |
e4c7a5f7 LC |
7115 | @item --ttl=@var{ttl} |
7116 | Produce @code{Cache-Control} HTTP headers that advertise a time-to-live | |
7117 | (TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 | |
7118 | days, @code{1m} means 1 month, and so on. | |
7119 | ||
7120 | This allows the user's Guix to keep substitute information in cache for | |
7121 | @var{ttl}. However, note that @code{guix publish} does not itself | |
7122 | guarantee that the store items it provides will indeed remain available | |
7123 | for as long as @var{ttl}. | |
7124 | ||
d72b4206 | 7125 | Additionally, when @option{--cache} is used, cached entries that have |
c95644f0 LC |
7126 | not been accessed for @var{ttl} and that no longer have a corresponding |
7127 | item in the store, may be deleted. | |
d72b4206 | 7128 | |
4bb5e0ae LC |
7129 | @item --nar-path=@var{path} |
7130 | Use @var{path} as the prefix for the URLs of ``nar'' files | |
7131 | (@pxref{Invoking guix archive, normalized archives}). | |
7132 | ||
7133 | By default, nars are served at a URL such as | |
7134 | @code{/nar/gzip/@dots{}-coreutils-8.25}. This option allows you to | |
7135 | change the @code{/nar} part to @var{path}. | |
7136 | ||
46f58390 LC |
7137 | @item --public-key=@var{file} |
7138 | @itemx --private-key=@var{file} | |
7139 | Use the specific @var{file}s as the public/private key pair used to sign | |
7140 | the store items being published. | |
7141 | ||
7142 | The files must correspond to the same key pair (the private key is used | |
7143 | for signing and the public key is merely advertised in the signature | |
7144 | metadata). They must contain keys in the canonical s-expression format | |
7145 | as produced by @command{guix archive --generate-key} (@pxref{Invoking | |
7146 | guix archive}). By default, @file{/etc/guix/signing-key.pub} and | |
7147 | @file{/etc/guix/signing-key.sec} are used. | |
7148 | ||
aff8ce7c DT |
7149 | @item --repl[=@var{port}] |
7150 | @itemx -r [@var{port}] | |
7151 | Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile | |
8ce229fc LC |
7152 | Reference Manual}) on @var{port} (37146 by default). This is used |
7153 | primarily for debugging a running @command{guix publish} server. | |
aff8ce7c DT |
7154 | @end table |
7155 | ||
1c52181f | 7156 | Enabling @command{guix publish} on a GuixSD system is a one-liner: just |
f1e900a3 LC |
7157 | instantiate a @code{guix-publish-service-type} service in the @code{services} field |
7158 | of the @code{operating-system} declaration (@pxref{guix-publish-service-type, | |
7159 | @code{guix-publish-service-type}}). | |
1c52181f | 7160 | |
332d7903 HG |
7161 | If you are instead running Guix on a ``foreign distro'', follow these |
7162 | instructions:” | |
7163 | ||
7164 | @itemize | |
7165 | @item | |
7166 | If your host distro uses the systemd init system: | |
7167 | ||
7168 | @example | |
7169 | # ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \ | |
7170 | /etc/systemd/system/ | |
7171 | # systemctl start guix-publish && systemctl enable guix-publish | |
7172 | @end example | |
7173 | ||
7174 | @item | |
7175 | If your host distro uses the Upstart init system: | |
7176 | ||
7177 | @example | |
7178 | # ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/ | |
7179 | # start guix-publish | |
7180 | @end example | |
7181 | ||
7182 | @item | |
7183 | Otherwise, proceed similarly with your distro's init system. | |
7184 | @end itemize | |
d23c20f1 LC |
7185 | |
7186 | @node Invoking guix challenge | |
7187 | @section Invoking @command{guix challenge} | |
7188 | ||
7189 | @cindex reproducible builds | |
7190 | @cindex verifiable builds | |
e32171ee JD |
7191 | @cindex @command{guix challenge} |
7192 | @cindex challenge | |
d23c20f1 | 7193 | Do the binaries provided by this server really correspond to the source |
f97c9175 | 7194 | code it claims to build? Is a package build process deterministic? |
d23c20f1 LC |
7195 | These are the questions the @command{guix challenge} command attempts to |
7196 | answer. | |
7197 | ||
7198 | The former is obviously an important question: Before using a substitute | |
f97c9175 | 7199 | server (@pxref{Substitutes}), one had better @emph{verify} that it |
d23c20f1 LC |
7200 | provides the right binaries, and thus @emph{challenge} it. The latter |
7201 | is what enables the former: If package builds are deterministic, then | |
7202 | independent builds of the package should yield the exact same result, | |
7203 | bit for bit; if a server provides a binary different from the one | |
7204 | obtained locally, it may be either corrupt or malicious. | |
7205 | ||
7206 | We know that the hash that shows up in @file{/gnu/store} file names is | |
7207 | the hash of all the inputs of the process that built the file or | |
7208 | directory---compilers, libraries, build scripts, | |
7209 | etc. (@pxref{Introduction}). Assuming deterministic build processes, | |
7210 | one store file name should map to exactly one build output. | |
7211 | @command{guix challenge} checks whether there is, indeed, a single | |
7212 | mapping by comparing the build outputs of several independent builds of | |
7213 | any given store item. | |
7214 | ||
f97c9175 | 7215 | The command output looks like this: |
d23c20f1 LC |
7216 | |
7217 | @smallexample | |
ddbc7f7d LC |
7218 | $ guix challenge --substitute-urls="https://hydra.gnu.org https://guix.example.org" |
7219 | updating list of substitutes from 'https://hydra.gnu.org'... 100.0% | |
7220 | updating list of substitutes from 'https://guix.example.org'... 100.0% | |
d23c20f1 LC |
7221 | /gnu/store/@dots{}-openssl-1.0.2d contents differ: |
7222 | local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q | |
ddbc7f7d LC |
7223 | https://hydra.gnu.org/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q |
7224 | https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim | |
d23c20f1 LC |
7225 | /gnu/store/@dots{}-git-2.5.0 contents differ: |
7226 | local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha | |
ddbc7f7d LC |
7227 | https://hydra.gnu.org/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f |
7228 | https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73 | |
d23c20f1 LC |
7229 | /gnu/store/@dots{}-pius-2.1.1 contents differ: |
7230 | local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax | |
ddbc7f7d LC |
7231 | https://hydra.gnu.org/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax |
7232 | https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs | |
d23c20f1 LC |
7233 | @end smallexample |
7234 | ||
7235 | @noindent | |
7236 | In this example, @command{guix challenge} first scans the store to | |
7237 | determine the set of locally-built derivations---as opposed to store | |
7238 | items that were downloaded from a substitute server---and then queries | |
7239 | all the substitute servers. It then reports those store items for which | |
7240 | the servers obtained a result different from the local build. | |
7241 | ||
7242 | @cindex non-determinism, in package builds | |
7243 | As an example, @code{guix.example.org} always gets a different answer. | |
7244 | Conversely, @code{hydra.gnu.org} agrees with local builds, except in the | |
7245 | case of Git. This might indicate that the build process of Git is | |
7246 | non-deterministic, meaning that its output varies as a function of | |
7247 | various things that Guix does not fully control, in spite of building | |
7248 | packages in isolated environments (@pxref{Features}). Most common | |
7249 | sources of non-determinism include the addition of timestamps in build | |
7250 | results, the inclusion of random numbers, and directory listings sorted | |
a70a5004 | 7251 | by inode number. See @uref{https://reproducible-builds.org/docs/}, for |
d23c20f1 LC |
7252 | more information. |
7253 | ||
f97c9175 | 7254 | To find out what is wrong with this Git binary, we can do something along |
d23c20f1 LC |
7255 | these lines (@pxref{Invoking guix archive}): |
7256 | ||
7257 | @example | |
ddbc7f7d | 7258 | $ wget -q -O - https://hydra.gnu.org/nar/@dots{}-git-2.5.0 \ |
d23c20f1 | 7259 | | guix archive -x /tmp/git |
043f4698 | 7260 | $ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git |
d23c20f1 LC |
7261 | @end example |
7262 | ||
7263 | This command shows the difference between the files resulting from the | |
7264 | local build, and the files resulting from the build on | |
7265 | @code{hydra.gnu.org} (@pxref{Overview, Comparing and Merging Files,, | |
7266 | diffutils, Comparing and Merging Files}). The @command{diff} command | |
7267 | works great for text files. When binary files differ, a better option | |
ddbc7f7d | 7268 | is @uref{https://diffoscope.org/, Diffoscope}, a tool that helps |
d23c20f1 LC |
7269 | visualize differences for all kinds of files. |
7270 | ||
f97c9175 | 7271 | Once you have done that work, you can tell whether the differences are due |
d23c20f1 LC |
7272 | to a non-deterministic build process or to a malicious server. We try |
7273 | hard to remove sources of non-determinism in packages to make it easier | |
f97c9175 AE |
7274 | to verify substitutes, but of course, this is a process that |
7275 | involves not just Guix, but a large part of the free software community. | |
d23c20f1 LC |
7276 | In the meantime, @command{guix challenge} is one tool to help address |
7277 | the problem. | |
7278 | ||
7279 | If you are writing packages for Guix, you are encouraged to check | |
7280 | whether @code{hydra.gnu.org} and other substitute servers obtain the | |
7281 | same build result as you did with: | |
7282 | ||
7283 | @example | |
7284 | $ guix challenge @var{package} | |
7285 | @end example | |
7286 | ||
7287 | @noindent | |
f97c9175 | 7288 | where @var{package} is a package specification such as |
7cffaeb6 | 7289 | @code{guile@@2.0} or @code{glibc:debug}. |
d23c20f1 LC |
7290 | |
7291 | The general syntax is: | |
7292 | ||
7293 | @example | |
7294 | guix challenge @var{options} [@var{packages}@dots{}] | |
7295 | @end example | |
7296 | ||
7cffaeb6 LC |
7297 | When a difference is found between the hash of a locally-built item and |
7298 | that of a server-provided substitute, or among substitutes provided by | |
7299 | different servers, the command displays it as in the example above and | |
a17417a8 LC |
7300 | its exit code is 2 (other non-zero exit codes denote other kinds of |
7301 | errors.) | |
7cffaeb6 | 7302 | |
d23c20f1 LC |
7303 | The one option that matters is: |
7304 | ||
7305 | @table @code | |
7306 | ||
7307 | @item --substitute-urls=@var{urls} | |
7308 | Consider @var{urls} the whitespace-separated list of substitute source | |
7309 | URLs to compare to. | |
7310 | ||
153b6295 LC |
7311 | @item --verbose |
7312 | @itemx -v | |
7313 | Show details about matches (identical contents) in addition to | |
7314 | information about mismatches. | |
7315 | ||
d23c20f1 LC |
7316 | @end table |
7317 | ||
f11c444d LC |
7318 | @node Invoking guix copy |
7319 | @section Invoking @command{guix copy} | |
7320 | ||
7321 | @cindex copy, of store items, over SSH | |
7322 | @cindex SSH, copy of store items | |
7323 | @cindex sharing store items across machines | |
7324 | @cindex transferring store items across machines | |
7325 | The @command{guix copy} command copies items from the store of one | |
7326 | machine to that of another machine over a secure shell (SSH) | |
7327 | connection@footnote{This command is available only when Guile-SSH was | |
7328 | found. @xref{Requirements}, for details.}. For example, the following | |
7329 | command copies the @code{coreutils} package, the user's profile, and all | |
7330 | their dependencies over to @var{host}, logged in as @var{user}: | |
7331 | ||
7332 | @example | |
7333 | guix copy --to=@var{user}@@@var{host} \ | |
7334 | coreutils `readlink -f ~/.guix-profile` | |
7335 | @end example | |
7336 | ||
7337 | If some of the items to be copied are already present on @var{host}, | |
7338 | they are not actually sent. | |
7339 | ||
7340 | The command below retrieves @code{libreoffice} and @code{gimp} from | |
7341 | @var{host}, assuming they are available there: | |
7342 | ||
7343 | @example | |
7344 | guix copy --from=@var{host} libreoffice gimp | |
7345 | @end example | |
7346 | ||
7347 | The SSH connection is established using the Guile-SSH client, which is | |
7348 | compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and | |
7349 | @file{~/.ssh/config}, and uses the SSH agent for authentication. | |
7350 | ||
7351 | The key used to sign items that are sent must be accepted by the remote | |
7352 | machine. Likewise, the key used by the remote machine to sign items you | |
7353 | are retrieving must be in @file{/etc/guix/acl} so it is accepted by your | |
7354 | own daemon. @xref{Invoking guix archive}, for more information about | |
7355 | store item authentication. | |
7356 | ||
7357 | The general syntax is: | |
7358 | ||
7359 | @example | |
7360 | guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{} | |
7361 | @end example | |
7362 | ||
7363 | You must always specify one of the following options: | |
7364 | ||
7365 | @table @code | |
7366 | @item --to=@var{spec} | |
7367 | @itemx --from=@var{spec} | |
7368 | Specify the host to send to or receive from. @var{spec} must be an SSH | |
7369 | spec such as @code{example.org}, @code{charlie@@example.org}, or | |
7370 | @code{charlie@@example.org:2222}. | |
7371 | @end table | |
7372 | ||
7373 | The @var{items} can be either package names, such as @code{gimp}, or | |
7374 | store items, such as @file{/gnu/store/@dots{}-idutils-4.6}. | |
7375 | ||
7376 | When specifying the name of a package to send, it is first built if | |
7377 | needed, unless @option{--dry-run} was specified. Common build options | |
7378 | are supported (@pxref{Common Build Options}). | |
7379 | ||
d23c20f1 | 7380 | |
32efa254 DT |
7381 | @node Invoking guix container |
7382 | @section Invoking @command{guix container} | |
7383 | @cindex container | |
e32171ee | 7384 | @cindex @command{guix container} |
32efa254 DT |
7385 | @quotation Note |
7386 | As of version @value{VERSION}, this tool is experimental. The interface | |
7387 | is subject to radical change in the future. | |
7388 | @end quotation | |
7389 | ||
7390 | The purpose of @command{guix container} is to manipulate processes | |
7391 | running within an isolated environment, commonly known as a | |
46c36586 | 7392 | ``container'', typically created by the @command{guix environment} |
32efa254 DT |
7393 | (@pxref{Invoking guix environment}) and @command{guix system container} |
7394 | (@pxref{Invoking guix system}) commands. | |
7395 | ||
7396 | The general syntax is: | |
7397 | ||
7398 | @example | |
7399 | guix container @var{action} @var{options}@dots{} | |
7400 | @end example | |
7401 | ||
7402 | @var{action} specifies the operation to perform with a container, and | |
7403 | @var{options} specifies the context-specific arguments for the action. | |
7404 | ||
7405 | The following actions are available: | |
7406 | ||
7407 | @table @code | |
7408 | @item exec | |
7409 | Execute a command within the context of a running container. | |
7410 | ||
7411 | The syntax is: | |
7412 | ||
7413 | @example | |
7414 | guix container exec @var{pid} @var{program} @var{arguments}@dots{} | |
7415 | @end example | |
7416 | ||
7417 | @var{pid} specifies the process ID of the running container. | |
f97c9175 AE |
7418 | @var{program} specifies an executable file name within the root file |
7419 | system of the container. @var{arguments} are the additional options that | |
7420 | will be passed to @var{program}. | |
32efa254 DT |
7421 | |
7422 | The following command launches an interactive login shell inside a | |
7423 | GuixSD container, started by @command{guix system container}, and whose | |
7424 | process ID is 9001: | |
7425 | ||
7426 | @example | |
7427 | guix container exec 9001 /run/current-system/profile/bin/bash --login | |
7428 | @end example | |
7429 | ||
7430 | Note that the @var{pid} cannot be the parent process of a container. It | |
f97c9175 | 7431 | must be PID 1 of the container or one of its child processes. |
32efa254 DT |
7432 | |
7433 | @end table | |
7434 | ||
585347d7 LC |
7435 | @node Invoking guix weather |
7436 | @section Invoking @command{guix weather} | |
7437 | ||
7438 | Occasionally you're grumpy because substitutes are lacking and you end | |
7439 | up building packages by yourself (@pxref{Substitutes}). The | |
7440 | @command{guix weather} command reports on substitute availability on the | |
7441 | specified servers so you can have an idea of whether you'll be grumpy | |
7442 | today. It can sometimes be useful info as a user, but it is primarily | |
7443 | useful to people running @command{guix publish} (@pxref{Invoking guix | |
7444 | publish}). | |
7445 | ||
7446 | @cindex statistics, for substitutes | |
7447 | @cindex availability of substitutes | |
7448 | @cindex substitute availability | |
7449 | @cindex weather, substitute availability | |
7450 | Here's a sample run: | |
7451 | ||
7452 | @example | |
7453 | $ guix weather --substitute-urls=https://guix.example.org | |
7454 | computing 5,872 package derivations for x86_64-linux... | |
7455 | looking for 6,128 store items on https://guix.example.org.. | |
7456 | updating list of substitutes from 'https://guix.example.org'... 100.0% | |
7457 | https://guix.example.org | |
7458 | 43.4% substitutes available (2,658 out of 6,128) | |
7459 | 7,032.5 MiB of nars (compressed) | |
7460 | 19,824.2 MiB on disk (uncompressed) | |
7461 | 0.030 seconds per request (182.9 seconds in total) | |
7462 | 33.5 requests per second | |
7463 | @end example | |
7464 | ||
7465 | As you can see, it reports the fraction of all the packages for which | |
7466 | substitutes are available on the server---regardless of whether | |
7467 | substitutes are enabled, and regardless of whether this server's signing | |
7468 | key is authorized. It also reports the size of the compressed archives | |
7469 | (``nars'') provided by the server, the size the corresponding store | |
7470 | items occupy in the store (assuming deduplication is turned off), and | |
7471 | the server's throughput. | |
7472 | ||
7473 | To achieve that, @command{guix weather} queries over HTTP(S) meta-data | |
7474 | (@dfn{narinfos}) for all the relevant store items. Like @command{guix | |
7475 | challenge}, it ignores signatures on those substitutes, which is | |
7476 | innocuous since the command only gathers statistics and cannot install | |
7477 | those substitutes. | |
7478 | ||
7479 | Among other things, it is possible to query specific system types and | |
7480 | specific package sets. The available options are listed below. | |
7481 | ||
7482 | @table @code | |
7483 | @item --substitute-urls=@var{urls} | |
7484 | @var{urls} is the space-separated list of substitute server URLs to | |
7485 | query. When this option is omitted, the default set of substitute | |
7486 | servers is queried. | |
7487 | ||
7488 | @item --system=@var{system} | |
7489 | @itemx -s @var{system} | |
7490 | Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This | |
7491 | option can be repeated, in which case @command{guix weather} will query | |
7492 | substitutes for several system types. | |
7493 | ||
7494 | @item --manifest=@var{file} | |
7495 | Instead of querying substitutes for all the packages, only ask for those | |
7496 | specified in @var{file}. @var{file} must contain a @dfn{manifest}, as | |
7497 | with the @code{-m} option of @command{guix package} (@pxref{Invoking | |
7498 | guix package}). | |
7499 | @end table | |
7500 | ||
7501 | ||
a1ba8475 LC |
7502 | @c ********************************************************************* |
7503 | @node GNU Distribution | |
7504 | @chapter GNU Distribution | |
7505 | ||
3ca2731c | 7506 | @cindex Guix System Distribution |
4705641f | 7507 | @cindex GuixSD |
3ca2731c LC |
7508 | Guix comes with a distribution of the GNU system consisting entirely of |
7509 | free software@footnote{The term ``free'' here refers to the | |
a1ba8475 | 7510 | @url{http://www.gnu.org/philosophy/free-sw.html,freedom provided to |
3ca2731c | 7511 | users of that software}.}. The |
35ed9306 LC |
7512 | distribution can be installed on its own (@pxref{System Installation}), |
7513 | but it is also possible to install Guix as a package manager on top of | |
7514 | an installed GNU/Linux system (@pxref{Installation}). To distinguish | |
3ca2731c | 7515 | between the two, we refer to the standalone distribution as the Guix |
4705641f | 7516 | System Distribution, or GuixSD. |
35ed9306 LC |
7517 | |
7518 | The distribution provides core GNU packages such as GNU libc, GCC, and | |
7519 | Binutils, as well as many GNU and non-GNU applications. The complete | |
7520 | list of available packages can be browsed | |
093ae1be | 7521 | @url{http://www.gnu.org/software/guix/packages,on-line} or by |
d03bb653 | 7522 | running @command{guix package} (@pxref{Invoking guix package}): |
a1ba8475 LC |
7523 | |
7524 | @example | |
e49951eb | 7525 | guix package --list-available |
a1ba8475 LC |
7526 | @end example |
7527 | ||
f97c9175 | 7528 | Our goal is to provide a practical 100% free software distribution of |
401c53c4 LC |
7529 | Linux-based and other variants of GNU, with a focus on the promotion and |
7530 | tight integration of GNU components, and an emphasis on programs and | |
7531 | tools that help users exert that freedom. | |
7532 | ||
3ca2731c | 7533 | Packages are currently available on the following platforms: |
c320011d LC |
7534 | |
7535 | @table @code | |
7536 | ||
7537 | @item x86_64-linux | |
7538 | Intel/AMD @code{x86_64} architecture, Linux-Libre kernel; | |
7539 | ||
7540 | @item i686-linux | |
7541 | Intel 32-bit architecture (IA32), Linux-Libre kernel; | |
7542 | ||
aa1e1947 | 7543 | @item armhf-linux |
aa725117 | 7544 | ARMv7-A architecture with hard float, Thumb-2 and NEON, |
f97c9175 AE |
7545 | using the EABI hard-float application binary interface (ABI), |
7546 | and Linux-Libre kernel. | |
aa1e1947 | 7547 | |
3b88f376 EF |
7548 | @item aarch64-linux |
7549 | little-endian 64-bit ARMv8-A processors, Linux-Libre kernel. This is | |
be2ba697 | 7550 | currently in an experimental stage, with limited support. |
3b88f376 EF |
7551 | @xref{Contributing}, for how to help! |
7552 | ||
c320011d LC |
7553 | @item mips64el-linux |
7554 | little-endian 64-bit MIPS processors, specifically the Loongson series, | |
f97c9175 | 7555 | n32 ABI, and Linux-Libre kernel. |
c320011d LC |
7556 | |
7557 | @end table | |
7558 | ||
4705641f | 7559 | GuixSD itself is currently only available on @code{i686} and @code{x86_64}. |
3ca2731c | 7560 | |
c320011d LC |
7561 | @noindent |
7562 | For information on porting to other architectures or kernels, | |
f97c9175 | 7563 | @pxref{Porting}. |
c320011d | 7564 | |
401c53c4 | 7565 | @menu |
5af6de3e | 7566 | * System Installation:: Installing the whole operating system. |
35ed9306 | 7567 | * System Configuration:: Configuring the operating system. |
31f1f593 | 7568 | * Documentation:: Browsing software user manuals. |
91ef73d4 | 7569 | * Installing Debugging Files:: Feeding the debugger. |
05962f29 | 7570 | * Security Updates:: Deploying security fixes quickly. |
401c53c4 | 7571 | * Package Modules:: Packages from the programmer's viewpoint. |
da7cabd4 | 7572 | * Packaging Guidelines:: Growing the distribution. |
401c53c4 | 7573 | * Bootstrapping:: GNU/Linux built from scratch. |
8b315a6d | 7574 | * Porting:: Targeting another platform or kernel. |
401c53c4 LC |
7575 | @end menu |
7576 | ||
7577 | Building this distribution is a cooperative effort, and you are invited | |
081145cf | 7578 | to join! @xref{Contributing}, for information about how you can help. |
401c53c4 | 7579 | |
5af6de3e LC |
7580 | @node System Installation |
7581 | @section System Installation | |
7582 | ||
e32171ee | 7583 | @cindex installing GuixSD |
3ca2731c | 7584 | @cindex Guix System Distribution |
c8b54374 | 7585 | This section explains how to install the Guix System Distribution (GuixSD) |
3ca2731c | 7586 | on a machine. The Guix package manager can |
35ed9306 LC |
7587 | also be installed on top of a running GNU/Linux system, |
7588 | @pxref{Installation}. | |
5af6de3e LC |
7589 | |
7590 | @ifinfo | |
9c18cf9b | 7591 | @quotation Note |
5af6de3e LC |
7592 | @c This paragraph is for people reading this from tty2 of the |
7593 | @c installation image. | |
1068f26b | 7594 | You are reading this documentation with an Info reader. For details on |
5af6de3e | 7595 | how to use it, hit the @key{RET} key (``return'' or ``enter'') on the |
de341e7c LC |
7596 | link that follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU |
7597 | Info}. Hit @kbd{l} afterwards to come back here. | |
9c18cf9b LC |
7598 | |
7599 | Alternately, run @command{info info} in another tty to keep the manual | |
7600 | available. | |
7601 | @end quotation | |
5af6de3e LC |
7602 | @end ifinfo |
7603 | ||
dedb8d5e | 7604 | @menu |
e3009f60 LC |
7605 | * Limitations:: What you can expect. |
7606 | * Hardware Considerations:: Supported hardware. | |
7607 | * USB Stick Installation:: Preparing the installation medium. | |
d79013f6 | 7608 | * DVD Installation:: Preparing the installation medium. |
e3009f60 LC |
7609 | * Preparing for Installation:: Networking, partitioning, etc. |
7610 | * Proceeding with the Installation:: The real thing. | |
c8b54374 | 7611 | * Installing GuixSD in a VM:: GuixSD playground. |
e3009f60 | 7612 | * Building the Installation Image:: How this comes to be. |
dedb8d5e LC |
7613 | @end menu |
7614 | ||
7615 | @node Limitations | |
8aaaae38 LC |
7616 | @subsection Limitations |
7617 | ||
4705641f | 7618 | As of version @value{VERSION}, the Guix System Distribution (GuixSD) is |
3ca2731c | 7619 | not production-ready. It may contain bugs and lack important |
8aaaae38 LC |
7620 | features. Thus, if you are looking for a stable production system that |
7621 | respects your freedom as a computer user, a good solution at this point | |
7622 | is to consider @url{http://www.gnu.org/distros/free-distros.html, one of | |
f97c9175 | 7623 | the more established GNU/Linux distributions}. We hope you can soon switch |
4705641f | 7624 | to the GuixSD without fear, of course. In the meantime, you can |
8aaaae38 LC |
7625 | also keep using your distribution and try out the package manager on top |
7626 | of it (@pxref{Installation}). | |
7627 | ||
7628 | Before you proceed with the installation, be aware of the following | |
7629 | noteworthy limitations applicable to version @value{VERSION}: | |
7630 | ||
7631 | @itemize | |
7632 | @item | |
7633 | The installation process does not include a graphical user interface and | |
7634 | requires familiarity with GNU/Linux (see the following subsections to | |
7635 | get a feel of what that means.) | |
7636 | ||
8aaaae38 | 7637 | @item |
dbcb0ab1 | 7638 | Support for the Logical Volume Manager (LVM) is missing. |
8aaaae38 LC |
7639 | |
7640 | @item | |
0be9b4a9 LC |
7641 | More and more system services are provided (@pxref{Services}), but some |
7642 | may be missing. | |
8aaaae38 LC |
7643 | |
7644 | @item | |
0be9b4a9 | 7645 | More than 5,300 packages are available, but you may |
8aaaae38 | 7646 | occasionally find that a useful package is missing. |
5fe01c2d LC |
7647 | |
7648 | @item | |
0be9b4a9 | 7649 | GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop Services}), |
5fe01c2d LC |
7650 | as well as a number of X11 window managers. However, some graphical |
7651 | applications may be missing, as well as KDE. | |
8aaaae38 LC |
7652 | @end itemize |
7653 | ||
f97c9175 AE |
7654 | You have been warned! But more than a disclaimer, this is an invitation |
7655 | to report issues (and success stories!), and to join us in improving it. | |
8aaaae38 | 7656 | @xref{Contributing}, for more info. |
5af6de3e | 7657 | |
e3009f60 LC |
7658 | |
7659 | @node Hardware Considerations | |
7660 | @subsection Hardware Considerations | |
7661 | ||
7662 | @cindex hardware support on GuixSD | |
7663 | GNU@tie{}GuixSD focuses on respecting the user's computing freedom. It | |
7664 | builds around the kernel Linux-libre, which means that only hardware for | |
e0b3f97e | 7665 | which free software drivers and firmware exist is supported. Nowadays, |
e3009f60 LC |
7666 | a wide range of off-the-shelf hardware is supported on |
7667 | GNU/Linux-libre---from keyboards to graphics cards to scanners and | |
7668 | Ethernet controllers. Unfortunately, there are still areas where | |
7669 | hardware vendors deny users control over their own computing, and such | |
7670 | hardware is not supported on GuixSD. | |
7671 | ||
7672 | @cindex WiFi, hardware support | |
e0b3f97e | 7673 | One of the main areas where free drivers or firmware are lacking is WiFi |
e3009f60 LC |
7674 | devices. WiFi devices known to work include those using Atheros chips |
7675 | (AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre | |
52db41af EB |
7676 | driver, and those using Broadcom/AirForce chips (BCM43xx with |
7677 | Wireless-Core Revision 5), which corresponds to the @code{b43-open} | |
7678 | Linux-libre driver. Free firmware exists for both and is available | |
e3009f60 LC |
7679 | out-of-the-box on GuixSD, as part of @var{%base-firmware} |
7680 | (@pxref{operating-system Reference, @code{firmware}}). | |
7681 | ||
7682 | @cindex RYF, Respects Your Freedom | |
7683 | The @uref{https://www.fsf.org/, Free Software Foundation} runs | |
e0b3f97e | 7684 | @uref{https://www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a |
e3009f60 LC |
7685 | certification program for hardware products that respect your freedom |
7686 | and your privacy and ensure that you have control over your device. We | |
e0b3f97e | 7687 | encourage you to check the list of RYF-certified devices. |
e3009f60 LC |
7688 | |
7689 | Another useful resource is the @uref{https://www.h-node.org/, H-Node} | |
7690 | web site. It contains a catalog of hardware devices with information | |
7691 | about their support in GNU/Linux. | |
7692 | ||
7693 | ||
dedb8d5e | 7694 | @node USB Stick Installation |
5af6de3e LC |
7695 | @subsection USB Stick Installation |
7696 | ||
7697 | An installation image for USB sticks can be downloaded from | |
d79013f6 | 7698 | @indicateurl{ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.xz}, |
5af6de3e LC |
7699 | where @var{system} is one of: |
7700 | ||
7701 | @table @code | |
7702 | @item x86_64-linux | |
7703 | for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs; | |
7704 | ||
7705 | @item i686-linux | |
7706 | for a 32-bit GNU/Linux system on Intel-compatible CPUs. | |
7707 | @end table | |
7708 | ||
debc6360 LC |
7709 | @c start duplication of authentication part from ``Binary Installation'' |
7710 | Make sure to download the associated @file{.sig} file and to verify the | |
7711 | authenticity of the image against it, along these lines: | |
7712 | ||
7713 | @example | |
d79013f6 DM |
7714 | $ wget ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.xz.sig |
7715 | $ gpg --verify guixsd-install-@value{VERSION}.@var{system}.xz.sig | |
debc6360 LC |
7716 | @end example |
7717 | ||
7718 | If that command fails because you do not have the required public key, | |
7719 | then run this command to import it: | |
7720 | ||
7721 | @example | |
7722 | $ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID} | |
7723 | @end example | |
7724 | ||
7725 | @noindent | |
7726 | and rerun the @code{gpg --verify} command. | |
7727 | @c end duplication | |
7728 | ||
d79013f6 DM |
7729 | This image contains the tools necessary for an installation. |
7730 | It is meant to be copied @emph{as is} to a large-enough USB stick or DVD. | |
5af6de3e LC |
7731 | |
7732 | To copy the image to a USB stick, follow these steps: | |
7733 | ||
7734 | @enumerate | |
7735 | @item | |
7736 | Decompress the image using the @command{xz} command: | |
7737 | ||
7738 | @example | |
d79013f6 | 7739 | xz -d guixsd-install-@value{VERSION}.@var{system}.xz |
5af6de3e LC |
7740 | @end example |
7741 | ||
7742 | @item | |
f97c9175 AE |
7743 | Insert a USB stick of 1@tie{}GiB or more into your machine, and determine |
7744 | its device name. Assuming that the USB stick is known as @file{/dev/sdX}, | |
5af6de3e LC |
7745 | copy the image with: |
7746 | ||
7747 | @example | |
d79013f6 | 7748 | dd if=guixsd-install-@value{VERSION}.x86_64 of=/dev/sdX |
0e2bfa3a | 7749 | sync |
5af6de3e LC |
7750 | @end example |
7751 | ||
7752 | Access to @file{/dev/sdX} usually requires root privileges. | |
7753 | @end enumerate | |
7754 | ||
7755 | Once this is done, you should be able to reboot the system and boot from | |
4fed93a1 | 7756 | the USB stick. The latter usually requires you to get in the BIOS or |
8ea98ee1 | 7757 | UEFI boot menu, where you can choose to boot from the USB stick. |
5af6de3e | 7758 | |
c8b54374 VL |
7759 | @xref{Installing GuixSD in a VM}, if, instead, you would like to install |
7760 | GuixSD in a virtual machine (VM). | |
7761 | ||
d79013f6 DM |
7762 | @node DVD Installation |
7763 | @subsection DVD Installation | |
7764 | ||
7765 | An installation image for DVDs can be downloaded from | |
7766 | @indicateurl{ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.xz}, | |
7767 | where @var{system} is one of: | |
7768 | ||
7769 | @table @code | |
7770 | @item x86_64-linux | |
7771 | for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs; | |
7772 | ||
7773 | @item i686-linux | |
7774 | for a 32-bit GNU/Linux system on Intel-compatible CPUs. | |
7775 | @end table | |
7776 | ||
7777 | @c start duplication of authentication part from ``Binary Installation'' | |
7778 | Make sure to download the associated @file{.sig} file and to verify the | |
7779 | authenticity of the image against it, along these lines: | |
7780 | ||
7781 | @example | |
7782 | $ wget ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.xz.sig | |
7783 | $ gpg --verify guixsd-install-@value{VERSION}.@var{system}.xz.sig | |
7784 | @end example | |
7785 | ||
7786 | If that command fails because you do not have the required public key, | |
7787 | then run this command to import it: | |
7788 | ||
7789 | @example | |
7790 | $ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID} | |
7791 | @end example | |
7792 | ||
7793 | @noindent | |
7794 | and rerun the @code{gpg --verify} command. | |
7795 | @c end duplication | |
7796 | ||
7797 | This image contains the tools necessary for an installation. | |
7798 | It is meant to be copied @emph{as is} to a large-enough USB stick or DVD. | |
7799 | ||
7800 | To copy the image to a DVD, follow these steps: | |
7801 | ||
7802 | @enumerate | |
7803 | @item | |
7804 | Decompress the image using the @command{xz} command: | |
7805 | ||
7806 | @example | |
7807 | xz -d guixsd-install-@value{VERSION}.@var{system}.xz | |
7808 | @end example | |
7809 | ||
7810 | @item | |
7811 | Insert a blank DVD into your machine, and determine | |
7812 | its device name. Assuming that the DVD drive is known as @file{/dev/srX}, | |
7813 | copy the image with: | |
7814 | ||
7815 | @example | |
7816 | growisofs -dvd-compat -Z /dev/srX=guixsd-install-@value{VERSION}.x86_64 | |
7817 | @end example | |
7818 | ||
7819 | Access to @file{/dev/srX} usually requires root privileges. | |
7820 | @end enumerate | |
7821 | ||
7822 | Once this is done, you should be able to reboot the system and boot from | |
7823 | the DVD. The latter usually requires you to get in the BIOS or | |
7824 | UEFI boot menu, where you can choose to boot from the DVD. | |
7825 | ||
7826 | @xref{Installing GuixSD in a VM}, if, instead, you would like to install | |
7827 | GuixSD in a virtual machine (VM). | |
7828 | ||
dedb8d5e | 7829 | @node Preparing for Installation |
5af6de3e LC |
7830 | @subsection Preparing for Installation |
7831 | ||
d79013f6 DM |
7832 | Once you have successfully booted your computer using the installation medium, |
7833 | you should end up with a root prompt. Several console TTYs are configured | |
7834 | and can be used to run commands as root. TTY2 shows this documentation, | |
de341e7c LC |
7835 | browsable using the Info reader commands (@pxref{Top,,, info-stnd, |
7836 | Stand-alone GNU Info}). The installation system runs the GPM mouse | |
7837 | daemon, which allows you to select text with the left mouse button and | |
7838 | to paste it with the middle button. | |
5af6de3e | 7839 | |
ff925d37 LC |
7840 | @quotation Note |
7841 | Installation requires access to the Internet so that any missing | |
7842 | dependencies of your system configuration can be downloaded. See the | |
7843 | ``Networking'' section below. | |
7844 | @end quotation | |
7845 | ||
0e69cf67 LC |
7846 | The installation system includes many common tools needed for this task. |
7847 | But it is also a full-blown GuixSD system, which means that you can | |
7848 | install additional packages, should you need it, using @command{guix | |
7849 | package} (@pxref{Invoking guix package}). | |
7850 | ||
dedb8d5e | 7851 | @subsubsection Keyboard Layout |
5af6de3e | 7852 | |
dedb8d5e LC |
7853 | @cindex keyboard layout |
7854 | The installation image uses the US qwerty keyboard layout. If you want | |
7855 | to change it, you can use the @command{loadkeys} command. For example, | |
7856 | the following command selects the Dvorak keyboard layout: | |
5af6de3e | 7857 | |
dedb8d5e LC |
7858 | @example |
7859 | loadkeys dvorak | |
7860 | @end example | |
7861 | ||
7862 | See the files under @file{/run/current-system/profile/share/keymaps} for | |
7863 | a list of available keyboard layouts. Run @command{man loadkeys} for | |
7864 | more information. | |
7865 | ||
7866 | @subsubsection Networking | |
7867 | ||
7868 | Run the following command see what your network interfaces are called: | |
235cba85 LC |
7869 | |
7870 | @example | |
dedb8d5e | 7871 | ifconfig -a |
235cba85 LC |
7872 | @end example |
7873 | ||
1713c37f LC |
7874 | @noindent |
7875 | @dots{} or, using the GNU/Linux-specific @command{ip} command: | |
7876 | ||
7877 | @example | |
7878 | ip a | |
7879 | @end example | |
7880 | ||
95c559c1 | 7881 | @c http://cgit.freedesktop.org/systemd/systemd/tree/src/udev/udev-builtin-net_id.c#n20 |
dedb8d5e LC |
7882 | Wired interfaces have a name starting with @samp{e}; for example, the |
7883 | interface corresponding to the first on-board Ethernet controller is | |
7884 | called @samp{eno1}. Wireless interfaces have a name starting with | |
7885 | @samp{w}, like @samp{w1p2s0}. | |
7886 | ||
7887 | @table @asis | |
7888 | @item Wired connection | |
7889 | To configure a wired network run the following command, substituting | |
7890 | @var{interface} with the name of the wired interface you want to use. | |
7891 | ||
7892 | @example | |
7893 | ifconfig @var{interface} up | |
7894 | @end example | |
7895 | ||
7896 | @item Wireless connection | |
e32171ee JD |
7897 | @cindex wireless |
7898 | @cindex WiFi | |
dedb8d5e LC |
7899 | To configure wireless networking, you can create a configuration file |
7900 | for the @command{wpa_supplicant} configuration tool (its location is not | |
7901 | important) using one of the available text editors such as | |
7902 | @command{zile}: | |
7903 | ||
7904 | @example | |
7905 | zile wpa_supplicant.conf | |
7906 | @end example | |
7907 | ||
7908 | As an example, the following stanza can go to this file and will work | |
7909 | for many wireless networks, provided you give the actual SSID and | |
7910 | passphrase for the network you are connecting to: | |
7911 | ||
7912 | @example | |
7913 | network=@{ | |
ae768308 | 7914 | ssid="@var{my-ssid}" |
dedb8d5e LC |
7915 | key_mgmt=WPA-PSK |
7916 | psk="the network's secret passphrase" | |
7917 | @} | |
7918 | @end example | |
7919 | ||
7920 | Start the wireless service and run it in the background with the | |
7921 | following command (substitute @var{interface} with the name of the | |
7922 | network interface you want to use): | |
7923 | ||
7924 | @example | |
7925 | wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B | |
7926 | @end example | |
7927 | ||
641d0518 | 7928 | Run @command{man wpa_supplicant} for more information. |
dedb8d5e LC |
7929 | @end table |
7930 | ||
e32171ee | 7931 | @cindex DHCP |
dedb8d5e LC |
7932 | At this point, you need to acquire an IP address. On a network where IP |
7933 | addresses are automatically assigned @i{via} DHCP, you can run: | |
7934 | ||
7935 | @example | |
15650ac2 | 7936 | dhclient -v @var{interface} |
dedb8d5e | 7937 | @end example |
5af6de3e | 7938 | |
dedb8d5e LC |
7939 | Try to ping a server to see if networking is up and running: |
7940 | ||
7941 | @example | |
7942 | ping -c 3 gnu.org | |
7943 | @end example | |
5af6de3e LC |
7944 | |
7945 | Setting up network access is almost always a requirement because the | |
7946 | image does not contain all the software and tools that may be needed. | |
7947 | ||
c80cd4df MB |
7948 | @cindex installing over SSH |
7949 | If you want to, you can continue the installation remotely by starting | |
7950 | an SSH server: | |
7951 | ||
7952 | @example | |
7953 | herd start ssh-daemon | |
7954 | @end example | |
7955 | ||
7956 | Make sure to either set a password with @command{passwd}, or configure | |
7957 | OpenSSH public key authentication before logging in. | |
7958 | ||
dedb8d5e LC |
7959 | @subsubsection Disk Partitioning |
7960 | ||
7961 | Unless this has already been done, the next step is to partition, and | |
7962 | then format the target partition(s). | |
7963 | ||
7964 | The installation image includes several partitioning tools, including | |
7965 | Parted (@pxref{Overview,,, parted, GNU Parted User Manual}), | |
7966 | @command{fdisk}, and @command{cfdisk}. Run it and set up your disk with | |
7967 | the partition layout you want: | |
7968 | ||
7969 | @example | |
7970 | cfdisk | |
7971 | @end example | |
7972 | ||
d918d79f SB |
7973 | If your disk uses the GUID Partition Table (GPT) format and you plan to |
7974 | install BIOS-based GRUB (which is the default), make sure a BIOS Boot | |
7975 | Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB | |
7976 | manual}). | |
7977 | ||
8ea98ee1 MB |
7978 | @cindex EFI, installation |
7979 | @cindex UEFI, installation | |
7980 | @cindex ESP, EFI system partition | |
7981 | If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System Partition} | |
7982 | (ESP) is required. This partition should be mounted at @file{/boot/efi} and | |
7983 | must have the @code{esp} flag set. E.g., for @command{parted}: | |
7984 | ||
7985 | @example | |
7986 | parted /dev/sda set 1 esp on | |
7987 | @end example | |
7988 | ||
dedb8d5e LC |
7989 | Once you are done partitioning the target hard disk drive, you have to |
7990 | create a file system on the relevant partition(s)@footnote{Currently | |
b1a505ba DC |
7991 | GuixSD only supports ext4 and btrfs file systems. In particular, code |
7992 | that reads partition UUIDs and labels only works for these file system | |
6ab63268 LC |
7993 | types.}. For the ESP, if you have one and assuming it is |
7994 | @file{/dev/sda2}, run: | |
7995 | ||
7996 | @example | |
7997 | mkfs.fat -F32 /dev/sda2 | |
7998 | @end example | |
5af6de3e | 7999 | |
7ab44369 LC |
8000 | Preferably, assign partitions a label so that you can easily and |
8001 | reliably refer to them in @code{file-system} declarations (@pxref{File | |
8002 | Systems}). This is typically done using the @code{-L} option of | |
dedb8d5e LC |
8003 | @command{mkfs.ext4} and related commands. So, assuming the target root |
8004 | partition lives at @file{/dev/sda1}, a file system with the label | |
8005 | @code{my-root} can be created with: | |
7ab44369 | 8006 | |
dedb8d5e LC |
8007 | @example |
8008 | mkfs.ext4 -L my-root /dev/sda1 | |
8009 | @end example | |
dd816355 | 8010 | |
13fb1bd9 LC |
8011 | @cindex encrypted disk |
8012 | If you are instead planning to encrypt the root partition, you can use | |
8013 | the Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, | |
8014 | @uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, | |
8015 | @code{man cryptsetup}} for more information.) Assuming you want to | |
8016 | store the root partition on @file{/dev/sda1}, the command sequence would | |
8017 | be along these lines: | |
6d6e6281 | 8018 | |
13fb1bd9 LC |
8019 | @example |
8020 | cryptsetup luksFormat /dev/sda1 | |
8021 | cryptsetup open --type luks /dev/sda1 my-partition | |
8022 | mkfs.ext4 -L my-root /dev/mapper/my-partition | |
8023 | @end example | |
5af6de3e | 8024 | |
dedb8d5e | 8025 | Once that is done, mount the target root partition under @file{/mnt} |
13fb1bd9 LC |
8026 | with a command like (again, assuming @code{my-root} is the label of the |
8027 | root partition): | |
83a17b62 | 8028 | |
dedb8d5e | 8029 | @example |
13fb1bd9 | 8030 | mount LABEL=my-root /mnt |
dedb8d5e | 8031 | @end example |
83a17b62 | 8032 | |
8ea98ee1 MB |
8033 | Also mount any other partitions you would like to use on the target |
8034 | system relative to this path. If you have @file{/boot} on a separate | |
8035 | partition for example, mount it at @file{/mnt/boot} now so it is found | |
8036 | by @code{guix system init} afterwards. | |
8037 | ||
31b6cdf8 LC |
8038 | Finally, if you plan to use one or more swap partitions (@pxref{Memory |
8039 | Concepts, swap space,, libc, The GNU C Library Reference Manual}), make | |
8040 | sure to initialize them with @command{mkswap}. Assuming you have one | |
8041 | swap partition on @file{/dev/sda2}, you would run: | |
8042 | ||
8043 | @example | |
8044 | mkswap /dev/sda2 | |
b2ff76a0 | 8045 | swapon /dev/sda2 |
31b6cdf8 LC |
8046 | @end example |
8047 | ||
a4ca4362 CM |
8048 | Alternatively, you may use a swap file. For example, assuming that in |
8049 | the new system you want to use the file @file{/swapfile} as a swap file, | |
8050 | you would run@footnote{This example will work for many types of file | |
8051 | systems (e.g., ext4). However, for copy-on-write file systems (e.g., | |
8052 | btrfs), the required steps may be different. For details, see the | |
8053 | manual pages for @command{mkswap} and @command{swapon}.}: | |
8054 | ||
8055 | @example | |
8056 | # This is 10 GiB of swap space. Adjust "count" to change the size. | |
8057 | dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240 | |
8058 | # For security, make the file readable and writable only by root. | |
8059 | chmod 600 /mnt/swapfile | |
8060 | mkswap /mnt/swapfile | |
8061 | swapon /mnt/swapfile | |
8062 | @end example | |
8063 | ||
8064 | Note that if you have encrypted the root partition and created a swap | |
8065 | file in its file system as described above, then the encryption also | |
8066 | protects the swap file, just like any other file in that file system. | |
8067 | ||
dedb8d5e LC |
8068 | @node Proceeding with the Installation |
8069 | @subsection Proceeding with the Installation | |
83a17b62 | 8070 | |
dedb8d5e LC |
8071 | With the target partitions ready and the target root mounted on |
8072 | @file{/mnt}, we're ready to go. First, run: | |
5af6de3e | 8073 | |
dedb8d5e LC |
8074 | @example |
8075 | herd start cow-store /mnt | |
8076 | @end example | |
5af6de3e | 8077 | |
b397c0d5 LC |
8078 | This makes @file{/gnu/store} copy-on-write, such that packages added to it |
8079 | during the installation phase are written to the target disk on @file{/mnt} | |
8080 | rather than kept in memory. This is necessary because the first phase of | |
8081 | the @command{guix system init} command (see below) entails downloads or | |
8082 | builds to @file{/gnu/store} which, initially, is an in-memory file system. | |
5af6de3e | 8083 | |
dedb8d5e | 8084 | Next, you have to edit a file and |
5af6de3e | 8085 | provide the declaration of the operating system to be installed. To |
a8cb87ab LC |
8086 | that end, the installation system comes with three text editors: GNU nano |
8087 | (@pxref{Top,,, nano, GNU nano Manual}), GNU Zile (an Emacs clone), and | |
8088 | nvi (a clone of the original BSD @command{vi} editor). | |
efa77c6c LC |
8089 | We strongly recommend storing that file on the target root file system, say, |
8090 | as @file{/mnt/etc/config.scm}. Failing to do that, you will have lost your | |
8091 | configuration file once you have rebooted into the newly-installed system. | |
5af6de3e | 8092 | |
dedb8d5e LC |
8093 | @xref{Using the Configuration System}, for an overview of the |
8094 | configuration file. The example configurations discussed in that | |
8095 | section are available under @file{/etc/configuration} in the | |
8096 | installation image. Thus, to get started with a system configuration | |
8097 | providing a graphical display server (a ``desktop'' system), you can run | |
8098 | something along these lines: | |
8099 | ||
8100 | @example | |
8101 | # mkdir /mnt/etc | |
8102 | # cp /etc/configuration/desktop.scm /mnt/etc/config.scm | |
8103 | # zile /mnt/etc/config.scm | |
8104 | @end example | |
8105 | ||
8106 | You should pay attention to what your configuration file contains, and | |
8107 | in particular: | |
8108 | ||
8109 | @itemize | |
8110 | @item | |
045ebb3e AW |
8111 | Make sure the @code{grub-configuration} form refers to the target you |
8112 | want to install GRUB on. It should mention @code{grub-bootloader} if | |
8113 | you are installing GRUB in the legacy way, or @code{grub-efi-bootloader} | |
8114 | for newer UEFI systems. For legacy systems, the @code{target} field | |
8115 | names a device, like @code{/dev/sda}; for UEFI systems it names a path | |
8116 | to a mounted EFI partition, like @code{/boot/efi}, and do make sure the | |
8117 | path is actually mounted. | |
dedb8d5e LC |
8118 | |
8119 | @item | |
8120 | Be sure that your partition labels match the value of their respective | |
8121 | @code{device} fields in your @code{file-system} configuration, assuming | |
8122 | your @code{file-system} configuration sets the value of @code{title} to | |
8123 | @code{'label}. | |
13fb1bd9 LC |
8124 | |
8125 | @item | |
8126 | If there are encrypted or RAID partitions, make sure to add a | |
8127 | @code{mapped-devices} field to describe them (@pxref{Mapped Devices}). | |
dedb8d5e | 8128 | @end itemize |
5af6de3e | 8129 | |
dd51caac LC |
8130 | Once you are done preparing the configuration file, the new system must |
8131 | be initialized (remember that the target root file system is mounted | |
8132 | under @file{/mnt}): | |
5af6de3e LC |
8133 | |
8134 | @example | |
8135 | guix system init /mnt/etc/config.scm /mnt | |
8136 | @end example | |
8137 | ||
8138 | @noindent | |
dedb8d5e | 8139 | This copies all the necessary files and installs GRUB on |
f8818360 | 8140 | @file{/dev/sdX}, unless you pass the @option{--no-bootloader} option. For |
6621cdb6 | 8141 | more information, @pxref{Invoking guix system}. This command may trigger |
5af6de3e LC |
8142 | downloads or builds of missing packages, which can take some time. |
8143 | ||
1bd4e6db LC |
8144 | Once that command has completed---and hopefully succeeded!---you can run |
8145 | @command{reboot} and boot into the new system. The @code{root} password | |
8146 | in the new system is initially empty; other users' passwords need to be | |
8147 | initialized by running the @command{passwd} command as @code{root}, | |
8148 | unless your configuration specifies otherwise | |
8149 | (@pxref{user-account-password, user account passwords}). | |
8150 | ||
7fcf2a0b LC |
8151 | @cindex upgrading GuixSD |
8152 | From then on, you can update GuixSD whenever you want by running | |
8153 | @command{guix pull} as @code{root} (@pxref{Invoking guix pull}), and | |
8154 | then running @command{guix system reconfigure} to build a new system | |
8155 | generation with the latest packages and services (@pxref{Invoking guix | |
8156 | system}). We recommend doing that regularly so that your system | |
8157 | includes the latest security updates (@pxref{Security Updates}). | |
8158 | ||
1bd4e6db | 8159 | Join us on @code{#guix} on the Freenode IRC network or on |
5af6de3e LC |
8160 | @file{guix-devel@@gnu.org} to share your experience---good or not so |
8161 | good. | |
8162 | ||
c8b54374 VL |
8163 | @node Installing GuixSD in a VM |
8164 | @subsection Installing GuixSD in a Virtual Machine | |
8165 | ||
8166 | @cindex virtual machine, GuixSD installation | |
4b236c88 LF |
8167 | @cindex virtual private server (VPS) |
8168 | @cindex VPS (virtual private server) | |
8169 | If you'd like to install GuixSD in a virtual machine (VM) or on a | |
8170 | virtual private server (VPS) rather than on your beloved machine, this | |
8171 | section is for you. | |
c8b54374 VL |
8172 | |
8173 | To boot a @uref{http://qemu.org/,QEMU} VM for installing GuixSD in a | |
8174 | disk image, follow these steps: | |
8175 | ||
8176 | @enumerate | |
8177 | @item | |
a0885414 LF |
8178 | First, retrieve and decompress the GuixSD installation image as |
8179 | described previously (@pxref{USB Stick Installation}). | |
c8b54374 VL |
8180 | |
8181 | @item | |
8182 | Create a disk image that will hold the installed system. To make a | |
8183 | qcow2-formatted disk image, use the @command{qemu-img} command: | |
8184 | ||
8185 | @example | |
01049bb0 | 8186 | qemu-img create -f qcow2 guixsd.img 50G |
c8b54374 VL |
8187 | @end example |
8188 | ||
01049bb0 LF |
8189 | The resulting file will be much smaller than 50 GB (typically less than |
8190 | 1 MB), but it will grow as the virtualized storage device is filled up. | |
c8b54374 VL |
8191 | |
8192 | @item | |
8193 | Boot the USB installation image in an VM: | |
8194 | ||
8195 | @example | |
8196 | qemu-system-x86_64 -m 1024 -smp 1 \ | |
d36b8457 | 8197 | -net user -net nic,model=virtio -boot menu=on \ |
d79013f6 | 8198 | -drive file=guixsd-install-@value{VERSION}.@var{system} \ |
1c25d6d0 | 8199 | -drive file=guixsd.img |
c8b54374 VL |
8200 | @end example |
8201 | ||
1c25d6d0 DM |
8202 | The ordering of the drives matters. |
8203 | ||
c8b54374 VL |
8204 | In the VM console, quickly press the @kbd{F12} key to enter the boot |
8205 | menu. Then press the @kbd{2} key and the @kbd{RET} key to validate your | |
8206 | selection. | |
8207 | ||
8208 | @item | |
8209 | You're now root in the VM, proceed with the installation process. | |
8210 | @xref{Preparing for Installation}, and follow the instructions. | |
8211 | @end enumerate | |
8212 | ||
8213 | Once installation is complete, you can boot the system that's on your | |
8214 | @file{guixsd.img} image. @xref{Running GuixSD in a VM}, for how to do | |
8215 | that. | |
8216 | ||
dedb8d5e | 8217 | @node Building the Installation Image |
5af6de3e LC |
8218 | @subsection Building the Installation Image |
8219 | ||
e32171ee | 8220 | @cindex installation image |
5af6de3e LC |
8221 | The installation image described above was built using the @command{guix |
8222 | system} command, specifically: | |
8223 | ||
8224 | @example | |
a8ac4f08 | 8225 | guix system disk-image gnu/system/install.scm |
5af6de3e LC |
8226 | @end example |
8227 | ||
6e6a0401 AE |
8228 | Have a look at @file{gnu/system/install.scm} in the source tree, |
8229 | and see also @ref{Invoking guix system} for more information | |
5af6de3e LC |
8230 | about the installation image. |
8231 | ||
cf4a9129 LC |
8232 | @node System Configuration |
8233 | @section System Configuration | |
b208a005 | 8234 | |
cf4a9129 | 8235 | @cindex system configuration |
3ca2731c | 8236 | The Guix System Distribution supports a consistent whole-system configuration |
cf4a9129 LC |
8237 | mechanism. By that we mean that all aspects of the global system |
8238 | configuration---such as the available system services, timezone and | |
8239 | locale settings, user accounts---are declared in a single place. Such | |
8240 | a @dfn{system configuration} can be @dfn{instantiated}---i.e., effected. | |
91ef73d4 | 8241 | |
cf4a9129 LC |
8242 | One of the advantages of putting all the system configuration under the |
8243 | control of Guix is that it supports transactional system upgrades, and | |
1068f26b | 8244 | makes it possible to roll back to a previous system instantiation, |
cf4a9129 | 8245 | should something go wrong with the new one (@pxref{Features}). Another |
1068f26b | 8246 | advantage is that it makes it easy to replicate the exact same configuration |
cf4a9129 LC |
8247 | across different machines, or at different points in time, without |
8248 | having to resort to additional administration tools layered on top of | |
1068f26b | 8249 | the own tools of the system. |
cf4a9129 | 8250 | @c Yes, we're talking of Puppet, Chef, & co. here. ↑ |
91ef73d4 | 8251 | |
cf4a9129 LC |
8252 | This section describes this mechanism. First we focus on the system |
8253 | administrator's viewpoint---explaining how the system is configured and | |
8254 | instantiated. Then we show how this mechanism can be extended, for | |
8255 | instance to support new system services. | |
91ef73d4 | 8256 | |
cf4a9129 LC |
8257 | @menu |
8258 | * Using the Configuration System:: Customizing your GNU system. | |
7313a52e | 8259 | * operating-system Reference:: Detail of operating-system declarations. |
cf4a9129 | 8260 | * File Systems:: Configuring file system mounts. |
510f9d86 | 8261 | * Mapped Devices:: Block device extra processing. |
cf4a9129 | 8262 | * User Accounts:: Specifying user accounts. |
598e19dc | 8263 | * Locales:: Language and cultural convention settings. |
cf4a9129 | 8264 | * Services:: Specifying system services. |
0ae8c15a | 8265 | * Setuid Programs:: Programs running with root privileges. |
efb5e833 | 8266 | * X.509 Certificates:: Authenticating HTTPS servers. |
996ed739 | 8267 | * Name Service Switch:: Configuring libc's name service switch. |
fd1b1fa2 | 8268 | * Initial RAM Disk:: Linux-Libre bootstrapping. |
74e64724 | 8269 | * Bootloader Configuration:: Configuring the boot loader. |
cf4a9129 | 8270 | * Invoking guix system:: Instantiating a system configuration. |
97d76250 | 8271 | * Running GuixSD in a VM:: How to run GuixSD in a virtual machine. |
cf4a9129 LC |
8272 | * Defining Services:: Adding new service definitions. |
8273 | @end menu | |
91ef73d4 | 8274 | |
cf4a9129 LC |
8275 | @node Using the Configuration System |
8276 | @subsection Using the Configuration System | |
64d76fa6 | 8277 | |
cf4a9129 LC |
8278 | The operating system is configured by providing an |
8279 | @code{operating-system} declaration in a file that can then be passed to | |
8280 | the @command{guix system} command (@pxref{Invoking guix system}). A | |
8281 | simple setup, with the default system services, the default Linux-Libre | |
8282 | kernel, initial RAM disk, and boot loader looks like this: | |
91ef73d4 | 8283 | |
cf4a9129 LC |
8284 | @findex operating-system |
8285 | @lisp | |
dd51caac | 8286 | @include os-config-bare-bones.texi |
cf4a9129 | 8287 | @end lisp |
401c53c4 | 8288 | |
cf4a9129 LC |
8289 | This example should be self-describing. Some of the fields defined |
8290 | above, such as @code{host-name} and @code{bootloader}, are mandatory. | |
8291 | Others, such as @code{packages} and @code{services}, can be omitted, in | |
8292 | which case they get a default value. | |
e7f34eb0 | 8293 | |
5d94ac51 LC |
8294 | Below we discuss the effect of some of the most important fields |
8295 | (@pxref{operating-system Reference}, for details about all the available | |
8296 | fields), and how to @dfn{instantiate} the operating system using | |
8297 | @command{guix system}. | |
8298 | ||
8299 | @unnumberedsubsubsec Globally-Visible Packages | |
8300 | ||
cf4a9129 | 8301 | @vindex %base-packages |
5d94ac51 LC |
8302 | The @code{packages} field lists packages that will be globally visible |
8303 | on the system, for all user accounts---i.e., in every user's @code{PATH} | |
8304 | environment variable---in addition to the per-user profiles | |
8305 | (@pxref{Invoking guix package}). The @var{%base-packages} variable | |
8306 | provides all the tools one would expect for basic user and administrator | |
8307 | tasks---including the GNU Core Utilities, the GNU Networking Utilities, | |
8308 | the GNU Zile lightweight text editor, @command{find}, @command{grep}, | |
960c40de LC |
8309 | etc. The example above adds GNU@tie{}Screen and OpenSSH to those, |
8310 | taken from the @code{(gnu packages screen)} and @code{(gnu packages ssh)} | |
8311 | modules (@pxref{Package Modules}). The | |
fe0915cf JL |
8312 | @code{(list package output)} syntax can be used to add a specific output |
8313 | of a package: | |
8314 | ||
8315 | @lisp | |
8316 | (use-modules (gnu packages)) | |
8317 | (use-modules (gnu packages dns)) | |
8318 | ||
8319 | (operating-system | |
8320 | ;; ... | |
8321 | (packages (cons (list bind "utils") | |
8322 | %base-packages))) | |
8323 | @end lisp | |
e7f34eb0 | 8324 | |
f6c9fb1b LC |
8325 | @findex specification->package |
8326 | Referring to packages by variable name, like @var{tcpdump} above, has | |
8327 | the advantage of being unambiguous; it also allows typos and such to be | |
8328 | diagnosed right away as ``unbound variables''. The downside is that one | |
8329 | needs to know which module defines which package, and to augment the | |
8330 | @code{use-package-modules} line accordingly. To avoid that, one can use | |
8331 | the @code{specification->package} procedure of the @code{(gnu packages)} | |
8332 | module, which returns the best package for a given name or name and | |
8333 | version: | |
8334 | ||
8335 | @lisp | |
8336 | (use-modules (gnu packages)) | |
8337 | ||
8338 | (operating-system | |
8339 | ;; ... | |
8340 | (packages (append (map specification->package | |
d5e59248 | 8341 | '("tcpdump" "htop" "gnupg@@2.0")) |
f6c9fb1b LC |
8342 | %base-packages))) |
8343 | @end lisp | |
8344 | ||
5d94ac51 LC |
8345 | @unnumberedsubsubsec System Services |
8346 | ||
e32171ee | 8347 | @cindex services |
cf4a9129 LC |
8348 | @vindex %base-services |
8349 | The @code{services} field lists @dfn{system services} to be made | |
8350 | available when the system starts (@pxref{Services}). | |
8351 | The @code{operating-system} declaration above specifies that, in | |
8352 | addition to the basic services, we want the @command{lshd} secure shell | |
cd6f6c22 LC |
8353 | daemon listening on port 2222 (@pxref{Networking Services, |
8354 | @code{lsh-service}}). Under the hood, | |
cf4a9129 LC |
8355 | @code{lsh-service} arranges so that @code{lshd} is started with the |
8356 | right command-line options, possibly with supporting configuration files | |
cd6f6c22 LC |
8357 | generated as needed (@pxref{Defining Services}). |
8358 | ||
8359 | @cindex customization, of services | |
8360 | @findex modify-services | |
8361 | Occasionally, instead of using the base services as is, you will want to | |
4d343a14 CM |
8362 | customize them. To do this, use @code{modify-services} (@pxref{Service |
8363 | Reference, @code{modify-services}}) to modify the list. | |
8364 | ||
8365 | For example, suppose you want to modify @code{guix-daemon} and Mingetty | |
8366 | (the console log-in) in the @var{%base-services} list (@pxref{Base | |
8367 | Services, @code{%base-services}}). To do that, you can write the | |
8368 | following in your operating system declaration: | |
cd6f6c22 LC |
8369 | |
8370 | @lisp | |
4d343a14 CM |
8371 | (define %my-services |
8372 | ;; My very own list of services. | |
8373 | (modify-services %base-services | |
8374 | (guix-service-type config => | |
8375 | (guix-configuration | |
8376 | (inherit config) | |
8377 | (use-substitutes? #f) | |
8378 | (extra-options '("--gc-keep-derivations")))) | |
8379 | (mingetty-service-type config => | |
8380 | (mingetty-configuration | |
317d3b47 | 8381 | (inherit config))))) |
4d343a14 CM |
8382 | |
8383 | (operating-system | |
8384 | ;; @dots{} | |
8385 | (services %my-services)) | |
cd6f6c22 LC |
8386 | @end lisp |
8387 | ||
4d343a14 CM |
8388 | This changes the configuration---i.e., the service parameters---of the |
8389 | @code{guix-service-type} instance, and that of all the | |
8390 | @code{mingetty-service-type} instances in the @var{%base-services} list. | |
8391 | Observe how this is accomplished: first, we arrange for the original | |
8392 | configuration to be bound to the identifier @code{config} in the | |
8393 | @var{body}, and then we write the @var{body} so that it evaluates to the | |
8394 | desired configuration. In particular, notice how we use @code{inherit} | |
8395 | to create a new configuration which has the same values as the old | |
8396 | configuration, but with a few modifications. | |
a1ba8475 | 8397 | |
13fb1bd9 LC |
8398 | @cindex encrypted disk |
8399 | The configuration for a typical ``desktop'' usage, with an encrypted | |
8400 | root partition, the X11 display | |
d038b674 LC |
8401 | server, GNOME and Xfce (users can choose which of these desktop |
8402 | environments to use at the log-in screen by pressing @kbd{F1}), network | |
8403 | management, power management, and more, would look like this: | |
dd51caac LC |
8404 | |
8405 | @lisp | |
8406 | @include os-config-desktop.texi | |
8407 | @end lisp | |
8408 | ||
50fcf37c | 8409 | @cindex UEFI |
8ea98ee1 | 8410 | A graphical UEFI system with a choice of lightweight window managers |
d038b674 LC |
8411 | instead of full-blown desktop environments would look like this: |
8412 | ||
8413 | @lisp | |
8414 | @include os-config-lightweight-desktop.texi | |
8415 | @end lisp | |
8416 | ||
50fcf37c LC |
8417 | This example refers to the @file{/boot/efi} partition by its UUID, |
8418 | @code{1234-ABCD}. Replace this UUID with the right UUID on your system, | |
8419 | as returned by the @command{blkid} command. | |
8420 | ||
dd51caac | 8421 | @xref{Desktop Services}, for the exact list of services provided by |
efb5e833 LC |
8422 | @var{%desktop-services}. @xref{X.509 Certificates}, for background |
8423 | information about the @code{nss-certs} package that is used here. | |
dd51caac | 8424 | |
5d94ac51 LC |
8425 | Again, @var{%desktop-services} is just a list of service objects. If |
8426 | you want to remove services from there, you can do so using the | |
8427 | procedures for list filtering (@pxref{SRFI-1 Filtering and | |
8428 | Partitioning,,, guile, GNU Guile Reference Manual}). For instance, the | |
8429 | following expression returns a list that contains all the services in | |
8430 | @var{%desktop-services} minus the Avahi service: | |
8431 | ||
8432 | @example | |
8433 | (remove (lambda (service) | |
8434 | (eq? (service-kind service) avahi-service-type)) | |
8435 | %desktop-services) | |
8436 | @end example | |
8437 | ||
8438 | @unnumberedsubsubsec Instantiating the System | |
8439 | ||
8440 | Assuming the @code{operating-system} declaration | |
8441 | is stored in the @file{my-system-config.scm} | |
cf4a9129 LC |
8442 | file, the @command{guix system reconfigure my-system-config.scm} command |
8443 | instantiates that configuration, and makes it the default GRUB boot | |
65797bff LC |
8444 | entry (@pxref{Invoking guix system}). |
8445 | ||
1068f26b | 8446 | The normal way to change the system configuration is by updating this |
65797bff | 8447 | file and re-running @command{guix system reconfigure}. One should never |
8b499030 | 8448 | have to touch files in @file{/etc} or to run commands that modify the |
65797bff LC |
8449 | system state such as @command{useradd} or @command{grub-install}. In |
8450 | fact, you must avoid that since that would not only void your warranty | |
8451 | but also prevent you from rolling back to previous versions of your | |
8452 | system, should you ever need to. | |
8453 | ||
8454 | @cindex roll-back, of the operating system | |
8455 | Speaking of roll-back, each time you run @command{guix system | |
8456 | reconfigure}, a new @dfn{generation} of the system is created---without | |
8457 | modifying or deleting previous generations. Old system generations get | |
74e64724 | 8458 | an entry in the bootloader boot menu, allowing you to boot them in case |
65797bff LC |
8459 | something went wrong with the latest generation. Reassuring, no? The |
8460 | @command{guix system list-generations} command lists the system | |
067a2e2d CM |
8461 | generations available on disk. It is also possible to roll back the |
8462 | system via the commands @command{guix system roll-back} and | |
8463 | @command{guix system switch-generation}. | |
8464 | ||
8465 | Although the command @command{guix system reconfigure} will not modify | |
8466 | previous generations, must take care when the current generation is not | |
8467 | the latest (e.g., after invoking @command{guix system roll-back}), since | |
8468 | the operation might overwrite a later generation (@pxref{Invoking guix | |
8469 | system}). | |
b81e1947 | 8470 | |
5d94ac51 LC |
8471 | @unnumberedsubsubsec The Programming Interface |
8472 | ||
cf4a9129 LC |
8473 | At the Scheme level, the bulk of an @code{operating-system} declaration |
8474 | is instantiated with the following monadic procedure (@pxref{The Store | |
8475 | Monad}): | |
b81e1947 | 8476 | |
cf4a9129 LC |
8477 | @deffn {Monadic Procedure} operating-system-derivation os |
8478 | Return a derivation that builds @var{os}, an @code{operating-system} | |
8479 | object (@pxref{Derivations}). | |
b81e1947 | 8480 | |
cf4a9129 LC |
8481 | The output of the derivation is a single directory that refers to all |
8482 | the packages, configuration files, and other supporting files needed to | |
8483 | instantiate @var{os}. | |
8484 | @end deffn | |
b81e1947 | 8485 | |
5d94ac51 LC |
8486 | This procedure is provided by the @code{(gnu system)} module. Along |
8487 | with @code{(gnu services)} (@pxref{Services}), this module contains the | |
8488 | guts of GuixSD. Make sure to visit it! | |
8489 | ||
8490 | ||
7313a52e LC |
8491 | @node operating-system Reference |
8492 | @subsection @code{operating-system} Reference | |
8493 | ||
8494 | This section summarizes all the options available in | |
8495 | @code{operating-system} declarations (@pxref{Using the Configuration | |
8496 | System}). | |
8497 | ||
8498 | @deftp {Data Type} operating-system | |
8499 | This is the data type representing an operating system configuration. | |
8500 | By that, we mean all the global system configuration, not per-user | |
8501 | configuration (@pxref{Using the Configuration System}). | |
8502 | ||
8503 | @table @asis | |
8504 | @item @code{kernel} (default: @var{linux-libre}) | |
fbb25e56 | 8505 | The package object of the operating system kernel to use@footnote{Currently |
7313a52e LC |
8506 | only the Linux-libre kernel is supported. In the future, it will be |
8507 | possible to use the GNU@tie{}Hurd.}. | |
8508 | ||
ee2a6304 LC |
8509 | @item @code{kernel-arguments} (default: @code{'()}) |
8510 | List of strings or gexps representing additional arguments to pass on | |
1068f26b | 8511 | the command-line of the kernel---e.g., @code{("console=ttyS0")}. |
ee2a6304 | 8512 | |
7313a52e | 8513 | @item @code{bootloader} |
74e64724 | 8514 | The system bootloader configuration object. @xref{Bootloader Configuration}. |
7313a52e LC |
8515 | |
8516 | @item @code{initrd} (default: @code{base-initrd}) | |
e32171ee JD |
8517 | @cindex initrd |
8518 | @cindex initial RAM disk | |
7313a52e LC |
8519 | A two-argument monadic procedure that returns an initial RAM disk for |
8520 | the Linux kernel. @xref{Initial RAM Disk}. | |
8521 | ||
f34c56be LC |
8522 | @item @code{firmware} (default: @var{%base-firmware}) |
8523 | @cindex firmware | |
8524 | List of firmware packages loadable by the operating system kernel. | |
8525 | ||
52db41af EB |
8526 | The default includes firmware needed for Atheros- and Broadcom-based |
8527 | WiFi devices (Linux-libre modules @code{ath9k} and @code{b43-open}, | |
8528 | respectively). @xref{Hardware Considerations}, for more info on | |
8529 | supported hardware. | |
f34c56be | 8530 | |
7313a52e LC |
8531 | @item @code{host-name} |
8532 | The host name. | |
8533 | ||
8534 | @item @code{hosts-file} | |
8535 | @cindex hosts file | |
24e02c28 | 8536 | A file-like object (@pxref{G-Expressions, file-like objects}) for use as |
7313a52e | 8537 | @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library |
24e02c28 | 8538 | Reference Manual}). The default is a file with entries for |
7313a52e LC |
8539 | @code{localhost} and @var{host-name}. |
8540 | ||
8541 | @item @code{mapped-devices} (default: @code{'()}) | |
8542 | A list of mapped devices. @xref{Mapped Devices}. | |
8543 | ||
8544 | @item @code{file-systems} | |
8545 | A list of file systems. @xref{File Systems}. | |
8546 | ||
8547 | @item @code{swap-devices} (default: @code{'()}) | |
8548 | @cindex swap devices | |
a4ca4362 CM |
8549 | A list of strings identifying devices or files to be used for ``swap |
8550 | space'' (@pxref{Memory Concepts,,, libc, The GNU C Library Reference | |
8551 | Manual}). For example, @code{'("/dev/sda3")} or @code{'("/swapfile")}. | |
8552 | It is possible to specify a swap file in a file system on a mapped | |
8553 | device, provided that the necessary device mapping and file system are | |
8554 | also specified. @xref{Mapped Devices} and @ref{File Systems}. | |
7313a52e | 8555 | |
bf87f38a | 8556 | @item @code{users} (default: @code{%base-user-accounts}) |
7313a52e LC |
8557 | @itemx @code{groups} (default: @var{%base-groups}) |
8558 | List of user accounts and groups. @xref{User Accounts}. | |
8559 | ||
8560 | @item @code{skeletons} (default: @code{(default-skeletons)}) | |
e9dffec1 LC |
8561 | A list target file name/file-like object tuples (@pxref{G-Expressions, |
8562 | file-like objects}). These are the skeleton files that will be added to | |
8563 | the home directory of newly-created user accounts. | |
7313a52e LC |
8564 | |
8565 | For instance, a valid value may look like this: | |
8566 | ||
8567 | @example | |
e9dffec1 LC |
8568 | `((".bashrc" ,(plain-file "bashrc" "echo Hello\n")) |
8569 | (".guile" ,(plain-file "guile" | |
8570 | "(use-modules (ice-9 readline)) | |
8571 | (activate-readline)"))) | |
7313a52e LC |
8572 | @end example |
8573 | ||
8574 | @item @code{issue} (default: @var{%default-issue}) | |
8575 | A string denoting the contents of the @file{/etc/issue} file, which is | |
1068f26b | 8576 | displayed when users log in on a text console. |
7313a52e LC |
8577 | |
8578 | @item @code{packages} (default: @var{%base-packages}) | |
8579 | The set of packages installed in the global profile, which is accessible | |
8580 | at @file{/run/current-system/profile}. | |
8581 | ||
1068f26b | 8582 | The default set includes core utilities and it is good practice to |
7313a52e LC |
8583 | install non-core utilities in user profiles (@pxref{Invoking guix |
8584 | package}). | |
8585 | ||
8586 | @item @code{timezone} | |
8587 | A timezone identifying string---e.g., @code{"Europe/Paris"}. | |
8588 | ||
17c20385 LC |
8589 | You can run the @command{tzselect} command to find out which timezone |
8590 | string corresponds to your region. Choosing an invalid timezone name | |
8591 | causes @command{guix system} to fail. | |
8592 | ||
598e19dc LC |
8593 | @item @code{locale} (default: @code{"en_US.utf8"}) |
8594 | The name of the default locale (@pxref{Locale Names,,, libc, The GNU C | |
8595 | Library Reference Manual}). @xref{Locales}, for more information. | |
8596 | ||
8597 | @item @code{locale-definitions} (default: @var{%default-locale-definitions}) | |
8598 | The list of locale definitions to be compiled and that may be used at | |
8599 | run time. @xref{Locales}. | |
7313a52e | 8600 | |
34760ae7 LC |
8601 | @item @code{locale-libcs} (default: @code{(list @var{glibc})}) |
8602 | The list of GNU@tie{}libc packages whose locale data and tools are used | |
8603 | to build the locale definitions. @xref{Locales}, for compatibility | |
8604 | considerations that justify this option. | |
8605 | ||
996ed739 | 8606 | @item @code{name-service-switch} (default: @var{%default-nss}) |
1068f26b | 8607 | Configuration of the libc name service switch (NSS)---a |
996ed739 LC |
8608 | @code{<name-service-switch>} object. @xref{Name Service Switch}, for |
8609 | details. | |
8610 | ||
7313a52e | 8611 | @item @code{services} (default: @var{%base-services}) |
28d939af | 8612 | A list of service objects denoting system services. @xref{Services}. |
7313a52e LC |
8613 | |
8614 | @item @code{pam-services} (default: @code{(base-pam-services)}) | |
8615 | @cindex PAM | |
8616 | @cindex pluggable authentication modules | |
8617 | Linux @dfn{pluggable authentication module} (PAM) services. | |
8618 | @c FIXME: Add xref to PAM services section. | |
8619 | ||
8620 | @item @code{setuid-programs} (default: @var{%setuid-programs}) | |
8621 | List of string-valued G-expressions denoting setuid programs. | |
8622 | @xref{Setuid Programs}. | |
8623 | ||
f5a9ffa0 AK |
8624 | @item @code{sudoers-file} (default: @var{%sudoers-specification}) |
8625 | @cindex sudoers file | |
84765839 LC |
8626 | The contents of the @file{/etc/sudoers} file as a file-like object |
8627 | (@pxref{G-Expressions, @code{local-file} and @code{plain-file}}). | |
7313a52e LC |
8628 | |
8629 | This file specifies which users can use the @command{sudo} command, what | |
8630 | they are allowed to do, and what privileges they may gain. The default | |
8631 | is that only @code{root} and members of the @code{wheel} group may use | |
8632 | @code{sudo}. | |
8633 | ||
8634 | @end table | |
8635 | @end deftp | |
8636 | ||
cf4a9129 LC |
8637 | @node File Systems |
8638 | @subsection File Systems | |
b81e1947 | 8639 | |
cf4a9129 | 8640 | The list of file systems to be mounted is specified in the |
1068f26b | 8641 | @code{file-systems} field of the operating system declaration |
cf4a9129 LC |
8642 | (@pxref{Using the Configuration System}). Each file system is declared |
8643 | using the @code{file-system} form, like this: | |
b81e1947 LC |
8644 | |
8645 | @example | |
cf4a9129 LC |
8646 | (file-system |
8647 | (mount-point "/home") | |
8648 | (device "/dev/sda3") | |
8649 | (type "ext4")) | |
b81e1947 LC |
8650 | @end example |
8651 | ||
cf4a9129 LC |
8652 | As usual, some of the fields are mandatory---those shown in the example |
8653 | above---while others can be omitted. These are described below. | |
b81e1947 | 8654 | |
cf4a9129 LC |
8655 | @deftp {Data Type} file-system |
8656 | Objects of this type represent file systems to be mounted. They | |
8657 | contain the following members: | |
5ff3c4b8 | 8658 | |
cf4a9129 LC |
8659 | @table @asis |
8660 | @item @code{type} | |
8661 | This is a string specifying the type of the file system---e.g., | |
8662 | @code{"ext4"}. | |
5ff3c4b8 | 8663 | |
cf4a9129 LC |
8664 | @item @code{mount-point} |
8665 | This designates the place where the file system is to be mounted. | |
b81e1947 | 8666 | |
cf4a9129 LC |
8667 | @item @code{device} |
8668 | This names the ``source'' of the file system. By default it is the name | |
8669 | of a node under @file{/dev}, but its meaning depends on the @code{title} | |
8670 | field described below. | |
401c53c4 | 8671 | |
cf4a9129 LC |
8672 | @item @code{title} (default: @code{'device}) |
8673 | This is a symbol that specifies how the @code{device} field is to be | |
8674 | interpreted. | |
401c53c4 | 8675 | |
cf4a9129 LC |
8676 | When it is the symbol @code{device}, then the @code{device} field is |
8677 | interpreted as a file name; when it is @code{label}, then @code{device} | |
8678 | is interpreted as a partition label name; when it is @code{uuid}, | |
8679 | @code{device} is interpreted as a partition unique identifier (UUID). | |
da7cabd4 | 8680 | |
661a1d79 | 8681 | UUIDs may be converted from their string representation (as shown by the |
0767f6a6 LC |
8682 | @command{tune2fs -l} command) using the @code{uuid} form@footnote{The |
8683 | @code{uuid} form expects 16-byte UUIDs as defined in | |
8684 | @uref{https://tools.ietf.org/html/rfc4122, RFC@tie{}4122}. This is the | |
8685 | form of UUID used by the ext2 family of file systems and others, but it | |
8686 | is different from ``UUIDs'' found in FAT file systems, for instance.}, | |
8687 | like this: | |
661a1d79 LC |
8688 | |
8689 | @example | |
8690 | (file-system | |
8691 | (mount-point "/home") | |
8692 | (type "ext4") | |
8693 | (title 'uuid) | |
8694 | (device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb"))) | |
8695 | @end example | |
8696 | ||
cf4a9129 | 8697 | The @code{label} and @code{uuid} options offer a way to refer to disk |
661a1d79 LC |
8698 | partitions without having to hard-code their actual device |
8699 | name@footnote{Note that, while it is tempting to use | |
8700 | @file{/dev/disk/by-uuid} and similar device names to achieve the same | |
8701 | result, this is not recommended: These special device nodes are created | |
8702 | by the udev daemon and may be unavailable at the time the device is | |
8703 | mounted.}. | |
da7cabd4 | 8704 | |
1068f26b | 8705 | However, when the source of a file system is a mapped device (@pxref{Mapped |
5f86a66e LC |
8706 | Devices}), its @code{device} field @emph{must} refer to the mapped |
8707 | device name---e.g., @file{/dev/mapper/root-partition}---and consequently | |
8708 | @code{title} must be set to @code{'device}. This is required so that | |
8709 | the system knows that mounting the file system depends on having the | |
8710 | corresponding device mapping established. | |
8711 | ||
cf4a9129 LC |
8712 | @item @code{flags} (default: @code{'()}) |
8713 | This is a list of symbols denoting mount flags. Recognized flags | |
2c071ce9 LC |
8714 | include @code{read-only}, @code{bind-mount}, @code{no-dev} (disallow |
8715 | access to special files), @code{no-suid} (ignore setuid and setgid | |
8716 | bits), and @code{no-exec} (disallow program execution.) | |
da7cabd4 | 8717 | |
cf4a9129 LC |
8718 | @item @code{options} (default: @code{#f}) |
8719 | This is either @code{#f}, or a string denoting mount options. | |
da7cabd4 | 8720 | |
be21979d LC |
8721 | @item @code{mount?} (default: @code{#t}) |
8722 | This value indicates whether to automatically mount the file system when | |
8723 | the system is brought up. When set to @code{#f}, the file system gets | |
8724 | an entry in @file{/etc/fstab} (read by the @command{mount} command) but | |
8725 | is not automatically mounted. | |
8726 | ||
cf4a9129 LC |
8727 | @item @code{needed-for-boot?} (default: @code{#f}) |
8728 | This Boolean value indicates whether the file system is needed when | |
8729 | booting. If that is true, then the file system is mounted when the | |
8730 | initial RAM disk (initrd) is loaded. This is always the case, for | |
8731 | instance, for the root file system. | |
da7cabd4 | 8732 | |
cf4a9129 LC |
8733 | @item @code{check?} (default: @code{#t}) |
8734 | This Boolean indicates whether the file system needs to be checked for | |
8735 | errors before being mounted. | |
f9cc8971 | 8736 | |
4e469051 LC |
8737 | @item @code{create-mount-point?} (default: @code{#f}) |
8738 | When true, the mount point is created if it does not exist yet. | |
8739 | ||
e51710d1 | 8740 | @item @code{dependencies} (default: @code{'()}) |
13fb1bd9 LC |
8741 | This is a list of @code{<file-system>} or @code{<mapped-device>} objects |
8742 | representing file systems that must be mounted or mapped devices that | |
8743 | must be opened before (and unmounted or closed after) this one. | |
e51710d1 LC |
8744 | |
8745 | As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is | |
8746 | a dependency of @file{/sys/fs/cgroup/cpu} and | |
8747 | @file{/sys/fs/cgroup/memory}. | |
8748 | ||
13fb1bd9 LC |
8749 | Another example is a file system that depends on a mapped device, for |
8750 | example for an encrypted partition (@pxref{Mapped Devices}). | |
cf4a9129 LC |
8751 | @end table |
8752 | @end deftp | |
da7cabd4 | 8753 | |
a69576ea LC |
8754 | The @code{(gnu system file-systems)} exports the following useful |
8755 | variables. | |
8756 | ||
8757 | @defvr {Scheme Variable} %base-file-systems | |
8758 | These are essential file systems that are required on normal systems, | |
cc0e575a | 8759 | such as @var{%pseudo-terminal-file-system} and @var{%immutable-store} (see |
3392ce5d LC |
8760 | below.) Operating system declarations should always contain at least |
8761 | these. | |
a69576ea LC |
8762 | @end defvr |
8763 | ||
7f239fd3 LC |
8764 | @defvr {Scheme Variable} %pseudo-terminal-file-system |
8765 | This is the file system to be mounted as @file{/dev/pts}. It supports | |
8766 | @dfn{pseudo-terminals} created @i{via} @code{openpty} and similar | |
8767 | functions (@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference | |
8768 | Manual}). Pseudo-terminals are used by terminal emulators such as | |
8769 | @command{xterm}. | |
8770 | @end defvr | |
8771 | ||
db17ae5c LC |
8772 | @defvr {Scheme Variable} %shared-memory-file-system |
8773 | This file system is mounted as @file{/dev/shm} and is used to support | |
8774 | memory sharing across processes (@pxref{Memory-mapped I/O, | |
8775 | @code{shm_open},, libc, The GNU C Library Reference Manual}). | |
8776 | @end defvr | |
8777 | ||
3392ce5d LC |
8778 | @defvr {Scheme Variable} %immutable-store |
8779 | This file system performs a read-only ``bind mount'' of | |
8780 | @file{/gnu/store}, making it read-only for all the users including | |
8781 | @code{root}. This prevents against accidental modification by software | |
8782 | running as @code{root} or by system administrators. | |
8783 | ||
8784 | The daemon itself is still able to write to the store: it remounts it | |
8785 | read-write in its own ``name space.'' | |
8786 | @end defvr | |
8787 | ||
a69576ea LC |
8788 | @defvr {Scheme Variable} %binary-format-file-system |
8789 | The @code{binfmt_misc} file system, which allows handling of arbitrary | |
8790 | executable file types to be delegated to user space. This requires the | |
8791 | @code{binfmt.ko} kernel module to be loaded. | |
8792 | @end defvr | |
8793 | ||
8794 | @defvr {Scheme Variable} %fuse-control-file-system | |
8795 | The @code{fusectl} file system, which allows unprivileged users to mount | |
8796 | and unmount user-space FUSE file systems. This requires the | |
8797 | @code{fuse.ko} kernel module to be loaded. | |
8798 | @end defvr | |
8799 | ||
510f9d86 LC |
8800 | @node Mapped Devices |
8801 | @subsection Mapped Devices | |
8802 | ||
8803 | @cindex device mapping | |
8804 | @cindex mapped devices | |
8805 | The Linux kernel has a notion of @dfn{device mapping}: a block device, | |
8806 | such as a hard disk partition, can be @dfn{mapped} into another device, | |
97c8aef1 | 8807 | usually in @code{/dev/mapper/}, |
510f9d86 LC |
8808 | with additional processing over the data that flows through |
8809 | it@footnote{Note that the GNU@tie{}Hurd makes no difference between the | |
8810 | concept of a ``mapped device'' and that of a file system: both boil down | |
8811 | to @emph{translating} input/output operations made on a file to | |
8812 | operations on its backing store. Thus, the Hurd implements mapped | |
8813 | devices, like file systems, using the generic @dfn{translator} mechanism | |
8814 | (@pxref{Translators,,, hurd, The GNU Hurd Reference Manual}).}. A | |
8815 | typical example is encryption device mapping: all writes to the mapped | |
8816 | device are encrypted, and all reads are deciphered, transparently. | |
97c8aef1 AE |
8817 | Guix extends this notion by considering any device or set of devices that |
8818 | are @dfn{transformed} in some way to create a new device; for instance, | |
8819 | RAID devices are obtained by @dfn{assembling} several other devices, such | |
8820 | as hard disks or partitions, into a new one that behaves as one partition. | |
8821 | Other examples, not yet implemented, are LVM logical volumes. | |
510f9d86 | 8822 | |
97c8aef1 AE |
8823 | Mapped devices are declared using the @code{mapped-device} form, |
8824 | defined as follows; for examples, see below. | |
510f9d86 LC |
8825 | |
8826 | @deftp {Data Type} mapped-device | |
8827 | Objects of this type represent device mappings that will be made when | |
8828 | the system boots up. | |
8829 | ||
9cb426b8 LC |
8830 | @table @code |
8831 | @item source | |
97c8aef1 AE |
8832 | This is either a string specifying the name of the block device to be mapped, |
8833 | such as @code{"/dev/sda3"}, or a list of such strings when several devices | |
8834 | need to be assembled for creating a new one. | |
510f9d86 | 8835 | |
9cb426b8 | 8836 | @item target |
97c8aef1 AE |
8837 | This string specifies the name of the resulting mapped device. For |
8838 | kernel mappers such as encrypted devices of type @code{luks-device-mapping}, | |
8839 | specifying @code{"my-partition"} leads to the creation of | |
510f9d86 | 8840 | the @code{"/dev/mapper/my-partition"} device. |
97c8aef1 AE |
8841 | For RAID devices of type @code{raid-device-mapping}, the full device name |
8842 | such as @code{"/dev/md0"} needs to be given. | |
510f9d86 | 8843 | |
9cb426b8 | 8844 | @item type |
510f9d86 LC |
8845 | This must be a @code{mapped-device-kind} object, which specifies how |
8846 | @var{source} is mapped to @var{target}. | |
8847 | @end table | |
8848 | @end deftp | |
8849 | ||
8850 | @defvr {Scheme Variable} luks-device-mapping | |
8851 | This defines LUKS block device encryption using the @command{cryptsetup} | |
1068f26b | 8852 | command from the package with the same name. It relies on the |
510f9d86 LC |
8853 | @code{dm-crypt} Linux kernel module. |
8854 | @end defvr | |
8855 | ||
97c8aef1 AE |
8856 | @defvr {Scheme Variable} raid-device-mapping |
8857 | This defines a RAID device, which is assembled using the @code{mdadm} | |
8858 | command from the package with the same name. It requires a Linux kernel | |
8859 | module for the appropriate RAID level to be loaded, such as @code{raid456} | |
8860 | for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10. | |
8861 | @end defvr | |
8862 | ||
8863 | @cindex disk encryption | |
8864 | @cindex LUKS | |
8865 | The following example specifies a mapping from @file{/dev/sda3} to | |
8866 | @file{/dev/mapper/home} using LUKS---the | |
ddf1cd51 | 8867 | @url{https://gitlab.com/cryptsetup/cryptsetup,Linux Unified Key Setup}, a |
97c8aef1 AE |
8868 | standard mechanism for disk encryption. |
8869 | The @file{/dev/mapper/home} | |
8870 | device can then be used as the @code{device} of a @code{file-system} | |
8871 | declaration (@pxref{File Systems}). | |
8872 | ||
8873 | @example | |
8874 | (mapped-device | |
8875 | (source "/dev/sda3") | |
8876 | (target "home") | |
8877 | (type luks-device-mapping)) | |
8878 | @end example | |
8879 | ||
8880 | Alternatively, to become independent of device numbering, one may obtain | |
8881 | the LUKS UUID (@dfn{unique identifier}) of the source device by a | |
8882 | command like: | |
8883 | ||
8884 | @example | |
8885 | cryptsetup luksUUID /dev/sda3 | |
8886 | @end example | |
8887 | ||
8888 | and use it as follows: | |
8889 | ||
8890 | @example | |
8891 | (mapped-device | |
8892 | (source (uuid "cb67fc72-0d54-4c88-9d4b-b225f30b0f44")) | |
8893 | (target "home") | |
8894 | (type luks-device-mapping)) | |
8895 | @end example | |
8896 | ||
a4ca4362 CM |
8897 | @cindex swap encryption |
8898 | It is also desirable to encrypt swap space, since swap space may contain | |
8899 | sensitive data. One way to accomplish that is to use a swap file in a | |
8900 | file system on a device mapped via LUKS encryption. In this way, the | |
8901 | swap file is encrypted because the entire device is encrypted. | |
8902 | @xref{Preparing for Installation,,Disk Partitioning}, for an example. | |
8903 | ||
97c8aef1 AE |
8904 | A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} |
8905 | may be declared as follows: | |
8906 | ||
8907 | @example | |
8908 | (mapped-device | |
8909 | (source (list "/dev/sda1" "/dev/sdb1")) | |
8910 | (target "/dev/md0") | |
8911 | (type raid-device-mapping)) | |
8912 | @end example | |
8913 | ||
8914 | The @file{/dev/md0} device can then be used as the @code{device} of a | |
8915 | @code{file-system} declaration (@pxref{File Systems}). | |
8916 | Note that the RAID level need not be given; it is chosen during the | |
8917 | initial creation and formatting of the RAID device and is determined | |
8918 | automatically later. | |
8919 | ||
8920 | ||
cf4a9129 LC |
8921 | @node User Accounts |
8922 | @subsection User Accounts | |
ee85f3db | 8923 | |
e32171ee JD |
8924 | @cindex users |
8925 | @cindex accounts | |
8926 | @cindex user accounts | |
9bea87a5 LC |
8927 | User accounts and groups are entirely managed through the |
8928 | @code{operating-system} declaration. They are specified with the | |
8929 | @code{user-account} and @code{user-group} forms: | |
ee85f3db | 8930 | |
cf4a9129 LC |
8931 | @example |
8932 | (user-account | |
8933 | (name "alice") | |
8934 | (group "users") | |
24e752c0 LC |
8935 | (supplementary-groups '("wheel" ;allow use of sudo, etc. |
8936 | "audio" ;sound card | |
8937 | "video" ;video devices such as webcams | |
8938 | "cdrom")) ;the good ol' CD-ROM | |
cf4a9129 LC |
8939 | (comment "Bob's sister") |
8940 | (home-directory "/home/alice")) | |
8941 | @end example | |
25083588 | 8942 | |
9bea87a5 LC |
8943 | When booting or upon completion of @command{guix system reconfigure}, |
8944 | the system ensures that only the user accounts and groups specified in | |
8945 | the @code{operating-system} declaration exist, and with the specified | |
8946 | properties. Thus, account or group creations or modifications made by | |
8947 | directly invoking commands such as @command{useradd} are lost upon | |
8948 | reconfiguration or reboot. This ensures that the system remains exactly | |
8949 | as declared. | |
8950 | ||
cf4a9129 LC |
8951 | @deftp {Data Type} user-account |
8952 | Objects of this type represent user accounts. The following members may | |
8953 | be specified: | |
ee85f3db | 8954 | |
cf4a9129 LC |
8955 | @table @asis |
8956 | @item @code{name} | |
8957 | The name of the user account. | |
ee85f3db | 8958 | |
cf4a9129 | 8959 | @item @code{group} |
e32171ee | 8960 | @cindex groups |
cf4a9129 LC |
8961 | This is the name (a string) or identifier (a number) of the user group |
8962 | this account belongs to. | |
ee85f3db | 8963 | |
cf4a9129 LC |
8964 | @item @code{supplementary-groups} (default: @code{'()}) |
8965 | Optionally, this can be defined as a list of group names that this | |
8966 | account belongs to. | |
ee85f3db | 8967 | |
cf4a9129 LC |
8968 | @item @code{uid} (default: @code{#f}) |
8969 | This is the user ID for this account (a number), or @code{#f}. In the | |
8970 | latter case, a number is automatically chosen by the system when the | |
8971 | account is created. | |
ee85f3db | 8972 | |
cf4a9129 | 8973 | @item @code{comment} (default: @code{""}) |
1068f26b | 8974 | A comment about the account, such as the account owner's full name. |
c8c871d1 | 8975 | |
cf4a9129 LC |
8976 | @item @code{home-directory} |
8977 | This is the name of the home directory for the account. | |
ee85f3db | 8978 | |
eb56ee02 LC |
8979 | @item @code{create-home-directory?} (default: @code{#t}) |
8980 | Indicates whether the home directory of this account should be created | |
8981 | if it does not exist yet. | |
8982 | ||
cf4a9129 LC |
8983 | @item @code{shell} (default: Bash) |
8984 | This is a G-expression denoting the file name of a program to be used as | |
8985 | the shell (@pxref{G-Expressions}). | |
ee85f3db | 8986 | |
cf4a9129 LC |
8987 | @item @code{system?} (default: @code{#f}) |
8988 | This Boolean value indicates whether the account is a ``system'' | |
8989 | account. System accounts are sometimes treated specially; for instance, | |
8990 | graphical login managers do not list them. | |
ee85f3db | 8991 | |
1bd4e6db | 8992 | @anchor{user-account-password} |
cf4a9129 | 8993 | @item @code{password} (default: @code{#f}) |
eb59595c LC |
8994 | You would normally leave this field to @code{#f}, initialize user |
8995 | passwords as @code{root} with the @command{passwd} command, and then let | |
9bea87a5 LC |
8996 | users change it with @command{passwd}. Passwords set with |
8997 | @command{passwd} are of course preserved across reboot and | |
8998 | reconfiguration. | |
eb59595c LC |
8999 | |
9000 | If you @emph{do} want to have a preset password for an account, then | |
9001 | this field must contain the encrypted password, as a string. | |
5d1f1177 LC |
9002 | @xref{crypt,,, libc, The GNU C Library Reference Manual}, for more information |
9003 | on password encryption, and @ref{Encryption,,, guile, GNU Guile Reference | |
eb59595c | 9004 | Manual}, for information on Guile's @code{crypt} procedure. |
c8c871d1 | 9005 | |
cf4a9129 LC |
9006 | @end table |
9007 | @end deftp | |
ee85f3db | 9008 | |
e32171ee | 9009 | @cindex groups |
cf4a9129 | 9010 | User group declarations are even simpler: |
ee85f3db | 9011 | |
cf4a9129 LC |
9012 | @example |
9013 | (user-group (name "students")) | |
9014 | @end example | |
ee85f3db | 9015 | |
cf4a9129 LC |
9016 | @deftp {Data Type} user-group |
9017 | This type is for, well, user groups. There are just a few fields: | |
af8a56b8 | 9018 | |
cf4a9129 LC |
9019 | @table @asis |
9020 | @item @code{name} | |
1068f26b | 9021 | The name of the group. |
ee85f3db | 9022 | |
cf4a9129 LC |
9023 | @item @code{id} (default: @code{#f}) |
9024 | The group identifier (a number). If @code{#f}, a new number is | |
9025 | automatically allocated when the group is created. | |
ee85f3db | 9026 | |
c8fa3426 LC |
9027 | @item @code{system?} (default: @code{#f}) |
9028 | This Boolean value indicates whether the group is a ``system'' group. | |
9029 | System groups have low numerical IDs. | |
9030 | ||
cf4a9129 LC |
9031 | @item @code{password} (default: @code{#f}) |
9032 | What, user groups can have a password? Well, apparently yes. Unless | |
1068f26b | 9033 | @code{#f}, this field specifies the password of the group. |
ee85f3db | 9034 | |
cf4a9129 LC |
9035 | @end table |
9036 | @end deftp | |
401c53c4 | 9037 | |
cf4a9129 LC |
9038 | For convenience, a variable lists all the basic user groups one may |
9039 | expect: | |
401c53c4 | 9040 | |
cf4a9129 LC |
9041 | @defvr {Scheme Variable} %base-groups |
9042 | This is the list of basic user groups that users and/or packages expect | |
9043 | to be present on the system. This includes groups such as ``root'', | |
9044 | ``wheel'', and ``users'', as well as groups used to control access to | |
9045 | specific devices such as ``audio'', ``disk'', and ``cdrom''. | |
9046 | @end defvr | |
401c53c4 | 9047 | |
bf87f38a LC |
9048 | @defvr {Scheme Variable} %base-user-accounts |
9049 | This is the list of basic system accounts that programs may expect to | |
9050 | find on a GNU/Linux system, such as the ``nobody'' account. | |
9051 | ||
9052 | Note that the ``root'' account is not included here. It is a | |
9053 | special-case and is automatically added whether or not it is specified. | |
9054 | @end defvr | |
9055 | ||
598e19dc LC |
9056 | @node Locales |
9057 | @subsection Locales | |
9058 | ||
9059 | @cindex locale | |
9060 | A @dfn{locale} defines cultural conventions for a particular language | |
9061 | and region of the world (@pxref{Locales,,, libc, The GNU C Library | |
9062 | Reference Manual}). Each locale has a name that typically has the form | |
b2636518 | 9063 | @code{@var{language}_@var{territory}.@var{codeset}}---e.g., |
598e19dc LC |
9064 | @code{fr_LU.utf8} designates the locale for the French language, with |
9065 | cultural conventions from Luxembourg, and using the UTF-8 encoding. | |
9066 | ||
9067 | @cindex locale definition | |
9068 | Usually, you will want to specify the default locale for the machine | |
9069 | using the @code{locale} field of the @code{operating-system} declaration | |
9070 | (@pxref{operating-system Reference, @code{locale}}). | |
9071 | ||
f5582b2c LC |
9072 | The selected locale is automatically added to the @dfn{locale |
9073 | definitions} known to the system if needed, with its codeset inferred | |
9074 | from its name---e.g., @code{bo_CN.utf8} will be assumed to use the | |
9075 | @code{UTF-8} codeset. Additional locale definitions can be specified in | |
9076 | the @code{locale-definitions} slot of @code{operating-system}---this is | |
9077 | useful, for instance, if the codeset could not be inferred from the | |
9078 | locale name. The default set of locale definitions includes some widely | |
9079 | used locales, but not all the available locales, in order to save space. | |
9080 | ||
9081 | For instance, to add the North Frisian locale for Germany, the value of | |
9082 | that field may be: | |
598e19dc LC |
9083 | |
9084 | @example | |
9085 | (cons (locale-definition | |
9086 | (name "fy_DE.utf8") (source "fy_DE")) | |
9087 | %default-locale-definitions) | |
9088 | @end example | |
9089 | ||
9090 | Likewise, to save space, one might want @code{locale-definitions} to | |
9091 | list only the locales that are actually used, as in: | |
9092 | ||
9093 | @example | |
9094 | (list (locale-definition | |
9095 | (name "ja_JP.eucjp") (source "ja_JP") | |
9096 | (charset "EUC-JP"))) | |
9097 | @end example | |
9098 | ||
5c3c1427 LC |
9099 | @vindex LOCPATH |
9100 | The compiled locale definitions are available at | |
46bd6edd LC |
9101 | @file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc |
9102 | version, which is the default location where the GNU@tie{}libc provided | |
9103 | by Guix looks for locale data. This can be overridden using the | |
9104 | @code{LOCPATH} environment variable (@pxref{locales-and-locpath, | |
5c3c1427 LC |
9105 | @code{LOCPATH} and locale packages}). |
9106 | ||
598e19dc LC |
9107 | The @code{locale-definition} form is provided by the @code{(gnu system |
9108 | locale)} module. Details are given below. | |
9109 | ||
9110 | @deftp {Data Type} locale-definition | |
9111 | This is the data type of a locale definition. | |
9112 | ||
9113 | @table @asis | |
9114 | ||
9115 | @item @code{name} | |
9116 | The name of the locale. @xref{Locale Names,,, libc, The GNU C Library | |
9117 | Reference Manual}, for more information on locale names. | |
9118 | ||
9119 | @item @code{source} | |
9120 | The name of the source for that locale. This is typically the | |
9121 | @code{@var{language}_@var{territory}} part of the locale name. | |
9122 | ||
9123 | @item @code{charset} (default: @code{"UTF-8"}) | |
9124 | The ``character set'' or ``code set'' for that locale, | |
9125 | @uref{http://www.iana.org/assignments/character-sets, as defined by | |
9126 | IANA}. | |
9127 | ||
9128 | @end table | |
9129 | @end deftp | |
9130 | ||
9131 | @defvr {Scheme Variable} %default-locale-definitions | |
1068f26b | 9132 | A list of commonly used UTF-8 locales, used as the default |
b2636518 | 9133 | value of the @code{locale-definitions} field of @code{operating-system} |
598e19dc | 9134 | declarations. |
b2636518 LC |
9135 | |
9136 | @cindex locale name | |
9137 | @cindex normalized codeset in locale names | |
9138 | These locale definitions use the @dfn{normalized codeset} for the part | |
9139 | that follows the dot in the name (@pxref{Using gettextized software, | |
9140 | normalized codeset,, libc, The GNU C Library Reference Manual}). So for | |
9141 | instance it has @code{uk_UA.utf8} but @emph{not}, say, | |
9142 | @code{uk_UA.UTF-8}. | |
598e19dc | 9143 | @end defvr |
401c53c4 | 9144 | |
34760ae7 LC |
9145 | @subsubsection Locale Data Compatibility Considerations |
9146 | ||
9147 | @cindex incompatibility, of locale data | |
9148 | @code{operating-system} declarations provide a @code{locale-libcs} field | |
9149 | to specify the GNU@tie{}libc packages that are used to compile locale | |
9150 | declarations (@pxref{operating-system Reference}). ``Why would I | |
9151 | care?'', you may ask. Well, it turns out that the binary format of | |
9152 | locale data is occasionally incompatible from one libc version to | |
9153 | another. | |
9154 | ||
9155 | @c See <https://sourceware.org/ml/libc-alpha/2015-09/msg00575.html> | |
9156 | @c and <https://lists.gnu.org/archive/html/guix-devel/2015-08/msg00737.html>. | |
9157 | For instance, a program linked against libc version 2.21 is unable to | |
9158 | read locale data produced with libc 2.22; worse, that program | |
9159 | @emph{aborts} instead of simply ignoring the incompatible locale | |
9160 | data@footnote{Versions 2.23 and later of GNU@tie{}libc will simply skip | |
9161 | the incompatible locale data, which is already an improvement.}. | |
9162 | Similarly, a program linked against libc 2.22 can read most, but not | |
201fff9e | 9163 | all, of the locale data from libc 2.21 (specifically, @code{LC_COLLATE} |
34760ae7 LC |
9164 | data is incompatible); thus calls to @code{setlocale} may fail, but |
9165 | programs will not abort. | |
9166 | ||
9167 | The ``problem'' in GuixSD is that users have a lot of freedom: They can | |
9168 | choose whether and when to upgrade software in their profiles, and might | |
9169 | be using a libc version different from the one the system administrator | |
9170 | used to build the system-wide locale data. | |
9171 | ||
9172 | Fortunately, unprivileged users can also install their own locale data | |
9173 | and define @var{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, | |
9174 | @code{GUIX_LOCPATH} and locale packages}). | |
9175 | ||
9176 | Still, it is best if the system-wide locale data at | |
9177 | @file{/run/current-system/locale} is built for all the libc versions | |
9178 | actually in use on the system, so that all the programs can access | |
9179 | it---this is especially crucial on a multi-user system. To do that, the | |
9180 | administrator can specify several libc packages in the | |
9181 | @code{locale-libcs} field of @code{operating-system}: | |
9182 | ||
9183 | @example | |
9184 | (use-package-modules base) | |
9185 | ||
9186 | (operating-system | |
9187 | ;; @dots{} | |
9188 | (locale-libcs (list glibc-2.21 (canonical-package glibc)))) | |
9189 | @end example | |
9190 | ||
9191 | This example would lead to a system containing locale definitions for | |
9192 | both libc 2.21 and the current version of libc in | |
9193 | @file{/run/current-system/locale}. | |
9194 | ||
9195 | ||
cf4a9129 LC |
9196 | @node Services |
9197 | @subsection Services | |
401c53c4 | 9198 | |
cf4a9129 LC |
9199 | @cindex system services |
9200 | An important part of preparing an @code{operating-system} declaration is | |
9201 | listing @dfn{system services} and their configuration (@pxref{Using the | |
9202 | Configuration System}). System services are typically daemons launched | |
9203 | when the system boots, or other actions needed at that time---e.g., | |
d8b94dbd LC |
9204 | configuring network access. |
9205 | ||
e8b652d4 LC |
9206 | GuixSD has a broad definition of ``service'' (@pxref{Service |
9207 | Composition}), but many services are managed by the GNU@tie{}Shepherd | |
9208 | (@pxref{Shepherd Services}). On a running system, the @command{herd} | |
9209 | command allows you to list the available services, show their status, | |
9210 | start and stop them, or do other specific operations (@pxref{Jump | |
9211 | Start,,, shepherd, The GNU Shepherd Manual}). For example: | |
d8b94dbd LC |
9212 | |
9213 | @example | |
dd17bc38 | 9214 | # herd status |
d8b94dbd LC |
9215 | @end example |
9216 | ||
9217 | The above command, run as @code{root}, lists the currently defined | |
dd17bc38 | 9218 | services. The @command{herd doc} command shows a synopsis of the given |
d8b94dbd LC |
9219 | service: |
9220 | ||
9221 | @example | |
dd17bc38 | 9222 | # herd doc nscd |
d8b94dbd LC |
9223 | Run libc's name service cache daemon (nscd). |
9224 | @end example | |
9225 | ||
9226 | The @command{start}, @command{stop}, and @command{restart} sub-commands | |
9227 | have the effect you would expect. For instance, the commands below stop | |
9228 | the nscd service and restart the Xorg display server: | |
9229 | ||
9230 | @example | |
dd17bc38 | 9231 | # herd stop nscd |
d8b94dbd | 9232 | Service nscd has been stopped. |
dd17bc38 | 9233 | # herd restart xorg-server |
d8b94dbd LC |
9234 | Service xorg-server has been stopped. |
9235 | Service xorg-server has been started. | |
9236 | @end example | |
401c53c4 | 9237 | |
cf4a9129 | 9238 | The following sections document the available services, starting with |
d8b94dbd LC |
9239 | the core services, that may be used in an @code{operating-system} |
9240 | declaration. | |
401c53c4 | 9241 | |
cf4a9129 LC |
9242 | @menu |
9243 | * Base Services:: Essential system services. | |
c311089b | 9244 | * Scheduled Job Execution:: The mcron service. |
92c03a87 | 9245 | * Log Rotation:: The rottlog service. |
cf4a9129 LC |
9246 | * Networking Services:: Network setup, SSH daemon, etc. |
9247 | * X Window:: Graphical display. | |
f2ec23d1 | 9248 | * Printing Services:: Local and remote printer support. |
fe1a39d3 | 9249 | * Desktop Services:: D-Bus and desktop services. |
065225a4 | 9250 | * Database Services:: SQL databases, key-value stores, etc. |
d8c18af8 | 9251 | * Mail Services:: IMAP, POP3, SMTP, and all that. |
78cef99b | 9252 | * Messaging Services:: Messaging services. |
730ed6ec | 9253 | * Monitoring Services:: Monitoring services. |
859e367d | 9254 | * Kerberos Services:: Kerberos services. |
58724c48 | 9255 | * Web Services:: Web servers. |
ba69e8f7 | 9256 | * DNS Services:: DNS daemons. |
2be1b471 | 9257 | * VPN Services:: VPN daemons. |
eb419bc9 | 9258 | * Network File System:: NFS related services. |
a7cf4eb6 | 9259 | * Continuous Integration:: The Cuirass service. |
bfbf6e1e | 9260 | * Power management Services:: The TLP tool. |
06465d2b | 9261 | * Audio Services:: The MPD. |
e6051057 | 9262 | * Virtualization Services:: Virtualization services. |
dbc6d370 | 9263 | * Miscellaneous Services:: Other services. |
cf4a9129 | 9264 | @end menu |
401c53c4 | 9265 | |
cf4a9129 LC |
9266 | @node Base Services |
9267 | @subsubsection Base Services | |
a1ba8475 | 9268 | |
cf4a9129 LC |
9269 | The @code{(gnu services base)} module provides definitions for the basic |
9270 | services that one expects from the system. The services exported by | |
9271 | this module are listed below. | |
401c53c4 | 9272 | |
cf4a9129 | 9273 | @defvr {Scheme Variable} %base-services |
31771497 LC |
9274 | This variable contains a list of basic services (@pxref{Service Types |
9275 | and Services}, for more information on service objects) one would | |
cf4a9129 | 9276 | expect from the system: a login service (mingetty) on each tty, syslogd, |
1068f26b | 9277 | the libc name service cache daemon (nscd), the udev device manager, and |
cf4a9129 | 9278 | more. |
401c53c4 | 9279 | |
cf4a9129 LC |
9280 | This is the default value of the @code{services} field of |
9281 | @code{operating-system} declarations. Usually, when customizing a | |
9282 | system, you will want to append services to @var{%base-services}, like | |
9283 | this: | |
401c53c4 | 9284 | |
cf4a9129 | 9285 | @example |
fa1e31b8 | 9286 | (cons* (avahi-service) (lsh-service) %base-services) |
cf4a9129 LC |
9287 | @end example |
9288 | @end defvr | |
401c53c4 | 9289 | |
387e1754 LC |
9290 | @defvr {Scheme Variable} special-files-service-type |
9291 | This is the service that sets up ``special files'' such as | |
9292 | @file{/bin/sh}; an instance of it is part of @code{%base-services}. | |
9293 | ||
9294 | The value associated with @code{special-files-service-type} services | |
9295 | must be a list of tuples where the first element is the ``special file'' | |
9296 | and the second element is its target. By default it is: | |
9297 | ||
9298 | @cindex @file{/bin/sh} | |
9299 | @cindex @file{sh}, in @file{/bin} | |
9300 | @example | |
9301 | `(("/bin/sh" ,(file-append @var{bash} "/bin/sh"))) | |
9302 | @end example | |
9303 | ||
9304 | @cindex @file{/usr/bin/env} | |
9305 | @cindex @file{env}, in @file{/usr/bin} | |
9306 | If you want to add, say, @code{/usr/bin/env} to your system, you can | |
9307 | change it to: | |
9308 | ||
9309 | @example | |
9310 | `(("/bin/sh" ,(file-append @var{bash} "/bin/sh")) | |
9311 | ("/usr/bin/env" ,(file-append @var{coreutils} "/bin/env"))) | |
9312 | @end example | |
9313 | ||
9314 | Since this is part of @code{%base-services}, you can use | |
9315 | @code{modify-services} to customize the set of special files | |
9316 | (@pxref{Service Reference, @code{modify-services}}). But the simple way | |
9317 | to add a special file is @i{via} the @code{extra-special-file} procedure | |
9318 | (see below.) | |
9319 | @end defvr | |
9320 | ||
9321 | @deffn {Scheme Procedure} extra-special-file @var{file} @var{target} | |
9322 | Use @var{target} as the ``special file'' @var{file}. | |
9323 | ||
9324 | For example, adding the following lines to the @code{services} field of | |
9325 | your operating system declaration leads to a @file{/usr/bin/env} | |
9326 | symlink: | |
9327 | ||
9328 | @example | |
9329 | (extra-special-file "/usr/bin/env" | |
9330 | (file-append coreutils "/bin/env")) | |
9331 | @end example | |
9332 | @end deffn | |
9333 | ||
be1c2c54 | 9334 | @deffn {Scheme Procedure} host-name-service @var{name} |
cf4a9129 LC |
9335 | Return a service that sets the host name to @var{name}. |
9336 | @end deffn | |
401c53c4 | 9337 | |
317d3b47 DC |
9338 | @deffn {Scheme Procedure} login-service @var{config} |
9339 | Return a service to run login according to @var{config}, a | |
9340 | @code{<login-configuration>} object, which specifies the message of the day, | |
9341 | among other things. | |
9342 | @end deffn | |
9343 | ||
9344 | @deftp {Data Type} login-configuration | |
9345 | This is the data type representing the configuration of login. | |
9346 | ||
9347 | @table @asis | |
9348 | ||
9349 | @item @code{motd} | |
e32171ee | 9350 | @cindex message of the day |
317d3b47 DC |
9351 | A file-like object containing the ``message of the day''. |
9352 | ||
9353 | @item @code{allow-empty-passwords?} (default: @code{#t}) | |
9354 | Allow empty passwords by default so that first-time users can log in when | |
9355 | the 'root' account has just been created. | |
9356 | ||
9357 | @end table | |
9358 | @end deftp | |
9359 | ||
66e4f01c LC |
9360 | @deffn {Scheme Procedure} mingetty-service @var{config} |
9361 | Return a service to run mingetty according to @var{config}, a | |
9362 | @code{<mingetty-configuration>} object, which specifies the tty to run, among | |
9363 | other things. | |
cf4a9129 | 9364 | @end deffn |
401c53c4 | 9365 | |
66e4f01c LC |
9366 | @deftp {Data Type} mingetty-configuration |
9367 | This is the data type representing the configuration of Mingetty, which | |
9ee4c9ab | 9368 | provides the default implementation of virtual console log-in. |
66e4f01c LC |
9369 | |
9370 | @table @asis | |
9371 | ||
9372 | @item @code{tty} | |
9373 | The name of the console this Mingetty runs on---e.g., @code{"tty1"}. | |
9374 | ||
66e4f01c LC |
9375 | @item @code{auto-login} (default: @code{#f}) |
9376 | When true, this field must be a string denoting the user name under | |
f9b9a033 | 9377 | which the system automatically logs in. When it is @code{#f}, a |
66e4f01c LC |
9378 | user name and password must be entered to log in. |
9379 | ||
9380 | @item @code{login-program} (default: @code{#f}) | |
9381 | This must be either @code{#f}, in which case the default log-in program | |
9382 | is used (@command{login} from the Shadow tool suite), or a gexp denoting | |
9383 | the name of the log-in program. | |
9384 | ||
9385 | @item @code{login-pause?} (default: @code{#f}) | |
9386 | When set to @code{#t} in conjunction with @var{auto-login}, the user | |
9387 | will have to press a key before the log-in shell is launched. | |
9388 | ||
9389 | @item @code{mingetty} (default: @var{mingetty}) | |
9390 | The Mingetty package to use. | |
9391 | ||
9392 | @end table | |
9393 | @end deftp | |
9394 | ||
9ee4c9ab LF |
9395 | @deffn {Scheme Procedure} agetty-service @var{config} |
9396 | Return a service to run agetty according to @var{config}, an | |
9397 | @code{<agetty-configuration>} object, which specifies the tty to run, | |
9398 | among other things. | |
9399 | @end deffn | |
9400 | ||
9401 | @deftp {Data Type} agetty-configuration | |
9402 | This is the data type representing the configuration of agetty, which | |
9403 | implements virtual and serial console log-in. See the @code{agetty(8)} | |
9404 | man page for more information. | |
9405 | ||
9406 | @table @asis | |
9407 | ||
9408 | @item @code{tty} | |
9409 | The name of the console this agetty runs on, as a string---e.g., | |
9410 | @code{"ttyS0"}. This argument is mandatory. | |
9411 | ||
9412 | @item @code{baud-rate} (default: @code{#f}) | |
9413 | A string containing a comma-separated list of one or more baud rates, in | |
9414 | descending order. | |
9415 | ||
9416 | @item @code{term} (default: @code{#f}) | |
9417 | A string containing the value used for the @code{TERM} environment | |
9418 | variable. | |
9419 | ||
9420 | @item @code{eight-bits?} (default: @code{#f}) | |
9421 | When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection is | |
9422 | disabled. | |
9423 | ||
9424 | @item @code{auto-login} (default: @code{#f}) | |
9425 | When passed a login name, as a string, the specified user will be logged | |
9426 | in automatically without prompting for their login name or password. | |
9427 | ||
9428 | @item @code{no-reset?} (default: @code{#f}) | |
9429 | When @code{#t}, don't reset terminal cflags (control modes). | |
9430 | ||
9431 | @item @code{host} (default: @code{#f}) | |
9432 | This accepts a string containing the "login_host", which will be written | |
9433 | into the @file{/var/run/utmpx} file. | |
9434 | ||
9435 | @item @code{remote?} (default: @code{#f}) | |
9436 | When set to @code{#t} in conjunction with @var{host}, this will add an | |
9437 | @code{-r} fakehost option to the command line of the login program | |
9438 | specified in @var{login-program}. | |
9439 | ||
9440 | @item @code{flow-control?} (default: @code{#f}) | |
9441 | When set to @code{#t}, enable hardware (RTS/CTS) flow control. | |
9442 | ||
9443 | @item @code{no-issue?} (default: @code{#f}) | |
9444 | When set to @code{#t}, the contents of the @file{/etc/issue} file will | |
9445 | not be displayed before presenting the login prompt. | |
9446 | ||
9447 | @item @code{init-string} (default: @code{#f}) | |
9448 | This accepts a string that will be sent to the tty or modem before | |
9449 | sending anything else. It can be used to initialize a modem. | |
9450 | ||
9451 | @item @code{no-clear?} (default: @code{#f}) | |
9452 | When set to @code{#t}, agetty will not clear the screen before showing | |
9453 | the login prompt. | |
9454 | ||
9455 | @item @code{login-program} (default: (file-append shadow "/bin/login")) | |
9456 | This must be either a gexp denoting the name of a log-in program, or | |
9457 | unset, in which case the default value is the @command{login} from the | |
9458 | Shadow tool suite. | |
9459 | ||
9460 | @item @code{local-line} (default: @code{#f}) | |
9461 | Control the CLOCAL line flag. This accepts one of three symbols as | |
9462 | arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, | |
9463 | the default value chosen by agetty is @code{'auto}. | |
9464 | ||
9465 | @item @code{extract-baud?} (default: @code{#f}) | |
9466 | When set to @code{#t}, instruct agetty to try to extract the baud rate | |
9467 | from the status messages produced by certain types of modems. | |
9468 | ||
9469 | @item @code{skip-login?} (default: @code{#f}) | |
9470 | When set to @code{#t}, do not prompt the user for a login name. This | |
9471 | can be used with @var{login-program} field to use non-standard login | |
9472 | systems. | |
9473 | ||
9474 | @item @code{no-newline?} (default: @code{#f}) | |
9475 | When set to @code{#t}, do not print a newline before printing the | |
9476 | @file{/etc/issue} file. | |
9477 | ||
9478 | @c Is this dangerous only when used with login-program, or always? | |
9479 | @item @code{login-options} (default: @code{#f}) | |
9480 | This option accepts a string containing options that are passed to the | |
9481 | login program. When used with the @var{login-program}, be aware that a | |
9482 | malicious user could try to enter a login name containing embedded | |
9483 | options that could be parsed by the login program. | |
9484 | ||
9485 | @item @code{login-pause} (default: @code{#f}) | |
9486 | When set to @code{#t}, wait for any key before showing the login prompt. | |
9487 | This can be used in conjunction with @var{auto-login} to save memory by | |
9488 | lazily spawning shells. | |
9489 | ||
9490 | @item @code{chroot} (default: @code{#f}) | |
9491 | Change root to the specified directory. This option accepts a directory | |
9492 | path as a string. | |
9493 | ||
9494 | @item @code{hangup?} (default: @code{#f}) | |
9495 | Use the Linux system call @code{vhangup} to do a virtual hangup of the | |
9496 | specified terminal. | |
9497 | ||
9498 | @item @code{keep-baud?} (default: @code{#f}) | |
9499 | When set to @code{#t}, try to keep the existing baud rate. The baud | |
9500 | rates from @var{baud-rate} are used when agetty receives a @key{BREAK} | |
9501 | character. | |
9502 | ||
9503 | @item @code{timeout} (default: @code{#f}) | |
9504 | When set to an integer value, terminate if no user name could be read | |
9505 | within @var{timeout} seconds. | |
9506 | ||
9507 | @item @code{detect-case?} (default: @code{#f}) | |
9508 | When set to @code{#t}, turn on support for detecting an uppercase-only | |
9509 | terminal. This setting will detect a login name containing only | |
9510 | uppercase letters as indicating an uppercase-only terminal and turn on | |
9511 | some upper-to-lower case conversions. Note that this will not support | |
9512 | Unicode characters. | |
9513 | ||
9514 | @item @code{wait-cr?} (default: @code{#f}) | |
9515 | When set to @code{#t}, wait for the user or modem to send a | |
9516 | carriage-return or linefeed character before displaying | |
9517 | @file{/etc/issue} or login prompt. This is typically used with the | |
9518 | @var{init-string} option. | |
9519 | ||
9520 | @item @code{no-hints?} (default: @code{#f}) | |
9521 | When set to @code{#t}, do not print hints about Num, Caps, and Scroll | |
9522 | locks. | |
9523 | ||
9524 | @item @code{no-hostname?} (default: @code{#f}) | |
9525 | By default, the hostname is printed. When this option is set to | |
9526 | @code{#t}, no hostname will be shown at all. | |
9527 | ||
9528 | @item @code{long-hostname?} (default: @code{#f}) | |
9529 | By default, the hostname is only printed until the first dot. When this | |
9530 | option is set to @code{#t}, the fully qualified hostname by | |
9531 | @code{gethostname} or @code{getaddrinfo} is shown. | |
9532 | ||
9533 | @item @code{erase-characters} (default: @code{#f}) | |
9534 | This option accepts a string of additional characters that should be | |
9535 | interpreted as backspace when the user types their login name. | |
9536 | ||
9537 | @item @code{kill-characters} (default: @code{#f}) | |
9538 | This option accepts a string that should be interpreted to mean "ignore | |
9539 | all previous characters" (also called a "kill" character) when the types | |
9540 | their login name. | |
9541 | ||
9542 | @item @code{chdir} (default: @code{#f}) | |
9543 | This option accepts, as a string, a directory path that will be changed | |
9544 | to before login. | |
9545 | ||
9546 | @item @code{delay} (default: @code{#f}) | |
9547 | This options accepts, as an integer, the number of seconds to sleep | |
9548 | before opening the tty and displaying the login prompt. | |
9549 | ||
9550 | @item @code{nice} (default: @code{#f}) | |
9551 | This option accepts, as an integer, the nice value with which to run the | |
9552 | @command{login} program. | |
9553 | ||
9554 | @item @code{extra-options} (default: @code{'()}) | |
9555 | This option provides an "escape hatch" for the user to provide arbitrary | |
9556 | command-line arguments to @command{agetty} as a list of strings. | |
9557 | ||
9558 | @end table | |
9559 | @end deftp | |
9560 | ||
46ec2707 DC |
9561 | @deffn {Scheme Procedure} kmscon-service-type @var{config} |
9562 | Return a service to run @uref{https://www.freedesktop.org/wiki/Software/kmscon,kmscon} | |
9563 | according to @var{config}, a @code{<kmscon-configuration>} object, which | |
9564 | specifies the tty to run, among other things. | |
9565 | @end deffn | |
9566 | ||
9567 | @deftp {Data Type} kmscon-configuration | |
9568 | This is the data type representing the configuration of Kmscon, which | |
9ee4c9ab | 9569 | implements virtual console log-in. |
46ec2707 DC |
9570 | |
9571 | @table @asis | |
9572 | ||
9573 | @item @code{virtual-terminal} | |
9574 | The name of the console this Kmscon runs on---e.g., @code{"tty1"}. | |
9575 | ||
9576 | @item @code{login-program} (default: @code{#~(string-append #$shadow "/bin/login")}) | |
9577 | A gexp denoting the name of the log-in program. The default log-in program is | |
9578 | @command{login} from the Shadow tool suite. | |
9579 | ||
9580 | @item @code{login-arguments} (default: @code{'("-p")}) | |
9581 | A list of arguments to pass to @command{login}. | |
9582 | ||
9583 | @item @code{hardware-acceleration?} (default: #f) | |
9584 | Whether to use hardware acceleration. | |
9585 | ||
9586 | @item @code{kmscon} (default: @var{kmscon}) | |
9587 | The Kmscon package to use. | |
9588 | ||
9589 | @end table | |
9590 | @end deftp | |
9591 | ||
6454b333 LC |
9592 | @cindex name service cache daemon |
9593 | @cindex nscd | |
be1c2c54 | 9594 | @deffn {Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @ |
4aee6e60 | 9595 | [#:name-services '()] |
1068f26b | 9596 | Return a service that runs the libc name service cache daemon (nscd) with the |
b893f1ae LC |
9597 | given @var{config}---an @code{<nscd-configuration>} object. @xref{Name |
9598 | Service Switch}, for an example. | |
cf4a9129 | 9599 | @end deffn |
401c53c4 | 9600 | |
6454b333 LC |
9601 | @defvr {Scheme Variable} %nscd-default-configuration |
9602 | This is the default @code{<nscd-configuration>} value (see below) used | |
1068f26b | 9603 | by @code{nscd-service}. It uses the caches defined by |
6454b333 LC |
9604 | @var{%nscd-default-caches}; see below. |
9605 | @end defvr | |
9606 | ||
9607 | @deftp {Data Type} nscd-configuration | |
1068f26b | 9608 | This is the data type representing the name service cache daemon (nscd) |
6454b333 LC |
9609 | configuration. |
9610 | ||
9611 | @table @asis | |
9612 | ||
b893f1ae LC |
9613 | @item @code{name-services} (default: @code{'()}) |
9614 | List of packages denoting @dfn{name services} that must be visible to | |
9615 | the nscd---e.g., @code{(list @var{nss-mdns})}. | |
9616 | ||
9617 | @item @code{glibc} (default: @var{glibc}) | |
9618 | Package object denoting the GNU C Library providing the @command{nscd} | |
9619 | command. | |
9620 | ||
6454b333 | 9621 | @item @code{log-file} (default: @code{"/var/log/nscd.log"}) |
1068f26b | 9622 | Name of the nscd log file. This is where debugging output goes when |
6454b333 LC |
9623 | @code{debug-level} is strictly positive. |
9624 | ||
9625 | @item @code{debug-level} (default: @code{0}) | |
1068f26b | 9626 | Integer denoting the debugging levels. Higher numbers mean that more |
6454b333 LC |
9627 | debugging output is logged. |
9628 | ||
9629 | @item @code{caches} (default: @var{%nscd-default-caches}) | |
9630 | List of @code{<nscd-cache>} objects denoting things to be cached; see | |
9631 | below. | |
9632 | ||
9633 | @end table | |
9634 | @end deftp | |
9635 | ||
9636 | @deftp {Data Type} nscd-cache | |
9637 | Data type representing a cache database of nscd and its parameters. | |
9638 | ||
9639 | @table @asis | |
9640 | ||
9641 | @item @code{database} | |
9642 | This is a symbol representing the name of the database to be cached. | |
9643 | Valid values are @code{passwd}, @code{group}, @code{hosts}, and | |
9644 | @code{services}, which designate the corresponding NSS database | |
9645 | (@pxref{NSS Basics,,, libc, The GNU C Library Reference Manual}). | |
9646 | ||
9647 | @item @code{positive-time-to-live} | |
9648 | @itemx @code{negative-time-to-live} (default: @code{20}) | |
9649 | A number representing the number of seconds during which a positive or | |
9650 | negative lookup result remains in cache. | |
9651 | ||
9652 | @item @code{check-files?} (default: @code{#t}) | |
9653 | Whether to check for updates of the files corresponding to | |
9654 | @var{database}. | |
9655 | ||
9656 | For instance, when @var{database} is @code{hosts}, setting this flag | |
9657 | instructs nscd to check for updates in @file{/etc/hosts} and to take | |
9658 | them into account. | |
9659 | ||
9660 | @item @code{persistent?} (default: @code{#t}) | |
9661 | Whether the cache should be stored persistently on disk. | |
9662 | ||
9663 | @item @code{shared?} (default: @code{#t}) | |
9664 | Whether the cache should be shared among users. | |
9665 | ||
9666 | @item @code{max-database-size} (default: 32@tie{}MiB) | |
9667 | Maximum size in bytes of the database cache. | |
9668 | ||
9669 | @c XXX: 'suggested-size' and 'auto-propagate?' seem to be expert | |
9670 | @c settings, so leave them out. | |
9671 | ||
9672 | @end table | |
9673 | @end deftp | |
9674 | ||
9675 | @defvr {Scheme Variable} %nscd-default-caches | |
9676 | List of @code{<nscd-cache>} objects used by default by | |
1068f26b | 9677 | @code{nscd-configuration} (see above). |
6454b333 LC |
9678 | |
9679 | It enables persistent and aggressive caching of service and host name | |
9680 | lookups. The latter provides better host name lookup performance, | |
9681 | resilience in the face of unreliable name servers, and also better | |
9682 | privacy---often the result of host name lookups is in local cache, so | |
9683 | external name servers do not even need to be queried. | |
9684 | @end defvr | |
9685 | ||
ec2e2f6c | 9686 | @anchor{syslog-configuration-type} |
e32171ee JD |
9687 | @cindex syslog |
9688 | @cindex logging | |
ec2e2f6c DC |
9689 | @deftp {Data Type} syslog-configuration |
9690 | This data type represents the configuration of the syslog daemon. | |
6454b333 | 9691 | |
ec2e2f6c DC |
9692 | @table @asis |
9693 | @item @code{syslogd} (default: @code{#~(string-append #$inetutils "/libexec/syslogd")}) | |
9694 | The syslog daemon to use. | |
9695 | ||
9696 | @item @code{config-file} (default: @code{%default-syslog.conf}) | |
9697 | The syslog configuration file to use. | |
9698 | ||
9699 | @end table | |
9700 | @end deftp | |
9701 | ||
9702 | @anchor{syslog-service} | |
e32171ee | 9703 | @cindex syslog |
ec2e2f6c DC |
9704 | @deffn {Scheme Procedure} syslog-service @var{config} |
9705 | Return a service that runs a syslog daemon according to @var{config}. | |
44abcb28 LC |
9706 | |
9707 | @xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more | |
9708 | information on the configuration file syntax. | |
cf4a9129 | 9709 | @end deffn |
401c53c4 | 9710 | |
0adfe95a LC |
9711 | @anchor{guix-configuration-type} |
9712 | @deftp {Data Type} guix-configuration | |
9713 | This data type represents the configuration of the Guix build daemon. | |
9714 | @xref{Invoking guix-daemon}, for more information. | |
9715 | ||
9716 | @table @asis | |
9717 | @item @code{guix} (default: @var{guix}) | |
9718 | The Guix package to use. | |
401c53c4 | 9719 | |
0adfe95a LC |
9720 | @item @code{build-group} (default: @code{"guixbuild"}) |
9721 | Name of the group for build user accounts. | |
401c53c4 | 9722 | |
0adfe95a LC |
9723 | @item @code{build-accounts} (default: @code{10}) |
9724 | Number of build user accounts to create. | |
401c53c4 | 9725 | |
0adfe95a | 9726 | @item @code{authorize-key?} (default: @code{#t}) |
e32171ee | 9727 | @cindex substitutes, authorization thereof |
5b58c28b LC |
9728 | Whether to authorize the substitute keys listed in |
9729 | @code{authorized-keys}---by default that of @code{hydra.gnu.org} | |
0adfe95a LC |
9730 | (@pxref{Substitutes}). |
9731 | ||
5b58c28b LC |
9732 | @vindex %default-authorized-guix-keys |
9733 | @item @code{authorized-keys} (default: @var{%default-authorized-guix-keys}) | |
9734 | The list of authorized key files for archive imports, as a list of | |
9735 | string-valued gexps (@pxref{Invoking guix archive}). By default, it | |
9736 | contains that of @code{hydra.gnu.org} (@pxref{Substitutes}). | |
9737 | ||
0adfe95a LC |
9738 | @item @code{use-substitutes?} (default: @code{#t}) |
9739 | Whether to use substitutes. | |
9740 | ||
b0b9f6e0 LC |
9741 | @item @code{substitute-urls} (default: @var{%default-substitute-urls}) |
9742 | The list of URLs where to look for substitutes by default. | |
9743 | ||
3bee4b61 LC |
9744 | @item @code{max-silent-time} (default: @code{0}) |
9745 | @itemx @code{timeout} (default: @code{0}) | |
9746 | The number of seconds of silence and the number of seconds of activity, | |
9747 | respectively, after which a build process times out. A value of zero | |
9748 | disables the timeout. | |
9749 | ||
0adfe95a LC |
9750 | @item @code{extra-options} (default: @code{'()}) |
9751 | List of extra command-line options for @command{guix-daemon}. | |
9752 | ||
dc0ef095 LC |
9753 | @item @code{log-file} (default: @code{"/var/log/guix-daemon.log"}) |
9754 | File where @command{guix-daemon}'s standard output and standard error | |
9755 | are written. | |
9756 | ||
0adfe95a | 9757 | @item @code{lsof} (default: @var{lsof}) |
f78903f3 | 9758 | The lsof package to use. |
0adfe95a | 9759 | |
93d32da9 LF |
9760 | @item @code{http-proxy} (default: @code{#f}) |
9761 | The HTTP proxy used for downloading fixed-output derivations and | |
9762 | substitutes. | |
9763 | ||
b191f0a6 LF |
9764 | @item @code{tmpdir} (default: @code{#f}) |
9765 | A directory path where the @command{guix-daemon} will perform builds. | |
9766 | ||
0adfe95a LC |
9767 | @end table |
9768 | @end deftp | |
9769 | ||
9770 | @deffn {Scheme Procedure} guix-service @var{config} | |
9771 | Return a service that runs the Guix build daemon according to | |
9772 | @var{config}. | |
cf4a9129 | 9773 | @end deffn |
a1ba8475 | 9774 | |
be1c2c54 | 9775 | @deffn {Scheme Procedure} udev-service [#:udev udev] |
cf4a9129 LC |
9776 | Run @var{udev}, which populates the @file{/dev} directory dynamically. |
9777 | @end deffn | |
401c53c4 | 9778 | |
a535e122 LF |
9779 | @deffn {Scheme Procedure} urandom-seed-service @var{#f} |
9780 | Save some entropy in @var{%random-seed-file} to seed @file{/dev/urandom} | |
9781 | when rebooting. | |
9782 | @end deffn | |
9783 | ||
9784 | @defvr {Scheme Variable} %random-seed-file | |
9785 | This is the name of the file where some random bytes are saved by | |
9786 | @var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. | |
9787 | It defaults to @file{/var/lib/random-seed}. | |
9788 | @end defvr | |
9789 | ||
e32171ee JD |
9790 | @cindex keymap |
9791 | @cindex keyboard | |
b3d05f48 | 9792 | @deffn {Scheme Procedure} console-keymap-service @var{files} ... |
dedb8d5e | 9793 | @cindex keyboard layout |
b3d05f48 AK |
9794 | Return a service to load console keymaps from @var{files} using |
9795 | @command{loadkeys} command. Most likely, you want to load some default | |
9796 | keymap, which can be done like this: | |
9797 | ||
9798 | @example | |
9799 | (console-keymap-service "dvorak") | |
9800 | @end example | |
9801 | ||
9802 | Or, for example, for a Swedish keyboard, you may need to combine | |
9803 | the following keymaps: | |
9804 | @example | |
9805 | (console-keymap-service "se-lat6" "se-fi-lat6") | |
9806 | @end example | |
9807 | ||
9808 | Also you can specify a full file name (or file names) of your keymap(s). | |
9809 | See @code{man loadkeys} for details. | |
9810 | ||
5eca9459 AK |
9811 | @end deffn |
9812 | ||
e32171ee JD |
9813 | @cindex mouse |
9814 | @cindex gpm | |
1aaf116d | 9815 | @deffn {Scheme Procedure} gpm-service [#:gpm @var{gpm}] @ |
8664cc88 LC |
9816 | [#:options] |
9817 | Run @var{gpm}, the general-purpose mouse daemon, with the given | |
9818 | command-line @var{options}. GPM allows users to use the mouse in the console, | |
9819 | notably to select, copy, and paste text. The default value of @var{options} | |
9820 | uses the @code{ps2} protocol, which works for both USB and PS/2 mice. | |
9821 | ||
9822 | This service is not part of @var{%base-services}. | |
9823 | @end deffn | |
9824 | ||
f1e900a3 | 9825 | @anchor{guix-publish-service-type} |
3d3c5650 | 9826 | @deffn {Scheme Variable} guix-publish-service-type |
f1e900a3 | 9827 | This is the service type for @command{guix publish} (@pxref{Invoking |
3d3c5650 | 9828 | guix publish}). Its value must be a @code{guix-configuration} |
f1e900a3 | 9829 | object, as described below. |
1c52181f LC |
9830 | |
9831 | This assumes that @file{/etc/guix} already contains a signing key pair as | |
9832 | created by @command{guix archive --generate-key} (@pxref{Invoking guix | |
9833 | archive}). If that is not the case, the service will fail to start. | |
9834 | @end deffn | |
9835 | ||
f1e900a3 LC |
9836 | @deftp {Data Type} guix-publish-configuration |
9837 | Data type representing the configuration of the @code{guix publish} | |
9838 | service. | |
9839 | ||
9840 | @table @asis | |
9841 | @item @code{guix} (default: @code{guix}) | |
9842 | The Guix package to use. | |
9843 | ||
9844 | @item @code{port} (default: @code{80}) | |
9845 | The TCP port to listen for connections. | |
9846 | ||
9847 | @item @code{host} (default: @code{"localhost"}) | |
9848 | The host (and thus, network interface) to listen to. Use | |
9849 | @code{"0.0.0.0"} to listen on all the network interfaces. | |
697ddb88 LC |
9850 | |
9851 | @item @code{compression-level} (default: @code{3}) | |
9852 | The gzip compression level at which substitutes are compressed. Use | |
9853 | @code{0} to disable compression altogether, and @code{9} to get the best | |
9854 | compression ratio at the expense of increased CPU usage. | |
9855 | ||
9856 | @item @code{nar-path} (default: @code{"nar"}) | |
9857 | The URL path at which ``nars'' can be fetched. @xref{Invoking guix | |
9858 | publish, @code{--nar-path}}, for details. | |
a35136cb LC |
9859 | |
9860 | @item @code{cache} (default: @code{#f}) | |
9861 | When it is @code{#f}, disable caching and instead generate archives on | |
9862 | demand. Otherwise, this should be the name of a directory---e.g., | |
9863 | @code{"/var/cache/guix/publish"}---where @command{guix publish} caches | |
9864 | archives and meta-data ready to be sent. @xref{Invoking guix publish, | |
9865 | @option{--cache}}, for more information on the tradeoffs involved. | |
9866 | ||
9867 | @item @code{workers} (default: @code{#f}) | |
9868 | When it is an integer, this is the number of worker threads used for | |
9869 | caching; when @code{#f}, the number of processors is used. | |
9870 | @xref{Invoking guix publish, @option{--workers}}, for more information. | |
9871 | ||
9872 | @item @code{ttl} (default: @code{#f}) | |
9873 | When it is an integer, this denotes the @dfn{time-to-live} of the | |
9874 | published archives. @xref{Invoking guix publish, @option{--ttl}}, for | |
9875 | more information. | |
f1e900a3 LC |
9876 | @end table |
9877 | @end deftp | |
9878 | ||
b58cbf9a DC |
9879 | @anchor{rngd-service} |
9880 | @deffn {Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @ | |
9881 | [#:device "/dev/hwrng"] | |
9882 | Return a service that runs the @command{rngd} program from @var{rng-tools} | |
9883 | to add @var{device} to the kernel's entropy pool. The service will fail if | |
9884 | @var{device} does not exist. | |
9885 | @end deffn | |
a69576ea | 9886 | |
909147e4 RW |
9887 | @anchor{pam-limits-service} |
9888 | @cindex session limits | |
9889 | @cindex ulimit | |
9890 | @cindex priority | |
9891 | @deffn {Scheme Procedure} pam-limits-service [#:limits @var{limits}] | |
9892 | ||
9893 | Return a service that installs a configuration file for the | |
9894 | @uref{http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html, | |
9895 | @code{pam_limits} module}. The procedure optionally takes a list of | |
9896 | @code{pam-limits-entry} values, which can be used to specify | |
9897 | @code{ulimit} limits and nice priority limits to user sessions. | |
9898 | ||
9899 | The following limits definition sets two hard and soft limits for all | |
9900 | login sessions of users in the @code{realtime} group: | |
9901 | ||
9902 | @example | |
9903 | (pam-limits-service | |
9904 | (list | |
9905 | (pam-limits-entry "@@realtime" 'both 'rtprio 99) | |
9906 | (pam-limits-entry "@@realtime" 'both 'memlock 'unlimited))) | |
9907 | @end example | |
9908 | ||
9909 | The first entry increases the maximum realtime priority for | |
9910 | non-privileged processes; the second entry lifts any restriction of the | |
9911 | maximum address space that can be locked in memory. These settings are | |
9912 | commonly used for real-time audio systems. | |
9913 | @end deffn | |
9914 | ||
c311089b LC |
9915 | @node Scheduled Job Execution |
9916 | @subsubsection Scheduled Job Execution | |
9917 | ||
9918 | @cindex cron | |
e32171ee | 9919 | @cindex mcron |
c311089b LC |
9920 | @cindex scheduling jobs |
9921 | The @code{(gnu services mcron)} module provides an interface to | |
9922 | GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, | |
9923 | mcron, GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional | |
9924 | Unix @command{cron} daemon; the main difference is that it is | |
9925 | implemented in Guile Scheme, which provides a lot of flexibility when | |
9926 | specifying the scheduling of jobs and their actions. | |
9927 | ||
8ac6282c | 9928 | The example below defines an operating system that runs the |
c311089b | 9929 | @command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) |
8ac6282c LC |
9930 | and the @command{guix gc} commands (@pxref{Invoking guix gc}) daily, as |
9931 | well as the @command{mkid} command on behalf of an unprivileged user | |
9932 | (@pxref{mkid invocation,,, idutils, ID Database Utilities}). It uses | |
9933 | gexps to introduce job definitions that are passed to mcron | |
9934 | (@pxref{G-Expressions}). | |
c311089b LC |
9935 | |
9936 | @lisp | |
9937 | (use-modules (guix) (gnu) (gnu services mcron)) | |
8ac6282c | 9938 | (use-package-modules base idutils) |
c311089b LC |
9939 | |
9940 | (define updatedb-job | |
8ac6282c LC |
9941 | ;; Run 'updatedb' at 3AM every day. Here we write the |
9942 | ;; job's action as a Scheme procedure. | |
c311089b | 9943 | #~(job '(next-hour '(3)) |
8ac6282c LC |
9944 | (lambda () |
9945 | (execl (string-append #$findutils "/bin/updatedb") | |
9946 | "updatedb" | |
9947 | "--prunepaths=/tmp /var/tmp /gnu/store")))) | |
c311089b LC |
9948 | |
9949 | (define garbage-collector-job | |
9950 | ;; Collect garbage 5 minutes after midnight every day. | |
8ac6282c | 9951 | ;; The job's action is a shell command. |
c311089b LC |
9952 | #~(job "5 0 * * *" ;Vixie cron syntax |
9953 | "guix gc -F 1G")) | |
9954 | ||
80d944b7 | 9955 | (define idutils-job |
8ac6282c LC |
9956 | ;; Update the index database as user "charlie" at 12:15PM |
9957 | ;; and 19:15PM. This runs from the user's home directory. | |
9958 | #~(job '(next-minute-from (next-hour '(12 19)) '(15)) | |
9959 | (string-append #$idutils "/bin/mkid src") | |
9960 | #:user "charlie")) | |
9961 | ||
c311089b LC |
9962 | (operating-system |
9963 | ;; @dots{} | |
9964 | (services (cons (mcron-service (list garbage-collector-job | |
8ac6282c LC |
9965 | updatedb-job |
9966 | idutils-job)) | |
c311089b LC |
9967 | %base-services))) |
9968 | @end lisp | |
9969 | ||
9970 | @xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, | |
9971 | for more information on mcron job specifications. Below is the | |
9972 | reference of the mcron service. | |
9973 | ||
9974 | @deffn {Scheme Procedure} mcron-service @var{jobs} [#:mcron @var{mcron2}] | |
9975 | Return an mcron service running @var{mcron} that schedules @var{jobs}, a | |
9976 | list of gexps denoting mcron job specifications. | |
9977 | ||
9978 | This is a shorthand for: | |
9979 | @example | |
80d944b7 LC |
9980 | (service mcron-service-type |
9981 | (mcron-configuration (mcron mcron) (jobs jobs))) | |
c311089b LC |
9982 | @end example |
9983 | @end deffn | |
9984 | ||
9985 | @defvr {Scheme Variable} mcron-service-type | |
9986 | This is the type of the @code{mcron} service, whose value is an | |
9987 | @code{mcron-configuration} object. | |
9988 | ||
9989 | This service type can be the target of a service extension that provides | |
9990 | it additional job specifications (@pxref{Service Composition}). In | |
80d944b7 | 9991 | other words, it is possible to define services that provide additional |
c311089b LC |
9992 | mcron jobs to run. |
9993 | @end defvr | |
9994 | ||
9995 | @deftp {Data Type} mcron-configuration | |
9996 | Data type representing the configuration of mcron. | |
9997 | ||
9998 | @table @asis | |
9999 | @item @code{mcron} (default: @var{mcron2}) | |
10000 | The mcron package to use. | |
10001 | ||
10002 | @item @code{jobs} | |
10003 | This is a list of gexps (@pxref{G-Expressions}), where each gexp | |
10004 | corresponds to an mcron job specification (@pxref{Syntax, mcron job | |
10005 | specifications,, mcron, GNU@tie{}mcron}). | |
10006 | @end table | |
10007 | @end deftp | |
10008 | ||
10009 | ||
92c03a87 JN |
10010 | @node Log Rotation |
10011 | @subsubsection Log Rotation | |
10012 | ||
10013 | @cindex rottlog | |
10014 | @cindex log rotation | |
e32171ee | 10015 | @cindex logging |
92c03a87 JN |
10016 | Log files such as those found in @file{/var/log} tend to grow endlessly, |
10017 | so it's a good idea to @dfn{rotate} them once in a while---i.e., archive | |
10018 | their contents in separate files, possibly compressed. The @code{(gnu | |
10019 | services admin)} module provides an interface to GNU@tie{}Rot[t]log, a | |
10020 | log rotation tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual}). | |
10021 | ||
10022 | The example below defines an operating system that provides log rotation | |
81fa2229 | 10023 | with the default settings, for commonly encountered log files. |
92c03a87 JN |
10024 | |
10025 | @lisp | |
10026 | (use-modules (guix) (gnu)) | |
10027 | (use-service-modules admin mcron) | |
10028 | (use-package-modules base idutils) | |
10029 | ||
10030 | (operating-system | |
10031 | ;; @dots{} | |
350cc3a2 | 10032 | (services (cons* (service mcron-service-type) |
3d3c5650 | 10033 | (service rottlog-service-type) |
92c03a87 JN |
10034 | %base-services))) |
10035 | @end lisp | |
10036 | ||
10037 | @defvr {Scheme Variable} rottlog-service-type | |
10038 | This is the type of the Rottlog service, whose value is a | |
10039 | @code{rottlog-configuration} object. | |
10040 | ||
254ea3f9 LC |
10041 | Other services can extend this one with new @code{log-rotation} objects |
10042 | (see below), thereby augmenting the set of files to be rotated. | |
10043 | ||
92c03a87 JN |
10044 | This service type can define mcron jobs (@pxref{Scheduled Job |
10045 | Execution}) to run the rottlog service. | |
10046 | @end defvr | |
10047 | ||
10048 | @deftp {Data Type} rottlog-configuration | |
10049 | Data type representing the configuration of rottlog. | |
10050 | ||
10051 | @table @asis | |
10052 | @item @code{rottlog} (default: @code{rottlog}) | |
10053 | The Rottlog package to use. | |
10054 | ||
10055 | @item @code{rc-file} (default: @code{(file-append rottlog "/etc/rc")}) | |
10056 | The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, | |
10057 | rottlog, GNU Rot[t]log Manual}). | |
10058 | ||
81fa2229 LC |
10059 | @item @code{rotations} (default: @code{%default-rotations}) |
10060 | A list of @code{log-rotation} objects as defined below. | |
92c03a87 | 10061 | |
81fa2229 LC |
10062 | @item @code{jobs} |
10063 | This is a list of gexps where each gexp corresponds to an mcron job | |
10064 | specification (@pxref{Scheduled Job Execution}). | |
10065 | @end table | |
10066 | @end deftp | |
10067 | ||
10068 | @deftp {Data Type} log-rotation | |
10069 | Data type representing the rotation of a group of log files. | |
10070 | ||
10071 | Taking an example from the Rottlog manual (@pxref{Period Related File | |
10072 | Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be | |
10073 | defined like this: | |
92c03a87 JN |
10074 | |
10075 | @example | |
81fa2229 LC |
10076 | (log-rotation |
10077 | (frequency 'daily) | |
10078 | (files '("/var/log/apache/*")) | |
10079 | (options '("storedir apache-archives" | |
10080 | "rotate 6" | |
10081 | "notifempty" | |
10082 | "nocompress"))) | |
92c03a87 JN |
10083 | @end example |
10084 | ||
81fa2229 LC |
10085 | The list of fields is as follows: |
10086 | ||
10087 | @table @asis | |
10088 | @item @code{frequency} (default: @code{'weekly}) | |
10089 | The log rotation frequency, a symbol. | |
10090 | ||
10091 | @item @code{files} | |
10092 | The list of files or file glob patterns to rotate. | |
10093 | ||
10094 | @item @code{options} (default: @code{'()}) | |
10095 | The list of rottlog options for this rotation (@pxref{Configuration | |
10096 | parameters,,, rottlog, GNU Rot[t]lg Manual}). | |
10097 | ||
10098 | @item @code{post-rotate} (default: @code{#f}) | |
10099 | Either @code{#f} or a gexp to execute once the rotation has completed. | |
92c03a87 JN |
10100 | @end table |
10101 | @end deftp | |
10102 | ||
10103 | @defvr {Scheme Variable} %default-rotations | |
10104 | Specifies weekly rotation of @var{%rotated-files} and | |
81fa2229 | 10105 | a couple of other files. |
92c03a87 JN |
10106 | @end defvr |
10107 | ||
10108 | @defvr {Scheme Variable} %rotated-files | |
10109 | The list of syslog-controlled files to be rotated. By default it is: | |
10110 | @code{'("/var/log/messages" "/var/log/secure")}. | |
10111 | @end defvr | |
10112 | ||
cf4a9129 LC |
10113 | @node Networking Services |
10114 | @subsubsection Networking Services | |
401c53c4 | 10115 | |
fa1e31b8 | 10116 | The @code{(gnu services networking)} module provides services to configure |
cf4a9129 | 10117 | the network interface. |
a1ba8475 | 10118 | |
a023cca8 | 10119 | @cindex DHCP, networking service |
be1c2c54 | 10120 | @deffn {Scheme Procedure} dhcp-client-service [#:dhcp @var{isc-dhcp}] |
a023cca8 LC |
10121 | Return a service that runs @var{dhcp}, a Dynamic Host Configuration |
10122 | Protocol (DHCP) client, on all the non-loopback network interfaces. | |
10123 | @end deffn | |
10124 | ||
8de3e4b3 LC |
10125 | @defvr {Scheme Variable} static-networking-service-type |
10126 | This is the type for statically-configured network interfaces. | |
10127 | @c TODO Document <static-networking> data structures. | |
10128 | @end defvr | |
10129 | ||
be1c2c54 | 10130 | @deffn {Scheme Procedure} static-networking-service @var{interface} @var{ip} @ |
1f9803c2 | 10131 | [#:netmask #f] [#:gateway #f] [#:name-servers @code{'()}] |
cf4a9129 | 10132 | Return a service that starts @var{interface} with address @var{ip}. If |
1f9803c2 LC |
10133 | @var{netmask} is true, use it as the network mask. If @var{gateway} is true, |
10134 | it must be a string specifying the default network gateway. | |
8de3e4b3 LC |
10135 | |
10136 | This procedure can be called several times, one for each network | |
10137 | interface of interest. Behind the scenes what it does is extend | |
10138 | @code{static-networking-service-type} with additional network interfaces | |
10139 | to handle. | |
cf4a9129 | 10140 | @end deffn |
8b315a6d | 10141 | |
b7d0c494 | 10142 | @cindex wicd |
e32171ee JD |
10143 | @cindex wireless |
10144 | @cindex WiFi | |
87f40011 | 10145 | @cindex network management |
be1c2c54 | 10146 | @deffn {Scheme Procedure} wicd-service [#:wicd @var{wicd}] |
87f40011 LC |
10147 | Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network |
10148 | management daemon that aims to simplify wired and wireless networking. | |
10149 | ||
10150 | This service adds the @var{wicd} package to the global profile, providing | |
10151 | several commands to interact with the daemon and configure networking: | |
10152 | @command{wicd-client}, a graphical user interface, and the @command{wicd-cli} | |
10153 | and @command{wicd-curses} user interfaces. | |
b7d0c494 MW |
10154 | @end deffn |
10155 | ||
c0a9589d | 10156 | @cindex NetworkManager |
b726096b CB |
10157 | |
10158 | @defvr {Scheme Variable} network-manager-service-type | |
10159 | This is the service type for the | |
10160 | @uref{https://wiki.gnome.org/Projects/NetworkManager, NetworkManager} | |
10161 | service. The value for this service type is a | |
10162 | @code{network-manager-configuration} record. | |
4110fbc6 LC |
10163 | |
10164 | This service is part of @code{%desktop-services} (@pxref{Desktop | |
10165 | Services}). | |
b726096b CB |
10166 | @end defvr |
10167 | ||
10168 | @deftp {Data Type} network-manager-configuration | |
10169 | Data type representing the configuration of NetworkManager. | |
10170 | ||
10171 | @table @asis | |
10172 | @item @code{network-manager} (default: @code{network-manager}) | |
10173 | The NetworkManager package to use. | |
10174 | ||
10175 | @item @code{dns} (default: @code{"default"}) | |
10176 | Processing mode for DNS, which affects how NetworkManager uses the | |
10177 | @code{resolv.conf} configuration file. | |
10178 | ||
10179 | @table @samp | |
10180 | @item default | |
10181 | NetworkManager will update @code{resolv.conf} to reflect the nameservers | |
10182 | provided by currently active connections. | |
10183 | ||
10184 | @item dnsmasq | |
10185 | NetworkManager will run @code{dnsmasq} as a local caching nameserver, | |
10186 | using a "split DNS" configuration if you are connected to a VPN, and | |
10187 | then update @code{resolv.conf} to point to the local nameserver. | |
10188 | ||
10189 | @item none | |
10190 | NetworkManager will not modify @code{resolv.conf}. | |
10191 | @end table | |
10192 | ||
94d2a250 LC |
10193 | @item @code{vpn-plugins} (default: @code{'()}) |
10194 | This is the list of available plugins for virtual private networks | |
10195 | (VPNs). An example of this is the @code{network-manager-openvpn} | |
10196 | package, which allows NetworkManager to manage VPNs @i{via} OpenVPN. | |
10197 | ||
b726096b CB |
10198 | @end table |
10199 | @end deftp | |
c0a9589d | 10200 | |
76192896 | 10201 | @cindex Connman |
34d60c49 MO |
10202 | @deffn {Scheme Variable} connman-service-type |
10203 | This is the service type to run @url{https://01.org/connman,Connman}, | |
10204 | a network connection manager. | |
10205 | ||
10206 | Its value must be an | |
10207 | @code{connman-configuration} record as in this example: | |
10208 | ||
10209 | @example | |
10210 | (service connman-service-type | |
10211 | (connman-configuration | |
10212 | (disable-vpn? #t))) | |
10213 | @end example | |
10214 | ||
10215 | See below for details about @code{connman-configuration}. | |
76192896 EF |
10216 | @end deffn |
10217 | ||
34d60c49 MO |
10218 | @deftp {Data Type} connman-configuration |
10219 | Data Type representing the configuration of connman. | |
10220 | ||
10221 | @table @asis | |
10222 | @item @code{connman} (default: @var{connman}) | |
10223 | The connman package to use. | |
10224 | ||
10225 | @item @code{disable-vpn?} (default: @code{#f}) | |
10226 | When true, enable connman's vpn plugin. | |
10227 | @end table | |
10228 | @end deftp | |
10229 | ||
2cccbc2a | 10230 | @cindex WPA Supplicant |
cbf1024e LC |
10231 | @defvr {Scheme Variable} wpa-supplicant-service-type |
10232 | This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA | |
2cccbc2a | 10233 | supplicant}, an authentication daemon required to authenticate against |
cbf1024e | 10234 | encrypted WiFi or ethernet networks. It is configured to listen for |
2cccbc2a | 10235 | requests on D-Bus. |
cbf1024e LC |
10236 | |
10237 | The value of this service is the @code{wpa-supplicant} package to use. | |
10238 | Thus, it can be instantiated like this: | |
10239 | ||
10240 | @lisp | |
3d3c5650 | 10241 | (use-modules (gnu services networking)) |
cbf1024e | 10242 | |
3d3c5650 | 10243 | (service wpa-supplicant-service-type) |
cbf1024e LC |
10244 | @end lisp |
10245 | @end defvr | |
2cccbc2a | 10246 | |
e32171ee JD |
10247 | @cindex NTP |
10248 | @cindex real time clock | |
be1c2c54 | 10249 | @deffn {Scheme Procedure} ntp-service [#:ntp @var{ntp}] @ |
dc0322b5 LC |
10250 | [#:servers @var{%ntp-servers}] @ |
10251 | [#:allow-large-adjustment? #f] | |
63854bcb LC |
10252 | Return a service that runs the daemon from @var{ntp}, the |
10253 | @uref{http://www.ntp.org, Network Time Protocol package}. The daemon will | |
10254 | keep the system clock synchronized with that of @var{servers}. | |
dc0322b5 LC |
10255 | @var{allow-large-adjustment?} determines whether @command{ntpd} is allowed to |
10256 | make an initial adjustment of more than 1,000 seconds. | |
63854bcb LC |
10257 | @end deffn |
10258 | ||
10259 | @defvr {Scheme Variable} %ntp-servers | |
10260 | List of host names used as the default NTP servers. | |
10261 | @end defvr | |
10262 | ||
9260b9d1 TD |
10263 | @cindex inetd |
10264 | @deffn {Scheme variable} inetd-service-type | |
10265 | This service runs the @command{inetd} (@pxref{inetd invocation,,, | |
10266 | inetutils, GNU Inetutils}) daemon. @command{inetd} listens for | |
10267 | connections on internet sockets, and lazily starts the specified server | |
10268 | program when a connection is made on one of these sockets. | |
10269 | ||
10270 | The value of this service is an @code{inetd-configuration} object. The | |
10271 | following example configures the @command{inetd} daemon to provide the | |
10272 | built-in @command{echo} service, as well as an smtp service which | |
10273 | forwards smtp traffic over ssh to a server @code{smtp-server} behind a | |
10274 | gateway @code{hostname}: | |
10275 | ||
10276 | @example | |
10277 | (service | |
10278 | inetd-service-type | |
10279 | (inetd-configuration | |
10280 | (entries (list | |
10281 | (inetd-entry | |
10282 | (name "echo") | |
10283 | (socket-type 'stream) | |
10284 | (protocol "tcp") | |
10285 | (wait? #f) | |
10286 | (user "root")) | |
10287 | (inetd-entry | |
10288 | (node "127.0.0.1") | |
10289 | (name "smtp") | |
10290 | (socket-type 'stream) | |
10291 | (protocol "tcp") | |
10292 | (wait? #f) | |
10293 | (user "root") | |
10294 | (program (file-append openssh "/bin/ssh")) | |
10295 | (arguments | |
10296 | '("ssh" "-qT" "-i" "/path/to/ssh_key" | |
10297 | "-W" "smtp-server:25" "user@@hostname"))))) | |
10298 | @end example | |
10299 | ||
10300 | See below for more details about @code{inetd-configuration}. | |
10301 | @end deffn | |
10302 | ||
10303 | @deftp {Data Type} inetd-configuration | |
10304 | Data type representing the configuration of @command{inetd}. | |
10305 | ||
10306 | @table @asis | |
10307 | @item @code{program} (default: @code{(file-append inetutils "/libexec/inetd")}) | |
10308 | The @command{inetd} executable to use. | |
10309 | ||
10310 | @item @code{entries} (default: @code{'()}) | |
10311 | A list of @command{inetd} service entries. Each entry should be created | |
10312 | by the @code{inetd-entry} constructor. | |
10313 | @end table | |
10314 | @end deftp | |
10315 | ||
10316 | @deftp {Data Type} inetd-entry | |
10317 | Data type representing an entry in the @command{inetd} configuration. | |
10318 | Each entry corresponds to a socket where @command{inetd} will listen for | |
10319 | requests. | |
10320 | ||
10321 | @table @asis | |
10322 | @item @code{node} (default: @code{#f}) | |
10323 | Optional string, a comma-separated list of local addresses | |
10324 | @command{inetd} should use when listening for this service. | |
10325 | @xref{Configuration file,,, inetutils, GNU Inetutils} for a complete | |
10326 | description of all options. | |
10327 | @item @code{name} | |
10328 | A string, the name must correspond to an entry in @code{/etc/services}. | |
10329 | @item @code{socket-type} | |
10330 | One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or | |
10331 | @code{'seqpacket}. | |
10332 | @item @code{protocol} | |
10333 | A string, must correspond to an entry in @code{/etc/protocols}. | |
10334 | @item @code{wait?} (default: @code{#t}) | |
10335 | Whether @command{inetd} should wait for the server to exit before | |
10336 | listening to new service requests. | |
10337 | @item @code{user} | |
10338 | A string containing the user (and, optionally, group) name of the user | |
10339 | as whom the server should run. The group name can be specified in a | |
10340 | suffix, separated by a colon or period, i.e. @code{"user"}, | |
10341 | @code{"user:group"} or @code{"user.group"}. | |
10342 | @item @code{program} (default: @code{"internal"}) | |
10343 | The server program which will serve the requests, or @code{"internal"} | |
10344 | if @command{inetd} should use a built-in service. | |
10345 | @item @code{arguments} (default: @code{'()}) | |
10346 | A list strings or file-like objects, which are the server program's | |
10347 | arguments, starting with the zeroth argument, i.e. the name of the | |
10348 | program itself. For @command{inetd}'s internal services, this entry | |
10349 | must be @code{'()} or @code{'("internal")}. | |
10350 | @end table | |
10351 | ||
10352 | @xref{Configuration file,,, inetutils, GNU Inetutils} for a more | |
10353 | detailed discussion of each configuration field. | |
10354 | @end deftp | |
10355 | ||
e32171ee | 10356 | @cindex Tor |
375c6108 LC |
10357 | @deffn {Scheme Procedure} tor-service [@var{config-file}] [#:tor @var{tor}] |
10358 | Return a service to run the @uref{https://torproject.org, Tor} anonymous | |
10359 | networking daemon. | |
8b315a6d | 10360 | |
375c6108 | 10361 | The daemon runs as the @code{tor} unprivileged user. It is passed |
6331bde7 LC |
10362 | @var{config-file}, a file-like object, with an additional @code{User tor} line |
10363 | and lines for hidden services added via @code{tor-hidden-service}. Run | |
10364 | @command{man tor} for information about the configuration file. | |
10365 | @end deffn | |
10366 | ||
24a8ef3b | 10367 | @cindex hidden service |
6331bde7 LC |
10368 | @deffn {Scheme Procedure} tor-hidden-service @var{name} @var{mapping} |
10369 | Define a new Tor @dfn{hidden service} called @var{name} and implementing | |
10370 | @var{mapping}. @var{mapping} is a list of port/host tuples, such as: | |
10371 | ||
10372 | @example | |
24a8ef3b LC |
10373 | '((22 "127.0.0.1:22") |
10374 | (80 "127.0.0.1:8080")) | |
6331bde7 LC |
10375 | @end example |
10376 | ||
10377 | In this example, port 22 of the hidden service is mapped to local port 22, and | |
10378 | port 80 is mapped to local port 8080. | |
10379 | ||
6629099a LC |
10380 | This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where |
10381 | the @file{hostname} file contains the @code{.onion} host name for the hidden | |
6331bde7 LC |
10382 | service. |
10383 | ||
10384 | See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor | |
10385 | project's documentation} for more information. | |
cf4a9129 | 10386 | @end deffn |
8b315a6d | 10387 | |
be1c2c54 | 10388 | @deffn {Scheme Procedure} bitlbee-service [#:bitlbee bitlbee] @ |
4627a464 LC |
10389 | [#:interface "127.0.0.1"] [#:port 6667] @ |
10390 | [#:extra-settings ""] | |
10391 | Return a service that runs @url{http://bitlbee.org,BitlBee}, a daemon that | |
10392 | acts as a gateway between IRC and chat networks. | |
10393 | ||
10394 | The daemon will listen to the interface corresponding to the IP address | |
10395 | specified in @var{interface}, on @var{port}. @code{127.0.0.1} means that only | |
10396 | local clients can connect, whereas @code{0.0.0.0} means that connections can | |
10397 | come from any networking interface. | |
10398 | ||
10399 | In addition, @var{extra-settings} specifies a string to append to the | |
10400 | configuration file. | |
10401 | @end deffn | |
10402 | ||
9db7e9be OP |
10403 | The @code{(gnu services rsync)} module provides the following services: |
10404 | ||
10405 | You might want an rsync daemon if you have files that you want available | |
10406 | so anyone (or just yourself) can download existing files or upload new | |
10407 | files. | |
10408 | ||
10409 | @deffn {Scheme Variable} rsync-service-type | |
10410 | This is the type for the @uref{https://rsync.samba.org, rsync} rsync daemon, | |
10411 | @command{rsync-configuration} record as in this example: | |
10412 | ||
10413 | @example | |
10414 | (service rsync-service-type) | |
10415 | @end example | |
10416 | ||
10417 | See below for details about @code{rsync-configuration}. | |
10418 | @end deffn | |
10419 | ||
10420 | @deftp {Data Type} rsync-configuration | |
10421 | Data type representing the configuration for @code{rsync-service}. | |
10422 | ||
10423 | @table @asis | |
10424 | @item @code{package} (default: @var{rsync}) | |
10425 | @code{rsync} package to use. | |
10426 | ||
10427 | @item @code{port-number} (default: @code{873}) | |
10428 | TCP port on which @command{rsync} listens for incoming connections. If port | |
10429 | is less than @code{1024} @command{rsync} needs to be started as the | |
10430 | @code{root} user and group. | |
10431 | ||
10432 | @item @code{pid-file} (default: @code{"/var/run/rsyncd/rsyncd.pid"}) | |
10433 | Name of the file where @command{rsync} writes its PID. | |
10434 | ||
10435 | @item @code{lock-file} (default: @code{"/var/run/rsyncd/rsyncd.lock"}) | |
10436 | Name of the file where @command{rsync} writes its lock file. | |
10437 | ||
10438 | @item @code{log-file} (default: @code{"/var/log/rsyncd.log"}) | |
10439 | Name of the file where @command{rsync} writes its log file. | |
10440 | ||
10441 | @item @code{use-chroot?} (default: @var{#t}) | |
10442 | Whether to use chroot for @command{rsync} shared directory. | |
10443 | ||
10444 | @item @code{share-path} (default: @file{/srv/rsync}) | |
10445 | Location of the @command{rsync} shared directory. | |
10446 | ||
10447 | @item @code{share-comment} (default: @code{"Rsync share"}) | |
10448 | Comment of the @command{rsync} shared directory. | |
10449 | ||
10450 | @item @code{read-only?} (default: @var{#f}) | |
10451 | Read-write permissions to shared directory. | |
10452 | ||
10453 | @item @code{timeout} (default: @code{300}) | |
10454 | I/O timeout in seconds. | |
10455 | ||
10456 | @item @code{user} (default: @var{"root"}) | |
10457 | Owner of the @code{rsync} process. | |
10458 | ||
10459 | @item @code{group} (default: @var{"root"}) | |
10460 | Group of the @code{rsync} process. | |
10461 | ||
10462 | @item @code{uid} (default: @var{"rsyncd"}) | |
10463 | User name or user ID that file transfers to and from that module should take | |
10464 | place as when the daemon was run as @code{root}. | |
10465 | ||
10466 | @item @code{gid} (default: @var{"rsyncd"}) | |
10467 | Group name or group ID that will be used when accessing the module. | |
10468 | ||
10469 | @end table | |
10470 | @end deftp | |
10471 | ||
71b0601a | 10472 | Furthermore, @code{(gnu services ssh)} provides the following services. |
e32171ee JD |
10473 | @cindex SSH |
10474 | @cindex SSH server | |
8b315a6d | 10475 | |
be1c2c54 | 10476 | @deffn {Scheme Procedure} lsh-service [#:host-key "/etc/lsh/host-key"] @ |
5833bf33 | 10477 | [#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ |
cf4a9129 LC |
10478 | [#:allow-empty-passwords? #f] [#:root-login? #f] @ |
10479 | [#:syslog-output? #t] [#:x11-forwarding? #t] @ | |
10480 | [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ | |
21cc905a | 10481 | [#:public-key-authentication? #t] [#:initialize? #t] |
cf4a9129 LC |
10482 | Run the @command{lshd} program from @var{lsh} to listen on port @var{port-number}. |
10483 | @var{host-key} must designate a file containing the host key, and readable | |
10484 | only by root. | |
72e25e35 | 10485 | |
5833bf33 DP |
10486 | When @var{daemonic?} is true, @command{lshd} will detach from the |
10487 | controlling terminal and log its output to syslogd, unless one sets | |
10488 | @var{syslog-output?} to false. Obviously, it also makes lsh-service | |
10489 | depend on existence of syslogd service. When @var{pid-file?} is true, | |
10490 | @command{lshd} writes its PID to the file called @var{pid-file}. | |
10491 | ||
cf4a9129 LC |
10492 | When @var{initialize?} is true, automatically create the seed and host key |
10493 | upon service activation if they do not exist yet. This may take long and | |
10494 | require interaction. | |
8b315a6d | 10495 | |
20dd519c LC |
10496 | When @var{initialize?} is false, it is up to the user to initialize the |
10497 | randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create | |
10498 | a key pair with the private key stored in file @var{host-key} (@pxref{lshd | |
10499 | basics,,, lsh, LSH Manual}). | |
10500 | ||
cf4a9129 LC |
10501 | When @var{interfaces} is empty, lshd listens for connections on all the |
10502 | network interfaces; otherwise, @var{interfaces} must be a list of host names | |
10503 | or addresses. | |
9bf3c1a7 | 10504 | |
20dd519c LC |
10505 | @var{allow-empty-passwords?} specifies whether to accept log-ins with empty |
10506 | passwords, and @var{root-login?} specifies whether to accept log-ins as | |
cf4a9129 | 10507 | root. |
4af2447e | 10508 | |
cf4a9129 LC |
10509 | The other options should be self-descriptive. |
10510 | @end deffn | |
4af2447e | 10511 | |
e32171ee JD |
10512 | @cindex SSH |
10513 | @cindex SSH server | |
d8f31281 LC |
10514 | @deffn {Scheme Variable} openssh-service-type |
10515 | This is the type for the @uref{http://www.openssh.org, OpenSSH} secure | |
10516 | shell daemon, @command{sshd}. Its value must be an | |
10517 | @code{openssh-configuration} record as in this example: | |
10518 | ||
10519 | @example | |
10520 | (service openssh-service-type | |
10521 | (openssh-configuration | |
10522 | (x11-forwarding? #t) | |
4892eb7c LC |
10523 | (permit-root-login 'without-password) |
10524 | (authorized-keys | |
10525 | `(("alice" ,(local-file "alice.pub")) | |
10526 | ("bob" ,(local-file "bob.pub")))))) | |
d8f31281 LC |
10527 | @end example |
10528 | ||
10529 | See below for details about @code{openssh-configuration}. | |
1398a438 LC |
10530 | |
10531 | This service can be extended with extra authorized keys, as in this | |
10532 | example: | |
10533 | ||
10534 | @example | |
10535 | (service-extension openssh-service-type | |
10536 | (const `(("charlie" | |
10537 | ,(local-file "charlie.pub"))))) | |
10538 | @end example | |
86d8f6d3 JL |
10539 | @end deffn |
10540 | ||
d8f31281 LC |
10541 | @deftp {Data Type} openssh-configuration |
10542 | This is the configuration record for OpenSSH's @command{sshd}. | |
10543 | ||
10544 | @table @asis | |
10545 | @item @code{pid-file} (default: @code{"/var/run/sshd.pid"}) | |
10546 | Name of the file where @command{sshd} writes its PID. | |
10547 | ||
10548 | @item @code{port-number} (default: @code{22}) | |
10549 | TCP port on which @command{sshd} listens for incoming connections. | |
10550 | ||
10551 | @item @code{permit-root-login} (default: @code{#f}) | |
10552 | This field determines whether and when to allow logins as root. If | |
10553 | @code{#f}, root logins are disallowed; if @code{#t}, they are allowed. | |
10554 | If it's the symbol @code{'without-password}, then root logins are | |
10555 | permitted but not with password-based authentication. | |
10556 | ||
10557 | @item @code{allow-empty-passwords?} (default: @code{#f}) | |
10558 | When true, users with empty passwords may log in. When false, they may | |
10559 | not. | |
10560 | ||
10561 | @item @code{password-authentication?} (default: @code{#t}) | |
10562 | When true, users may log in with their password. When false, they have | |
10563 | other authentication methods. | |
10564 | ||
10565 | @item @code{public-key-authentication?} (default: @code{#t}) | |
10566 | When true, users may log in using public key authentication. When | |
10567 | false, users have to use other authentication method. | |
10568 | ||
10569 | Authorized public keys are stored in @file{~/.ssh/authorized_keys}. | |
10570 | This is used only by protocol version 2. | |
10571 | ||
d8f31281 LC |
10572 | @item @code{x11-forwarding?} (default: @code{#f}) |
10573 | When true, forwarding of X11 graphical client connections is | |
10574 | enabled---in other words, @command{ssh} options @option{-X} and | |
10575 | @option{-Y} will work. | |
10576 | ||
563c5d42 CL |
10577 | @item @code{challenge-response-authentication?} (default: @code{#f}) |
10578 | Specifies whether challenge response authentication is allowed (e.g. via | |
10579 | PAM). | |
10580 | ||
10581 | @item @code{use-pam?} (default: @code{#t}) | |
10582 | Enables the Pluggable Authentication Module interface. If set to | |
10583 | @code{#t}, this will enable PAM authentication using | |
10584 | @code{challenge-response-authentication?} and | |
10585 | @code{password-authentication?}, in addition to PAM account and session | |
10586 | module processing for all authentication types. | |
10587 | ||
10588 | Because PAM challenge response authentication usually serves an | |
10589 | equivalent role to password authentication, you should disable either | |
10590 | @code{challenge-response-authentication?} or | |
10591 | @code{password-authentication?}. | |
f895dce4 CL |
10592 | |
10593 | @item @code{print-last-log?} (default: @code{#t}) | |
10594 | Specifies whether @command{sshd} should print the date and time of the | |
10595 | last user login when a user logs in interactively. | |
12723370 CL |
10596 | |
10597 | @item @code{subsystems} (default: @code{'(("sftp" "internal-sftp"))}) | |
10598 | Configures external subsystems (e.g. file transfer daemon). | |
10599 | ||
10600 | This is a list of two-element lists, each of which containing the | |
10601 | subsystem name and a command (with optional arguments) to execute upon | |
10602 | subsystem request. | |
10603 | ||
10604 | The command @command{internal-sftp} implements an in-process SFTP | |
10605 | server. Alternately, one can specify the @command{sftp-server} command: | |
10606 | @example | |
10607 | (service openssh-service-type | |
10608 | (openssh-configuration | |
10609 | (subsystems | |
4892eb7c | 10610 | `(("sftp" ,(file-append openssh "/libexec/sftp-server")))))) |
12723370 | 10611 | @end example |
4892eb7c LC |
10612 | |
10613 | @item @code{authorized-keys} (default: @code{'()}) | |
10614 | @cindex authorized keys, SSH | |
10615 | @cindex SSH authorized keys | |
10616 | This is the list of authorized keys. Each element of the list is a user | |
10617 | name followed by one or more file-like objects that represent SSH public | |
10618 | keys. For example: | |
10619 | ||
10620 | @example | |
10621 | (openssh-configuration | |
10622 | (authorized-keys | |
10623 | `(("rekado" ,(local-file "rekado.pub")) | |
10624 | ("chris" ,(local-file "chris.pub")) | |
10625 | ("root" ,(local-file "rekado.pub") ,(local-file "chris.pub"))))) | |
10626 | @end example | |
10627 | ||
10628 | @noindent | |
10629 | registers the specified public keys for user accounts @code{rekado}, | |
10630 | @code{chris}, and @code{root}. | |
10631 | ||
1398a438 LC |
10632 | Additional authorized keys can be specified @i{via} |
10633 | @code{service-extension}. | |
10634 | ||
4892eb7c LC |
10635 | Note that this does @emph{not} interfere with the use of |
10636 | @file{~/.ssh/authorized_keys}. | |
d8f31281 LC |
10637 | @end table |
10638 | @end deftp | |
10639 | ||
71b0601a DC |
10640 | @deffn {Scheme Procedure} dropbear-service [@var{config}] |
10641 | Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH | |
10642 | daemon} with the given @var{config}, a @code{<dropbear-configuration>} | |
10643 | object. | |
10644 | ||
10645 | For example, to specify a Dropbear service listening on port 1234, add | |
10646 | this call to the operating system's @code{services} field: | |
10647 | ||
10648 | @example | |
10649 | (dropbear-service (dropbear-configuration | |
10650 | (port-number 1234))) | |
10651 | @end example | |
10652 | @end deffn | |
10653 | ||
10654 | @deftp {Data Type} dropbear-configuration | |
10655 | This data type represents the configuration of a Dropbear SSH daemon. | |
10656 | ||
10657 | @table @asis | |
10658 | @item @code{dropbear} (default: @var{dropbear}) | |
10659 | The Dropbear package to use. | |
10660 | ||
10661 | @item @code{port-number} (default: 22) | |
10662 | The TCP port where the daemon waits for incoming connections. | |
10663 | ||
10664 | @item @code{syslog-output?} (default: @code{#t}) | |
10665 | Whether to enable syslog output. | |
10666 | ||
10667 | @item @code{pid-file} (default: @code{"/var/run/dropbear.pid"}) | |
10668 | File name of the daemon's PID file. | |
10669 | ||
10670 | @item @code{root-login?} (default: @code{#f}) | |
10671 | Whether to allow @code{root} logins. | |
10672 | ||
10673 | @item @code{allow-empty-passwords?} (default: @code{#f}) | |
10674 | Whether to allow empty passwords. | |
10675 | ||
10676 | @item @code{password-authentication?} (default: @code{#t}) | |
10677 | Whether to enable password-based authentication. | |
10678 | @end table | |
10679 | @end deftp | |
10680 | ||
fa0c1d61 LC |
10681 | @defvr {Scheme Variable} %facebook-host-aliases |
10682 | This variable contains a string for use in @file{/etc/hosts} | |
10683 | (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). Each | |
10684 | line contains a entry that maps a known server name of the Facebook | |
10685 | on-line service---e.g., @code{www.facebook.com}---to the local | |
10686 | host---@code{127.0.0.1} or its IPv6 equivalent, @code{::1}. | |
10687 | ||
10688 | This variable is typically used in the @code{hosts-file} field of an | |
7313a52e LC |
10689 | @code{operating-system} declaration (@pxref{operating-system Reference, |
10690 | @file{/etc/hosts}}): | |
fa0c1d61 LC |
10691 | |
10692 | @example | |
10693 | (use-modules (gnu) (guix)) | |
10694 | ||
10695 | (operating-system | |
10696 | (host-name "mymachine") | |
10697 | ;; ... | |
10698 | (hosts-file | |
10699 | ;; Create a /etc/hosts file with aliases for "localhost" | |
10700 | ;; and "mymachine", as well as for Facebook servers. | |
24e02c28 LC |
10701 | (plain-file "hosts" |
10702 | (string-append (local-host-aliases host-name) | |
10703 | %facebook-host-aliases)))) | |
fa0c1d61 LC |
10704 | @end example |
10705 | ||
10706 | This mechanism can prevent programs running locally, such as Web | |
10707 | browsers, from accessing Facebook. | |
10708 | @end defvr | |
10709 | ||
965a7332 LC |
10710 | The @code{(gnu services avahi)} provides the following definition. |
10711 | ||
be1c2c54 | 10712 | @deffn {Scheme Procedure} avahi-service [#:avahi @var{avahi}] @ |
965a7332 LC |
10713 | [#:host-name #f] [#:publish? #t] [#:ipv4? #t] @ |
10714 | [#:ipv6? #t] [#:wide-area? #f] @ | |
c8695f32 | 10715 | [#:domains-to-browse '()] [#:debug? #f] |
965a7332 LC |
10716 | Return a service that runs @command{avahi-daemon}, a system-wide |
10717 | mDNS/DNS-SD responder that allows for service discovery and | |
cc9c1f39 LC |
10718 | "zero-configuration" host name lookups (see @uref{http://avahi.org/}), and |
10719 | extends the name service cache daemon (nscd) so that it can resolve | |
10720 | @code{.local} host names using | |
1065bed9 LC |
10721 | @uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. Additionally, |
10722 | add the @var{avahi} package to the system profile so that commands such as | |
10723 | @command{avahi-browse} are directly usable. | |
965a7332 LC |
10724 | |
10725 | If @var{host-name} is different from @code{#f}, use that as the host name to | |
10726 | publish for this machine; otherwise, use the machine's actual host name. | |
10727 | ||
10728 | When @var{publish?} is true, publishing of host names and services is allowed; | |
10729 | in particular, avahi-daemon will publish the machine's host name and IP | |
10730 | address via mDNS on the local network. | |
10731 | ||
10732 | When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled. | |
10733 | ||
10734 | Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6 | |
10735 | sockets. | |
10736 | @end deffn | |
10737 | ||
c32d02fe SB |
10738 | @deffn {Scheme Variable} openvswitch-service-type |
10739 | This is the type of the @uref{http://www.openvswitch.org, Open vSwitch} | |
10740 | service, whose value should be an @code{openvswitch-configuration} | |
10741 | object. | |
10742 | @end deffn | |
10743 | ||
10744 | @deftp {Data Type} openvswitch-configuration | |
10745 | Data type representing the configuration of Open vSwitch, a multilayer | |
10746 | virtual switch which is designed to enable massive network automation | |
10747 | through programmatic extension. | |
10748 | ||
10749 | @table @asis | |
10750 | @item @code{package} (default: @var{openvswitch}) | |
10751 | Package object of the Open vSwitch. | |
10752 | ||
10753 | @end table | |
10754 | @end deftp | |
965a7332 | 10755 | |
cf4a9129 LC |
10756 | @node X Window |
10757 | @subsubsection X Window | |
68ad877c | 10758 | |
e32171ee JD |
10759 | @cindex X11 |
10760 | @cindex X Window System | |
cf4a9129 LC |
10761 | Support for the X Window graphical display system---specifically |
10762 | Xorg---is provided by the @code{(gnu services xorg)} module. Note that | |
10763 | there is no @code{xorg-service} procedure. Instead, the X server is | |
10764 | started by the @dfn{login manager}, currently SLiM. | |
4af2447e | 10765 | |
935644c0 DC |
10766 | @deftp {Data Type} sddm-configuration |
10767 | This is the data type representing the sddm service configuration. | |
10768 | ||
10769 | @table @asis | |
10770 | @item @code{display-server} (default: "x11") | |
10771 | Select display server to use for the greeter. Valid values are "x11" | |
10772 | or "wayland". | |
10773 | ||
10774 | @item @code{numlock} (default: "on") | |
10775 | Valid values are "on", "off" or "none". | |
10776 | ||
10777 | @item @code{halt-command} (default @code{#~(string-apppend #$shepherd "/sbin/halt")}) | |
10778 | Command to run when halting. | |
10779 | ||
10780 | @item @code{reboot-command} (default @code{#~(string-append #$shepherd "/sbin/reboot")}) | |
10781 | Command to run when rebooting. | |
10782 | ||
10783 | @item @code{theme} (default "maldives") | |
10784 | Theme to use. Default themes provided by SDDM are "elarun" or "maldives". | |
10785 | ||
10786 | @item @code{themes-directory} (default "/run/current-system/profile/share/sddm/themes") | |
10787 | Directory to look for themes. | |
10788 | ||
10789 | @item @code{faces-directory} (default "/run/current-system/profile/share/sddm/faces") | |
10790 | Directory to look for faces. | |
10791 | ||
10792 | @item @code{default-path} (default "/run/current-system/profile/bin") | |
10793 | Default PATH to use. | |
10794 | ||
10795 | @item @code{minimum-uid} (default 1000) | |
10796 | Minimum UID to display in SDDM. | |
10797 | ||
10798 | @item @code{maximum-uid} (default 2000) | |
10799 | Maximum UID to display in SDDM | |
10800 | ||
10801 | @item @code{remember-last-user?} (default #t) | |
10802 | Remember last user. | |
10803 | ||
10804 | @item @code{remember-last-session?} (default #t) | |
10805 | Remember last session. | |
10806 | ||
10807 | @item @code{hide-users} (default "") | |
10808 | Usernames to hide from SDDM greeter. | |
10809 | ||
10810 | @item @code{hide-shells} (default @code{#~(string-append #$shadow "/sbin/nologin")}) | |
10811 | Users with shells listed will be hidden from the SDDM greeter. | |
10812 | ||
10813 | @item @code{session-command} (default @code{#~(string-append #$sddm "/share/sddm/scripts/wayland-session")}) | |
10814 | Script to run before starting a wayland session. | |
10815 | ||
10816 | @item @code{sessions-directory} (default "/run/current-system/profile/share/wayland-sessions") | |
10817 | Directory to look for desktop files starting wayland sessions. | |
10818 | ||
10819 | @item @code{xorg-server-path} (default @code{xorg-start-command}) | |
10820 | Path to xorg-server. | |
10821 | ||
10822 | @item @code{xauth-path} (default @code{#~(string-append #$xauth "/bin/xauth")}) | |
10823 | Path to xauth. | |
10824 | ||
10825 | @item @code{xephyr-path} (default @code{#~(string-append #$xorg-server "/bin/Xephyr")}) | |
10826 | Path to Xephyr. | |
10827 | ||
10828 | @item @code{xdisplay-start} (default @code{#~(string-append #$sddm "/share/sddm/scripts/Xsetup")}) | |
10829 | Script to run after starting xorg-server. | |
10830 | ||
10831 | @item @code{xdisplay-stop} (default @code{#~(string-append #$sddm "/share/sddm/scripts/Xstop")}) | |
10832 | Script to run before stopping xorg-server. | |
10833 | ||
10834 | @item @code{xsession-command} (default: @code{xinitr }) | |
10835 | Script to run before starting a X session. | |
10836 | ||
10837 | @item @code{xsessions-directory} (default: "/run/current-system/profile/share/xsessions") | |
10838 | Directory to look for desktop files starting X sessions. | |
10839 | ||
10840 | @item @code{minimum-vt} (default: 7) | |
10841 | Minimum VT to use. | |
10842 | ||
10843 | @item @code{xserver-arguments} (default "-nolisten tcp") | |
10844 | Arguments to pass to xorg-server. | |
10845 | ||
10846 | @item @code{auto-login-user} (default "") | |
10847 | User to use for auto-login. | |
10848 | ||
10849 | @item @code{auto-login-session} (default "") | |
10850 | Desktop file to use for auto-login. | |
10851 | ||
10852 | @item @code{relogin?} (default #f) | |
10853 | Relogin after logout. | |
10854 | ||
10855 | @end table | |
10856 | @end deftp | |
10857 | ||
e32171ee | 10858 | @cindex login manager |
935644c0 DC |
10859 | @deffn {Scheme Procedure} sddm-service config |
10860 | Return a service that spawns the SDDM graphical login manager for config of | |
10861 | type @code{<sddm-configuration>}. | |
10862 | ||
10863 | @example | |
10864 | (sddm-service (sddm-configuration | |
10865 | (auto-login-user "Alice") | |
10866 | (auto-login-session "xfce.desktop"))) | |
10867 | @end example | |
10868 | @end deffn | |
10869 | ||
be1c2c54 | 10870 | @deffn {Scheme Procedure} slim-service [#:allow-empty-passwords? #f] @ |
0ecc3bf3 LC |
10871 | [#:auto-login? #f] [#:default-user ""] [#:startx] @ |
10872 | [#:theme @var{%default-slim-theme}] @ | |
4bd43bbe | 10873 | [#:theme-name @var{%default-slim-theme-name}] |
cf4a9129 LC |
10874 | Return a service that spawns the SLiM graphical login manager, which in |
10875 | turn starts the X display server with @var{startx}, a command as returned by | |
10876 | @code{xorg-start-command}. | |
4af2447e | 10877 | |
04e4e6ab LC |
10878 | @cindex X session |
10879 | ||
10880 | SLiM automatically looks for session types described by the @file{.desktop} | |
10881 | files in @file{/run/current-system/profile/share/xsessions} and allows users | |
10882 | to choose a session from the log-in screen using @kbd{F1}. Packages such as | |
10883 | @var{xfce}, @var{sawfish}, and @var{ratpoison} provide @file{.desktop} files; | |
10884 | adding them to the system-wide set of packages automatically makes them | |
10885 | available at the log-in screen. | |
10886 | ||
10887 | In addition, @file{~/.xsession} files are honored. When available, | |
10888 | @file{~/.xsession} must be an executable that starts a window manager | |
10889 | and/or other X clients. | |
10890 | ||
cf4a9129 LC |
10891 | When @var{allow-empty-passwords?} is true, allow logins with an empty |
10892 | password. When @var{auto-login?} is true, log in automatically as | |
10893 | @var{default-user}. | |
0ecc3bf3 | 10894 | |
1068f26b | 10895 | If @var{theme} is @code{#f}, use the default log-in theme; otherwise |
0ecc3bf3 LC |
10896 | @var{theme} must be a gexp denoting the name of a directory containing the |
10897 | theme to use. In that case, @var{theme-name} specifies the name of the | |
10898 | theme. | |
cf4a9129 | 10899 | @end deffn |
4af2447e | 10900 | |
0ecc3bf3 LC |
10901 | @defvr {Scheme Variable} %default-theme |
10902 | @defvrx {Scheme Variable} %default-theme-name | |
10903 | The G-Expression denoting the default SLiM theme and its name. | |
10904 | @end defvr | |
10905 | ||
be1c2c54 | 10906 | @deffn {Scheme Procedure} xorg-start-command [#:guile] @ |
d1cdd7ba | 10907 | [#:configuration-file #f] [#:xorg-server @var{xorg-server}] |
f703413e | 10908 | Return a derivation that builds a @var{guile} script to start the X server |
d1cdd7ba LC |
10909 | from @var{xorg-server}. @var{configuration-file} is the server configuration |
10910 | file or a derivation that builds it; when omitted, the result of | |
10911 | @code{xorg-configuration-file} is used. | |
10912 | ||
10913 | Usually the X server is started by a login manager. | |
10914 | @end deffn | |
10915 | ||
be1c2c54 | 10916 | @deffn {Scheme Procedure} xorg-configuration-file @ |
12422c9d | 10917 | [#:drivers '()] [#:resolutions '()] [#:extra-config '()] |
d1cdd7ba LC |
10918 | Return a configuration file for the Xorg server containing search paths for |
10919 | all the common drivers. | |
f703413e LC |
10920 | |
10921 | @var{drivers} must be either the empty list, in which case Xorg chooses a | |
10922 | graphics driver automatically, or a list of driver names that will be tried in | |
d1cdd7ba | 10923 | this order---e.g., @code{(\"modesetting\" \"vesa\")}. |
d2e59637 LC |
10924 | |
10925 | Likewise, when @var{resolutions} is the empty list, Xorg chooses an | |
10926 | appropriate screen resolution; otherwise, it must be a list of | |
10927 | resolutions---e.g., @code{((1024 768) (640 480))}. | |
12422c9d LC |
10928 | |
10929 | Last, @var{extra-config} is a list of strings or objects appended to the | |
10930 | @code{text-file*} argument list. It is used to pass extra text to be added | |
10931 | verbatim to the configuration file. | |
f703413e | 10932 | @end deffn |
4af2447e | 10933 | |
6726282b LC |
10934 | @deffn {Scheme Procedure} screen-locker-service @var{package} [@var{name}] |
10935 | Add @var{package}, a package for a screen-locker or screen-saver whose | |
10936 | command is @var{program}, to the set of setuid programs and add a PAM entry | |
10937 | for it. For example: | |
10938 | ||
10939 | @lisp | |
10940 | (screen-locker-service xlockmore "xlock") | |
10941 | @end lisp | |
10942 | ||
10943 | makes the good ol' XlockMore usable. | |
10944 | @end deffn | |
10945 | ||
10946 | ||
f2ec23d1 AW |
10947 | @node Printing Services |
10948 | @subsubsection Printing Services | |
10949 | ||
de322a5d | 10950 | @cindex printer support with CUPS |
f2ec23d1 AW |
10951 | The @code{(gnu services cups)} module provides a Guix service definition |
10952 | for the CUPS printing service. To add printer support to a GuixSD | |
10953 | system, add a @code{cups-service} to the operating system definition: | |
10954 | ||
10955 | @deffn {Scheme Variable} cups-service-type | |
10956 | The service type for the CUPS print server. Its value should be a valid | |
3d3c5650 LC |
10957 | CUPS configuration (see below). To use the default settings, simply |
10958 | write: | |
f2ec23d1 | 10959 | @example |
3d3c5650 | 10960 | (service cups-service-type) |
f2ec23d1 AW |
10961 | @end example |
10962 | @end deffn | |
10963 | ||
10964 | The CUPS configuration controls the basic things about your CUPS | |
10965 | installation: what interfaces it listens on, what to do if a print job | |
10966 | fails, how much logging to do, and so on. To actually add a printer, | |
10967 | you have to visit the @url{http://localhost:631} URL, or use a tool such | |
10968 | as GNOME's printer configuration services. By default, configuring a | |
10969 | CUPS service will generate a self-signed certificate if needed, for | |
10970 | secure connections to the print server. | |
10971 | ||
de322a5d LC |
10972 | Suppose you want to enable the Web interface of CUPS and also add |
10973 | support for HP printers @i{via} the @code{hplip} package. You can do | |
10974 | that directly, like this (you need to use the @code{(gnu packages cups)} | |
10975 | module): | |
f2ec23d1 AW |
10976 | |
10977 | @example | |
10978 | (service cups-service-type | |
10979 | (cups-configuration | |
de322a5d LC |
10980 | (web-interface? #t) |
10981 | (extensions | |
10982 | (list cups-filters hplip)))) | |
f2ec23d1 AW |
10983 | @end example |
10984 | ||
10985 | The available configuration parameters follow. Each parameter | |
10986 | definition is preceded by its type; for example, @samp{string-list foo} | |
10987 | indicates that the @code{foo} parameter should be specified as a list of | |
10988 | strings. There is also a way to specify the configuration as a string, | |
10989 | if you have an old @code{cupsd.conf} file that you want to port over | |
10990 | from some other system; see the end for more details. | |
10991 | ||
10992 | @c The following documentation was initially generated by | |
10993 | @c (generate-documentation) in (gnu services cups). Manually maintained | |
10994 | @c documentation is better, so we shouldn't hesitate to edit below as | |
10995 | @c needed. However if the change you want to make to this documentation | |
10996 | @c can be done in an automated way, it's probably easier to change | |
10997 | @c (generate-documentation) than to make it below and have to deal with | |
10998 | @c the churn as CUPS updates. | |
10999 | ||
11000 | ||
11001 | Available @code{cups-configuration} fields are: | |
11002 | ||
11003 | @deftypevr {@code{cups-configuration} parameter} package cups | |
11004 | The CUPS package. | |
11005 | @end deftypevr | |
11006 | ||
11007 | @deftypevr {@code{cups-configuration} parameter} package-list extensions | |
11008 | Drivers and other extensions to the CUPS package. | |
11009 | @end deftypevr | |
11010 | ||
11011 | @deftypevr {@code{cups-configuration} parameter} files-configuration files-configuration | |
11012 | Configuration of where to write logs, what directories to use for print | |
11013 | spools, and related privileged configuration parameters. | |
11014 | ||
11015 | Available @code{files-configuration} fields are: | |
11016 | ||
11017 | @deftypevr {@code{files-configuration} parameter} log-location access-log | |
11018 | Defines the access log filename. Specifying a blank filename disables | |
11019 | access log generation. The value @code{stderr} causes log entries to be | |
11020 | sent to the standard error file when the scheduler is running in the | |
11021 | foreground, or to the system log daemon when run in the background. The | |
11022 | value @code{syslog} causes log entries to be sent to the system log | |
11023 | daemon. The server name may be included in filenames using the string | |
11024 | @code{%s}, as in @code{/var/log/cups/%s-access_log}. | |
11025 | ||
11026 | Defaults to @samp{"/var/log/cups/access_log"}. | |
11027 | @end deftypevr | |
11028 | ||
11029 | @deftypevr {@code{files-configuration} parameter} file-name cache-dir | |
11030 | Where CUPS should cache data. | |
11031 | ||
11032 | Defaults to @samp{"/var/cache/cups"}. | |
11033 | @end deftypevr | |
11034 | ||
11035 | @deftypevr {@code{files-configuration} parameter} string config-file-perm | |
11036 | Specifies the permissions for all configuration files that the scheduler | |
11037 | writes. | |
11038 | ||
11039 | Note that the permissions for the printers.conf file are currently | |
11040 | masked to only allow access from the scheduler user (typically root). | |
11041 | This is done because printer device URIs sometimes contain sensitive | |
11042 | authentication information that should not be generally known on the | |
11043 | system. There is no way to disable this security feature. | |
11044 | ||
11045 | Defaults to @samp{"0640"}. | |
11046 | @end deftypevr | |
11047 | ||
11048 | @deftypevr {@code{files-configuration} parameter} log-location error-log | |
11049 | Defines the error log filename. Specifying a blank filename disables | |
11050 | access log generation. The value @code{stderr} causes log entries to be | |
11051 | sent to the standard error file when the scheduler is running in the | |
11052 | foreground, or to the system log daemon when run in the background. The | |
11053 | value @code{syslog} causes log entries to be sent to the system log | |
11054 | daemon. The server name may be included in filenames using the string | |
11055 | @code{%s}, as in @code{/var/log/cups/%s-error_log}. | |
11056 | ||
11057 | Defaults to @samp{"/var/log/cups/error_log"}. | |
11058 | @end deftypevr | |
11059 | ||
11060 | @deftypevr {@code{files-configuration} parameter} string fatal-errors | |
11061 | Specifies which errors are fatal, causing the scheduler to exit. The | |
11062 | kind strings are: | |
11063 | ||
11064 | @table @code | |
11065 | @item none | |
11066 | No errors are fatal. | |
11067 | ||
11068 | @item all | |
11069 | All of the errors below are fatal. | |
11070 | ||
11071 | @item browse | |
11072 | Browsing initialization errors are fatal, for example failed connections | |
11073 | to the DNS-SD daemon. | |
11074 | ||
11075 | @item config | |
11076 | Configuration file syntax errors are fatal. | |
11077 | ||
11078 | @item listen | |
11079 | Listen or Port errors are fatal, except for IPv6 failures on the | |
11080 | loopback or @code{any} addresses. | |
11081 | ||
11082 | @item log | |
11083 | Log file creation or write errors are fatal. | |
11084 | ||
11085 | @item permissions | |
11086 | Bad startup file permissions are fatal, for example shared TLS | |
11087 | certificate and key files with world-read permissions. | |
11088 | @end table | |
11089 | ||
11090 | Defaults to @samp{"all -browse"}. | |
11091 | @end deftypevr | |
11092 | ||
11093 | @deftypevr {@code{files-configuration} parameter} boolean file-device? | |
11094 | Specifies whether the file pseudo-device can be used for new printer | |
11095 | queues. The URI @uref{file:///dev/null} is always allowed. | |
11096 | ||
11097 | Defaults to @samp{#f}. | |
11098 | @end deftypevr | |
11099 | ||
11100 | @deftypevr {@code{files-configuration} parameter} string group | |
11101 | Specifies the group name or ID that will be used when executing external | |
11102 | programs. | |
11103 | ||
11104 | Defaults to @samp{"lp"}. | |
11105 | @end deftypevr | |
11106 | ||
11107 | @deftypevr {@code{files-configuration} parameter} string log-file-perm | |
11108 | Specifies the permissions for all log files that the scheduler writes. | |
11109 | ||
11110 | Defaults to @samp{"0644"}. | |
11111 | @end deftypevr | |
11112 | ||
11113 | @deftypevr {@code{files-configuration} parameter} log-location page-log | |
11114 | Defines the page log filename. Specifying a blank filename disables | |
11115 | access log generation. The value @code{stderr} causes log entries to be | |
11116 | sent to the standard error file when the scheduler is running in the | |
11117 | foreground, or to the system log daemon when run in the background. The | |
11118 | value @code{syslog} causes log entries to be sent to the system log | |
11119 | daemon. The server name may be included in filenames using the string | |
11120 | @code{%s}, as in @code{/var/log/cups/%s-page_log}. | |
11121 | ||
11122 | Defaults to @samp{"/var/log/cups/page_log"}. | |
11123 | @end deftypevr | |
11124 | ||
11125 | @deftypevr {@code{files-configuration} parameter} string remote-root | |
11126 | Specifies the username that is associated with unauthenticated accesses | |
11127 | by clients claiming to be the root user. The default is @code{remroot}. | |
11128 | ||
11129 | Defaults to @samp{"remroot"}. | |
11130 | @end deftypevr | |
11131 | ||
11132 | @deftypevr {@code{files-configuration} parameter} file-name request-root | |
11133 | Specifies the directory that contains print jobs and other HTTP request | |
11134 | data. | |
11135 | ||
11136 | Defaults to @samp{"/var/spool/cups"}. | |
11137 | @end deftypevr | |
11138 | ||
11139 | @deftypevr {@code{files-configuration} parameter} sandboxing sandboxing | |
11140 | Specifies the level of security sandboxing that is applied to print | |
11141 | filters, backends, and other child processes of the scheduler; either | |
11142 | @code{relaxed} or @code{strict}. This directive is currently only | |
11143 | used/supported on macOS. | |
11144 | ||
11145 | Defaults to @samp{strict}. | |
11146 | @end deftypevr | |
11147 | ||
11148 | @deftypevr {@code{files-configuration} parameter} file-name server-keychain | |
11149 | Specifies the location of TLS certificates and private keys. CUPS will | |
11150 | look for public and private keys in this directory: a @code{.crt} files | |
11151 | for PEM-encoded certificates and corresponding @code{.key} files for | |
11152 | PEM-encoded private keys. | |
11153 | ||
11154 | Defaults to @samp{"/etc/cups/ssl"}. | |
11155 | @end deftypevr | |
11156 | ||
11157 | @deftypevr {@code{files-configuration} parameter} file-name server-root | |
11158 | Specifies the directory containing the server configuration files. | |
11159 | ||
11160 | Defaults to @samp{"/etc/cups"}. | |
11161 | @end deftypevr | |
11162 | ||
11163 | @deftypevr {@code{files-configuration} parameter} boolean sync-on-close? | |
11164 | Specifies whether the scheduler calls fsync(2) after writing | |
11165 | configuration or state files. | |
11166 | ||
11167 | Defaults to @samp{#f}. | |
11168 | @end deftypevr | |
11169 | ||
11170 | @deftypevr {@code{files-configuration} parameter} space-separated-string-list system-group | |
11171 | Specifies the group(s) to use for @code{@@SYSTEM} group authentication. | |
11172 | @end deftypevr | |
11173 | ||
11174 | @deftypevr {@code{files-configuration} parameter} file-name temp-dir | |
11175 | Specifies the directory where temporary files are stored. | |
11176 | ||
11177 | Defaults to @samp{"/var/spool/cups/tmp"}. | |
11178 | @end deftypevr | |
11179 | ||
11180 | @deftypevr {@code{files-configuration} parameter} string user | |
11181 | Specifies the user name or ID that is used when running external | |
11182 | programs. | |
11183 | ||
11184 | Defaults to @samp{"lp"}. | |
11185 | @end deftypevr | |
11186 | @end deftypevr | |
11187 | ||
11188 | @deftypevr {@code{cups-configuration} parameter} access-log-level access-log-level | |
11189 | Specifies the logging level for the AccessLog file. The @code{config} | |
11190 | level logs when printers and classes are added, deleted, or modified and | |
11191 | when configuration files are accessed or updated. The @code{actions} | |
11192 | level logs when print jobs are submitted, held, released, modified, or | |
11193 | canceled, and any of the conditions for @code{config}. The @code{all} | |
11194 | level logs all requests. | |
11195 | ||
11196 | Defaults to @samp{actions}. | |
11197 | @end deftypevr | |
11198 | ||
11199 | @deftypevr {@code{cups-configuration} parameter} boolean auto-purge-jobs? | |
11200 | Specifies whether to purge job history data automatically when it is no | |
11201 | longer required for quotas. | |
11202 | ||
11203 | Defaults to @samp{#f}. | |
11204 | @end deftypevr | |
11205 | ||
11206 | @deftypevr {@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols | |
11207 | Specifies which protocols to use for local printer sharing. | |
11208 | ||
11209 | Defaults to @samp{dnssd}. | |
11210 | @end deftypevr | |
11211 | ||
11212 | @deftypevr {@code{cups-configuration} parameter} boolean browse-web-if? | |
11213 | Specifies whether the CUPS web interface is advertised. | |
11214 | ||
11215 | Defaults to @samp{#f}. | |
11216 | @end deftypevr | |
11217 | ||
11218 | @deftypevr {@code{cups-configuration} parameter} boolean browsing? | |
11219 | Specifies whether shared printers are advertised. | |
11220 | ||
11221 | Defaults to @samp{#f}. | |
11222 | @end deftypevr | |
11223 | ||
11224 | @deftypevr {@code{cups-configuration} parameter} string classification | |
11225 | Specifies the security classification of the server. Any valid banner | |
11226 | name can be used, including "classified", "confidential", "secret", | |
11227 | "topsecret", and "unclassified", or the banner can be omitted to disable | |
11228 | secure printing functions. | |
11229 | ||
11230 | Defaults to @samp{""}. | |
11231 | @end deftypevr | |
11232 | ||
11233 | @deftypevr {@code{cups-configuration} parameter} boolean classify-override? | |
11234 | Specifies whether users may override the classification (cover page) of | |
11235 | individual print jobs using the @code{job-sheets} option. | |
11236 | ||
11237 | Defaults to @samp{#f}. | |
11238 | @end deftypevr | |
11239 | ||
11240 | @deftypevr {@code{cups-configuration} parameter} default-auth-type default-auth-type | |
11241 | Specifies the default type of authentication to use. | |
11242 | ||
11243 | Defaults to @samp{Basic}. | |
11244 | @end deftypevr | |
11245 | ||
11246 | @deftypevr {@code{cups-configuration} parameter} default-encryption default-encryption | |
11247 | Specifies whether encryption will be used for authenticated requests. | |
11248 | ||
11249 | Defaults to @samp{Required}. | |
11250 | @end deftypevr | |
11251 | ||
11252 | @deftypevr {@code{cups-configuration} parameter} string default-language | |
11253 | Specifies the default language to use for text and web content. | |
11254 | ||
11255 | Defaults to @samp{"en"}. | |
11256 | @end deftypevr | |
11257 | ||
11258 | @deftypevr {@code{cups-configuration} parameter} string default-paper-size | |
11259 | Specifies the default paper size for new print queues. @samp{"Auto"} | |
11260 | uses a locale-specific default, while @samp{"None"} specifies there is | |
11261 | no default paper size. Specific size names are typically | |
11262 | @samp{"Letter"} or @samp{"A4"}. | |
11263 | ||
11264 | Defaults to @samp{"Auto"}. | |
11265 | @end deftypevr | |
11266 | ||
11267 | @deftypevr {@code{cups-configuration} parameter} string default-policy | |
11268 | Specifies the default access policy to use. | |
11269 | ||
11270 | Defaults to @samp{"default"}. | |
11271 | @end deftypevr | |
11272 | ||
11273 | @deftypevr {@code{cups-configuration} parameter} boolean default-shared? | |
11274 | Specifies whether local printers are shared by default. | |
11275 | ||
11276 | Defaults to @samp{#t}. | |
11277 | @end deftypevr | |
11278 | ||
11279 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval | |
11280 | Specifies the delay for updating of configuration and state files, in | |
11281 | seconds. A value of 0 causes the update to happen as soon as possible, | |
11282 | typically within a few milliseconds. | |
11283 | ||
11284 | Defaults to @samp{30}. | |
11285 | @end deftypevr | |
11286 | ||
11287 | @deftypevr {@code{cups-configuration} parameter} error-policy error-policy | |
11288 | Specifies what to do when an error occurs. Possible values are | |
11289 | @code{abort-job}, which will discard the failed print job; | |
11290 | @code{retry-job}, which will retry the job at a later time; | |
11291 | @code{retry-this-job}, which retries the failed job immediately; and | |
11292 | @code{stop-printer}, which stops the printer. | |
11293 | ||
11294 | Defaults to @samp{stop-printer}. | |
11295 | @end deftypevr | |
11296 | ||
11297 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer filter-limit | |
11298 | Specifies the maximum cost of filters that are run concurrently, which | |
11299 | can be used to minimize disk, memory, and CPU resource problems. A | |
11300 | limit of 0 disables filter limiting. An average print to a | |
11301 | non-PostScript printer needs a filter limit of about 200. A PostScript | |
11302 | printer needs about half that (100). Setting the limit below these | |
11303 | thresholds will effectively limit the scheduler to printing a single job | |
11304 | at any time. | |
11305 | ||
11306 | Defaults to @samp{0}. | |
11307 | @end deftypevr | |
11308 | ||
11309 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer filter-nice | |
11310 | Specifies the scheduling priority of filters that are run to print a | |
11311 | job. The nice value ranges from 0, the highest priority, to 19, the | |
11312 | lowest priority. | |
11313 | ||
11314 | Defaults to @samp{0}. | |
11315 | @end deftypevr | |
11316 | ||
11317 | @deftypevr {@code{cups-configuration} parameter} host-name-lookups host-name-lookups | |
11318 | Specifies whether to do reverse lookups on connecting clients. The | |
11319 | @code{double} setting causes @code{cupsd} to verify that the hostname | |
11320 | resolved from the address matches one of the addresses returned for that | |
11321 | hostname. Double lookups also prevent clients with unregistered | |
11322 | addresses from connecting to your server. Only set this option to | |
11323 | @code{#t} or @code{double} if absolutely required. | |
11324 | ||
11325 | Defaults to @samp{#f}. | |
11326 | @end deftypevr | |
11327 | ||
11328 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer job-kill-delay | |
11329 | Specifies the number of seconds to wait before killing the filters and | |
11330 | backend associated with a canceled or held job. | |
11331 | ||
11332 | Defaults to @samp{30}. | |
11333 | @end deftypevr | |
11334 | ||
11335 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer job-retry-interval | |
11336 | Specifies the interval between retries of jobs in seconds. This is | |
11337 | typically used for fax queues but can also be used with normal print | |
11338 | queues whose error policy is @code{retry-job} or | |
11339 | @code{retry-current-job}. | |
11340 | ||
11341 | Defaults to @samp{30}. | |
11342 | @end deftypevr | |
11343 | ||
11344 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer job-retry-limit | |
11345 | Specifies the number of retries that are done for jobs. This is | |
11346 | typically used for fax queues but can also be used with normal print | |
11347 | queues whose error policy is @code{retry-job} or | |
11348 | @code{retry-current-job}. | |
11349 | ||
11350 | Defaults to @samp{5}. | |
11351 | @end deftypevr | |
11352 | ||
11353 | @deftypevr {@code{cups-configuration} parameter} boolean keep-alive? | |
11354 | Specifies whether to support HTTP keep-alive connections. | |
11355 | ||
11356 | Defaults to @samp{#t}. | |
11357 | @end deftypevr | |
11358 | ||
11359 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout | |
11360 | Specifies how long an idle client connection remains open, in seconds. | |
11361 | ||
11362 | Defaults to @samp{30}. | |
11363 | @end deftypevr | |
11364 | ||
11365 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer limit-request-body | |
11366 | Specifies the maximum size of print files, IPP requests, and HTML form | |
11367 | data. A limit of 0 disables the limit check. | |
11368 | ||
11369 | Defaults to @samp{0}. | |
11370 | @end deftypevr | |
11371 | ||
11372 | @deftypevr {@code{cups-configuration} parameter} multiline-string-list listen | |
11373 | Listens on the specified interfaces for connections. Valid values are | |
11374 | of the form @var{address}:@var{port}, where @var{address} is either an | |
11375 | IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to | |
11376 | indicate all addresses. Values can also be file names of local UNIX | |
11377 | domain sockets. The Listen directive is similar to the Port directive | |
11378 | but allows you to restrict access to specific interfaces or networks. | |
11379 | @end deftypevr | |
11380 | ||
11381 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer listen-back-log | |
11382 | Specifies the number of pending connections that will be allowed. This | |
11383 | normally only affects very busy servers that have reached the MaxClients | |
11384 | limit, but can also be triggered by large numbers of simultaneous | |
11385 | connections. When the limit is reached, the operating system will | |
11386 | refuse additional connections until the scheduler can accept the pending | |
11387 | ones. | |
11388 | ||
11389 | Defaults to @samp{128}. | |
11390 | @end deftypevr | |
11391 | ||
11392 | @deftypevr {@code{cups-configuration} parameter} location-access-control-list location-access-controls | |
11393 | Specifies a set of additional access controls. | |
11394 | ||
11395 | Available @code{location-access-controls} fields are: | |
11396 | ||
11397 | @deftypevr {@code{location-access-controls} parameter} file-name path | |
11398 | Specifies the URI path to which the access control applies. | |
11399 | @end deftypevr | |
11400 | ||
11401 | @deftypevr {@code{location-access-controls} parameter} access-control-list access-controls | |
11402 | Access controls for all access to this path, in the same format as the | |
11403 | @code{access-controls} of @code{operation-access-control}. | |
11404 | ||
11405 | Defaults to @samp{()}. | |
11406 | @end deftypevr | |
11407 | ||
11408 | @deftypevr {@code{location-access-controls} parameter} method-access-control-list method-access-controls | |
11409 | Access controls for method-specific access to this path. | |
11410 | ||
11411 | Defaults to @samp{()}. | |
11412 | ||
11413 | Available @code{method-access-controls} fields are: | |
11414 | ||
11415 | @deftypevr {@code{method-access-controls} parameter} boolean reverse? | |
11416 | If @code{#t}, apply access controls to all methods except the listed | |
11417 | methods. Otherwise apply to only the listed methods. | |
11418 | ||
11419 | Defaults to @samp{#f}. | |
11420 | @end deftypevr | |
11421 | ||
11422 | @deftypevr {@code{method-access-controls} parameter} method-list methods | |
11423 | Methods to which this access control applies. | |
11424 | ||
11425 | Defaults to @samp{()}. | |
11426 | @end deftypevr | |
11427 | ||
11428 | @deftypevr {@code{method-access-controls} parameter} access-control-list access-controls | |
11429 | Access control directives, as a list of strings. Each string should be | |
11430 | one directive, such as "Order allow,deny". | |
11431 | ||
11432 | Defaults to @samp{()}. | |
11433 | @end deftypevr | |
11434 | @end deftypevr | |
11435 | @end deftypevr | |
11436 | ||
11437 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer log-debug-history | |
11438 | Specifies the number of debugging messages that are retained for logging | |
11439 | if an error occurs in a print job. Debug messages are logged regardless | |
11440 | of the LogLevel setting. | |
11441 | ||
11442 | Defaults to @samp{100}. | |
11443 | @end deftypevr | |
11444 | ||
11445 | @deftypevr {@code{cups-configuration} parameter} log-level log-level | |
11446 | Specifies the level of logging for the ErrorLog file. The value | |
11447 | @code{none} stops all logging while @code{debug2} logs everything. | |
11448 | ||
11449 | Defaults to @samp{info}. | |
11450 | @end deftypevr | |
11451 | ||
11452 | @deftypevr {@code{cups-configuration} parameter} log-time-format log-time-format | |
11453 | Specifies the format of the date and time in the log files. The value | |
11454 | @code{standard} logs whole seconds while @code{usecs} logs microseconds. | |
11455 | ||
11456 | Defaults to @samp{standard}. | |
11457 | @end deftypevr | |
11458 | ||
11459 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-clients | |
11460 | Specifies the maximum number of simultaneous clients that are allowed by | |
11461 | the scheduler. | |
11462 | ||
11463 | Defaults to @samp{100}. | |
11464 | @end deftypevr | |
11465 | ||
11466 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-clients-per-host | |
11467 | Specifies the maximum number of simultaneous clients that are allowed | |
11468 | from a single address. | |
11469 | ||
11470 | Defaults to @samp{100}. | |
11471 | @end deftypevr | |
11472 | ||
11473 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-copies | |
11474 | Specifies the maximum number of copies that a user can print of each | |
11475 | job. | |
11476 | ||
11477 | Defaults to @samp{9999}. | |
11478 | @end deftypevr | |
11479 | ||
11480 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-hold-time | |
11481 | Specifies the maximum time a job may remain in the @code{indefinite} | |
11482 | hold state before it is canceled. A value of 0 disables cancellation of | |
11483 | held jobs. | |
11484 | ||
11485 | Defaults to @samp{0}. | |
11486 | @end deftypevr | |
11487 | ||
11488 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs | |
11489 | Specifies the maximum number of simultaneous jobs that are allowed. Set | |
11490 | to 0 to allow an unlimited number of jobs. | |
11491 | ||
11492 | Defaults to @samp{500}. | |
11493 | @end deftypevr | |
11494 | ||
11495 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer | |
11496 | Specifies the maximum number of simultaneous jobs that are allowed per | |
11497 | printer. A value of 0 allows up to MaxJobs jobs per printer. | |
11498 | ||
11499 | Defaults to @samp{0}. | |
11500 | @end deftypevr | |
11501 | ||
11502 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user | |
11503 | Specifies the maximum number of simultaneous jobs that are allowed per | |
11504 | user. A value of 0 allows up to MaxJobs jobs per user. | |
11505 | ||
11506 | Defaults to @samp{0}. | |
11507 | @end deftypevr | |
11508 | ||
11509 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-job-time | |
11510 | Specifies the maximum time a job may take to print before it is | |
11511 | canceled, in seconds. Set to 0 to disable cancellation of "stuck" jobs. | |
11512 | ||
11513 | Defaults to @samp{10800}. | |
11514 | @end deftypevr | |
11515 | ||
11516 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer max-log-size | |
11517 | Specifies the maximum size of the log files before they are rotated, in | |
11518 | bytes. The value 0 disables log rotation. | |
11519 | ||
11520 | Defaults to @samp{1048576}. | |
11521 | @end deftypevr | |
11522 | ||
11523 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout | |
11524 | Specifies the maximum amount of time to allow between files in a | |
11525 | multiple file print job, in seconds. | |
11526 | ||
11527 | Defaults to @samp{300}. | |
11528 | @end deftypevr | |
11529 | ||
11530 | @deftypevr {@code{cups-configuration} parameter} string page-log-format | |
11531 | Specifies the format of PageLog lines. Sequences beginning with percent | |
11532 | (@samp{%}) characters are replaced with the corresponding information, | |
11533 | while all other characters are copied literally. The following percent | |
11534 | sequences are recognized: | |
11535 | ||
11536 | @table @samp | |
11537 | @item %% | |
11538 | insert a single percent character | |
11539 | ||
11540 | @item %@{name@} | |
11541 | insert the value of the specified IPP attribute | |
11542 | ||
11543 | @item %C | |
11544 | insert the number of copies for the current page | |
11545 | ||
11546 | @item %P | |
11547 | insert the current page number | |
11548 | ||
11549 | @item %T | |
11550 | insert the current date and time in common log format | |
11551 | ||
11552 | @item %j | |
11553 | insert the job ID | |
11554 | ||
11555 | @item %p | |
11556 | insert the printer name | |
11557 | ||
11558 | @item %u | |
11559 | insert the username | |
11560 | @end table | |
11561 | ||
11562 | A value of the empty string disables page logging. The string @code{%p | |
11563 | %u %j %T %P %C %@{job-billing@} %@{job-originating-host-name@} | |
11564 | %@{job-name@} %@{media@} %@{sides@}} creates a page log with the | |
11565 | standard items. | |
11566 | ||
11567 | Defaults to @samp{""}. | |
11568 | @end deftypevr | |
11569 | ||
11570 | @deftypevr {@code{cups-configuration} parameter} environment-variables environment-variables | |
11571 | Passes the specified environment variable(s) to child processes; a list | |
11572 | of strings. | |
11573 | ||
11574 | Defaults to @samp{()}. | |
11575 | @end deftypevr | |
11576 | ||
11577 | @deftypevr {@code{cups-configuration} parameter} policy-configuration-list policies | |
11578 | Specifies named access control policies. | |
11579 | ||
11580 | Available @code{policy-configuration} fields are: | |
11581 | ||
11582 | @deftypevr {@code{policy-configuration} parameter} string name | |
11583 | Name of the policy. | |
11584 | @end deftypevr | |
11585 | ||
11586 | @deftypevr {@code{policy-configuration} parameter} string job-private-access | |
11587 | Specifies an access list for a job's private values. @code{@@ACL} maps | |
11588 | to the printer's requesting-user-name-allowed or | |
11589 | requesting-user-name-denied values. @code{@@OWNER} maps to the job's | |
11590 | owner. @code{@@SYSTEM} maps to the groups listed for the | |
11591 | @code{system-group} field of the @code{files-config} configuration, | |
11592 | which is reified into the @code{cups-files.conf(5)} file. Other | |
11593 | possible elements of the access list include specific user names, and | |
11594 | @code{@@@var{group}} to indicate members of a specific group. The | |
11595 | access list may also be simply @code{all} or @code{default}. | |
11596 | ||
11597 | Defaults to @samp{"@@OWNER @@SYSTEM"}. | |
11598 | @end deftypevr | |
11599 | ||
11600 | @deftypevr {@code{policy-configuration} parameter} string job-private-values | |
11601 | Specifies the list of job values to make private, or @code{all}, | |
11602 | @code{default}, or @code{none}. | |
11603 | ||
11604 | Defaults to @samp{"job-name job-originating-host-name | |
11605 | job-originating-user-name phone"}. | |
11606 | @end deftypevr | |
11607 | ||
11608 | @deftypevr {@code{policy-configuration} parameter} string subscription-private-access | |
11609 | Specifies an access list for a subscription's private values. | |
11610 | @code{@@ACL} maps to the printer's requesting-user-name-allowed or | |
11611 | requesting-user-name-denied values. @code{@@OWNER} maps to the job's | |
11612 | owner. @code{@@SYSTEM} maps to the groups listed for the | |
11613 | @code{system-group} field of the @code{files-config} configuration, | |
11614 | which is reified into the @code{cups-files.conf(5)} file. Other | |
11615 | possible elements of the access list include specific user names, and | |
11616 | @code{@@@var{group}} to indicate members of a specific group. The | |
11617 | access list may also be simply @code{all} or @code{default}. | |
11618 | ||
11619 | Defaults to @samp{"@@OWNER @@SYSTEM"}. | |
11620 | @end deftypevr | |
11621 | ||
11622 | @deftypevr {@code{policy-configuration} parameter} string subscription-private-values | |
11623 | Specifies the list of job values to make private, or @code{all}, | |
11624 | @code{default}, or @code{none}. | |
11625 | ||
11626 | Defaults to @samp{"notify-events notify-pull-method notify-recipient-uri | |
11627 | notify-subscriber-user-name notify-user-data"}. | |
11628 | @end deftypevr | |
11629 | ||
11630 | @deftypevr {@code{policy-configuration} parameter} operation-access-control-list access-controls | |
11631 | Access control by IPP operation. | |
11632 | ||
11633 | Defaults to @samp{()}. | |
11634 | @end deftypevr | |
11635 | @end deftypevr | |
11636 | ||
11637 | @deftypevr {@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files | |
11638 | Specifies whether job files (documents) are preserved after a job is | |
11639 | printed. If a numeric value is specified, job files are preserved for | |
11640 | the indicated number of seconds after printing. Otherwise a boolean | |
11641 | value applies indefinitely. | |
11642 | ||
11643 | Defaults to @samp{86400}. | |
11644 | @end deftypevr | |
11645 | ||
11646 | @deftypevr {@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history | |
11647 | Specifies whether the job history is preserved after a job is printed. | |
11648 | If a numeric value is specified, the job history is preserved for the | |
11649 | indicated number of seconds after printing. If @code{#t}, the job | |
11650 | history is preserved until the MaxJobs limit is reached. | |
11651 | ||
11652 | Defaults to @samp{#t}. | |
11653 | @end deftypevr | |
11654 | ||
11655 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer reload-timeout | |
11656 | Specifies the amount of time to wait for job completion before | |
11657 | restarting the scheduler. | |
11658 | ||
11659 | Defaults to @samp{30}. | |
11660 | @end deftypevr | |
11661 | ||
11662 | @deftypevr {@code{cups-configuration} parameter} string rip-cache | |
11663 | Specifies the maximum amount of memory to use when converting documents | |
11664 | into bitmaps for a printer. | |
11665 | ||
11666 | Defaults to @samp{"128m"}. | |
11667 | @end deftypevr | |
11668 | ||
11669 | @deftypevr {@code{cups-configuration} parameter} string server-admin | |
11670 | Specifies the email address of the server administrator. | |
11671 | ||
11672 | Defaults to @samp{"root@@localhost.localdomain"}. | |
11673 | @end deftypevr | |
11674 | ||
11675 | @deftypevr {@code{cups-configuration} parameter} host-name-list-or-* server-alias | |
11676 | The ServerAlias directive is used for HTTP Host header validation when | |
11677 | clients connect to the scheduler from external interfaces. Using the | |
11678 | special name @code{*} can expose your system to known browser-based DNS | |
11679 | rebinding attacks, even when accessing sites through a firewall. If the | |
11680 | auto-discovery of alternate names does not work, we recommend listing | |
11681 | each alternate name with a ServerAlias directive instead of using | |
11682 | @code{*}. | |
11683 | ||
11684 | Defaults to @samp{*}. | |
11685 | @end deftypevr | |
11686 | ||
11687 | @deftypevr {@code{cups-configuration} parameter} string server-name | |
11688 | Specifies the fully-qualified host name of the server. | |
11689 | ||
11690 | Defaults to @samp{"localhost"}. | |
11691 | @end deftypevr | |
11692 | ||
11693 | @deftypevr {@code{cups-configuration} parameter} server-tokens server-tokens | |
11694 | Specifies what information is included in the Server header of HTTP | |
11695 | responses. @code{None} disables the Server header. @code{ProductOnly} | |
11696 | reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} | |
11697 | reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. | |
11698 | @code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is | |
11699 | the output of the @code{uname} command. @code{Full} reports @code{CUPS | |
11700 | 2.0.0 (@var{uname}) IPP/2.0}. | |
11701 | ||
11702 | Defaults to @samp{Minimal}. | |
11703 | @end deftypevr | |
11704 | ||
11705 | @deftypevr {@code{cups-configuration} parameter} string set-env | |
11706 | Set the specified environment variable to be passed to child processes. | |
11707 | ||
11708 | Defaults to @samp{"variable value"}. | |
11709 | @end deftypevr | |
11710 | ||
11711 | @deftypevr {@code{cups-configuration} parameter} multiline-string-list ssl-listen | |
11712 | Listens on the specified interfaces for encrypted connections. Valid | |
11713 | values are of the form @var{address}:@var{port}, where @var{address} is | |
11714 | either an IPv6 address enclosed in brackets, an IPv4 address, or | |
11715 | @code{*} to indicate all addresses. | |
11716 | ||
11717 | Defaults to @samp{()}. | |
11718 | @end deftypevr | |
11719 | ||
11720 | @deftypevr {@code{cups-configuration} parameter} ssl-options ssl-options | |
11721 | Sets encryption options. By default, CUPS only supports encryption | |
11722 | using TLS v1.0 or higher using known secure cipher suites. The | |
11723 | @code{AllowRC4} option enables the 128-bit RC4 cipher suites, which are | |
11724 | required for some older clients that do not implement newer ones. The | |
11725 | @code{AllowSSL3} option enables SSL v3.0, which is required for some | |
11726 | older clients that do not support TLS v1.0. | |
11727 | ||
11728 | Defaults to @samp{()}. | |
11729 | @end deftypevr | |
11730 | ||
11731 | @deftypevr {@code{cups-configuration} parameter} boolean strict-conformance? | |
11732 | Specifies whether the scheduler requires clients to strictly adhere to | |
11733 | the IPP specifications. | |
11734 | ||
11735 | Defaults to @samp{#f}. | |
11736 | @end deftypevr | |
11737 | ||
11738 | @deftypevr {@code{cups-configuration} parameter} non-negative-integer timeout | |
11739 | Specifies the HTTP request timeout, in seconds. | |
11740 | ||
11741 | Defaults to @samp{300}. | |
11742 | ||
11743 | @end deftypevr | |
11744 | ||
11745 | @deftypevr {@code{cups-configuration} parameter} boolean web-interface? | |
11746 | Specifies whether the web interface is enabled. | |
11747 | ||
11748 | Defaults to @samp{#f}. | |
11749 | @end deftypevr | |
11750 | ||
11751 | At this point you're probably thinking ``oh dear, Guix manual, I like | |
11752 | you but you can stop already with the configuration options''. Indeed. | |
11753 | However, one more point: it could be that you have an existing | |
11754 | @code{cupsd.conf} that you want to use. In that case, you can pass an | |
11755 | @code{opaque-cups-configuration} as the configuration of a | |
11756 | @code{cups-service-type}. | |
11757 | ||
11758 | Available @code{opaque-cups-configuration} fields are: | |
11759 | ||
11760 | @deftypevr {@code{opaque-cups-configuration} parameter} package cups | |
11761 | The CUPS package. | |
11762 | @end deftypevr | |
11763 | ||
11764 | @deftypevr {@code{opaque-cups-configuration} parameter} string cupsd.conf | |
11765 | The contents of the @code{cupsd.conf}, as a string. | |
11766 | @end deftypevr | |
11767 | ||
11768 | @deftypevr {@code{opaque-cups-configuration} parameter} string cups-files.conf | |
11769 | The contents of the @code{cups-files.conf} file, as a string. | |
11770 | @end deftypevr | |
11771 | ||
11772 | For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in | |
11773 | strings of the same name, you could instantiate a CUPS service like | |
11774 | this: | |
11775 | ||
11776 | @example | |
11777 | (service cups-service-type | |
11778 | (opaque-cups-configuration | |
11779 | (cupsd.conf cupsd.conf) | |
11780 | (cups-files.conf cups-files.conf))) | |
11781 | @end example | |
11782 | ||
11783 | ||
fe1a39d3 LC |
11784 | @node Desktop Services |
11785 | @subsubsection Desktop Services | |
aa4ed923 | 11786 | |
fe1a39d3 LC |
11787 | The @code{(gnu services desktop)} module provides services that are |
11788 | usually useful in the context of a ``desktop'' setup---that is, on a | |
11789 | machine running a graphical display server, possibly with graphical user | |
7a2413e4 AW |
11790 | interfaces, etc. It also defines services that provide specific desktop |
11791 | environments like GNOME and XFCE. | |
aa4ed923 | 11792 | |
4467be21 LC |
11793 | To simplify things, the module defines a variable containing the set of |
11794 | services that users typically expect on a machine with a graphical | |
11795 | environment and networking: | |
11796 | ||
11797 | @defvr {Scheme Variable} %desktop-services | |
11798 | This is a list of services that builds upon @var{%base-services} and | |
1068f26b | 11799 | adds or adjusts services for a typical ``desktop'' setup. |
4467be21 LC |
11800 | |
11801 | In particular, it adds a graphical login manager (@pxref{X Window, | |
063c6082 | 11802 | @code{slim-service}}), screen lockers, a network management tool |
4110fbc6 | 11803 | (@pxref{Networking Services, @code{network-manager-service-type}}), energy and color |
063c6082 AW |
11804 | management services, the @code{elogind} login and seat manager, the |
11805 | Polkit privilege service, the GeoClue location service, the | |
11806 | AccountsService daemon that allows authorized users change system | |
11807 | passwords, an NTP client (@pxref{Networking Services}), the Avahi | |
11808 | daemon, and has the name service switch service configured to be able to | |
11809 | use @code{nss-mdns} (@pxref{Name Service Switch, mDNS}). | |
4467be21 LC |
11810 | @end defvr |
11811 | ||
11812 | The @var{%desktop-services} variable can be used as the @code{services} | |
11813 | field of an @code{operating-system} declaration (@pxref{operating-system | |
11814 | Reference, @code{services}}). | |
11815 | ||
7a2413e4 AW |
11816 | Additionally, the @code{gnome-desktop-service} and |
11817 | @code{xfce-desktop-service} procedures can add GNOME and/or XFCE to a | |
11818 | system. To ``add GNOME'' means that system-level services like the | |
11819 | backlight adjustment helpers and the power management utilities are | |
11820 | added to the system, extending @code{polkit} and @code{dbus} | |
11821 | appropriately, allowing GNOME to operate with elevated privileges on a | |
11822 | limited number of special-purpose system interfaces. Additionally, | |
11823 | adding a service made by @code{gnome-desktop-service} adds the GNOME | |
11824 | metapackage to the system profile. Likewise, adding the XFCE service | |
11825 | not only adds the @code{xfce} metapackage to the system profile, but it | |
11826 | also gives the Thunar file manager the ability to open a ``root-mode'' | |
11827 | file management window, if the user authenticates using the | |
11828 | administrator's password via the standard polkit graphical interface. | |
11829 | ||
11830 | @deffn {Scheme Procedure} gnome-desktop-service | |
11831 | Return a service that adds the @code{gnome} package to the system | |
11832 | profile, and extends polkit with the actions from | |
11833 | @code{gnome-settings-daemon}. | |
11834 | @end deffn | |
11835 | ||
11836 | @deffn {Scheme Procedure} xfce-desktop-service | |
11837 | Return a service that adds the @code{xfce} package to the system profile, | |
5741e3e5 | 11838 | and extends polkit with the ability for @code{thunar} to manipulate the |
7a2413e4 AW |
11839 | file system as root from within a user session, after the user has |
11840 | authenticated with the administrator's password. | |
11841 | @end deffn | |
11842 | ||
11843 | Because the GNOME and XFCE desktop services pull in so many packages, | |
11844 | the default @code{%desktop-services} variable doesn't include either of | |
11845 | them by default. To add GNOME or XFCE, just @code{cons} them onto | |
11846 | @code{%desktop-services} in the @code{services} field of your | |
11847 | @code{operating-system}: | |
11848 | ||
11849 | @example | |
11850 | (use-modules (gnu)) | |
11851 | (use-service-modules desktop) | |
11852 | (operating-system | |
11853 | ... | |
11854 | ;; cons* adds items to the list given as its last argument. | |
11855 | (services (cons* (gnome-desktop-service) | |
11856 | (xfce-desktop-service) | |
11857 | %desktop-services)) | |
11858 | ...) | |
11859 | @end example | |
11860 | ||
11861 | These desktop environments will then be available as options in the | |
11862 | graphical login window. | |
11863 | ||
11864 | The actual service definitions included in @code{%desktop-services} and | |
11865 | provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} | |
11866 | are described below. | |
4467be21 | 11867 | |
0adfe95a | 11868 | @deffn {Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()] |
fe1a39d3 LC |
11869 | Return a service that runs the ``system bus'', using @var{dbus}, with |
11870 | support for @var{services}. | |
aa4ed923 | 11871 | |
fe1a39d3 LC |
11872 | @uref{http://dbus.freedesktop.org/, D-Bus} is an inter-process communication |
11873 | facility. Its system bus is used to allow system services to communicate | |
1068f26b | 11874 | and to be notified of system-wide events. |
aa4ed923 | 11875 | |
fe1a39d3 LC |
11876 | @var{services} must be a list of packages that provide an |
11877 | @file{etc/dbus-1/system.d} directory containing additional D-Bus configuration | |
11878 | and policy files. For example, to allow avahi-daemon to use the system bus, | |
11879 | @var{services} must be equal to @code{(list avahi)}. | |
aa4ed923 AK |
11880 | @end deffn |
11881 | ||
0adfe95a | 11882 | @deffn {Scheme Procedure} elogind-service [#:config @var{config}] |
4650a77e | 11883 | Return a service that runs the @code{elogind} login and |
acc2ab65 | 11884 | seat management daemon. @uref{https://github.com/elogind/elogind, |
4650a77e AW |
11885 | Elogind} exposes a D-Bus interface that can be used to know which users |
11886 | are logged in, know what kind of sessions they have open, suspend the | |
11887 | system, inhibit system suspend, reboot the system, and other tasks. | |
11888 | ||
11889 | Elogind handles most system-level power events for a computer, for | |
11890 | example suspending the system when a lid is closed, or shutting it down | |
11891 | when the power button is pressed. | |
11892 | ||
11893 | The @var{config} keyword argument specifies the configuration for | |
1068f26b | 11894 | elogind, and should be the result of an @code{(elogind-configuration |
4650a77e AW |
11895 | (@var{parameter} @var{value})...)} invocation. Available parameters and |
11896 | their default values are: | |
11897 | ||
11898 | @table @code | |
11899 | @item kill-user-processes? | |
11900 | @code{#f} | |
11901 | @item kill-only-users | |
11902 | @code{()} | |
11903 | @item kill-exclude-users | |
11904 | @code{("root")} | |
11905 | @item inhibit-delay-max-seconds | |
11906 | @code{5} | |
11907 | @item handle-power-key | |
11908 | @code{poweroff} | |
11909 | @item handle-suspend-key | |
11910 | @code{suspend} | |
11911 | @item handle-hibernate-key | |
11912 | @code{hibernate} | |
11913 | @item handle-lid-switch | |
11914 | @code{suspend} | |
11915 | @item handle-lid-switch-docked | |
11916 | @code{ignore} | |
11917 | @item power-key-ignore-inhibited? | |
11918 | @code{#f} | |
11919 | @item suspend-key-ignore-inhibited? | |
11920 | @code{#f} | |
11921 | @item hibernate-key-ignore-inhibited? | |
11922 | @code{#f} | |
11923 | @item lid-switch-ignore-inhibited? | |
11924 | @code{#t} | |
11925 | @item holdoff-timeout-seconds | |
11926 | @code{30} | |
11927 | @item idle-action | |
11928 | @code{ignore} | |
11929 | @item idle-action-seconds | |
11930 | @code{(* 30 60)} | |
11931 | @item runtime-directory-size-percent | |
11932 | @code{10} | |
11933 | @item runtime-directory-size | |
11934 | @code{#f} | |
11935 | @item remove-ipc? | |
11936 | @code{#t} | |
11937 | @item suspend-state | |
11938 | @code{("mem" "standby" "freeze")} | |
11939 | @item suspend-mode | |
11940 | @code{()} | |
11941 | @item hibernate-state | |
11942 | @code{("disk")} | |
11943 | @item hibernate-mode | |
11944 | @code{("platform" "shutdown")} | |
11945 | @item hybrid-sleep-state | |
11946 | @code{("disk")} | |
11947 | @item hybrid-sleep-mode | |
11948 | @code{("suspend" "platform" "shutdown")} | |
11949 | @end table | |
11950 | @end deffn | |
11951 | ||
063c6082 AW |
11952 | @deffn {Scheme Procedure} accountsservice-service @ |
11953 | [#:accountsservice @var{accountsservice}] | |
11954 | Return a service that runs AccountsService, a system service that can | |
11955 | list available accounts, change their passwords, and so on. | |
11956 | AccountsService integrates with PolicyKit to enable unprivileged users | |
11957 | to acquire the capability to modify their system configuration. | |
11958 | @uref{https://www.freedesktop.org/wiki/Software/AccountsService/, the | |
11959 | accountsservice web site} for more information. | |
11960 | ||
11961 | The @var{accountsservice} keyword argument is the @code{accountsservice} | |
11962 | package to expose as a service. | |
11963 | @end deffn | |
11964 | ||
be1c2c54 | 11965 | @deffn {Scheme Procedure} polkit-service @ |
4650a77e | 11966 | [#:polkit @var{polkit}] |
222e3319 LC |
11967 | Return a service that runs the |
11968 | @uref{http://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege | |
11969 | management service}, which allows system administrators to grant access to | |
11970 | privileged operations in a structured way. By querying the Polkit service, a | |
11971 | privileged system component can know when it should grant additional | |
11972 | capabilities to ordinary users. For example, an ordinary user can be granted | |
11973 | the capability to suspend the system if the user is logged in locally. | |
4650a77e AW |
11974 | @end deffn |
11975 | ||
be1c2c54 | 11976 | @deffn {Scheme Procedure} upower-service [#:upower @var{upower}] @ |
be234128 AW |
11977 | [#:watts-up-pro? #f] @ |
11978 | [#:poll-batteries? #t] @ | |
11979 | [#:ignore-lid? #f] @ | |
11980 | [#:use-percentage-for-policy? #f] @ | |
11981 | [#:percentage-low 10] @ | |
11982 | [#:percentage-critical 3] @ | |
11983 | [#:percentage-action 2] @ | |
11984 | [#:time-low 1200] @ | |
11985 | [#:time-critical 300] @ | |
11986 | [#:time-action 120] @ | |
11987 | [#:critical-power-action 'hybrid-sleep] | |
11988 | Return a service that runs @uref{http://upower.freedesktop.org/, | |
11989 | @command{upowerd}}, a system-wide monitor for power consumption and battery | |
11990 | levels, with the given configuration settings. It implements the | |
11991 | @code{org.freedesktop.UPower} D-Bus interface, and is notably used by | |
11992 | GNOME. | |
11993 | @end deffn | |
11994 | ||
2b9e0a94 LC |
11995 | @deffn {Scheme Procedure} udisks-service [#:udisks @var{udisks}] |
11996 | Return a service for @uref{http://udisks.freedesktop.org/docs/latest/, | |
11997 | UDisks}, a @dfn{disk management} daemon that provides user interfaces with | |
11998 | notifications and ways to mount/unmount disks. Programs that talk to UDisks | |
11999 | include the @command{udisksctl} command, part of UDisks, and GNOME Disks. | |
12000 | @end deffn | |
12001 | ||
be1c2c54 | 12002 | @deffn {Scheme Procedure} colord-service [#:colord @var{colord}] |
7ce597ff AW |
12003 | Return a service that runs @command{colord}, a system service with a D-Bus |
12004 | interface to manage the color profiles of input and output devices such as | |
12005 | screens and scanners. It is notably used by the GNOME Color Manager graphical | |
12006 | tool. See @uref{http://www.freedesktop.org/software/colord/, the colord web | |
12007 | site} for more information. | |
12008 | @end deffn | |
12009 | ||
cee32ee4 | 12010 | @deffn {Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()] |
1068f26b | 12011 | Return a configuration allowing an application to access GeoClue |
cee32ee4 AW |
12012 | location data. @var{name} is the Desktop ID of the application, without |
12013 | the @code{.desktop} part. If @var{allowed?} is true, the application | |
12014 | will have access to location information by default. The boolean | |
1068f26b | 12015 | @var{system?} value indicates whether an application is a system component |
cee32ee4 AW |
12016 | or not. Finally @var{users} is a list of UIDs of all users for which |
12017 | this application is allowed location info access. An empty users list | |
12018 | means that all users are allowed. | |
12019 | @end deffn | |
12020 | ||
12021 | @defvr {Scheme Variable} %standard-geoclue-applications | |
12022 | The standard list of well-known GeoClue application configurations, | |
1068f26b AE |
12023 | granting authority to the GNOME date-and-time utility to ask for the |
12024 | current location in order to set the time zone, and allowing the | |
12025 | IceCat and Epiphany web browsers to request location information. | |
12026 | IceCat and Epiphany both query the user before allowing a web page to | |
cee32ee4 AW |
12027 | know the user's location. |
12028 | @end defvr | |
12029 | ||
be1c2c54 | 12030 | @deffn {Scheme Procedure} geoclue-service [#:colord @var{colord}] @ |
cee32ee4 AW |
12031 | [#:whitelist '()] @ |
12032 | [#:wifi-geolocation-url "https://location.services.mozilla.com/v1/geolocate?key=geoclue"] @ | |
12033 | [#:submit-data? #f] | |
12034 | [#:wifi-submission-url "https://location.services.mozilla.com/v1/submit?key=geoclue"] @ | |
12035 | [#:submission-nick "geoclue"] @ | |
12036 | [#:applications %standard-geoclue-applications] | |
12037 | Return a service that runs the GeoClue location service. This service | |
12038 | provides a D-Bus interface to allow applications to request access to a | |
12039 | user's physical location, and optionally to add information to online | |
12040 | location databases. See | |
12041 | @uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue | |
12042 | web site} for more information. | |
12043 | @end deffn | |
12044 | ||
b9f67d6d MC |
12045 | @deffn {Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @ |
12046 | [@w{#:auto-enable? #f}] | |
12047 | Return a service that runs the @command{bluetoothd} daemon, which | |
12048 | manages all the Bluetooth devices and provides a number of D-Bus | |
12049 | interfaces. When AUTO-ENABLE? is true, the bluetooth controller is | |
12050 | powered automatically at boot, which can be useful when using a | |
12051 | bluetooth keyboard or mouse. | |
922e21f4 SB |
12052 | |
12053 | Users need to be in the @code{lp} group to access the D-Bus service. | |
12054 | @end deffn | |
12055 | ||
105369a4 DT |
12056 | @node Database Services |
12057 | @subsubsection Database Services | |
12058 | ||
e32171ee JD |
12059 | @cindex database |
12060 | @cindex SQL | |
6575183b | 12061 | The @code{(gnu services databases)} module provides the following services. |
105369a4 | 12062 | |
be1c2c54 | 12063 | @deffn {Scheme Procedure} postgresql-service [#:postgresql postgresql] @ |
2d3d5cc5 | 12064 | [#:config-file] [#:data-directory ``/var/lib/postgresql/data''] @ |
e05b780a | 12065 | [#:port 5432] [#:locale ``en_US.utf8''] |
105369a4 DT |
12066 | Return a service that runs @var{postgresql}, the PostgreSQL database |
12067 | server. | |
12068 | ||
e05b780a CB |
12069 | The PostgreSQL daemon loads its runtime configuration from @var{config-file}, |
12070 | creates a database cluster with @var{locale} as the default | |
12071 | locale, stored in @var{data-directory}. It then listens on @var{port}. | |
105369a4 | 12072 | @end deffn |
fe1a39d3 | 12073 | |
6575183b SB |
12074 | @deffn {Scheme Procedure} mysql-service [#:config (mysql-configuration)] |
12075 | Return a service that runs @command{mysqld}, the MySQL or MariaDB | |
12076 | database server. | |
12077 | ||
12078 | The optional @var{config} argument specifies the configuration for | |
c940b8e6 | 12079 | @command{mysqld}, which should be a @code{<mysql-configuration>} object. |
6575183b SB |
12080 | @end deffn |
12081 | ||
12082 | @deftp {Data Type} mysql-configuration | |
12083 | Data type representing the configuration of @var{mysql-service}. | |
12084 | ||
12085 | @table @asis | |
12086 | @item @code{mysql} (default: @var{mariadb}) | |
12087 | Package object of the MySQL database server, can be either @var{mariadb} | |
12088 | or @var{mysql}. | |
12089 | ||
7414de0a | 12090 | For MySQL, a temporary root password will be displayed at activation time. |
6575183b | 12091 | For MariaDB, the root password is empty. |
4b41febf CB |
12092 | |
12093 | @item @code{port} (default: @code{3306}) | |
12094 | TCP port on which the database server listens for incoming connections. | |
6575183b SB |
12095 | @end table |
12096 | @end deftp | |
12097 | ||
119fdd0d CB |
12098 | @defvr {Scheme Variable} memcached-service-type |
12099 | This is the service type for the @uref{https://memcached.org/, | |
12100 | Memcached} service, which provides a distributed in memory cache. The | |
12101 | value for the service type is a @code{memcached-configuration} object. | |
12102 | @end defvr | |
12103 | ||
12104 | @example | |
12105 | (service memcached-service-type) | |
12106 | @end example | |
12107 | ||
12108 | @deftp {Data Type} memcached-configuration | |
12109 | Data type representing the configuration of memcached. | |
12110 | ||
12111 | @table @asis | |
12112 | @item @code{memcached} (default: @code{memcached}) | |
12113 | The Memcached package to use. | |
12114 | ||
12115 | @item @code{interfaces} (default: @code{'("0.0.0.0")}) | |
12116 | Network interfaces on which to listen. | |
12117 | ||
12118 | @item @code{tcp-port} (default: @code{11211}) | |
12119 | Port on which to accept connections on, | |
12120 | ||
12121 | @item @code{udp-port} (default: @code{11211}) | |
12122 | Port on which to accept UDP connections on, a value of 0 will disable | |
12123 | listening on a UDP socket. | |
12124 | ||
12125 | @item @code{additional-options} (default: @code{'()}) | |
12126 | Additional command line options to pass to @code{memcached}. | |
12127 | @end table | |
12128 | @end deftp | |
12129 | ||
5266ff71 CB |
12130 | @defvr {Scheme Variable} mongodb-service-type |
12131 | This is the service type for @uref{https://www.mongodb.com/, MongoDB}. | |
12132 | The value for the service type is a @code{mongodb-configuration} object. | |
12133 | @end defvr | |
12134 | ||
12135 | @example | |
12136 | (service mongodb-service-type) | |
12137 | @end example | |
12138 | ||
12139 | @deftp {Data Type} mongodb-configuration | |
12140 | Data type representing the configuration of mongodb. | |
12141 | ||
12142 | @table @asis | |
12143 | @item @code{mongodb} (default: @code{mongodb}) | |
12144 | The MongoDB package to use. | |
12145 | ||
12146 | @item @code{config-file} (default: @code{%default-mongodb-configuration-file}) | |
12147 | The configuration file for MongoDB. | |
12148 | ||
12149 | @item @code{data-directory} (default: @code{"/var/lib/mongodb"}) | |
12150 | This value is used to create the directory, so that it exists and is | |
12151 | owned by the mongodb user. It should match the data-directory which | |
12152 | MongoDB is configured to use through the configuration file. | |
12153 | @end table | |
12154 | @end deftp | |
12155 | ||
67cadaca CB |
12156 | @defvr {Scheme Variable} redis-service-type |
12157 | This is the service type for the @uref{https://redis.io/, Redis} | |
12158 | key/value store, whose value is a @code{redis-configuration} object. | |
12159 | @end defvr | |
12160 | ||
12161 | @deftp {Data Type} redis-configuration | |
12162 | Data type representing the configuration of redis. | |
12163 | ||
12164 | @table @asis | |
12165 | @item @code{redis} (default: @code{redis}) | |
12166 | The Redis package to use. | |
12167 | ||
12168 | @item @code{bind} (default: @code{"127.0.0.1"}) | |
12169 | Network interface on which to listen. | |
12170 | ||
12171 | @item @code{port} (default: @code{6379}) | |
12172 | Port on which to accept connections on, a value of 0 will disable | |
9fc221b5 | 12173 | listening on a TCP socket. |
67cadaca CB |
12174 | |
12175 | @item @code{working-directory} (default: @code{"/var/lib/redis"}) | |
12176 | Directory in which to store the database and related files. | |
12177 | @end table | |
12178 | @end deftp | |
12179 | ||
d8c18af8 AW |
12180 | @node Mail Services |
12181 | @subsubsection Mail Services | |
12182 | ||
e32171ee JD |
12183 | @cindex mail |
12184 | @cindex email | |
d8c18af8 | 12185 | The @code{(gnu services mail)} module provides Guix service definitions |
f88371e8 SB |
12186 | for email services: IMAP, POP3, and LMTP servers, as well as mail |
12187 | transport agents (MTAs). Lots of acronyms! These services are detailed | |
12188 | in the subsections below. | |
d8c18af8 | 12189 | |
f88371e8 | 12190 | @subsubheading Dovecot Service |
d8c18af8 AW |
12191 | |
12192 | @deffn {Scheme Procedure} dovecot-service [#:config (dovecot-configuration)] | |
12193 | Return a service that runs the Dovecot IMAP/POP3/LMTP mail server. | |
12194 | @end deffn | |
12195 | ||
1068f26b | 12196 | By default, Dovecot does not need much configuration; the default |
d8c18af8 AW |
12197 | configuration object created by @code{(dovecot-configuration)} will |
12198 | suffice if your mail is delivered to @code{~/Maildir}. A self-signed | |
12199 | certificate will be generated for TLS-protected connections, though | |
12200 | Dovecot will also listen on cleartext ports by default. There are a | |
1068f26b | 12201 | number of options, though, which mail administrators might need to change, |
d8c18af8 AW |
12202 | and as is the case with other services, Guix allows the system |
12203 | administrator to specify these parameters via a uniform Scheme interface. | |
12204 | ||
12205 | For example, to specify that mail is located at @code{maildir~/.mail}, | |
12206 | one would instantiate the Dovecot service like this: | |
12207 | ||
12208 | @example | |
12209 | (dovecot-service #:config | |
12210 | (dovecot-configuration | |
12211 | (mail-location "maildir:~/.mail"))) | |
12212 | @end example | |
12213 | ||
12214 | The available configuration parameters follow. Each parameter | |
12215 | definition is preceded by its type; for example, @samp{string-list foo} | |
12216 | indicates that the @code{foo} parameter should be specified as a list of | |
12217 | strings. There is also a way to specify the configuration as a string, | |
12218 | if you have an old @code{dovecot.conf} file that you want to port over | |
12219 | from some other system; see the end for more details. | |
12220 | ||
12221 | @c The following documentation was initially generated by | |
12222 | @c (generate-documentation) in (gnu services mail). Manually maintained | |
12223 | @c documentation is better, so we shouldn't hesitate to edit below as | |
12224 | @c needed. However if the change you want to make to this documentation | |
12225 | @c can be done in an automated way, it's probably easier to change | |
12226 | @c (generate-documentation) than to make it below and have to deal with | |
12227 | @c the churn as dovecot updates. | |
12228 | ||
12229 | Available @code{dovecot-configuration} fields are: | |
12230 | ||
12231 | @deftypevr {@code{dovecot-configuration} parameter} package dovecot | |
12232 | The dovecot package. | |
12233 | @end deftypevr | |
12234 | ||
12235 | @deftypevr {@code{dovecot-configuration} parameter} comma-separated-string-list listen | |
1068f26b AE |
12236 | A list of IPs or hosts where to listen for connections. @samp{*} |
12237 | listens on all IPv4 interfaces, @samp{::} listens on all IPv6 | |
d8c18af8 AW |
12238 | interfaces. If you want to specify non-default ports or anything more |
12239 | complex, customize the address and port fields of the | |
12240 | @samp{inet-listener} of the specific services you are interested in. | |
12241 | @end deftypevr | |
12242 | ||
12243 | @deftypevr {@code{dovecot-configuration} parameter} protocol-configuration-list protocols | |
12244 | List of protocols we want to serve. Available protocols include | |
12245 | @samp{imap}, @samp{pop3}, and @samp{lmtp}. | |
12246 | ||
12247 | Available @code{protocol-configuration} fields are: | |
12248 | ||
12249 | @deftypevr {@code{protocol-configuration} parameter} string name | |
12250 | The name of the protocol. | |
12251 | @end deftypevr | |
12252 | ||
12253 | @deftypevr {@code{protocol-configuration} parameter} string auth-socket-path | |
1068f26b | 12254 | UNIX socket path to the master authentication server to find users. |
d8c18af8 | 12255 | This is used by imap (for shared users) and lda. |
1068f26b | 12256 | It defaults to @samp{"/var/run/dovecot/auth-userdb"}. |
d8c18af8 AW |
12257 | @end deftypevr |
12258 | ||
12259 | @deftypevr {@code{protocol-configuration} parameter} space-separated-string-list mail-plugins | |
12260 | Space separated list of plugins to load. | |
12261 | @end deftypevr | |
12262 | ||
12263 | @deftypevr {@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections | |
12264 | Maximum number of IMAP connections allowed for a user from each IP | |
12265 | address. NOTE: The username is compared case-sensitively. | |
12266 | Defaults to @samp{10}. | |
12267 | @end deftypevr | |
12268 | ||
12269 | @end deftypevr | |
12270 | ||
12271 | @deftypevr {@code{dovecot-configuration} parameter} service-configuration-list services | |
12272 | List of services to enable. Available services include @samp{imap}, | |
12273 | @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and | |
12274 | @samp{lmtp}. | |
12275 | ||
12276 | Available @code{service-configuration} fields are: | |
12277 | ||
12278 | @deftypevr {@code{service-configuration} parameter} string kind | |
12279 | The service kind. Valid values include @code{director}, | |
12280 | @code{imap-login}, @code{pop3-login}, @code{lmtp}, @code{imap}, | |
12281 | @code{pop3}, @code{auth}, @code{auth-worker}, @code{dict}, | |
12282 | @code{tcpwrap}, @code{quota-warning}, or anything else. | |
12283 | @end deftypevr | |
12284 | ||
12285 | @deftypevr {@code{service-configuration} parameter} listener-configuration-list listeners | |
1068f26b | 12286 | Listeners for the service. A listener is either a |
d8c18af8 AW |
12287 | @code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or |
12288 | an @code{inet-listener-configuration}. | |
12289 | Defaults to @samp{()}. | |
12290 | ||
12291 | Available @code{unix-listener-configuration} fields are: | |
12292 | ||
eba56076 CL |
12293 | @deftypevr {@code{unix-listener-configuration} parameter} string path |
12294 | Path to the file, relative to @code{base-dir} field. This is also used as | |
12295 | the section name. | |
d8c18af8 AW |
12296 | @end deftypevr |
12297 | ||
12298 | @deftypevr {@code{unix-listener-configuration} parameter} string mode | |
12299 | The access mode for the socket. | |
12300 | Defaults to @samp{"0600"}. | |
12301 | @end deftypevr | |
12302 | ||
12303 | @deftypevr {@code{unix-listener-configuration} parameter} string user | |
f9b9a033 | 12304 | The user to own the socket. |
d8c18af8 AW |
12305 | Defaults to @samp{""}. |
12306 | @end deftypevr | |
12307 | ||
12308 | @deftypevr {@code{unix-listener-configuration} parameter} string group | |
12309 | The group to own the socket. | |
12310 | Defaults to @samp{""}. | |
12311 | @end deftypevr | |
12312 | ||
12313 | ||
12314 | Available @code{fifo-listener-configuration} fields are: | |
12315 | ||
eba56076 CL |
12316 | @deftypevr {@code{fifo-listener-configuration} parameter} string path |
12317 | Path to the file, relative to @code{base-dir} field. This is also used as | |
12318 | the section name. | |
d8c18af8 AW |
12319 | @end deftypevr |
12320 | ||
12321 | @deftypevr {@code{fifo-listener-configuration} parameter} string mode | |
12322 | The access mode for the socket. | |
12323 | Defaults to @samp{"0600"}. | |
12324 | @end deftypevr | |
12325 | ||
12326 | @deftypevr {@code{fifo-listener-configuration} parameter} string user | |
f9b9a033 | 12327 | The user to own the socket. |
d8c18af8 AW |
12328 | Defaults to @samp{""}. |
12329 | @end deftypevr | |
12330 | ||
12331 | @deftypevr {@code{fifo-listener-configuration} parameter} string group | |
12332 | The group to own the socket. | |
12333 | Defaults to @samp{""}. | |
12334 | @end deftypevr | |
12335 | ||
12336 | ||
12337 | Available @code{inet-listener-configuration} fields are: | |
12338 | ||
12339 | @deftypevr {@code{inet-listener-configuration} parameter} string protocol | |
12340 | The protocol to listen for. | |
12341 | @end deftypevr | |
12342 | ||
12343 | @deftypevr {@code{inet-listener-configuration} parameter} string address | |
12344 | The address on which to listen, or empty for all addresses. | |
12345 | Defaults to @samp{""}. | |
12346 | @end deftypevr | |
12347 | ||
12348 | @deftypevr {@code{inet-listener-configuration} parameter} non-negative-integer port | |
12349 | The port on which to listen. | |
12350 | @end deftypevr | |
12351 | ||
12352 | @deftypevr {@code{inet-listener-configuration} parameter} boolean ssl? | |
12353 | Whether to use SSL for this service; @samp{yes}, @samp{no}, or | |
12354 | @samp{required}. | |
12355 | Defaults to @samp{#t}. | |
12356 | @end deftypevr | |
12357 | ||
12358 | @end deftypevr | |
12359 | ||
12360 | @deftypevr {@code{service-configuration} parameter} non-negative-integer service-count | |
12361 | Number of connections to handle before starting a new process. | |
12362 | Typically the only useful values are 0 (unlimited) or 1. 1 is more | |
12363 | secure, but 0 is faster. <doc/wiki/LoginProcess.txt>. | |
12364 | Defaults to @samp{1}. | |
12365 | @end deftypevr | |
12366 | ||
12367 | @deftypevr {@code{service-configuration} parameter} non-negative-integer process-min-avail | |
12368 | Number of processes to always keep waiting for more connections. | |
12369 | Defaults to @samp{0}. | |
12370 | @end deftypevr | |
12371 | ||
12372 | @deftypevr {@code{service-configuration} parameter} non-negative-integer vsz-limit | |
12373 | If you set @samp{service-count 0}, you probably need to grow | |
12374 | this. | |
12375 | Defaults to @samp{256000000}. | |
12376 | @end deftypevr | |
12377 | ||
12378 | @end deftypevr | |
12379 | ||
12380 | @deftypevr {@code{dovecot-configuration} parameter} dict-configuration dict | |
12381 | Dict configuration, as created by the @code{dict-configuration} | |
12382 | constructor. | |
12383 | ||
12384 | Available @code{dict-configuration} fields are: | |
12385 | ||
12386 | @deftypevr {@code{dict-configuration} parameter} free-form-fields entries | |
12387 | A list of key-value pairs that this dict should hold. | |
12388 | Defaults to @samp{()}. | |
12389 | @end deftypevr | |
12390 | ||
12391 | @end deftypevr | |
12392 | ||
12393 | @deftypevr {@code{dovecot-configuration} parameter} passdb-configuration-list passdbs | |
1068f26b | 12394 | A list of passdb configurations, each one created by the |
d8c18af8 AW |
12395 | @code{passdb-configuration} constructor. |
12396 | ||
12397 | Available @code{passdb-configuration} fields are: | |
12398 | ||
12399 | @deftypevr {@code{passdb-configuration} parameter} string driver | |
12400 | The driver that the passdb should use. Valid values include | |
12401 | @samp{pam}, @samp{passwd}, @samp{shadow}, @samp{bsdauth}, and | |
12402 | @samp{static}. | |
12403 | Defaults to @samp{"pam"}. | |
12404 | @end deftypevr | |
12405 | ||
deb36188 CL |
12406 | @deftypevr {@code{passdb-configuration} parameter} space-separated-string-list args |
12407 | Space separated list of arguments to the passdb driver. | |
12408 | Defaults to @samp{""}. | |
d8c18af8 AW |
12409 | @end deftypevr |
12410 | ||
12411 | @end deftypevr | |
12412 | ||
12413 | @deftypevr {@code{dovecot-configuration} parameter} userdb-configuration-list userdbs | |
12414 | List of userdb configurations, each one created by the | |
12415 | @code{userdb-configuration} constructor. | |
12416 | ||
12417 | Available @code{userdb-configuration} fields are: | |
12418 | ||
12419 | @deftypevr {@code{userdb-configuration} parameter} string driver | |
12420 | The driver that the userdb should use. Valid values include | |
12421 | @samp{passwd} and @samp{static}. | |
12422 | Defaults to @samp{"passwd"}. | |
12423 | @end deftypevr | |
12424 | ||
deb36188 CL |
12425 | @deftypevr {@code{userdb-configuration} parameter} space-separated-string-list args |
12426 | Space separated list of arguments to the userdb driver. | |
12427 | Defaults to @samp{""}. | |
d8c18af8 AW |
12428 | @end deftypevr |
12429 | ||
12430 | @deftypevr {@code{userdb-configuration} parameter} free-form-args override-fields | |
12431 | Override fields from passwd. | |
12432 | Defaults to @samp{()}. | |
12433 | @end deftypevr | |
12434 | ||
12435 | @end deftypevr | |
12436 | ||
12437 | @deftypevr {@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration | |
12438 | Plug-in configuration, created by the @code{plugin-configuration} | |
12439 | constructor. | |
12440 | @end deftypevr | |
12441 | ||
12442 | @deftypevr {@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces | |
12443 | List of namespaces. Each item in the list is created by the | |
12444 | @code{namespace-configuration} constructor. | |
12445 | ||
12446 | Available @code{namespace-configuration} fields are: | |
12447 | ||
12448 | @deftypevr {@code{namespace-configuration} parameter} string name | |
12449 | Name for this namespace. | |
12450 | @end deftypevr | |
12451 | ||
12452 | @deftypevr {@code{namespace-configuration} parameter} string type | |
12453 | Namespace type: @samp{private}, @samp{shared} or @samp{public}. | |
12454 | Defaults to @samp{"private"}. | |
12455 | @end deftypevr | |
12456 | ||
12457 | @deftypevr {@code{namespace-configuration} parameter} string separator | |
12458 | Hierarchy separator to use. You should use the same separator for | |
12459 | all namespaces or some clients get confused. @samp{/} is usually a good | |
12460 | one. The default however depends on the underlying mail storage | |
12461 | format. | |
12462 | Defaults to @samp{""}. | |
12463 | @end deftypevr | |
12464 | ||
12465 | @deftypevr {@code{namespace-configuration} parameter} string prefix | |
12466 | Prefix required to access this namespace. This needs to be | |
12467 | different for all namespaces. For example @samp{Public/}. | |
12468 | Defaults to @samp{""}. | |
12469 | @end deftypevr | |
12470 | ||
12471 | @deftypevr {@code{namespace-configuration} parameter} string location | |
1068f26b | 12472 | Physical location of the mailbox. This is in the same format as |
d8c18af8 AW |
12473 | mail_location, which is also the default for it. |
12474 | Defaults to @samp{""}. | |
12475 | @end deftypevr | |
12476 | ||
12477 | @deftypevr {@code{namespace-configuration} parameter} boolean inbox? | |
12478 | There can be only one INBOX, and this setting defines which | |
12479 | namespace has it. | |
12480 | Defaults to @samp{#f}. | |
12481 | @end deftypevr | |
12482 | ||
12483 | @deftypevr {@code{namespace-configuration} parameter} boolean hidden? | |
12484 | If namespace is hidden, it's not advertised to clients via NAMESPACE | |
12485 | extension. You'll most likely also want to set @samp{list? #f}. This is mostly | |
12486 | useful when converting from another server with different namespaces | |
12487 | which you want to deprecate but still keep working. For example you can | |
12488 | create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} | |
12489 | and @samp{mail/}. | |
12490 | Defaults to @samp{#f}. | |
12491 | @end deftypevr | |
12492 | ||
12493 | @deftypevr {@code{namespace-configuration} parameter} boolean list? | |
1068f26b AE |
12494 | Show the mailboxes under this namespace with the LIST command. This |
12495 | makes the namespace visible for clients that do not support the NAMESPACE | |
d8c18af8 AW |
12496 | extension. The special @code{children} value lists child mailboxes, but |
12497 | hides the namespace prefix. | |
12498 | Defaults to @samp{#t}. | |
12499 | @end deftypevr | |
12500 | ||
12501 | @deftypevr {@code{namespace-configuration} parameter} boolean subscriptions? | |
12502 | Namespace handles its own subscriptions. If set to @code{#f}, the | |
12503 | parent namespace handles them. The empty prefix should always have this | |
1068f26b | 12504 | as @code{#t}). |
d8c18af8 AW |
12505 | Defaults to @samp{#t}. |
12506 | @end deftypevr | |
12507 | ||
12508 | @deftypevr {@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes | |
12509 | List of predefined mailboxes in this namespace. | |
12510 | Defaults to @samp{()}. | |
12511 | ||
12512 | Available @code{mailbox-configuration} fields are: | |
12513 | ||
12514 | @deftypevr {@code{mailbox-configuration} parameter} string name | |
12515 | Name for this mailbox. | |
12516 | @end deftypevr | |
12517 | ||
12518 | @deftypevr {@code{mailbox-configuration} parameter} string auto | |
12519 | @samp{create} will automatically create this mailbox. | |
12520 | @samp{subscribe} will both create and subscribe to the mailbox. | |
12521 | Defaults to @samp{"no"}. | |
12522 | @end deftypevr | |
12523 | ||
12524 | @deftypevr {@code{mailbox-configuration} parameter} space-separated-string-list special-use | |
12525 | List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. | |
12526 | Valid values are @code{\All}, @code{\Archive}, @code{\Drafts}, | |
12527 | @code{\Flagged}, @code{\Junk}, @code{\Sent}, and @code{\Trash}. | |
12528 | Defaults to @samp{()}. | |
12529 | @end deftypevr | |
12530 | ||
12531 | @end deftypevr | |
12532 | ||
12533 | @end deftypevr | |
12534 | ||
12535 | @deftypevr {@code{dovecot-configuration} parameter} file-name base-dir | |
12536 | Base directory where to store runtime data. | |
12537 | Defaults to @samp{"/var/run/dovecot/"}. | |
12538 | @end deftypevr | |
12539 | ||
12540 | @deftypevr {@code{dovecot-configuration} parameter} string login-greeting | |
12541 | Greeting message for clients. | |
12542 | Defaults to @samp{"Dovecot ready."}. | |
12543 | @end deftypevr | |
12544 | ||
12545 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks | |
12546 | List of trusted network ranges. Connections from these IPs are | |
12547 | allowed to override their IP addresses and ports (for logging and for | |
12548 | authentication checks). @samp{disable-plaintext-auth} is also ignored | |
1068f26b | 12549 | for these networks. Typically you would specify your IMAP proxy servers |
d8c18af8 AW |
12550 | here. |
12551 | Defaults to @samp{()}. | |
12552 | @end deftypevr | |
12553 | ||
12554 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets | |
12555 | List of login access check sockets (e.g. tcpwrap). | |
12556 | Defaults to @samp{()}. | |
12557 | @end deftypevr | |
12558 | ||
12559 | @deftypevr {@code{dovecot-configuration} parameter} boolean verbose-proctitle? | |
12560 | Show more verbose process titles (in ps). Currently shows user name | |
1068f26b AE |
12561 | and IP address. Useful for seeing who is actually using the IMAP |
12562 | processes (e.g. shared mailboxes or if the same uid is used for multiple | |
d8c18af8 AW |
12563 | accounts). |
12564 | Defaults to @samp{#f}. | |
12565 | @end deftypevr | |
12566 | ||
12567 | @deftypevr {@code{dovecot-configuration} parameter} boolean shutdown-clients? | |
12568 | Should all processes be killed when Dovecot master process shuts down. | |
12569 | Setting this to @code{#f} means that Dovecot can be upgraded without | |
12570 | forcing existing client connections to close (although that could also | |
1068f26b | 12571 | be a problem if the upgrade is e.g. due to a security fix). |
d8c18af8 AW |
12572 | Defaults to @samp{#t}. |
12573 | @end deftypevr | |
12574 | ||
12575 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count | |
12576 | If non-zero, run mail commands via this many connections to doveadm | |
12577 | server, instead of running them directly in the same process. | |
12578 | Defaults to @samp{0}. | |
12579 | @end deftypevr | |
12580 | ||
12581 | @deftypevr {@code{dovecot-configuration} parameter} string doveadm-socket-path | |
12582 | UNIX socket or host:port used for connecting to doveadm server. | |
12583 | Defaults to @samp{"doveadm-server"}. | |
12584 | @end deftypevr | |
12585 | ||
12586 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list import-environment | |
12587 | List of environment variables that are preserved on Dovecot startup | |
12588 | and passed down to all of its child processes. You can also give | |
12589 | key=value pairs to always set specific settings. | |
12590 | @end deftypevr | |
12591 | ||
12592 | @deftypevr {@code{dovecot-configuration} parameter} boolean disable-plaintext-auth? | |
12593 | Disable LOGIN command and all other plaintext authentications unless | |
12594 | SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP | |
12595 | matches the local IP (i.e. you're connecting from the same computer), | |
12596 | the connection is considered secure and plaintext authentication is | |
12597 | allowed. See also ssl=required setting. | |
12598 | Defaults to @samp{#t}. | |
12599 | @end deftypevr | |
12600 | ||
12601 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size | |
12602 | Authentication cache size (e.g. @samp{#e10e6}). 0 means it's disabled. | |
12603 | Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set | |
12604 | for caching to be used. | |
12605 | Defaults to @samp{0}. | |
12606 | @end deftypevr | |
12607 | ||
12608 | @deftypevr {@code{dovecot-configuration} parameter} string auth-cache-ttl | |
12609 | Time to live for cached data. After TTL expires the cached record | |
12610 | is no longer used, *except* if the main database lookup returns internal | |
12611 | failure. We also try to handle password changes automatically: If | |
12612 | user's previous authentication was successful, but this one wasn't, the | |
12613 | cache isn't used. For now this works only with plaintext | |
12614 | authentication. | |
12615 | Defaults to @samp{"1 hour"}. | |
12616 | @end deftypevr | |
12617 | ||
12618 | @deftypevr {@code{dovecot-configuration} parameter} string auth-cache-negative-ttl | |
12619 | TTL for negative hits (user not found, password mismatch). | |
12620 | 0 disables caching them completely. | |
12621 | Defaults to @samp{"1 hour"}. | |
12622 | @end deftypevr | |
12623 | ||
12624 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-realms | |
12625 | List of realms for SASL authentication mechanisms that need them. | |
12626 | You can leave it empty if you don't want to support multiple realms. | |
12627 | Many clients simply use the first one listed here, so keep the default | |
12628 | realm first. | |
12629 | Defaults to @samp{()}. | |
12630 | @end deftypevr | |
12631 | ||
12632 | @deftypevr {@code{dovecot-configuration} parameter} string auth-default-realm | |
12633 | Default realm/domain to use if none was specified. This is used for | |
12634 | both SASL realms and appending @@domain to username in plaintext | |
12635 | logins. | |
12636 | Defaults to @samp{""}. | |
12637 | @end deftypevr | |
12638 | ||
12639 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-chars | |
12640 | List of allowed characters in username. If the user-given username | |
12641 | contains a character not listed in here, the login automatically fails. | |
12642 | This is just an extra check to make sure user can't exploit any | |
12643 | potential quote escaping vulnerabilities with SQL/LDAP databases. If | |
12644 | you want to allow all characters, set this value to empty. | |
12645 | Defaults to @samp{"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@"}. | |
12646 | @end deftypevr | |
12647 | ||
12648 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-translation | |
12649 | Username character translations before it's looked up from | |
12650 | databases. The value contains series of from -> to characters. For | |
12651 | example @samp{#@@/@@} means that @samp{#} and @samp{/} characters are | |
12652 | translated to @samp{@@}. | |
12653 | Defaults to @samp{""}. | |
12654 | @end deftypevr | |
12655 | ||
12656 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-format | |
12657 | Username formatting before it's looked up from databases. You can | |
12658 | use the standard variables here, e.g. %Lu would lowercase the username, | |
12659 | %n would drop away the domain if it was given, or @samp{%n-AT-%d} would | |
12660 | change the @samp{@@} into @samp{-AT-}. This translation is done after | |
12661 | @samp{auth-username-translation} changes. | |
12662 | Defaults to @samp{"%Lu"}. | |
12663 | @end deftypevr | |
12664 | ||
12665 | @deftypevr {@code{dovecot-configuration} parameter} string auth-master-user-separator | |
12666 | If you want to allow master users to log in by specifying the master | |
12667 | username within the normal username string (i.e. not using SASL | |
12668 | mechanism's support for it), you can specify the separator character | |
12669 | here. The format is then <username><separator><master username>. | |
12670 | UW-IMAP uses @samp{*} as the separator, so that could be a good | |
12671 | choice. | |
12672 | Defaults to @samp{""}. | |
12673 | @end deftypevr | |
12674 | ||
12675 | @deftypevr {@code{dovecot-configuration} parameter} string auth-anonymous-username | |
12676 | Username to use for users logging in with ANONYMOUS SASL | |
12677 | mechanism. | |
12678 | Defaults to @samp{"anonymous"}. | |
12679 | @end deftypevr | |
12680 | ||
12681 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count | |
12682 | Maximum number of dovecot-auth worker processes. They're used to | |
12683 | execute blocking passdb and userdb queries (e.g. MySQL and PAM). | |
12684 | They're automatically created and destroyed as needed. | |
12685 | Defaults to @samp{30}. | |
12686 | @end deftypevr | |
12687 | ||
12688 | @deftypevr {@code{dovecot-configuration} parameter} string auth-gssapi-hostname | |
12689 | Host name to use in GSSAPI principal names. The default is to use | |
12690 | the name returned by gethostname(). Use @samp{$ALL} (with quotes) to | |
12691 | allow all keytab entries. | |
12692 | Defaults to @samp{""}. | |
12693 | @end deftypevr | |
12694 | ||
12695 | @deftypevr {@code{dovecot-configuration} parameter} string auth-krb5-keytab | |
12696 | Kerberos keytab to use for the GSSAPI mechanism. Will use the | |
8b499030 | 12697 | system default (usually @file{/etc/krb5.keytab}) if not specified. You may |
d8c18af8 AW |
12698 | need to change the auth service to run as root to be able to read this |
12699 | file. | |
12700 | Defaults to @samp{""}. | |
12701 | @end deftypevr | |
12702 | ||
12703 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-use-winbind? | |
12704 | Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon | |
12705 | and @samp{ntlm-auth} helper. | |
12706 | <doc/wiki/Authentication/Mechanisms/Winbind.txt>. | |
12707 | Defaults to @samp{#f}. | |
12708 | @end deftypevr | |
12709 | ||
12710 | @deftypevr {@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path | |
12711 | Path for Samba's @samp{ntlm-auth} helper binary. | |
12712 | Defaults to @samp{"/usr/bin/ntlm_auth"}. | |
12713 | @end deftypevr | |
12714 | ||
12715 | @deftypevr {@code{dovecot-configuration} parameter} string auth-failure-delay | |
12716 | Time to delay before replying to failed authentications. | |
12717 | Defaults to @samp{"2 secs"}. | |
12718 | @end deftypevr | |
12719 | ||
12720 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert? | |
12721 | Require a valid SSL client certificate or the authentication | |
12722 | fails. | |
12723 | Defaults to @samp{#f}. | |
12724 | @end deftypevr | |
12725 | ||
12726 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert? | |
12727 | Take the username from client's SSL certificate, using | |
12728 | @code{X509_NAME_get_text_by_NID()} which returns the subject's DN's | |
12729 | CommonName. | |
12730 | Defaults to @samp{#f}. | |
12731 | @end deftypevr | |
12732 | ||
12733 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms | |
12734 | List of wanted authentication mechanisms. Supported mechanisms are: | |
12735 | @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, | |
12736 | @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, | |
12737 | @samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also | |
12738 | @samp{disable-plaintext-auth} setting. | |
12739 | @end deftypevr | |
12740 | ||
12741 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-servers | |
12742 | List of IPs or hostnames to all director servers, including ourself. | |
12743 | Ports can be specified as ip:port. The default port is the same as what | |
12744 | director service's @samp{inet-listener} is using. | |
12745 | Defaults to @samp{()}. | |
12746 | @end deftypevr | |
12747 | ||
12748 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers | |
12749 | List of IPs or hostnames to all backend mail servers. Ranges are | |
12750 | allowed too, like 10.0.0.10-10.0.0.30. | |
12751 | Defaults to @samp{()}. | |
12752 | @end deftypevr | |
12753 | ||
12754 | @deftypevr {@code{dovecot-configuration} parameter} string director-user-expire | |
12755 | How long to redirect users to a specific server after it no longer | |
12756 | has any connections. | |
12757 | Defaults to @samp{"15 min"}. | |
12758 | @end deftypevr | |
12759 | ||
12760 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer director-doveadm-port | |
12761 | TCP/IP port that accepts doveadm connections (instead of director | |
12762 | connections) If you enable this, you'll also need to add | |
12763 | @samp{inet-listener} for the port. | |
12764 | Defaults to @samp{0}. | |
12765 | @end deftypevr | |
12766 | ||
12767 | @deftypevr {@code{dovecot-configuration} parameter} string director-username-hash | |
12768 | How the username is translated before being hashed. Useful values | |
12769 | include %Ln if user can log in with or without @@domain, %Ld if mailboxes | |
12770 | are shared within domain. | |
12771 | Defaults to @samp{"%Lu"}. | |
12772 | @end deftypevr | |
12773 | ||
12774 | @deftypevr {@code{dovecot-configuration} parameter} string log-path | |
12775 | Log file to use for error messages. @samp{syslog} logs to syslog, | |
12776 | @samp{/dev/stderr} logs to stderr. | |
12777 | Defaults to @samp{"syslog"}. | |
12778 | @end deftypevr | |
12779 | ||
12780 | @deftypevr {@code{dovecot-configuration} parameter} string info-log-path | |
12781 | Log file to use for informational messages. Defaults to | |
12782 | @samp{log-path}. | |
12783 | Defaults to @samp{""}. | |
12784 | @end deftypevr | |
12785 | ||
12786 | @deftypevr {@code{dovecot-configuration} parameter} string debug-log-path | |
12787 | Log file to use for debug messages. Defaults to | |
12788 | @samp{info-log-path}. | |
12789 | Defaults to @samp{""}. | |
12790 | @end deftypevr | |
12791 | ||
12792 | @deftypevr {@code{dovecot-configuration} parameter} string syslog-facility | |
12793 | Syslog facility to use if you're logging to syslog. Usually if you | |
12794 | don't want to use @samp{mail}, you'll use local0..local7. Also other | |
12795 | standard facilities are supported. | |
12796 | Defaults to @samp{"mail"}. | |
12797 | @end deftypevr | |
12798 | ||
12799 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose? | |
12800 | Log unsuccessful authentication attempts and the reasons why they | |
12801 | failed. | |
12802 | Defaults to @samp{#f}. | |
12803 | @end deftypevr | |
12804 | ||
12805 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose-passwords? | |
12806 | In case of password mismatches, log the attempted password. Valid | |
12807 | values are no, plain and sha1. sha1 can be useful for detecting brute | |
12808 | force password attempts vs. user simply trying the same password over | |
12809 | and over again. You can also truncate the value to n chars by appending | |
12810 | ":n" (e.g. sha1:6). | |
12811 | Defaults to @samp{#f}. | |
12812 | @end deftypevr | |
12813 | ||
12814 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug? | |
12815 | Even more verbose logging for debugging purposes. Shows for example | |
12816 | SQL queries. | |
12817 | Defaults to @samp{#f}. | |
12818 | @end deftypevr | |
12819 | ||
12820 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug-passwords? | |
12821 | In case of password mismatches, log the passwords and used scheme so | |
12822 | the problem can be debugged. Enabling this also enables | |
12823 | @samp{auth-debug}. | |
12824 | Defaults to @samp{#f}. | |
12825 | @end deftypevr | |
12826 | ||
12827 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-debug? | |
12828 | Enable mail process debugging. This can help you figure out why | |
12829 | Dovecot isn't finding your mails. | |
12830 | Defaults to @samp{#f}. | |
12831 | @end deftypevr | |
12832 | ||
12833 | @deftypevr {@code{dovecot-configuration} parameter} boolean verbose-ssl? | |
12834 | Show protocol level SSL errors. | |
12835 | Defaults to @samp{#f}. | |
12836 | @end deftypevr | |
12837 | ||
12838 | @deftypevr {@code{dovecot-configuration} parameter} string log-timestamp | |
12839 | Prefix for each line written to log file. % codes are in | |
12840 | strftime(3) format. | |
12841 | Defaults to @samp{"\"%b %d %H:%M:%S \""}. | |
12842 | @end deftypevr | |
12843 | ||
12844 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements | |
12845 | List of elements we want to log. The elements which have a | |
12846 | non-empty variable value are joined together to form a comma-separated | |
12847 | string. | |
12848 | @end deftypevr | |
12849 | ||
12850 | @deftypevr {@code{dovecot-configuration} parameter} string login-log-format | |
12851 | Login log format. %s contains @samp{login-log-format-elements} | |
12852 | string, %$ contains the data we want to log. | |
12853 | Defaults to @samp{"%$: %s"}. | |
12854 | @end deftypevr | |
12855 | ||
12856 | @deftypevr {@code{dovecot-configuration} parameter} string mail-log-prefix | |
12857 | Log prefix for mail processes. See doc/wiki/Variables.txt for list | |
12858 | of possible variables you can use. | |
12859 | Defaults to @samp{"\"%s(%u): \""}. | |
12860 | @end deftypevr | |
12861 | ||
12862 | @deftypevr {@code{dovecot-configuration} parameter} string deliver-log-format | |
12863 | Format to use for logging mail deliveries. You can use variables: | |
12864 | @table @code | |
12865 | @item %$ | |
12866 | Delivery status message (e.g. @samp{saved to INBOX}) | |
12867 | @item %m | |
12868 | Message-ID | |
12869 | @item %s | |
12870 | Subject | |
12871 | @item %f | |
12872 | From address | |
12873 | @item %p | |
12874 | Physical size | |
12875 | @item %w | |
12876 | Virtual size. | |
12877 | @end table | |
12878 | Defaults to @samp{"msgid=%m: %$"}. | |
12879 | @end deftypevr | |
12880 | ||
12881 | @deftypevr {@code{dovecot-configuration} parameter} string mail-location | |
12882 | Location for users' mailboxes. The default is empty, which means | |
12883 | that Dovecot tries to find the mailboxes automatically. This won't work | |
12884 | if the user doesn't yet have any mail, so you should explicitly tell | |
12885 | Dovecot the full location. | |
12886 | ||
12887 | If you're using mbox, giving a path to the INBOX | |
12888 | file (e.g. /var/mail/%u) isn't enough. You'll also need to tell Dovecot | |
12889 | where the other mailboxes are kept. This is called the "root mail | |
12890 | directory", and it must be the first path given in the | |
12891 | @samp{mail-location} setting. | |
12892 | ||
12893 | There are a few special variables you can use, eg.: | |
12894 | ||
12895 | @table @samp | |
12896 | @item %u | |
12897 | username | |
12898 | @item %n | |
12899 | user part in user@@domain, same as %u if there's no domain | |
12900 | @item %d | |
12901 | domain part in user@@domain, empty if there's no domain | |
12902 | @item %h | |
12903 | home director | |
12904 | @end table | |
12905 | ||
12906 | See doc/wiki/Variables.txt for full list. Some examples: | |
12907 | @table @samp | |
12908 | @item maildir:~/Maildir | |
12909 | @item mbox:~/mail:INBOX=/var/mail/%u | |
12910 | @item mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/% | |
12911 | @end table | |
12912 | Defaults to @samp{""}. | |
12913 | @end deftypevr | |
12914 | ||
12915 | @deftypevr {@code{dovecot-configuration} parameter} string mail-uid | |
12916 | System user and group used to access mails. If you use multiple, | |
12917 | userdb can override these by returning uid or gid fields. You can use | |
12918 | either numbers or names. <doc/wiki/UserIds.txt>. | |
12919 | Defaults to @samp{""}. | |
12920 | @end deftypevr | |
12921 | ||
12922 | @deftypevr {@code{dovecot-configuration} parameter} string mail-gid | |
12923 | ||
12924 | Defaults to @samp{""}. | |
12925 | @end deftypevr | |
12926 | ||
12927 | @deftypevr {@code{dovecot-configuration} parameter} string mail-privileged-group | |
12928 | Group to enable temporarily for privileged operations. Currently | |
12929 | this is used only with INBOX when either its initial creation or | |
12930 | dotlocking fails. Typically this is set to "mail" to give access to | |
12931 | /var/mail. | |
12932 | Defaults to @samp{""}. | |
12933 | @end deftypevr | |
12934 | ||
12935 | @deftypevr {@code{dovecot-configuration} parameter} string mail-access-groups | |
12936 | Grant access to these supplementary groups for mail processes. | |
12937 | Typically these are used to set up access to shared mailboxes. Note | |
12938 | that it may be dangerous to set these if users can create | |
12939 | symlinks (e.g. if "mail" group is set here, ln -s /var/mail ~/mail/var | |
12940 | could allow a user to delete others' mailboxes, or ln -s | |
12941 | /secret/shared/box ~/mail/mybox would allow reading it). | |
12942 | Defaults to @samp{""}. | |
12943 | @end deftypevr | |
12944 | ||
12945 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access? | |
8f65585b | 12946 | Allow full file system access to clients. There's no access checks |
d8c18af8 AW |
12947 | other than what the operating system does for the active UID/GID. It |
12948 | works with both maildir and mboxes, allowing you to prefix mailboxes | |
12949 | names with e.g. /path/ or ~user/. | |
12950 | Defaults to @samp{#f}. | |
12951 | @end deftypevr | |
12952 | ||
12953 | @deftypevr {@code{dovecot-configuration} parameter} boolean mmap-disable? | |
12954 | Don't use mmap() at all. This is required if you store indexes to | |
8f65585b | 12955 | shared file systems (NFS or clustered file system). |
d8c18af8 AW |
12956 | Defaults to @samp{#f}. |
12957 | @end deftypevr | |
12958 | ||
12959 | @deftypevr {@code{dovecot-configuration} parameter} boolean dotlock-use-excl? | |
12960 | Rely on @samp{O_EXCL} to work when creating dotlock files. NFS | |
12961 | supports @samp{O_EXCL} since version 3, so this should be safe to use | |
12962 | nowadays by default. | |
12963 | Defaults to @samp{#t}. | |
12964 | @end deftypevr | |
12965 | ||
12966 | @deftypevr {@code{dovecot-configuration} parameter} string mail-fsync | |
12967 | When to use fsync() or fdatasync() calls: | |
12968 | @table @code | |
12969 | @item optimized | |
12970 | Whenever necessary to avoid losing important data | |
12971 | @item always | |
12972 | Useful with e.g. NFS when write()s are delayed | |
12973 | @item never | |
12974 | Never use it (best performance, but crashes can lose data). | |
12975 | @end table | |
12976 | Defaults to @samp{"optimized"}. | |
12977 | @end deftypevr | |
12978 | ||
12979 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-storage? | |
12980 | Mail storage exists in NFS. Set this to yes to make Dovecot flush | |
12981 | NFS caches whenever needed. If you're using only a single mail server | |
12982 | this isn't needed. | |
12983 | Defaults to @samp{#f}. | |
12984 | @end deftypevr | |
12985 | ||
12986 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-index? | |
12987 | Mail index files also exist in NFS. Setting this to yes requires | |
12988 | @samp{mmap-disable? #t} and @samp{fsync-disable? #f}. | |
12989 | Defaults to @samp{#f}. | |
12990 | @end deftypevr | |
12991 | ||
12992 | @deftypevr {@code{dovecot-configuration} parameter} string lock-method | |
12993 | Locking method for index files. Alternatives are fcntl, flock and | |
12994 | dotlock. Dotlocking uses some tricks which may create more disk I/O | |
12995 | than other locking methods. NFS users: flock doesn't work, remember to | |
12996 | change @samp{mmap-disable}. | |
12997 | Defaults to @samp{"fcntl"}. | |
12998 | @end deftypevr | |
12999 | ||
13000 | @deftypevr {@code{dovecot-configuration} parameter} file-name mail-temp-dir | |
13001 | Directory in which LDA/LMTP temporarily stores incoming mails >128 | |
13002 | kB. | |
13003 | Defaults to @samp{"/tmp"}. | |
13004 | @end deftypevr | |
13005 | ||
13006 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid | |
13007 | Valid UID range for users. This is mostly to make sure that users can't | |
13008 | log in as daemons or other system users. Note that denying root logins is | |
13009 | hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} | |
13010 | is set to 0. | |
13011 | Defaults to @samp{500}. | |
13012 | @end deftypevr | |
13013 | ||
13014 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid | |
13015 | ||
13016 | Defaults to @samp{0}. | |
13017 | @end deftypevr | |
13018 | ||
13019 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid | |
13020 | Valid GID range for users. Users having non-valid GID as primary group ID | |
13021 | aren't allowed to log in. If user belongs to supplementary groups with | |
13022 | non-valid GIDs, those groups are not set. | |
13023 | Defaults to @samp{1}. | |
13024 | @end deftypevr | |
13025 | ||
13026 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid | |
13027 | ||
13028 | Defaults to @samp{0}. | |
13029 | @end deftypevr | |
13030 | ||
13031 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length | |
13032 | Maximum allowed length for mail keyword name. It's only forced when | |
13033 | trying to create new keywords. | |
13034 | Defaults to @samp{50}. | |
13035 | @end deftypevr | |
13036 | ||
13037 | @deftypevr {@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs | |
13038 | List of directories under which chrooting is allowed for mail | |
13039 | processes (i.e. /var/mail will allow chrooting to /var/mail/foo/bar | |
13040 | too). This setting doesn't affect @samp{login-chroot} | |
13041 | @samp{mail-chroot} or auth chroot settings. If this setting is empty, | |
13042 | "/./" in home dirs are ignored. WARNING: Never add directories here | |
13043 | which local users can modify, that may lead to root exploit. Usually | |
13044 | this should be done only if you don't allow shell access for users. | |
13045 | <doc/wiki/Chrooting.txt>. | |
13046 | Defaults to @samp{()}. | |
13047 | @end deftypevr | |
13048 | ||
13049 | @deftypevr {@code{dovecot-configuration} parameter} string mail-chroot | |
13050 | Default chroot directory for mail processes. This can be overridden | |
13051 | for specific users in user database by giving /./ in user's home | |
13052 | directory (e.g. /home/./user chroots into /home). Note that usually | |
13053 | there is no real need to do chrooting, Dovecot doesn't allow users to | |
13054 | access files outside their mail directory anyway. If your home | |
13055 | directories are prefixed with the chroot directory, append "/." to | |
13056 | @samp{mail-chroot}. <doc/wiki/Chrooting.txt>. | |
13057 | Defaults to @samp{""}. | |
13058 | @end deftypevr | |
13059 | ||
13060 | @deftypevr {@code{dovecot-configuration} parameter} file-name auth-socket-path | |
13061 | UNIX socket path to master authentication server to find users. | |
13062 | This is used by imap (for shared users) and lda. | |
13063 | Defaults to @samp{"/var/run/dovecot/auth-userdb"}. | |
13064 | @end deftypevr | |
13065 | ||
13066 | @deftypevr {@code{dovecot-configuration} parameter} file-name mail-plugin-dir | |
13067 | Directory where to look up mail plugins. | |
13068 | Defaults to @samp{"/usr/lib/dovecot"}. | |
13069 | @end deftypevr | |
13070 | ||
13071 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins | |
13072 | List of plugins to load for all services. Plugins specific to IMAP, | |
13073 | LDA, etc. are added to this list in their own .conf files. | |
13074 | Defaults to @samp{()}. | |
13075 | @end deftypevr | |
13076 | ||
13077 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count | |
13078 | The minimum number of mails in a mailbox before updates are done to | |
13079 | cache file. This allows optimizing Dovecot's behavior to do less disk | |
13080 | writes at the cost of more disk reads. | |
13081 | Defaults to @samp{0}. | |
13082 | @end deftypevr | |
13083 | ||
13084 | @deftypevr {@code{dovecot-configuration} parameter} string mailbox-idle-check-interval | |
13085 | When IDLE command is running, mailbox is checked once in a while to | |
13086 | see if there are any new mails or other changes. This setting defines | |
13087 | the minimum time to wait between those checks. Dovecot can also use | |
13088 | dnotify, inotify and kqueue to find out immediately when changes | |
13089 | occur. | |
13090 | Defaults to @samp{"30 secs"}. | |
13091 | @end deftypevr | |
13092 | ||
13093 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-save-crlf? | |
13094 | Save mails with CR+LF instead of plain LF. This makes sending those | |
13095 | mails take less CPU, especially with sendfile() syscall with Linux and | |
13096 | FreeBSD. But it also creates a bit more disk I/O which may just make it | |
13097 | slower. Also note that if other software reads the mboxes/maildirs, | |
13098 | they may handle the extra CRs wrong and cause problems. | |
13099 | Defaults to @samp{#f}. | |
13100 | @end deftypevr | |
13101 | ||
13102 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-stat-dirs? | |
13103 | By default LIST command returns all entries in maildir beginning | |
13104 | with a dot. Enabling this option makes Dovecot return only entries | |
13105 | which are directories. This is done by stat()ing each entry, so it | |
13106 | causes more disk I/O. | |
13107 | (For systems setting struct @samp{dirent->d_type} this check is free | |
13108 | and it's done always regardless of this setting). | |
13109 | Defaults to @samp{#f}. | |
13110 | @end deftypevr | |
13111 | ||
13112 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks? | |
13113 | When copying a message, do it with hard links whenever possible. | |
13114 | This makes the performance much better, and it's unlikely to have any | |
13115 | side effects. | |
13116 | Defaults to @samp{#t}. | |
13117 | @end deftypevr | |
13118 | ||
13119 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs? | |
13120 | Assume Dovecot is the only MUA accessing Maildir: Scan cur/ | |
13121 | directory only when its mtime changes unexpectedly or when we can't find | |
13122 | the mail otherwise. | |
13123 | Defaults to @samp{#f}. | |
13124 | @end deftypevr | |
13125 | ||
13126 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks | |
13127 | Which locking methods to use for locking mbox. There are four | |
13128 | available: | |
13129 | ||
13130 | @table @code | |
13131 | @item dotlock | |
13132 | Create <mailbox>.lock file. This is the oldest and most NFS-safe | |
13133 | solution. If you want to use /var/mail/ like directory, the users will | |
13134 | need write access to that directory. | |
13135 | @item dotlock-try | |
13136 | Same as dotlock, but if it fails because of permissions or because there | |
13137 | isn't enough disk space, just skip it. | |
13138 | @item fcntl | |
13139 | Use this if possible. Works with NFS too if lockd is used. | |
13140 | @item flock | |
a01ad638 | 13141 | May not exist in all systems. Doesn't work with NFS. |
d8c18af8 AW |
13142 | @item lockf |
13143 | May not exist in all systems. Doesn't work with NFS. | |
13144 | @end table | |
13145 | ||
13146 | You can use multiple locking methods; if you do the order they're declared | |
13147 | in is important to avoid deadlocks if other MTAs/MUAs are using multiple | |
13148 | locking methods as well. Some operating systems don't allow using some of | |
13149 | them simultaneously. | |
13150 | @end deftypevr | |
13151 | ||
13152 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks | |
13153 | ||
13154 | @end deftypevr | |
13155 | ||
13156 | @deftypevr {@code{dovecot-configuration} parameter} string mbox-lock-timeout | |
13157 | Maximum time to wait for lock (all of them) before aborting. | |
13158 | Defaults to @samp{"5 mins"}. | |
13159 | @end deftypevr | |
13160 | ||
13161 | @deftypevr {@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout | |
13162 | If dotlock exists but the mailbox isn't modified in any way, | |
13163 | override the lock file after this much time. | |
13164 | Defaults to @samp{"2 mins"}. | |
13165 | @end deftypevr | |
13166 | ||
13167 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs? | |
13168 | When mbox changes unexpectedly we have to fully read it to find out | |
13169 | what changed. If the mbox is large this can take a long time. Since | |
13170 | the change is usually just a newly appended mail, it'd be faster to | |
13171 | simply read the new mails. If this setting is enabled, Dovecot does | |
13172 | this but still safely fallbacks to re-reading the whole mbox file | |
13173 | whenever something in mbox isn't how it's expected to be. The only real | |
13174 | downside to this setting is that if some other MUA changes message | |
13175 | flags, Dovecot doesn't notice it immediately. Note that a full sync is | |
13176 | done with SELECT, EXAMINE, EXPUNGE and CHECK commands. | |
13177 | Defaults to @samp{#t}. | |
13178 | @end deftypevr | |
13179 | ||
13180 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs? | |
13181 | Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, | |
13182 | EXAMINE, EXPUNGE or CHECK commands. If this is set, | |
13183 | @samp{mbox-dirty-syncs} is ignored. | |
13184 | Defaults to @samp{#f}. | |
13185 | @end deftypevr | |
13186 | ||
13187 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-lazy-writes? | |
13188 | Delay writing mbox headers until doing a full write sync (EXPUNGE | |
13189 | and CHECK commands and when closing the mailbox). This is especially | |
13190 | useful for POP3 where clients often delete all mails. The downside is | |
13191 | that our changes aren't immediately visible to other MUAs. | |
13192 | Defaults to @samp{#t}. | |
13193 | @end deftypevr | |
13194 | ||
13195 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size | |
13196 | If mbox size is smaller than this (e.g. 100k), don't write index | |
13197 | files. If an index file already exists it's still read, just not | |
13198 | updated. | |
13199 | Defaults to @samp{0}. | |
13200 | @end deftypevr | |
13201 | ||
13202 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size | |
13203 | Maximum dbox file size until it's rotated. | |
13204 | Defaults to @samp{2000000}. | |
13205 | @end deftypevr | |
13206 | ||
13207 | @deftypevr {@code{dovecot-configuration} parameter} string mdbox-rotate-interval | |
13208 | Maximum dbox file age until it's rotated. Typically in days. Day | |
13209 | begins from midnight, so 1d = today, 2d = yesterday, etc. 0 = check | |
13210 | disabled. | |
13211 | Defaults to @samp{"1d"}. | |
13212 | @end deftypevr | |
13213 | ||
13214 | @deftypevr {@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space? | |
13215 | When creating new mdbox files, immediately preallocate their size to | |
13216 | @samp{mdbox-rotate-size}. This setting currently works only in Linux | |
8f65585b | 13217 | with some file systems (ext4, xfs). |
d8c18af8 AW |
13218 | Defaults to @samp{#f}. |
13219 | @end deftypevr | |
13220 | ||
13221 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-dir | |
13222 | sdbox and mdbox support saving mail attachments to external files, | |
13223 | which also allows single instance storage for them. Other backends | |
13224 | don't support this for now. | |
13225 | ||
13226 | WARNING: This feature hasn't been tested much yet. Use at your own risk. | |
13227 | ||
13228 | Directory root where to store mail attachments. Disabled, if empty. | |
13229 | Defaults to @samp{""}. | |
13230 | @end deftypevr | |
13231 | ||
13232 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size | |
13233 | Attachments smaller than this aren't saved externally. It's also | |
13234 | possible to write a plugin to disable saving specific attachments | |
13235 | externally. | |
13236 | Defaults to @samp{128000}. | |
13237 | @end deftypevr | |
13238 | ||
13239 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-fs | |
8f65585b | 13240 | File system backend to use for saving attachments: |
d8c18af8 AW |
13241 | @table @code |
13242 | @item posix | |
13243 | No SiS done by Dovecot (but this might help FS's own deduplication) | |
13244 | @item sis posix | |
13245 | SiS with immediate byte-by-byte comparison during saving | |
13246 | @item sis-queue posix | |
13247 | SiS with delayed comparison and deduplication. | |
13248 | @end table | |
13249 | Defaults to @samp{"sis posix"}. | |
13250 | @end deftypevr | |
13251 | ||
13252 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-hash | |
13253 | Hash format to use in attachment filenames. You can add any text and | |
13254 | variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, | |
13255 | @code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be | |
13256 | truncated, e.g. @code{%@{sha256:80@}} returns only first 80 bits. | |
13257 | Defaults to @samp{"%@{sha1@}"}. | |
13258 | @end deftypevr | |
13259 | ||
13260 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-process-limit | |
13261 | ||
13262 | Defaults to @samp{100}. | |
13263 | @end deftypevr | |
13264 | ||
13265 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-client-limit | |
13266 | ||
13267 | Defaults to @samp{1000}. | |
13268 | @end deftypevr | |
13269 | ||
13270 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit | |
13271 | Default VSZ (virtual memory size) limit for service processes. | |
13272 | This is mainly intended to catch and kill processes that leak memory | |
13273 | before they eat up everything. | |
13274 | Defaults to @samp{256000000}. | |
13275 | @end deftypevr | |
13276 | ||
13277 | @deftypevr {@code{dovecot-configuration} parameter} string default-login-user | |
13278 | Login user is internally used by login processes. This is the most | |
13279 | untrusted user in Dovecot system. It shouldn't have access to anything | |
13280 | at all. | |
13281 | Defaults to @samp{"dovenull"}. | |
13282 | @end deftypevr | |
13283 | ||
13284 | @deftypevr {@code{dovecot-configuration} parameter} string default-internal-user | |
13285 | Internal user is used by unprivileged processes. It should be | |
13286 | separate from login user, so that login processes can't disturb other | |
13287 | processes. | |
13288 | Defaults to @samp{"dovecot"}. | |
13289 | @end deftypevr | |
13290 | ||
13291 | @deftypevr {@code{dovecot-configuration} parameter} string ssl? | |
13292 | SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. | |
13293 | Defaults to @samp{"required"}. | |
13294 | @end deftypevr | |
13295 | ||
13296 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cert | |
13297 | PEM encoded X.509 SSL/TLS certificate (public key). | |
13298 | Defaults to @samp{"</etc/dovecot/default.pem"}. | |
13299 | @end deftypevr | |
13300 | ||
13301 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-key | |
13302 | PEM encoded SSL/TLS private key. The key is opened before | |
13303 | dropping root privileges, so keep the key file unreadable by anyone but | |
13304 | root. | |
13305 | Defaults to @samp{"</etc/dovecot/private/default.pem"}. | |
13306 | @end deftypevr | |
13307 | ||
13308 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-key-password | |
13309 | If key file is password protected, give the password here. | |
13310 | Alternatively give it when starting dovecot with -p parameter. Since | |
13311 | this file is often world-readable, you may want to place this setting | |
13312 | instead to a different. | |
13313 | Defaults to @samp{""}. | |
13314 | @end deftypevr | |
13315 | ||
13316 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-ca | |
13317 | PEM encoded trusted certificate authority. Set this only if you | |
13318 | intend to use @samp{ssl-verify-client-cert? #t}. The file should | |
13319 | contain the CA certificate(s) followed by the matching | |
13320 | CRL(s). (e.g. @samp{ssl-ca </etc/ssl/certs/ca.pem}). | |
13321 | Defaults to @samp{""}. | |
13322 | @end deftypevr | |
13323 | ||
13324 | @deftypevr {@code{dovecot-configuration} parameter} boolean ssl-require-crl? | |
13325 | Require that CRL check succeeds for client certificates. | |
13326 | Defaults to @samp{#t}. | |
13327 | @end deftypevr | |
13328 | ||
13329 | @deftypevr {@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert? | |
13330 | Request client to send a certificate. If you also want to require | |
13331 | it, set @samp{auth-ssl-require-client-cert? #t} in auth section. | |
13332 | Defaults to @samp{#f}. | |
13333 | @end deftypevr | |
13334 | ||
13335 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cert-username-field | |
13336 | Which field from certificate to use for username. commonName and | |
13337 | x500UniqueIdentifier are the usual choices. You'll also need to set | |
13338 | @samp{auth-ssl-username-from-cert? #t}. | |
13339 | Defaults to @samp{"commonName"}. | |
13340 | @end deftypevr | |
13341 | ||
13342 | @deftypevr {@code{dovecot-configuration} parameter} hours ssl-parameters-regenerate | |
13343 | How often to regenerate the SSL parameters file. Generation is | |
13344 | quite CPU intensive operation. The value is in hours, 0 disables | |
13345 | regeneration entirely. | |
13346 | Defaults to @samp{168}. | |
13347 | @end deftypevr | |
13348 | ||
13349 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-protocols | |
13350 | SSL protocols to use. | |
13351 | Defaults to @samp{"!SSLv2"}. | |
13352 | @end deftypevr | |
13353 | ||
13354 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cipher-list | |
13355 | SSL ciphers to use. | |
13356 | Defaults to @samp{"ALL:!LOW:!SSLv2:!EXP:!aNULL"}. | |
13357 | @end deftypevr | |
13358 | ||
13359 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-crypto-device | |
13360 | SSL crypto device to use, for valid values run "openssl engine". | |
13361 | Defaults to @samp{""}. | |
13362 | @end deftypevr | |
13363 | ||
13364 | @deftypevr {@code{dovecot-configuration} parameter} string postmaster-address | |
13365 | Address to use when sending rejection mails. | |
66329c23 AW |
13366 | %d expands to recipient domain. |
13367 | Defaults to @samp{"postmaster@@%d"}. | |
d8c18af8 AW |
13368 | @end deftypevr |
13369 | ||
13370 | @deftypevr {@code{dovecot-configuration} parameter} string hostname | |
13371 | Hostname to use in various parts of sent mails (e.g. in Message-Id) | |
13372 | and in LMTP replies. Default is the system's real hostname@@domain. | |
13373 | Defaults to @samp{""}. | |
13374 | @end deftypevr | |
13375 | ||
13376 | @deftypevr {@code{dovecot-configuration} parameter} boolean quota-full-tempfail? | |
13377 | If user is over quota, return with temporary failure instead of | |
13378 | bouncing the mail. | |
13379 | Defaults to @samp{#f}. | |
13380 | @end deftypevr | |
13381 | ||
13382 | @deftypevr {@code{dovecot-configuration} parameter} file-name sendmail-path | |
13383 | Binary to use for sending mails. | |
13384 | Defaults to @samp{"/usr/sbin/sendmail"}. | |
13385 | @end deftypevr | |
13386 | ||
13387 | @deftypevr {@code{dovecot-configuration} parameter} string submission-host | |
13388 | If non-empty, send mails via this SMTP host[:port] instead of | |
13389 | sendmail. | |
13390 | Defaults to @samp{""}. | |
13391 | @end deftypevr | |
13392 | ||
13393 | @deftypevr {@code{dovecot-configuration} parameter} string rejection-subject | |
13394 | Subject: header to use for rejection mails. You can use the same | |
13395 | variables as for @samp{rejection-reason} below. | |
13396 | Defaults to @samp{"Rejected: %s"}. | |
13397 | @end deftypevr | |
13398 | ||
13399 | @deftypevr {@code{dovecot-configuration} parameter} string rejection-reason | |
13400 | Human readable error message for rejection mails. You can use | |
13401 | variables: | |
13402 | ||
13403 | @table @code | |
13404 | @item %n | |
13405 | CRLF | |
13406 | @item %r | |
13407 | reason | |
13408 | @item %s | |
13409 | original subject | |
13410 | @item %t | |
13411 | recipient | |
13412 | @end table | |
13413 | Defaults to @samp{"Your message to <%t> was automatically rejected:%n%r"}. | |
13414 | @end deftypevr | |
13415 | ||
13416 | @deftypevr {@code{dovecot-configuration} parameter} string recipient-delimiter | |
13417 | Delimiter character between local-part and detail in email | |
13418 | address. | |
13419 | Defaults to @samp{"+"}. | |
13420 | @end deftypevr | |
13421 | ||
13422 | @deftypevr {@code{dovecot-configuration} parameter} string lda-original-recipient-header | |
13423 | Header where the original recipient address (SMTP's RCPT TO: | |
13424 | address) is taken from if not available elsewhere. With dovecot-lda -a | |
13425 | parameter overrides this. A commonly used header for this is | |
13426 | X-Original-To. | |
13427 | Defaults to @samp{""}. | |
13428 | @end deftypevr | |
13429 | ||
13430 | @deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate? | |
13431 | Should saving a mail to a nonexistent mailbox automatically create | |
13432 | it?. | |
13433 | Defaults to @samp{#f}. | |
13434 | @end deftypevr | |
13435 | ||
13436 | @deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe? | |
13437 | Should automatically created mailboxes be also automatically | |
13438 | subscribed?. | |
13439 | Defaults to @samp{#f}. | |
13440 | @end deftypevr | |
13441 | ||
13442 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length | |
13443 | Maximum IMAP command line length. Some clients generate very long | |
13444 | command lines with huge mailboxes, so you may need to raise this if you | |
13445 | get "Too long argument" or "IMAP command line too large" errors | |
13446 | often. | |
13447 | Defaults to @samp{64000}. | |
13448 | @end deftypevr | |
13449 | ||
13450 | @deftypevr {@code{dovecot-configuration} parameter} string imap-logout-format | |
13451 | IMAP logout format string: | |
13452 | @table @code | |
13453 | @item %i | |
13454 | total number of bytes read from client | |
13455 | @item %o | |
13456 | total number of bytes sent to client. | |
13457 | @end table | |
13458 | Defaults to @samp{"in=%i out=%o"}. | |
13459 | @end deftypevr | |
13460 | ||
13461 | @deftypevr {@code{dovecot-configuration} parameter} string imap-capability | |
13462 | Override the IMAP CAPABILITY response. If the value begins with '+', | |
13463 | add the given capabilities on top of the defaults (e.g. +XFOO XBAR). | |
13464 | Defaults to @samp{""}. | |
13465 | @end deftypevr | |
13466 | ||
13467 | @deftypevr {@code{dovecot-configuration} parameter} string imap-idle-notify-interval | |
13468 | How long to wait between "OK Still here" notifications when client | |
13469 | is IDLEing. | |
13470 | Defaults to @samp{"2 mins"}. | |
13471 | @end deftypevr | |
13472 | ||
13473 | @deftypevr {@code{dovecot-configuration} parameter} string imap-id-send | |
13474 | ID field names and values to send to clients. Using * as the value | |
13475 | makes Dovecot use the default value. The following fields have default | |
13476 | values currently: name, version, os, os-version, support-url, | |
13477 | support-email. | |
13478 | Defaults to @samp{""}. | |
13479 | @end deftypevr | |
13480 | ||
13481 | @deftypevr {@code{dovecot-configuration} parameter} string imap-id-log | |
13482 | ID fields sent by client to log. * means everything. | |
13483 | Defaults to @samp{""}. | |
13484 | @end deftypevr | |
13485 | ||
13486 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds | |
13487 | Workarounds for various client bugs: | |
13488 | ||
13489 | @table @code | |
13490 | @item delay-newmail | |
13491 | Send EXISTS/RECENT new mail notifications only when replying to NOOP and | |
13492 | CHECK commands. Some clients ignore them otherwise, for example OSX | |
13493 | Mail (<v2.1). Outlook Express breaks more badly though, without this it | |
13494 | may show user "Message no longer in server" errors. Note that OE6 | |
13495 | still breaks even with this workaround if synchronization is set to | |
13496 | "Headers Only". | |
13497 | ||
13498 | @item tb-extra-mailbox-sep | |
13499 | Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and | |
13500 | adds extra @samp{/} suffixes to mailbox names. This option causes Dovecot to | |
13501 | ignore the extra @samp{/} instead of treating it as invalid mailbox name. | |
13502 | ||
13503 | @item tb-lsub-flags | |
13504 | Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox). | |
13505 | This makes Thunderbird realize they aren't selectable and show them | |
13506 | greyed out, instead of only later giving "not selectable" popup error. | |
13507 | @end table | |
13508 | Defaults to @samp{()}. | |
13509 | @end deftypevr | |
13510 | ||
13511 | @deftypevr {@code{dovecot-configuration} parameter} string imap-urlauth-host | |
13512 | Host allowed in URLAUTH URLs sent by client. "*" allows all. | |
13513 | Defaults to @samp{""}. | |
13514 | @end deftypevr | |
13515 | ||
13516 | ||
13517 | Whew! Lots of configuration options. The nice thing about it though is | |
13518 | that GuixSD has a complete interface to Dovecot's configuration | |
13519 | language. This allows not only a nice way to declare configurations, | |
13520 | but also offers reflective capabilities as well: users can write code to | |
13521 | inspect and transform configurations from within Scheme. | |
13522 | ||
13523 | However, it could be that you just want to get a @code{dovecot.conf} up | |
13524 | and running. In that case, you can pass an | |
7414de0a | 13525 | @code{opaque-dovecot-configuration} as the @code{#:config} parameter to |
d8c18af8 AW |
13526 | @code{dovecot-service}. As its name indicates, an opaque configuration |
13527 | does not have easy reflective capabilities. | |
13528 | ||
13529 | Available @code{opaque-dovecot-configuration} fields are: | |
13530 | ||
13531 | @deftypevr {@code{opaque-dovecot-configuration} parameter} package dovecot | |
13532 | The dovecot package. | |
13533 | @end deftypevr | |
13534 | ||
13535 | @deftypevr {@code{opaque-dovecot-configuration} parameter} string string | |
13536 | The contents of the @code{dovecot.conf}, as a string. | |
13537 | @end deftypevr | |
13538 | ||
13539 | For example, if your @code{dovecot.conf} is just the empty string, you | |
13540 | could instantiate a dovecot service like this: | |
13541 | ||
13542 | @example | |
13543 | (dovecot-service #:config | |
13544 | (opaque-dovecot-configuration | |
13545 | (string ""))) | |
13546 | @end example | |
13547 | ||
f88371e8 SB |
13548 | @subsubheading OpenSMTPD Service |
13549 | ||
13550 | @deffn {Scheme Variable} opensmtpd-service-type | |
13551 | This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} | |
13552 | service, whose value should be an @code{opensmtpd-configuration} object | |
13553 | as in this example: | |
13554 | ||
13555 | @example | |
13556 | (service opensmtpd-service-type | |
13557 | (opensmtpd-configuration | |
13558 | (config-file (local-file "./my-smtpd.conf")))) | |
13559 | @end example | |
13560 | @end deffn | |
13561 | ||
13562 | @deftp {Data Type} opensmtpd-configuration | |
9fc221b5 | 13563 | Data type representing the configuration of opensmtpd. |
f88371e8 SB |
13564 | |
13565 | @table @asis | |
13566 | @item @code{package} (default: @var{opensmtpd}) | |
13567 | Package object of the OpenSMTPD SMTP server. | |
13568 | ||
13569 | @item @code{config-file} (default: @var{%default-opensmtpd-file}) | |
13570 | File-like object of the OpenSMTPD configuration file to use. By default | |
13571 | it listens on the loopback network interface, and allows for mail from | |
13572 | users and daemons on the local machine, as well as permitting email to | |
13573 | remote servers. Run @command{man smtpd.conf} for more information. | |
13574 | ||
13575 | @end table | |
13576 | @end deftp | |
859e367d | 13577 | |
82ccc499 CZ |
13578 | @subsubheading Exim Service |
13579 | ||
63422bbb CZ |
13580 | @cindex mail transfer agent (MTA) |
13581 | @cindex MTA (mail transfer agent) | |
13582 | @cindex SMTP | |
13583 | ||
82ccc499 | 13584 | @deffn {Scheme Variable} exim-service-type |
63422bbb CZ |
13585 | This is the type of the @uref{https://exim.org, Exim} mail transfer |
13586 | agent (MTA), whose value should be an @code{exim-configuration} object | |
13587 | as in this example: | |
82ccc499 CZ |
13588 | |
13589 | @example | |
13590 | (service exim-service-type | |
13591 | (exim-configuration | |
63422bbb | 13592 | (config-file (local-file "./my-exim.conf")))) |
82ccc499 CZ |
13593 | @end example |
13594 | @end deffn | |
13595 | ||
63422bbb CZ |
13596 | In order to use an @code{exim-service-type} service you must also have a |
13597 | @code{mail-aliases-service-type} service present in your | |
13598 | @code{operating-system} (even if it has no aliases). | |
13599 | ||
82ccc499 CZ |
13600 | @deftp {Data Type} exim-configuration |
13601 | Data type representing the configuration of exim. | |
13602 | ||
13603 | @table @asis | |
13604 | @item @code{package} (default: @var{exim}) | |
13605 | Package object of the Exim server. | |
13606 | ||
13607 | @item @code{config-file} (default: @code{#f}) | |
13608 | File-like object of the Exim configuration file to use. If its value is | |
13609 | @code{#f} then use the default configuration file from the package | |
13610 | provided in @code{package}. The resulting configuration file is loaded | |
13611 | after setting the @code{exim_user} and @code{exim_group} configuration | |
13612 | variables. | |
13613 | ||
82ccc499 CZ |
13614 | @end table |
13615 | @end deftp | |
13616 | ||
63422bbb CZ |
13617 | @subsubheading Mail Aliases Service |
13618 | ||
13619 | @cindex email aliases | |
13620 | @cindex aliases, for email addresses | |
13621 | ||
13622 | @deffn {Scheme Variable} mail-aliases-service-type | |
13623 | This is the type of the service which provides @code{/etc/aliases}, | |
13624 | specifying how to deliver mail to users on this system. | |
13625 | ||
13626 | @example | |
13627 | (service mail-aliases-service-type | |
13628 | '(("postmaster" "bob") | |
13629 | ("bob" "bob@@example.com" "bob@@example2.com"))) | |
13630 | @end example | |
13631 | @end deffn | |
13632 | ||
13633 | The configuration for a @code{mail-aliases-service-type} service is an | |
13634 | association list denoting how to deliver mail that comes to this | |
13635 | system. Each entry is of the form @code{(alias addresses ...)}, with | |
13636 | @code{alias} specifying the local alias and @code{addresses} specifying | |
13637 | where to deliver this user's mail. | |
13638 | ||
13639 | The aliases aren't required to exist as users on the local system. In | |
13640 | the above example, there doesn't need to be a @code{postmaster} entry in | |
13641 | the @code{operating-system}'s @code{user-accounts} in order to deliver | |
13642 | the @code{postmaster} mail to @code{bob} (which subsequently would | |
13643 | deliver mail to @code{bob@@example.com} and @code{bob@@example2.com}). | |
13644 | ||
78cef99b CL |
13645 | @node Messaging Services |
13646 | @subsubsection Messaging Services | |
13647 | ||
13648 | @cindex messaging | |
13649 | @cindex jabber | |
13650 | @cindex XMPP | |
13651 | The @code{(gnu services messaging)} module provides Guix service | |
13652 | definitions for messaging services: currently only Prosody is supported. | |
13653 | ||
13654 | @subsubheading Prosody Service | |
13655 | ||
13656 | @deffn {Scheme Variable} prosody-service-type | |
13657 | This is the type for the @uref{http://prosody.im, Prosody XMPP | |
13658 | communication server}. Its value must be a @code{prosody-configuration} | |
13659 | record as in this example: | |
13660 | ||
13661 | @example | |
13662 | (service prosody-service-type | |
13663 | (prosody-configuration | |
13664 | (modules-enabled (cons "groups" %default-modules-enabled)) | |
13665 | (int-components | |
13666 | (list | |
13667 | (int-component-configuration | |
13668 | (hostname "conference.example.net") | |
13669 | (plugin "muc") | |
13670 | (mod-muc (mod-muc-configuration))))) | |
13671 | (virtualhosts | |
13672 | (list | |
13673 | (virtualhost-configuration | |
13674 | (domain "example.net")))))) | |
13675 | @end example | |
13676 | ||
13677 | See below for details about @code{prosody-configuration}. | |
13678 | ||
13679 | @end deffn | |
13680 | ||
13681 | By default, Prosody does not need much configuration. Only one | |
13682 | @code{virtualhosts} field is needed: it specifies the domain you wish | |
13683 | Prosody to serve. | |
13684 | ||
13685 | Prosodyctl will help you generate X.509 certificates and keys: | |
13686 | ||
13687 | @example | |
13688 | prosodyctl cert request example.net | |
13689 | @end example | |
13690 | ||
13691 | The available configuration parameters follow. Each parameter | |
13692 | definition is preceded by its type; for example, @samp{string-list foo} | |
13693 | indicates that the @code{foo} parameter should be specified as a list of | |
13694 | strings. Types starting with @code{maybe-} denote parameters that won't | |
13695 | show up in @code{prosody.cfg.lua} when their value is @code{'disabled}. | |
13696 | ||
13697 | There is also a way to specify the configuration as a string, if you | |
13698 | have an old @code{prosody.cfg.lua} file that you want to port over from | |
13699 | some other system; see the end for more details. | |
13700 | ||
13701 | @c The following documentation was initially generated by | |
13702 | @c (generate-documentation) in (gnu services messaging). Manually maintained | |
13703 | @c documentation is better, so we shouldn't hesitate to edit below as | |
13704 | @c needed. However if the change you want to make to this documentation | |
13705 | @c can be done in an automated way, it's probably easier to change | |
13706 | @c (generate-documentation) than to make it below and have to deal with | |
13707 | @c the churn as Prosody updates. | |
13708 | ||
13709 | Available @code{prosody-configuration} fields are: | |
13710 | ||
13711 | @deftypevr {@code{prosody-configuration} parameter} package prosody | |
13712 | The Prosody package. | |
13713 | @end deftypevr | |
13714 | ||
13715 | @deftypevr {@code{prosody-configuration} parameter} file-name data-path | |
13716 | Location of the Prosody data storage directory. See | |
13717 | @url{http://prosody.im/doc/configure}. | |
13718 | Defaults to @samp{"/var/lib/prosody"}. | |
13719 | @end deftypevr | |
13720 | ||
13721 | @deftypevr {@code{prosody-configuration} parameter} file-name-list plugin-paths | |
13722 | Additional plugin directories. They are searched in all the specified | |
13723 | paths in order. See @url{http://prosody.im/doc/plugins_directory}. | |
13724 | Defaults to @samp{()}. | |
13725 | @end deftypevr | |
13726 | ||
13727 | @deftypevr {@code{prosody-configuration} parameter} string-list admins | |
13728 | This is a list of accounts that are admins for the server. Note that you | |
13729 | must create the accounts separately. See @url{http://prosody.im/doc/admins} and | |
13730 | @url{http://prosody.im/doc/creating_accounts}. | |
13731 | Example: @code{(admins '("user1@@example.com" "user2@@example.net"))} | |
13732 | Defaults to @samp{()}. | |
13733 | @end deftypevr | |
13734 | ||
13735 | @deftypevr {@code{prosody-configuration} parameter} boolean use-libevent? | |
13736 | Enable use of libevent for better performance under high load. See | |
13737 | @url{http://prosody.im/doc/libevent}. | |
13738 | Defaults to @samp{#f}. | |
13739 | @end deftypevr | |
13740 | ||
13741 | @deftypevr {@code{prosody-configuration} parameter} module-list modules-enabled | |
13742 | This is the list of modules Prosody will load on startup. It looks for | |
13743 | @code{mod_modulename.lua} in the plugins folder, so make sure that exists too. | |
13744 | Documentation on modules can be found at: @url{http://prosody.im/doc/modules}. | |
13745 | Defaults to @samp{%default-modules-enabled}. | |
13746 | @end deftypevr | |
13747 | ||
13748 | @deftypevr {@code{prosody-configuration} parameter} string-list modules-disabled | |
13749 | @samp{"offline"}, @samp{"c2s"} and @samp{"s2s"} are auto-loaded, but | |
13750 | should you want to disable them then add them to this list. | |
13751 | Defaults to @samp{()}. | |
13752 | @end deftypevr | |
13753 | ||
13754 | @deftypevr {@code{prosody-configuration} parameter} file-name groups-file | |
13755 | Path to a text file where the shared groups are defined. If this path is | |
13756 | empty then @samp{mod_groups} does nothing. See | |
13757 | @url{http://prosody.im/doc/modules/mod_groups}. | |
13758 | Defaults to @samp{"/var/lib/prosody/sharedgroups.txt"}. | |
13759 | @end deftypevr | |
13760 | ||
13761 | @deftypevr {@code{prosody-configuration} parameter} boolean allow-registration? | |
13762 | Disable account creation by default, for security. See | |
13763 | @url{http://prosody.im/doc/creating_accounts}. | |
13764 | Defaults to @samp{#f}. | |
13765 | @end deftypevr | |
13766 | ||
13767 | @deftypevr {@code{prosody-configuration} parameter} maybe-ssl-configuration ssl | |
13768 | These are the SSL/TLS-related settings. Most of them are disabled so to | |
13769 | use Prosody's defaults. If you do not completely understand these options, do | |
13770 | not add them to your config, it is easy to lower the security of your server | |
13771 | using them. See @url{http://prosody.im/doc/advanced_ssl_config}. | |
13772 | ||
13773 | Available @code{ssl-configuration} fields are: | |
13774 | ||
13775 | @deftypevr {@code{ssl-configuration} parameter} maybe-string protocol | |
13776 | This determines what handshake to use. | |
13777 | @end deftypevr | |
13778 | ||
13779 | @deftypevr {@code{ssl-configuration} parameter} file-name key | |
13780 | Path to your private key file, relative to @code{/etc/prosody}. | |
13781 | Defaults to @samp{"/etc/prosody/certs/key.pem"}. | |
13782 | @end deftypevr | |
13783 | ||
13784 | @deftypevr {@code{ssl-configuration} parameter} file-name certificate | |
13785 | Path to your certificate file, relative to @code{/etc/prosody}. | |
13786 | Defaults to @samp{"/etc/prosody/certs/cert.pem"}. | |
13787 | @end deftypevr | |
13788 | ||
13789 | @deftypevr {@code{ssl-configuration} parameter} file-name capath | |
13790 | Path to directory containing root certificates that you wish Prosody to | |
13791 | trust when verifying the certificates of remote servers. | |
13792 | Defaults to @samp{"/etc/ssl/certs"}. | |
13793 | @end deftypevr | |
13794 | ||
13795 | @deftypevr {@code{ssl-configuration} parameter} maybe-file-name cafile | |
13796 | Path to a file containing root certificates that you wish Prosody to trust. | |
13797 | Similar to @code{capath} but with all certificates concatenated together. | |
13798 | @end deftypevr | |
13799 | ||
13800 | @deftypevr {@code{ssl-configuration} parameter} maybe-string-list verify | |
13801 | A list of verification options (these mostly map to OpenSSL's | |
13802 | @code{set_verify()} flags). | |
13803 | @end deftypevr | |
13804 | ||
13805 | @deftypevr {@code{ssl-configuration} parameter} maybe-string-list options | |
13806 | A list of general options relating to SSL/TLS. These map to OpenSSL's | |
13807 | @code{set_options()}. For a full list of options available in LuaSec, see the | |
13808 | LuaSec source. | |
13809 | @end deftypevr | |
13810 | ||
13811 | @deftypevr {@code{ssl-configuration} parameter} maybe-non-negative-integer depth | |
13812 | How long a chain of certificate authorities to check when looking for a | |
13813 | trusted root certificate. | |
13814 | @end deftypevr | |
13815 | ||
13816 | @deftypevr {@code{ssl-configuration} parameter} maybe-string ciphers | |
13817 | An OpenSSL cipher string. This selects what ciphers Prosody will offer to | |
13818 | clients, and in what order. | |
13819 | @end deftypevr | |
13820 | ||
13821 | @deftypevr {@code{ssl-configuration} parameter} maybe-file-name dhparam | |
13822 | A path to a file containing parameters for Diffie-Hellman key exchange. You | |
13823 | can create such a file with: | |
13824 | @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048} | |
13825 | @end deftypevr | |
13826 | ||
13827 | @deftypevr {@code{ssl-configuration} parameter} maybe-string curve | |
13828 | Curve for Elliptic curve Diffie-Hellman. Prosody's default is | |
13829 | @samp{"secp384r1"}. | |
13830 | @end deftypevr | |
13831 | ||
13832 | @deftypevr {@code{ssl-configuration} parameter} maybe-string-list verifyext | |
13833 | A list of "extra" verification options. | |
13834 | @end deftypevr | |
13835 | ||
13836 | @deftypevr {@code{ssl-configuration} parameter} maybe-string password | |
13837 | Password for encrypted private keys. | |
13838 | @end deftypevr | |
13839 | ||
13840 | @end deftypevr | |
13841 | ||
13842 | @deftypevr {@code{prosody-configuration} parameter} boolean c2s-require-encryption? | |
13843 | Whether to force all client-to-server connections to be encrypted or not. | |
13844 | See @url{http://prosody.im/doc/modules/mod_tls}. | |
13845 | Defaults to @samp{#f}. | |
13846 | @end deftypevr | |
13847 | ||
13848 | @deftypevr {@code{prosody-configuration} parameter} boolean s2s-require-encryption? | |
13849 | Whether to force all server-to-server connections to be encrypted or not. | |
13850 | See @url{http://prosody.im/doc/modules/mod_tls}. | |
13851 | Defaults to @samp{#f}. | |
13852 | @end deftypevr | |
13853 | ||
13854 | @deftypevr {@code{prosody-configuration} parameter} boolean s2s-secure-auth? | |
13855 | Whether to require encryption and certificate authentication. This | |
13856 | provides ideal security, but requires servers you communicate with to support | |
13857 | encryption AND present valid, trusted certificates. See | |
13858 | @url{http://prosody.im/doc/s2s#security}. | |
13859 | Defaults to @samp{#f}. | |
13860 | @end deftypevr | |
13861 | ||
13862 | @deftypevr {@code{prosody-configuration} parameter} string-list s2s-insecure-domains | |
13863 | Many servers don't support encryption or have invalid or self-signed | |
13864 | certificates. You can list domains here that will not be required to | |
13865 | authenticate using certificates. They will be authenticated using DNS. See | |
13866 | @url{http://prosody.im/doc/s2s#security}. | |
13867 | Defaults to @samp{()}. | |
13868 | @end deftypevr | |
13869 | ||
13870 | @deftypevr {@code{prosody-configuration} parameter} string-list s2s-secure-domains | |
13871 | Even if you leave @code{s2s-secure-auth?} disabled, you can still require | |
13872 | valid certificates for some domains by specifying a list here. See | |
13873 | @url{http://prosody.im/doc/s2s#security}. | |
13874 | Defaults to @samp{()}. | |
13875 | @end deftypevr | |
13876 | ||
13877 | @deftypevr {@code{prosody-configuration} parameter} string authentication | |
13878 | Select the authentication backend to use. The default provider stores | |
13879 | passwords in plaintext and uses Prosody's configured data storage to store the | |
13880 | authentication data. If you do not trust your server please see | |
13881 | @url{http://prosody.im/doc/modules/mod_auth_internal_hashed} for information | |
13882 | about using the hashed backend. See also | |
13883 | @url{http://prosody.im/doc/authentication} | |
13884 | Defaults to @samp{"internal_plain"}. | |
13885 | @end deftypevr | |
13886 | ||
13887 | @deftypevr {@code{prosody-configuration} parameter} maybe-string log | |
13888 | Set logging options. Advanced logging configuration is not yet supported | |
13889 | by the GuixSD Prosody Service. See @url{http://prosody.im/doc/logging}. | |
13890 | Defaults to @samp{"*syslog"}. | |
13891 | @end deftypevr | |
13892 | ||
13893 | @deftypevr {@code{prosody-configuration} parameter} file-name pidfile | |
13894 | File to write pid in. See @url{http://prosody.im/doc/modules/mod_posix}. | |
13895 | Defaults to @samp{"/var/run/prosody/prosody.pid"}. | |
13896 | @end deftypevr | |
13897 | ||
13898 | @deftypevr {@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts | |
13899 | A host in Prosody is a domain on which user accounts can be created. For | |
13900 | example if you want your users to have addresses like | |
13901 | @samp{"john.smith@@example.com"} then you need to add a host | |
13902 | @samp{"example.com"}. All options in this list will apply only to this host. | |
13903 | ||
13904 | Note: the name "virtual" host is used in configuration to avoid confusion with | |
13905 | the actual physical host that Prosody is installed on. A single Prosody | |
13906 | instance can serve many domains, each one defined as a VirtualHost entry in | |
13907 | Prosody's configuration. Conversely a server that hosts a single domain would | |
13908 | have just one VirtualHost entry. | |
13909 | ||
13910 | See @url{http://prosody.im/doc/configure#virtual_host_settings}. | |
13911 | ||
13912 | Available @code{virtualhost-configuration} fields are: | |
13913 | ||
13914 | all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, plus: | |
13915 | @deftypevr {@code{virtualhost-configuration} parameter} string domain | |
13916 | Domain you wish Prosody to serve. | |
13917 | @end deftypevr | |
13918 | ||
13919 | @end deftypevr | |
13920 | ||
13921 | @deftypevr {@code{prosody-configuration} parameter} int-component-configuration-list int-components | |
13922 | Components are extra services on a server which are available to clients, | |
13923 | usually on a subdomain of the main server (such as | |
13924 | @samp{"mycomponent.example.com"}). Example components might be chatroom | |
13925 | servers, user directories, or gateways to other protocols. | |
13926 | ||
13927 | Internal components are implemented with Prosody-specific plugins. To add an | |
13928 | internal component, you simply fill the hostname field, and the plugin you wish | |
13929 | to use for the component. | |
13930 | ||
13931 | See @url{http://prosody.im/doc/components}. | |
13932 | Defaults to @samp{()}. | |
13933 | ||
13934 | Available @code{int-component-configuration} fields are: | |
13935 | ||
13936 | all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, plus: | |
13937 | @deftypevr {@code{int-component-configuration} parameter} string hostname | |
13938 | Hostname of the component. | |
13939 | @end deftypevr | |
13940 | ||
13941 | @deftypevr {@code{int-component-configuration} parameter} string plugin | |
13942 | Plugin you wish to use for the component. | |
13943 | @end deftypevr | |
13944 | ||
13945 | @deftypevr {@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc | |
13946 | Multi-user chat (MUC) is Prosody's module for allowing you to create | |
13947 | hosted chatrooms/conferences for XMPP users. | |
13948 | ||
13949 | General information on setting up and using multi-user chatrooms can be found | |
13950 | in the "Chatrooms" documentation (@url{http://prosody.im/doc/chatrooms}), | |
13951 | which you should read if you are new to XMPP chatrooms. | |
13952 | ||
13953 | See also @url{http://prosody.im/doc/modules/mod_muc}. | |
13954 | ||
13955 | Available @code{mod-muc-configuration} fields are: | |
13956 | ||
13957 | @deftypevr {@code{mod-muc-configuration} parameter} string name | |
13958 | The name to return in service discovery responses. | |
13959 | Defaults to @samp{"Prosody Chatrooms"}. | |
13960 | @end deftypevr | |
13961 | ||
13962 | @deftypevr {@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation | |
13963 | If @samp{#t}, this will only allow admins to create new chatrooms. | |
13964 | Otherwise anyone can create a room. The value @samp{"local"} restricts room | |
13965 | creation to users on the service's parent domain. E.g. @samp{user@@example.com} | |
13966 | can create rooms on @samp{rooms.example.com}. The value @samp{"admin"} | |
13967 | restricts to service administrators only. | |
13968 | Defaults to @samp{#f}. | |
13969 | @end deftypevr | |
13970 | ||
13971 | @deftypevr {@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages | |
13972 | Maximum number of history messages that will be sent to the member that has | |
13973 | just joined the room. | |
13974 | Defaults to @samp{20}. | |
13975 | @end deftypevr | |
13976 | ||
13977 | @end deftypevr | |
13978 | ||
13979 | @end deftypevr | |
13980 | ||
13981 | @deftypevr {@code{prosody-configuration} parameter} ext-component-configuration-list ext-components | |
13982 | External components use XEP-0114, which most standalone components | |
13983 | support. To add an external component, you simply fill the hostname field. See | |
13984 | @url{http://prosody.im/doc/components}. | |
13985 | Defaults to @samp{()}. | |
13986 | ||
13987 | Available @code{ext-component-configuration} fields are: | |
13988 | ||
13989 | all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, plus: | |
13990 | @deftypevr {@code{ext-component-configuration} parameter} string component-secret | |
13991 | Password which the component will use to log in. | |
13992 | @end deftypevr | |
13993 | ||
13994 | @deftypevr {@code{ext-component-configuration} parameter} string hostname | |
13995 | Hostname of the component. | |
13996 | @end deftypevr | |
13997 | ||
13998 | @end deftypevr | |
13999 | ||
14000 | @deftypevr {@code{prosody-configuration} parameter} non-negative-integer-list component-ports | |
14001 | Port(s) Prosody listens on for component connections. | |
14002 | @end deftypevr | |
14003 | ||
14004 | @deftypevr {@code{prosody-configuration} parameter} string component-interface | |
14005 | Interface Prosody listens on for component connections. | |
14006 | Defaults to @samp{"127.0.0.1"}. | |
14007 | @end deftypevr | |
14008 | ||
14009 | It could be that you just want to get a @code{prosody.cfg.lua} | |
14010 | up and running. In that case, you can pass an | |
14011 | @code{opaque-prosody-configuration} record as the value of | |
14012 | @code{prosody-service-type}. As its name indicates, an opaque configuration | |
14013 | does not have easy reflective capabilities. | |
14014 | Available @code{opaque-prosody-configuration} fields are: | |
14015 | ||
14016 | @deftypevr {@code{opaque-prosody-configuration} parameter} package prosody | |
14017 | The prosody package. | |
14018 | @end deftypevr | |
14019 | ||
14020 | @deftypevr {@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua | |
14021 | The contents of the @code{prosody.cfg.lua} to use. | |
14022 | @end deftypevr | |
14023 | ||
14024 | For example, if your @code{prosody.cfg.lua} is just the empty | |
14025 | string, you could instantiate a prosody service like this: | |
14026 | ||
14027 | @example | |
14028 | (service prosody-service-type | |
14029 | (opaque-prosody-configuration | |
14030 | (prosody.cfg.lua ""))) | |
14031 | @end example | |
14032 | ||
730ed6ec CB |
14033 | @node Monitoring Services |
14034 | @subsubsection Monitoring Services | |
14035 | ||
14036 | @subsubheading Tailon Service | |
14037 | ||
14038 | @uref{https://tailon.readthedocs.io/, Tailon} is a web application for | |
14039 | viewing and searching log files. | |
14040 | ||
14041 | The following example will configure the service with default values. | |
14042 | By default, Tailon can be accessed on port 8080 (@code{http://localhost:8080}). | |
14043 | ||
14044 | @example | |
14045 | (service tailon-service-type) | |
14046 | @end example | |
14047 | ||
14048 | The following example customises more of the Tailon configuration, | |
14049 | adding @command{sed} to the list of allowed commands. | |
14050 | ||
14051 | @example | |
14052 | (service tailon-service-type | |
14053 | (tailon-configuration | |
14054 | (config-file | |
14055 | (tailon-configuration-file | |
14056 | (allowed-commands '("tail" "grep" "awk" "sed")))))) | |
14057 | @end example | |
14058 | ||
14059 | ||
14060 | @deftp {Data Type} tailon-configuration | |
14061 | Data type representing the configuration of Tailon. | |
14062 | This type has the following parameters: | |
14063 | ||
14064 | @table @asis | |
14065 | @item @code{config-file} (default: @code{(tailon-configuration-file)}) | |
14066 | The configuration file to use for Tailon. This can be set to a | |
14067 | @dfn{tailon-configuration-file} record value, or any gexp | |
14068 | (@pxref{G-Expressions}). | |
14069 | ||
14070 | For example, to instead use a local file, the @code{local-file} function | |
14071 | can be used: | |
14072 | ||
14073 | @example | |
14074 | (service tailon-service-type | |
14075 | (tailon-configuration | |
14076 | (config-file (local-file "./my-tailon.conf")))) | |
14077 | @end example | |
14078 | ||
14079 | @item @code{package} (default: @code{tailon}) | |
14080 | The tailon package to use. | |
14081 | ||
14082 | @end table | |
14083 | @end deftp | |
14084 | ||
14085 | @deftp {Data Type} tailon-configuration-file | |
14086 | Data type representing the configuration options for Tailon. | |
14087 | This type has the following parameters: | |
14088 | ||
14089 | @table @asis | |
14090 | @item @code{files} (default: @code{(list "/var/log")}) | |
14091 | List of files to display. The list can include strings for a single file | |
14092 | or directory, or a list, where the first item is the name of a | |
14093 | subsection, and the remaining items are the files or directories in that | |
14094 | subsection. | |
14095 | ||
14096 | @item @code{bind} (default: @code{"localhost:8080"}) | |
14097 | Address and port to which Tailon should bind on. | |
14098 | ||
14099 | @item @code{relative-root} (default: @code{#f}) | |
14100 | URL path to use for Tailon, set to @code{#f} to not use a path. | |
14101 | ||
14102 | @item @code{allow-transfers?} (default: @code{#t}) | |
14103 | Allow downloading the log files in the web interface. | |
14104 | ||
14105 | @item @code{follow-names?} (default: @code{#t}) | |
14106 | Allow tailing of not-yet existent files. | |
14107 | ||
14108 | @item @code{tail-lines} (default: @code{200}) | |
14109 | Number of lines to read initially from each file. | |
14110 | ||
14111 | @item @code{allowed-commands} (default: @code{(list "tail" "grep" "awk")}) | |
14112 | Commands to allow running. By default, @code{sed} is disabled. | |
14113 | ||
14114 | @item @code{debug?} (default: @code{#f}) | |
14115 | Set @code{debug?} to @code{#t} to show debug messages. | |
14116 | ||
f2d8e7f7 CB |
14117 | @item @code{wrap-lines} (default: @code{#t}) |
14118 | Initial line wrapping state in the web interface. Set to @code{#t} to | |
14119 | initially wrap lines (the default), or to @code{#f} to initially not | |
14120 | wrap lines. | |
14121 | ||
91fdc8a5 CB |
14122 | @item @code{http-auth} (default: @code{#f}) |
14123 | HTTP authentication type to use. Set to @code{#f} to disable | |
14124 | authentication (the default). Supported values are @code{"digest"} or | |
14125 | @code{"basic"}. | |
14126 | ||
14127 | @item @code{users} (default: @code{#f}) | |
14128 | If HTTP authentication is enabled (see @code{http-auth}), access will be | |
14129 | restricted to the credentials provided here. To configure users, use a | |
14130 | list of pairs, where the first element of the pair is the username, and | |
14131 | the 2nd element of the pair is the password. | |
14132 | ||
14133 | @example | |
14134 | (tailon-configuration-file | |
14135 | (http-auth "basic") | |
14136 | (users '(("user1" . "password1") | |
14137 | ("user2" . "password2")))) | |
14138 | @end example | |
14139 | ||
730ed6ec CB |
14140 | @end table |
14141 | @end deftp | |
14142 | ||
14143 | ||
859e367d JD |
14144 | @node Kerberos Services |
14145 | @subsubsection Kerberos Services | |
14146 | @cindex Kerberos | |
14147 | ||
df31e36a | 14148 | The @code{(gnu services kerberos)} module provides services relating to |
859e367d JD |
14149 | the authentication protocol @dfn{Kerberos}. |
14150 | ||
8e3f813f JD |
14151 | @subsubheading Krb5 Service |
14152 | ||
14153 | Programs using a Kerberos client library normally | |
14154 | expect a configuration file in @file{/etc/krb5.conf}. | |
14155 | This service generates such a file from a definition provided in the | |
14156 | operating system declaration. | |
14157 | It does not cause any daemon to be started. | |
14158 | ||
14159 | No ``keytab'' files are provided by this service---you must explicitly create them. | |
14160 | This service is known to work with the MIT client library, @code{mit-krb5}. | |
14161 | Other implementations have not been tested. | |
14162 | ||
14163 | @defvr {Scheme Variable} krb5-service-type | |
14164 | A service type for Kerberos 5 clients. | |
14165 | @end defvr | |
14166 | ||
14167 | @noindent | |
14168 | Here is an example of its use: | |
14169 | @lisp | |
14170 | (service krb5-service-type | |
14171 | (krb5-configuration | |
14172 | (default-realm "EXAMPLE.COM") | |
14173 | (allow-weak-crypto? #t) | |
14174 | (realms (list | |
14175 | (krb5-realm | |
14176 | (name "EXAMPLE.COM") | |
14177 | (admin-server "groucho.example.com") | |
14178 | (kdc "karl.example.com")) | |
14179 | (krb5-realm | |
14180 | (name "ARGRX.EDU") | |
14181 | (admin-server "kerb-admin.argrx.edu") | |
14182 | (kdc "keys.argrx.edu")))))) | |
14183 | @end lisp | |
14184 | ||
14185 | @noindent | |
14186 | This example provides a Kerberos@tie{}5 client configuration which: | |
14187 | @itemize | |
14188 | @item Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both | |
14189 | of which have distinct administration servers and key distribution centers; | |
14190 | @item Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly | |
14191 | specified by clients; | |
14192 | @item Accepts services which only support encryption types known to be weak. | |
14193 | @end itemize | |
14194 | ||
14195 | The @code{krb5-realm} and @code{krb5-configuration} types have many fields. | |
14196 | Only the most commonly used ones are described here. | |
14197 | For a full list, and more detailed explanation of each, see the MIT | |
14198 | @uref{http://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} | |
14199 | documentation. | |
14200 | ||
14201 | ||
14202 | @deftp {Data Type} krb5-realm | |
14203 | @cindex realm, kerberos | |
14204 | @table @asis | |
14205 | @item @code{name} | |
14206 | This field is a string identifying the name of the realm. | |
14207 | A common convention is to use the fully qualified DNS name of your organization, | |
14208 | converted to upper case. | |
14209 | ||
14210 | @item @code{admin-server} | |
14211 | This field is a string identifying the host where the administration server is | |
14212 | running. | |
14213 | ||
14214 | @item @code{kdc} | |
14215 | This field is a string identifying the key distribution center | |
14216 | for the realm. | |
14217 | @end table | |
14218 | @end deftp | |
14219 | ||
14220 | @deftp {Data Type} krb5-configuration | |
14221 | ||
14222 | @table @asis | |
14223 | @item @code{allow-weak-crypto?} (default: @code{#f}) | |
14224 | If this flag is @code{#t} then services which only offer encryption algorithms | |
14225 | known to be weak will be accepted. | |
14226 | ||
14227 | @item @code{default-realm} (default: @code{#f}) | |
14228 | This field should be a string identifying the default Kerberos | |
14229 | realm for the client. | |
14230 | You should set this field to the name of your Kerberos realm. | |
14231 | If this value is @code{#f} | |
14232 | then a realm must be specified with every Kerberos principal when invoking programs | |
14233 | such as @command{kinit}. | |
14234 | ||
14235 | @item @code{realms} | |
14236 | This should be a non-empty list of @code{krb5-realm} objects, which clients may | |
14237 | access. | |
14238 | Normally, one of them will have a @code{name} field matching the @code{default-realm} | |
14239 | field. | |
14240 | @end table | |
14241 | @end deftp | |
14242 | ||
14243 | ||
859e367d JD |
14244 | @subsubheading PAM krb5 Service |
14245 | @cindex pam-krb5 | |
14246 | ||
df31e36a | 14247 | The @code{pam-krb5} service allows for login authentication and password |
859e367d JD |
14248 | management via Kerberos. |
14249 | You will need this service if you want PAM enabled applications to authenticate | |
14250 | users using Kerberos. | |
14251 | ||
14252 | @defvr {Scheme Variable} pam-krb5-service-type | |
14253 | A service type for the Kerberos 5 PAM module. | |
14254 | @end defvr | |
14255 | ||
14256 | @deftp {Data Type} pam-krb5-configuration | |
14257 | Data type representing the configuration of the Kerberos 5 PAM module | |
14258 | This type has the following parameters: | |
14259 | @table @asis | |
14260 | @item @code{pam-krb5} (default: @code{pam-krb5}) | |
14261 | The pam-krb5 package to use. | |
14262 | ||
14263 | @item @code{minimum-uid} (default: @code{1000}) | |
14264 | The smallest user ID for which Kerberos authentications should be attempted. | |
14265 | Local accounts with lower values will silently fail to authenticate. | |
14266 | @end table | |
14267 | @end deftp | |
14268 | ||
14269 | ||
58724c48 DT |
14270 | @node Web Services |
14271 | @subsubsection Web Services | |
14272 | ||
e32171ee JD |
14273 | @cindex web |
14274 | @cindex www | |
14275 | @cindex HTTP | |
a5130d10 AW |
14276 | The @code{(gnu services web)} module provides the nginx web server and |
14277 | also a fastcgi wrapper daemon. | |
58724c48 | 14278 | |
39fc3004 CB |
14279 | @deffn {Scheme Variable} nginx-service-type |
14280 | Service type for the @uref{https://nginx.org/,NGinx} web server. The | |
14281 | value for this service type is a @code{<nginx-configuration>} record. | |
5a10cd47 | 14282 | |
39fc3004 | 14283 | A simple example configuration is given below. |
58724c48 | 14284 | |
39fc3004 CB |
14285 | @example |
14286 | (service nginx-service-type | |
14287 | (nginx-configuration | |
fb1cba68 | 14288 | (server-blocks |
39fc3004 CB |
14289 | (list (nginx-server-configuration |
14290 | (server-name '("www.example.com")) | |
14291 | (root "/srv/http/www.example.com") | |
14292 | (https-port #f) | |
14293 | (ssl-certificate #f) | |
14294 | (ssl-certificate-key #f)))))) | |
14295 | @end example | |
d338237d | 14296 | |
39fc3004 CB |
14297 | In addition to adding server blocks to the service configuration |
14298 | directly, this service can be extended by other services to add server | |
14299 | blocks, as in this example: | |
d338237d JL |
14300 | |
14301 | @example | |
14302 | (simple-service 'my-extra-server nginx-service-type | |
14303 | (list (nginx-server-configuration | |
14304 | (https-port #f) | |
39fc3004 CB |
14305 | (ssl-certificate #f) |
14306 | (ssl-certificate-key #f) | |
4d14808a OP |
14307 | (root "/srv/http/extra-website") |
14308 | (try-files (list "$uri" "$uri/index.html"))))) | |
d338237d JL |
14309 | @end example |
14310 | @end deffn | |
14311 | ||
39fc3004 CB |
14312 | At startup, @command{nginx} has not yet read its configuration file, so |
14313 | it uses a default file to log error messages. If it fails to load its | |
14314 | configuration file, that is where error messages are logged. After the | |
14315 | configuration file is loaded, the default error log file changes as per | |
14316 | configuration. In our case, startup error messages can be found in | |
14317 | @file{/var/run/nginx/logs/error.log}, and after configuration in | |
14318 | @file{/var/log/nginx/error.log}. The second location can be changed | |
14319 | with the @var{log-directory} configuration option. | |
14320 | ||
14321 | @deffn {Data Type} nginx-configuration | |
14322 | This data type represents the configuration for NGinx. Some | |
14323 | configuration can be done through this and the other provided record | |
14324 | types, or alternatively, a config file can be provided. | |
14325 | ||
14326 | @table @asis | |
14327 | @item @code{nginx} (default: @code{nginx}) | |
14328 | The nginx package to use. | |
14329 | ||
14330 | @item @code{log-directory} (default: @code{"/var/log/nginx"}) | |
14331 | The directory to which NGinx will write log files. | |
14332 | ||
14333 | @item @code{run-directory} (default: @code{"/var/run/nginx"}) | |
14334 | The directory in which NGinx will create a pid file, and write temporary | |
14335 | files. | |
14336 | ||
fb1cba68 | 14337 | @item @code{server-blocks} (default: @code{'()}) |
39fc3004 CB |
14338 | A list of @dfn{server blocks} to create in the generated configuration |
14339 | file, the elements should be of type | |
14340 | @code{<nginx-server-configuration>}. | |
14341 | ||
14342 | The following example would setup NGinx to serve @code{www.example.com} | |
14343 | from the @code{/srv/http/www.example.com} directory, without using | |
14344 | HTTPS. | |
14345 | @example | |
14346 | (service nginx-service-type | |
14347 | (nginx-configuration | |
fb1cba68 | 14348 | (server-blocks |
39fc3004 CB |
14349 | (list (nginx-server-configuration |
14350 | (server-name '("www.example.com")) | |
14351 | (root "/srv/http/www.example.com") | |
14352 | (https-port #f) | |
14353 | (ssl-certificate #f) | |
14354 | (ssl-certificate-key #f)))))) | |
14355 | @end example | |
14356 | ||
c2a59a92 | 14357 | @item @code{upstream-blocks} (default: @code{'()}) |
39fc3004 CB |
14358 | A list of @dfn{upstream blocks} to create in the generated configuration |
14359 | file, the elements should be of type | |
14360 | @code{<nginx-upstream-configuration>}. | |
14361 | ||
c2a59a92 | 14362 | Configuring upstreams through the @code{upstream-blocks} can be useful |
39fc3004 CB |
14363 | when combined with @code{locations} in the |
14364 | @code{<nginx-server-configuration>} records. The following example | |
14365 | creates a server configuration with one location configuration, that | |
14366 | will proxy requests to a upstream configuration, which will handle | |
14367 | requests with two servers. | |
14368 | ||
14369 | @example | |
14370 | (service | |
14371 | nginx-service-type | |
14372 | (nginx-configuration | |
fb1cba68 | 14373 | (server-blocks |
39fc3004 CB |
14374 | (list (nginx-server-configuration |
14375 | (server-name '("www.example.com")) | |
14376 | (root "/srv/http/www.example.com") | |
14377 | (https-port #f) | |
14378 | (ssl-certificate #f) | |
14379 | (ssl-certificate-key #f) | |
14380 | (locations | |
14381 | (list | |
14382 | (nginx-location-configuration | |
14383 | (uri "/path1") | |
14384 | (body '("proxy_pass http://server-proxy;")))))))) | |
c2a59a92 | 14385 | (upstream-blocks |
39fc3004 CB |
14386 | (list (nginx-upstream-configuration |
14387 | (name "server-proxy") | |
14388 | (servers (list "server1.example.com" | |
14389 | "server2.example.com"))))))) | |
14390 | @end example | |
14391 | ||
352a5b63 TGR |
14392 | @item @code{file} (default: @code{#f}) |
14393 | If a configuration @var{file} is provided, this will be used, rather than | |
39fc3004 | 14394 | generating a configuration file from the provided @code{log-directory}, |
c2a59a92 | 14395 | @code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For |
fb1cba68 OP |
14396 | proper operation, these arguments should match what is in @var{file} to ensure |
14397 | that the directories are created when the service is activated. | |
39fc3004 CB |
14398 | |
14399 | This can be useful if you have an existing configuration file, or it's | |
14400 | not possible to do what is required through the other parts of the | |
14401 | nginx-configuration record. | |
14402 | ||
14403 | @end table | |
14404 | @end deffn | |
14405 | ||
3b9b12ef JL |
14406 | @deftp {Data Type} nginx-server-configuration |
14407 | Data type representing the configuration of an nginx server block. | |
8c00b838 JL |
14408 | This type has the following parameters: |
14409 | ||
14410 | @table @asis | |
14411 | @item @code{http-port} (default: @code{80}) | |
14412 | Nginx will listen for HTTP connection on this port. Set it at @code{#f} if | |
14413 | nginx should not listen for HTTP (non secure) connection for this | |
3b9b12ef | 14414 | @dfn{server block}. |
8c00b838 JL |
14415 | |
14416 | @item @code{https-port} (default: @code{443}) | |
14417 | Nginx will listen for HTTPS connection on this port. Set it at @code{#f} if | |
3b9b12ef | 14418 | nginx should not listen for HTTPS (secure) connection for this @dfn{server block}. |
8c00b838 JL |
14419 | |
14420 | Note that nginx can listen for HTTP and HTTPS connections in the same | |
3b9b12ef | 14421 | @dfn{server block}. |
8c00b838 JL |
14422 | |
14423 | @item @code{server-name} (default: @code{(list 'default)}) | |
3b9b12ef JL |
14424 | A list of server names this server represents. @code{'default} represents the |
14425 | default server for connections matching no other server. | |
8c00b838 JL |
14426 | |
14427 | @item @code{root} (default: @code{"/srv/http"}) | |
14428 | Root of the website nginx will serve. | |
14429 | ||
9c557a69 CB |
14430 | @item @code{locations} (default: @code{'()}) |
14431 | A list of @dfn{nginx-location-configuration} or | |
14432 | @dfn{nginx-named-location-configuration} records to use within this | |
14433 | server block. | |
14434 | ||
8c00b838 JL |
14435 | @item @code{index} (default: @code{(list "index.html")}) |
14436 | Index files to look for when clients ask for a directory. If it cannot be found, | |
14437 | Nginx will send the list of files in the directory. | |
14438 | ||
4d14808a OP |
14439 | @item @code{try-files} (default: @code{'()}) |
14440 | A list of files whose existence is checked in the specified order. | |
14441 | @code{nginx} will use the first file it finds to process the request. | |
14442 | ||
8c00b838 JL |
14443 | @item @code{ssl-certificate} (default: @code{"/etc/nginx/cert.pem"}) |
14444 | Where to find the certificate for secure connections. Set it to @code{#f} if | |
14445 | you don't have a certificate or you don't want to use HTTPS. | |
14446 | ||
14447 | @item @code{ssl-certificate-key} (default: @code{"/etc/nginx/key.pem"}) | |
14448 | Where to find the private key for secure connections. Set it to @code{#f} if | |
14449 | you don't have a key or you don't want to use HTTPS. | |
14450 | ||
14451 | @item @code{server-tokens?} (default: @code{#f}) | |
14452 | Whether the server should add its configuration to response. | |
14453 | ||
14454 | @end table | |
14455 | @end deftp | |
14456 | ||
a88d41d1 CB |
14457 | @deftp {Data Type} nginx-upstream-configuration |
14458 | Data type representing the configuration of an nginx @code{upstream} | |
14459 | block. This type has the following parameters: | |
14460 | ||
14461 | @table @asis | |
14462 | @item @code{name} | |
14463 | Name for this group of servers. | |
14464 | ||
14465 | @item @code{servers} | |
14466 | Specify the addresses of the servers in the group. The address can be | |
14467 | specified as a IP address (e.g. @samp{127.0.0.1}), domain name | |
14468 | (e.g. @samp{backend1.example.com}) or a path to a UNIX socket using the | |
14469 | prefix @samp{unix:}. For addresses using an IP address or domain name, | |
14470 | the default port is 80, and a different port can be specified | |
14471 | explicitly. | |
14472 | ||
14473 | @end table | |
14474 | @end deftp | |
14475 | ||
14476 | @deftp {Data Type} nginx-location-configuration | |
14477 | Data type representing the configuration of an nginx @code{location} | |
14478 | block. This type has the following parameters: | |
14479 | ||
14480 | @table @asis | |
14481 | @item @code{uri} | |
14482 | URI which this location block matches. | |
14483 | ||
14484 | @anchor{nginx-location-configuration body} | |
14485 | @item @code{body} | |
14486 | Body of the location block, specified as a string. This can contain many | |
14487 | configuration directives. For example, to pass requests to a upstream | |
14488 | server group defined using an @code{nginx-upstream-configuration} block, | |
14489 | the following directive would be specified in the body @samp{proxy_pass | |
14490 | http://upstream-name;}. | |
14491 | ||
14492 | @end table | |
14493 | @end deftp | |
14494 | ||
14495 | @deftp {Data Type} nginx-named-location-configuration | |
14496 | Data type representing the configuration of an nginx named location | |
14497 | block. Named location blocks are used for request redirection, and not | |
14498 | used for regular request processing. This type has the following | |
14499 | parameters: | |
14500 | ||
14501 | @table @asis | |
14502 | @item @code{name} | |
14503 | Name to identify this location block. | |
14504 | ||
14505 | @item @code{body} | |
14506 | @xref{nginx-location-configuration body}, as the body for named location | |
14507 | blocks can be used in a similar way to the | |
14508 | @code{nginx-location-configuration body}. One restriction is that the | |
14509 | body of a named location block cannot contain location blocks. | |
14510 | ||
14511 | @end table | |
14512 | @end deftp | |
14513 | ||
a5130d10 AW |
14514 | @cindex fastcgi |
14515 | @cindex fcgiwrap | |
14516 | FastCGI is an interface between the front-end and the back-end of a web | |
14517 | service. It is a somewhat legacy facility; new web services should | |
14518 | generally just talk HTTP between the front-end and the back-end. | |
14519 | However there are a number of back-end services such as PHP or the | |
14520 | optimized HTTP Git repository access that use FastCGI, so we have | |
14521 | support for it in Guix. | |
14522 | ||
14523 | To use FastCGI, you configure the front-end web server (e.g., nginx) to | |
14524 | dispatch some subset of its requests to the fastcgi backend, which | |
14525 | listens on a local TCP or UNIX socket. There is an intermediary | |
14526 | @code{fcgiwrap} program that sits between the actual backend process and | |
14527 | the web server. The front-end indicates which backend program to run, | |
14528 | passing that information to the @code{fcgiwrap} process. | |
14529 | ||
14530 | @defvr {Scheme Variable} fcgiwrap-service-type | |
14531 | A service type for the @code{fcgiwrap} FastCGI proxy. | |
14532 | @end defvr | |
14533 | ||
14534 | @deftp {Data Type} fcgiwrap-configuration | |
14535 | Data type representing the configuration of the @code{fcgiwrap} serice. | |
14536 | This type has the following parameters: | |
14537 | @table @asis | |
14538 | @item @code{package} (default: @code{fcgiwrap}) | |
14539 | The fcgiwrap package to use. | |
14540 | ||
14541 | @item @code{socket} (default: @code{tcp:127.0.0.1:9000}) | |
14542 | The socket on which the @code{fcgiwrap} process should listen, as a | |
14543 | string. Valid @var{socket} values include | |
14544 | @code{unix:@var{/path/to/unix/socket}}, | |
14545 | @code{tcp:@var{dot.ted.qu.ad}:@var{port}} and | |
14546 | @code{tcp6:[@var{ipv6_addr}]:port}. | |
14547 | ||
14548 | @item @code{user} (default: @code{fcgiwrap}) | |
14549 | @itemx @code{group} (default: @code{fcgiwrap}) | |
14550 | The user and group names, as strings, under which to run the | |
14551 | @code{fcgiwrap} process. The @code{fastcgi} service will ensure that if | |
14552 | the user asks for the specific user or group names @code{fcgiwrap} that | |
14553 | the corresponding user and/or group is present on the system. | |
14554 | ||
14555 | It is possible to configure a FastCGI-backed web service to pass HTTP | |
14556 | authentication information from the front-end to the back-end, and to | |
14557 | allow @code{fcgiwrap} to run the back-end process as a corresponding | |
14558 | local user. To enable this capability on the back-end., run | |
14559 | @code{fcgiwrap} as the @code{root} user and group. Note that this | |
14560 | capability also has to be configured on the front-end as well. | |
14561 | @end table | |
14562 | @end deftp | |
14563 | ||
a88d41d1 | 14564 | |
ba69e8f7 JL |
14565 | @node DNS Services |
14566 | @subsubsection DNS Services | |
14567 | @cindex DNS (domain name system) | |
14568 | @cindex domain name system (DNS) | |
14569 | ||
14570 | The @code{(gnu services dns)} module provides services related to the | |
14571 | @dfn{domain name system} (DNS). It provides a server service for hosting | |
14572 | an @emph{authoritative} DNS server for multiple zones, slave or master. | |
14573 | This service uses @uref{https://www.knot-dns.cz/, Knot DNS}. | |
14574 | ||
14575 | An example configuration of an authoritative server for two zones, one master | |
14576 | and one slave, is: | |
14577 | ||
14578 | @lisp | |
14579 | (define-zone-entries example.org.zone | |
14580 | ;; Name TTL Class Type Data | |
14581 | ("@@" "" "IN" "A" "127.0.0.1") | |
14582 | ("@@" "" "IN" "NS" "ns") | |
14583 | ("ns" "" "IN" "A" "127.0.0.1")) | |
14584 | ||
14585 | (define master-zone | |
14586 | (knot-zone-configuration | |
14587 | (domain "example.org") | |
14588 | (zone (zone-file | |
14589 | (origin "example.org") | |
14590 | (entries example.org.zone))))) | |
14591 | ||
14592 | (define slave-zone | |
14593 | (knot-zone-configuration | |
14594 | (domain "plop.org") | |
14595 | (dnssec-policy "default") | |
14596 | (master (list "plop-master")))) | |
14597 | ||
14598 | (define plop-master | |
14599 | (knot-remote-configuration | |
14600 | (id "plop-master") | |
14601 | (address (list "208.76.58.171")))) | |
14602 | ||
14603 | (operating-system | |
14604 | ;; ... | |
14605 | (services (cons* (service knot-service-type | |
14606 | (knot-confifguration | |
14607 | (remotes (list plop-master)) | |
14608 | (zones (list master-zone slave-zone)))) | |
14609 | ;; ... | |
14610 | %base-services))) | |
14611 | @end lisp | |
14612 | ||
14613 | @deffn {Scheme Variable} knot-service-type | |
14614 | This is the type for the Knot DNS server. | |
14615 | ||
14616 | Knot DNS is an authoritative DNS server, meaning that it can serve multiple | |
14617 | zones, that is to say domain names you would buy from a registrar. This server | |
14618 | is not a resolver, meaning that it can only resolve names for which it is | |
14619 | authoritative. This server can be configured to serve zones as a master server | |
14620 | or a slave server as a per-zone basis. Slave zones will get their data from | |
14621 | masters, and will serve it as an authoritative server. From the point of view | |
14622 | of a resolver, there is no difference between master and slave. | |
14623 | ||
14624 | The following data types are used to configure the Knot DNS server: | |
14625 | @end deffn | |
14626 | ||
14627 | @deftp {Data Type} knot-key-configuration | |
14628 | Data type representing a key. | |
14629 | This type has the following parameters: | |
14630 | ||
14631 | @table @asis | |
14632 | @item @code{id} (default: @code{""}) | |
14633 | An identifier for other configuration fields to refer to this key. IDs must | |
14634 | be unique and must not be empty. | |
14635 | ||
14636 | @item @code{algorithm} (default: @code{#f}) | |
14637 | The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, | |
14638 | @code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, @code{'hmac-sha384} | |
14639 | and @code{'hmac-sha512}. | |
14640 | ||
14641 | @item @code{secret} (default: @code{""}) | |
14642 | The secret key itself. | |
14643 | ||
14644 | @end table | |
14645 | @end deftp | |
14646 | ||
14647 | @deftp {Data Type} knot-acl-configuration | |
14648 | Data type representing an Access Control List (ACL) configuration. | |
14649 | This type has the following parameters: | |
14650 | ||
14651 | @table @asis | |
14652 | @item @code{id} (default: @code{""}) | |
14653 | An identifier for ether configuration fields to refer to this key. IDs must be | |
14654 | unique and must not be empty. | |
14655 | ||
14656 | @item @code{address} (default: @code{'()}) | |
14657 | An ordered list of IP addresses, network subnets, or network ranges represented | |
14658 | with strings. The query must match one of them. Empty value means that | |
14659 | address match is not required. | |
14660 | ||
14661 | @item @code{key} (default: @code{'()}) | |
14662 | An ordered list of references to keys represented with strings. The string | |
14663 | must match a key ID defined in a @code{knot-key-configuration}. No key means | |
14664 | that a key is not require to match that ACL. | |
14665 | ||
14666 | @item @code{action} (default: @code{'()}) | |
14667 | An ordered list of actions that are permitted or forbidden by this ACL. Possible | |
14668 | values are lists of zero or more elements from @code{'transfer}, @code{'notify} | |
14669 | and @code{'update}. | |
14670 | ||
14671 | @item @code{deny?} (default: @code{#f}) | |
14672 | When true, the ACL defines restrictions. Listed actions are forbidden. When | |
14673 | false, listed actions are allowed. | |
14674 | ||
14675 | @end table | |
14676 | @end deftp | |
14677 | ||
14678 | @deftp {Data Type} zone-entry | |
14679 | Data type represnting a record entry in a zone file. | |
14680 | This type has the following parameters: | |
14681 | ||
14682 | @table @asis | |
14683 | @item @code{name} (default: @code{"@@"}) | |
14684 | The name of the record. @code{"@@"} refers to the origin of the zone. Names | |
14685 | are relative to the origin of the zone. For example, in the @code{example.org} | |
14686 | zone, @code{"ns.example.org"} actually refers to @code{ns.example.org.example.org}. | |
14687 | Names ending with a dot are absolute, which means that @code{"ns.example.org."} | |
14688 | refers to @code{ns.example.org}. | |
14689 | ||
14690 | @item @code{ttl} (default: @code{""}) | |
14691 | The Time-To-Live (TTL) of this record. If not set, the default TTL is used. | |
14692 | ||
14693 | @item @code{class} (default: @code{"IN"}) | |
14694 | The class of the record. Knot currently supports only @code{"IN"} and | |
14695 | partially @code{"CH"}. | |
14696 | ||
14697 | @item @code{type} (default: @code{"A"}) | |
14698 | The type of the record. Common types include A (IPv4 address), AAAA (IPv6 | |
14699 | address), NS (Name Server) and MX (Mail eXchange). Many other types are | |
14700 | defined. | |
14701 | ||
14702 | @item @code{data} (default: @code{""}) | |
14703 | The data contained in the record. For instance an IP address associated with | |
14704 | an A record, or a domain name associated with an NS record. Remember that | |
14705 | domain names are relative to the origin unless they end with a dot. | |
14706 | ||
14707 | @end table | |
14708 | @end deftp | |
14709 | ||
14710 | @deftp {Data Type} zone-file | |
14711 | Data type representing the content of a zone file. | |
14712 | This type has the following parameters: | |
14713 | ||
14714 | @table @asis | |
14715 | @item @code{entries} (default: @code{'()}) | |
14716 | The list of entries. The SOA record is taken care of, so you don't need to | |
14717 | put it in the list of entries. This list should probably contain an entry | |
14718 | for your primary authoritative DNS server. Other than using a list of entries | |
14719 | directly, you can use @code{define-zone-entries} to define a object containing | |
14720 | the list of entries more easily, that you can later pass to the @code{entries} | |
14721 | field of the @code{zone-file}. | |
14722 | ||
14723 | @item @code{origin} (default: @code{""}) | |
14724 | The name of your zone. This parameter cannot be empty. | |
14725 | ||
14726 | @item @code{ns} (default: @code{"ns"}) | |
14727 | The domain of your primary authoritative DNS server. The name is relative to | |
14728 | the origin, unless it ends with a dot. It is mandatory that this primary | |
14729 | DNS server corresponds to an NS record in the zone and that it is associated | |
14730 | to an IP address in the list of entries. | |
14731 | ||
14732 | @item @code{mail} (default: @code{"hostmaster"}) | |
14733 | An email address people can contact you at, as the owner of the zone. This | |
14734 | is translated as @code{<mail>@@<origin>}. | |
14735 | ||
14736 | @item @code{serial} (default: @code{1}) | |
14737 | The serial number of the zone. As this is used to keep track of changes by | |
14738 | both slaves and resolvers, it is mandatory that it @emph{never} decreases. | |
14739 | Always increment it when you make a change in your zone. | |
14740 | ||
f3853a25 JL |
14741 | @item @code{refresh} (default: @code{(* 2 24 3600)}) |
14742 | The frequency at which slaves will do a zone transfer. This value is a number | |
14743 | of seconds. It can be computed by multiplications or with | |
14744 | @code{(string->duration)}. | |
ba69e8f7 | 14745 | |
f3853a25 | 14746 | @item @code{retry} (default: @code{(* 15 60)}) |
ba69e8f7 JL |
14747 | The period after which a slave will retry to contact its master when it fails |
14748 | to do so a first time. | |
14749 | ||
f3853a25 | 14750 | @item @code{expiry} (default: @code{(* 14 24 3600)}) |
ba69e8f7 JL |
14751 | Default TTL of records. Existing records are considered correct for at most |
14752 | this amount of time. After this period, resolvers will invalidate their cache | |
14753 | and check again that it still exists. | |
14754 | ||
f3853a25 | 14755 | @item @code{nx} (default: @code{3600}) |
ba69e8f7 JL |
14756 | Default TTL of inexistant records. This delay is usually short because you want |
14757 | your new domains to reach everyone quickly. | |
14758 | ||
14759 | @end table | |
14760 | @end deftp | |
14761 | ||
14762 | @deftp {Data Type} knot-remote-configuration | |
14763 | Data type representing a remote configuration. | |
14764 | This type has the following parameters: | |
14765 | ||
14766 | @table @asis | |
14767 | @item @code{id} (default: @code{""}) | |
14768 | An identifier for other configuration fields to refer to this remote. IDs must | |
14769 | be unique and must not be empty. | |
14770 | ||
14771 | @item @code{address} (default: @code{'()}) | |
14772 | An ordered list of destination IP addresses. Addresses are tried in sequence. | |
14773 | An optional port can be given with the @@ separator. For instance: | |
14774 | @code{(list "1.2.3.4" "2.3.4.5@@53")}. Default port is 53. | |
14775 | ||
14776 | @item @code{via} (default: @code{'()}) | |
14777 | An ordered list of source IP addresses. An empty list will have Knot choose | |
14778 | an appropriate source IP. An optional port can be given with the @@ separator. | |
14779 | The default is to choose at random. | |
14780 | ||
14781 | @item @code{key} (default: @code{#f}) | |
14782 | A reference to a key, that is a string containing the identifier of a key | |
14783 | defined in a @code{knot-key-configuration} field. | |
14784 | ||
14785 | @end table | |
14786 | @end deftp | |
14787 | ||
14788 | @deftp {Data Type} knot-keystore-configuration | |
14789 | Data type representing a keystore to hold dnssec keys. | |
14790 | This type has the following parameters: | |
14791 | ||
14792 | @table @asis | |
14793 | @item @code{id} (default: @code{""}) | |
14794 | The id of the keystore. It must not be empty. | |
14795 | ||
14796 | @item @code{backend} (default: @code{'pem}) | |
14797 | The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}. | |
14798 | ||
14799 | @item @code{config} (default: @code{"/var/lib/knot/keys/keys"}) | |
14800 | The configuration string of the backend. An example for the PKCS#11 is: | |
14801 | @code{"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so"}. | |
14802 | For the pem backend, the string reprensents a path in the filesystem. | |
14803 | ||
14804 | @end table | |
14805 | @end deftp | |
14806 | ||
14807 | @deftp {Data Type} knot-policy-configuration | |
14808 | Data type representing a dnssec policy. Knot DNS is able to automatically | |
14809 | sign your zones. It can either generate and manage your keys automatically or | |
14810 | use keys that you generate. | |
14811 | ||
14812 | Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that is | |
14813 | used to sign the second, and a Zone Signing Key (ZSK) that is used to sign the | |
14814 | zone. In order to be trusted, the KSK needs to be present in the parent zone | |
14815 | (usually a top-level domain). If your registrar supports dnssec, you will | |
14816 | have to send them your KSK's hash so they can add a DS record in their zone. | |
14817 | This is not automated and need to be done each time you change your KSK. | |
14818 | ||
14819 | The policy also defines the lifetime of keys. Usually, ZSK can be changed | |
14820 | easily and use weaker cryptographic functions (they use lower parameters) in | |
14821 | order to sign records quickly, so they are changed often. The KSK however | |
14822 | requires manual interaction with the registrar, so they are changed less often | |
14823 | and use stronger parameters because they sign only one record. | |
14824 | ||
14825 | This type has the following parameters: | |
14826 | ||
14827 | @table @asis | |
14828 | @item @code{id} (default: @code{""}) | |
14829 | The id of the policy. It must not be empty. | |
14830 | ||
14831 | @item @code{keystore} (default: @code{"default"}) | |
14832 | A reference to a keystore, that is a string containing the identifier of a | |
14833 | keystore defined in a @code{knot-keystore-configuration} field. The | |
14834 | @code{"default"} identifier means the default keystore (a kasp database that | |
14835 | was setup by this service). | |
14836 | ||
14837 | @item @code{manual?} (default: @code{#f}) | |
14838 | Whether the key management is manual or automatic. | |
14839 | ||
14840 | @item @code{single-type-signing?} (default: @code{#f}) | |
14841 | When @code{#t}, use the Single-Type Signing Scheme. | |
14842 | ||
14843 | @item @code{algorithm} (default: @code{"ecdsap256sha256"}) | |
14844 | An algorithm of signing keys and issued signatures. | |
14845 | ||
14846 | @item @code{ksk-size} (default: @code{256}) | |
14847 | The length of the KSK. Note that this value is correct for the default | |
14848 | algorithm, but would be unsecure for other algorithms. | |
14849 | ||
14850 | @item @code{zsk-size} (default: @code{256}) | |
14851 | The length of the ZSK. Note that this value is correct for the default | |
14852 | algorithm, but would be unsecure for other algorithms. | |
14853 | ||
14854 | @item @code{dnskey-ttl} (default: @code{'default}) | |
14855 | The TTL value for DNSKEY records added into zone apex. The special | |
14856 | @code{'default} value means same as the zone SOA TTL. | |
14857 | ||
f3853a25 | 14858 | @item @code{zsk-lifetime} (default: @code{(* 30 24 3600)}) |
ba69e8f7 JL |
14859 | The period between ZSK publication and the next rollover initiation. |
14860 | ||
f3853a25 | 14861 | @item @code{propagation-delay} (default: @code{(* 24 3600)}) |
ba69e8f7 JL |
14862 | An extra delay added for each key rollover step. This value should be high |
14863 | enough to cover propagation of data from the master server to all slaves. | |
14864 | ||
f3853a25 | 14865 | @item @code{rrsig-lifetime} (default: @code{(* 14 24 3600)}) |
ba69e8f7 JL |
14866 | A validity period of newly issued signatures. |
14867 | ||
f3853a25 | 14868 | @item @code{rrsig-refresh} (default: @code{(* 7 24 3600)}) |
ba69e8f7 JL |
14869 | A period how long before a signature expiration the signature will be refreshed. |
14870 | ||
14871 | @item @code{nsec3?} (default: @code{#f}) | |
14872 | When @code{#t}, NSEC3 will be used instead of NSEC. | |
14873 | ||
14874 | @item @code{nsec3-iterations} (default: @code{5}) | |
14875 | The number of additional times the hashing is performed. | |
14876 | ||
14877 | @item @code{nsec3-salt-length} (default: @code{8}) | |
14878 | The length of a salt field in octets, which is appended to the original owner | |
14879 | name before hashing. | |
14880 | ||
f3853a25 | 14881 | @item @code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)}) |
ba69e8f7 JL |
14882 | The validity period of newly issued salt field. |
14883 | ||
14884 | @end table | |
14885 | @end deftp | |
14886 | ||
14887 | @deftp {Data Type} knot-zone-configuration | |
14888 | Data type representing a zone served by Knot. | |
14889 | This type has the following parameters: | |
14890 | ||
14891 | @table @asis | |
14892 | @item @code{domain} (default: @code{""}) | |
14893 | The domain served by this configuration. It must not be empty. | |
14894 | ||
14895 | @item @code{file} (default: @code{""}) | |
14896 | The file where this zone is saved. This parameter is ignored by master zones. | |
14897 | Empty means default location that depends on the domain name. | |
14898 | ||
14899 | @item @code{zone} (default: @code{(zone-file)}) | |
14900 | The content of the zone file. This parameter is ignored by slave zones. It | |
14901 | must contain a zone-file record. | |
14902 | ||
14903 | @item @code{master} (default: @code{'()}) | |
14904 | A list of master remotes. When empty, this zone is a master. When set, this | |
14905 | zone is a slave. This is a list of remotes identifiers. | |
14906 | ||
14907 | @item @code{ddns-master} (default: @code{#f}) | |
14908 | The main master. When empty, it defaults to the first master in the list of | |
14909 | masters. | |
14910 | ||
14911 | @item @code{notify} (default: @code{'()}) | |
14912 | A list of slave remote identifiers. | |
14913 | ||
14914 | @item @code{acl} (default: @code{'()}) | |
14915 | A list of acl identifiers. | |
14916 | ||
14917 | @item @code{semantic-checks?} (default: @code{#f}) | |
14918 | When set, this adds more semantic checks to the zone. | |
14919 | ||
14920 | @item @code{disable-any?} (default: @code{#f}) | |
14921 | When set, this forbids queries of the ANY type. | |
14922 | ||
14923 | @item @code{zonefile-sync} (default: @code{0}) | |
14924 | The delay between a modification in memory and on disk. 0 means immediate | |
14925 | synchronization. | |
14926 | ||
14927 | @item @code{serial-policy} (default: @code{'increment}) | |
14928 | A policy between @code{'increment} and @code{'unixtime}. | |
14929 | ||
14930 | @end table | |
14931 | @end deftp | |
14932 | ||
14933 | @deftp {Data Type} knot-configuration | |
14934 | Data type representing the Knot configuration. | |
14935 | This type has the following parameters: | |
14936 | ||
14937 | @table @asis | |
14938 | @item @code{knot} (default: @code{knot}) | |
14939 | The Knot package. | |
14940 | ||
14941 | @item @code{run-directory} (default: @code{"/var/run/knot"}) | |
14942 | The run directory. This directory will be used for pid file and sockets. | |
14943 | ||
14944 | @item @code{listen-v4} (default: @code{"0.0.0.0"}) | |
14945 | An ip address on which to listen. | |
14946 | ||
14947 | @item @code{listen-v6} (default: @code{"::"}) | |
14948 | An ip address on which to listen. | |
14949 | ||
14950 | @item @code{listen-port} (default: @code{53}) | |
14951 | A port on which to listen. | |
14952 | ||
14953 | @item @code{keys} (default: @code{'()}) | |
14954 | The list of knot-key-configuration used by this configuration. | |
14955 | ||
14956 | @item @code{acls} (default: @code{'()}) | |
14957 | The list of knot-acl-configuration used by this configuration. | |
14958 | ||
14959 | @item @code{remotes} (default: @code{'()}) | |
14960 | The list of knot-remote-configuration used by this configuration. | |
14961 | ||
14962 | @item @code{zones} (default: @code{'()}) | |
14963 | The list of knot-zone-configuration used by this configuration. | |
14964 | ||
14965 | @end table | |
14966 | @end deftp | |
14967 | ||
2be1b471 JL |
14968 | @node VPN Services |
14969 | @subsubsection VPN Services | |
14970 | @cindex VPN (virtual private network) | |
14971 | @cindex virtual private network (VPN) | |
14972 | ||
14973 | The @code{(gnu services vpn)} module provides services related to | |
14974 | @dfn{virtual private networks} (VPNs). It provides a @emph{client} service for | |
14975 | your machine to connect to a VPN, and a @emph{servire} service for your machine | |
14976 | to host a VPN. Both services use @uref{https://openvpn.net/, OpenVPN}. | |
14977 | ||
14978 | @deffn {Scheme Procedure} openvpn-client-service @ | |
14979 | [#:config (openvpn-client-configuration)] | |
14980 | ||
14981 | Return a service that runs @command{openvpn}, a VPN daemon, as a client. | |
14982 | @end deffn | |
14983 | ||
14984 | @deffn {Scheme Procedure} openvpn-server-service @ | |
14985 | [#:config (openvpn-server-configuration)] | |
14986 | ||
14987 | Return a service that runs @command{openvpn}, a VPN daemon, as a server. | |
14988 | ||
14989 | Both can be run simultaneously. | |
14990 | @end deffn | |
14991 | ||
14992 | @c %automatically generated documentation | |
14993 | ||
14994 | Available @code{openvpn-client-configuration} fields are: | |
14995 | ||
1c17a863 | 14996 | @deftypevr {@code{openvpn-client-configuration} parameter} package openvpn |
2be1b471 JL |
14997 | The OpenVPN package. |
14998 | ||
14999 | @end deftypevr | |
15000 | ||
1c17a863 | 15001 | @deftypevr {@code{openvpn-client-configuration} parameter} string pid-file |
2be1b471 JL |
15002 | The OpenVPN pid file. |
15003 | ||
15004 | Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. | |
15005 | ||
15006 | @end deftypevr | |
15007 | ||
1c17a863 | 15008 | @deftypevr {@code{openvpn-client-configuration} parameter} proto proto |
2be1b471 JL |
15009 | The protocol (UDP or TCP) used to open a channel between clients and |
15010 | servers. | |
15011 | ||
15012 | Defaults to @samp{udp}. | |
15013 | ||
15014 | @end deftypevr | |
15015 | ||
1c17a863 | 15016 | @deftypevr {@code{openvpn-client-configuration} parameter} dev dev |
2be1b471 JL |
15017 | The device type used to represent the VPN connection. |
15018 | ||
15019 | Defaults to @samp{tun}. | |
15020 | ||
15021 | @end deftypevr | |
15022 | ||
1c17a863 | 15023 | @deftypevr {@code{openvpn-client-configuration} parameter} string ca |
2be1b471 JL |
15024 | The certificate authority to check connections against. |
15025 | ||
15026 | Defaults to @samp{"/etc/openvpn/ca.crt"}. | |
15027 | ||
15028 | @end deftypevr | |
15029 | ||
1c17a863 | 15030 | @deftypevr {@code{openvpn-client-configuration} parameter} string cert |
2be1b471 JL |
15031 | The certificate of the machine the daemon is running on. It should be |
15032 | signed by the authority given in @code{ca}. | |
15033 | ||
15034 | Defaults to @samp{"/etc/openvpn/client.crt"}. | |
15035 | ||
15036 | @end deftypevr | |
15037 | ||
1c17a863 | 15038 | @deftypevr {@code{openvpn-client-configuration} parameter} string key |
2be1b471 JL |
15039 | The key of the machine the daemon is running on. It must be the key whose |
15040 | certificate is @code{cert}. | |
15041 | ||
15042 | Defaults to @samp{"/etc/openvpn/client.key"}. | |
15043 | ||
15044 | @end deftypevr | |
15045 | ||
1c17a863 | 15046 | @deftypevr {@code{openvpn-client-configuration} parameter} boolean comp-lzo? |
2be1b471 JL |
15047 | Whether to use the lzo compression algorithm. |
15048 | ||
15049 | Defaults to @samp{#t}. | |
15050 | ||
15051 | @end deftypevr | |
15052 | ||
1c17a863 | 15053 | @deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-key? |
2be1b471 JL |
15054 | Don't re-read key files across SIGUSR1 or --ping-restart. |
15055 | ||
15056 | Defaults to @samp{#t}. | |
15057 | ||
15058 | @end deftypevr | |
15059 | ||
1c17a863 | 15060 | @deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-tun? |
2be1b471 JL |
15061 | Don't close and reopen TUN/TAP device or run up/down scripts across |
15062 | SIGUSR1 or --ping-restart restarts. | |
15063 | ||
15064 | Defaults to @samp{#t}. | |
15065 | ||
15066 | @end deftypevr | |
15067 | ||
1c17a863 | 15068 | @deftypevr {@code{openvpn-client-configuration} parameter} number verbosity |
2be1b471 JL |
15069 | Verbosity level. |
15070 | ||
15071 | Defaults to @samp{3}. | |
15072 | ||
15073 | @end deftypevr | |
15074 | ||
1c17a863 | 15075 | @deftypevr {@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth |
2be1b471 JL |
15076 | Add an additional layer of HMAC authentication on top of the TLS control |
15077 | channel to protect against DoS attacks. | |
15078 | ||
15079 | Defaults to @samp{#f}. | |
15080 | ||
15081 | @end deftypevr | |
15082 | ||
1c17a863 | 15083 | @deftypevr {@code{openvpn-client-configuration} parameter} key-usage verify-key-usage? |
2be1b471 JL |
15084 | Whether to check the server certificate has server usage extension. |
15085 | ||
15086 | Defaults to @samp{#t}. | |
15087 | ||
15088 | @end deftypevr | |
15089 | ||
1c17a863 | 15090 | @deftypevr {@code{openvpn-client-configuration} parameter} bind bind? |
2be1b471 JL |
15091 | Bind to a specific local port number. |
15092 | ||
15093 | Defaults to @samp{#f}. | |
15094 | ||
15095 | @end deftypevr | |
15096 | ||
1c17a863 | 15097 | @deftypevr {@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry? |
2be1b471 JL |
15098 | Retry resolving server address. |
15099 | ||
15100 | Defaults to @samp{#t}. | |
15101 | ||
15102 | @end deftypevr | |
15103 | ||
1c17a863 | 15104 | @deftypevr {@code{openvpn-client-configuration} parameter} openvpn-remote-list remote |
2be1b471 JL |
15105 | A list of remote servers to connect to. |
15106 | ||
15107 | Defaults to @samp{()}. | |
15108 | ||
15109 | Available @code{openvpn-remote-configuration} fields are: | |
15110 | ||
1c17a863 | 15111 | @deftypevr {@code{openvpn-remote-configuration} parameter} string name |
2be1b471 JL |
15112 | Server name. |
15113 | ||
15114 | Defaults to @samp{"my-server"}. | |
15115 | ||
15116 | @end deftypevr | |
15117 | ||
1c17a863 | 15118 | @deftypevr {@code{openvpn-remote-configuration} parameter} number port |
2be1b471 JL |
15119 | Port number the server listens to. |
15120 | ||
15121 | Defaults to @samp{1194}. | |
15122 | ||
15123 | @end deftypevr | |
15124 | ||
15125 | @end deftypevr | |
15126 | @c %end of automatic openvpn-client documentation | |
15127 | ||
15128 | @c %automatically generated documentation | |
15129 | ||
15130 | Available @code{openvpn-server-configuration} fields are: | |
15131 | ||
1c17a863 | 15132 | @deftypevr {@code{openvpn-server-configuration} parameter} package openvpn |
2be1b471 JL |
15133 | The OpenVPN package. |
15134 | ||
15135 | @end deftypevr | |
15136 | ||
1c17a863 | 15137 | @deftypevr {@code{openvpn-server-configuration} parameter} string pid-file |
2be1b471 JL |
15138 | The OpenVPN pid file. |
15139 | ||
15140 | Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. | |
15141 | ||
15142 | @end deftypevr | |
15143 | ||
1c17a863 | 15144 | @deftypevr {@code{openvpn-server-configuration} parameter} proto proto |
2be1b471 JL |
15145 | The protocol (UDP or TCP) used to open a channel between clients and |
15146 | servers. | |
15147 | ||
15148 | Defaults to @samp{udp}. | |
15149 | ||
15150 | @end deftypevr | |
15151 | ||
1c17a863 | 15152 | @deftypevr {@code{openvpn-server-configuration} parameter} dev dev |
2be1b471 JL |
15153 | The device type used to represent the VPN connection. |
15154 | ||
15155 | Defaults to @samp{tun}. | |
15156 | ||
15157 | @end deftypevr | |
15158 | ||
1c17a863 | 15159 | @deftypevr {@code{openvpn-server-configuration} parameter} string ca |
2be1b471 JL |
15160 | The certificate authority to check connections against. |
15161 | ||
15162 | Defaults to @samp{"/etc/openvpn/ca.crt"}. | |
15163 | ||
15164 | @end deftypevr | |
15165 | ||
1c17a863 | 15166 | @deftypevr {@code{openvpn-server-configuration} parameter} string cert |
2be1b471 JL |
15167 | The certificate of the machine the daemon is running on. It should be |
15168 | signed by the authority given in @code{ca}. | |
15169 | ||
15170 | Defaults to @samp{"/etc/openvpn/client.crt"}. | |
15171 | ||
15172 | @end deftypevr | |
15173 | ||
1c17a863 | 15174 | @deftypevr {@code{openvpn-server-configuration} parameter} string key |
2be1b471 JL |
15175 | The key of the machine the daemon is running on. It must be the key whose |
15176 | certificate is @code{cert}. | |
15177 | ||
15178 | Defaults to @samp{"/etc/openvpn/client.key"}. | |
15179 | ||
15180 | @end deftypevr | |
15181 | ||
1c17a863 | 15182 | @deftypevr {@code{openvpn-server-configuration} parameter} boolean comp-lzo? |
2be1b471 JL |
15183 | Whether to use the lzo compression algorithm. |
15184 | ||
15185 | Defaults to @samp{#t}. | |
15186 | ||
15187 | @end deftypevr | |
15188 | ||
1c17a863 | 15189 | @deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-key? |
2be1b471 JL |
15190 | Don't re-read key files across SIGUSR1 or --ping-restart. |
15191 | ||
15192 | Defaults to @samp{#t}. | |
15193 | ||
15194 | @end deftypevr | |
15195 | ||
1c17a863 | 15196 | @deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-tun? |
2be1b471 JL |
15197 | Don't close and reopen TUN/TAP device or run up/down scripts across |
15198 | SIGUSR1 or --ping-restart restarts. | |
15199 | ||
15200 | Defaults to @samp{#t}. | |
15201 | ||
15202 | @end deftypevr | |
15203 | ||
1c17a863 | 15204 | @deftypevr {@code{openvpn-server-configuration} parameter} number verbosity |
2be1b471 JL |
15205 | Verbosity level. |
15206 | ||
15207 | Defaults to @samp{3}. | |
15208 | ||
15209 | @end deftypevr | |
15210 | ||
1c17a863 | 15211 | @deftypevr {@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth |
2be1b471 JL |
15212 | Add an additional layer of HMAC authentication on top of the TLS control |
15213 | channel to protect against DoS attacks. | |
15214 | ||
15215 | Defaults to @samp{#f}. | |
15216 | ||
15217 | @end deftypevr | |
15218 | ||
1c17a863 | 15219 | @deftypevr {@code{openvpn-server-configuration} parameter} number port |
2be1b471 JL |
15220 | Specifies the port number on which the server listens. |
15221 | ||
15222 | Defaults to @samp{1194}. | |
15223 | ||
15224 | @end deftypevr | |
15225 | ||
1c17a863 | 15226 | @deftypevr {@code{openvpn-server-configuration} parameter} ip-mask server |
2be1b471 JL |
15227 | An ip and mask specifying the subnet inside the virtual network. |
15228 | ||
15229 | Defaults to @samp{"10.8.0.0 255.255.255.0"}. | |
15230 | ||
15231 | @end deftypevr | |
15232 | ||
1c17a863 | 15233 | @deftypevr {@code{openvpn-server-configuration} parameter} cidr6 server-ipv6 |
2be1b471 JL |
15234 | A CIDR notation specifying the IPv6 subnet inside the virtual network. |
15235 | ||
15236 | Defaults to @samp{#f}. | |
15237 | ||
15238 | @end deftypevr | |
15239 | ||
1c17a863 | 15240 | @deftypevr {@code{openvpn-server-configuration} parameter} string dh |
2be1b471 JL |
15241 | The Diffie-Hellman parameters file. |
15242 | ||
15243 | Defaults to @samp{"/etc/openvpn/dh2048.pem"}. | |
15244 | ||
15245 | @end deftypevr | |
15246 | ||
1c17a863 | 15247 | @deftypevr {@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist |
2be1b471 JL |
15248 | The file that records client IPs. |
15249 | ||
15250 | Defaults to @samp{"/etc/openvpn/ipp.txt"}. | |
15251 | ||
15252 | @end deftypevr | |
15253 | ||
1c17a863 | 15254 | @deftypevr {@code{openvpn-server-configuration} parameter} gateway redirect-gateway? |
2be1b471 JL |
15255 | When true, the server will act as a gateway for its clients. |
15256 | ||
15257 | Defaults to @samp{#f}. | |
15258 | ||
15259 | @end deftypevr | |
15260 | ||
1c17a863 | 15261 | @deftypevr {@code{openvpn-server-configuration} parameter} boolean client-to-client? |
9fc221b5 | 15262 | When true, clients are allowed to talk to each other inside the VPN. |
2be1b471 JL |
15263 | |
15264 | Defaults to @samp{#f}. | |
15265 | ||
15266 | @end deftypevr | |
15267 | ||
1c17a863 | 15268 | @deftypevr {@code{openvpn-server-configuration} parameter} keepalive keepalive |
2be1b471 JL |
15269 | Causes ping-like messages to be sent back and forth over the link so |
15270 | that each side knows when the other side has gone down. @code{keepalive} | |
15271 | requires a pair. The first element is the period of the ping sending, | |
15272 | and the second element is the timeout before considering the other side | |
15273 | down. | |
15274 | ||
15275 | @end deftypevr | |
15276 | ||
1c17a863 | 15277 | @deftypevr {@code{openvpn-server-configuration} parameter} number max-clients |
2be1b471 JL |
15278 | The maximum number of clients. |
15279 | ||
15280 | Defaults to @samp{100}. | |
15281 | ||
15282 | @end deftypevr | |
15283 | ||
1c17a863 | 15284 | @deftypevr {@code{openvpn-server-configuration} parameter} string status |
2be1b471 | 15285 | The status file. This file shows a small report on current connection. |
9fc221b5 | 15286 | It is truncated and rewritten every minute. |
2be1b471 JL |
15287 | |
15288 | Defaults to @samp{"/var/run/openvpn/status"}. | |
15289 | ||
15290 | @end deftypevr | |
15291 | ||
1c17a863 | 15292 | @deftypevr {@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir |
2be1b471 JL |
15293 | The list of configuration for some clients. |
15294 | ||
15295 | Defaults to @samp{()}. | |
15296 | ||
15297 | Available @code{openvpn-ccd-configuration} fields are: | |
15298 | ||
1c17a863 | 15299 | @deftypevr {@code{openvpn-ccd-configuration} parameter} string name |
2be1b471 JL |
15300 | Client name. |
15301 | ||
15302 | Defaults to @samp{"client"}. | |
15303 | ||
15304 | @end deftypevr | |
15305 | ||
1c17a863 | 15306 | @deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask iroute |
2be1b471 JL |
15307 | Client own network |
15308 | ||
15309 | Defaults to @samp{#f}. | |
15310 | ||
15311 | @end deftypevr | |
15312 | ||
1c17a863 | 15313 | @deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push |
2be1b471 JL |
15314 | Client VPN IP. |
15315 | ||
15316 | Defaults to @samp{#f}. | |
15317 | ||
15318 | @end deftypevr | |
15319 | ||
15320 | @end deftypevr | |
15321 | ||
15322 | ||
15323 | @c %end of automatic openvpn-server documentation | |
15324 | ||
15325 | ||
eb419bc9 JD |
15326 | @node Network File System |
15327 | @subsubsection Network File System | |
15328 | @cindex NFS | |
fe1a39d3 | 15329 | |
eb419bc9 JD |
15330 | The @code{(gnu services nfs)} module provides the following services, |
15331 | which are most commonly used in relation to mounting or exporting | |
15332 | directory trees as @dfn{network file systems} (NFS). | |
d6a07ee6 JD |
15333 | |
15334 | @subsubheading RPC Bind Service | |
15335 | @cindex rpcbind | |
15336 | ||
eb419bc9 JD |
15337 | The RPC Bind service provides a facility to map program numbers into |
15338 | universal addresses. | |
15339 | Many NFS related services use this facility. Hence it is automatically | |
15340 | started when a dependent service starts. | |
d6a07ee6 JD |
15341 | |
15342 | @defvr {Scheme Variable} rpcbind-service-type | |
15343 | A service type for the RPC portmapper daemon. | |
15344 | @end defvr | |
15345 | ||
15346 | ||
15347 | @deftp {Data Type} rpcbind-configuration | |
15348 | Data type representing the configuration of the RPC Bind Service. | |
15349 | This type has the following parameters: | |
15350 | @table @asis | |
15351 | @item @code{rpcbind} (default: @code{rpcbind}) | |
15352 | The rpcbind package to use. | |
15353 | ||
15354 | @item @code{warm-start?} (default: @code{#t}) | |
15355 | If this parameter is @code{#t}, then the daemon will read a | |
15356 | state file on startup thus reloading state information saved by a previous | |
15357 | instance. | |
15358 | @end table | |
15359 | @end deftp | |
15360 | ||
eb419bc9 JD |
15361 | |
15362 | @subsubheading Pipefs Pseudo File System | |
15363 | @cindex pipefs | |
15364 | @cindex rpc_pipefs | |
15365 | ||
15366 | The pipefs file system is used to transfer NFS related data | |
15367 | between the kernel and user space programs. | |
15368 | ||
15369 | @defvr {Scheme Variable} pipefs-service-type | |
15370 | A service type for the pipefs pseudo file system. | |
15371 | @end defvr | |
15372 | ||
15373 | @deftp {Data Type} pipefs-configuration | |
15374 | Data type representing the configuration of the pipefs pseudo file system service. | |
15375 | This type has the following parameters: | |
15376 | @table @asis | |
15377 | @item @code{mount-point} (default: @code{"/var/lib/nfs/rpc_pipefs"}) | |
15378 | The directory to which the file system is to be attached. | |
15379 | @end table | |
15380 | @end deftp | |
15381 | ||
15382 | ||
15383 | @subsubheading GSS Daemon Service | |
15384 | @cindex GSSD | |
15385 | @cindex GSS | |
15386 | @cindex global security system | |
15387 | ||
15388 | The @dfn{global security system} (GSS) daemon provides strong security for RPC | |
15389 | based protocols. | |
15390 | Before exchanging RPC requests an RPC client must establish a security | |
15391 | context. Typically this is done using the Kerberos command @command{kinit} | |
859e367d | 15392 | or automatically at login time using PAM services (@pxref{Kerberos Services}). |
eb419bc9 JD |
15393 | |
15394 | @defvr {Scheme Variable} gss-service-type | |
15395 | A service type for the Global Security System (GSS) daemon. | |
15396 | @end defvr | |
15397 | ||
15398 | @deftp {Data Type} gss-configuration | |
15399 | Data type representing the configuration of the GSS daemon service. | |
15400 | This type has the following parameters: | |
15401 | @table @asis | |
15402 | @item @code{nfs-utils} (default: @code{nfs-utils}) | |
15403 | The package in which the @command{rpc.gssd} command is to be found. | |
15404 | ||
15405 | @item @code{pipefs-directory} (default: @code{"/var/lib/nfs/rpc_pipefs"}) | |
15406 | The directory where the pipefs file system is mounted. | |
15407 | ||
15408 | @end table | |
15409 | @end deftp | |
15410 | ||
15411 | ||
15412 | @subsubheading IDMAP Daemon Service | |
15413 | @cindex idmapd | |
15414 | @cindex name mapper | |
15415 | ||
15416 | The idmap daemon service provides mapping between user IDs and user names. | |
15417 | Typically it is required in order to access file systems mounted via NFSv4. | |
15418 | ||
15419 | @defvr {Scheme Variable} idmap-service-type | |
15420 | A service type for the Identity Mapper (IDMAP) daemon. | |
15421 | @end defvr | |
15422 | ||
15423 | @deftp {Data Type} idmap-configuration | |
15424 | Data type representing the configuration of the IDMAP daemon service. | |
15425 | This type has the following parameters: | |
15426 | @table @asis | |
15427 | @item @code{nfs-utils} (default: @code{nfs-utils}) | |
15428 | The package in which the @command{rpc.idmapd} command is to be found. | |
15429 | ||
15430 | @item @code{pipefs-directory} (default: @code{"/var/lib/nfs/rpc_pipefs"}) | |
15431 | The directory where the pipefs file system is mounted. | |
15432 | ||
15433 | @item @code{domain} (default: @code{#f}) | |
15434 | The local NFSv4 domain name. | |
15435 | This must be a string or @code{#f}. | |
15436 | If it is @code{#f} then the daemon will use the host's fully qualified domain name. | |
15437 | ||
15438 | @end table | |
15439 | @end deftp | |
15440 | ||
a7cf4eb6 ML |
15441 | @node Continuous Integration |
15442 | @subsubsection Continuous Integration | |
15443 | ||
15444 | @cindex continuous integration | |
15445 | @uref{https://notabug.org/mthl/cuirass, Cuirass} is a continuous | |
15446 | integration tool for Guix. It can be used both for development and for | |
15447 | providing substitutes to others (@pxref{Substitutes}). | |
15448 | ||
15449 | The @code{(gnu services cuirass)} module provides the following service. | |
15450 | ||
231eddc8 LC |
15451 | @defvr {Scheme Procedure} cuirass-service-type |
15452 | The type of the Cuirass service. Its value must be a | |
15453 | @code{cuirass-configuration} object, as described below. | |
15454 | @end defvr | |
a7cf4eb6 | 15455 | |
231eddc8 LC |
15456 | To add build jobs, you have to set the @code{specifications} field of |
15457 | the configuration. Here is an example of a service defining a build job | |
15458 | based on a specification that can be found in Cuirass source tree. This | |
15459 | service polls the Guix repository and builds a subset of the Guix | |
15460 | packages, as prescribed in the @file{gnu-system.scm} example spec: | |
a7cf4eb6 ML |
15461 | |
15462 | @example | |
8de938d5 LC |
15463 | (let ((spec #~((#:name . "guix") |
15464 | (#:url . "git://git.savannah.gnu.org/guix.git") | |
15465 | (#:load-path . ".") | |
66bc1d2a JN |
15466 | (#:file . "build-aux/cuirass/gnu-system.scm") |
15467 | (#:proc . cuirass-jobs) | |
8de938d5 LC |
15468 | (#:arguments (subset . "hello")) |
15469 | (#:branch . "master")))) | |
231eddc8 LC |
15470 | (service cuirass-service-type |
15471 | (cuirass-configuration | |
9bb98bcf | 15472 | (specifications #~(list '#$spec))))) |
a7cf4eb6 ML |
15473 | @end example |
15474 | ||
231eddc8 | 15475 | While information related to build jobs is located directly in the |
a7cf4eb6 ML |
15476 | specifications, global settings for the @command{cuirass} process are |
15477 | accessible in other @code{cuirass-configuration} fields. | |
15478 | ||
15479 | @deftp {Data Type} cuirass-configuration | |
15480 | Data type representing the configuration of Cuirass. | |
15481 | ||
15482 | @table @asis | |
b17e326f LC |
15483 | @item @code{log-file} (default: @code{"/var/log/cuirass.log"}) |
15484 | Location of the log file. | |
15485 | ||
463995da | 15486 | @item @code{cache-directory} (default: @code{"/var/cache/cuirass"}) |
a7cf4eb6 ML |
15487 | Location of the repository cache. |
15488 | ||
15489 | @item @code{user} (default: @code{"cuirass"}) | |
15490 | Owner of the @code{cuirass} process. | |
15491 | ||
15492 | @item @code{group} (default: @code{"cuirass"}) | |
15493 | Owner's group of the @code{cuirass} process. | |
15494 | ||
15495 | @item @code{interval} (default: @code{60}) | |
15496 | Number of seconds between the poll of the repositories followed by the | |
15497 | Cuirass jobs. | |
15498 | ||
15499 | @item @code{database} (default: @code{"/var/run/cuirass/cuirass.db"}) | |
15500 | Location of sqlite database which contains the build results and previously | |
15501 | added specifications. | |
15502 | ||
1c05aab4 | 15503 | @item @code{port} (default: @code{8081}) |
11b7717d MO |
15504 | Port number used by the HTTP server. |
15505 | ||
326f6ef1 JN |
15506 | @item --listen=@var{host} |
15507 | Listen on the network interface for @var{host}. The default is to | |
15508 | accept connections from localhost. | |
15509 | ||
8de938d5 LC |
15510 | @item @code{specifications} (default: @code{#~'()}) |
15511 | A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications, | |
15512 | where a specification is an association list | |
a7cf4eb6 ML |
15513 | (@pxref{Associations Lists,,, guile, GNU Guile Reference Manual}) whose |
15514 | keys are keywords (@code{#:keyword-example}) as shown in the example | |
15515 | above. | |
15516 | ||
15517 | @item @code{use-substitutes?} (default: @code{#f}) | |
15518 | This allows using substitutes to avoid building every dependencies of a job | |
15519 | from source. | |
15520 | ||
15521 | @item @code{one-shot?} (default: @code{#f}) | |
15522 | Only evaluate specifications and build derivations once. | |
379b6ba5 | 15523 | |
c800fd56 MO |
15524 | @item @code{fallback?} (default: @code{#f}) |
15525 | When substituting a pre-built binary fails, fall back to building | |
15526 | packages locally. | |
15527 | ||
eb122280 MO |
15528 | @item @code{load-path} (default: @code{'()}) |
15529 | This allows users to define their own packages and make them visible to | |
15530 | cuirass as in @command{guix build} command. | |
15531 | ||
379b6ba5 LC |
15532 | @item @code{cuirass} (default: @code{cuirass}) |
15533 | The Cuirass package to use. | |
a7cf4eb6 ML |
15534 | @end table |
15535 | @end deftp | |
eb419bc9 | 15536 | |
bfbf6e1e MO |
15537 | @node Power management Services |
15538 | @subsubsection Power management Services | |
15539 | ||
15540 | @cindex power management with TLP | |
15541 | The @code{(gnu services pm)} module provides a Guix service definition | |
15542 | for the Linux power management tool TLP. | |
15543 | ||
15544 | TLP enables various powersaving modes in userspace and kernel. | |
15545 | Contrary to @code{upower-service}, it is not a passive, | |
15546 | monitoring tool, as it will apply custom settings each time a new power | |
15547 | source is detected. More information can be found at | |
15548 | @uref{http://linrunner.de/en/tlp/tlp.html, TLP home page}. | |
15549 | ||
15550 | @deffn {Scheme Variable} tlp-service-type | |
15551 | The service type for the TLP tool. Its value should be a valid | |
3d3c5650 LC |
15552 | TLP configuration (see below). To use the default settings, simply |
15553 | write: | |
bfbf6e1e | 15554 | @example |
3d3c5650 | 15555 | (service tlp-service-type) |
bfbf6e1e MO |
15556 | @end example |
15557 | @end deffn | |
15558 | ||
15559 | By default TLP does not need much configuration but most TLP parameters | |
15560 | can be tweaked using @code{tlp-configuration}. | |
15561 | ||
15562 | Each parameter definition is preceded by its type; for example, | |
15563 | @samp{boolean foo} indicates that the @code{foo} parameter | |
15564 | should be specified as a boolean. Types starting with | |
15565 | @code{maybe-} denote parameters that won't show up in TLP config file | |
15566 | when their value is @code{'disabled}. | |
15567 | ||
15568 | @c The following documentation was initially generated by | |
15569 | @c (generate-tlp-documentation) in (gnu services pm). Manually maintained | |
15570 | @c documentation is better, so we shouldn't hesitate to edit below as | |
15571 | @c needed. However if the change you want to make to this documentation | |
15572 | @c can be done in an automated way, it's probably easier to change | |
15573 | @c (generate-documentation) than to make it below and have to deal with | |
15574 | @c the churn as TLP updates. | |
15575 | ||
15576 | Available @code{tlp-configuration} fields are: | |
15577 | ||
15578 | @deftypevr {@code{tlp-configuration} parameter} package tlp | |
15579 | The TLP package. | |
15580 | ||
15581 | @end deftypevr | |
15582 | ||
15583 | @deftypevr {@code{tlp-configuration} parameter} boolean tlp-enable? | |
15584 | Set to true if you wish to enable TLP. | |
15585 | ||
15586 | Defaults to @samp{#t}. | |
15587 | ||
15588 | @end deftypevr | |
15589 | ||
15590 | @deftypevr {@code{tlp-configuration} parameter} string tlp-default-mode | |
15591 | Default mode when no power supply can be detected. Alternatives are AC | |
15592 | and BAT. | |
15593 | ||
15594 | Defaults to @samp{"AC"}. | |
15595 | ||
15596 | @end deftypevr | |
15597 | ||
15598 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac | |
15599 | Number of seconds Linux kernel has to wait after the disk goes idle, | |
15600 | before syncing on AC. | |
15601 | ||
15602 | Defaults to @samp{0}. | |
15603 | ||
15604 | @end deftypevr | |
15605 | ||
15606 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat | |
15607 | Same as @code{disk-idle-ac} but on BAT mode. | |
15608 | ||
15609 | Defaults to @samp{2}. | |
15610 | ||
15611 | @end deftypevr | |
15612 | ||
15613 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac | |
15614 | Dirty pages flushing periodicity, expressed in seconds. | |
15615 | ||
15616 | Defaults to @samp{15}. | |
15617 | ||
15618 | @end deftypevr | |
15619 | ||
15620 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat | |
15621 | Same as @code{max-lost-work-secs-on-ac} but on BAT mode. | |
15622 | ||
15623 | Defaults to @samp{60}. | |
15624 | ||
15625 | @end deftypevr | |
15626 | ||
15627 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac | |
15628 | CPU frequency scaling governor on AC mode. With intel_pstate driver, | |
15629 | alternatives are powersave and performance. With acpi-cpufreq driver, | |
15630 | alternatives are ondemand, powersave, performance and conservative. | |
15631 | ||
15632 | Defaults to @samp{disabled}. | |
15633 | ||
15634 | @end deftypevr | |
15635 | ||
15636 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat | |
15637 | Same as @code{cpu-scaling-governor-on-ac} but on BAT mode. | |
15638 | ||
15639 | Defaults to @samp{disabled}. | |
15640 | ||
15641 | @end deftypevr | |
15642 | ||
15643 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac | |
15644 | Set the min available frequency for the scaling governor on AC. | |
15645 | ||
15646 | Defaults to @samp{disabled}. | |
15647 | ||
15648 | @end deftypevr | |
15649 | ||
15650 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac | |
15651 | Set the max available frequency for the scaling governor on AC. | |
15652 | ||
15653 | Defaults to @samp{disabled}. | |
15654 | ||
15655 | @end deftypevr | |
15656 | ||
15657 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat | |
15658 | Set the min available frequency for the scaling governor on BAT. | |
15659 | ||
15660 | Defaults to @samp{disabled}. | |
15661 | ||
15662 | @end deftypevr | |
15663 | ||
15664 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat | |
15665 | Set the max available frequency for the scaling governor on BAT. | |
15666 | ||
15667 | Defaults to @samp{disabled}. | |
15668 | ||
15669 | @end deftypevr | |
15670 | ||
15671 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac | |
15672 | Limit the min P-state to control the power dissipation of the CPU, in AC | |
15673 | mode. Values are stated as a percentage of the available performance. | |
15674 | ||
15675 | Defaults to @samp{disabled}. | |
15676 | ||
15677 | @end deftypevr | |
15678 | ||
15679 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac | |
15680 | Limit the max P-state to control the power dissipation of the CPU, in AC | |
15681 | mode. Values are stated as a percentage of the available performance. | |
15682 | ||
15683 | Defaults to @samp{disabled}. | |
15684 | ||
15685 | @end deftypevr | |
15686 | ||
15687 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat | |
15688 | Same as @code{cpu-min-perf-on-ac} on BAT mode. | |
15689 | ||
15690 | Defaults to @samp{disabled}. | |
15691 | ||
15692 | @end deftypevr | |
15693 | ||
15694 | @deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat | |
15695 | Same as @code{cpu-max-perf-on-ac} on BAT mode. | |
15696 | ||
15697 | Defaults to @samp{disabled}. | |
15698 | ||
15699 | @end deftypevr | |
15700 | ||
15701 | @deftypevr {@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac? | |
15702 | Enable CPU turbo boost feature on AC mode. | |
15703 | ||
15704 | Defaults to @samp{disabled}. | |
15705 | ||
15706 | @end deftypevr | |
15707 | ||
15708 | @deftypevr {@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat? | |
15709 | Same as @code{cpu-boost-on-ac?} on BAT mode. | |
15710 | ||
15711 | Defaults to @samp{disabled}. | |
15712 | ||
15713 | @end deftypevr | |
15714 | ||
15715 | @deftypevr {@code{tlp-configuration} parameter} boolean sched-powersave-on-ac? | |
15716 | Allow Linux kernel to minimize the number of CPU cores/hyper-threads | |
15717 | used under light load conditions. | |
15718 | ||
15719 | Defaults to @samp{#f}. | |
15720 | ||
15721 | @end deftypevr | |
15722 | ||
15723 | @deftypevr {@code{tlp-configuration} parameter} boolean sched-powersave-on-bat? | |
15724 | Same as @code{sched-powersave-on-ac?} but on BAT mode. | |
15725 | ||
15726 | Defaults to @samp{#t}. | |
15727 | ||
15728 | @end deftypevr | |
15729 | ||
15730 | @deftypevr {@code{tlp-configuration} parameter} boolean nmi-watchdog? | |
15731 | Enable Linux kernel NMI watchdog. | |
15732 | ||
15733 | Defaults to @samp{#f}. | |
15734 | ||
15735 | @end deftypevr | |
15736 | ||
15737 | @deftypevr {@code{tlp-configuration} parameter} maybe-string phc-controls | |
15738 | For Linux kernels with PHC patch applied, change CPU voltages. An | |
15739 | example value would be @samp{"F:V F:V F:V F:V"}. | |
15740 | ||
15741 | Defaults to @samp{disabled}. | |
15742 | ||
15743 | @end deftypevr | |
15744 | ||
15745 | @deftypevr {@code{tlp-configuration} parameter} string energy-perf-policy-on-ac | |
15746 | Set CPU performance versus energy saving policy on AC. Alternatives are | |
15747 | performance, normal, powersave. | |
15748 | ||
15749 | Defaults to @samp{"performance"}. | |
15750 | ||
15751 | @end deftypevr | |
15752 | ||
15753 | @deftypevr {@code{tlp-configuration} parameter} string energy-perf-policy-on-bat | |
15754 | Same as @code{energy-perf-policy-ac} but on BAT mode. | |
15755 | ||
15756 | Defaults to @samp{"powersave"}. | |
15757 | ||
15758 | @end deftypevr | |
15759 | ||
15760 | @deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disks-devices | |
15761 | Hard disk devices. | |
15762 | ||
15763 | @end deftypevr | |
15764 | ||
15765 | @deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac | |
15766 | Hard disk advanced power management level. | |
15767 | ||
15768 | @end deftypevr | |
15769 | ||
15770 | @deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat | |
15771 | Same as @code{disk-apm-bat} but on BAT mode. | |
15772 | ||
15773 | @end deftypevr | |
15774 | ||
15775 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac | |
15776 | Hard disk spin down timeout. One value has to be specified for each | |
15777 | declared hard disk. | |
15778 | ||
15779 | Defaults to @samp{disabled}. | |
15780 | ||
15781 | @end deftypevr | |
15782 | ||
15783 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat | |
15784 | Same as @code{disk-spindown-timeout-on-ac} but on BAT mode. | |
15785 | ||
15786 | Defaults to @samp{disabled}. | |
15787 | ||
15788 | @end deftypevr | |
15789 | ||
15790 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched | |
15791 | Select IO scheduler for disk devices. One value has to be specified for | |
15792 | each declared hard disk. Example alternatives are cfq, deadline and | |
15793 | noop. | |
15794 | ||
15795 | Defaults to @samp{disabled}. | |
15796 | ||
15797 | @end deftypevr | |
15798 | ||
15799 | @deftypevr {@code{tlp-configuration} parameter} string sata-linkpwr-on-ac | |
15800 | SATA aggressive link power management (ALPM) level. Alternatives are | |
15801 | min_power, medium_power, max_performance. | |
15802 | ||
15803 | Defaults to @samp{"max_performance"}. | |
15804 | ||
15805 | @end deftypevr | |
15806 | ||
15807 | @deftypevr {@code{tlp-configuration} parameter} string sata-linkpwr-on-bat | |
15808 | Same as @code{sata-linkpwr-ac} but on BAT mode. | |
15809 | ||
15810 | Defaults to @samp{"min_power"}. | |
15811 | ||
15812 | @end deftypevr | |
15813 | ||
15814 | @deftypevr {@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist | |
15815 | Exclude specified SATA host devices for link power management. | |
15816 | ||
15817 | Defaults to @samp{disabled}. | |
15818 | ||
15819 | @end deftypevr | |
15820 | ||
15821 | @deftypevr {@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac? | |
15822 | Enable Runtime Power Management for AHCI controller and disks on AC | |
15823 | mode. | |
15824 | ||
15825 | Defaults to @samp{disabled}. | |
15826 | ||
15827 | @end deftypevr | |
15828 | ||
15829 | @deftypevr {@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat? | |
15830 | Same as @code{ahci-runtime-pm-on-ac} on BAT mode. | |
15831 | ||
15832 | Defaults to @samp{disabled}. | |
15833 | ||
15834 | @end deftypevr | |
15835 | ||
15836 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout | |
15837 | Seconds of inactivity before disk is suspended. | |
15838 | ||
15839 | Defaults to @samp{15}. | |
15840 | ||
15841 | @end deftypevr | |
15842 | ||
15843 | @deftypevr {@code{tlp-configuration} parameter} string pcie-aspm-on-ac | |
15844 | PCI Express Active State Power Management level. Alternatives are | |
15845 | default, performance, powersave. | |
15846 | ||
15847 | Defaults to @samp{"performance"}. | |
15848 | ||
15849 | @end deftypevr | |
15850 | ||
15851 | @deftypevr {@code{tlp-configuration} parameter} string pcie-aspm-on-bat | |
15852 | Same as @code{pcie-aspm-ac} but on BAT mode. | |
15853 | ||
15854 | Defaults to @samp{"powersave"}. | |
15855 | ||
15856 | @end deftypevr | |
15857 | ||
15858 | @deftypevr {@code{tlp-configuration} parameter} string radeon-power-profile-on-ac | |
15859 | Radeon graphics clock speed level. Alternatives are low, mid, high, | |
15860 | auto, default. | |
15861 | ||
15862 | Defaults to @samp{"high"}. | |
15863 | ||
15864 | @end deftypevr | |
15865 | ||
15866 | @deftypevr {@code{tlp-configuration} parameter} string radeon-power-profile-on-bat | |
15867 | Same as @code{radeon-power-ac} but on BAT mode. | |
15868 | ||
15869 | Defaults to @samp{"low"}. | |
15870 | ||
15871 | @end deftypevr | |
15872 | ||
15873 | @deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac | |
15874 | Radeon dynamic power management method (DPM). Alternatives are battery, | |
15875 | performance. | |
15876 | ||
15877 | Defaults to @samp{"performance"}. | |
15878 | ||
15879 | @end deftypevr | |
15880 | ||
15881 | @deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat | |
15882 | Same as @code{radeon-dpm-state-ac} but on BAT mode. | |
15883 | ||
15884 | Defaults to @samp{"battery"}. | |
15885 | ||
15886 | @end deftypevr | |
15887 | ||
15888 | @deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac | |
15889 | Radeon DPM performance level. Alternatives are auto, low, high. | |
15890 | ||
15891 | Defaults to @samp{"auto"}. | |
15892 | ||
15893 | @end deftypevr | |
15894 | ||
15895 | @deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat | |
15896 | Same as @code{radeon-dpm-perf-ac} but on BAT mode. | |
15897 | ||
15898 | Defaults to @samp{"auto"}. | |
15899 | ||
15900 | @end deftypevr | |
15901 | ||
15902 | @deftypevr {@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac? | |
15903 | Wifi power saving mode. | |
15904 | ||
15905 | Defaults to @samp{#f}. | |
15906 | ||
15907 | @end deftypevr | |
15908 | ||
15909 | @deftypevr {@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat? | |
15910 | Same as @code{wifi-power-ac?} but on BAT mode. | |
15911 | ||
15912 | Defaults to @samp{#t}. | |
15913 | ||
15914 | @end deftypevr | |
15915 | ||
15916 | @deftypevr {@code{tlp-configuration} parameter} y-n-boolean wol-disable? | |
15917 | Disable wake on LAN. | |
15918 | ||
15919 | Defaults to @samp{#t}. | |
15920 | ||
15921 | @end deftypevr | |
15922 | ||
15923 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac | |
15924 | Timeout duration in seconds before activating audio power saving on | |
15925 | Intel HDA and AC97 devices. A value of 0 disables power saving. | |
15926 | ||
15927 | Defaults to @samp{0}. | |
15928 | ||
15929 | @end deftypevr | |
15930 | ||
15931 | @deftypevr {@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat | |
15932 | Same as @code{sound-powersave-ac} but on BAT mode. | |
15933 | ||
15934 | Defaults to @samp{1}. | |
15935 | ||
15936 | @end deftypevr | |
15937 | ||
15938 | @deftypevr {@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller? | |
15939 | Disable controller in powersaving mode on Intel HDA devices. | |
15940 | ||
15941 | Defaults to @samp{#t}. | |
15942 | ||
15943 | @end deftypevr | |
15944 | ||
15945 | @deftypevr {@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat? | |
15946 | Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be | |
15947 | powered on again by releasing (and reinserting) the eject lever or by | |
15948 | pressing the disc eject button on newer models. | |
15949 | ||
15950 | Defaults to @samp{#f}. | |
15951 | ||
15952 | @end deftypevr | |
15953 | ||
15954 | @deftypevr {@code{tlp-configuration} parameter} string bay-device | |
15955 | Name of the optical drive device to power off. | |
15956 | ||
15957 | Defaults to @samp{"sr0"}. | |
15958 | ||
15959 | @end deftypevr | |
15960 | ||
15961 | @deftypevr {@code{tlp-configuration} parameter} string runtime-pm-on-ac | |
15962 | Runtime Power Management for PCI(e) bus devices. Alternatives are on | |
15963 | and auto. | |
15964 | ||
15965 | Defaults to @samp{"on"}. | |
15966 | ||
15967 | @end deftypevr | |
15968 | ||
15969 | @deftypevr {@code{tlp-configuration} parameter} string runtime-pm-on-bat | |
15970 | Same as @code{runtime-pm-ac} but on BAT mode. | |
15971 | ||
15972 | Defaults to @samp{"auto"}. | |
15973 | ||
15974 | @end deftypevr | |
15975 | ||
15976 | @deftypevr {@code{tlp-configuration} parameter} boolean runtime-pm-all? | |
15977 | Runtime Power Management for all PCI(e) bus devices, except blacklisted | |
15978 | ones. | |
15979 | ||
15980 | Defaults to @samp{#t}. | |
15981 | ||
15982 | @end deftypevr | |
15983 | ||
15984 | @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist | |
9fc221b5 | 15985 | Exclude specified PCI(e) device addresses from Runtime Power Management. |
bfbf6e1e MO |
15986 | |
15987 | Defaults to @samp{disabled}. | |
15988 | ||
15989 | @end deftypevr | |
15990 | ||
15991 | @deftypevr {@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist | |
15992 | Exclude PCI(e) devices assigned to the specified drivers from Runtime | |
15993 | Power Management. | |
15994 | ||
15995 | @end deftypevr | |
15996 | ||
15997 | @deftypevr {@code{tlp-configuration} parameter} boolean usb-autosuspend? | |
15998 | Enable USB autosuspend feature. | |
15999 | ||
16000 | Defaults to @samp{#t}. | |
16001 | ||
16002 | @end deftypevr | |
16003 | ||
16004 | @deftypevr {@code{tlp-configuration} parameter} maybe-string usb-blacklist | |
16005 | Exclude specified devices from USB autosuspend. | |
16006 | ||
16007 | Defaults to @samp{disabled}. | |
16008 | ||
16009 | @end deftypevr | |
16010 | ||
16011 | @deftypevr {@code{tlp-configuration} parameter} boolean usb-blacklist-wwan? | |
16012 | Exclude WWAN devices from USB autosuspend. | |
16013 | ||
16014 | Defaults to @samp{#t}. | |
16015 | ||
16016 | @end deftypevr | |
16017 | ||
16018 | @deftypevr {@code{tlp-configuration} parameter} maybe-string usb-whitelist | |
16019 | Include specified devices into USB autosuspend, even if they are already | |
16020 | excluded by the driver or via @code{usb-blacklist-wwan?}. | |
16021 | ||
16022 | Defaults to @samp{disabled}. | |
16023 | ||
16024 | @end deftypevr | |
16025 | ||
16026 | @deftypevr {@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown? | |
16027 | Enable USB autosuspend before shutdown. | |
16028 | ||
16029 | Defaults to @samp{disabled}. | |
16030 | ||
16031 | @end deftypevr | |
16032 | ||
16033 | @deftypevr {@code{tlp-configuration} parameter} boolean restore-device-state-on-startup? | |
16034 | Restore radio device state (bluetooth, wifi, wwan) from previous | |
16035 | shutdown on system startup. | |
16036 | ||
16037 | Defaults to @samp{#f}. | |
16038 | ||
16039 | @end deftypevr | |
16040 | ||
d7fa39cc CAW |
16041 | |
16042 | The @code{(gnu services pm)} module provides an interface to | |
16043 | thermald, a CPU frequency scaling service which helps prevent overheating. | |
16044 | ||
16045 | @defvr {Scheme Variable} thermald-service-type | |
16046 | This is the service type for | |
16047 | @uref{https://01.org/linux-thermal-daemon/, thermald}, the Linux | |
16048 | Thermal Daemon, which is responsible for controlling the thermal state | |
16049 | of processors and preventing overheating. | |
16050 | @end defvr | |
16051 | ||
16052 | @deftp {Data Type} thermald-configuration | |
16053 | Data type representing the configuration of @code{thermald-service-type}. | |
16054 | ||
16055 | @table @asis | |
16056 | @item @code{ignore-cpuid-check?} (default: @code{#f}) | |
16057 | Ignore cpuid check for supported CPU models. | |
16058 | ||
16059 | @item @code{thermald} (default: @var{thermald}) | |
16060 | Package object of thermald. | |
16061 | ||
16062 | @end table | |
16063 | @end deftp | |
16064 | ||
06465d2b PM |
16065 | @node Audio Services |
16066 | @subsubsection Audio Services | |
16067 | ||
16068 | The @code{(gnu services audio)} module provides a service to start MPD | |
16069 | (the Music Player Daemon). | |
16070 | ||
16071 | @cindex mpd | |
16072 | @subsubheading Music Player Daemon | |
16073 | ||
16074 | The Music Player Daemon (MPD) is a service that can play music while | |
16075 | being controlled from the local machine or over the network by a variety | |
16076 | of clients. | |
16077 | ||
16078 | The following example shows how one might run @code{mpd} as user | |
16079 | @code{"bob"} on port @code{6666}. It uses pulseaudio for output. | |
16080 | ||
16081 | @example | |
16082 | (service mpd-service-type | |
16083 | (mpd-configuration | |
16084 | (user "bob") | |
16085 | (port "6666"))) | |
16086 | @end example | |
16087 | ||
16088 | @defvr {Scheme Variable} mpd-service-type | |
16089 | The service type for @command{mpd} | |
16090 | @end defvr | |
16091 | ||
16092 | @deftp {Data Type} mpd-configuration | |
16093 | Data type representing the configuration of @command{mpd}. | |
16094 | ||
16095 | @table @asis | |
16096 | @item @code{user} (default: @code{"mpd"}) | |
16097 | The user to run mpd as. | |
16098 | ||
16099 | @item @code{music-dir} (default: @code{"~/Music"}) | |
16100 | The directory to scan for music files. | |
16101 | ||
16102 | @item @code{playlist-dir} (default: @code{"~/.mpd/playlists"}) | |
16103 | The directory to store playlists. | |
16104 | ||
06465d2b PM |
16105 | @item @code{port} (default: @code{"6600"}) |
16106 | The port to run mpd on. | |
16107 | ||
16108 | @item @code{address} (default: @code{"any"}) | |
16109 | The address that mpd will bind to. To use a Unix domain socket, | |
16110 | an absolute path can be specified here. | |
16111 | ||
16112 | @end table | |
16113 | @end deftp | |
d7fa39cc | 16114 | |
e6051057 RM |
16115 | @node Virtualization Services |
16116 | @subsubsection Virtualization services | |
16117 | The @code{(gnu services virtualization)} module provides services for | |
16118 | the libvirt and virtlog daemons. | |
16119 | ||
16120 | @subsubheading Libvirt daemon | |
16121 | @code{libvirtd} is the server side daemon component of the libvirt | |
16122 | virtualization management system. This daemon runs on host servers | |
16123 | and performs required management tasks for virtualized guests. | |
16124 | ||
16125 | @deffn {Scheme Variable} libvirt-service-type | |
16126 | This is the type of the @uref{https://libvirt.org, libvirt daemon}. | |
16127 | Its value must be a @code{libvirt-configuration}. | |
16128 | ||
16129 | @example | |
16130 | (service libvirt-service-type | |
16131 | (libvirt-configuration | |
16132 | (unix-sock-group "libvirt") | |
16133 | (tls-port "16555"))) | |
16134 | @end example | |
16135 | @end deffn | |
16136 | ||
16137 | @c Auto-generated with (generate-libvirt-documentation) | |
16138 | Available @code{libvirt-configuration} fields are: | |
16139 | ||
16140 | @deftypevr {@code{libvirt-configuration} parameter} package libvirt | |
16141 | Libvirt package. | |
16142 | ||
16143 | @end deftypevr | |
16144 | ||
16145 | @deftypevr {@code{libvirt-configuration} parameter} boolean listen-tls? | |
16146 | Flag listening for secure TLS connections on the public TCP/IP port. | |
16147 | must set @code{listen} for this to have any effect. | |
16148 | ||
16149 | It is necessary to setup a CA and issue server certificates before using | |
16150 | this capability. | |
16151 | ||
16152 | Defaults to @samp{#t}. | |
16153 | ||
16154 | @end deftypevr | |
16155 | ||
16156 | @deftypevr {@code{libvirt-configuration} parameter} boolean listen-tcp? | |
16157 | Listen for unencrypted TCP connections on the public TCP/IP port. must | |
16158 | set @code{listen} for this to have any effect. | |
16159 | ||
16160 | Using the TCP socket requires SASL authentication by default. Only SASL | |
16161 | mechanisms which support data encryption are allowed. This is | |
16162 | DIGEST_MD5 and GSSAPI (Kerberos5) | |
16163 | ||
16164 | Defaults to @samp{#f}. | |
16165 | ||
16166 | @end deftypevr | |
16167 | ||
16168 | @deftypevr {@code{libvirt-configuration} parameter} string tls-port | |
16169 | Port for accepting secure TLS connections This can be a port number, or | |
16170 | service name | |
16171 | ||
16172 | Defaults to @samp{"16514"}. | |
16173 | ||
16174 | @end deftypevr | |
16175 | ||
16176 | @deftypevr {@code{libvirt-configuration} parameter} string tcp-port | |
16177 | Port for accepting insecure TCP connections This can be a port number, | |
16178 | or service name | |
16179 | ||
16180 | Defaults to @samp{"16509"}. | |
16181 | ||
16182 | @end deftypevr | |
16183 | ||
16184 | @deftypevr {@code{libvirt-configuration} parameter} string listen-addr | |
16185 | IP address or hostname used for client connections. | |
16186 | ||
16187 | Defaults to @samp{"0.0.0.0"}. | |
16188 | ||
16189 | @end deftypevr | |
16190 | ||
16191 | @deftypevr {@code{libvirt-configuration} parameter} boolean mdns-adv? | |
16192 | Flag toggling mDNS advertisement of the libvirt service. | |
16193 | ||
16194 | Alternatively can disable for all services on a host by stopping the | |
16195 | Avahi daemon. | |
16196 | ||
16197 | Defaults to @samp{#f}. | |
16198 | ||
16199 | @end deftypevr | |
16200 | ||
16201 | @deftypevr {@code{libvirt-configuration} parameter} string mdns-name | |
16202 | Default mDNS advertisement name. This must be unique on the immediate | |
16203 | broadcast network. | |
16204 | ||
16205 | Defaults to @samp{"Virtualization Host <hostname>"}. | |
16206 | ||
16207 | @end deftypevr | |
16208 | ||
16209 | @deftypevr {@code{libvirt-configuration} parameter} string unix-sock-group | |
16210 | UNIX domain socket group ownership. This can be used to allow a | |
16211 | 'trusted' set of users access to management capabilities without | |
16212 | becoming root. | |
16213 | ||
16214 | Defaults to @samp{"root"}. | |
16215 | ||
16216 | @end deftypevr | |
16217 | ||
16218 | @deftypevr {@code{libvirt-configuration} parameter} string unix-sock-ro-perms | |
16219 | UNIX socket permissions for the R/O socket. This is used for monitoring | |
16220 | VM status only. | |
16221 | ||
16222 | Defaults to @samp{"0777"}. | |
16223 | ||
16224 | @end deftypevr | |
16225 | ||
16226 | @deftypevr {@code{libvirt-configuration} parameter} string unix-sock-rw-perms | |
16227 | UNIX socket permissions for the R/W socket. Default allows only root. | |
16228 | If PolicyKit is enabled on the socket, the default will change to allow | |
16229 | everyone (eg, 0777) | |
16230 | ||
16231 | Defaults to @samp{"0770"}. | |
16232 | ||
16233 | @end deftypevr | |
16234 | ||
16235 | @deftypevr {@code{libvirt-configuration} parameter} string unix-sock-admin-perms | |
16236 | UNIX socket permissions for the admin socket. Default allows only owner | |
16237 | (root), do not change it unless you are sure to whom you are exposing | |
16238 | the access to. | |
16239 | ||
16240 | Defaults to @samp{"0777"}. | |
16241 | ||
16242 | @end deftypevr | |
16243 | ||
16244 | @deftypevr {@code{libvirt-configuration} parameter} string unix-sock-dir | |
16245 | The directory in which sockets will be found/created. | |
16246 | ||
16247 | Defaults to @samp{"/var/run/libvirt"}. | |
16248 | ||
16249 | @end deftypevr | |
16250 | ||
16251 | @deftypevr {@code{libvirt-configuration} parameter} string auth-unix-ro | |
16252 | Authentication scheme for UNIX read-only sockets. By default socket | |
16253 | permissions allow anyone to connect | |
16254 | ||
16255 | Defaults to @samp{"polkit"}. | |
16256 | ||
16257 | @end deftypevr | |
16258 | ||
16259 | @deftypevr {@code{libvirt-configuration} parameter} string auth-unix-rw | |
16260 | Authentication scheme for UNIX read-write sockets. By default socket | |
16261 | permissions only allow root. If PolicyKit support was compiled into | |
16262 | libvirt, the default will be to use 'polkit' auth. | |
16263 | ||
16264 | Defaults to @samp{"polkit"}. | |
16265 | ||
16266 | @end deftypevr | |
16267 | ||
16268 | @deftypevr {@code{libvirt-configuration} parameter} string auth-tcp | |
16269 | Authentication scheme for TCP sockets. If you don't enable SASL, then | |
16270 | all TCP traffic is cleartext. Don't do this outside of a dev/test | |
16271 | scenario. | |
16272 | ||
16273 | Defaults to @samp{"sasl"}. | |
16274 | ||
16275 | @end deftypevr | |
16276 | ||
16277 | @deftypevr {@code{libvirt-configuration} parameter} string auth-tls | |
16278 | Authentication scheme for TLS sockets. TLS sockets already have | |
16279 | encryption provided by the TLS layer, and limited authentication is done | |
16280 | by certificates. | |
16281 | ||
16282 | It is possible to make use of any SASL authentication mechanism as well, | |
16283 | by using 'sasl' for this option | |
16284 | ||
16285 | Defaults to @samp{"none"}. | |
16286 | ||
16287 | @end deftypevr | |
16288 | ||
16289 | @deftypevr {@code{libvirt-configuration} parameter} optional-list access-drivers | |
16290 | API access control scheme. | |
16291 | ||
16292 | By default an authenticated user is allowed access to all APIs. Access | |
16293 | drivers can place restrictions on this. | |
16294 | ||
16295 | Defaults to @samp{()}. | |
16296 | ||
16297 | @end deftypevr | |
16298 | ||
16299 | @deftypevr {@code{libvirt-configuration} parameter} string key-file | |
16300 | Server key file path. If set to an empty string, then no private key is | |
16301 | loaded. | |
16302 | ||
16303 | Defaults to @samp{""}. | |
16304 | ||
16305 | @end deftypevr | |
16306 | ||
16307 | @deftypevr {@code{libvirt-configuration} parameter} string cert-file | |
16308 | Server key file path. If set to an empty string, then no certificate is | |
16309 | loaded. | |
16310 | ||
16311 | Defaults to @samp{""}. | |
16312 | ||
16313 | @end deftypevr | |
16314 | ||
16315 | @deftypevr {@code{libvirt-configuration} parameter} string ca-file | |
16316 | Server key file path. If set to an empty string, then no CA certificate | |
16317 | is loaded. | |
16318 | ||
16319 | Defaults to @samp{""}. | |
16320 | ||
16321 | @end deftypevr | |
16322 | ||
16323 | @deftypevr {@code{libvirt-configuration} parameter} string crl-file | |
16324 | Certificate revocation list path. If set to an empty string, then no | |
16325 | CRL is loaded. | |
16326 | ||
16327 | Defaults to @samp{""}. | |
16328 | ||
16329 | @end deftypevr | |
16330 | ||
16331 | @deftypevr {@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert | |
16332 | Disable verification of our own server certificates. | |
16333 | ||
16334 | When libvirtd starts it performs some sanity checks against its own | |
16335 | certificates. | |
16336 | ||
16337 | Defaults to @samp{#f}. | |
16338 | ||
16339 | @end deftypevr | |
16340 | ||
16341 | @deftypevr {@code{libvirt-configuration} parameter} boolean tls-no-verify-cert | |
16342 | Disable verification of client certificates. | |
16343 | ||
16344 | Client certificate verification is the primary authentication mechanism. | |
16345 | Any client which does not present a certificate signed by the CA will be | |
16346 | rejected. | |
16347 | ||
16348 | Defaults to @samp{#f}. | |
16349 | ||
16350 | @end deftypevr | |
16351 | ||
16352 | @deftypevr {@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list | |
16353 | Whitelist of allowed x509 Distinguished Name. | |
16354 | ||
16355 | Defaults to @samp{()}. | |
16356 | ||
16357 | @end deftypevr | |
16358 | ||
16359 | @deftypevr {@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames | |
16360 | Whitelist of allowed SASL usernames. The format for username depends on | |
16361 | the SASL authentication mechanism. | |
16362 | ||
16363 | Defaults to @samp{()}. | |
16364 | ||
16365 | @end deftypevr | |
16366 | ||
16367 | @deftypevr {@code{libvirt-configuration} parameter} string tls-priority | |
16368 | Override the compile time default TLS priority string. The default is | |
16369 | usually "NORMAL" unless overridden at build time. Only set this is it | |
16370 | is desired for libvirt to deviate from the global default settings. | |
16371 | ||
16372 | Defaults to @samp{"NORMAL"}. | |
16373 | ||
16374 | @end deftypevr | |
16375 | ||
16376 | @deftypevr {@code{libvirt-configuration} parameter} integer max-clients | |
16377 | Maximum number of concurrent client connections to allow over all | |
16378 | sockets combined. | |
16379 | ||
16380 | Defaults to @samp{5000}. | |
16381 | ||
16382 | @end deftypevr | |
16383 | ||
16384 | @deftypevr {@code{libvirt-configuration} parameter} integer max-queued-clients | |
16385 | Maximum length of queue of connections waiting to be accepted by the | |
16386 | daemon. Note, that some protocols supporting retransmission may obey | |
16387 | this so that a later reattempt at connection succeeds. | |
16388 | ||
16389 | Defaults to @samp{1000}. | |
16390 | ||
16391 | @end deftypevr | |
16392 | ||
16393 | @deftypevr {@code{libvirt-configuration} parameter} integer max-anonymous-clients | |
16394 | Maximum length of queue of accepted but not yet authenticated clients. | |
16395 | Set this to zero to turn this feature off | |
16396 | ||
16397 | Defaults to @samp{20}. | |
16398 | ||
16399 | @end deftypevr | |
16400 | ||
16401 | @deftypevr {@code{libvirt-configuration} parameter} integer min-workers | |
16402 | Number of workers to start up initially. | |
16403 | ||
16404 | Defaults to @samp{5}. | |
16405 | ||
16406 | @end deftypevr | |
16407 | ||
16408 | @deftypevr {@code{libvirt-configuration} parameter} integer max-workers | |
16409 | Maximum number of worker threads. | |
16410 | ||
16411 | If the number of active clients exceeds @code{min-workers}, then more | |
16412 | threads are spawned, up to max_workers limit. Typically you'd want | |
16413 | max_workers to equal maximum number of clients allowed. | |
16414 | ||
16415 | Defaults to @samp{20}. | |
16416 | ||
16417 | @end deftypevr | |
16418 | ||
16419 | @deftypevr {@code{libvirt-configuration} parameter} integer prio-workers | |
16420 | Number of priority workers. If all workers from above pool are stuck, | |
16421 | some calls marked as high priority (notably domainDestroy) can be | |
16422 | executed in this pool. | |
16423 | ||
16424 | Defaults to @samp{5}. | |
16425 | ||
16426 | @end deftypevr | |
16427 | ||
16428 | @deftypevr {@code{libvirt-configuration} parameter} integer max-requests | |
16429 | Total global limit on concurrent RPC calls. | |
16430 | ||
16431 | Defaults to @samp{20}. | |
16432 | ||
16433 | @end deftypevr | |
16434 | ||
16435 | @deftypevr {@code{libvirt-configuration} parameter} integer max-client-requests | |
16436 | Limit on concurrent requests from a single client connection. To avoid | |
16437 | one client monopolizing the server this should be a small fraction of | |
16438 | the global max_requests and max_workers parameter. | |
16439 | ||
16440 | Defaults to @samp{5}. | |
16441 | ||
16442 | @end deftypevr | |
16443 | ||
16444 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-min-workers | |
16445 | Same as @code{min-workers} but for the admin interface. | |
16446 | ||
16447 | Defaults to @samp{1}. | |
16448 | ||
16449 | @end deftypevr | |
16450 | ||
16451 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-max-workers | |
16452 | Same as @code{max-workers} but for the admin interface. | |
16453 | ||
16454 | Defaults to @samp{5}. | |
16455 | ||
16456 | @end deftypevr | |
16457 | ||
16458 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-max-clients | |
16459 | Same as @code{max-clients} but for the admin interface. | |
16460 | ||
16461 | Defaults to @samp{5}. | |
16462 | ||
16463 | @end deftypevr | |
16464 | ||
16465 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-max-queued-clients | |
16466 | Same as @code{max-queued-clients} but for the admin interface. | |
16467 | ||
16468 | Defaults to @samp{5}. | |
16469 | ||
16470 | @end deftypevr | |
16471 | ||
16472 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-max-client-requests | |
16473 | Same as @code{max-client-requests} but for the admin interface. | |
16474 | ||
16475 | Defaults to @samp{5}. | |
16476 | ||
16477 | @end deftypevr | |
16478 | ||
16479 | @deftypevr {@code{libvirt-configuration} parameter} integer log-level | |
16480 | Logging level. 4 errors, 3 warnings, 2 information, 1 debug. | |
16481 | ||
16482 | Defaults to @samp{3}. | |
16483 | ||
16484 | @end deftypevr | |
16485 | ||
16486 | @deftypevr {@code{libvirt-configuration} parameter} string log-filters | |
16487 | Logging filters. | |
16488 | ||
16489 | A filter allows to select a different logging level for a given category | |
16490 | of logs The format for a filter is one of: | |
16491 | ||
16492 | @itemize @bullet | |
16493 | @item | |
16494 | x:name | |
16495 | ||
16496 | @item | |
16497 | x:+name | |
16498 | ||
16499 | @end itemize | |
16500 | ||
16501 | where @code{name} is a string which is matched against the category | |
16502 | given in the @code{VIR_LOG_INIT()} at the top of each libvirt source | |
16503 | file, e.g., "remote", "qemu", or "util.json" (the name in the filter can | |
16504 | be a substring of the full category name, in order to match multiple | |
16505 | similar categories), the optional "+" prefix tells libvirt to log stack | |
16506 | trace for each message matching name, and @code{x} is the minimal level | |
16507 | where matching messages should be logged: | |
16508 | ||
16509 | @itemize @bullet | |
16510 | @item | |
16511 | 1: DEBUG | |
16512 | ||
16513 | @item | |
16514 | 2: INFO | |
16515 | ||
16516 | @item | |
16517 | 3: WARNING | |
16518 | ||
16519 | @item | |
16520 | 4: ERROR | |
16521 | ||
16522 | @end itemize | |
16523 | ||
16524 | Multiple filters can be defined in a single filters statement, they just | |
16525 | need to be separated by spaces. | |
16526 | ||
16527 | Defaults to @samp{"3:remote 4:event"}. | |
16528 | ||
16529 | @end deftypevr | |
16530 | ||
16531 | @deftypevr {@code{libvirt-configuration} parameter} string log-outputs | |
16532 | Logging outputs. | |
16533 | ||
16534 | An output is one of the places to save logging information The format | |
16535 | for an output can be: | |
16536 | ||
16537 | @table @code | |
16538 | @item x:stderr | |
16539 | output goes to stderr | |
16540 | ||
16541 | @item x:syslog:name | |
16542 | use syslog for the output and use the given name as the ident | |
16543 | ||
16544 | @item x:file:file_path | |
16545 | output to a file, with the given filepath | |
16546 | ||
16547 | @item x:journald | |
16548 | output to journald logging system | |
16549 | ||
16550 | @end table | |
16551 | ||
16552 | In all case the x prefix is the minimal level, acting as a filter | |
16553 | ||
16554 | @itemize @bullet | |
16555 | @item | |
16556 | 1: DEBUG | |
16557 | ||
16558 | @item | |
16559 | 2: INFO | |
16560 | ||
16561 | @item | |
16562 | 3: WARNING | |
16563 | ||
16564 | @item | |
16565 | 4: ERROR | |
16566 | ||
16567 | @end itemize | |
16568 | ||
16569 | Multiple outputs can be defined, they just need to be separated by | |
16570 | spaces. | |
16571 | ||
16572 | Defaults to @samp{"3:stderr"}. | |
16573 | ||
16574 | @end deftypevr | |
16575 | ||
16576 | @deftypevr {@code{libvirt-configuration} parameter} integer audit-level | |
16577 | Allows usage of the auditing subsystem to be altered | |
16578 | ||
16579 | @itemize @bullet | |
16580 | @item | |
16581 | 0: disable all auditing | |
16582 | ||
16583 | @item | |
16584 | 1: enable auditing, only if enabled on host | |
16585 | ||
16586 | @item | |
16587 | 2: enable auditing, and exit if disabled on host. | |
16588 | ||
16589 | @end itemize | |
16590 | ||
16591 | Defaults to @samp{1}. | |
16592 | ||
16593 | @end deftypevr | |
16594 | ||
16595 | @deftypevr {@code{libvirt-configuration} parameter} boolean audit-logging | |
16596 | Send audit messages via libvirt logging infrastructure. | |
16597 | ||
16598 | Defaults to @samp{#f}. | |
16599 | ||
16600 | @end deftypevr | |
16601 | ||
16602 | @deftypevr {@code{libvirt-configuration} parameter} optional-string host-uuid | |
16603 | Host UUID. UUID must not have all digits be the same. | |
16604 | ||
16605 | Defaults to @samp{""}. | |
16606 | ||
16607 | @end deftypevr | |
16608 | ||
16609 | @deftypevr {@code{libvirt-configuration} parameter} string host-uuid-source | |
16610 | Source to read host UUID. | |
16611 | ||
16612 | @itemize @bullet | |
16613 | @item | |
16614 | @code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid} | |
16615 | ||
16616 | @item | |
16617 | @code{machine-id}: fetch the UUID from @code{/etc/machine-id} | |
16618 | ||
16619 | @end itemize | |
16620 | ||
16621 | If @code{dmidecode} does not provide a valid UUID a temporary UUID will | |
16622 | be generated. | |
16623 | ||
16624 | Defaults to @samp{"smbios"}. | |
16625 | ||
16626 | @end deftypevr | |
16627 | ||
16628 | @deftypevr {@code{libvirt-configuration} parameter} integer keepalive-interval | |
16629 | A keepalive message is sent to a client after @code{keepalive_interval} | |
16630 | seconds of inactivity to check if the client is still responding. If | |
16631 | set to -1, libvirtd will never send keepalive requests; however clients | |
16632 | can still send them and the daemon will send responses. | |
16633 | ||
16634 | Defaults to @samp{5}. | |
16635 | ||
16636 | @end deftypevr | |
16637 | ||
16638 | @deftypevr {@code{libvirt-configuration} parameter} integer keepalive-count | |
16639 | Maximum number of keepalive messages that are allowed to be sent to the | |
16640 | client without getting any response before the connection is considered | |
16641 | broken. | |
16642 | ||
16643 | In other words, the connection is automatically closed approximately | |
16644 | after @code{keepalive_interval * (keepalive_count + 1)} seconds since | |
16645 | the last message received from the client. When @code{keepalive-count} | |
16646 | is set to 0, connections will be automatically closed after | |
16647 | @code{keepalive-interval} seconds of inactivity without sending any | |
16648 | keepalive messages. | |
16649 | ||
16650 | Defaults to @samp{5}. | |
16651 | ||
16652 | @end deftypevr | |
16653 | ||
16654 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-keepalive-interval | |
16655 | Same as above but for admin interface. | |
16656 | ||
16657 | Defaults to @samp{5}. | |
16658 | ||
16659 | @end deftypevr | |
16660 | ||
16661 | @deftypevr {@code{libvirt-configuration} parameter} integer admin-keepalive-count | |
16662 | Same as above but for admin interface. | |
16663 | ||
16664 | Defaults to @samp{5}. | |
16665 | ||
16666 | @end deftypevr | |
16667 | ||
16668 | @deftypevr {@code{libvirt-configuration} parameter} integer ovs-timeout | |
16669 | Timeout for Open vSwitch calls. | |
16670 | ||
16671 | The @code{ovs-vsctl} utility is used for the configuration and its | |
16672 | timeout option is set by default to 5 seconds to avoid potential | |
16673 | infinite waits blocking libvirt. | |
16674 | ||
16675 | Defaults to @samp{5}. | |
16676 | ||
16677 | @end deftypevr | |
16678 | ||
16679 | @c %end of autogenerated docs | |
16680 | ||
16681 | @subsubheading Virtlog daemon | |
16682 | The virtlogd service is a server side daemon component of libvirt that is | |
16683 | used to manage logs from virtual machine consoles. | |
16684 | ||
16685 | This daemon is not used directly by libvirt client applications, rather it | |
16686 | is called on their behalf by @code{libvirtd}. By maintaining the logs in a | |
16687 | standalone daemon, the main @code{libvirtd} daemon can be restarted without | |
16688 | risk of losing logs. The @code{virtlogd} daemon has the ability to re-exec() | |
16689 | itself upon receiving @code{SIGUSR1}, to allow live upgrades without downtime. | |
16690 | ||
16691 | @deffn {Scheme Variable} virtlog-service-type | |
16692 | This is the type of the virtlog daemon. | |
16693 | Its value must be a @code{virtlog-configuration}. | |
16694 | ||
16695 | @example | |
16696 | (service virtlog-service-type | |
16697 | (virtlog-configuration | |
16698 | (max-clients 1000))) | |
16699 | @end example | |
16700 | @end deffn | |
16701 | ||
16702 | @deftypevr {@code{virtlog-configuration} parameter} integer log-level | |
16703 | Logging level. 4 errors, 3 warnings, 2 information, 1 debug. | |
16704 | ||
16705 | Defaults to @samp{3}. | |
16706 | ||
16707 | @end deftypevr | |
16708 | ||
16709 | @deftypevr {@code{virtlog-configuration} parameter} string log-filters | |
16710 | Logging filters. | |
16711 | ||
16712 | A filter allows to select a different logging level for a given category | |
16713 | of logs The format for a filter is one of: | |
16714 | ||
16715 | @itemize @bullet | |
16716 | @item | |
16717 | x:name | |
16718 | ||
16719 | @item | |
16720 | x:+name | |
16721 | ||
16722 | @end itemize | |
16723 | ||
16724 | where @code{name} is a string which is matched against the category | |
16725 | given in the @code{VIR_LOG_INIT()} at the top of each libvirt source | |
16726 | file, e.g., "remote", "qemu", or "util.json" (the name in the filter can | |
16727 | be a substring of the full category name, in order to match multiple | |
16728 | similar categories), the optional "+" prefix tells libvirt to log stack | |
16729 | trace for each message matching name, and @code{x} is the minimal level | |
16730 | where matching messages should be logged: | |
16731 | ||
16732 | @itemize @bullet | |
16733 | @item | |
16734 | 1: DEBUG | |
16735 | ||
16736 | @item | |
16737 | 2: INFO | |
16738 | ||
16739 | @item | |
16740 | 3: WARNING | |
16741 | ||
16742 | @item | |
16743 | 4: ERROR | |
16744 | ||
16745 | @end itemize | |
16746 | ||
16747 | Multiple filters can be defined in a single filters statement, they just | |
16748 | need to be separated by spaces. | |
16749 | ||
16750 | Defaults to @samp{"3:remote 4:event"}. | |
16751 | ||
16752 | @end deftypevr | |
16753 | ||
16754 | @deftypevr {@code{virtlog-configuration} parameter} string log-outputs | |
16755 | Logging outputs. | |
16756 | ||
16757 | An output is one of the places to save logging information The format | |
16758 | for an output can be: | |
16759 | ||
16760 | @table @code | |
16761 | @item x:stderr | |
16762 | output goes to stderr | |
16763 | ||
16764 | @item x:syslog:name | |
16765 | use syslog for the output and use the given name as the ident | |
16766 | ||
16767 | @item x:file:file_path | |
16768 | output to a file, with the given filepath | |
16769 | ||
16770 | @item x:journald | |
16771 | output to journald logging system | |
16772 | ||
16773 | @end table | |
16774 | ||
16775 | In all case the x prefix is the minimal level, acting as a filter | |
16776 | ||
16777 | @itemize @bullet | |
16778 | @item | |
16779 | 1: DEBUG | |
16780 | ||
16781 | @item | |
16782 | 2: INFO | |
16783 | ||
16784 | @item | |
16785 | 3: WARNING | |
16786 | ||
16787 | @item | |
16788 | 4: ERROR | |
16789 | ||
16790 | @end itemize | |
16791 | ||
16792 | Multiple outputs can be defined, they just need to be separated by | |
16793 | spaces. | |
16794 | ||
16795 | Defaults to @samp{"3:stderr"}. | |
16796 | ||
16797 | @end deftypevr | |
16798 | ||
16799 | @deftypevr {@code{virtlog-configuration} parameter} integer max-clients | |
16800 | Maximum number of concurrent client connections to allow over all | |
16801 | sockets combined. | |
16802 | ||
16803 | Defaults to @samp{1024}. | |
16804 | ||
16805 | @end deftypevr | |
16806 | ||
16807 | @deftypevr {@code{virtlog-configuration} parameter} integer max-size | |
16808 | Maximum file size before rolling over. | |
16809 | ||
16810 | Defaults to @samp{2MB} | |
16811 | ||
16812 | @end deftypevr | |
16813 | ||
16814 | @deftypevr {@code{virtlog-configuration} parameter} integer max-backups | |
16815 | Maximum number of backup files to keep. | |
16816 | ||
16817 | Defaults to @samp{3} | |
16818 | ||
16819 | @end deftypevr | |
16820 | ||
16821 | ||
eb419bc9 JD |
16822 | @node Miscellaneous Services |
16823 | @subsubsection Miscellaneous Services | |
16824 | ||
296bf4d5 SB |
16825 | @cindex sysctl |
16826 | @subsubheading System Control Service | |
16827 | ||
16828 | The @code{(gnu services sysctl)} provides a service to configure kernel | |
16829 | parameters at boot. | |
16830 | ||
16831 | @defvr {Scheme Variable} sysctl-service-type | |
16832 | The service type for @command{sysctl}, which modifies kernel parameters | |
16833 | under @file{/proc/sys/}. To enable IPv4 forwarding, it can be | |
16834 | instantiated as: | |
16835 | ||
16836 | @example | |
16837 | (service sysctl-service-type | |
16838 | (sysctl-configuration | |
16839 | (settings '(("net.ipv4.ip_forward" . "1"))))) | |
16840 | @end example | |
16841 | @end defvr | |
16842 | ||
16843 | @deftp {Data Type} sysctl-configuration | |
16844 | The data type representing the configuration of @command{sysctl}. | |
16845 | ||
16846 | @table @asis | |
16847 | @item @code{sysctl} (default: @code{(file-append procps "/sbin/sysctl"}) | |
16848 | The @command{sysctl} executable to use. | |
16849 | ||
16850 | @item @code{settings} (default: @code{'()}) | |
16851 | An association list specifies kernel parameters and their values. | |
16852 | @end table | |
16853 | @end deftp | |
eb419bc9 | 16854 | |
8ff4dcbe DC |
16855 | @cindex lirc |
16856 | @subsubheading Lirc Service | |
16857 | ||
fe1a39d3 LC |
16858 | The @code{(gnu services lirc)} module provides the following service. |
16859 | ||
be1c2c54 | 16860 | @deffn {Scheme Procedure} lirc-service [#:lirc lirc] @ |
fe1a39d3 LC |
16861 | [#:device #f] [#:driver #f] [#:config-file #f] @ |
16862 | [#:extra-options '()] | |
16863 | Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that | |
16864 | decodes infrared signals from remote controls. | |
16865 | ||
16866 | Optionally, @var{device}, @var{driver} and @var{config-file} | |
16867 | (configuration file name) may be specified. See @command{lircd} manual | |
16868 | for details. | |
16869 | ||
16870 | Finally, @var{extra-options} is a list of additional command-line options | |
16871 | passed to @command{lircd}. | |
16872 | @end deffn | |
16873 | ||
00f46905 DC |
16874 | @cindex spice |
16875 | @subsubheading Spice Service | |
16876 | ||
16877 | The @code{(gnu services spice)} module provides the following service. | |
16878 | ||
16879 | @deffn {Scheme Procedure} spice-vdagent-service [#:spice-vdagent] | |
16880 | Returns a service that runs @url{http://www.spice-space.org,VDAGENT}, a daemon | |
16881 | that enables sharing the clipboard with a vm and setting the guest display | |
16882 | resolution when the graphical console window resizes. | |
16883 | @end deffn | |
16884 | ||
c3d38b2b | 16885 | @subsubsection Dictionary Services |
e32171ee | 16886 | @cindex dictionary |
c3d38b2b SB |
16887 | The @code{(gnu services dict)} module provides the following service: |
16888 | ||
16889 | @deffn {Scheme Procedure} dicod-service [#:config (dicod-configuration)] | |
16890 | Return a service that runs the @command{dicod} daemon, an implementation | |
16891 | of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). | |
16892 | ||
16893 | The optional @var{config} argument specifies the configuration for | |
16894 | @command{dicod}, which should be a @code{<dicod-configuration>} object, by | |
16895 | default it serves the GNU Collaborative International Dictonary of English. | |
16896 | ||
16897 | You can add @command{open localhost} to your @file{~/.dico} file to make | |
16898 | @code{localhost} the default server for @command{dico} client | |
16899 | (@pxref{Initialization File,,, dico, GNU Dico Manual}). | |
16900 | @end deffn | |
16901 | ||
16902 | @deftp {Data Type} dicod-configuration | |
16903 | Data type representing the configuration of dicod. | |
16904 | ||
16905 | @table @asis | |
16906 | @item @code{dico} (default: @var{dico}) | |
16907 | Package object of the GNU Dico dictionary server. | |
16908 | ||
a1b48465 LC |
16909 | @item @code{interfaces} (default: @var{'("localhost")}) |
16910 | This is the list of IP addresses and ports and possibly socket file | |
16911 | names to listen to (@pxref{Server Settings, @code{listen} directive,, | |
16912 | dico, GNU Dico Manual}). | |
16913 | ||
9af7ecd9 HY |
16914 | @item @code{handlers} (default: @var{'()}) |
16915 | List of @code{<dicod-handler>} objects denoting handlers (module instances). | |
16916 | ||
c3d38b2b SB |
16917 | @item @code{databases} (default: @var{(list %dicod-database:gcide)}) |
16918 | List of @code{<dicod-database>} objects denoting dictionaries to be served. | |
16919 | @end table | |
16920 | @end deftp | |
16921 | ||
9af7ecd9 HY |
16922 | @deftp {Data Type} dicod-handler |
16923 | Data type representing a dictionary handler (module instance). | |
c3d38b2b SB |
16924 | |
16925 | @table @asis | |
16926 | @item @code{name} | |
9af7ecd9 | 16927 | Name of the handler (module instance). |
c3d38b2b | 16928 | |
9af7ecd9 HY |
16929 | @item @code{module} (default: @var{#f}) |
16930 | Name of the dicod module of the handler (instance). If it is @code{#f}, | |
16931 | the module has the same name as the handler. | |
c3d38b2b SB |
16932 | (@pxref{Modules,,, dico, GNU Dico Manual}). |
16933 | ||
16934 | @item @code{options} | |
16935 | List of strings or gexps representing the arguments for the module handler | |
9af7ecd9 HY |
16936 | @end table |
16937 | @end deftp | |
16938 | ||
16939 | @deftp {Data Type} dicod-database | |
16940 | Data type representing a dictionary database. | |
16941 | ||
16942 | @table @asis | |
16943 | @item @code{name} | |
16944 | Name of the database, will be used in DICT commands. | |
16945 | ||
16946 | @item @code{handler} | |
16947 | Name of the dicod handler (module instance) used by this database | |
c3d38b2b | 16948 | (@pxref{Handlers,,, dico, GNU Dico Manual}). |
9af7ecd9 HY |
16949 | |
16950 | @item @code{complex?} (default: @var{#f}) | |
16951 | Whether the database configuration complex. The complex configuration | |
16952 | will need a corresponding @code{<dicod-handler>} object, otherwise not. | |
16953 | ||
16954 | @item @code{options} | |
16955 | List of strings or gexps representing the arguments for the database | |
16956 | (@pxref{Databases,,, dico, GNU Dico Manual}). | |
c3d38b2b SB |
16957 | @end table |
16958 | @end deftp | |
16959 | ||
16960 | @defvr {Scheme Variable} %dicod-database:gcide | |
16961 | A @code{<dicod-database>} object serving the GNU Collaborative International | |
9fc221b5 | 16962 | Dictionary of English using the @code{gcide} package. |
c3d38b2b | 16963 | @end defvr |
fe1a39d3 | 16964 | |
9af7ecd9 HY |
16965 | The following is an example @code{dicod-service} configuration. |
16966 | ||
16967 | @example | |
16968 | (dicod-service #:config | |
16969 | (dicod-configuration | |
16970 | (handlers (list (dicod-handler | |
16971 | (name "wordnet") | |
16972 | (module "dictorg") | |
16973 | (options | |
16974 | (list #~(string-append "dbdir=" #$wordnet)))))) | |
16975 | (databases (list (dicod-database | |
16976 | (name "wordnet") | |
16977 | (complex? #t) | |
16978 | (handler "wordnet") | |
16979 | (options '("database=wn"))) | |
16980 | %dicod-database:gcide)))) | |
16981 | @end example | |
16982 | ||
e01e2c6c | 16983 | @subsubsection Version Control |
16984 | ||
16985 | The @code{(gnu services version-control)} module provides the following services: | |
16986 | ||
16987 | @subsubheading Git daemon service | |
16988 | ||
16989 | @deffn {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)] | |
16990 | ||
16991 | Return a service that runs @command{git daemon}, a simple TCP server to | |
9fc221b5 | 16992 | expose repositories over the Git protocol for anonymous access. |
e01e2c6c | 16993 | |
16994 | The optional @var{config} argument should be a | |
16995 | @code{<git-daemon-configuration>} object, by default it allows read-only | |
16996 | access to exported@footnote{By creating the magic file | |
16997 | "git-daemon-export-ok" in the repository directory.} repositories under | |
16998 | @file{/srv/git}. | |
16999 | ||
17000 | @end deffn | |
17001 | ||
17002 | @deftp {Data Type} git-daemon-configuration | |
17003 | Data type representing the configuration for @code{git-daemon-service}. | |
17004 | ||
17005 | @table @asis | |
17006 | @item @code{package} (default: @var{git}) | |
17007 | Package object of the Git distributed version control system. | |
17008 | ||
17009 | @item @code{export-all?} (default: @var{#f}) | |
17010 | Whether to allow access for all Git repositories, even if they do not | |
17011 | have the @file{git-daemon-export-ok} file. | |
17012 | ||
17013 | @item @code{base-path} (default: @file{/srv/git}) | |
17014 | Whether to remap all the path requests as relative to the given path. | |
17015 | If you run git daemon with @var{(base-path "/srv/git")} on example.com, | |
17016 | then if you later try to pull @code{git://example.com/hello.git}, git | |
17017 | daemon will interpret the path as @code{/srv/git/hello.git}. | |
17018 | ||
17019 | @item @code{user-path} (default: @var{#f}) | |
17020 | Whether to allow @code{~user} notation to be used in requests. When | |
17021 | specified with empty string, requests to @code{git://host/~alice/foo} is | |
17022 | taken as a request to access @code{foo} repository in the home directory | |
17023 | of user @code{alice}. If @var{(user-path "path")} is specified, the | |
17024 | same request is taken as a request to access @code{path/foo} repository | |
17025 | in the home directory of user @code{alice}. | |
17026 | ||
17027 | @item @code{listen} (default: @var{'()}) | |
17028 | Whether to listen on specific IP addresses or hostnames, defaults to | |
17029 | all. | |
17030 | ||
17031 | @item @code{port} (default: @var{#f}) | |
17032 | Whether to listen on an alternative port, which defaults to 9418. | |
17033 | ||
17034 | @item @code{whitelist} (default: @var{'()}) | |
17035 | If not empty, only allow access to this list of directories. | |
17036 | ||
17037 | @item @code{extra-options} (default: @var{'()}) | |
17038 | Extra options will be passed to @code{git daemon}, please run | |
17039 | @command{man git-daemon} for more information. | |
17040 | ||
17041 | @end table | |
17042 | @end deftp | |
17043 | ||
032a2760 OP |
17044 | @subsubheading Cgit Service |
17045 | ||
17046 | @cindex Cgit service | |
17047 | @cindex Git, web interface | |
17048 | @uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git | |
17049 | repositories written in C. | |
17050 | ||
17051 | The following example will configure the service with default values. | |
17052 | By default, Cgit can be accessed on port 80 (@code{http://localhost:80}). | |
17053 | ||
17054 | @example | |
17055 | (service nginx-service-type) | |
17056 | (service fcgiwrap-service-type) | |
17057 | (service cgit-service-type) | |
17058 | @end example | |
17059 | ||
17060 | @deftp {Data Type} cgit-configuration | |
17061 | Data type representing the configuration of Cgit. | |
17062 | This type has the following parameters: | |
17063 | ||
17064 | @table @asis | |
17065 | @item @code{config-file} (default: @code{(cgit-configuration-file)}) | |
17066 | The configuration file to use for Cgit. This can be set to a | |
17067 | @dfn{cgit-configuration-file} record value, or any gexp | |
17068 | (@pxref{G-Expressions}). | |
17069 | ||
17070 | For example, to instead use a local file, the @code{local-file} function | |
17071 | can be used: | |
17072 | ||
17073 | @example | |
17074 | (service cgit-service-type | |
17075 | (cgit-configuration | |
17076 | (config-file (local-file "./my-cgitrc.conf")))) | |
17077 | @end example | |
17078 | ||
17079 | @item @code{package} (default: @code{cgit}) | |
17080 | The Cgit package to use. | |
17081 | ||
17082 | @end table | |
17083 | @end deftp | |
17084 | ||
17085 | @deftp {Data Type} cgit-configuration-file | |
17086 | Data type representing the configuration options for Cgit. | |
17087 | This type has the following parameters: | |
17088 | ||
17089 | @table @asis | |
17090 | @item @code{css} (default: @code{"/share/cgit/cgit.css"}) | |
17091 | URL which specifies the css document to include in all Cgit pages. | |
17092 | ||
17093 | @item @code{logo} (default: @code{"/share/cgit/cgit.png"}) | |
17094 | URL which specifies the source of an image which will be used as a logo | |
17095 | on all Cgit pages. | |
17096 | ||
17097 | @item @code{virtual-root} (default: @code{"/"}) | |
17098 | URL which, if specified, will be used as root for all Cgit links. | |
17099 | ||
17100 | @item @code{repository-directory} (default: @code{"/srv/git"}) | |
17101 | Name of the directory to scan for repositories. | |
17102 | ||
17103 | @item @code{robots} (default: @code{(list "noindex" "nofollow")}) | |
17104 | Text used as content for the ``robots'' meta-tag. | |
17105 | ||
17106 | @end table | |
17107 | @end deftp | |
17108 | ||
0ae8c15a LC |
17109 | @node Setuid Programs |
17110 | @subsection Setuid Programs | |
17111 | ||
17112 | @cindex setuid programs | |
17113 | Some programs need to run with ``root'' privileges, even when they are | |
17114 | launched by unprivileged users. A notorious example is the | |
4d40227c LC |
17115 | @command{passwd} program, which users can run to change their |
17116 | password, and which needs to access the @file{/etc/passwd} and | |
0ae8c15a LC |
17117 | @file{/etc/shadow} files---something normally restricted to root, for |
17118 | obvious security reasons. To address that, these executables are | |
17119 | @dfn{setuid-root}, meaning that they always run with root privileges | |
17120 | (@pxref{How Change Persona,,, libc, The GNU C Library Reference Manual}, | |
f7e4ae7f | 17121 | for more info about the setuid mechanism.) |
0ae8c15a LC |
17122 | |
17123 | The store itself @emph{cannot} contain setuid programs: that would be a | |
17124 | security issue since any user on the system can write derivations that | |
17125 | populate the store (@pxref{The Store}). Thus, a different mechanism is | |
17126 | used: instead of changing the setuid bit directly on files that are in | |
17127 | the store, we let the system administrator @emph{declare} which programs | |
17128 | should be setuid root. | |
17129 | ||
17130 | The @code{setuid-programs} field of an @code{operating-system} | |
17131 | declaration contains a list of G-expressions denoting the names of | |
17132 | programs to be setuid-root (@pxref{Using the Configuration System}). | |
17133 | For instance, the @command{passwd} program, which is part of the Shadow | |
17134 | package, can be designated by this G-expression (@pxref{G-Expressions}): | |
17135 | ||
17136 | @example | |
17137 | #~(string-append #$shadow "/bin/passwd") | |
17138 | @end example | |
17139 | ||
17140 | A default set of setuid programs is defined by the | |
17141 | @code{%setuid-programs} variable of the @code{(gnu system)} module. | |
17142 | ||
17143 | @defvr {Scheme Variable} %setuid-programs | |
17144 | A list of G-expressions denoting common programs that are setuid-root. | |
17145 | ||
17146 | The list includes commands such as @command{passwd}, @command{ping}, | |
17147 | @command{su}, and @command{sudo}. | |
17148 | @end defvr | |
17149 | ||
17150 | Under the hood, the actual setuid programs are created in the | |
17151 | @file{/run/setuid-programs} directory at system activation time. The | |
17152 | files in this directory refer to the ``real'' binaries, which are in the | |
17153 | store. | |
17154 | ||
efb5e833 LC |
17155 | @node X.509 Certificates |
17156 | @subsection X.509 Certificates | |
17157 | ||
17158 | @cindex HTTPS, certificates | |
17159 | @cindex X.509 certificates | |
17160 | @cindex TLS | |
17161 | Web servers available over HTTPS (that is, HTTP over the transport-layer | |
17162 | security mechanism, TLS) send client programs an @dfn{X.509 certificate} | |
17163 | that the client can then use to @emph{authenticate} the server. To do | |
17164 | that, clients verify that the server's certificate is signed by a | |
17165 | so-called @dfn{certificate authority} (CA). But to verify the CA's | |
17166 | signature, clients must have first acquired the CA's certificate. | |
17167 | ||
17168 | Web browsers such as GNU@tie{}IceCat include their own set of CA | |
17169 | certificates, such that they are able to verify CA signatures | |
17170 | out-of-the-box. | |
17171 | ||
17172 | However, most other programs that can talk HTTPS---@command{wget}, | |
17173 | @command{git}, @command{w3m}, etc.---need to be told where CA | |
17174 | certificates can be found. | |
17175 | ||
17176 | @cindex @code{nss-certs} | |
17177 | In GuixSD, this is done by adding a package that provides certificates | |
17178 | to the @code{packages} field of the @code{operating-system} declaration | |
17179 | (@pxref{operating-system Reference}). GuixSD includes one such package, | |
17180 | @code{nss-certs}, which is a set of CA certificates provided as part of | |
17181 | Mozilla's Network Security Services. | |
17182 | ||
17183 | Note that it is @emph{not} part of @var{%base-packages}, so you need to | |
17184 | explicitly add it. The @file{/etc/ssl/certs} directory, which is where | |
17185 | most applications and libraries look for certificates by default, points | |
17186 | to the certificates installed globally. | |
17187 | ||
b3129f2b LC |
17188 | Unprivileged users, including users of Guix on a foreign distro, |
17189 | can also install their own certificate package in | |
efb5e833 LC |
17190 | their profile. A number of environment variables need to be defined so |
17191 | that applications and libraries know where to find them. Namely, the | |
17192 | OpenSSL library honors the @code{SSL_CERT_DIR} and @code{SSL_CERT_FILE} | |
17193 | variables. Some applications add their own environment variables; for | |
17194 | instance, the Git version control system honors the certificate bundle | |
b3129f2b LC |
17195 | pointed to by the @code{GIT_SSL_CAINFO} environment variable. Thus, you |
17196 | would typically run something like: | |
efb5e833 | 17197 | |
b3129f2b LC |
17198 | @example |
17199 | $ guix package -i nss-certs | |
17200 | $ export SSL_CERT_DIR="$HOME/.guix-profile/etc/ssl/certs" | |
17201 | $ export SSL_CERT_FILE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt" | |
17202 | $ export GIT_SSL_CAINFO="$SSL_CERT_FILE" | |
17203 | @end example | |
efb5e833 | 17204 | |
63657335 RW |
17205 | As another example, R requires the @code{CURL_CA_BUNDLE} environment |
17206 | variable to point to a certificate bundle, so you would have to run | |
17207 | something like this: | |
17208 | ||
17209 | @example | |
17210 | $ guix package -i nss-certs | |
17211 | $ export CURL_CA_BUNDLE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt" | |
17212 | @end example | |
17213 | ||
17214 | For other applications you may want to look up the required environment | |
17215 | variable in the relevant documentation. | |
17216 | ||
17217 | ||
996ed739 LC |
17218 | @node Name Service Switch |
17219 | @subsection Name Service Switch | |
17220 | ||
17221 | @cindex name service switch | |
17222 | @cindex NSS | |
17223 | The @code{(gnu system nss)} module provides bindings to the | |
1068f26b | 17224 | configuration file of the libc @dfn{name service switch} or @dfn{NSS} |
996ed739 LC |
17225 | (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference |
17226 | Manual}). In a nutshell, the NSS is a mechanism that allows libc to be | |
17227 | extended with new ``name'' lookup methods for system databases, which | |
17228 | includes host names, service names, user accounts, and more (@pxref{Name | |
17229 | Service Switch, System Databases and Name Service Switch,, libc, The GNU | |
17230 | C Library Reference Manual}). | |
17231 | ||
17232 | The NSS configuration specifies, for each system database, which lookup | |
17233 | method is to be used, and how the various methods are chained | |
17234 | together---for instance, under which circumstances NSS should try the | |
17235 | next method in the list. The NSS configuration is given in the | |
17236 | @code{name-service-switch} field of @code{operating-system} declarations | |
17237 | (@pxref{operating-system Reference, @code{name-service-switch}}). | |
17238 | ||
4c9050c6 LC |
17239 | @cindex nss-mdns |
17240 | @cindex .local, host name lookup | |
996ed739 | 17241 | As an example, the declaration below configures the NSS to use the |
4c9050c6 LC |
17242 | @uref{http://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} |
17243 | back-end}, which supports host name lookups over multicast DNS (mDNS) | |
17244 | for host names ending in @code{.local}: | |
996ed739 LC |
17245 | |
17246 | @example | |
17247 | (name-service-switch | |
17248 | (hosts (list %files ;first, check /etc/hosts | |
17249 | ||
17250 | ;; If the above did not succeed, try | |
17251 | ;; with 'mdns_minimal'. | |
17252 | (name-service | |
17253 | (name "mdns_minimal") | |
17254 | ||
17255 | ;; 'mdns_minimal' is authoritative for | |
17256 | ;; '.local'. When it returns "not found", | |
17257 | ;; no need to try the next methods. | |
17258 | (reaction (lookup-specification | |
17259 | (not-found => return)))) | |
17260 | ||
17261 | ;; Then fall back to DNS. | |
17262 | (name-service | |
17263 | (name "dns")) | |
17264 | ||
17265 | ;; Finally, try with the "full" 'mdns'. | |
17266 | (name-service | |
17267 | (name "mdns"))))) | |
17268 | @end example | |
17269 | ||
1068f26b AE |
17270 | Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) |
17271 | contains this configuration, so you will not have to type it if all you | |
15137a29 LC |
17272 | want is to have @code{.local} host lookup working. |
17273 | ||
4c9050c6 LC |
17274 | Note that, in this case, in addition to setting the |
17275 | @code{name-service-switch} of the @code{operating-system} declaration, | |
cc9c1f39 LC |
17276 | you also need to use @code{avahi-service} (@pxref{Networking Services, |
17277 | @code{avahi-service}}), or @var{%desktop-services}, which includes it | |
17278 | (@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible | |
17279 | to the name service cache daemon (@pxref{Base Services, | |
17280 | @code{nscd-service}}). | |
15137a29 LC |
17281 | |
17282 | For convenience, the following variables provide typical NSS | |
17283 | configurations. | |
17284 | ||
17285 | @defvr {Scheme Variable} %default-nss | |
17286 | This is the default name service switch configuration, a | |
17287 | @code{name-service-switch} object. | |
17288 | @end defvr | |
17289 | ||
17290 | @defvr {Scheme Variable} %mdns-host-lookup-nss | |
17291 | This is the name service switch configuration with support for host name | |
17292 | lookup over multicast DNS (mDNS) for host names ending in @code{.local}. | |
17293 | @end defvr | |
4c9050c6 | 17294 | |
996ed739 | 17295 | The reference for name service switch configuration is given below. It |
1068f26b | 17296 | is a direct mapping of the configuration file format of the C library , so |
996ed739 LC |
17297 | please refer to the C library manual for more information (@pxref{NSS |
17298 | Configuration File,,, libc, The GNU C Library Reference Manual}). | |
1068f26b | 17299 | Compared to the configuration file format of libc NSS, it has the advantage |
996ed739 | 17300 | not only of adding this warm parenthetic feel that we like, but also |
1068f26b | 17301 | static checks: you will know about syntax errors and typos as soon as you |
996ed739 LC |
17302 | run @command{guix system}. |
17303 | ||
996ed739 LC |
17304 | @deftp {Data Type} name-service-switch |
17305 | ||
17306 | This is the data type representation the configuration of libc's name | |
17307 | service switch (NSS). Each field below represents one of the supported | |
17308 | system databases. | |
17309 | ||
17310 | @table @code | |
17311 | @item aliases | |
17312 | @itemx ethers | |
17313 | @itemx group | |
17314 | @itemx gshadow | |
17315 | @itemx hosts | |
17316 | @itemx initgroups | |
17317 | @itemx netgroup | |
17318 | @itemx networks | |
17319 | @itemx password | |
17320 | @itemx public-key | |
17321 | @itemx rpc | |
17322 | @itemx services | |
17323 | @itemx shadow | |
17324 | The system databases handled by the NSS. Each of these fields must be a | |
1068f26b | 17325 | list of @code{<name-service>} objects (see below). |
996ed739 LC |
17326 | @end table |
17327 | @end deftp | |
17328 | ||
17329 | @deftp {Data Type} name-service | |
17330 | ||
17331 | This is the data type representing an actual name service and the | |
17332 | associated lookup action. | |
17333 | ||
17334 | @table @code | |
17335 | @item name | |
17336 | A string denoting the name service (@pxref{Services in the NSS | |
17337 | configuration,,, libc, The GNU C Library Reference Manual}). | |
17338 | ||
4aee6e60 LC |
17339 | Note that name services listed here must be visible to nscd. This is |
17340 | achieved by passing the @code{#:name-services} argument to | |
17341 | @code{nscd-service} the list of packages providing the needed name | |
17342 | services (@pxref{Base Services, @code{nscd-service}}). | |
17343 | ||
996ed739 LC |
17344 | @item reaction |
17345 | An action specified using the @code{lookup-specification} macro | |
17346 | (@pxref{Actions in the NSS configuration,,, libc, The GNU C Library | |
17347 | Reference Manual}). For example: | |
17348 | ||
17349 | @example | |
17350 | (lookup-specification (unavailable => continue) | |
17351 | (success => return)) | |
17352 | @end example | |
17353 | @end table | |
17354 | @end deftp | |
0ae8c15a | 17355 | |
fd1b1fa2 LC |
17356 | @node Initial RAM Disk |
17357 | @subsection Initial RAM Disk | |
17358 | ||
e32171ee JD |
17359 | @cindex initrd |
17360 | @cindex initial RAM disk | |
fd1b1fa2 LC |
17361 | For bootstrapping purposes, the Linux-Libre kernel is passed an |
17362 | @dfn{initial RAM disk}, or @dfn{initrd}. An initrd contains a temporary | |
1068f26b | 17363 | root file system as well as an initialization script. The latter is |
fd1b1fa2 LC |
17364 | responsible for mounting the real root file system, and for loading any |
17365 | kernel modules that may be needed to achieve that. | |
17366 | ||
17367 | The @code{initrd} field of an @code{operating-system} declaration allows | |
17368 | you to specify which initrd you would like to use. The @code{(gnu | |
47bdc5a1 MO |
17369 | system linux-initrd)} module provides three ways to build an initrd: the |
17370 | high-level @code{base-initrd} procedure and the low-level | |
17371 | @code{raw-initrd} and @code{expression->initrd} procedures. | |
fd1b1fa2 LC |
17372 | |
17373 | The @code{base-initrd} procedure is intended to cover most common uses. | |
17374 | For example, if you want to add a bunch of kernel modules to be loaded | |
17375 | at boot time, you can define the @code{initrd} field of the operating | |
17376 | system declaration like this: | |
17377 | ||
17378 | @example | |
52ac153e | 17379 | (initrd (lambda (file-systems . rest) |
027981d6 LC |
17380 | ;; Create a standard initrd that has modules "foo.ko" |
17381 | ;; and "bar.ko", as well as their dependencies, in | |
17382 | ;; addition to the modules available by default. | |
52ac153e | 17383 | (apply base-initrd file-systems |
027981d6 | 17384 | #:extra-modules '("foo" "bar") |
52ac153e | 17385 | rest))) |
fd1b1fa2 LC |
17386 | @end example |
17387 | ||
52ac153e | 17388 | The @code{base-initrd} procedure also handles common use cases that |
1068f26b AE |
17389 | involves using the system as a QEMU guest, or as a ``live'' system with |
17390 | volatile root file system. | |
fd1b1fa2 | 17391 | |
47bdc5a1 MO |
17392 | The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. |
17393 | Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, | |
17394 | such as trying to guess which kernel modules and packages should be included | |
17395 | to the initrd. An example use of @code{raw-initrd} is when a user has | |
17396 | a custom Linux kernel configuration and default kernel modules included by | |
17397 | @code{base-initrd} are not available. | |
17398 | ||
17399 | The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} | |
17400 | honors several options passed on the Linux kernel command line | |
17401 | (that is, arguments passed @i{via} the @code{linux} command of GRUB, or the | |
4af2fafd | 17402 | @code{-append} option of QEMU), notably: |
e90cf6c1 LC |
17403 | |
17404 | @table @code | |
17405 | @item --load=@var{boot} | |
17406 | Tell the initial RAM disk to load @var{boot}, a file containing a Scheme | |
17407 | program, once it has mounted the root file system. | |
17408 | ||
17409 | GuixSD uses this option to yield control to a boot program that runs the | |
dd17bc38 | 17410 | service activation programs and then spawns the GNU@tie{}Shepherd, the |
e90cf6c1 LC |
17411 | initialization system. |
17412 | ||
17413 | @item --root=@var{root} | |
1068f26b | 17414 | Mount @var{root} as the root file system. @var{root} can be a |
e90cf6c1 LC |
17415 | device name like @code{/dev/sda1}, a partition label, or a partition |
17416 | UUID. | |
17417 | ||
17418 | @item --system=@var{system} | |
17419 | Have @file{/run/booted-system} and @file{/run/current-system} point to | |
17420 | @var{system}. | |
17421 | ||
17422 | @item modprobe.blacklist=@var{modules}@dots{} | |
17423 | @cindex module, black-listing | |
17424 | @cindex black list, of kernel modules | |
17425 | Instruct the initial RAM disk as well as the @command{modprobe} command | |
17426 | (from the kmod package) to refuse to load @var{modules}. @var{modules} | |
17427 | must be a comma-separated list of module names---e.g., | |
17428 | @code{usbkbd,9pnet}. | |
17429 | ||
17430 | @item --repl | |
17431 | Start a read-eval-print loop (REPL) from the initial RAM disk before it | |
17432 | tries to load kernel modules and to mount the root file system. Our | |
17433 | marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will | |
17434 | love it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference | |
17435 | Manual}, for more information on Guile's REPL. | |
17436 | ||
17437 | @end table | |
17438 | ||
17439 | Now that you know all the features that initial RAM disks produced by | |
47bdc5a1 MO |
17440 | @code{base-initrd} and @code{raw-initrd} provide, |
17441 | here is how to use it and customize it further. | |
e90cf6c1 | 17442 | |
e32171ee JD |
17443 | @cindex initrd |
17444 | @cindex initial RAM disk | |
47bdc5a1 MO |
17445 | @deffn {Monadic Procedure} raw-initrd @var{file-systems} @ |
17446 | [#:linux-modules '()] [#:mapped-devices '()] @ | |
17447 | [#:helper-packages '()] [#:qemu-networking? #f] [#:volatile-root? #f] | |
17448 | Return a monadic derivation that builds a raw initrd. @var{file-systems} is | |
1068f26b | 17449 | a list of file systems to be mounted by the initrd, possibly in addition to |
fd1b1fa2 | 17450 | the root file system specified on the kernel command line via @code{--root}. |
47bdc5a1 | 17451 | @var{linux-modules} is a list of kernel modules to be loaded at boot time. |
52ac153e LC |
17452 | @var{mapped-devices} is a list of device mappings to realize before |
17453 | @var{file-systems} are mounted (@pxref{Mapped Devices}). | |
47bdc5a1 MO |
17454 | @var{helper-packages} is a list of packages to be copied in the initrd. It may |
17455 | include @code{e2fsck/static} or other packages needed by the initrd to check | |
17456 | root partition. | |
fd1b1fa2 LC |
17457 | |
17458 | When @var{qemu-networking?} is true, set up networking with the standard QEMU | |
1068f26b AE |
17459 | parameters. When @var{virtio?} is true, load additional modules so that the |
17460 | initrd can be used as a QEMU guest with para-virtualized I/O drivers. | |
fd1b1fa2 LC |
17461 | |
17462 | When @var{volatile-root?} is true, the root file system is writable but any changes | |
17463 | to it are lost. | |
47bdc5a1 MO |
17464 | @end deffn |
17465 | ||
17466 | @deffn {Monadic Procedure} base-initrd @var{file-systems} @ | |
17467 | [#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]@ | |
17468 | [#:virtio? #t] [#:extra-modules '()] | |
17469 | Return a monadic derivation that builds a generic initrd. @var{file-systems} is | |
17470 | a list of file systems to be mounted by the initrd like for @code{raw-initrd}. | |
17471 | @var{mapped-devices}, @var{qemu-networking?} and @var{volatile-root?} | |
17472 | also behaves as in @code{raw-initrd}. | |
17473 | ||
17474 | When @var{virtio?} is true, load additional modules so that the | |
17475 | initrd can be used as a QEMU guest with para-virtualized I/O drivers. | |
fd1b1fa2 LC |
17476 | |
17477 | The initrd is automatically populated with all the kernel modules necessary | |
17478 | for @var{file-systems} and for the given options. However, additional kernel | |
17479 | modules can be listed in @var{extra-modules}. They will be added to the initrd, and | |
17480 | loaded at boot time in the order in which they appear. | |
17481 | @end deffn | |
17482 | ||
17483 | Needless to say, the initrds we produce and use embed a | |
17484 | statically-linked Guile, and the initialization program is a Guile | |
17485 | program. That gives a lot of flexibility. The | |
17486 | @code{expression->initrd} procedure builds such an initrd, given the | |
17487 | program to run in that initrd. | |
17488 | ||
17489 | @deffn {Monadic Procedure} expression->initrd @var{exp} @ | |
4ee96a79 | 17490 | [#:guile %guile-static-stripped] [#:name "guile-initrd"] |
fd1b1fa2 LC |
17491 | Return a derivation that builds a Linux initrd (a gzipped cpio archive) |
17492 | containing @var{guile} and that evaluates @var{exp}, a G-expression, | |
df650fa8 LC |
17493 | upon booting. All the derivations referenced by @var{exp} are |
17494 | automatically copied to the initrd. | |
fd1b1fa2 LC |
17495 | @end deffn |
17496 | ||
74e64724 MO |
17497 | @node Bootloader Configuration |
17498 | @subsection Bootloader Configuration | |
88faf933 | 17499 | |
74e64724 | 17500 | @cindex bootloader |
88faf933 LC |
17501 | @cindex boot loader |
17502 | ||
74e64724 MO |
17503 | The operating system supports multiple bootloaders. The bootloader is |
17504 | configured using @code{bootloader-configuration} declaration. All the | |
17505 | fields of this structure are bootloader agnostic except for one field, | |
17506 | @code{bootloader} that indicates the bootloader to be configured and | |
17507 | installed. | |
88faf933 | 17508 | |
74e64724 MO |
17509 | Some of the bootloaders do not honor every field of |
17510 | @code{bootloader-configuration}. For instance, the extlinux | |
17511 | bootloader does not support themes and thus ignores the @code{theme} | |
17512 | field. | |
17513 | ||
17514 | @deftp {Data Type} bootloader-configuration | |
17515 | The type of a bootloader configuration declaration. | |
88faf933 LC |
17516 | |
17517 | @table @asis | |
17518 | ||
74e64724 MO |
17519 | @item @code{bootloader} |
17520 | @cindex EFI, bootloader | |
17521 | @cindex UEFI, bootloader | |
17522 | @cindex BIOS, bootloader | |
17523 | The bootloader to use, as a @code{bootloader} object. For now | |
8d858010 DM |
17524 | @code{grub-bootloader}, @code{grub-efi-bootloader}, |
17525 | @code{extlinux-bootloader} and @code{u-boot-bootloader} are supported. | |
17526 | @code{grub-efi-bootloader} allows to boot on modern systems using the | |
17527 | @dfn{Unified Extensible Firmware Interface} (UEFI). | |
74e64724 MO |
17528 | |
17529 | Available bootloaders are described in @code{(gnu bootloader @dots{})} | |
17530 | modules. | |
17531 | ||
045ebb3e AW |
17532 | @item @code{target} |
17533 | This is a string denoting the target onto which to install the | |
17534 | bootloader. The exact interpretation depends on the bootloader in | |
17535 | question; for @code{grub-bootloader}, for example, it should be a device | |
17536 | name understood by the bootloader @command{installer} command, such as | |
17537 | @code{/dev/sda} or @code{(hd0)} (for GRUB, @pxref{Invoking | |
17538 | grub-install,,, grub, GNU GRUB Manual}). For | |
17539 | @code{grub-efi-bootloader}, it should be the path to a mounted EFI file | |
17540 | system. | |
88faf933 LC |
17541 | |
17542 | @item @code{menu-entries} (default: @code{()}) | |
17543 | A possibly empty list of @code{menu-entry} objects (see below), denoting | |
74e64724 | 17544 | entries to appear in the bootloader menu, in addition to the current |
88faf933 | 17545 | system entry and the entry pointing to previous system generations. |
74e64724 | 17546 | generations. |
88faf933 LC |
17547 | |
17548 | @item @code{default-entry} (default: @code{0}) | |
1068f26b AE |
17549 | The index of the default boot menu entry. Index 0 is for the entry of the |
17550 | current system. | |
88faf933 LC |
17551 | |
17552 | @item @code{timeout} (default: @code{5}) | |
17553 | The number of seconds to wait for keyboard input before booting. Set to | |
17554 | 0 to boot immediately, and to -1 to wait indefinitely. | |
17555 | ||
74e64724 MO |
17556 | @item @code{theme} (default: @var{#f}) |
17557 | The bootloader theme object describing the theme to use. If no theme | |
17558 | is provided, some bootloaders might use a default theme, that's true | |
17559 | for GRUB. | |
e0b2e930 LF |
17560 | |
17561 | @item @code{terminal-outputs} (default: @code{'gfxterm}) | |
74e64724 MO |
17562 | The output terminals used for the bootloader boot menu, as a list of |
17563 | symbols. GRUB accepts the values: @code{console}, @code{serial}, | |
17564 | @code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, | |
17565 | @code{mda_text}, @code{morse}, and @code{pkmodem}. This field | |
17566 | corresponds to the GRUB variable GRUB_TERMINAL_OUTPUT (@pxref{Simple | |
17567 | configuration,,, grub,GNU GRUB manual}). | |
e0b2e930 LF |
17568 | |
17569 | @item @code{terminal-inputs} (default: @code{'()}) | |
74e64724 MO |
17570 | The input terminals used for the bootloader boot menu, as a list of |
17571 | symbols. For GRUB, the default is the native platform terminal as | |
17572 | determined at run-time. GRUB accepts the values: @code{console}, | |
17573 | @code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and | |
17574 | @code{usb_keyboard}. This field corresponds to the GRUB variable | |
17575 | GRUB_TERMINAL_INPUT (@pxref{Simple configuration,,, grub,GNU GRUB | |
17576 | manual}). | |
e0b2e930 LF |
17577 | |
17578 | @item @code{serial-unit} (default: @code{#f}) | |
74e64724 MO |
17579 | The serial unit used by the bootloader, as an integer from 0 to 3. |
17580 | For GRUB it is choosen at run-time; currently GRUB chooses 0, which | |
e0b2e930 LF |
17581 | corresponds to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual}). |
17582 | ||
17583 | @item @code{serial-speed} (default: @code{#f}) | |
74e64724 MO |
17584 | The speed of the serial interface, as an integer. For GRUB, the |
17585 | default value is chosen at run-time; currently GRUB chooses | |
17586 | 9600@tie{}bps (@pxref{Serial terminal,,, grub,GNU GRUB manual}). | |
88faf933 LC |
17587 | @end table |
17588 | ||
17589 | @end deftp | |
17590 | ||
44d5f54e LC |
17591 | @cindex dual boot |
17592 | @cindex boot menu | |
88faf933 LC |
17593 | Should you want to list additional boot menu entries @i{via} the |
17594 | @code{menu-entries} field above, you will need to create them with the | |
44d5f54e LC |
17595 | @code{menu-entry} form. For example, imagine you want to be able to |
17596 | boot another distro (hard to imagine!), you can define a menu entry | |
17597 | along these lines: | |
17598 | ||
17599 | @example | |
17600 | (menu-entry | |
17601 | (label "The Other Distro") | |
17602 | (linux "/boot/old/vmlinux-2.6.32") | |
17603 | (linux-arguments '("root=/dev/sda2")) | |
17604 | (initrd "/boot/old/initrd")) | |
17605 | @end example | |
17606 | ||
17607 | Details below. | |
88faf933 LC |
17608 | |
17609 | @deftp {Data Type} menu-entry | |
74e64724 | 17610 | The type of an entry in the bootloader menu. |
88faf933 LC |
17611 | |
17612 | @table @asis | |
17613 | ||
17614 | @item @code{label} | |
35ed9306 | 17615 | The label to show in the menu---e.g., @code{"GNU"}. |
88faf933 LC |
17616 | |
17617 | @item @code{linux} | |
44d5f54e LC |
17618 | The Linux kernel image to boot, for example: |
17619 | ||
17620 | @example | |
17621 | (file-append linux-libre "/bzImage") | |
17622 | @end example | |
88faf933 | 17623 | |
74e64724 MO |
17624 | For GRUB, it is also possible to specify a device explicitly in the |
17625 | file path using GRUB's device naming convention (@pxref{Naming | |
17626 | convention,,, grub, GNU GRUB manual}), for example: | |
1ef8b72a CM |
17627 | |
17628 | @example | |
17629 | "(hd0,msdos1)/boot/vmlinuz" | |
17630 | @end example | |
17631 | ||
17632 | If the device is specified explicitly as above, then the @code{device} | |
17633 | field is ignored entirely. | |
17634 | ||
88faf933 LC |
17635 | @item @code{linux-arguments} (default: @code{()}) |
17636 | The list of extra Linux kernel command-line arguments---e.g., | |
17637 | @code{("console=ttyS0")}. | |
17638 | ||
17639 | @item @code{initrd} | |
17640 | A G-Expression or string denoting the file name of the initial RAM disk | |
17641 | to use (@pxref{G-Expressions}). | |
1ef8b72a | 17642 | @item @code{device} (default: @code{#f}) |
74e64724 | 17643 | The device where the kernel and initrd are to be found---i.e., for GRUB, |
1ef8b72a CM |
17644 | @dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual}). |
17645 | ||
17646 | This may be a file system label (a string), a file system UUID (a | |
74e64724 MO |
17647 | bytevector, @pxref{File Systems}), or @code{#f}, in which case |
17648 | the bootloader will search the device containing the file specified by | |
17649 | the @code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It | |
17650 | must @emph{not} be an OS device name such as @file{/dev/sda1}. | |
1ef8b72a | 17651 | |
88faf933 LC |
17652 | @end table |
17653 | @end deftp | |
17654 | ||
17655 | @c FIXME: Write documentation once it's stable. | |
74e64724 MO |
17656 | Fow now only GRUB has theme support. GRUB themes are created using |
17657 | the @code{grub-theme} form, which is not documented yet. | |
88faf933 LC |
17658 | |
17659 | @defvr {Scheme Variable} %default-theme | |
74e64724 MO |
17660 | This is the default GRUB theme used by the operating system if no |
17661 | @code{theme} field is specified in @code{bootloader-configuration} | |
17662 | record. | |
17663 | ||
17664 | It comes with a fancy background image displaying the GNU and Guix | |
17665 | logos. | |
88faf933 LC |
17666 | @end defvr |
17667 | ||
17668 | ||
cf4a9129 LC |
17669 | @node Invoking guix system |
17670 | @subsection Invoking @code{guix system} | |
0918e64a | 17671 | |
1068f26b | 17672 | Once you have written an operating system declaration as seen in the |
cf4a9129 LC |
17673 | previous section, it can be @dfn{instantiated} using the @command{guix |
17674 | system} command. The synopsis is: | |
4af2447e | 17675 | |
cf4a9129 LC |
17676 | @example |
17677 | guix system @var{options}@dots{} @var{action} @var{file} | |
17678 | @end example | |
4af2447e | 17679 | |
cf4a9129 LC |
17680 | @var{file} must be the name of a file containing an |
17681 | @code{operating-system} declaration. @var{action} specifies how the | |
a40424bd | 17682 | operating system is instantiated. Currently the following values are |
cf4a9129 | 17683 | supported: |
4af2447e | 17684 | |
cf4a9129 | 17685 | @table @code |
0649321d LC |
17686 | @item search |
17687 | Display available service type definitions that match the given regular | |
17688 | expressions, sorted by relevance: | |
17689 | ||
17690 | @example | |
17691 | $ guix system search console font | |
17692 | name: console-fonts | |
17693 | location: gnu/services/base.scm:729:2 | |
17694 | extends: shepherd-root | |
17695 | description: Install the given fonts on the specified ttys (fonts are | |
17696 | + per virtual console on GNU/Linux). The value of this service is a list | |
17697 | + of tty/font pairs like: | |
17698 | + | |
17699 | + '(("tty1" . "LatGrkCyr-8x16")) | |
17700 | relevance: 20 | |
17701 | ||
17702 | name: mingetty | |
17703 | location: gnu/services/base.scm:1048:2 | |
17704 | extends: shepherd-root | |
17705 | description: Provide console login using the `mingetty' program. | |
17706 | relevance: 2 | |
17707 | ||
17708 | name: login | |
17709 | location: gnu/services/base.scm:775:2 | |
17710 | extends: pam | |
17711 | description: Provide a console log-in service as specified by its | |
17712 | + configuration value, a `login-configuration' object. | |
17713 | relevance: 2 | |
17714 | ||
17715 | @dots{} | |
17716 | @end example | |
17717 | ||
17718 | As for @command{guix package --search}, the result is written in | |
17719 | @code{recutils} format, which makes it easy to filter the output | |
17720 | (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual}). | |
17721 | ||
cf4a9129 LC |
17722 | @item reconfigure |
17723 | Build the operating system described in @var{file}, activate it, and | |
8074b330 CM |
17724 | switch to it@footnote{This action (and the related actions |
17725 | @code{switch-generation} and @code{roll-back}) are usable only on | |
17726 | systems already running GuixSD.}. | |
4af2447e | 17727 | |
cf4a9129 LC |
17728 | This effects all the configuration specified in @var{file}: user |
17729 | accounts, system services, global package list, setuid programs, etc. | |
240b57f0 LC |
17730 | The command starts system services specified in @var{file} that are not |
17731 | currently running; if a service is currently running, it does not | |
1068f26b | 17732 | attempt to upgrade it since this would not be possible without stopping it |
240b57f0 | 17733 | first. |
4af2447e | 17734 | |
067a2e2d CM |
17735 | This command creates a new generation whose number is one greater than |
17736 | the current generation (as reported by @command{guix system | |
17737 | list-generations}). If that generation already exists, it will be | |
17738 | overwritten. This behavior mirrors that of @command{guix package} | |
17739 | (@pxref{Invoking guix package}). | |
17740 | ||
74e64724 MO |
17741 | It also adds a bootloader menu entry for the new OS configuration, |
17742 | ---unless @option{--no-bootloader} is passed. For GRUB, it moves | |
17743 | entries for older configurations to a submenu, allowing you to choose | |
17744 | an older system generation at boot time should you need it. | |
4af2447e | 17745 | |
240b57f0 | 17746 | @quotation Note |
bf2479c7 LC |
17747 | @c The paragraph below refers to the problem discussed at |
17748 | @c <http://lists.gnu.org/archive/html/guix-devel/2014-08/msg00057.html>. | |
17749 | It is highly recommended to run @command{guix pull} once before you run | |
17750 | @command{guix system reconfigure} for the first time (@pxref{Invoking | |
17751 | guix pull}). Failing to do that you would see an older version of Guix | |
17752 | once @command{reconfigure} has completed. | |
240b57f0 | 17753 | @end quotation |
bf2479c7 | 17754 | |
8074b330 | 17755 | @item switch-generation |
e32171ee | 17756 | @cindex generations |
8074b330 | 17757 | Switch to an existing system generation. This action atomically |
74e64724 MO |
17758 | switches the system profile to the specified system generation. It |
17759 | also rearranges the system's existing bootloader menu entries. It | |
17760 | makes the menu entry for the specified system generation the default, | |
17761 | and it moves the entries for the other generatiors to a submenu, if | |
17762 | supported by the bootloader being used. The next time the system | |
17763 | boots, it will use the specified system generation. | |
17764 | ||
17765 | The bootloader itself is not being reinstalled when using this | |
17766 | command. Thus, the installed bootloader is used with an updated | |
17767 | configuration file. | |
8074b330 CM |
17768 | |
17769 | The target generation can be specified explicitly by its generation | |
17770 | number. For example, the following invocation would switch to system | |
17771 | generation 7: | |
17772 | ||
17773 | @example | |
17774 | guix system switch-generation 7 | |
17775 | @end example | |
17776 | ||
17777 | The target generation can also be specified relative to the current | |
17778 | generation with the form @code{+N} or @code{-N}, where @code{+3} means | |
17779 | ``3 generations ahead of the current generation,'' and @code{-1} means | |
17780 | ``1 generation prior to the current generation.'' When specifying a | |
17781 | negative value such as @code{-1}, you must precede it with @code{--} to | |
17782 | prevent it from being parsed as an option. For example: | |
17783 | ||
17784 | @example | |
17785 | guix system switch-generation -- -1 | |
17786 | @end example | |
17787 | ||
17788 | Currently, the effect of invoking this action is @emph{only} to switch | |
74e64724 MO |
17789 | the system profile to an existing generation and rearrange the |
17790 | bootloader menu entries. To actually start using the target system | |
17791 | generation, you must reboot after running this action. In the future, | |
17792 | it will be updated to do the same things as @command{reconfigure}, | |
17793 | like activating and deactivating services. | |
8074b330 CM |
17794 | |
17795 | This action will fail if the specified generation does not exist. | |
17796 | ||
17797 | @item roll-back | |
e32171ee | 17798 | @cindex rolling back |
8074b330 CM |
17799 | Switch to the preceding system generation. The next time the system |
17800 | boots, it will use the preceding system generation. This is the inverse | |
17801 | of @command{reconfigure}, and it is exactly the same as invoking | |
17802 | @command{switch-generation} with an argument of @code{-1}. | |
17803 | ||
17804 | Currently, as with @command{switch-generation}, you must reboot after | |
17805 | running this action to actually start using the preceding system | |
17806 | generation. | |
17807 | ||
cf4a9129 | 17808 | @item build |
1068f26b | 17809 | Build the derivation of the operating system, which includes all the |
cf4a9129 LC |
17810 | configuration files and programs needed to boot and run the system. |
17811 | This action does not actually install anything. | |
113daf62 | 17812 | |
cf4a9129 LC |
17813 | @item init |
17814 | Populate the given directory with all the files necessary to run the | |
17815 | operating system specified in @var{file}. This is useful for first-time | |
4705641f | 17816 | installations of GuixSD. For instance: |
113daf62 LC |
17817 | |
17818 | @example | |
cf4a9129 | 17819 | guix system init my-os-config.scm /mnt |
113daf62 LC |
17820 | @end example |
17821 | ||
cf4a9129 LC |
17822 | copies to @file{/mnt} all the store items required by the configuration |
17823 | specified in @file{my-os-config.scm}. This includes configuration | |
17824 | files, packages, and so on. It also creates other essential files | |
17825 | needed for the system to operate correctly---e.g., the @file{/etc}, | |
17826 | @file{/var}, and @file{/run} directories, and the @file{/bin/sh} file. | |
113daf62 | 17827 | |
045ebb3e | 17828 | This command also installs bootloader on the target specified in |
74e64724 MO |
17829 | @file{my-os-config}, unless the @option{--no-bootloader} option was |
17830 | passed. | |
113daf62 | 17831 | |
cf4a9129 LC |
17832 | @item vm |
17833 | @cindex virtual machine | |
0276f697 | 17834 | @cindex VM |
f535dcbe | 17835 | @anchor{guix system vm} |
1068f26b | 17836 | Build a virtual machine that contains the operating system declared in |
cf4a9129 | 17837 | @var{file}, and return a script to run that virtual machine (VM). |
03317cbf LC |
17838 | Arguments given to the script are passed to QEMU as in the example |
17839 | below, which enables networking and requests 1@tie{}GiB of RAM for the | |
17840 | emulated machine: | |
17841 | ||
17842 | @example | |
17843 | $ /gnu/store/@dots{}-run-vm.sh -m 1024 -net user | |
17844 | @end example | |
113daf62 | 17845 | |
cf4a9129 | 17846 | The VM shares its store with the host system. |
113daf62 | 17847 | |
0276f697 LC |
17848 | Additional file systems can be shared between the host and the VM using |
17849 | the @code{--share} and @code{--expose} command-line options: the former | |
17850 | specifies a directory to be shared with write access, while the latter | |
17851 | provides read-only access to the shared directory. | |
17852 | ||
17853 | The example below creates a VM in which the user's home directory is | |
17854 | accessible read-only, and where the @file{/exchange} directory is a | |
1068f26b | 17855 | read-write mapping of @file{$HOME/tmp} on the host: |
0276f697 LC |
17856 | |
17857 | @example | |
17858 | guix system vm my-config.scm \ | |
17859 | --expose=$HOME --share=$HOME/tmp=/exchange | |
17860 | @end example | |
17861 | ||
6aa260af LC |
17862 | On GNU/Linux, the default is to boot directly to the kernel; this has |
17863 | the advantage of requiring only a very tiny root disk image since the | |
1068f26b | 17864 | store of the host can then be mounted. |
6aa260af LC |
17865 | |
17866 | The @code{--full-boot} option forces a complete boot sequence, starting | |
17867 | with the bootloader. This requires more disk space since a root image | |
17868 | containing at least the kernel, initrd, and bootloader data files must | |
17869 | be created. The @code{--image-size} option can be used to specify the | |
1068f26b | 17870 | size of the image. |
ab11f0be | 17871 | |
cf4a9129 LC |
17872 | @item vm-image |
17873 | @itemx disk-image | |
17874 | Return a virtual machine or disk image of the operating system declared | |
a8ac4f08 LC |
17875 | in @var{file} that stands alone. By default, @command{guix system} |
17876 | estimates the size of the image needed to store the system, but you can | |
17877 | use the @option{--image-size} option to specify a value. | |
113daf62 | 17878 | |
3f4d8a7f | 17879 | You can specify the root file system type by using the |
3b6e7d86 | 17880 | @option{--file-system-type} option. It defaults to @code{ext4}. |
3f4d8a7f | 17881 | |
cf4a9129 | 17882 | When using @code{vm-image}, the returned image is in qcow2 format, which |
97d76250 LF |
17883 | the QEMU emulator can efficiently use. @xref{Running GuixSD in a VM}, |
17884 | for more information on how to run the image in a virtual machine. | |
113daf62 | 17885 | |
cf4a9129 LC |
17886 | When using @code{disk-image}, a raw disk image is produced; it can be |
17887 | copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is | |
1068f26b | 17888 | the device corresponding to a USB stick, one can copy the image to it |
cf4a9129 | 17889 | using the following command: |
113daf62 | 17890 | |
cf4a9129 LC |
17891 | @example |
17892 | # dd if=$(guix system disk-image my-os.scm) of=/dev/sdc | |
17893 | @end example | |
113daf62 | 17894 | |
1c8a81b1 DT |
17895 | @item container |
17896 | Return a script to run the operating system declared in @var{file} | |
17897 | within a container. Containers are a set of lightweight isolation | |
17898 | mechanisms provided by the kernel Linux-libre. Containers are | |
17899 | substantially less resource-demanding than full virtual machines since | |
17900 | the kernel, shared objects, and other resources can be shared with the | |
17901 | host system; this also means they provide thinner isolation. | |
17902 | ||
17903 | Currently, the script must be run as root in order to support more than | |
17904 | a single user and group. The container shares its store with the host | |
17905 | system. | |
17906 | ||
17907 | As with the @code{vm} action (@pxref{guix system vm}), additional file | |
17908 | systems to be shared between the host and container can be specified | |
17909 | using the @option{--share} and @option{--expose} options: | |
17910 | ||
17911 | @example | |
17912 | guix system container my-config.scm \ | |
17913 | --expose=$HOME --share=$HOME/tmp=/exchange | |
17914 | @end example | |
17915 | ||
0f252e26 | 17916 | @quotation Note |
cfd35b4e | 17917 | This option requires Linux-libre 3.19 or newer. |
0f252e26 DT |
17918 | @end quotation |
17919 | ||
cf4a9129 | 17920 | @end table |
113daf62 | 17921 | |
ccd7158d LC |
17922 | @var{options} can contain any of the common build options (@pxref{Common |
17923 | Build Options}). In addition, @var{options} can contain one of the | |
17924 | following: | |
113daf62 | 17925 | |
cf4a9129 LC |
17926 | @table @option |
17927 | @item --system=@var{system} | |
17928 | @itemx -s @var{system} | |
1068f26b | 17929 | Attempt to build for @var{system} instead of the host system type. |
cf4a9129 | 17930 | This works as per @command{guix build} (@pxref{Invoking guix build}). |
113daf62 | 17931 | |
f3f427c2 LC |
17932 | @item --derivation |
17933 | @itemx -d | |
17934 | Return the derivation file name of the given operating system without | |
17935 | building anything. | |
17936 | ||
3f4d8a7f DM |
17937 | @item --file-system-type=@var{type} |
17938 | @itemx -t @var{type} | |
17939 | For the @code{disk-image} action, create a file system of the given | |
17940 | @var{type} on the image. | |
17941 | ||
17942 | When this option is omitted, @command{guix system} uses @code{ext4}. | |
17943 | ||
17944 | @cindex ISO-9660 format | |
17945 | @cindex CD image format | |
17946 | @cindex DVD image format | |
17947 | @code{--file-system-type=iso9660} produces an ISO-9660 image, suitable | |
17948 | for burning on CDs and DVDs. | |
17949 | ||
cf4a9129 LC |
17950 | @item --image-size=@var{size} |
17951 | For the @code{vm-image} and @code{disk-image} actions, create an image | |
17952 | of the given @var{size}. @var{size} may be a number of bytes, or it may | |
4a44d7bb LC |
17953 | include a unit as a suffix (@pxref{Block size, size specifications,, |
17954 | coreutils, GNU Coreutils}). | |
db030303 | 17955 | |
a8ac4f08 LC |
17956 | When this option is omitted, @command{guix system} computes an estimate |
17957 | of the image size as a function of the size of the system declared in | |
17958 | @var{file}. | |
17959 | ||
5ea69d9a CM |
17960 | @item --root=@var{file} |
17961 | @itemx -r @var{file} | |
17962 | Make @var{file} a symlink to the result, and register it as a garbage | |
17963 | collector root. | |
17964 | ||
db030303 LC |
17965 | @item --on-error=@var{strategy} |
17966 | Apply @var{strategy} when an error occurs when reading @var{file}. | |
17967 | @var{strategy} may be one of the following: | |
17968 | ||
17969 | @table @code | |
17970 | @item nothing-special | |
17971 | Report the error concisely and exit. This is the default strategy. | |
17972 | ||
17973 | @item backtrace | |
17974 | Likewise, but also display a backtrace. | |
17975 | ||
17976 | @item debug | |
17977 | Report the error and enter Guile's debugger. From there, you can run | |
17978 | commands such as @code{,bt} to get a backtrace, @code{,locals} to | |
1068f26b AE |
17979 | display local variable values, and more generally inspect the state of the |
17980 | program. @xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for | |
db030303 LC |
17981 | a list of available debugging commands. |
17982 | @end table | |
113daf62 | 17983 | @end table |
113daf62 | 17984 | |
eca69fc0 LC |
17985 | @quotation Note |
17986 | All the actions above, except @code{build} and @code{init}, | |
17987 | can use KVM support in the Linux-libre kernel. Specifically, if the | |
17988 | machine has hardware virtualization support, the corresponding | |
cf4a9129 | 17989 | KVM kernel module should be loaded, and the @file{/dev/kvm} device node |
1068f26b | 17990 | must exist and be readable and writable by the user and by the |
eca69fc0 LC |
17991 | build users of the daemon (@pxref{Build Environment Setup}). |
17992 | @end quotation | |
8451a568 | 17993 | |
65797bff LC |
17994 | Once you have built, configured, re-configured, and re-re-configured |
17995 | your GuixSD installation, you may find it useful to list the operating | |
17996 | system generations available on disk---and that you can choose from the | |
74e64724 | 17997 | bootloader boot menu: |
65797bff LC |
17998 | |
17999 | @table @code | |
18000 | ||
18001 | @item list-generations | |
18002 | List a summary of each generation of the operating system available on | |
18003 | disk, in a human-readable way. This is similar to the | |
18004 | @option{--list-generations} option of @command{guix package} | |
18005 | (@pxref{Invoking guix package}). | |
18006 | ||
18007 | Optionally, one can specify a pattern, with the same syntax that is used | |
18008 | in @command{guix package --list-generations}, to restrict the list of | |
18009 | generations displayed. For instance, the following command displays | |
1068f26b | 18010 | generations that are up to 10 days old: |
65797bff LC |
18011 | |
18012 | @example | |
18013 | $ guix system list-generations 10d | |
18014 | @end example | |
18015 | ||
18016 | @end table | |
18017 | ||
d6c3267a LC |
18018 | The @command{guix system} command has even more to offer! The following |
18019 | sub-commands allow you to visualize how your system services relate to | |
18020 | each other: | |
18021 | ||
18022 | @anchor{system-extension-graph} | |
18023 | @table @code | |
18024 | ||
18025 | @item extension-graph | |
18026 | Emit in Dot/Graphviz format to standard output the @dfn{service | |
18027 | extension graph} of the operating system defined in @var{file} | |
18028 | (@pxref{Service Composition}, for more information on service | |
18029 | extensions.) | |
18030 | ||
18031 | The command: | |
18032 | ||
18033 | @example | |
18034 | $ guix system extension-graph @var{file} | dot -Tpdf > services.pdf | |
18035 | @end example | |
18036 | ||
18037 | produces a PDF file showing the extension relations among services. | |
18038 | ||
710fa231 AK |
18039 | @anchor{system-shepherd-graph} |
18040 | @item shepherd-graph | |
6f305ea5 | 18041 | Emit in Dot/Graphviz format to standard output the @dfn{dependency |
dd17bc38 AK |
18042 | graph} of shepherd services of the operating system defined in |
18043 | @var{file}. @xref{Shepherd Services}, for more information and for an | |
18044 | example graph. | |
6f305ea5 | 18045 | |
d6c3267a LC |
18046 | @end table |
18047 | ||
97d76250 | 18048 | @node Running GuixSD in a VM |
70ac09a5 | 18049 | @subsection Running GuixSD in a Virtual Machine |
97d76250 | 18050 | |
e32171ee | 18051 | @cindex virtual machine |
4b236c88 LF |
18052 | To run GuixSD in a virtual machine (VM), one can either use the |
18053 | pre-built GuixSD VM image distributed at | |
18054 | @indicateurl{ftp://alpha.gnu.org/guix/guixsd-vm-image-@value{VERSION}.@var{system}.tar.xz} | |
18055 | , or build their own virtual machine image using @command{guix system | |
18056 | vm-image} (@pxref{Invoking guix system}). The returned image is in | |
18057 | qcow2 format, which the @uref{http://qemu.org/, QEMU emulator} can | |
18058 | efficiently use. | |
97d76250 | 18059 | |
e32171ee | 18060 | @cindex QEMU |
4b236c88 LF |
18061 | If you built your own image, you must copy it out of the store |
18062 | (@pxref{The Store}) and give yourself permission to write to the copy | |
18063 | before you can use it. When invoking QEMU, you must choose a system | |
18064 | emulator that is suitable for your hardware platform. Here is a minimal | |
18065 | QEMU invocation that will boot the result of @command{guix system | |
18066 | vm-image} on x86_64 hardware: | |
97d76250 LF |
18067 | |
18068 | @example | |
18069 | $ qemu-system-x86_64 \ | |
18070 | -net user -net nic,model=virtio \ | |
18071 | -enable-kvm -m 256 /tmp/qemu-image | |
18072 | @end example | |
18073 | ||
18074 | Here is what each of these options means: | |
18075 | ||
18076 | @table @code | |
18077 | @item qemu-system-x86_64 | |
18078 | This specifies the hardware platform to emulate. This should match the | |
18079 | host. | |
18080 | ||
18081 | @item -net user | |
18082 | Enable the unprivileged user-mode network stack. The guest OS can | |
18083 | access the host but not vice versa. This is the simplest way to get the | |
58806e6f | 18084 | guest OS online. |
97d76250 LF |
18085 | |
18086 | @item -net nic,model=virtio | |
1068f26b | 18087 | You must create a network interface of a given model. If you do not |
97d76250 LF |
18088 | create a NIC, the boot will fail. Assuming your hardware platform is |
18089 | x86_64, you can get a list of available NIC models by running | |
18090 | @command{qemu-system-x86_64 -net nic,model=help}. | |
18091 | ||
18092 | @item -enable-kvm | |
18093 | If your system has hardware virtualization extensions, enabling the | |
1068f26b | 18094 | virtual machine support (KVM) of the Linux kernel will make things run |
97d76250 LF |
18095 | faster. |
18096 | ||
18097 | @item -m 256 | |
18098 | RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, | |
7414de0a | 18099 | which may be insufficient for some operations. |
97d76250 LF |
18100 | |
18101 | @item /tmp/qemu-image | |
18102 | The file name of the qcow2 image. | |
18103 | @end table | |
d6c3267a | 18104 | |
9fc221b5 | 18105 | The default @command{run-vm.sh} script that is returned by an invocation of |
3ddc50db DC |
18106 | @command{guix system vm} does not add a @command{-net user} flag by default. |
18107 | To get network access from within the vm add the @code{(dhcp-client-service)} | |
18108 | to your system definition and start the VM using | |
18109 | @command{`guix system vm config.scm` -net user}. An important caveat of using | |
18110 | @command{-net user} for networking is that @command{ping} will not work, because | |
18111 | it uses the ICMP protocol. You'll have to use a different command to check for | |
4100698d | 18112 | network connectivity, for example @command{guix download}. |
3ddc50db DC |
18113 | |
18114 | @subsubsection Connecting Through SSH | |
18115 | ||
e32171ee JD |
18116 | @cindex SSH |
18117 | @cindex SSH server | |
3ddc50db DC |
18118 | To enable SSH inside a VM you need to add a SSH server like @code{(dropbear-service)} |
18119 | or @code{(lsh-service)} to your VM. The @code{(lsh-service}) doesn't currently | |
18120 | boot unsupervised. It requires you to type some characters to initialize the | |
18121 | randomness generator. In addition you need to forward the SSH port, 22 by | |
18122 | default, to the host. You can do this with | |
18123 | ||
18124 | @example | |
18125 | `guix system vm config.scm` -net user,hostfwd=tcp::10022-:22 | |
18126 | @end example | |
18127 | ||
18128 | To connect to the VM you can run | |
18129 | ||
18130 | @example | |
18131 | ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 | |
18132 | @end example | |
18133 | ||
18134 | The @command{-p} tells @command{ssh} the port you want to connect to. | |
18135 | @command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from complaining | |
18136 | every time you modify your @command{config.scm} file and the | |
18137 | @command{-o StrictHostKeyChecking=no} prevents you from having to allow a | |
18138 | connection to an unknown host every time you connect. | |
18139 | ||
18140 | @subsubsection Using @command{virt-viewer} with Spice | |
18141 | ||
18142 | As an alternative to the default @command{qemu} graphical client you can | |
18143 | use the @command{remote-viewer} from the @command{virt-viewer} package. To | |
18144 | connect pass the @command{-spice port=5930,disable-ticketing} flag to | |
18145 | @command{qemu}. See previous section for further information on how to do this. | |
18146 | ||
18147 | Spice also allows you to do some nice stuff like share your clipboard with your | |
18148 | VM. To enable that you'll also have to pass the following flags to @command{qemu}: | |
18149 | ||
18150 | @example | |
18151 | -device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5 | |
18152 | -chardev spicevmc,name=vdagent,id=vdagent | |
18153 | -device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent, | |
18154 | name=com.redhat.spice.0 | |
18155 | @end example | |
18156 | ||
18157 | You'll also need to add the @pxref{Miscellaneous Services, Spice service}. | |
18158 | ||
cf4a9129 LC |
18159 | @node Defining Services |
18160 | @subsection Defining Services | |
8451a568 | 18161 | |
eb524192 | 18162 | The previous sections show the available services and how one can combine |
0adfe95a LC |
18163 | them in an @code{operating-system} declaration. But how do we define |
18164 | them in the first place? And what is a service anyway? | |
8451a568 | 18165 | |
0adfe95a LC |
18166 | @menu |
18167 | * Service Composition:: The model for composing services. | |
18168 | * Service Types and Services:: Types and services. | |
18169 | * Service Reference:: API reference. | |
dd17bc38 | 18170 | * Shepherd Services:: A particular type of service. |
0adfe95a LC |
18171 | @end menu |
18172 | ||
18173 | @node Service Composition | |
18174 | @subsubsection Service Composition | |
18175 | ||
18176 | @cindex services | |
18177 | @cindex daemons | |
18178 | Here we define a @dfn{service} as, broadly, something that extends the | |
1068f26b | 18179 | functionality of the operating system. Often a service is a process---a |
0adfe95a LC |
18180 | @dfn{daemon}---started when the system boots: a secure shell server, a |
18181 | Web server, the Guix build daemon, etc. Sometimes a service is a daemon | |
18182 | whose execution can be triggered by another daemon---e.g., an FTP server | |
18183 | started by @command{inetd} or a D-Bus service activated by | |
18184 | @command{dbus-daemon}. Occasionally, a service does not map to a | |
18185 | daemon. For instance, the ``account'' service collects user accounts | |
18186 | and makes sure they exist when the system runs; the ``udev'' service | |
18187 | collects device management rules and makes them available to the eudev | |
1068f26b AE |
18188 | daemon; the @file{/etc} service populates the @file{/etc} directory |
18189 | of the system. | |
0adfe95a | 18190 | |
d6c3267a | 18191 | @cindex service extensions |
0adfe95a | 18192 | GuixSD services are connected by @dfn{extensions}. For instance, the |
1068f26b | 18193 | secure shell service @emph{extends} the Shepherd---the GuixSD |
dd17bc38 AK |
18194 | initialization system, running as PID@tie{}1---by giving it the command |
18195 | lines to start and stop the secure shell daemon (@pxref{Networking | |
18196 | Services, @code{lsh-service}}); the UPower service extends the D-Bus | |
18197 | service by passing it its @file{.service} specification, and extends the | |
18198 | udev service by passing it device management rules (@pxref{Desktop | |
18199 | Services, @code{upower-service}}); the Guix daemon service extends the | |
18200 | Shepherd by passing it the command lines to start and stop the daemon, | |
18201 | and extends the account service by passing it a list of required build | |
18202 | user accounts (@pxref{Base Services}). | |
0adfe95a LC |
18203 | |
18204 | All in all, services and their ``extends'' relations form a directed | |
18205 | acyclic graph (DAG). If we represent services as boxes and extensions | |
18206 | as arrows, a typical system might provide something like this: | |
18207 | ||
18208 | @image{images/service-graph,,5in,Typical service extension graph.} | |
18209 | ||
d62e201c LC |
18210 | @cindex system service |
18211 | At the bottom, we see the @dfn{system service}, which produces the | |
18212 | directory containing everything to run and boot the system, as returned | |
18213 | by the @command{guix system build} command. @xref{Service Reference}, | |
18214 | to learn about the other service types shown here. | |
d6c3267a LC |
18215 | @xref{system-extension-graph, the @command{guix system extension-graph} |
18216 | command}, for information on how to generate this representation for a | |
18217 | particular operating system definition. | |
0adfe95a LC |
18218 | |
18219 | @cindex service types | |
18220 | Technically, developers can define @dfn{service types} to express these | |
18221 | relations. There can be any number of services of a given type on the | |
18222 | system---for instance, a system running two instances of the GNU secure | |
18223 | shell server (lsh) has two instances of @var{lsh-service-type}, with | |
18224 | different parameters. | |
18225 | ||
18226 | The following section describes the programming interface for service | |
18227 | types and services. | |
18228 | ||
18229 | @node Service Types and Services | |
18230 | @subsubsection Service Types and Services | |
18231 | ||
18232 | A @dfn{service type} is a node in the DAG described above. Let us start | |
18233 | with a simple example, the service type for the Guix build daemon | |
18234 | (@pxref{Invoking guix-daemon}): | |
18235 | ||
18236 | @example | |
18237 | (define guix-service-type | |
18238 | (service-type | |
18239 | (name 'guix) | |
18240 | (extensions | |
d4053c71 | 18241 | (list (service-extension shepherd-root-service-type guix-shepherd-service) |
0adfe95a | 18242 | (service-extension account-service-type guix-accounts) |
1bb895ea LC |
18243 | (service-extension activation-service-type guix-activation))) |
18244 | (default-value (guix-configuration)))) | |
0adfe95a | 18245 | @end example |
8451a568 | 18246 | |
cf4a9129 | 18247 | @noindent |
1bb895ea | 18248 | It defines three things: |
0adfe95a LC |
18249 | |
18250 | @enumerate | |
18251 | @item | |
18252 | A name, whose sole purpose is to make inspection and debugging easier. | |
18253 | ||
18254 | @item | |
18255 | A list of @dfn{service extensions}, where each extension designates the | |
1068f26b AE |
18256 | target service type and a procedure that, given the parameters of the |
18257 | service, returns a list of objects to extend the service of that type. | |
0adfe95a LC |
18258 | |
18259 | Every service type has at least one service extension. The only | |
18260 | exception is the @dfn{boot service type}, which is the ultimate service. | |
1bb895ea LC |
18261 | |
18262 | @item | |
18263 | Optionally, a default value for instances of this type. | |
0adfe95a LC |
18264 | @end enumerate |
18265 | ||
18266 | In this example, @var{guix-service-type} extends three services: | |
18267 | ||
18268 | @table @var | |
d4053c71 AK |
18269 | @item shepherd-root-service-type |
18270 | The @var{guix-shepherd-service} procedure defines how the Shepherd | |
18271 | service is extended. Namely, it returns a @code{<shepherd-service>} | |
18272 | object that defines how @command{guix-daemon} is started and stopped | |
18273 | (@pxref{Shepherd Services}). | |
0adfe95a LC |
18274 | |
18275 | @item account-service-type | |
18276 | This extension for this service is computed by @var{guix-accounts}, | |
18277 | which returns a list of @code{user-group} and @code{user-account} | |
18278 | objects representing the build user accounts (@pxref{Invoking | |
18279 | guix-daemon}). | |
18280 | ||
18281 | @item activation-service-type | |
18282 | Here @var{guix-activation} is a procedure that returns a gexp, which is | |
18283 | a code snippet to run at ``activation time''---e.g., when the service is | |
18284 | booted. | |
18285 | @end table | |
18286 | ||
18287 | A service of this type is instantiated like this: | |
18288 | ||
18289 | @example | |
18290 | (service guix-service-type | |
18291 | (guix-configuration | |
18292 | (build-accounts 5) | |
18293 | (use-substitutes? #f))) | |
18294 | @end example | |
18295 | ||
18296 | The second argument to the @code{service} form is a value representing | |
18297 | the parameters of this specific service instance. | |
18298 | @xref{guix-configuration-type, @code{guix-configuration}}, for | |
1bb895ea LC |
18299 | information about the @code{guix-configuration} data type. When the |
18300 | value is omitted, the default value specified by | |
18301 | @code{guix-service-type} is used: | |
18302 | ||
18303 | @example | |
18304 | (service guix-service-type) | |
18305 | @end example | |
0adfe95a LC |
18306 | |
18307 | @var{guix-service-type} is quite simple because it extends other | |
18308 | services but is not extensible itself. | |
18309 | ||
18310 | @c @subsubsubsection Extensible Service Types | |
18311 | ||
18312 | The service type for an @emph{extensible} service looks like this: | |
18313 | ||
18314 | @example | |
18315 | (define udev-service-type | |
18316 | (service-type (name 'udev) | |
18317 | (extensions | |
d4053c71 AK |
18318 | (list (service-extension shepherd-root-service-type |
18319 | udev-shepherd-service))) | |
0adfe95a LC |
18320 | |
18321 | (compose concatenate) ;concatenate the list of rules | |
18322 | (extend (lambda (config rules) | |
18323 | (match config | |
18324 | (($ <udev-configuration> udev initial-rules) | |
18325 | (udev-configuration | |
18326 | (udev udev) ;the udev package to use | |
18327 | (rules (append initial-rules rules))))))))) | |
18328 | @end example | |
18329 | ||
18330 | This is the service type for the | |
18331 | @uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device | |
18332 | management daemon}. Compared to the previous example, in addition to an | |
d4053c71 | 18333 | extension of @var{shepherd-root-service-type}, we see two new fields: |
0adfe95a LC |
18334 | |
18335 | @table @code | |
18336 | @item compose | |
18337 | This is the procedure to @dfn{compose} the list of extensions to | |
18338 | services of this type. | |
18339 | ||
18340 | Services can extend the udev service by passing it lists of rules; we | |
18341 | compose those extensions simply by concatenating them. | |
18342 | ||
18343 | @item extend | |
1068f26b | 18344 | This procedure defines how the value of the service is @dfn{extended} with |
0adfe95a LC |
18345 | the composition of the extensions. |
18346 | ||
18347 | Udev extensions are composed into a list of rules, but the udev service | |
18348 | value is itself a @code{<udev-configuration>} record. So here, we | |
a40424bd | 18349 | extend that record by appending the list of rules it contains to the |
0adfe95a | 18350 | list of contributed rules. |
b714395a LC |
18351 | |
18352 | @item description | |
18353 | This is a string giving an overview of the service type. The string can | |
0649321d LC |
18354 | contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The |
18355 | @command{guix system search} command searches these strings and displays | |
18356 | them (@pxref{Invoking guix system}). | |
0adfe95a LC |
18357 | @end table |
18358 | ||
18359 | There can be only one instance of an extensible service type such as | |
18360 | @var{udev-service-type}. If there were more, the | |
18361 | @code{service-extension} specifications would be ambiguous. | |
18362 | ||
18363 | Still here? The next section provides a reference of the programming | |
18364 | interface for services. | |
18365 | ||
18366 | @node Service Reference | |
18367 | @subsubsection Service Reference | |
18368 | ||
18369 | We have seen an overview of service types (@pxref{Service Types and | |
18370 | Services}). This section provides a reference on how to manipulate | |
18371 | services and service types. This interface is provided by the | |
18372 | @code{(gnu services)} module. | |
18373 | ||
1bb895ea | 18374 | @deffn {Scheme Procedure} service @var{type} [@var{value}] |
0adfe95a LC |
18375 | Return a new service of @var{type}, a @code{<service-type>} object (see |
18376 | below.) @var{value} can be any object; it represents the parameters of | |
18377 | this particular service instance. | |
1bb895ea LC |
18378 | |
18379 | When @var{value} is omitted, the default value specified by @var{type} | |
18380 | is used; if @var{type} does not specify a default value, an error is | |
18381 | raised. | |
18382 | ||
18383 | For instance, this: | |
18384 | ||
18385 | @example | |
18386 | (service openssh-service-type) | |
18387 | @end example | |
18388 | ||
18389 | @noindent | |
18390 | is equivalent to this: | |
18391 | ||
18392 | @example | |
18393 | (service openssh-service-type | |
18394 | (openssh-configuration)) | |
18395 | @end example | |
18396 | ||
18397 | In both cases the result is an instance of @code{openssh-service-type} | |
18398 | with the default configuration. | |
0adfe95a LC |
18399 | @end deffn |
18400 | ||
18401 | @deffn {Scheme Procedure} service? @var{obj} | |
18402 | Return true if @var{obj} is a service. | |
18403 | @end deffn | |
8451a568 | 18404 | |
0adfe95a LC |
18405 | @deffn {Scheme Procedure} service-kind @var{service} |
18406 | Return the type of @var{service}---i.e., a @code{<service-type>} object. | |
18407 | @end deffn | |
18408 | ||
efe7d19a | 18409 | @deffn {Scheme Procedure} service-value @var{service} |
0adfe95a LC |
18410 | Return the value associated with @var{service}. It represents its |
18411 | parameters. | |
18412 | @end deffn | |
18413 | ||
18414 | Here is an example of how a service is created and manipulated: | |
18415 | ||
18416 | @example | |
18417 | (define s | |
18418 | (service nginx-service-type | |
18419 | (nginx-configuration | |
18420 | (nginx nginx) | |
18421 | (log-directory log-directory) | |
18422 | (run-directory run-directory) | |
18423 | (file config-file)))) | |
18424 | ||
18425 | (service? s) | |
18426 | @result{} #t | |
18427 | ||
18428 | (eq? (service-kind s) nginx-service-type) | |
18429 | @result{} #t | |
18430 | @end example | |
18431 | ||
cd6f6c22 LC |
18432 | The @code{modify-services} form provides a handy way to change the |
18433 | parameters of some of the services of a list such as | |
4d343a14 | 18434 | @var{%base-services} (@pxref{Base Services, @code{%base-services}}). It |
7414de0a | 18435 | evaluates to a list of services. Of course, you could always use |
4d343a14 CM |
18436 | standard list combinators such as @code{map} and @code{fold} to do that |
18437 | (@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual}); | |
18438 | @code{modify-services} simply provides a more concise form for this | |
18439 | common pattern. | |
cd6f6c22 LC |
18440 | |
18441 | @deffn {Scheme Syntax} modify-services @var{services} @ | |
18442 | (@var{type} @var{variable} => @var{body}) @dots{} | |
18443 | ||
18444 | Modify the services listed in @var{services} according to the given | |
18445 | clauses. Each clause has the form: | |
18446 | ||
18447 | @example | |
18448 | (@var{type} @var{variable} => @var{body}) | |
18449 | @end example | |
18450 | ||
4d343a14 CM |
18451 | where @var{type} is a service type---e.g., |
18452 | @code{guix-service-type}---and @var{variable} is an identifier that is | |
18453 | bound within the @var{body} to the service parameters---e.g., a | |
18454 | @code{guix-configuration} instance---of the original service of that | |
18455 | @var{type}. | |
cd6f6c22 | 18456 | |
4d343a14 CM |
18457 | The @var{body} should evaluate to the new service parameters, which will |
18458 | be used to configure the new service. This new service will replace the | |
18459 | original in the resulting list. Because a service's service parameters | |
7414de0a | 18460 | are created using @code{define-record-type*}, you can write a succinct |
4d343a14 CM |
18461 | @var{body} that evaluates to the new service parameters by using the |
18462 | @code{inherit} feature that @code{define-record-type*} provides. | |
18463 | ||
b53daad0 | 18464 | @xref{Using the Configuration System}, for example usage. |
cd6f6c22 | 18465 | |
cd6f6c22 LC |
18466 | @end deffn |
18467 | ||
18468 | Next comes the programming interface for service types. This is | |
18469 | something you want to know when writing new service definitions, but not | |
18470 | necessarily when simply looking for ways to customize your | |
18471 | @code{operating-system} declaration. | |
18472 | ||
0adfe95a LC |
18473 | @deftp {Data Type} service-type |
18474 | @cindex service type | |
18475 | This is the representation of a @dfn{service type} (@pxref{Service Types | |
18476 | and Services}). | |
18477 | ||
18478 | @table @asis | |
18479 | @item @code{name} | |
18480 | This is a symbol, used only to simplify inspection and debugging. | |
18481 | ||
18482 | @item @code{extensions} | |
1068f26b | 18483 | A non-empty list of @code{<service-extension>} objects (see below). |
0adfe95a LC |
18484 | |
18485 | @item @code{compose} (default: @code{#f}) | |
18486 | If this is @code{#f}, then the service type denotes services that cannot | |
18487 | be extended---i.e., services that do not receive ``values'' from other | |
18488 | services. | |
18489 | ||
18490 | Otherwise, it must be a one-argument procedure. The procedure is called | |
18491 | by @code{fold-services} and is passed a list of values collected from | |
18492 | extensions. It must return a value that is a valid parameter value for | |
18493 | the service instance. | |
18494 | ||
18495 | @item @code{extend} (default: @code{#f}) | |
18496 | If this is @code{#f}, services of this type cannot be extended. | |
18497 | ||
18498 | Otherwise, it must be a two-argument procedure: @code{fold-services} | |
1068f26b | 18499 | calls it, passing it the initial value of the service as the first argument |
0adfe95a LC |
18500 | and the result of applying @code{compose} to the extension values as the |
18501 | second argument. | |
18502 | @end table | |
18503 | ||
18504 | @xref{Service Types and Services}, for examples. | |
18505 | @end deftp | |
18506 | ||
18507 | @deffn {Scheme Procedure} service-extension @var{target-type} @ | |
18508 | @var{compute} | |
18509 | Return a new extension for services of type @var{target-type}. | |
18510 | @var{compute} must be a one-argument procedure: @code{fold-services} | |
18511 | calls it, passing it the value associated with the service that provides | |
18512 | the extension; it must return a valid value for the target service. | |
18513 | @end deffn | |
18514 | ||
18515 | @deffn {Scheme Procedure} service-extension? @var{obj} | |
18516 | Return true if @var{obj} is a service extension. | |
18517 | @end deffn | |
18518 | ||
71654dfd LC |
18519 | Occasionally, you might want to simply extend an existing service. This |
18520 | involves creating a new service type and specifying the extension of | |
18521 | interest, which can be verbose; the @code{simple-service} procedure | |
18522 | provides a shorthand for this. | |
18523 | ||
18524 | @deffn {Scheme Procedure} simple-service @var{name} @var{target} @var{value} | |
18525 | Return a service that extends @var{target} with @var{value}. This works | |
18526 | by creating a singleton service type @var{name}, of which the returned | |
18527 | service is an instance. | |
18528 | ||
18529 | For example, this extends mcron (@pxref{Scheduled Job Execution}) with | |
18530 | an additional job: | |
18531 | ||
18532 | @example | |
18533 | (simple-service 'my-mcron-job mcron-service-type | |
18534 | #~(job '(next-hour (3)) "guix gc -F 2G")) | |
18535 | @end example | |
18536 | @end deffn | |
18537 | ||
0adfe95a LC |
18538 | At the core of the service abstraction lies the @code{fold-services} |
18539 | procedure, which is responsible for ``compiling'' a list of services | |
d62e201c LC |
18540 | down to a single directory that contains everything needed to boot and |
18541 | run the system---the directory shown by the @command{guix system build} | |
18542 | command (@pxref{Invoking guix system}). In essence, it propagates | |
18543 | service extensions down the service graph, updating each node parameters | |
18544 | on the way, until it reaches the root node. | |
0adfe95a LC |
18545 | |
18546 | @deffn {Scheme Procedure} fold-services @var{services} @ | |
d62e201c | 18547 | [#:target-type @var{system-service-type}] |
0adfe95a LC |
18548 | Fold @var{services} by propagating their extensions down to the root of |
18549 | type @var{target-type}; return the root service adjusted accordingly. | |
18550 | @end deffn | |
18551 | ||
18552 | Lastly, the @code{(gnu services)} module also defines several essential | |
18553 | service types, some of which are listed below. | |
18554 | ||
d62e201c LC |
18555 | @defvr {Scheme Variable} system-service-type |
18556 | This is the root of the service graph. It produces the system directory | |
18557 | as returned by the @command{guix system build} command. | |
18558 | @end defvr | |
18559 | ||
0adfe95a | 18560 | @defvr {Scheme Variable} boot-service-type |
d62e201c LC |
18561 | The type of the ``boot service'', which produces the @dfn{boot script}. |
18562 | The boot script is what the initial RAM disk runs when booting. | |
0adfe95a LC |
18563 | @end defvr |
18564 | ||
18565 | @defvr {Scheme Variable} etc-service-type | |
18566 | The type of the @file{/etc} service. This service can be extended by | |
18567 | passing it name/file tuples such as: | |
18568 | ||
18569 | @example | |
18570 | (list `("issue" ,(plain-file "issue" "Welcome!\n"))) | |
18571 | @end example | |
18572 | ||
18573 | In this example, the effect would be to add an @file{/etc/issue} file | |
18574 | pointing to the given file. | |
18575 | @end defvr | |
18576 | ||
18577 | @defvr {Scheme Variable} setuid-program-service-type | |
18578 | Type for the ``setuid-program service''. This service collects lists of | |
18579 | executable file names, passed as gexps, and adds them to the set of | |
18580 | setuid-root programs on the system (@pxref{Setuid Programs}). | |
18581 | @end defvr | |
18582 | ||
af4c3fd5 LC |
18583 | @defvr {Scheme Variable} profile-service-type |
18584 | Type of the service that populates the @dfn{system profile}---i.e., the | |
18585 | programs under @file{/run/current-system/profile}. Other services can | |
18586 | extend it by passing it lists of packages to add to the system profile. | |
18587 | @end defvr | |
18588 | ||
0adfe95a | 18589 | |
dd17bc38 AK |
18590 | @node Shepherd Services |
18591 | @subsubsection Shepherd Services | |
0adfe95a | 18592 | |
e32171ee | 18593 | @cindex shepherd services |
0adfe95a LC |
18594 | @cindex PID 1 |
18595 | @cindex init system | |
a40424bd CM |
18596 | The @code{(gnu services shepherd)} module provides a way to define |
18597 | services managed by the GNU@tie{}Shepherd, which is the GuixSD | |
18598 | initialization system---the first process that is started when the | |
1068f26b AE |
18599 | system boots, also known as PID@tie{}1 |
18600 | (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual}). | |
6f305ea5 | 18601 | |
dd17bc38 AK |
18602 | Services in the Shepherd can depend on each other. For instance, the |
18603 | SSH daemon may need to be started after the syslog daemon has been | |
18604 | started, which in turn can only happen once all the file systems have | |
18605 | been mounted. The simple operating system defined earlier (@pxref{Using | |
18606 | the Configuration System}) results in a service graph like this: | |
6f305ea5 | 18607 | |
710fa231 | 18608 | @image{images/shepherd-graph,,5in,Typical shepherd service graph.} |
6f305ea5 LC |
18609 | |
18610 | You can actually generate such a graph for any operating system | |
710fa231 AK |
18611 | definition using the @command{guix system shepherd-graph} command |
18612 | (@pxref{system-shepherd-graph, @command{guix system shepherd-graph}}). | |
6f305ea5 | 18613 | |
d4053c71 AK |
18614 | The @var{%shepherd-root-service} is a service object representing |
18615 | PID@tie{}1, of type @var{shepherd-root-service-type}; it can be extended | |
18616 | by passing it lists of @code{<shepherd-service>} objects. | |
0adfe95a | 18617 | |
d4053c71 | 18618 | @deftp {Data Type} shepherd-service |
dd17bc38 | 18619 | The data type representing a service managed by the Shepherd. |
0adfe95a LC |
18620 | |
18621 | @table @asis | |
18622 | @item @code{provision} | |
18623 | This is a list of symbols denoting what the service provides. | |
18624 | ||
dd17bc38 AK |
18625 | These are the names that may be passed to @command{herd start}, |
18626 | @command{herd status}, and similar commands (@pxref{Invoking herd,,, | |
18627 | shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the | |
18628 | @code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details. | |
0adfe95a LC |
18629 | |
18630 | @item @code{requirements} (default: @code{'()}) | |
dd17bc38 | 18631 | List of symbols denoting the Shepherd services this one depends on. |
0adfe95a LC |
18632 | |
18633 | @item @code{respawn?} (default: @code{#t}) | |
18634 | Whether to restart the service when it stops, for instance when the | |
18635 | underlying process dies. | |
18636 | ||
18637 | @item @code{start} | |
18638 | @itemx @code{stop} (default: @code{#~(const #f)}) | |
dd17bc38 AK |
18639 | The @code{start} and @code{stop} fields refer to the Shepherd's |
18640 | facilities to start and stop processes (@pxref{Service De- and | |
18641 | Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as | |
18642 | G-expressions that get expanded in the Shepherd configuration file | |
18643 | (@pxref{G-Expressions}). | |
0adfe95a LC |
18644 | |
18645 | @item @code{documentation} | |
18646 | A documentation string, as shown when running: | |
18647 | ||
18648 | @example | |
dd17bc38 | 18649 | herd doc @var{service-name} |
0adfe95a LC |
18650 | @end example |
18651 | ||
18652 | where @var{service-name} is one of the symbols in @var{provision} | |
dd17bc38 | 18653 | (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). |
fae685b9 LC |
18654 | |
18655 | @item @code{modules} (default: @var{%default-modules}) | |
18656 | This is the list of modules that must be in scope when @code{start} and | |
18657 | @code{stop} are evaluated. | |
18658 | ||
0adfe95a LC |
18659 | @end table |
18660 | @end deftp | |
18661 | ||
d4053c71 | 18662 | @defvr {Scheme Variable} shepherd-root-service-type |
dd17bc38 | 18663 | The service type for the Shepherd ``root service''---i.e., PID@tie{}1. |
0adfe95a LC |
18664 | |
18665 | This is the service type that extensions target when they want to create | |
dd17bc38 | 18666 | shepherd services (@pxref{Service Types and Services}, for an example). |
d4053c71 | 18667 | Each extension must pass a list of @code{<shepherd-service>}. |
0adfe95a LC |
18668 | @end defvr |
18669 | ||
d4053c71 | 18670 | @defvr {Scheme Variable} %shepherd-root-service |
0adfe95a LC |
18671 | This service represents PID@tie{}1. |
18672 | @end defvr | |
8451a568 | 18673 | |
8451a568 | 18674 | |
31f1f593 LC |
18675 | @node Documentation |
18676 | @section Documentation | |
18677 | ||
18678 | @cindex documentation, searching for | |
18679 | @cindex searching for documentation | |
18680 | @cindex Info, documentation format | |
18681 | @cindex man pages | |
18682 | @cindex manual pages | |
18683 | In most cases packages installed with Guix come with documentation. | |
18684 | There are two main documentation formats: ``Info'', a browseable | |
18685 | hypertext format used for GNU software, and ``manual pages'' (or ``man | |
18686 | pages''), the linear documentation format traditionally found on Unix. | |
18687 | Info manuals are accessed with the @command{info} command or with Emacs, | |
18688 | and man pages are accessed using @command{man}. | |
18689 | ||
18690 | You can look for documentation of software installed on your system by | |
18691 | keyword. For example, the following command searches for information | |
18692 | about ``TLS'' in Info manuals: | |
18693 | ||
18694 | @example | |
18695 | $ info -k TLS | |
18696 | "(emacs)Network Security" -- STARTTLS | |
18697 | "(emacs)Network Security" -- TLS | |
18698 | "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_flags | |
18699 | "(gnutls)Core TLS API" -- gnutls_certificate_set_verify_function | |
18700 | @dots{} | |
18701 | @end example | |
18702 | ||
18703 | @noindent | |
18704 | The command below searches for the same keyword in man pages: | |
18705 | ||
18706 | @example | |
18707 | $ man -k TLS | |
18708 | SSL (7) - OpenSSL SSL/TLS library | |
18709 | certtool (1) - GnuTLS certificate tool | |
18710 | @dots {} | |
18711 | @end example | |
18712 | ||
18713 | These searches are purely local to your computer so you have the | |
18714 | guarantee that documentation you find corresponds to what you have | |
18715 | actually installed, you can access it off-line, and your privacy is | |
18716 | respected. | |
18717 | ||
18718 | Once you have these results, you can view the relevant documentation by | |
18719 | running, say: | |
18720 | ||
18721 | @example | |
18722 | $ info "(gnutls)Core TLS API" | |
18723 | @end example | |
18724 | ||
18725 | @noindent | |
18726 | or: | |
18727 | ||
18728 | @example | |
18729 | $ man certtool | |
18730 | @end example | |
18731 | ||
18732 | Info manuals contain sections and indices as well as hyperlinks like | |
18733 | those found in Web pages. The @command{info} reader (@pxref{Top, Info | |
18734 | reader,, info-stnd, Stand-alone GNU Info}) and its Emacs counterpart | |
18735 | (@pxref{Misc Help,,, emacs, The GNU Emacs Manual}) provide intuitive key | |
18736 | bindings to navigate manuals. @xref{Getting Started,,, info, Info: An | |
18737 | Introduction}, for an introduction to Info navigation. | |
18738 | ||
cf4a9129 LC |
18739 | @node Installing Debugging Files |
18740 | @section Installing Debugging Files | |
8451a568 | 18741 | |
cf4a9129 LC |
18742 | @cindex debugging files |
18743 | Program binaries, as produced by the GCC compilers for instance, are | |
18744 | typically written in the ELF format, with a section containing | |
18745 | @dfn{debugging information}. Debugging information is what allows the | |
18746 | debugger, GDB, to map binary code to source code; it is required to | |
18747 | debug a compiled program in good conditions. | |
8451a568 | 18748 | |
cf4a9129 LC |
18749 | The problem with debugging information is that is takes up a fair amount |
18750 | of disk space. For example, debugging information for the GNU C Library | |
18751 | weighs in at more than 60 MiB. Thus, as a user, keeping all the | |
18752 | debugging info of all the installed programs is usually not an option. | |
18753 | Yet, space savings should not come at the cost of an impediment to | |
18754 | debugging---especially in the GNU system, which should make it easier | |
18755 | for users to exert their computing freedom (@pxref{GNU Distribution}). | |
8451a568 | 18756 | |
cf4a9129 LC |
18757 | Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a |
18758 | mechanism that allows users to get the best of both worlds: debugging | |
18759 | information can be stripped from the binaries and stored in separate | |
18760 | files. GDB is then able to load debugging information from those files, | |
18761 | when they are available (@pxref{Separate Debug Files,,, gdb, Debugging | |
18762 | with GDB}). | |
8451a568 | 18763 | |
cf4a9129 LC |
18764 | The GNU distribution takes advantage of this by storing debugging |
18765 | information in the @code{lib/debug} sub-directory of a separate package | |
18766 | output unimaginatively called @code{debug} (@pxref{Packages with | |
18767 | Multiple Outputs}). Users can choose to install the @code{debug} output | |
18768 | of a package when they need it. For instance, the following command | |
18769 | installs the debugging information for the GNU C Library and for GNU | |
18770 | Guile: | |
8451a568 LC |
18771 | |
18772 | @example | |
cf4a9129 | 18773 | guix package -i glibc:debug guile:debug |
8451a568 LC |
18774 | @end example |
18775 | ||
cf4a9129 LC |
18776 | GDB must then be told to look for debug files in the user's profile, by |
18777 | setting the @code{debug-file-directory} variable (consider setting it | |
18778 | from the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with | |
18779 | GDB}): | |
8451a568 | 18780 | |
cf4a9129 LC |
18781 | @example |
18782 | (gdb) set debug-file-directory ~/.guix-profile/lib/debug | |
18783 | @end example | |
8451a568 | 18784 | |
cf4a9129 LC |
18785 | From there on, GDB will pick up debugging information from the |
18786 | @code{.debug} files under @file{~/.guix-profile/lib/debug}. | |
8451a568 | 18787 | |
cf4a9129 LC |
18788 | In addition, you will most likely want GDB to be able to show the source |
18789 | code being debugged. To do that, you will have to unpack the source | |
18790 | code of the package of interest (obtained with @code{guix build | |
18791 | --source}, @pxref{Invoking guix build}), and to point GDB to that source | |
18792 | directory using the @code{directory} command (@pxref{Source Path, | |
18793 | @code{directory},, gdb, Debugging with GDB}). | |
8451a568 | 18794 | |
cf4a9129 LC |
18795 | @c XXX: keep me up-to-date |
18796 | The @code{debug} output mechanism in Guix is implemented by the | |
18797 | @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is | |
1068f26b AE |
18798 | opt-in---debugging information is available only for the packages |
18799 | with definitions explicitly declaring a @code{debug} output. This may be | |
18800 | changed to opt-out in the future if our build farm servers can handle | |
cf4a9129 LC |
18801 | the load. To check whether a package has a @code{debug} output, use |
18802 | @command{guix package --list-available} (@pxref{Invoking guix package}). | |
8451a568 | 18803 | |
8451a568 | 18804 | |
05962f29 LC |
18805 | @node Security Updates |
18806 | @section Security Updates | |
18807 | ||
09866b39 LC |
18808 | @cindex security updates |
18809 | @cindex security vulnerabilities | |
18810 | Occasionally, important security vulnerabilities are discovered in software | |
18811 | packages and must be patched. Guix developers try hard to keep track of | |
18812 | known vulnerabilities and to apply fixes as soon as possible in the | |
18813 | @code{master} branch of Guix (we do not yet provide a ``stable'' branch | |
18814 | containing only security updates.) The @command{guix lint} tool helps | |
18815 | developers find out about vulnerable versions of software packages in the | |
18816 | distribution: | |
18817 | ||
18818 | @smallexample | |
18819 | $ guix lint -c cve | |
e30c2be1 LC |
18820 | gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547 |
18821 | gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276 | |
18822 | gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924 | |
09866b39 LC |
18823 | @dots{} |
18824 | @end smallexample | |
18825 | ||
18826 | @xref{Invoking guix lint}, for more information. | |
18827 | ||
843858b8 | 18828 | @quotation Note |
09866b39 LC |
18829 | As of version @value{VERSION}, the feature described below is considered |
18830 | ``beta''. | |
843858b8 | 18831 | @end quotation |
05962f29 | 18832 | |
09866b39 | 18833 | Guix follows a functional |
05962f29 LC |
18834 | package management discipline (@pxref{Introduction}), which implies |
18835 | that, when a package is changed, @emph{every package that depends on it} | |
18836 | must be rebuilt. This can significantly slow down the deployment of | |
18837 | fixes in core packages such as libc or Bash, since basically the whole | |
18838 | distribution would need to be rebuilt. Using pre-built binaries helps | |
18839 | (@pxref{Substitutes}), but deployment may still take more time than | |
18840 | desired. | |
18841 | ||
18842 | @cindex grafts | |
1068f26b | 18843 | To address this, Guix implements @dfn{grafts}, a mechanism that allows |
05962f29 LC |
18844 | for fast deployment of critical updates without the costs associated |
18845 | with a whole-distribution rebuild. The idea is to rebuild only the | |
18846 | package that needs to be patched, and then to ``graft'' it onto packages | |
18847 | explicitly installed by the user and that were previously referring to | |
18848 | the original package. The cost of grafting is typically very low, and | |
18849 | order of magnitudes lower than a full rebuild of the dependency chain. | |
18850 | ||
18851 | @cindex replacements of packages, for grafts | |
18852 | For instance, suppose a security update needs to be applied to Bash. | |
18853 | Guix developers will provide a package definition for the ``fixed'' | |
18854 | Bash, say @var{bash-fixed}, in the usual way (@pxref{Defining | |
18855 | Packages}). Then, the original package definition is augmented with a | |
18856 | @code{replacement} field pointing to the package containing the bug fix: | |
18857 | ||
18858 | @example | |
18859 | (define bash | |
18860 | (package | |
18861 | (name "bash") | |
18862 | ;; @dots{} | |
18863 | (replacement bash-fixed))) | |
18864 | @end example | |
18865 | ||
c22a1324 LC |
18866 | From there on, any package depending directly or indirectly on Bash---as |
18867 | reported by @command{guix gc --requisites} (@pxref{Invoking guix | |
18868 | gc})---that is installed is automatically ``rewritten'' to refer to | |
05962f29 | 18869 | @var{bash-fixed} instead of @var{bash}. This grafting process takes |
1068f26b | 18870 | time proportional to the size of the package, usually less than a |
c22a1324 LC |
18871 | minute for an ``average'' package on a recent machine. Grafting is |
18872 | recursive: when an indirect dependency requires grafting, then grafting | |
18873 | ``propagates'' up to the package that the user is installing. | |
05962f29 | 18874 | |
57bdd79e LC |
18875 | Currently, the length of the name and version of the graft and that of |
18876 | the package it replaces (@var{bash-fixed} and @var{bash} in the example | |
18877 | above) must be equal. This restriction mostly comes from the fact that | |
18878 | grafting works by patching files, including binary files, directly. | |
05962f29 LC |
18879 | Other restrictions may apply: for instance, when adding a graft to a |
18880 | package providing a shared library, the original shared library and its | |
18881 | replacement must have the same @code{SONAME} and be binary-compatible. | |
18882 | ||
59a4dd50 LC |
18883 | The @option{--no-grafts} command-line option allows you to forcefully |
18884 | avoid grafting (@pxref{Common Build Options, @option{--no-grafts}}). | |
18885 | Thus, the command: | |
18886 | ||
18887 | @example | |
18888 | guix build bash --no-grafts | |
18889 | @end example | |
18890 | ||
18891 | @noindent | |
18892 | returns the store file name of the original Bash, whereas: | |
18893 | ||
18894 | @example | |
18895 | guix build bash | |
18896 | @end example | |
18897 | ||
18898 | @noindent | |
18899 | returns the store file name of the ``fixed'', replacement Bash. This | |
18900 | allows you to distinguish between the two variants of Bash. | |
18901 | ||
18902 | To verify which Bash your whole profile refers to, you can run | |
18903 | (@pxref{Invoking guix gc}): | |
18904 | ||
18905 | @example | |
18906 | guix gc -R `readlink -f ~/.guix-profile` | grep bash | |
18907 | @end example | |
18908 | ||
18909 | @noindent | |
18910 | @dots{} and compare the store file names that you get with those above. | |
18911 | Likewise for a complete GuixSD system generation: | |
18912 | ||
18913 | @example | |
18914 | guix gc -R `guix system build my-config.scm` | grep bash | |
18915 | @end example | |
18916 | ||
18917 | Lastly, to check which Bash running processes are using, you can use the | |
18918 | @command{lsof} command: | |
18919 | ||
18920 | @example | |
18921 | lsof | grep /gnu/store/.*bash | |
18922 | @end example | |
18923 | ||
05962f29 | 18924 | |
cf4a9129 LC |
18925 | @node Package Modules |
18926 | @section Package Modules | |
8451a568 | 18927 | |
cf4a9129 LC |
18928 | From a programming viewpoint, the package definitions of the |
18929 | GNU distribution are provided by Guile modules in the @code{(gnu packages | |
18930 | @dots{})} name space@footnote{Note that packages under the @code{(gnu | |
18931 | packages @dots{})} module name space are not necessarily ``GNU | |
18932 | packages''. This module naming scheme follows the usual Guile module | |
18933 | naming convention: @code{gnu} means that these modules are distributed | |
18934 | as part of the GNU system, and @code{packages} identifies modules that | |
18935 | define packages.} (@pxref{Modules, Guile modules,, guile, GNU Guile | |
18936 | Reference Manual}). For instance, the @code{(gnu packages emacs)} | |
18937 | module exports a variable named @code{emacs}, which is bound to a | |
18938 | @code{<package>} object (@pxref{Defining Packages}). | |
113daf62 | 18939 | |
300868ba | 18940 | The @code{(gnu packages @dots{})} module name space is |
cf4a9129 LC |
18941 | automatically scanned for packages by the command-line tools. For |
18942 | instance, when running @code{guix package -i emacs}, all the @code{(gnu | |
18943 | packages @dots{})} modules are scanned until one that exports a package | |
18944 | object whose name is @code{emacs} is found. This package search | |
18945 | facility is implemented in the @code{(gnu packages)} module. | |
113daf62 | 18946 | |
300868ba | 18947 | @cindex customization, of packages |
8689901f | 18948 | @cindex package module search path |
cf4a9129 | 18949 | Users can store package definitions in modules with different |
60142854 | 18950 | names---e.g., @code{(my-packages emacs)}@footnote{Note that the file |
c95ded7e LC |
18951 | name and module name must match. For instance, the @code{(my-packages |
18952 | emacs)} module must be stored in a @file{my-packages/emacs.scm} file | |
18953 | relative to the load path specified with @option{--load-path} or | |
18954 | @code{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, | |
18955 | guile, GNU Guile Reference Manual}, for details.}. These package definitions | |
1068f26b AE |
18956 | will not be visible by default. Users can invoke commands such as |
18957 | @command{guix package} and @command{guix build} with the | |
c95ded7e LC |
18958 | @code{-e} option so that they know where to find the package. Better |
18959 | yet, they can use the | |
300868ba | 18960 | @code{-L} option of these commands to make those modules visible |
8689901f LC |
18961 | (@pxref{Invoking guix build, @code{--load-path}}), or define the |
18962 | @code{GUIX_PACKAGE_PATH} environment variable. This environment | |
18963 | variable makes it easy to extend or customize the distribution and is | |
18964 | honored by all the user interfaces. | |
18965 | ||
18966 | @defvr {Environment Variable} GUIX_PACKAGE_PATH | |
1068f26b AE |
18967 | This is a colon-separated list of directories to search for additional |
18968 | package modules. Directories listed in this variable take precedence | |
18969 | over the own modules of the distribution. | |
8689901f | 18970 | @end defvr |
ef5dd60a | 18971 | |
cf4a9129 LC |
18972 | The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: |
18973 | each package is built based solely on other packages in the | |
18974 | distribution. The root of this dependency graph is a small set of | |
18975 | @dfn{bootstrap binaries}, provided by the @code{(gnu packages | |
18976 | bootstrap)} module. For more information on bootstrapping, | |
081145cf | 18977 | @pxref{Bootstrapping}. |
ef5dd60a | 18978 | |
cf4a9129 LC |
18979 | @node Packaging Guidelines |
18980 | @section Packaging Guidelines | |
ef5dd60a | 18981 | |
e32171ee | 18982 | @cindex packages, creating |
cf4a9129 LC |
18983 | The GNU distribution is nascent and may well lack some of your favorite |
18984 | packages. This section describes how you can help make the distribution | |
18985 | grow. @xref{Contributing}, for additional information on how you can | |
18986 | help. | |
ef5dd60a | 18987 | |
cf4a9129 LC |
18988 | Free software packages are usually distributed in the form of |
18989 | @dfn{source code tarballs}---typically @file{tar.gz} files that contain | |
18990 | all the source files. Adding a package to the distribution means | |
18991 | essentially two things: adding a @dfn{recipe} that describes how to | |
18992 | build the package, including a list of other packages required to build | |
f97c9175 | 18993 | it, and adding @dfn{package metadata} along with that recipe, such as a |
cf4a9129 | 18994 | description and licensing information. |
ef5dd60a | 18995 | |
cf4a9129 LC |
18996 | In Guix all this information is embodied in @dfn{package definitions}. |
18997 | Package definitions provide a high-level view of the package. They are | |
18998 | written using the syntax of the Scheme programming language; in fact, | |
18999 | for each package we define a variable bound to the package definition, | |
19000 | and export that variable from a module (@pxref{Package Modules}). | |
19001 | However, in-depth Scheme knowledge is @emph{not} a prerequisite for | |
19002 | creating packages. For more information on package definitions, | |
081145cf | 19003 | @pxref{Defining Packages}. |
ef5dd60a | 19004 | |
cf4a9129 LC |
19005 | Once a package definition is in place, stored in a file in the Guix |
19006 | source tree, it can be tested using the @command{guix build} command | |
19007 | (@pxref{Invoking guix build}). For example, assuming the new package is | |
c71979f4 LC |
19008 | called @code{gnew}, you may run this command from the Guix build tree |
19009 | (@pxref{Running Guix Before It Is Installed}): | |
ef5dd60a LC |
19010 | |
19011 | @example | |
cf4a9129 | 19012 | ./pre-inst-env guix build gnew --keep-failed |
ef5dd60a | 19013 | @end example |
ef5dd60a | 19014 | |
cf4a9129 LC |
19015 | Using @code{--keep-failed} makes it easier to debug build failures since |
19016 | it provides access to the failed build tree. Another useful | |
19017 | command-line option when debugging is @code{--log-file}, to access the | |
19018 | build log. | |
ef5dd60a | 19019 | |
cf4a9129 LC |
19020 | If the package is unknown to the @command{guix} command, it may be that |
19021 | the source file contains a syntax error, or lacks a @code{define-public} | |
19022 | clause to export the package variable. To figure it out, you may load | |
19023 | the module from Guile to get more information about the actual error: | |
ef5dd60a | 19024 | |
cf4a9129 LC |
19025 | @example |
19026 | ./pre-inst-env guile -c '(use-modules (gnu packages gnew))' | |
19027 | @end example | |
ef5dd60a | 19028 | |
cf4a9129 LC |
19029 | Once your package builds correctly, please send us a patch |
19030 | (@pxref{Contributing}). Well, if you need help, we will be happy to | |
19031 | help you too. Once the patch is committed in the Guix repository, the | |
19032 | new package automatically gets built on the supported platforms by | |
2b1cee21 | 19033 | @url{http://hydra.gnu.org/jobset/gnu/master, our continuous integration |
cf4a9129 | 19034 | system}. |
ef5dd60a | 19035 | |
cf4a9129 LC |
19036 | @cindex substituter |
19037 | Users can obtain the new package definition simply by running | |
19038 | @command{guix pull} (@pxref{Invoking guix pull}). When | |
19039 | @code{hydra.gnu.org} is done building the package, installing the | |
19040 | package automatically downloads binaries from there | |
19041 | (@pxref{Substitutes}). The only place where human intervention is | |
19042 | needed is to review and apply the patch. | |
ef5dd60a | 19043 | |
ef5dd60a | 19044 | |
cf4a9129 | 19045 | @menu |
ec0339cd LC |
19046 | * Software Freedom:: What may go into the distribution. |
19047 | * Package Naming:: What's in a name? | |
19048 | * Version Numbers:: When the name is not enough. | |
cbd02397 | 19049 | * Synopses and Descriptions:: Helping users find the right package. |
fb4d6f6c | 19050 | * Python Modules:: A touch of British comedy. |
ec0339cd | 19051 | * Perl Modules:: Little pearls. |
e1c963bf | 19052 | * Java Packages:: Coffee break. |
ec0339cd | 19053 | * Fonts:: Fond of fonts. |
cf4a9129 | 19054 | @end menu |
ef5dd60a | 19055 | |
cf4a9129 LC |
19056 | @node Software Freedom |
19057 | @subsection Software Freedom | |
ef5dd60a | 19058 | |
cf4a9129 | 19059 | @c Adapted from http://www.gnu.org/philosophy/philosophy.html. |
e32171ee | 19060 | @cindex free software |
cf4a9129 LC |
19061 | The GNU operating system has been developed so that users can have |
19062 | freedom in their computing. GNU is @dfn{free software}, meaning that | |
19063 | users have the @url{http://www.gnu.org/philosophy/free-sw.html,four | |
19064 | essential freedoms}: to run the program, to study and change the program | |
19065 | in source code form, to redistribute exact copies, and to distribute | |
19066 | modified versions. Packages found in the GNU distribution provide only | |
19067 | software that conveys these four freedoms. | |
c11a6eb1 | 19068 | |
cf4a9129 LC |
19069 | In addition, the GNU distribution follow the |
19070 | @url{http://www.gnu.org/distros/free-system-distribution-guidelines.html,free | |
19071 | software distribution guidelines}. Among other things, these guidelines | |
19072 | reject non-free firmware, recommendations of non-free software, and | |
19073 | discuss ways to deal with trademarks and patents. | |
ef5dd60a | 19074 | |
1068f26b AE |
19075 | Some otherwise free upstream package sources contain a small and optional |
19076 | subset that violates the above guidelines, for instance because this subset | |
19077 | is itself non-free code. When that happens, the offending items are removed | |
19078 | with appropriate patches or code snippets in the @code{origin} form of the | |
19079 | package (@pxref{Defining Packages}). This way, @code{guix | |
cf4a9129 LC |
19080 | build --source} returns the ``freed'' source rather than the unmodified |
19081 | upstream source. | |
ef5dd60a | 19082 | |
ef5dd60a | 19083 | |
cf4a9129 LC |
19084 | @node Package Naming |
19085 | @subsection Package Naming | |
ef5dd60a | 19086 | |
e32171ee | 19087 | @cindex package name |
cf4a9129 LC |
19088 | A package has actually two names associated with it: |
19089 | First, there is the name of the @emph{Scheme variable}, the one following | |
19090 | @code{define-public}. By this name, the package can be made known in the | |
19091 | Scheme code, for instance as input to another package. Second, there is | |
19092 | the string in the @code{name} field of a package definition. This name | |
19093 | is used by package management commands such as | |
19094 | @command{guix package} and @command{guix build}. | |
ef5dd60a | 19095 | |
cf4a9129 LC |
19096 | Both are usually the same and correspond to the lowercase conversion of |
19097 | the project name chosen upstream, with underscores replaced with | |
19098 | hyphens. For instance, GNUnet is available as @code{gnunet}, and | |
19099 | SDL_net as @code{sdl-net}. | |
927097ef | 19100 | |
cf4a9129 | 19101 | We do not add @code{lib} prefixes for library packages, unless these are |
081145cf | 19102 | already part of the official project name. But @pxref{Python |
cf4a9129 LC |
19103 | Modules} and @ref{Perl Modules} for special rules concerning modules for |
19104 | the Python and Perl languages. | |
927097ef | 19105 | |
1b366ee4 | 19106 | Font package names are handled differently, @pxref{Fonts}. |
7fec52b7 | 19107 | |
ef5dd60a | 19108 | |
cf4a9129 LC |
19109 | @node Version Numbers |
19110 | @subsection Version Numbers | |
ef5dd60a | 19111 | |
e32171ee | 19112 | @cindex package version |
cf4a9129 LC |
19113 | We usually package only the latest version of a given free software |
19114 | project. But sometimes, for instance for incompatible library versions, | |
19115 | two (or more) versions of the same package are needed. These require | |
19116 | different Scheme variable names. We use the name as defined | |
19117 | in @ref{Package Naming} | |
19118 | for the most recent version; previous versions use the same name, suffixed | |
19119 | by @code{-} and the smallest prefix of the version number that may | |
19120 | distinguish the two versions. | |
ef5dd60a | 19121 | |
cf4a9129 LC |
19122 | The name inside the package definition is the same for all versions of a |
19123 | package and does not contain any version number. | |
ef5dd60a | 19124 | |
cf4a9129 | 19125 | For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows: |
ef5dd60a | 19126 | |
cf4a9129 LC |
19127 | @example |
19128 | (define-public gtk+ | |
19129 | (package | |
17d8e33f ML |
19130 | (name "gtk+") |
19131 | (version "3.9.12") | |
19132 | ...)) | |
cf4a9129 LC |
19133 | (define-public gtk+-2 |
19134 | (package | |
17d8e33f ML |
19135 | (name "gtk+") |
19136 | (version "2.24.20") | |
19137 | ...)) | |
cf4a9129 LC |
19138 | @end example |
19139 | If we also wanted GTK+ 3.8.2, this would be packaged as | |
19140 | @example | |
19141 | (define-public gtk+-3.8 | |
19142 | (package | |
17d8e33f ML |
19143 | (name "gtk+") |
19144 | (version "3.8.2") | |
19145 | ...)) | |
cf4a9129 | 19146 | @end example |
ef5dd60a | 19147 | |
880d647d LC |
19148 | @c See <https://lists.gnu.org/archive/html/guix-devel/2016-01/msg00425.html>, |
19149 | @c for a discussion of what follows. | |
19150 | @cindex version number, for VCS snapshots | |
19151 | Occasionally, we package snapshots of upstream's version control system | |
19152 | (VCS) instead of formal releases. This should remain exceptional, | |
19153 | because it is up to upstream developers to clarify what the stable | |
19154 | release is. Yet, it is sometimes necessary. So, what should we put in | |
19155 | the @code{version} field? | |
19156 | ||
19157 | Clearly, we need to make the commit identifier of the VCS snapshot | |
19158 | visible in the version string, but we also need to make sure that the | |
19159 | version string is monotonically increasing so that @command{guix package | |
19160 | --upgrade} can determine which version is newer. Since commit | |
19161 | identifiers, notably with Git, are not monotonically increasing, we add | |
19162 | a revision number that we increase each time we upgrade to a newer | |
19163 | snapshot. The resulting version string looks like this: | |
19164 | ||
19165 | @example | |
19166 | 2.0.11-3.cabba9e | |
19167 | ^ ^ ^ | |
19168 | | | `-- upstream commit ID | |
19169 | | | | |
19170 | | `--- Guix package revision | |
19171 | | | |
19172 | latest upstream version | |
19173 | @end example | |
19174 | ||
19175 | It is a good idea to strip commit identifiers in the @code{version} | |
19176 | field to, say, 7 digits. It avoids an aesthetic annoyance (assuming | |
19177 | aesthetics have a role to play here) as well as problems related to OS | |
19178 | limits such as the maximum shebang length (127 bytes for the Linux | |
19179 | kernel.) It is best to use the full commit identifiers in | |
561360a5 LC |
19180 | @code{origin}s, though, to avoid ambiguities. A typical package |
19181 | definition may look like this: | |
19182 | ||
19183 | @example | |
19184 | (define my-package | |
6e42660b | 19185 | (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7") |
19186 | (revision "1")) ;Guix package revision | |
561360a5 | 19187 | (package |
6e42660b | 19188 | (version (string-append "0.9-" revision "." |
561360a5 LC |
19189 | (string-take commit 7))) |
19190 | (source (origin | |
19191 | (method git-fetch) | |
19192 | (uri (git-reference | |
19193 | (url "git://example.org/my-package.git") | |
19194 | (commit commit))) | |
19195 | (sha256 (base32 "1mbikn@dots{}")) | |
19196 | (file-name (string-append "my-package-" version | |
19197 | "-checkout")))) | |
19198 | ;; @dots{} | |
19199 | ))) | |
19200 | @end example | |
880d647d | 19201 | |
cbd02397 LC |
19202 | @node Synopses and Descriptions |
19203 | @subsection Synopses and Descriptions | |
19204 | ||
e32171ee JD |
19205 | @cindex package description |
19206 | @cindex package synopsis | |
cbd02397 LC |
19207 | As we have seen before, each package in GNU@tie{}Guix includes a |
19208 | synopsis and a description (@pxref{Defining Packages}). Synopses and | |
19209 | descriptions are important: They are what @command{guix package | |
19210 | --search} searches, and a crucial piece of information to help users | |
19211 | determine whether a given package suits their needs. Consequently, | |
19212 | packagers should pay attention to what goes into them. | |
19213 | ||
19214 | Synopses must start with a capital letter and must not end with a | |
19215 | period. They must not start with ``a'' or ``the'', which usually does | |
19216 | not bring anything; for instance, prefer ``File-frobbing tool'' over ``A | |
19217 | tool that frobs files''. The synopsis should say what the package | |
19218 | is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is | |
19219 | used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines | |
19220 | matching a pattern''. | |
19221 | ||
19222 | Keep in mind that the synopsis must be meaningful for a very wide | |
19223 | audience. For example, ``Manipulate alignments in the SAM format'' | |
19224 | might make sense for a seasoned bioinformatics researcher, but might be | |
19225 | fairly unhelpful or even misleading to a non-specialized audience. It | |
19226 | is a good idea to come up with a synopsis that gives an idea of the | |
19227 | application domain of the package. In this example, this might give | |
19228 | something like ``Manipulate nucleotide sequence alignments'', which | |
19229 | hopefully gives the user a better idea of whether this is what they are | |
19230 | looking for. | |
19231 | ||
cbd02397 LC |
19232 | Descriptions should take between five and ten lines. Use full |
19233 | sentences, and avoid using acronyms without first introducing them. | |
762e54b7 LC |
19234 | Please avoid marketing phrases such as ``world-leading'', |
19235 | ``industrial-strength'', and ``next-generation'', and avoid superlatives | |
19236 | like ``the most advanced''---they are not helpful to users looking for a | |
19237 | package and may even sound suspicious. Instead, try to be factual, | |
19238 | mentioning use cases and features. | |
19239 | ||
19240 | @cindex Texinfo markup, in package descriptions | |
cbd02397 LC |
19241 | Descriptions can include Texinfo markup, which is useful to introduce |
19242 | ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or | |
ba7d6c76 ML |
19243 | hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you |
19244 | should be careful when using some characters for example @samp{@@} and | |
19245 | curly braces which are the basic special characters in Texinfo | |
19246 | (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces | |
19247 | such as @command{guix package --show} take care of rendering it | |
19248 | appropriately. | |
cbd02397 LC |
19249 | |
19250 | Synopses and descriptions are translated by volunteers | |
19251 | @uref{http://translationproject.org/domain/guix-packages.html, at the | |
19252 | Translation Project} so that as many users as possible can read them in | |
19253 | their native language. User interfaces search them and display them in | |
19254 | the language specified by the current locale. | |
19255 | ||
e797e94b LC |
19256 | To allow @command{xgettext} to extract them as translatable strings, |
19257 | synopses and descriptions @emph{must be literal strings}. This means | |
19258 | that you cannot use @code{string-append} or @code{format} to construct | |
19259 | these strings: | |
19260 | ||
19261 | @lisp | |
19262 | (package | |
19263 | ;; @dots{} | |
19264 | (synopsis "This is translatable") | |
19265 | (description (string-append "This is " "*not*" " translatable."))) | |
19266 | @end lisp | |
19267 | ||
cbd02397 LC |
19268 | Translation is a lot of work so, as a packager, please pay even more |
19269 | attention to your synopses and descriptions as every change may entail | |
ba7d6c76 | 19270 | additional work for translators. In order to help them, it is possible |
36743e71 | 19271 | to make recommendations or instructions visible to them by inserting |
ba7d6c76 ML |
19272 | special comments like this (@pxref{xgettext Invocation,,, gettext, GNU |
19273 | Gettext}): | |
19274 | ||
19275 | @example | |
19276 | ;; TRANSLATORS: "X11 resize-and-rotate" should not be translated. | |
19277 | (description "ARandR is designed to provide a simple visual front end | |
19278 | for the X11 resize-and-rotate (RandR) extension. @dots{}") | |
19279 | @end example | |
cbd02397 | 19280 | |
ef5dd60a | 19281 | |
cf4a9129 LC |
19282 | @node Python Modules |
19283 | @subsection Python Modules | |
ef5dd60a | 19284 | |
e32171ee | 19285 | @cindex python |
cf4a9129 LC |
19286 | We currently package Python 2 and Python 3, under the Scheme variable names |
19287 | @code{python-2} and @code{python} as explained in @ref{Version Numbers}. | |
19288 | To avoid confusion and naming clashes with other programming languages, it | |
19289 | seems desirable that the name of a package for a Python module contains | |
19290 | the word @code{python}. | |
ef5dd60a | 19291 | |
cf4a9129 LC |
19292 | Some modules are compatible with only one version of Python, others with both. |
19293 | If the package Foo compiles only with Python 3, we name it | |
19294 | @code{python-foo}; if it compiles only with Python 2, we name it | |
19295 | @code{python2-foo}. If it is compatible with both versions, we create two | |
19296 | packages with the corresponding names. | |
ef5dd60a | 19297 | |
cf4a9129 LC |
19298 | If a project already contains the word @code{python}, we drop this; |
19299 | for instance, the module python-dateutil is packaged under the names | |
99c866a0 HG |
19300 | @code{python-dateutil} and @code{python2-dateutil}. If the project name |
19301 | starts with @code{py} (e.g. @code{pytz}), we keep it and prefix it as | |
19302 | described above. | |
113daf62 | 19303 | |
e940a271 HG |
19304 | @subsubsection Specifying Dependencies |
19305 | @cindex inputs, for Python packages | |
19306 | ||
19307 | Dependency information for Python packages is usually available in the | |
19308 | package source tree, with varying degrees of accuracy: in the | |
19309 | @file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}. | |
19310 | ||
19311 | Your mission, when writing a recipe for a Python package, is to map | |
19312 | these dependencies to the appropriate type of ``input'' (@pxref{package | |
19313 | Reference, inputs}). Although the @code{pypi} importer normally does a | |
19314 | good job (@pxref{Invoking guix import}), you may want to check the | |
19315 | following check list to determine which dependency goes where. | |
19316 | ||
19317 | @itemize | |
19318 | ||
aaf75c89 HG |
19319 | @item |
19320 | We currently package Python 2 with @code{setuptools} and @code{pip} | |
19321 | installed like Python 3.4 has per default. Thus you don't need to | |
891a843d HG |
19322 | specify either of these as an input. @command{guix lint} will warn you |
19323 | if you do. | |
aaf75c89 | 19324 | |
e940a271 HG |
19325 | @item |
19326 | Python dependencies required at run time go into | |
19327 | @code{propagated-inputs}. They are typically defined with the | |
19328 | @code{install_requires} keyword in @file{setup.py}, or in the | |
19329 | @file{requirements.txt} file. | |
19330 | ||
19331 | @item | |
19332 | Python packages required only at build time---e.g., those listed with | |
19333 | the @code{setup_requires} keyword in @file{setup.py}---or only for | |
19334 | testing---e.g., those in @code{tests_require}---go into | |
19335 | @code{native-inputs}. The rationale is that (1) they do not need to be | |
19336 | propagated because they are not needed at run time, and (2) in a | |
19337 | cross-compilation context, it's the ``native'' input that we'd want. | |
19338 | ||
aaf75c89 | 19339 | Examples are the @code{pytest}, @code{mock}, and @code{nose} test |
e940a271 HG |
19340 | frameworks. Of course if any of these packages is also required at |
19341 | run-time, it needs to go to @code{propagated-inputs}. | |
19342 | ||
19343 | @item | |
19344 | Anything that does not fall in the previous categories goes to | |
19345 | @code{inputs}, for example programs or C libraries required for building | |
19346 | Python packages containing C extensions. | |
19347 | ||
19348 | @item | |
19349 | If a Python package has optional dependencies (@code{extras_require}), | |
19350 | it is up to you to decide whether to add them or not, based on their | |
19351 | usefulness/overhead ratio (@pxref{Submitting Patches, @command{guix | |
19352 | size}}). | |
19353 | ||
19354 | @end itemize | |
19355 | ||
19356 | ||
cf4a9129 LC |
19357 | @node Perl Modules |
19358 | @subsection Perl Modules | |
523e4896 | 19359 | |
e32171ee | 19360 | @cindex perl |
cf4a9129 LC |
19361 | Perl programs standing for themselves are named as any other package, |
19362 | using the lowercase upstream name. | |
19363 | For Perl packages containing a single class, we use the lowercase class name, | |
19364 | replace all occurrences of @code{::} by dashes and prepend the prefix | |
19365 | @code{perl-}. | |
19366 | So the class @code{XML::Parser} becomes @code{perl-xml-parser}. | |
19367 | Modules containing several classes keep their lowercase upstream name and | |
19368 | are also prepended by @code{perl-}. Such modules tend to have the word | |
19369 | @code{perl} somewhere in their name, which gets dropped in favor of the | |
19370 | prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}. | |
523e4896 | 19371 | |
523e4896 | 19372 | |
e1c963bf HG |
19373 | @node Java Packages |
19374 | @subsection Java Packages | |
19375 | ||
e32171ee | 19376 | @cindex java |
e1c963bf HG |
19377 | Java programs standing for themselves are named as any other package, |
19378 | using the lowercase upstream name. | |
19379 | ||
19380 | To avoid confusion and naming clashes with other programming languages, | |
19381 | it is desirable that the name of a package for a Java package is | |
19382 | prefixed with @code{java-}. If a project already contains the word | |
19383 | @code{java}, we drop this; for instance, the package @code{ngsjava} is | |
19384 | packaged under the name @code{java-ngs}. | |
19385 | ||
19386 | For Java packages containing a single class or a small class hierarchy, | |
19387 | we use the lowercase class name, replace all occurrences of @code{.} by | |
19388 | dashes and prepend the prefix @code{java-}. So the class | |
19389 | @code{apache.commons.cli} becomes package | |
19390 | @code{java-apache-commons-cli}. | |
19391 | ||
19392 | ||
7fec52b7 AE |
19393 | @node Fonts |
19394 | @subsection Fonts | |
19395 | ||
e32171ee | 19396 | @cindex fonts |
7fec52b7 AE |
19397 | For fonts that are in general not installed by a user for typesetting |
19398 | purposes, or that are distributed as part of a larger software package, | |
19399 | we rely on the general packaging rules for software; for instance, this | |
19400 | applies to the fonts delivered as part of the X.Org system or fonts that | |
19401 | are part of TeX Live. | |
19402 | ||
19403 | To make it easier for a user to search for fonts, names for other packages | |
19404 | containing only fonts are constructed as follows, independently of the | |
19405 | upstream package name. | |
19406 | ||
19407 | The name of a package containing only one font family starts with | |
19408 | @code{font-}; it is followed by the foundry name and a dash @code{-} | |
19409 | if the foundry is known, and the font family name, in which spaces are | |
19410 | replaced by dashes (and as usual, all upper case letters are transformed | |
19411 | to lower case). | |
19412 | For example, the Gentium font family by SIL is packaged under the name | |
19413 | @code{font-sil-gentium}. | |
19414 | ||
19415 | For a package containing several font families, the name of the collection | |
19416 | is used in the place of the font family name. | |
19417 | For instance, the Liberation fonts consist of three families, | |
19418 | Liberation Sans, Liberation Serif and Liberation Mono. | |
19419 | These could be packaged separately under the names | |
19420 | @code{font-liberation-sans} and so on; but as they are distributed together | |
19421 | under a common name, we prefer to package them together as | |
19422 | @code{font-liberation}. | |
19423 | ||
19424 | In the case where several formats of the same font family or font collection | |
19425 | are packaged separately, a short form of the format, prepended by a dash, | |
19426 | is added to the package name. We use @code{-ttf} for TrueType fonts, | |
1b366ee4 | 19427 | @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 |
7fec52b7 AE |
19428 | fonts. |
19429 | ||
19430 | ||
b25937e3 | 19431 | |
cf4a9129 LC |
19432 | @node Bootstrapping |
19433 | @section Bootstrapping | |
b25937e3 | 19434 | |
cf4a9129 | 19435 | @c Adapted from the ELS 2013 paper. |
b25937e3 | 19436 | |
cf4a9129 | 19437 | @cindex bootstrapping |
7889394e | 19438 | |
cf4a9129 LC |
19439 | Bootstrapping in our context refers to how the distribution gets built |
19440 | ``from nothing''. Remember that the build environment of a derivation | |
19441 | contains nothing but its declared inputs (@pxref{Introduction}). So | |
19442 | there's an obvious chicken-and-egg problem: how does the first package | |
19443 | get built? How does the first compiler get compiled? Note that this is | |
19444 | a question of interest only to the curious hacker, not to the regular | |
19445 | user, so you can shamelessly skip this section if you consider yourself | |
19446 | a ``regular user''. | |
72b9d60d | 19447 | |
cf4a9129 LC |
19448 | @cindex bootstrap binaries |
19449 | The GNU system is primarily made of C code, with libc at its core. The | |
19450 | GNU build system itself assumes the availability of a Bourne shell and | |
19451 | command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and | |
19452 | `grep'. Furthermore, build programs---programs that run | |
19453 | @code{./configure}, @code{make}, etc.---are written in Guile Scheme | |
19454 | (@pxref{Derivations}). Consequently, to be able to build anything at | |
19455 | all, from scratch, Guix relies on pre-built binaries of Guile, GCC, | |
19456 | Binutils, libc, and the other packages mentioned above---the | |
19457 | @dfn{bootstrap binaries}. | |
72b9d60d | 19458 | |
cf4a9129 LC |
19459 | These bootstrap binaries are ``taken for granted'', though we can also |
19460 | re-create them if needed (more on that later). | |
72b9d60d | 19461 | |
cf4a9129 | 19462 | @unnumberedsubsec Preparing to Use the Bootstrap Binaries |
c79d54fe | 19463 | |
cf4a9129 LC |
19464 | @c As of Emacs 24.3, Info-mode displays the image, but since it's a |
19465 | @c large image, it's hard to scroll. Oh well. | |
19466 | @image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations} | |
523e4896 | 19467 | |
cf4a9129 LC |
19468 | The figure above shows the very beginning of the dependency graph of the |
19469 | distribution, corresponding to the package definitions of the @code{(gnu | |
d33fa0c7 LC |
19470 | packages bootstrap)} module. A similar figure can be generated with |
19471 | @command{guix graph} (@pxref{Invoking guix graph}), along the lines of: | |
19472 | ||
19473 | @example | |
19474 | guix graph -t derivation \ | |
19475 | -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \ | |
19476 | | dot -Tps > t.ps | |
19477 | @end example | |
19478 | ||
19479 | At this level of detail, things are | |
cf4a9129 LC |
19480 | slightly complex. First, Guile itself consists of an ELF executable, |
19481 | along with many source and compiled Scheme files that are dynamically | |
19482 | loaded when it runs. This gets stored in the @file{guile-2.0.7.tar.xz} | |
19483 | tarball shown in this graph. This tarball is part of Guix's ``source'' | |
19484 | distribution, and gets inserted into the store with @code{add-to-store} | |
19485 | (@pxref{The Store}). | |
2e7b5cea | 19486 | |
cf4a9129 LC |
19487 | But how do we write a derivation that unpacks this tarball and adds it |
19488 | to the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} | |
19489 | derivation---the first one that gets built---uses @code{bash} as its | |
19490 | builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls | |
19491 | @code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, | |
19492 | @file{xz}, and @file{mkdir} are statically-linked binaries, also part of | |
19493 | the Guix source distribution, whose sole purpose is to allow the Guile | |
19494 | tarball to be unpacked. | |
fb729425 | 19495 | |
cf4a9129 LC |
19496 | Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning |
19497 | Guile that can be used to run subsequent build programs. Its first task | |
19498 | is to download tarballs containing the other pre-built binaries---this | |
19499 | is what the @code{.tar.xz.drv} derivations do. Guix modules such as | |
19500 | @code{ftp-client.scm} are used for this purpose. The | |
19501 | @code{module-import.drv} derivations import those modules in a directory | |
19502 | in the store, using the original layout. The | |
19503 | @code{module-import-compiled.drv} derivations compile those modules, and | |
19504 | write them in an output directory with the right layout. This | |
19505 | corresponds to the @code{#:modules} argument of | |
19506 | @code{build-expression->derivation} (@pxref{Derivations}). | |
fb729425 | 19507 | |
cf4a9129 LC |
19508 | Finally, the various tarballs are unpacked by the |
19509 | derivations @code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, | |
19510 | etc., at which point we have a working C tool chain. | |
fb729425 | 19511 | |
fb729425 | 19512 | |
cf4a9129 | 19513 | @unnumberedsubsec Building the Build Tools |
523e4896 | 19514 | |
cf4a9129 LC |
19515 | Bootstrapping is complete when we have a full tool chain that does not |
19516 | depend on the pre-built bootstrap tools discussed above. This | |
19517 | no-dependency requirement is verified by checking whether the files of | |
19518 | the final tool chain contain references to the @file{/gnu/store} | |
19519 | directories of the bootstrap inputs. The process that leads to this | |
19520 | ``final'' tool chain is described by the package definitions found in | |
1f6f57df | 19521 | the @code{(gnu packages commencement)} module. |
df2ce343 | 19522 | |
d33fa0c7 LC |
19523 | The @command{guix graph} command allows us to ``zoom out'' compared to |
19524 | the graph above, by looking at the level of package objects instead of | |
19525 | individual derivations---remember that a package may translate to | |
19526 | several derivations, typically one derivation to download its source, | |
19527 | one to build the Guile modules it needs, and one to actually build the | |
19528 | package from source. The command: | |
19529 | ||
19530 | @example | |
19531 | guix graph -t bag \ | |
19532 | -e '(@@@@ (gnu packages commencement) | |
19533 | glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps | |
19534 | @end example | |
19535 | ||
19536 | @noindent | |
19537 | produces the dependency graph leading to the ``final'' C | |
19538 | library@footnote{You may notice the @code{glibc-intermediate} label, | |
19539 | suggesting that it is not @emph{quite} final, but as a good | |
19540 | approximation, we will consider it final.}, depicted below. | |
19541 | ||
19542 | @image{images/bootstrap-packages,6in,,Dependency graph of the early packages} | |
19543 | ||
cf4a9129 LC |
19544 | @c See <http://lists.gnu.org/archive/html/gnu-system-discuss/2012-10/msg00000.html>. |
19545 | The first tool that gets built with the bootstrap binaries is | |
d33fa0c7 LC |
19546 | GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite |
19547 | for all the following packages. From there Findutils and Diffutils get | |
19548 | built. | |
523e4896 | 19549 | |
cf4a9129 LC |
19550 | Then come the first-stage Binutils and GCC, built as pseudo cross |
19551 | tools---i.e., with @code{--target} equal to @code{--host}. They are | |
19552 | used to build libc. Thanks to this cross-build trick, this libc is | |
19553 | guaranteed not to hold any reference to the initial tool chain. | |
4af2447e | 19554 | |
d33fa0c7 LC |
19555 | From there the final Binutils and GCC (not shown above) are built. |
19556 | GCC uses @code{ld} | |
cf4a9129 LC |
19557 | from the final Binutils, and links programs against the just-built libc. |
19558 | This tool chain is used to build the other packages used by Guix and by | |
19559 | the GNU Build System: Guile, Bash, Coreutils, etc. | |
4af2447e | 19560 | |
cf4a9129 LC |
19561 | And voilà! At this point we have the complete set of build tools that |
19562 | the GNU Build System expects. These are in the @code{%final-inputs} | |
dd164244 MW |
19563 | variable of the @code{(gnu packages commencement)} module, and are |
19564 | implicitly used by any package that uses @code{gnu-build-system} | |
1f6f57df | 19565 | (@pxref{Build Systems, @code{gnu-build-system}}). |
4af2447e | 19566 | |
4af2447e | 19567 | |
cf4a9129 | 19568 | @unnumberedsubsec Building the Bootstrap Binaries |
4af2447e | 19569 | |
e32171ee | 19570 | @cindex bootstrap binaries |
cf4a9129 LC |
19571 | Because the final tool chain does not depend on the bootstrap binaries, |
19572 | those rarely need to be updated. Nevertheless, it is useful to have an | |
19573 | automated way to produce them, should an update occur, and this is what | |
19574 | the @code{(gnu packages make-bootstrap)} module provides. | |
4af2447e | 19575 | |
cf4a9129 LC |
19576 | The following command builds the tarballs containing the bootstrap |
19577 | binaries (Guile, Binutils, GCC, libc, and a tarball containing a mixture | |
19578 | of Coreutils and other basic command-line tools): | |
4b2615e1 | 19579 | |
cf4a9129 LC |
19580 | @example |
19581 | guix build bootstrap-tarballs | |
19582 | @end example | |
19583 | ||
19584 | The generated tarballs are those that should be referred to in the | |
19585 | @code{(gnu packages bootstrap)} module mentioned at the beginning of | |
19586 | this section. | |
19587 | ||
19588 | Still here? Then perhaps by now you've started to wonder: when do we | |
19589 | reach a fixed point? That is an interesting question! The answer is | |
19590 | unknown, but if you would like to investigate further (and have | |
19591 | significant computational and storage resources to do so), then let us | |
19592 | know. | |
19593 | ||
19594 | @node Porting | |
19595 | @section Porting to a New Platform | |
19596 | ||
19597 | As discussed above, the GNU distribution is self-contained, and | |
19598 | self-containment is achieved by relying on pre-built ``bootstrap | |
19599 | binaries'' (@pxref{Bootstrapping}). These binaries are specific to an | |
19600 | operating system kernel, CPU architecture, and application binary | |
19601 | interface (ABI). Thus, to port the distribution to a platform that is | |
19602 | not yet supported, one must build those bootstrap binaries, and update | |
19603 | the @code{(gnu packages bootstrap)} module to use them on that platform. | |
19604 | ||
19605 | Fortunately, Guix can @emph{cross compile} those bootstrap binaries. | |
19606 | When everything goes well, and assuming the GNU tool chain supports the | |
19607 | target platform, this can be as simple as running a command like this | |
19608 | one: | |
19609 | ||
19610 | @example | |
19611 | guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs | |
19612 | @end example | |
19613 | ||
1c0c417d LC |
19614 | For this to work, the @code{glibc-dynamic-linker} procedure in |
19615 | @code{(gnu packages bootstrap)} must be augmented to return the right | |
19616 | file name for libc's dynamic linker on that platform; likewise, | |
19617 | @code{system->linux-architecture} in @code{(gnu packages linux)} must be | |
19618 | taught about the new platform. | |
19619 | ||
cf4a9129 | 19620 | Once these are built, the @code{(gnu packages bootstrap)} module needs |
1c0c417d LC |
19621 | to be updated to refer to these binaries on the target platform. That |
19622 | is, the hashes and URLs of the bootstrap tarballs for the new platform | |
19623 | must be added alongside those of the currently supported platforms. The | |
19624 | bootstrap Guile tarball is treated specially: it is expected to be | |
03d0e2d2 | 19625 | available locally, and @file{gnu/local.mk} has rules do download it for |
1c0c417d LC |
19626 | the supported architectures; a rule for the new platform must be added |
19627 | as well. | |
cf4a9129 LC |
19628 | |
19629 | In practice, there may be some complications. First, it may be that the | |
19630 | extended GNU triplet that specifies an ABI (like the @code{eabi} suffix | |
19631 | above) is not recognized by all the GNU tools. Typically, glibc | |
19632 | recognizes some of these, whereas GCC uses an extra @code{--with-abi} | |
19633 | configure flag (see @code{gcc.scm} for examples of how to handle this). | |
19634 | Second, some of the required packages could fail to build for that | |
19635 | platform. Lastly, the generated binaries could be broken for some | |
19636 | reason. | |
4af2447e | 19637 | |
9bf3c1a7 | 19638 | @c ********************************************************************* |
8c01b9d0 | 19639 | @include contributing.texi |
c78bd12b | 19640 | |
568717fd LC |
19641 | @c ********************************************************************* |
19642 | @node Acknowledgments | |
19643 | @chapter Acknowledgments | |
19644 | ||
136787cb LC |
19645 | Guix is based on the @uref{http://nixos.org/nix/, Nix package manager}, |
19646 | which was designed and | |
4c7ac9aa LC |
19647 | implemented by Eelco Dolstra, with contributions from other people (see |
19648 | the @file{nix/AUTHORS} file in Guix.) Nix pioneered functional package | |
568717fd LC |
19649 | management, and promoted unprecedented features, such as transactional |
19650 | package upgrades and rollbacks, per-user profiles, and referentially | |
19651 | transparent build processes. Without this work, Guix would not exist. | |
19652 | ||
19653 | The Nix-based software distributions, Nixpkgs and NixOS, have also been | |
19654 | an inspiration for Guix. | |
19655 | ||
4c7ac9aa LC |
19656 | GNU@tie{}Guix itself is a collective work with contributions from a |
19657 | number of people. See the @file{AUTHORS} file in Guix for more | |
19658 | information on these fine people. The @file{THANKS} file lists people | |
19659 | who have helped by reporting bugs, taking care of the infrastructure, | |
19660 | providing artwork and themes, making suggestions, and more---thank you! | |
19661 | ||
19662 | ||
568717fd LC |
19663 | @c ********************************************************************* |
19664 | @node GNU Free Documentation License | |
19665 | @appendix GNU Free Documentation License | |
e32171ee | 19666 | @cindex license, GNU Free Documentation License |
568717fd LC |
19667 | @include fdl-1.3.texi |
19668 | ||
19669 | @c ********************************************************************* | |
19670 | @node Concept Index | |
19671 | @unnumbered Concept Index | |
19672 | @printindex cp | |
19673 | ||
a85b83d2 LC |
19674 | @node Programming Index |
19675 | @unnumbered Programming Index | |
19676 | @syncodeindex tp fn | |
19677 | @syncodeindex vr fn | |
568717fd LC |
19678 | @printindex fn |
19679 | ||
19680 | @bye | |
19681 | ||
19682 | @c Local Variables: | |
19683 | @c ispell-local-dictionary: "american"; | |
19684 | @c End: |