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 which will result in either a selection window (as in
165 for the destination disk or, if there is only one possible disk, will
166 automatically select it.
169 argument specifies the
171 partition scheme to apply to the disk.
176 will apply the default bootable scheme on your platform.
179 argument is also optional and specifies how to partition
181 It consists of a comma-separated list of partitions to create enclosed in
183 Each partition declaration takes the form
190 specifies the partition size to create in bytes (K, M, and G suffixes
191 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
194 keyword causes the partition to take all the remaining space on the disk.
199 filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
202 argument sets where the created partition is to be mounted in the installed
204 As an example, a typical invocation looks like:
206 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
208 Note that the list of partitions should
210 include boot partitions (e.g. EFI system partitions), which will be created automatically on whatever disk includes /.
212 A shorter invocation to use the default partitioning (as
214 would have used) on the same disk:
216 bsdinstall scriptedpart ada0
220 bsdinstall scriptedpart DEFAULT
222 Mounts the file systems previously configured by
228 .Ev BSDINSTALL_CHROOT .
230 Fetches the distributions in
233 .Ev BSDINSTALL_DISTDIR
235 .Ev BSDINSTALL_DISTSITE .
237 Verifies the checksums of the distributions listed in
239 against the distribution manifest.
241 Extracts the distributions listed in
244 .Ev BSDINSTALL_CHROOT .
246 Interactively invokes
248 in the new system to set the root user's password.
250 Interactively invokes
254 Interactively sets the time, date, and time zone of the new system.
256 Queries the user for the system daemons to begin at system startup,
257 writing the result into the new system's
260 Reads a small amount of data from
262 and stores it in a file in the new system's root directory.
264 Installs the configuration files destined for the new system, e.g.,
266 fragments generated by
268 etc.) onto the new system.
270 .Sh ENVIRONMENT VARIABLES
271 The following environment variables control various aspects of the installation
273 Many are used internally during installation and have reasonable default values
274 for most installation scenarios.
275 Others are set by various interactive user prompts, and can be usefully
276 overridden when making scripted or customized installers.
277 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
279 The directory to use for temporary files.
283 The set of distributions to install, e.g., "base.txz kernel.txz ports.txz".
286 The partitioning of the disk onto which the system is being installed.
292 section for format details. If this variable is unset, the installer will
293 use the default partitioning as in
296 .It Ev BSDINSTALL_DISTDIR
297 The directory in which the distribution files can be found (or to which they
298 should be downloaded).
300 .Dq Pa /usr/freebsd-dist
301 .It Ev BSDINSTALL_DISTSITE
302 URL from which the distribution files should be downloaded if they are not
303 already present in the directory defined by
304 .Ev BSDINSTALL_DISTDIR .
305 This should be a full path to the files, including architecture and release
313 mirror will skip that step if this variable is already defined in the
316 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
317 .It Ev BSDINSTALL_CHROOT
318 The directory into which the distribution files should be unpacked and the
319 directory at which the root file system of the new system should be mounted.
322 .It Ev BSDINSTALL_LOG
323 Path to a log file for the installation.
325 .Dq Pa $TMPDIR/bsdinstall_log
326 .It Ev BSDINSTALL_TMPETC
327 Directory where files destined for the new system's
329 will be stored until the
332 If this directory does not already exist, it will be created.
334 .Dq Pa $TMPDIR/bsdinstall_etc
335 .It Ev BSDINSTALL_TMPBOOT
336 Directory where files destined for the new system's
338 will be stored until the
341 If this directory does not already exist, it will be created.
343 .Dq Pa $TMPDIR/bsdinstall_boot
344 .It Ev ZFSBOOT_POOL_NAME
345 Name for the pool containing the base system.
348 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
349 Options to be used when creating the base system's pool.
350 Each option must be followed by the -O flag to be taken into consideration
351 or the pool will not be created due to errors using the command
354 .Dq Li "-O compress=lz4 -O atime=off"
355 .It Ev ZFSBOOT_BEROOT_NAME
356 Name for the boot environment parent dataset.
357 This is a non-mountable dataset meant to be a parent dataset where different
358 boot environment are going to be created.
361 .It Ev ZFSBOOT_BOOTFS_NAME
362 Name for the primary boot environment, which will be the default boot
363 environment for the system.
366 .It Ev ZFSBOOT_VDEV_TYPE
367 The type of pool to be created for the base system.
368 This variable can take one of this values: stripe (No redundancy),
369 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
370 raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID)
371 or raidz3 (RAID-Z3 Triple Redundancy RAID).
374 .It Ev ZFSBOOT_FORCE_4K_SECTORS
375 Indicates either the pool will use 4K or 512 sectors.
376 If this variable is not empty, 4K sectors will be used.
379 .It Ev ZFSBOOT_GELI_ENCRYPTION
380 If this variable is not empty, it will use
382 to encrypt the root pool, enabling automatically the
383 .Ev ZFSBOOT_BOOT_POOL
387 .It Ev ZFSBOOT_GELI_KEY_FILE
390 keyfile used to encrypt the pool where the base system is stored.
392 .Dq Pa /boot/encryption.key
393 .It Ev ZFSBOOT_BOOT_POOL
394 If set a separated boot pool will be created for the kernel of the
398 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
399 Options to use when creating the boot pool, when enabled (See
400 .Ev ZFSBOOT_BOOT_POOL ).
402 .It Ev ZFSBOOT_BOOT_POOL_NAME
403 Name for the optional boot pool when it is enabled, (See
404 .Ev ZFSBOOT_BOOT_POOL ).
407 .It Ev ZFSBOOT_BOOT_POOL_SIZE
408 Size of the boot pool when it is enabled (See
409 .Ev ZFSBOOT_BOOT_POOL ).
413 Disks to be used for the base system, including the boot pool.
414 This variable must only be used on a scripted installation.
417 for more information.
419 .It Ev ZFSBOOT_SWAP_SIZE
420 Size of the swap partition on each block device.
421 This variable will be passed to
423 which supports SI unit suffixes.
426 .It Ev ZFSBOOT_SWAP_ENCRYPTION
427 If set, enables the encryption of the swap partition using
430 .It Ev ZFSBOOT_SWAP_MIRROR
431 If set, enables a swap mirroring using
435 .It Ev ZFSBOOT_DATASETS
436 ZFS datasets to be created on the root zpool, it requires the
440 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
443 for more information about who to write this variable and to
444 take a look into the default value of it.
445 .It Ev ZFSBOOT_CONFIRM_LAYOUT
446 If set and the installation is interactive, allow the user to confirm
447 the layout before continuing with the installation.
453 supports unattended, or minimally-attended, installations using scripting.
454 This can be used with either modified physical installation media or with
456 installations over the network; information on preparing such media can be
458 .Sx BUILDING AUTOMATIC INSTALL MEDIA
460 Scripted installations follow an essentially identical path to interactive
461 installations, though with some minor feature differences (for example,
462 scripted installations do not support fetching of remote distribution files
463 since scripted installations normally install the same files and the distributions
464 can be added directly to the installation media).
466 scripts consist of two parts: a
470 The preamble sets up the options for the installation (how to partition the
471 disk[s], which distributions to install, etc.) and the optional second part is
472 a shell script run under
474 in the newly installed system before
477 The two parts are separated by the usual script header (#!), which also sets
478 the interpreter for the setup script.
480 A typical bsdinstall script, using the default filesystem layout and the UFS
481 filesystem, looks like this:
482 .Bd -literal -offset indent
484 DISTRIBUTIONS="kernel.txz base.txz"
487 sysrc ifconfig_DEFAULT=DHCP
488 sysrc sshd_enable=YES
492 For a scripted installation involving a ZFS pool spanning multiple disks,
493 the script instead looks like this:
494 .Bd -literal -offset indent
495 DISTRIBUTIONS="kernel.txz base.txz"
496 export ZFSBOOT_VDEV_TYPE=stripe
497 export ZFSBOOT_DISKS="ada0 ada1"
498 export nonInteractive="YES"
501 echo "ifconfig_DEFAULT=DHCP" >> /etc/rc.conf
502 echo "sshd_enable=YES" >> /etc/rc.conf
508 release media, such a script placed at
509 .Pa /etc/installerconfig
510 will be run at boot time and the system will be rebooted automatically after
511 the installation has completed.
512 This can be used for unattended network installation of new systems; see
516 The preamble consists of installer settings.
517 These control global installation parameters (see
518 .Sx ENVIRONMENT VARIABLES )
519 as well as disk partitioning.
520 The preamble is interpreted as a
522 script run at the very beginning of the install.
523 If more complicated behavior than setting these variables is desired,
524 arbitrary commands can be run here to extend the installer.
525 In addition to the variables in
526 .Sx ENVIRONMENT VARIABLES ,
529 the preamble can contain a variable
531 which is passed to the
533 target to control disk setup.
540 the preamble can contain the variable
545 If using .Cm zfsboot, the variables
548 .Ev ZFSBOOT_VDEV_TYPE
549 must be set to create the pool of disks for the base system.
550 Usually, for a mirrored booting disk, this two variables looks like this:
551 .Bd -literal -offset indent
552 ZFSBOOT_DISKS="ada0 ada1"
553 ZFSBOOT_VDEV_TYPE=mirror
556 Remember to export all the variables for the
558 command, otherwise installation will fail.
560 Following the preamble is an optional shell script, beginning with a #!
562 This script will be run at the end of the installation process inside a
564 environment in the newly installed system and can be used to set up
565 configuration files, install packages, etc.
566 Note that newly configured system services, e.g., networking have not
567 been started in the installed system at this time and only installation
568 host services are available.
572 in an installation script, the
574 partitioning tool takes the
576 variable to create the ZFS datasets on the base system.
577 This variable definition can become large if the pool contains many datasets.
578 The default value of the
581 .Bd -literal -offset indent
582 # DATASET OPTIONS (comma or space separated; or both)
584 # Boot Environment [BE] root and default boot dataset
585 /$ZFSBOOT_BEROOT_NAME mountpoint=none
586 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
588 # Compress /tmp, allow exec but not setuid
589 /tmp mountpoint=/tmp,exec=on,setuid=off
591 # Do not mount /usr so that 'base' files go to the BEROOT
592 /usr mountpoint=/usr,canmount=off
594 # Home directories separated so they are common to all BEs
595 /usr/home # NB: /home is a symlink to /usr/home
598 /usr/ports setuid=off
600 # Source tree (compressed)
603 # Create /var and friends
604 /var mountpoint=/var,canmount=off
605 /var/audit exec=off,setuid=off
606 /var/crash exec=off,setuid=off
607 /var/log exec=off,setuid=off
612 The first column is the name of the dataset to be created as part of the
613 .Ev ZFSBOOT_POOL_NAME
614 pool and the remainder of each line contains the options to be set on each dataset.
615 If multiple options are given, they can be separated by either commas or whitespace;
616 everything following a pound/hash character is ignored as a comment.
617 .Ss BUILDING AUTOMATIC INSTALL MEDIA
618 If building automatic install media, use tar to extract a release ISO:
619 .Dl mkdir release-media
620 .Dl tar xvf -C release-media FreeBSD-13.0-RELEASE-amd64-disc1.iso
622 Then place a script as above in
623 .Pa etc/installerconfig
625 This directory can then be used directly as an NFS root for
627 installations or it can be rebuilt into an ISO image using the release scripts in
628 .Pa /usr/src/release .
629 For example, on amd64:
630 .Dl sh /usr/src/release/amd64/mkisoimages.sh -b '13_0_RELEASE_AMD64_CD' output.iso release-media
637 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
638 .An Devin Teske Aq Mt dteske@FreeBSD.org
639 .An Allan Jude Aq Mt allanjude@FreeBSD.org