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 Provides an alternative ZFS-only automatic interactive disk partitioner.
125 with separate datasets for
133 Optionally can set up
137 Provides the installer's interactive manual disk partitioner with an interface
140 Supports multiple disks as well as UFS, ZFS, and FAT file systems.
141 ZFS is set up with one pool and dataset per partition.
142 .It Cm scriptedpart Ar parameters
147 but non-interactively according to the disk setup specified in
149 Each disk setup is specified by a three-part argument:
155 Multiple disk setups are separated by semicolons.
158 argument specifies the disk on which to operate (which will be erased),
161 argument specifies the
163 partition scheme to apply to the disk.
168 will apply the default bootable scheme on your platform.
171 argument is also optional and specifies how to partition
173 It consists of a comma-separated list of partitions to create enclosed in
175 Each partition declaration takes the form
182 specifies the partition size to create in bytes (K, M, and G suffixes
183 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
186 keyword causes the partition to take all the remaining space on the disk.
191 filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
194 argument sets where the created partition is to be mounted in the installed
196 As an example, a typical invocation looks like:
198 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
200 A shorter invocation to use the default partitioning (as
202 would have used) on the same disk:
204 bsdinstall scriptedpart ada0
206 Mounts the file systems previously configured by
212 .Ev BSDINSTALL_CHROOT .
214 Fetches the distributions in
217 .Ev BSDINSTALL_DISTDIR
219 .Ev BSDINSTALL_DISTSITE .
221 Verifies the checksums of the distributions listed in
223 against the distribution manifest.
225 Extracts the distributions listed in
228 .Ev BSDINSTALL_CHROOT .
230 Interactively invokes
232 in the new system to set the root user's password.
234 Interactively invokes
238 Interactively sets the time, date, and time zone of the new system.
240 Queries the user for the system daemons to begin at system startup,
241 writing the result into the new system's
244 Reads a small amount of data from
246 and stores it in a file in the new system's root directory.
248 Installs the configuration files destined for the new system, e.g.,
250 fragments generated by
252 etc.) onto the new system.
254 .Sh ENVIRONMENT VARIABLES
255 The following environment variables control various aspects of the installation
257 Many are used internally during installation and have reasonable default values
258 for most installation scenarios.
259 Others are set by various interactive user prompts, and can be usefully
260 overridden when making scripted or customized installers.
261 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
263 The set of distributions to install, e.g., "base kernel ports".
265 .It Ev BSDINSTALL_DISTDIR
266 The directory in which the distribution files can be found (or to which they
267 should be downloaded).
269 .Dq Pa /usr/freebsd-dist
270 .It Ev BSDINSTALL_DISTSITE
271 URL from which the distribution files should be downloaded if they are not
272 already present in the directory defined by
273 .Ev BSDINSTALL_DISTDIR .
274 This should be a full path to the files, including architecture and release
282 mirror will skip that step if this variable is already defined in the
285 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
286 .It Ev BSDINSTALL_CHROOT
287 The directory into which the distribution files should be unpacked and the
288 directory at which the root file system of the new system should be mounted.
291 .It Ev BSDINSTALL_LOG
292 Path to a log file for the installation.
294 .Dq Pa /tmp/bsdinstall_log
295 .It Ev BSDINSTALL_TMPETC
296 Directory where files destined for the new system's
298 will be stored until the
301 If this directory does not already exist, it will be created.
303 .Dq Pa /tmp/bsdinstall_etc
304 .It Ev BSDINSTALL_TMPBOOT
305 Directory where files destined for the new system's
307 will be stored until the
310 If this directory does not already exist, it will be created.
312 .Dq Pa /tmp/bsdinstall_boot
313 .It Ev ZFSBOOT_POOL_NAME
314 Name for the pool containing the base system.
317 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
318 Options to be used when creating the base system's pool.
319 Each option must be followed by the -O flag to be taken into consideration
320 or the pool will not be created due to errors using the command
323 .Dq Li "-O compress=lz4 -O atime=off"
324 .It Ev ZFSBOOT_BEROOT_NAME
325 Name for the boot environment parent dataset.
326 This is a non-mountable dataset meant to be a parent dataset where different
327 boot environment are going to be created.
330 .It Ev ZFSBOOT_BOOTFS_NAME
331 Name for the primary boot environment, which will be the default boot
332 environment for the system.
335 .It Ev ZFSBOOT_VDEV_TYPE
336 The type of pool to be created for the base system.
337 This variable can take one of this values: stripe (No redundacy),
338 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
339 raidz1 (RAID-Z1 - Single Redundacy RAID), raidz2 (RAID-Z2 - Double Redundacy RAID)
340 or raidz3 (RAID-Z3 Triple Redundacy RAID).
343 .It Ev ZFSBOOT_FORCE_4K_SECTORS
344 Indicates either the pool will use 4K or 512 sectors.
345 If this variable is not empty, 4K sectors will be used.
348 .It Ev ZFSBOOT_GELI_ENCRYPTION
349 If this variable is not empty, it will use
351 to encrypt the root pool, enabling automatically the
352 .Ev ZFSBOOT_BOOT_POOL
356 .It Ev ZFSBOOT_GELI_KEY_FILE
359 keyfile used to encrypt the pool where the base system is stored.
361 .Dq Pa /boot/encryption.key
362 .It Ev ZFSBOOT_BOOT_POOL
363 If set a separated boot pool will be created for the kernel of the
367 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
368 Options to use when creating the boot pool, when enabled (See
369 .Ev ZFSBOOT_BOOT_POOL ).
371 .It Ev ZFSBOOT_BOOT_POOL_NAME
372 Name for the optional boot pool when it is enabled, (See
373 .Ev ZFSBOOT_BOOT_POOL ).
376 .It Ev ZFSBOOT_BOOT_POOL_SIZE
377 Size of the boot pool when it is enabled (See
378 .Ev ZFSBOOT_BOOT_POOL ).
382 Disks to be used for the base system, including the boot pool.
383 This variable must only be used on a scripted installation.
386 for more information.
388 .It Ev ZFSBOOT_SWAP_SIZE
389 Size of the swap partition on each block device.
390 This variable will be passed to
392 which supports SI unit suffixes.
395 .It Ev ZFSBOOT_SWAP_ENCRYPTION
396 If set, enables the encryption of the swap partition using
399 .It Ev ZFSBOOT_SWAP_MIRROR
400 If set, enables a swap mirroring using
404 .It Ev ZFSBOOT_DATASETS
405 ZFS datasets to be created on the root zpool, it requires the
409 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
412 for more information about who to write this variable and to
413 take a look into the default value of it.
414 .It Ev ZFSBOOT_CONFIRM_LAYOUT
415 If set and the installation is interactive, allow the user to confirm
416 the layout before continuing with the installation.
422 scripts consist of two parts: a
426 The preamble sets up the options for the installation (how to partition the
427 disk[s], which distributions to install, etc.) and the optional second part is
428 a shell script run under
430 in the newly installed system before
433 The two parts are separated by the usual script header (#!), which also sets
434 the interpreter for the setup script.
436 A typical bsdinstall script looks like this:
437 .Bd -literal -offset indent
439 DISTRIBUTIONS="kernel.txz base.txz"
442 sysrc ifconfig_em0=DHCP
443 sysrc sshd_enable=YES
447 For a ZFS scripted installation, the script looks like this:
448 .Bd -literal -offset indent
449 DISTRIBUTIONS="kernel.txz base.txz"
450 export ZFSBOOT_VDEV_TYPE=stripe
451 export ZFSBOOT_DISKS=ada0
452 export nonInteractive="YES"
455 echo "ifconfig_em0=DHCP" >> /etc/rc.conf
456 echo "sshd_enable=YES" >> /etc/rc.conf
462 release media, such a script placed at
463 .Pa /etc/installerconfig
464 will be run at boot time and the system will be rebooted automatically after
465 the installation has completed.
466 This can be used for unattended network installation of new systems; see
470 The preamble consists of installer settings.
471 These control global installation parameters (see
472 .Sx ENVIRONMENT VARIABLES )
473 as well as disk partitioning.
474 The preamble is interpreted as a
476 script run at the very beginning of the install.
477 If more complicated behavior than setting these variables is desired,
478 arbitrary commands can be run here to extend the installer.
479 In addition to the variables in
480 .Sx ENVIRONMENT VARIABLES ,
483 the preamble can contain a variable
485 which is passed to the
487 target to control disk setup.
493 the preamble can contain the variable
497 and setting the variables
500 .Ev ZFSBOOT_VDEV_TYPE
501 to create the pool of disks for the base system.
502 Usually, for a mirrored booting disk, this two variables looks like this:
503 .Bd -literal -offset indent
504 ZFSBOOT_DISKS="ada0 ada1"
505 ZFSBOOT_VDEV_TYPE=mirror
508 Remenber to export all the variables for the
510 command, otherwise it will not get set.
512 Following the preamble is an optional shell script, beginning with a #!
514 This script will be run at the end of the installation process inside a
516 environment in the newly installed system and can be used to set up
517 configuration files, install packages, etc.
518 Note that newly configured system services, e.g., networking have not
519 been started in the installed system at this time and only installation
520 host services are available.
524 partitioning takes the
526 variable to create the datasets on the base system.
527 This variable can get pretty huge if the pool contains a lot of datasets.
528 The default value of the
531 .Bd -literal -offset indent
532 # DATASET OPTIONS (comma or space separated; or both)
534 # Boot Environment [BE] root and default boot dataset
535 /$ZFSBOOT_BEROOT_NAME mountpoint=none
536 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
538 # Compress /tmp, allow exec but not setuid
539 /tmp mountpoint=/tmp,exec=on,setuid=off
541 # Do not mount /usr so that 'base' files go to the BEROOT
542 /usr mountpoint=/usr,canmount=off
544 # Home directories separated so they are common to all BEs
545 /usr/home # NB: /home is a symlink to /usr/home
548 /usr/ports setuid=off
550 # Source tree (compressed)
553 # Create /var and friends
554 /var mountpoint=/var,canmount=off
555 /var/audit exec=off,setuid=off
556 /var/crash exec=off,setuid=off
557 /var/log exec=off,setuid=off
562 The first column if the dataset to be created on the top of the
563 .Ev ZFSBOOT_POOL_NAME
564 and the rest of the columns are the options to be set on each dataset.
565 The options must be written on a coma or space separated list, or both.
566 And everything behind a pound/hash character is ignored as a comment.
573 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org