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 Note that the list of partitions should
204 include boot partitions (e.g. EFI system partitions), which will be created automatically on whatever disk includes /.
206 A shorter invocation to use the default partitioning (as
208 would have used) on the same disk:
210 bsdinstall scriptedpart ada0
212 Mounts the file systems previously configured by
218 .Ev BSDINSTALL_CHROOT .
220 Fetches the distributions in
223 .Ev BSDINSTALL_DISTDIR
225 .Ev BSDINSTALL_DISTSITE .
227 Verifies the checksums of the distributions listed in
229 against the distribution manifest.
231 Extracts the distributions listed in
234 .Ev BSDINSTALL_CHROOT .
236 Interactively invokes
238 in the new system to set the root user's password.
240 Interactively invokes
244 Interactively sets the time, date, and time zone of the new system.
246 Queries the user for the system daemons to begin at system startup,
247 writing the result into the new system's
250 Reads a small amount of data from
252 and stores it in a file in the new system's root directory.
254 Installs the configuration files destined for the new system, e.g.,
256 fragments generated by
258 etc.) onto the new system.
260 .Sh ENVIRONMENT VARIABLES
261 The following environment variables control various aspects of the installation
263 Many are used internally during installation and have reasonable default values
264 for most installation scenarios.
265 Others are set by various interactive user prompts, and can be usefully
266 overridden when making scripted or customized installers.
267 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
269 The directory to use for temporary files.
273 The set of distributions to install, e.g., "base.txz kernel.txz ports.txz".
276 The partitioning of the disk onto which the system is being installed.
282 section for format details.
284 .It Ev BSDINSTALL_DISTDIR
285 The directory in which the distribution files can be found (or to which they
286 should be downloaded).
288 .Dq Pa /usr/freebsd-dist
289 .It Ev BSDINSTALL_DISTSITE
290 URL from which the distribution files should be downloaded if they are not
291 already present in the directory defined by
292 .Ev BSDINSTALL_DISTDIR .
293 This should be a full path to the files, including architecture and release
301 mirror will skip that step if this variable is already defined in the
304 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
305 .It Ev BSDINSTALL_CHROOT
306 The directory into which the distribution files should be unpacked and the
307 directory at which the root file system of the new system should be mounted.
310 .It Ev BSDINSTALL_LOG
311 Path to a log file for the installation.
313 .Dq Pa $TMPDIR/bsdinstall_log
314 .It Ev BSDINSTALL_TMPETC
315 Directory where files destined for the new system's
317 will be stored until the
320 If this directory does not already exist, it will be created.
322 .Dq Pa $TMPDIR/bsdinstall_etc
323 .It Ev BSDINSTALL_TMPBOOT
324 Directory where files destined for the new system's
326 will be stored until the
329 If this directory does not already exist, it will be created.
331 .Dq Pa $TMPDIR/bsdinstall_boot
332 .It Ev ZFSBOOT_POOL_NAME
333 Name for the pool containing the base system.
336 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
337 Options to be used when creating the base system's pool.
338 Each option must be followed by the -O flag to be taken into consideration
339 or the pool will not be created due to errors using the command
342 .Dq Li "-O compress=lz4 -O atime=off"
343 .It Ev ZFSBOOT_BEROOT_NAME
344 Name for the boot environment parent dataset.
345 This is a non-mountable dataset meant to be a parent dataset where different
346 boot environment are going to be created.
349 .It Ev ZFSBOOT_BOOTFS_NAME
350 Name for the primary boot environment, which will be the default boot
351 environment for the system.
354 .It Ev ZFSBOOT_VDEV_TYPE
355 The type of pool to be created for the base system.
356 This variable can take one of this values: stripe (No redundancy),
357 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
358 raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID)
359 or raidz3 (RAID-Z3 Triple Redundancy RAID).
362 .It Ev ZFSBOOT_FORCE_4K_SECTORS
363 Indicates either the pool will use 4K or 512 sectors.
364 If this variable is not empty, 4K sectors will be used.
367 .It Ev ZFSBOOT_GELI_ENCRYPTION
368 If this variable is not empty, it will use
370 to encrypt the root pool, enabling automatically the
371 .Ev ZFSBOOT_BOOT_POOL
375 .It Ev ZFSBOOT_GELI_KEY_FILE
378 keyfile used to encrypt the pool where the base system is stored.
380 .Dq Pa /boot/encryption.key
381 .It Ev ZFSBOOT_BOOT_POOL
382 If set a separated boot pool will be created for the kernel of the
386 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
387 Options to use when creating the boot pool, when enabled (See
388 .Ev ZFSBOOT_BOOT_POOL ).
390 .It Ev ZFSBOOT_BOOT_POOL_NAME
391 Name for the optional boot pool when it is enabled, (See
392 .Ev ZFSBOOT_BOOT_POOL ).
395 .It Ev ZFSBOOT_BOOT_POOL_SIZE
396 Size of the boot pool when it is enabled (See
397 .Ev ZFSBOOT_BOOT_POOL ).
401 Disks to be used for the base system, including the boot pool.
402 This variable must only be used on a scripted installation.
405 for more information.
407 .It Ev ZFSBOOT_SWAP_SIZE
408 Size of the swap partition on each block device.
409 This variable will be passed to
411 which supports SI unit suffixes.
414 .It Ev ZFSBOOT_SWAP_ENCRYPTION
415 If set, enables the encryption of the swap partition using
418 .It Ev ZFSBOOT_SWAP_MIRROR
419 If set, enables a swap mirroring using
423 .It Ev ZFSBOOT_DATASETS
424 ZFS datasets to be created on the root zpool, it requires the
428 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
431 for more information about who to write this variable and to
432 take a look into the default value of it.
433 .It Ev ZFSBOOT_CONFIRM_LAYOUT
434 If set and the installation is interactive, allow the user to confirm
435 the layout before continuing with the installation.
441 supports unattended, or minimally-attended, installations using scripting.
442 This can be used with either modified physical installation media or with
444 installations over the network; information on preparing such media can be
446 .Sx BUILDING AUTOMATIC INSTALL MEDIA
448 Scripted installations follow an essentially identical path to interactive
449 installations, though with some minor feature differences (for example,
450 scripted installations do not support fetching of remote distribution files
451 since scripted installations normally install the same files and the distributions
452 can be added directly to the installation media).
454 scripts consist of two parts: a
458 The preamble sets up the options for the installation (how to partition the
459 disk[s], which distributions to install, etc.) and the optional second part is
460 a shell script run under
462 in the newly installed system before
465 The two parts are separated by the usual script header (#!), which also sets
466 the interpreter for the setup script.
468 A typical bsdinstall script, using the default filesystem layout and the UFS
469 filesystem, looks like this:
470 .Bd -literal -offset indent
472 DISTRIBUTIONS="kernel.txz base.txz"
475 sysrc ifconfig_DEFAULT=DHCP
476 sysrc sshd_enable=YES
480 For a scripted installation involving a ZFS pool spanning multiple disks,
481 the script instead looks like this:
482 .Bd -literal -offset indent
483 DISTRIBUTIONS="kernel.txz base.txz"
484 export ZFSBOOT_VDEV_TYPE=stripe
485 export ZFSBOOT_DISKS="ada0 ada1"
486 export nonInteractive="YES"
489 echo "ifconfig_DEFAULT=DHCP" >> /etc/rc.conf
490 echo "sshd_enable=YES" >> /etc/rc.conf
496 release media, such a script placed at
497 .Pa /etc/installerconfig
498 will be run at boot time and the system will be rebooted automatically after
499 the installation has completed.
500 This can be used for unattended network installation of new systems; see
504 The preamble consists of installer settings.
505 These control global installation parameters (see
506 .Sx ENVIRONMENT VARIABLES )
507 as well as disk partitioning.
508 The preamble is interpreted as a
510 script run at the very beginning of the install.
511 If more complicated behavior than setting these variables is desired,
512 arbitrary commands can be run here to extend the installer.
513 In addition to the variables in
514 .Sx ENVIRONMENT VARIABLES ,
517 the preamble can contain a variable
519 which is passed to the
521 target to control disk setup.
528 the preamble can contain the variable
533 If using .Cm zfsboot, the variables
536 .Ev ZFSBOOT_VDEV_TYPE
537 must be set to create the pool of disks for the base system.
538 Usually, for a mirrored booting disk, this two variables looks like this:
539 .Bd -literal -offset indent
540 ZFSBOOT_DISKS="ada0 ada1"
541 ZFSBOOT_VDEV_TYPE=mirror
544 Remember to export all the variables for the
546 command, otherwise installation will fail.
548 Following the preamble is an optional shell script, beginning with a #!
550 This script will be run at the end of the installation process inside a
552 environment in the newly installed system and can be used to set up
553 configuration files, install packages, etc.
554 Note that newly configured system services, e.g., networking have not
555 been started in the installed system at this time and only installation
556 host services are available.
560 in an installation script, the
562 partitioning tool takes the
564 variable to create the ZFS datasets on the base system.
565 This variable definition can become large if the pool contains many datasets.
566 The default value of the
569 .Bd -literal -offset indent
570 # DATASET OPTIONS (comma or space separated; or both)
572 # Boot Environment [BE] root and default boot dataset
573 /$ZFSBOOT_BEROOT_NAME mountpoint=none
574 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
576 # Compress /tmp, allow exec but not setuid
577 /tmp mountpoint=/tmp,exec=on,setuid=off
579 # Do not mount /usr so that 'base' files go to the BEROOT
580 /usr mountpoint=/usr,canmount=off
582 # Home directories separated so they are common to all BEs
583 /usr/home # NB: /home is a symlink to /usr/home
586 /usr/ports setuid=off
588 # Source tree (compressed)
591 # Create /var and friends
592 /var mountpoint=/var,canmount=off
593 /var/audit exec=off,setuid=off
594 /var/crash exec=off,setuid=off
595 /var/log exec=off,setuid=off
600 The first column is the name of the dataset to be created as part of the
601 .Ev ZFSBOOT_POOL_NAME
602 pool and the remainder of each line contains the options to be set on each dataset.
603 If multiple options are given, they can be separated by either commas or whitespace;
604 everything following a pound/hash character is ignored as a comment.
605 .Ss BUILDING AUTOMATIC INSTALL MEDIA
606 If building automatic install media, use tar to extract a release ISO:
607 .Dl mkdir release-media
608 .Dl tar xvf -C release-media FreeBSD-13.0-RELEASE-amd64-disc1.iso
610 Then place a script as above in
611 .Pa etc/installerconfig
613 This directory can then be used directly as an NFS root for
615 installations or it can be rebuilt into an ISO image using the release scripts in
616 .Pa /usr/src/release .
617 For example, on amd64:
618 .Dl sh /usr/src/release/amd64/mkisoimages.sh -b '13_0_RELEASE_AMD64_CD' output.iso release-media
625 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
626 .An Devin Teske Aq Mt dteske@FreeBSD.org
627 .An Allan Jude Aq Mt allanjude@FreeBSD.org