1.\"- 2.\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org> All rights reserved. 3.\" Copyright (c) 2018 Roberto Fernandez Cueto <roberfern@gmail.com> 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 13.\" 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. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd July 18, 2022 29.Dt BSDINSTALL 8 30.Os 31.Sh NAME 32.Nm bsdinstall 33.Nd system installer 34.Sh SYNOPSIS 35.Nm 36.Op Ar options 37.Op Ar target 38.Op Ar ... 39.Sh DESCRIPTION 40.Nm 41is used for installation of new systems, both for system setup from 42installation media, e.g., CD-ROMs, and for use on live systems to prepare 43VM images and jails. 44.Pp 45Much like 46.Xr make 1 , Nm 47takes a target and possible parameters of the target as arguments. 48If invoked with no arguments, it will invoke the 49.Cm auto 50target, which provides a standard interactive installation, invoking the 51others in sequence. 52To perform a scripted installation, 53these subtargets can be invoked separately by an installation script. 54.Sh OPTIONS 55.Nm 56supports the following options, global to all targets: 57.Bl -tag -width indent+ 58.It Fl D Ar file 59Provide a path for the installation log file 60.Pq overrides Ev BSDINSTALL_LOG . 61See 62.Sx ENVIRONMENT VARIABLES 63for more information on 64.Ev BSDINSTALL_LOG . 65.El 66.Sh TARGETS 67Most of the following targets are only useful for scripting the installer. 68For interactive use, most users will be interested only in the 69.Cm auto , 70.Cm jail , 71and 72.Cm script 73targets. 74.Bl -tag -width ".Cm jail Ar destination" 75.It Cm auto 76Run the standard interactive installation, including disk partitioning. 77.It Cm jail Ar destination 78Sets up a new chroot system at 79.Pa destination , 80suitable for use with 81.Xr jail 8 . 82Behavior is generally similar to 83.Cm auto , 84except that disk partitioning and network setup are skipped and a kernel is 85not installed into the new system. 86.It Cm script Ar script 87Runs the installation script at 88.Pa script . 89See 90.Sx SCRIPTING 91for more information on this target. 92.It Cm keymap 93If the current controlling TTY is a 94.Xr syscons 4 95or 96.Xr vt 4 97console, asks the user to set the current keymap, and saves the result to the 98new system's 99.Pa rc.conf . 100.It Cm hostname 101Prompts the user for a host name for the new system and saves the result to the 102new system's 103.Pa rc.conf . 104If 105.Ev BSDINSTALL_CONFIGCURRENT 106is set, also sets the host name of the current system. 107.It Cm netconfig 108Interactively configures network interfaces (first invoking 109.Cm wlanconfig 110on wireless interfaces), saving the result to the new system's 111.Pa rc.conf 112and 113.Pa resolv.conf . 114If 115.Ev BSDINSTALL_CONFIGCURRENT 116is set, also configures the network interfaces of the current system to match. 117.It Cm autopart 118Provides the installer's interactive guided disk partitioner for single-disk 119installations. 120Defaults to UFS. 121.It Cm bootconfig 122Detects an appropriate partition and installs UEFI boot loader files. 123.It Cm zfsboot 124Provides a ZFS-only automatic interactive disk partitioner. 125Creates a single 126.Ic zpool 127with separate datasets for 128.Pa /tmp , 129.Pa /usr , 130.Pa /usr/home , 131.Pa /usr/ports , 132.Pa /usr/src , 133and 134.Pa /var . 135Optionally can set up 136.Xr geli 8 137to encrypt the disk. 138.It Cm partedit 139Provides the installer's interactive manual disk partitioner with an interface 140identical to 141.Xr sade 8 . 142Supports multiple disks as well as UFS, ZFS, and FAT file systems. 143ZFS is set up with one pool and dataset per partition. 144.It Cm scriptedpart Ar parameters 145Sets up disks like 146.Cm autopart 147and 148.Cm partedit , 149but non-interactively according to the disk setup specified in 150.Ar parameters . 151Each disk setup is specified by a three-part argument: 152.Pp 153.Ar disk 154.Op Ar scheme 155.Op Ar {partitions} 156.Pp 157Multiple disk setups are separated by semicolons. 158The 159.Ar disk 160argument specifies the disk on which to operate (which will be erased), 161or the special value 162.Em DEFAULT , 163which will result in either a selection window (as in 164.Cm autopart ) 165for the destination disk or, if there is only one possible disk, will 166automatically select it. 167The 168.Ar scheme 169argument specifies the 170.Xr gpart 8 171partition scheme to apply to the disk. 172If 173.Ar scheme 174is unspecified, 175.Cm scriptedpart 176will apply the default bootable scheme on your platform. 177The 178.Ar partitions 179argument is also optional and specifies how to partition 180.Ar disk . 181It consists of a comma-separated list of partitions to create enclosed in 182curly braces. 183Each partition declaration takes the form 184.Pp 185.Ar size 186.Ar type 187.Op Ar mount point 188.Pp 189.Ar size 190specifies the partition size to create in bytes (K, M, and G suffixes 191can be appended to specify kilobytes, megabytes, and gigabytes respectively), 192while the 193.Em auto 194keyword causes the partition to take all the remaining space on the disk. 195The 196.Ar type 197option chooses the 198.Xr gpart 8 199filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap. 200The optional 201.Ar mount point 202argument sets where the created partition is to be mounted in the installed 203system. 204As an example, a typical invocation looks like: 205.Pp 206bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr } 207.Pp 208Note that the list of partitions should 209.Em not 210include boot partitions (e.g. EFI system partitions), which will be created automatically on whatever disk includes /. 211.Pp 212A shorter invocation to use the default partitioning (as 213.Cm autopart 214would have used) on the same disk: 215.Pp 216bsdinstall scriptedpart ada0 217.Pp 218or, even shorter: 219.Pp 220bsdinstall scriptedpart DEFAULT 221.It Cm mount 222Mounts the file systems previously configured by 223.Cm autopart , 224.Cm partedit , 225or 226.Cm scriptedpart 227under 228.Ev BSDINSTALL_CHROOT . 229.It Cm distfetch 230Fetches the distributions in 231.Ev DISTRIBUTIONS 232to 233.Ev BSDINSTALL_DISTDIR 234from 235.Ev BSDINSTALL_DISTSITE . 236.It Cm checksum 237Verifies the checksums of the distributions listed in 238.Ev DISTRIBUTIONS 239against the distribution manifest. 240.It Cm distextract 241Extracts the distributions listed in 242.Ev DISTRIBUTIONS 243into 244.Ev BSDINSTALL_CHROOT . 245.It Cm rootpass 246Interactively invokes 247.Xr passwd 1 248in the new system to set the root user's password. 249.It Cm adduser 250Interactively invokes 251.Xr adduser 8 252in the new system. 253.It Cm time 254Interactively sets the time, date, and time zone of the new system. 255.It Cm services 256Queries the user for the system daemons to begin at system startup, 257writing the result into the new system's 258.Pa rc.conf . 259.It Cm entropy 260Reads a small amount of data from 261.Pa /dev/random 262and stores it in a file in the new system's root directory. 263.It Cm config 264Installs the configuration files destined for the new system, e.g., 265.Xr rc.conf 5 266fragments generated by 267.Cm netconfig , 268etc.) onto the new system. 269.El 270.Sh ENVIRONMENT VARIABLES 271The following environment variables control various aspects of the installation 272process. 273Many are used internally during installation and have reasonable default values 274for most installation scenarios. 275Others are set by various interactive user prompts, and can be usefully 276overridden when making scripted or customized installers. 277.Bl -tag -width ".Ev BSDINSTALL_DISTSITE" 278.It Ev TMPDIR 279The directory to use for temporary files. 280Default: 281.Dq Pa /tmp 282.It Ev DISTRIBUTIONS 283The set of distributions to install, e.g., "base.txz kernel.txz ports.txz". 284Default: unset 285.It Ev PARTITIONS 286The partitioning of the disk onto which the system is being installed. 287See 288.Cm scriptedpart 289of 290the 291.Sx TARGETS 292section for format details. If this variable is unset, the installer will 293use the default partitioning as in 294.Cm autopart . 295Default: unset 296.It Ev BSDINSTALL_DISTDIR 297The directory in which the distribution files can be found (or to which they 298should be downloaded). 299Default: 300.Dq Pa /usr/freebsd-dist 301.It Ev BSDINSTALL_DISTSITE 302URL from which the distribution files should be downloaded if they are not 303already present in the directory defined by 304.Ev BSDINSTALL_DISTDIR . 305This should be a full path to the files, including architecture and release 306names. 307Most targets, e.g., 308.Cm auto 309and 310.Cm jail , 311that prompt for a 312.Fx 313mirror will skip that step if this variable is already defined in the 314environment. 315Example: 316.Pa https://download.freebsd.org/ftp/releases/powerpc/powerpc64/13.1-RELEASE/ 317or 318.Pa http://ftp-archive.freebsd.org/pub/FreeBSD-Archive/old-releases/amd64/12.2-RELEASE/ . 319.It Ev BSDINSTALL_CHROOT 320The directory into which the distribution files should be unpacked and the 321directory at which the root file system of the new system should be mounted. 322Default: 323.Dq Pa /mnt 324.It Ev BSDINSTALL_LOG 325Path to a log file for the installation. 326Default: 327.Dq Pa $TMPDIR/bsdinstall_log 328.It Ev BSDINSTALL_TMPETC 329Directory where files destined for the new system's 330.Pa /etc 331will be stored until the 332.Cm config 333target is executed. 334If this directory does not already exist, it will be created. 335Default: 336.Dq Pa $TMPDIR/bsdinstall_etc 337.It Ev BSDINSTALL_TMPBOOT 338Directory where files destined for the new system's 339.Pa /boot 340will be stored until the 341.Cm config 342target is executed. 343If this directory does not already exist, it will be created. 344Default: 345.Dq Pa $TMPDIR/bsdinstall_boot 346.It Ev ZFSBOOT_POOL_NAME 347Name for the pool containing the base system. 348Default: 349.Dq zroot 350.It Ev ZFSBOOT_POOL_CREATE_OPTIONS 351Options to be used when creating the base system's pool. 352Each option must be preceded by the -O flag to be taken into consideration 353or the pool will not be created due to errors using the command 354.Cm zpool . 355Default: 356.Dq Li "-O compress=lz4 -O atime=off" 357.It Ev ZFSBOOT_BEROOT_NAME 358Name for the boot environment parent dataset. 359This is a non-mountable dataset meant to be a parent dataset where different 360boot environment are going to be created. 361Default: 362.Dq ROOT 363.It Ev ZFSBOOT_BOOTFS_NAME 364Name for the primary boot environment, which will be the default boot 365environment for the system. 366Default: 367.Dq default 368.It Ev ZFSBOOT_VDEV_TYPE 369The type of pool to be created for the base system. 370This variable can take one of this values: stripe (No redundancy), 371mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors), 372raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID) 373or raidz3 (RAID-Z3 Triple Redundancy RAID). 374Default: 375.Dq stripe 376.It Ev ZFSBOOT_FORCE_4K_SECTORS 377Indicates either the pool will use 4K or 512 sectors. 378If this variable is not empty, 4K sectors will be used. 379Default: 380.Dq 1 381.It Ev ZFSBOOT_GELI_ENCRYPTION 382If this variable is not empty, it will use 383.Xr geli 8 384to encrypt the root pool, enabling automatically the 385.Ev ZFSBOOT_BOOT_POOL 386variable. 387Default: 388.Dq "" 389.It Ev ZFSBOOT_GELI_KEY_FILE 390Path to the 391.Xr geli 8 392keyfile used to encrypt the pool where the base system is stored. 393Default: 394.Dq Pa /boot/encryption.key 395.It Ev ZFSBOOT_BOOT_POOL 396If set, a separated boot pool will be created for the kernel of the 397system and 398.Xr loader 8 . 399Default: unset 400.It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS 401Options to use when creating the boot pool, when enabled (See 402.Ev ZFSBOOT_BOOT_POOL ). 403Default: unset 404.It Ev ZFSBOOT_BOOT_POOL_NAME 405Name for the optional boot pool when it is enabled, (See 406.Ev ZFSBOOT_BOOT_POOL ). 407Default: 408.Dq bootpool 409.It Ev ZFSBOOT_BOOT_POOL_SIZE 410Size of the boot pool when it is enabled (See 411.Ev ZFSBOOT_BOOT_POOL ). 412Default: 413.Dq 2g 414.It Ev ZFSBOOT_DISKS 415Disks to be used for the base system, including the boot pool. 416This variable must only be used on a scripted installation. 417See 418.Sx SCRIPTING 419for more information. 420Default: unset 421.It Ev ZFSBOOT_SWAP_SIZE 422Size of the swap partition on each block device. 423This variable will be passed to 424.Xr gpart 8 ; 425which supports SI unit suffixes. 426Default: 427.Dq 2g 428.It Ev ZFSBOOT_SWAP_ENCRYPTION 429If set, enables the encryption of the swap partition using 430.Xr geli 8 . 431Default: "" 432.It Ev ZFSBOOT_SWAP_MIRROR 433If set, enables a swap mirroring using 434.Xr gmirror 8 . 435Default: 436unset 437.It Ev ZFSBOOT_DATASETS 438ZFS datasets to be created on the root zpool, it requires the 439following datasets: 440.Pa /tmp , 441.Pa /var/tmp , 442.Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME . 443See 444.Sx ZFS DATASETS 445for more information about how to populate this variable and 446its default value. 447.It Ev ZFSBOOT_CONFIRM_LAYOUT 448If set and the installation is interactive, allow the user to confirm 449the layout before continuing with the installation. 450Default: 451.Dq 1 452.El 453.Sh SCRIPTING 454.Nm 455supports unattended, or minimally-attended, installations using scripting. 456This can be used with either modified physical installation media or with 457.Xr diskless 8 458installations over the network; information on preparing such media can be 459found in 460.Sx BUILDING AUTOMATIC INSTALL MEDIA 461.Pp 462Scripted installations follow an essentially identical path to interactive 463installations, though with some minor feature differences (for example, 464scripted installations do not support fetching of remote distribution files 465since scripted installations normally install the same files and the distributions 466can be added directly to the installation media). 467.Nm 468scripts consist of two parts: a 469.Em preamble 470and a 471.Em setup script . 472The preamble sets up the options for the installation (how to partition the 473disk[s], which distributions to install, etc.) and the optional second part is 474a shell script run under 475.Xr chroot 8 476in the newly installed system before 477.Nm 478exits. 479The two parts are separated by the usual script header (#!), which also sets 480the interpreter for the setup script. 481.Pp 482A typical bsdinstall script, using the default filesystem layout and the UFS 483filesystem, looks like this: 484.Bd -literal -offset indent 485PARTITIONS=DEFAULT 486DISTRIBUTIONS="kernel.txz base.txz" 487 488#!/bin/sh 489sysrc ifconfig_DEFAULT=DHCP 490sysrc sshd_enable=YES 491pkg install puppet 492.Ed 493.Pp 494For a scripted installation involving a ZFS pool spanning multiple disks, 495the script instead looks like this: 496.Bd -literal -offset indent 497DISTRIBUTIONS="kernel.txz base.txz" 498export ZFSBOOT_VDEV_TYPE=stripe 499export ZFSBOOT_DISKS="ada0 ada1" 500export nonInteractive="YES" 501 502#!/bin/sh 503echo "ifconfig_DEFAULT=DHCP" >> /etc/rc.conf 504echo "sshd_enable=YES" >> /etc/rc.conf 505pkg install puppet 506.Ed 507.Pp 508On 509.Fx 510release media, such a script placed at 511.Pa /etc/installerconfig 512will be run at boot time and the system will be rebooted automatically after 513the installation has completed. 514This can be used for unattended network installation of new systems; see 515.Xr diskless 8 516for details. 517.Ss PREAMBLE 518The preamble consists of installer settings. 519These control global installation parameters (see 520.Sx ENVIRONMENT VARIABLES ) 521as well as disk partitioning. 522The preamble is interpreted as a 523.Xr sh 1 524script run at the very beginning of the install. 525If more complicated behavior than setting these variables is desired, 526arbitrary commands can be run here to extend the installer. 527In addition to the variables in 528.Sx ENVIRONMENT VARIABLES , 529in particular 530.Ev DISTRIBUTIONS , 531the preamble can contain a variable 532.Ev PARTITIONS 533which is passed to the 534.Cm scriptedpart 535target to control disk setup. 536.Pp 537Alternatively, 538to use 539.Cm zfsboot 540instead of 541.Cm partedit , 542the preamble can contain the variable 543.Ev ZFSBOOT_DATASETS 544instead of 545.Ev PARTITIONS 546(see below). 547If using 548.Cm zfsboot , 549the variables 550.Ev ZFSBOOT_DISKS 551and 552.Ev ZFSBOOT_VDEV_TYPE 553must be set to create the pool of disks for the base system. 554Usually, for a mirrored booting disk, these two variables look like this: 555.Bd -literal -offset indent 556ZFSBOOT_DISKS="ada0 ada1" 557ZFSBOOT_VDEV_TYPE=mirror 558.Ed 559.Pp 560Remember to export all the variables for the 561.Cm zfsboot 562command, otherwise installation will fail. 563.Ss SETUP SCRIPT 564Following the preamble is an optional shell script, beginning with a #! 565declaration. 566This script will be run at the end of the installation process inside a 567.Xr chroot 8 568environment in the newly installed system and can be used to set up 569configuration files, install packages, etc. 570Note that newly configured system services, e.g., networking have not 571been started in the installed system at this time and only installation 572host services are available. 573.Ss ZFS DATASETS 574If using 575.Cm zfsboot 576in an installation script, the 577.Cm zfsboot 578partitioning tool takes the 579.Ev ZFSBOOT_DATASETS 580variable to create the ZFS datasets on the base system. 581This variable definition can become large if the pool contains many datasets. 582The default value of 583.Ev ZFSBOOT_DATASETS 584is: 585.Bd -literal -offset indent 586# DATASET OPTIONS (comma or space separated; or both) 587 588# Boot Environment [BE] root and default boot dataset 589/$ZFSBOOT_BEROOT_NAME mountpoint=none 590/$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/ 591 592# Compress /tmp, allow exec but not setuid 593/tmp mountpoint=/tmp,exec=on,setuid=off 594 595# Do not mount /usr so that 'base' files go to the BEROOT 596/usr mountpoint=/usr,canmount=off 597 598# Home directories separated so they are common to all BEs 599/usr/home # NB: /home is a symlink to /usr/home 600 601# Ports tree 602/usr/ports setuid=off 603 604# Source tree (compressed) 605/usr/src 606 607# Create /var and friends 608/var mountpoint=/var,canmount=off 609/var/audit exec=off,setuid=off 610/var/crash exec=off,setuid=off 611/var/log exec=off,setuid=off 612/var/mail atime=on 613/var/tmp setuid=off 614.Ed 615.Pp 616The first column is the name of the dataset to be created as part of the 617.Ev ZFSBOOT_POOL_NAME 618pool and the remainder of each line contains the options to be set on each dataset. 619If multiple options are given, they can be separated by either commas or whitespace; 620everything following a pound/hash character is ignored as a comment. 621.Ss BUILDING AUTOMATIC INSTALL MEDIA 622If building automatic install media, use tar to extract a release ISO: 623.Dl mkdir release-media 624.Dl tar -C release-media -xvf FreeBSD-13.0-RELEASE-amd64-disc1.iso 625.Pp 626Then place a script as above in 627.Pa etc/installerconfig 628.Pp 629This directory can then be used directly as an NFS root for 630.Xr diskless 8 631installations or it can be rebuilt into an ISO image using the release scripts in 632.Pa /usr/src/release . 633For example, on amd64: 634.Dl sh /usr/src/release/amd64/mkisoimages.sh -b '13_0_RELEASE_AMD64_CD' output.iso release-media 635.Sh HISTORY 636This version of 637.Nm 638first appeared in 639.Fx 9.0 . 640.Sh AUTHORS 641.An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org 642.An Devin Teske Aq Mt dteske@FreeBSD.org 643.An Allan Jude Aq Mt allanjude@FreeBSD.org 644