2 .\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org> All rights reserved.
3 .\" Copyright (c) 2018 Roberto Fernandez Cueto <roberfern@gmail.com>
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 .\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 .\" POSSIBILITY OF SUCH DAMAGE.
41 is used for installation of new systems, both for system setup from
42 installation media, e.g., CD-ROMs, and for use on live systems to prepare
47 takes a target and possible parameters of the target as arguments.
48 If invoked with no arguments, it will invoke the
50 target, which provides a standard interactive installation, invoking the
52 To perform a scripted installation,
53 these subtargets can be invoked separately by an installation script.
56 supports the following options, global to all targets:
57 .Bl -tag -width indent+
59 Provide a path for the installation log file
60 .Pq overrides Ev BSDINSTALL_LOG .
62 .Sx ENVIRONMENT VARIABLES
63 for more information on
67 Most of the following targets are only useful for scripting the installer.
68 For interactive use, most users will be interested only in the
74 .Bl -tag -width ".Cm jail Ar destination"
76 Run the standard interactive installation, including disk partitioning.
77 .It Cm jail Ar destination
78 Sets up a new chroot system at
82 Behavior is generally similar to
84 except that disk partitioning and network setup are skipped and a kernel is
85 not installed into the new system.
86 .It Cm script Ar script
87 Runs the installation script at
91 for more information on this target.
93 If the current controlling TTY is a
97 console, asks the user to set the current keymap, and saves the result to the
101 Prompts the user for a host name for the new system and saves the result to the
105 .Ev BSDINSTALL_CONFIGCURRENT
106 is set, also sets the host name of the current system.
108 Interactively configures network interfaces (first invoking
110 on wireless interfaces), saving the result to the new system's
115 .Ev BSDINSTALL_CONFIGCURRENT
116 is set, also configures the network interfaces of the current system to match.
118 Provides the installer's interactive guided disk partitioner for single-disk
122 Detects an appropriate partition and installs UEFI boot loader files.
124 Provides a ZFS-only automatic interactive disk partitioner.
127 with separate datasets for
135 Optionally can set up
139 Provides the installer's interactive manual disk partitioner with an interface
142 Supports multiple disks as well as UFS, ZFS, and FAT file systems.
143 ZFS is set up with one pool and dataset per partition.
144 .It Cm scriptedpart Ar parameters
149 but non-interactively according to the disk setup specified in
151 Each disk setup is specified by a three-part argument:
157 Multiple disk setups are separated by semicolons.
160 argument specifies the disk on which to operate (which will be erased),
163 argument specifies the
165 partition scheme to apply to the disk.
170 will apply the default bootable scheme on your platform.
173 argument is also optional and specifies how to partition
175 It consists of a comma-separated list of partitions to create enclosed in
177 Each partition declaration takes the form
184 specifies the partition size to create in bytes (K, M, and G suffixes
185 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
188 keyword causes the partition to take all the remaining space on the disk.
193 filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
196 argument sets where the created partition is to be mounted in the installed
198 As an example, a typical invocation looks like:
200 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
202 A shorter invocation to use the default partitioning (as
204 would have used) on the same disk:
206 bsdinstall scriptedpart ada0
208 Mounts the file systems previously configured by
214 .Ev BSDINSTALL_CHROOT .
216 Fetches the distributions in
219 .Ev BSDINSTALL_DISTDIR
221 .Ev BSDINSTALL_DISTSITE .
223 Verifies the checksums of the distributions listed in
225 against the distribution manifest.
227 Extracts the distributions listed in
230 .Ev BSDINSTALL_CHROOT .
232 Interactively invokes
234 in the new system to set the root user's password.
236 Interactively invokes
240 Interactively sets the time, date, and time zone of the new system.
242 Queries the user for the system daemons to begin at system startup,
243 writing the result into the new system's
246 Reads a small amount of data from
248 and stores it in a file in the new system's root directory.
250 Installs the configuration files destined for the new system, e.g.,
252 fragments generated by
254 etc.) onto the new system.
256 .Sh ENVIRONMENT VARIABLES
257 The following environment variables control various aspects of the installation
259 Many are used internally during installation and have reasonable default values
260 for most installation scenarios.
261 Others are set by various interactive user prompts, and can be usefully
262 overridden when making scripted or customized installers.
263 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
265 The directory to use for temporary files.
269 The set of distributions to install, e.g., "base.txz kernel.txz ports.txz".
272 The partitioning of the disk onto which the system is being installed.
278 section for format details.
280 .It Ev BSDINSTALL_DISTDIR
281 The directory in which the distribution files can be found (or to which they
282 should be downloaded).
284 .Dq Pa /usr/freebsd-dist
285 .It Ev BSDINSTALL_DISTSITE
286 URL from which the distribution files should be downloaded if they are not
287 already present in the directory defined by
288 .Ev BSDINSTALL_DISTDIR .
289 This should be a full path to the files, including architecture and release
297 mirror will skip that step if this variable is already defined in the
300 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
301 .It Ev BSDINSTALL_CHROOT
302 The directory into which the distribution files should be unpacked and the
303 directory at which the root file system of the new system should be mounted.
306 .It Ev BSDINSTALL_LOG
307 Path to a log file for the installation.
309 .Dq Pa $TMPDIR/bsdinstall_log
310 .It Ev BSDINSTALL_TMPETC
311 Directory where files destined for the new system's
313 will be stored until the
316 If this directory does not already exist, it will be created.
318 .Dq Pa $TMPDIR/bsdinstall_etc
319 .It Ev BSDINSTALL_TMPBOOT
320 Directory where files destined for the new system's
322 will be stored until the
325 If this directory does not already exist, it will be created.
327 .Dq Pa $TMPDIR/bsdinstall_boot
328 .It Ev ZFSBOOT_POOL_NAME
329 Name for the pool containing the base system.
332 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
333 Options to be used when creating the base system's pool.
334 Each option must be followed by the -O flag to be taken into consideration
335 or the pool will not be created due to errors using the command
338 .Dq Li "-O compress=lz4 -O atime=off"
339 .It Ev ZFSBOOT_BEROOT_NAME
340 Name for the boot environment parent dataset.
341 This is a non-mountable dataset meant to be a parent dataset where different
342 boot environment are going to be created.
345 .It Ev ZFSBOOT_BOOTFS_NAME
346 Name for the primary boot environment, which will be the default boot
347 environment for the system.
350 .It Ev ZFSBOOT_VDEV_TYPE
351 The type of pool to be created for the base system.
352 This variable can take one of this values: stripe (No redundacy),
353 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
354 raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID)
355 or raidz3 (RAID-Z3 Triple Redundancy RAID).
358 .It Ev ZFSBOOT_FORCE_4K_SECTORS
359 Indicates either the pool will use 4K or 512 sectors.
360 If this variable is not empty, 4K sectors will be used.
363 .It Ev ZFSBOOT_GELI_ENCRYPTION
364 If this variable is not empty, it will use
366 to encrypt the root pool, enabling automatically the
367 .Ev ZFSBOOT_BOOT_POOL
371 .It Ev ZFSBOOT_GELI_KEY_FILE
374 keyfile used to encrypt the pool where the base system is stored.
376 .Dq Pa /boot/encryption.key
377 .It Ev ZFSBOOT_BOOT_POOL
378 If set a separated boot pool will be created for the kernel of the
382 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
383 Options to use when creating the boot pool, when enabled (See
384 .Ev ZFSBOOT_BOOT_POOL ).
386 .It Ev ZFSBOOT_BOOT_POOL_NAME
387 Name for the optional boot pool when it is enabled, (See
388 .Ev ZFSBOOT_BOOT_POOL ).
391 .It Ev ZFSBOOT_BOOT_POOL_SIZE
392 Size of the boot pool when it is enabled (See
393 .Ev ZFSBOOT_BOOT_POOL ).
397 Disks to be used for the base system, including the boot pool.
398 This variable must only be used on a scripted installation.
401 for more information.
403 .It Ev ZFSBOOT_SWAP_SIZE
404 Size of the swap partition on each block device.
405 This variable will be passed to
407 which supports SI unit suffixes.
410 .It Ev ZFSBOOT_SWAP_ENCRYPTION
411 If set, enables the encryption of the swap partition using
414 .It Ev ZFSBOOT_SWAP_MIRROR
415 If set, enables a swap mirroring using
419 .It Ev ZFSBOOT_DATASETS
420 ZFS datasets to be created on the root zpool, it requires the
424 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
427 for more information about who to write this variable and to
428 take a look into the default value of it.
429 .It Ev ZFSBOOT_CONFIRM_LAYOUT
430 If set and the installation is interactive, allow the user to confirm
431 the layout before continuing with the installation.
437 scripts consist of two parts: a
441 The preamble sets up the options for the installation (how to partition the
442 disk[s], which distributions to install, etc.) and the optional second part is
443 a shell script run under
445 in the newly installed system before
448 The two parts are separated by the usual script header (#!), which also sets
449 the interpreter for the setup script.
451 A typical bsdinstall script looks like this:
452 .Bd -literal -offset indent
454 DISTRIBUTIONS="kernel.txz base.txz"
457 gpart bootcode -b /boot/pmbr -p /boot/gptboot -i 1 ada0
458 sysrc ifconfig_em0=DHCP
459 sysrc sshd_enable=YES
463 For a ZFS scripted installation, the script looks like this:
464 .Bd -literal -offset indent
465 DISTRIBUTIONS="kernel.txz base.txz"
466 export ZFSBOOT_VDEV_TYPE=stripe
467 export ZFSBOOT_DISKS=ada0
468 export nonInteractive="YES"
471 echo "ifconfig_em0=DHCP" >> /etc/rc.conf
472 echo "sshd_enable=YES" >> /etc/rc.conf
478 release media, such a script placed at
479 .Pa /etc/installerconfig
480 will be run at boot time and the system will be rebooted automatically after
481 the installation has completed.
482 This can be used for unattended network installation of new systems; see
486 The preamble consists of installer settings.
487 These control global installation parameters (see
488 .Sx ENVIRONMENT VARIABLES )
489 as well as disk partitioning.
490 The preamble is interpreted as a
492 script run at the very beginning of the install.
493 If more complicated behavior than setting these variables is desired,
494 arbitrary commands can be run here to extend the installer.
495 In addition to the variables in
496 .Sx ENVIRONMENT VARIABLES ,
499 the preamble can contain a variable
501 which is passed to the
503 target to control disk setup.
509 the preamble can contain the variable
513 and setting the variables
516 .Ev ZFSBOOT_VDEV_TYPE
517 to create the pool of disks for the base system.
518 Usually, for a mirrored booting disk, this two variables looks like this:
519 .Bd -literal -offset indent
520 ZFSBOOT_DISKS="ada0 ada1"
521 ZFSBOOT_VDEV_TYPE=mirror
524 Remember to export all the variables for the
526 command, otherwise it will not get set.
528 Following the preamble is an optional shell script, beginning with a #!
530 This script will be run at the end of the installation process inside a
532 environment in the newly installed system and can be used to set up
533 configuration files, install packages, etc.
534 Note that newly configured system services, e.g., networking have not
535 been started in the installed system at this time and only installation
536 host services are available.
540 partitioning takes the
542 variable to create the datasets on the base system.
543 This variable can get pretty huge if the pool contains a lot of datasets.
544 The default value of the
547 .Bd -literal -offset indent
548 # DATASET OPTIONS (comma or space separated; or both)
550 # Boot Environment [BE] root and default boot dataset
551 /$ZFSBOOT_BEROOT_NAME mountpoint=none
552 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
554 # Compress /tmp, allow exec but not setuid
555 /tmp mountpoint=/tmp,exec=on,setuid=off
557 # Do not mount /usr so that 'base' files go to the BEROOT
558 /usr mountpoint=/usr,canmount=off
560 # Home directories separated so they are common to all BEs
561 /usr/home # NB: /home is a symlink to /usr/home
564 /usr/ports setuid=off
566 # Source tree (compressed)
569 # Create /var and friends
570 /var mountpoint=/var,canmount=off
571 /var/audit exec=off,setuid=off
572 /var/crash exec=off,setuid=off
573 /var/log exec=off,setuid=off
578 The first column if the dataset to be created on the top of the
579 .Ev ZFSBOOT_POOL_NAME
580 and the rest of the columns are the options to be set on each dataset.
581 The options must be written on a coma or space separated list, or both.
582 And everything behind a pound/hash character is ignored as a comment.
589 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org