diff options
Diffstat (limited to 'documentation/content/en/books/handbook/bsdinstall/_index.adoc')
| -rw-r--r-- | documentation/content/en/books/handbook/bsdinstall/_index.adoc | 459 |
1 files changed, 338 insertions, 121 deletions
diff --git a/documentation/content/en/books/handbook/bsdinstall/_index.adoc b/documentation/content/en/books/handbook/bsdinstall/_index.adoc index 33ae0535fe..cd11a7f59e 100644 --- a/documentation/content/en/books/handbook/bsdinstall/_index.adoc +++ b/documentation/content/en/books/handbook/bsdinstall/_index.adoc @@ -46,7 +46,8 @@ toc::[] [[bsdinstall-synopsis]] == Synopsis -There are several different ways of getting FreeBSD to run, depending on the environment. Those are: +There are several different ways of getting FreeBSD to run, depending on the environment. +Those are: * Virtual Machine images, to download and import on a virtual environment of choice. These can be downloaded from the https://www.freebsd.org/where/[Download FreeBSD] page. There are images for KVM ("qcow2"), VMWare ("vmdk"), Hyper-V ("vhd"), and raw device images that are universally supported. These are not installation images, but rather the preconfigured ("already installed") instances, ready to run and perform post-installation tasks. * Virtual Machine images available at Amazon's https://aws.amazon.com/marketplace/pp/B07L6QV354[AWS Marketplace], https://azuremarketplace.microsoft.com/en-us/marketplace/apps?search=freebsd&page=1[Microsoft Azure Marketplace], and https://console.cloud.google.com/marketplace/details/freebsd-cloud/freebsd-12[Google Cloud Platform], to run on their respective hosting services. For more information on deploying FreeBSD on Azure please consult the relevant chapter in the https://docs.microsoft.com/en-us/azure/virtual-machines/linux/freebsd-intro-on-azure[Azure Documentation]. @@ -55,7 +56,9 @@ There are several different ways of getting FreeBSD to run, depending on the env The rest of this chapter describes the fourth case, explaining how to install FreeBSD using the text-based installation program named bsdinstall. -In general, the installation instructions in this chapter are written for the i386(TM) and AMD64 architectures. Where applicable, instructions specific to other platforms will be listed. There may be minor differences between the installer and what is shown here, so use this chapter as a general guide rather than as a set of literal instructions. +In general, the installation instructions in this chapter are written for the i386(TM) and AMD64 architectures. +Where applicable, instructions specific to other platforms will be listed. +There may be minor differences between the installer and what is shown here, so use this chapter as a general guide rather than as a set of literal instructions. [NOTE] ==== @@ -78,24 +81,34 @@ Before reading this chapter, you should: [[bsdinstall-hardware]] == Minimum Hardware Requirements -The hardware requirements to install FreeBSD vary by architecture. Hardware architectures and devices supported by a FreeBSD release are listed on the link:https://www.FreeBSD.org/releases/[FreeBSD Release Information] page. The link:https://www.FreeBSD.org/where/[FreeBSD download page] also has recommendations for choosing the correct image for different architectures. +The hardware requirements to install FreeBSD vary by architecture. +Hardware architectures and devices supported by a FreeBSD release are listed on the link:https://www.FreeBSD.org/releases/[FreeBSD Release Information] page. +The link:https://www.FreeBSD.org/where/[FreeBSD download page] also has recommendations for choosing the correct image for different architectures. -A FreeBSD installation requires a minimum of 96 MB of RAM and 1.5 GB of free hard drive space. However, such small amounts of memory and disk space are really only suitable for custom applications like embedded appliances. General-purpose desktop systems need more resources. 2-4 GB RAM and at least 8 GB hard drive space is a good starting point. +A FreeBSD installation requires a minimum of 96 MB of RAM and 1.5 GB of free hard drive space. +However, such small amounts of memory and disk space are really only suitable for custom applications like embedded appliances. +General-purpose desktop systems need more resources. +2-4 GB RAM and at least 8 GB hard drive space is a good starting point. These are the processor requirements for each architecture: amd64:: -This is the most common desktop and laptop processor type, used in most modern systems. Intel(R) calls it Intel64. Other manufacturers sometimes call it x86-64. +This is the most common desktop and laptop processor type, used in most modern systems. +Intel(R) calls it Intel64. +Other manufacturers sometimes call it x86-64. + Examples of amd64 compatible processors include: AMD Athlon(TM)64, AMD Opteron(TM), multi-core Intel(R) Xeon(TM), and Intel(R) Core(TM) 2 and later processors. i386:: Older desktops and laptops often use this 32-bit, x86 architecture. + -Almost all i386-compatible processors with a floating point unit are supported. All Intel(R) processors 486 or higher are supported. +Almost all i386-compatible processors with a floating point unit are supported. +All Intel(R) processors 486 or higher are supported. However, binaries released by the project are compiled for the 686 processor, so a special build will be needed for 486 and 586 systems. + -FreeBSD will take advantage of Physical Address Extensions (PAE) support on CPUs with this feature. A kernel with the PAE feature enabled will detect memory above 4 GB and allow it to be used by the system. However, using PAE places constraints on device drivers and other features of FreeBSD. +FreeBSD will take advantage of Physical Address Extensions (PAE) support on CPUs with this feature. +A kernel with the PAE feature enabled will detect memory above 4 GB and allow it to be used by the system. +However, using PAE places constraints on device drivers and other features of FreeBSD. arm64:: Most embedded boards are 64-bit ARM computers. @@ -105,41 +118,60 @@ arm:: Older armv7 boards are supported. powerpc:: -All New World ROM Apple(R) Mac(R) systems with built-in USB are supported. SMP is supported on machines with multiple CPUs. +All New World ROM Apple(R) Mac(R) systems with built-in USB are supported. +SMP is supported on machines with multiple CPUs. + A 32-bit kernel can only use the first 2 GB of RAM. [[bsdinstall-pre]] == Pre-Installation Tasks -Once it has been determined that the system meets the minimum hardware requirements for installing FreeBSD, the installation file should be downloaded and the installation media prepared. Before doing this, check that the system is ready for an installation by verifying the items in this checklist: +Once it has been determined that the system meets the minimum hardware requirements for installing FreeBSD, the installation file should be downloaded and the installation media prepared. +Before doing this, check that the system is ready for an installation by verifying the items in this checklist: [.procedure] . *Back Up Important Data* + -Before installing any operating system, _always_ backup all important data first. Do not store the backup on the system being installed. Instead, save the data to a removable disk such as a USB drive, another system on the network, or an online backup service. Test the backup before starting the installation to make sure it contains all of the needed files. Once the installer formats the system's disk, all data stored on that disk will be lost. +Before installing any operating system, _always_ backup all important data first. +Do not store the backup on the system being installed. +Instead, save the data to a removable disk such as a USB drive, another system on the network, or an online backup service. +Test the backup before starting the installation to make sure it contains all of the needed files. +Once the installer formats the system's disk, all data stored on that disk will be lost. . *Decide Where to Install FreeBSD* + -If FreeBSD will be the only operating system installed, this step can be skipped. But if FreeBSD will share the disk with another operating system, decide which disk or partition will be used for FreeBSD. +If FreeBSD will be the only operating system installed, this step can be skipped. +But if FreeBSD will share the disk with another operating system, decide which disk or partition will be used for FreeBSD. + -In the i386 and amd64 architectures, disks can be divided into multiple partitions using one of two partitioning schemes. A traditional _Master Boot Record_ (MBR) holds a partition table defining up to four _primary partitions_. For historical reasons, FreeBSD calls these primary partition _slices_. One of these primary partitions can be made into an _extended partition_ containing multiple _logical partitions_. The _GUID Partition Table_ (GPT) is a newer and simpler method of partitioning a disk. Common GPT implementations allow up to 128 partitions per disk, eliminating the need for logical partitions. +In the i386 and amd64 architectures, disks can be divided into multiple partitions using one of two partitioning schemes. +A traditional _Master Boot Record_ (MBR) holds a partition table defining up to four _primary partitions_. +For historical reasons, FreeBSD calls these primary partition _slices_. +One of these primary partitions can be made into an _extended partition_ containing multiple _logical partitions_. +The _GUID Partition Table_ (GPT) is a newer and simpler method of partitioning a disk. +Common GPT implementations allow up to 128 partitions per disk, eliminating the need for logical partitions. + -The FreeBSD boot loader requires either a primary or GPT partition. If all of the primary or GPT partitions are already in use, one must be freed for FreeBSD. To create a partition without deleting existing data, use a partition resizing tool to shrink an existing partition and create a new partition using the freed space. +The FreeBSD boot loader requires either a primary or GPT partition. +If all of the primary or GPT partitions are already in use, one must be freed for FreeBSD. +To create a partition without deleting existing data, use a partition resizing tool to shrink an existing partition and create a new partition using the freed space. + -A variety of free and commercial partition resizing tools are listed at http://en.wikipedia.org/wiki/List_of_disk_partitioning_software[http://en.wikipedia.org/wiki/List_of_disk_partitioning_software]. GParted Live (http://gparted.sourceforge.net/livecd.php[http://gparted.sourceforge.net/livecd.php]) is a free live CD which includes the GParted partition editor. GParted is also included with many other Linux live CD distributions. +A variety of free and commercial partition resizing tools are listed at http://en.wikipedia.org/wiki/List_of_disk_partitioning_software[http://en.wikipedia.org/wiki/List_of_disk_partitioning_software]. +GParted Live (http://gparted.sourceforge.net/livecd.php[http://gparted.sourceforge.net/livecd.php]) is a free live CD which includes the GParted partition editor. +GParted is also included with many other Linux live CD distributions. + [WARNING] ==== - -When used properly, disk shrinking utilities can safely create space for creating a new partition. Since the possibility of selecting the wrong partition exists, always backup any important data and verify the integrity of the backup before modifying disk partitions. +When used properly, disk shrinking utilities can safely create space for creating a new partition. +Since the possibility of selecting the wrong partition exists, always backup any important data and verify the integrity of the backup before modifying disk partitions. ==== + -Disk partitions containing different operating systems make it possible to install multiple operating systems on one computer. An alternative is to use virtualization (crossref:virtualization[virtualization,Virtualization]) which allows multiple operating systems to run at the same time without modifying any disk partitions. +Disk partitions containing different operating systems make it possible to install multiple operating systems on one computer. +An alternative is to use virtualization (crossref:virtualization[virtualization,Virtualization]) which allows multiple operating systems to run at the same time without modifying any disk partitions. . *Collect Network Information* + -Some FreeBSD installation methods require a network connection in order to download the installation files. After any installation, the installer will offer to setup the system's network interfaces. +Some FreeBSD installation methods require a network connection in order to download the installation files. +After any installation, the installer will offer to setup the system's network interfaces. + -If the network has a DHCP server, it can be used to provide automatic network configuration. If DHCP is not available, the following network information for the system must be obtained from the local network administrator or Internet service provider: +If the network has a DHCP server, it can be used to provide automatic network configuration. +If DHCP is not available, the following network information for the system must be obtained from the local network administrator or Internet service provider: + [[bsdinstall-collect-network-information]] Required Network Information @@ -152,20 +184,29 @@ Required Network Information . *Check for FreeBSD Errata* + -Although the FreeBSD Project strives to ensure that each release of FreeBSD is as stable as possible, bugs occasionally creep into the process. On very rare occasions those bugs affect the installation process. As these problems are discovered and fixed, they are noted in the FreeBSD Errata (link:https://www.FreeBSD.org/releases/{rel121-current}R/errata/[https://www.freebsd.org/releases/{rel121-current}R/errata/]) on the FreeBSD web site. Check the errata before installing to make sure that there are no problems that might affect the installation. +Although the FreeBSD Project strives to ensure that each release of FreeBSD is as stable as possible, bugs occasionally creep into the process. +On very rare occasions those bugs affect the installation process. +As these problems are discovered and fixed, they are noted in the FreeBSD Errata (link:https://www.FreeBSD.org/releases/{rel121-current}R/errata/[https://www.freebsd.org/releases/{rel121-current}R/errata/]) on the FreeBSD web site. +Check the errata before installing to make sure that there are no problems that might affect the installation. + Information and errata for all the releases can be found on the release information section of the FreeBSD web site (link:https://www.FreeBSD.org/releases/[https://www.freebsd.org/releases/]). [[bsdinstall-installation-media]] === Prepare the Installation Media -The FreeBSD installer is not an application that can be run from within another operating system. Instead, download a FreeBSD installation file, burn it to the media associated with its file type and size (CD, DVD, or USB), and boot the system to install from the inserted media. +The FreeBSD installer is not an application that can be run from within another operating system. +Instead, download a FreeBSD installation file, burn it to the media associated with its file type and size (CD, DVD, or USB), and boot the system to install from the inserted media. + +FreeBSD installation files are available at link:https://www.FreeBSD.org/where/[www.freebsd.org/where/]. +Each installation file's name includes the release version of FreeBSD, the architecture, and the type of file. +For example, to install FreeBSD 12.1 on an amd64 system from a DVD, download [.filename]#FreeBSD-12.1-RELEASE-amd64-dvd1.iso#, burn this file to a DVD, and boot the system with the DVD inserted. -FreeBSD installation files are available at link:https://www.FreeBSD.org/where/[www.freebsd.org/where/]. Each installation file's name includes the release version of FreeBSD, the architecture, and the type of file. For example, to install FreeBSD 12.1 on an amd64 system from a DVD, download [.filename]#FreeBSD-12.1-RELEASE-amd64-dvd1.iso#, burn this file to a DVD, and boot the system with the DVD inserted. +Installation files are available in several formats. +The formats vary depending on computer architecture and media type. -Installation files are available in several formats. The formats vary depending on computer architecture and media type. [[bsdinstall-installation-media-uefi]] -Additional installation files are included for computers that boot with UEFI (Unified Extensible Firmware Interface). The names of these files include the string [.filename]#uefi#. +Additional installation files are included for computers that boot with UEFI (Unified Extensible Firmware Interface). +The names of these files include the string [.filename]#uefi#. File types: @@ -175,18 +216,27 @@ File types: * `-memstick.img`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It should be burned to a USB stick using the instructions below. * `-mini-memstick.img`: Like `-bootonly.iso`, does not include installation files, but downloads them as needed. A working internet connection is required during installation. Write this file to a USB stick as shown in <<bsdinstall-usb>>. -After downloading the image file, download [.filename]#CHECKSUM.SHA256# from the same directory. Calculate a _checksum_ for the image file. FreeBSD provides man:sha256[1] for this, used as `sha256 _imagefilename_`. Other operating systems have similar programs. +After downloading the image file, download [.filename]#CHECKSUM.SHA256# from the same directory. +Calculate a _checksum_ for the image file. +FreeBSD provides man:sha256[1] for this, used as `sha256 _imagefilename_`. +Other operating systems have similar programs. -Compare the calculated checksum with the one shown in [.filename]#CHECKSUM.SHA256#. The checksums must match exactly. If the checksums do not match, the image file is corrupt and must be downloaded again. +Compare the calculated checksum with the one shown in [.filename]#CHECKSUM.SHA256#. +The checksums must match exactly. +If the checksums do not match, the image file is corrupt and must be downloaded again. [[bsdinstall-usb]] ==== Writing an Image File to USB -The [.filename]#\*.img# file is an _image_ of the complete contents of a memory stick. It _cannot_ be copied to the target device as a file. Several applications are available for writing the [.filename]#*.img# to a USB stick. This section describes two of these utilities. +The [.filename]#\*.img# file is an _image_ of the complete contents of a memory stick. +It _cannot_ be copied to the target device as a file. +Several applications are available for writing the [.filename]#*.img# to a USB stick. +This section describes two of these utilities. [IMPORTANT] ==== -Before proceeding, back up any important data on the USB stick. This procedure will erase the existing data on the stick. +Before proceeding, back up any important data on the USB stick. +This procedure will erase the existing data on the stick. ==== [[bsdinstall-usb-dd]] @@ -196,9 +246,10 @@ Before proceeding, back up any important data on the USB stick. This procedure w [WARNING] ==== - -This example uses [.filename]#/dev/da0# as the target device where the image will be written. Be _very careful_ that the correct device is used as this command will destroy the existing data on the specified target device. +This example uses [.filename]#/dev/da0# as the target device where the image will be written. +Be _very careful_ that the correct device is used as this command will destroy the existing data on the specified target device. ==== + . The command-line utility is available on BSD, Linux(R), and Mac OS(R) systems. To burn the image using `dd`, insert the USB stick and determine its device name. Then, specify the name of the downloaded installation file and the device name for the USB stick. This example burns the amd64 installation image to the first USB device on an existing FreeBSD system. + [source,shell] @@ -224,10 +275,17 @@ Be sure to give the correct drive letter as the existing data on the specified d ==== . *Obtaining Image Writer for Windows(R)* + -Image Writer for Windows(R) is a free application that can correctly write an image file to a memory stick. Download it from https://sourceforge.net/projects/win32diskimager/[https://sourceforge.net/projects/win32diskimager/] and extract it into a folder. +Image Writer for Windows(R) is a free application that can correctly write an image file to a memory stick. +Download it from https://sourceforge.net/projects/win32diskimager/[https://sourceforge.net/projects/win32diskimager/] and extract it into a folder. + . *Writing the Image with Image Writer* + -Double-click the Win32DiskImager icon to start the program. Verify that the drive letter shown under `Device` is the drive with the memory stick. Click the folder icon and select the image to be written to the memory stick. Click btn:[Save] to accept the image file name. Verify that everything is correct, and that no folders on the memory stick are open in other windows. When everything is ready, click btn:[Write] to write the image file to the memory stick. +Double-click the Win32DiskImager icon to start the program. +Verify that the drive letter shown under `Device` is the drive with the memory stick. +Click the folder icon and select the image to be written to the memory stick. +Click btn:[Save] to accept the image file name. +Verify that everything is correct, and that no folders on the memory stick are open in other windows. +When everything is ready, click btn:[Write] to write the image file to the memory stick. **** You are now ready to start installing FreeBSD. @@ -247,15 +305,22 @@ be PERMANENTLY ERASED. Are you sure you want to commit your changes? .... -The install can be exited at any time prior to this warning. If there is a concern that something is incorrectly configured, just turn the computer off before this point and no changes will be made to the system's disks. +The install can be exited at any time prior to this warning. +If there is a concern that something is incorrectly configured, just turn the computer off before this point and no changes will be made to the system's disks. ==== -This section describes how to boot the system from the installation media which was prepared using the instructions in <<bsdinstall-installation-media>>. When using a bootable USB stick, plug in the USB stick before turning on the computer. When booting from CD or DVD, turn on the computer and insert the media at the first opportunity. How to configure the system to boot from the inserted media depends upon the architecture. +This section describes how to boot the system from the installation media which was prepared using the instructions in <<bsdinstall-installation-media>>. +When using a bootable USB stick, plug in the USB stick before turning on the computer. +When booting from CD or DVD, turn on the computer and insert the media at the first opportunity. +How to configure the system to boot from the inserted media depends upon the architecture. [[bsdinstall-starting-i386]] === Booting on i386(TM) and amd64 -These architectures provide a BIOS menu for selecting the boot device. Depending upon the installation media being used, select the CD/DVD or USB device as the first boot device. Most systems also provide a key for selecting the boot device during startup without having to enter the BIOS. Typically, the key is either kbd:[F10], kbd:[F11], kbd:[F12], or kbd:[Escape]. +These architectures provide a BIOS menu for selecting the boot device. +Depending upon the installation media being used, select the CD/DVD or USB device as the first boot device. +Most systems also provide a key for selecting the boot device during startup without having to enter the BIOS. +Typically, the key is either kbd:[F10], kbd:[F11], kbd:[F12], or kbd:[Escape]. If the computer loads the existing operating system instead of the FreeBSD installer, then either: @@ -265,7 +330,9 @@ If the computer loads the existing operating system instead of the FreeBSD insta === Booting on PowerPC(R) -On most machines, holding kbd:[C] on the keyboard during boot will boot from the CD. Otherwise, hold kbd:[Command+Option+O+F], or kbd:[Windows+Alt+O+F] on non-Apple(R) keyboards. At the `0 >` prompt, enter +On most machines, holding kbd:[C] on the keyboard during boot will boot from the CD. +Otherwise, hold kbd:[Command+Option+O+F], or kbd:[Windows+Alt+O+F] on non-Apple(R) keyboards. +At the `0 >` prompt, enter [source,shell] .... @@ -281,7 +348,10 @@ Once the system boots from the installation media, a menu similar to the followi .FreeBSD Boot Loader Menu image::bsdinstall-newboot-loader-menu.png[] -By default, the menu will wait ten seconds for user input before booting into the FreeBSD installer or, if FreeBSD is already installed, before booting into FreeBSD. To pause the boot timer in order to review the selections, press kbd:[Space]. To select an option, press its highlighted number, character, or key. The following options are available. +By default, the menu will wait ten seconds for user input before booting into the FreeBSD installer or, if FreeBSD is already installed, before booting into FreeBSD. +To pause the boot timer in order to review the selections, press kbd:[Space]. +To select an option, press its highlighted number, character, or key. +The following options are available. * `Boot Multi User`: This will continue the FreeBSD boot process. If the boot timer has been paused, press kbd:[1], upper- or lower-case kbd:[B], or kbd:[Enter]. * `Boot Single User`: This mode can be used to fix an existing FreeBSD installation as described in crossref:boot[boot-singleuser,“Single-User Mode”]. Press kbd:[2] or the upper- or lower-case kbd:[S] to enter this mode. @@ -294,33 +364,46 @@ By default, the menu will wait ten seconds for user input before booting into th .FreeBSD Boot Options Menu image::bsdinstall-boot-options-menu.png[] -The boot options menu is divided into two sections. The first section can be used to either return to the main boot menu or to reset any toggled options back to their defaults. +The boot options menu is divided into two sections. +The first section can be used to either return to the main boot menu or to reset any toggled options back to their defaults. -The next section is used to toggle the available options to `On` or `Off` by pressing the option's highlighted number or character. The system will always boot using the settings for these options until they are modified. Several options can be toggled using this menu: +The next section is used to toggle the available options to `On` or `Off` by pressing the option's highlighted number or character. +The system will always boot using the settings for these options until they are modified. +Several options can be toggled using this menu: * `ACPI Support`: If the system hangs during boot, try toggling this option to `Off`. * `Safe Mode`: If the system still hangs during boot even with `ACPI Support` set to `Off`, try setting this option to `On`. * `Single User`: Toggle this option to `On` to fix an existing FreeBSD installation as described in crossref:boot[boot-singleuser,“Single-User Mode”]. Once the problem is fixed, set it back to `Off`. * `Verbose`: Toggle this option to `On` to see more detailed messages during the boot process. This can be useful when troubleshooting a piece of hardware. -After making the needed selections, press kbd:[1] or kbd:[Backspace] to return to the main boot menu, then press kbd:[Enter] to continue booting into FreeBSD. A series of boot messages will appear as FreeBSD carries out its hardware device probes and loads the installation program. Once the boot is complete, the welcome menu shown in <<bsdinstall-choose-mode>> will be displayed. +After making the needed selections, press kbd:[1] or kbd:[Backspace] to return to the main boot menu, then press kbd:[Enter] to continue booting into FreeBSD. +A series of boot messages will appear as FreeBSD carries out its hardware device probes and loads the installation program. +Once the boot is complete, the welcome menu shown in <<bsdinstall-choose-mode>> will be displayed. [[bsdinstall-choose-mode]] .Welcome Menu image::bsdinstall-choose-mode.png[] -Press kbd:[Enter] to select the default of btn:[Install] to enter the installer. The rest of this chapter describes how to use this installer. Otherwise, use the right or left arrows or the colorized letter to select the desired menu item. The btn:[Shell] can be used to access a FreeBSD shell in order to use command line utilities to prepare the disks before installation. The btn:[Live CD] option can be used to try out FreeBSD before installing it. The live version is described in <<using-live-cd>>. +Press kbd:[Enter] to select the default of btn:[Install] to enter the installer. +The rest of this chapter describes how to use this installer. +Otherwise, use the right or left arrows or the colorized letter to select the desired menu item. +The btn:[Shell] can be used to access a FreeBSD shell in order to use command line utilities to prepare the disks before installation. +The btn:[Live CD] option can be used to try out FreeBSD before installing it. +The live version is described in <<using-live-cd>>. [TIP] ==== - -To review the boot messages, including the hardware device probe, press the upper- or lower-case kbd:[S] and then kbd:[Enter] to access a shell. At the shell prompt, type `more /var/run/dmesg.boot` and use the space bar to scroll through the messages. When finished, type `exit` to return to the welcome menu. +To review the boot messages, including the hardware device probe, press the upper- or lower-case kbd:[S] and then kbd:[Enter] to access a shell. +At the shell prompt, type `more /var/run/dmesg.boot` and use the space bar to scroll through the messages. +When finished, type `exit` to return to the welcome menu. ==== [[using-bsdinstall]] == Using bsdinstall -This section shows the order of the bsdinstall menus and the type of information that will be asked before the system is installed. Use the arrow keys to highlight a menu option, then kbd:[Space] to select or deselect that menu item. When finished, press kbd:[Enter] to save the selection and move onto the next screen. +This section shows the order of the bsdinstall menus and the type of information that will be asked before the system is installed. +Use the arrow keys to highlight a menu option, then kbd:[Space] to select or deselect that menu item. +When finished, press kbd:[Enter] to save the selection and move onto the next screen. [[bsdinstall-keymap]] === Selecting the Keymap Menu @@ -331,7 +414,9 @@ Before starting the process, bsdinstall will load the keymap files as show in << .Keymap Loading image::bsdinstall-keymap-loading.png[] -After the keymaps have been loaded bsdinstall displays the menu shown in <<bsdinstall-keymap-10>>. Use the up and down arrows to select the keymap that most closely represents the mapping of the keyboard attached to the system. Press kbd:[Enter] to save the selection. +After the keymaps have been loaded bsdinstall displays the menu shown in <<bsdinstall-keymap-10>>. +Use the up and down arrows to select the keymap that most closely represents the mapping of the keyboard attached to the system. +Press kbd:[Enter] to save the selection. [[bsdinstall-keymap-10]] .Keymap Selection Menu @@ -339,7 +424,8 @@ image::bsdinstall-keymap-10.png[] [NOTE] ==== -Pressing kbd:[Esc] will exit this menu and use the default keymap. If the choice of keymap is not clear, [.guimenuitem]#United States of America ISO-8859-1# is also a safe option. +Pressing kbd:[Esc] will exit this menu and use the default keymap. +If the choice of keymap is not clear, [.guimenuitem]#United States of America ISO-8859-1# is also a safe option. ==== In addition, when selecting a different keymap, the user can try the keymap and ensure it is correct before proceeding as shown in <<bsdinstall-keymap-testing>>. @@ -357,7 +443,8 @@ The next bsdinstall menu is used to set the hostname for the newly installed sys .Setting the Hostname image::bsdinstall-config-hostname.png[] -Type in a hostname that is unique for the network. It should be a fully-qualified hostname, such as `machine3.example.com`. +Type in a hostname that is unique for the network. +It should be a fully-qualified hostname, such as `machine3.example.com`. [[bsdinstall-components]] === Selecting Components to Install @@ -368,7 +455,9 @@ Next, bsdinstall will prompt to select optional components to install. .Selecting Components to Install image::bsdinstall-config-components.png[] -Deciding which components to install will depend largely on the intended use of the system and the amount of disk space available. The FreeBSD kernel and userland, collectively known as the _base system_, are always installed. Depending on the architecture, some of these components may not appear: +Deciding which components to install will depend largely on the intended use of the system and the amount of disk space available. +The FreeBSD kernel and userland, collectively known as the _base system_, are always installed. +Depending on the architecture, some of these components may not appear: * `base-dbg` - Base tools like cat, ls among many others with debug symbols activated. * `kernel-dbg` - Kernel and modules with debug symbols activated. @@ -378,8 +467,9 @@ Deciding which components to install will depend largely on the intended use of + [WARNING] ==== - -The installation program does not check for adequate disk space. Select this option only if sufficient hard disk space is available. The FreeBSD Ports Collection takes up about {ports-size} of disk space. +The installation program does not check for adequate disk space. +Select this option only if sufficient hard disk space is available. +The FreeBSD Ports Collection takes up about {ports-size} of disk space. ==== * `src` - The complete FreeBSD source code for both the kernel and the userland. Although not required for the majority of applications, it may be required to build device drivers, kernel modules, or some applications from the Ports Collection. It is also used for developing FreeBSD itself. The full source tree requires 1 GB of disk space and recompiling the entire FreeBSD system requires an additional 5 GB of space. @@ -388,7 +478,9 @@ The installation program does not check for adequate disk space. Select this opt [[bsdinstall-netinstall]] === Installing from the Network -The menu shown in <<bsdinstall-netinstall-notify>> only appears when installing from a [.filename]#-bootonly.iso# or [.filename]#-mini-memstick.img# as this installation media does not hold copies of the installation files. Since the installation files must be retrieved over a network connection, this menu indicates that the network interface must be configured first. If this menu is shown in any step of the process remember to follow the instructions in <<bsdinstall-config-network-dev>>. +The menu shown in <<bsdinstall-netinstall-notify>> only appears when installing from a [.filename]#-bootonly.iso# or [.filename]#-mini-memstick.img# as this installation media does not hold copies of the installation files. +Since the installation files must be retrieved over a network connection, this menu indicates that the network interface must be configured first. +If this menu is shown in any step of the process remember to follow the instructions in <<bsdinstall-config-network-dev>>. [[bsdinstall-netinstall-notify]] .Installing from the Network @@ -410,40 +502,62 @@ bsdinstall gives the user four methods for allocating disk space: * `Shell` opens a shell prompt where advanced users can create customized partitions using command-line utilities like man:gpart[8], man:fdisk[8], and man:bsdlabel[8]. * `Auto (ZFS)` partitioning creates a root-on-ZFS system with optional GELI encryption support for _boot environments_. -This section describes what to consider when laying out the disk partitions. It then demonstrates how to use the different partitioning methods. +This section describes what to consider when laying out the disk partitions. +It then demonstrates how to use the different partitioning methods. [[configtuning-initial]] === Designing the Partition Layout -When laying out file systems, remember that hard drives transfer data faster from the outer tracks to the inner. Thus, smaller and heavier-accessed file systems should be closer to the outside of the drive, while larger partitions like [.filename]#/usr# should be placed toward the inner parts of the disk. It is a good idea to create partitions in an order similar to: [.filename]#/#, swap, [.filename]#/var#, and [.filename]#/usr#. +When laying out file systems, remember that hard drives transfer data faster from the outer tracks to the inner. +Thus, smaller and heavier-accessed file systems should be closer to the outside of the drive, while larger partitions like [.filename]#/usr# should be placed toward the inner parts of the disk. +It is a good idea to create partitions in an order similar to: [.filename]#/#, swap, [.filename]#/var#, and [.filename]#/usr#. -The size of the [.filename]#/var# partition reflects the intended machine's usage. This partition is used to hold mailboxes, log files, and printer spools. Mailboxes and log files can grow to unexpected sizes depending on the number of users and how long log files are kept. On average, most users rarely need more than about a gigabyte of free disk space in [.filename]#/var#. +The size of the [.filename]#/var# partition reflects the intended machine's usage. +This partition is used to hold mailboxes, log files, and printer spools. +Mailboxes and log files can grow to unexpected sizes depending on the number of users and how long log files are kept. +On average, most users rarely need more than about a gigabyte of free disk space in [.filename]#/var#. [NOTE] ==== -Sometimes, a lot of disk space is required in [.filename]#/var/tmp#. When new software is installed, the packaging tools extract a temporary copy of the packages under [.filename]#/var/tmp#. Large software packages, like Firefox or LibreOffice may be tricky to install if there is not enough disk space under [.filename]#/var/tmp#. +Sometimes, a lot of disk space is required in [.filename]#/var/tmp#. +When new software is installed, the packaging tools extract a temporary copy of the packages under [.filename]#/var/tmp#. +Large software packages, like Firefox or LibreOffice may be tricky to install if there is not enough disk space under [.filename]#/var/tmp#. ==== -The [.filename]#/usr# partition holds many of the files which support the system, including the FreeBSD Ports Collection and system source code. At least 2 gigabytes of space is recommended for this partition. +The [.filename]#/usr# partition holds many of the files which support the system, including the FreeBSD Ports Collection and system source code. +At least 2 gigabytes of space is recommended for this partition. -When selecting partition sizes, keep the space requirements in mind. Running out of space in one partition while barely using another can be a hassle. +When selecting partition sizes, keep the space requirements in mind. +Running out of space in one partition while barely using another can be a hassle. -As a rule of thumb, the swap partition should be about double the size of physical memory (RAM). Systems with minimal RAM may perform better with more swap. Configuring too little swap can lead to inefficiencies in the VM page scanning code and might create issues later if more memory is added. +As a rule of thumb, the swap partition should be about double the size of physical memory (RAM). +Systems with minimal RAM may perform better with more swap. +Configuring too little swap can lead to inefficiencies in the VM page scanning code and might create issues later if more memory is added. -On larger systems with multiple SCSI disks or multiple IDE disks operating on different controllers, it is recommended that swap be configured on each drive, up to four drives. The swap partitions should be approximately the same size. The kernel can handle arbitrary sizes but internal data structures scale to 4 times the largest swap partition. Keeping the swap partitions near the same size will allow the kernel to optimally stripe swap space across disks. Large swap sizes are fine, even if swap is not used much. It might be easier to recover from a runaway program before being forced to reboot. +On larger systems with multiple SCSI disks or multiple IDE disks operating on different controllers, it is recommended that swap be configured on each drive, up to four drives. +The swap partitions should be approximately the same size. +The kernel can handle arbitrary sizes but internal data structures scale to 4 times the largest swap partition. +Keeping the swap partitions near the same size will allow the kernel to optimally stripe swap space across disks. +Large swap sizes are fine, even if swap is not used much. +It might be easier to recover from a runaway program before being forced to reboot. -By properly partitioning a system, fragmentation introduced in the smaller write heavy partitions will not bleed over into the mostly read partitions. Keeping the write loaded partitions closer to the disk's edge will increase I/O performance in the partitions where it occurs the most. While I/O performance in the larger partitions may be needed, shifting them more toward the edge of the disk will not lead to a significant performance improvement over moving [.filename]#/var# to the edge. +By properly partitioning a system, fragmentation introduced in the smaller write heavy partitions will not bleed over into the mostly read partitions. +Keeping the write loaded partitions closer to the disk's edge will increase I/O performance in the partitions where it occurs the most. +While I/O performance in the larger partitions may be needed, shifting them more toward the edge of the disk will not lead to a significant performance improvement over moving [.filename]#/var# to the edge. [[bsdinstall-part-guided]] === Guided Partitioning Using UFS -When this method is selected, a menu will display the available disk(s). If multiple disks are connected, choose the one where FreeBSD is to be installed. +When this method is selected, a menu will display the available disk(s). +If multiple disks are connected, choose the one where FreeBSD is to be installed. [[bsdinstall-part-guided-disk]] .Selecting from Multiple Disks image::bsdinstall-part-guided-disk.png[] -Once the disk is selected, the next menu prompts to install to either the entire disk or to create a partition using free space. If btn:[Entire Disk] is chosen, a general partition layout filling the whole disk is automatically created. Selecting btn:[Partition] creates a partition layout from the unused space on the disk. +Once the disk is selected, the next menu prompts to install to either the entire disk or to create a partition using free space. +If btn:[Entire Disk] is chosen, a general partition layout filling the whole disk is automatically created. +Selecting btn:[Partition] creates a partition layout from the unused space on the disk. [[bsdinstall-part-entire-part]] .Selecting Entire Disk or Partition @@ -455,19 +569,29 @@ After btn:[Entire Disk] is chosen bsdinstall displays a dialog indicating that t .Confirmation image::bsdinstall-ufs-warning.png[] -The next menu shows a list with the partition schemes types. GPT is usually the most appropriate choice for amd64 computers. Older computers that are not compatible with GPT should use MBR. The other partition schemes are generally used for uncommon or older computers. More information is available in <<partition-schemes>>. +The next menu shows a list with the partition schemes types. +GPT is usually the most appropriate choice for amd64 computers. +Older computers that are not compatible with GPT should use MBR. +The other partition schemes are generally used for uncommon or older computers. +More information is available in <<partition-schemes>>. [[bsdinstall-ufs-scheme]] .Select Partition Scheme image::bsdinstall-part-manual-partscheme.png[] -After the partition layout has been created, review it to ensure it meets the needs of the installation. Selecting btn:[Revert] will reset the partitions to their original values and pressing btn:[Auto] will recreate the automatic FreeBSD partitions. Partitions can also be manually created, modified, or deleted. When the partitioning is correct, select btn:[Finish] to continue with the installation. +After the partition layout has been created, review it to ensure it meets the needs of the installation. +Selecting btn:[Revert] will reset the partitions to their original values and pressing btn:[Auto] will recreate the automatic FreeBSD partitions. +Partitions can also be manually created, modified, or deleted. +When the partitioning is correct, select btn:[Finish] to continue with the installation. [[bsdinstall-part-review]] .Review Created Partitions image::bsdinstall-part-review.png[] -Once the disks are configured, the next menu provides the last chance to make changes before the selected drives are formatted. If changes need to be made, select btn:[Back] to return to the main partitioning menu. btn:[Revert & Exit] exits the installer without making any changes to the drive. Select btn:[Commit] to start the installation process. +Once the disks are configured, the next menu provides the last chance to make changes before the selected drives are formatted. +If changes need to be made, select btn:[Back] to return to the main partitioning menu. +btn:[Revert & Exit] exits the installer without making any changes to the drive. +Select btn:[Commit] to start the installation process. [[bsdinstall-ufs-final-confirmation]] .Final Confirmation @@ -490,7 +614,9 @@ Highlight the installation drive ([.filename]#ada0# in this example) and select .Manually Create Partitions image::bsdinstall-part-manual-partscheme.png[] -GPT is usually the most appropriate choice for amd64 computers. Older computers that are not compatible with GPT should use MBR. The other partition schemes are generally used for uncommon or older computers. +GPT is usually the most appropriate choice for amd64 computers. +Older computers that are not compatible with GPT should use MBR. +The other partition schemes are generally used for uncommon or older computers. [[partition-schemes]] .Partitioning Schemes @@ -512,7 +638,8 @@ GPT is usually the most appropriate choice for amd64 computers. Older computers |Master Boot Record (http://en.wikipedia.org/wiki/Master_boot_record[http://en.wikipedia.org/wiki/Master_boot_record]). |=== -After the partitioning scheme has been selected and created, select btn:[Create] again to create the partitions. The kbd:[Tab] key is used to move the cursor between fields. +After the partitioning scheme has been selected and created, select btn:[Create] again to create the partitions. +The kbd:[Tab] key is used to move the cursor between fields. [[bsdinstall-part-manual-addpart]] .Manually Create Partitions @@ -527,31 +654,42 @@ A standard FreeBSD GPT installation uses at least three partitions: Refer to man:gpart[8] for descriptions of the available GPT partition types. -Multiple file system partitions can be created and some people prefer a traditional layout with separate partitions for [.filename]#/#, [.filename]#/var#, [.filename]#/tmp#, and [.filename]#/usr#. See <<bsdinstall-part-manual-splitfs>> for an example. +Multiple file system partitions can be created and some people prefer a traditional layout with separate partitions for [.filename]#/#, [.filename]#/var#, [.filename]#/tmp#, and [.filename]#/usr#. +See <<bsdinstall-part-manual-splitfs>> for an example. The `Size` may be entered with common abbreviations: _K_ for kilobytes, _M_ for megabytes, or _G_ for gigabytes. [TIP] ==== - -Proper sector alignment provides the best performance, and making partition sizes even multiples of 4K bytes helps to ensure alignment on drives with either 512-byte or 4K-byte sectors. Generally, using partition sizes that are even multiples of 1M or 1G is the easiest way to make sure every partition starts at an even multiple of 4K. There is one exception: the _freebsd-boot_ partition should be no larger than 512K due to current boot code limitations. +Proper sector alignment provides the best performance, and making partition sizes even multiples of 4K bytes helps to ensure alignment on drives with either 512-byte or 4K-byte sectors. +Generally, using partition sizes that are even multiples of 1M or 1G is the easiest way to make sure every partition starts at an even multiple of 4K. +There is one exception: the _freebsd-boot_ partition should be no larger than 512K due to current boot code limitations. ==== -A `Mountpoint` is needed if the partition will contain a file system. If only a single UFS partition will be created, the mountpoint should be [.filename]#/#. +A `Mountpoint` is needed if the partition will contain a file system. +If only a single UFS partition will be created, the mountpoint should be [.filename]#/#. -The `Label` is a name by which the partition will be known. Drive names or numbers can change if the drive is connected to a different controller or port, but the partition label does not change. Referring to labels instead of drive names and partition numbers in files like [.filename]#/etc/fstab# makes the system more tolerant to hardware changes. GPT labels appear in [.filename]#/dev/gpt/# when a disk is attached. Other partitioning schemes have different label capabilities and their labels appear in different directories in [.filename]#/dev/#. +The `Label` is a name by which the partition will be known. +Drive names or numbers can change if the drive is connected to a different controller or port, but the partition label does not change. +Referring to labels instead of drive names and partition numbers in files like [.filename]#/etc/fstab# makes the system more tolerant to hardware changes. +GPT labels appear in [.filename]#/dev/gpt/# when a disk is attached. +Other partitioning schemes have different label capabilities and their labels appear in different directories in [.filename]#/dev/#. [TIP] ==== - -Use a unique label on every partition to avoid conflicts from identical labels. A few letters from the computer's name, use, or location can be added to the label. For instance, use `labroot` or `rootfslab` for the UFS root partition on the computer named `lab`. +Use a unique label on every partition to avoid conflicts from identical labels. +A few letters from the computer's name, use, or location can be added to the label. +For instance, use `labroot` or `rootfslab` for the UFS root partition on the computer named `lab`. ==== [[bsdinstall-part-manual-splitfs]] .Creating Traditional Split File System Partitions [example] ==== -For a traditional partition layout where the [.filename]#/#, [.filename]#/var#, [.filename]#/tmp#, and [.filename]#/usr# directories are separate file systems on their own partitions, create a GPT partitioning scheme, then create the partitions as shown. Partition sizes shown are typical for a 20G target disk. If more space is available on the target disk, larger swap or [.filename]#/var# partitions may be useful. Labels shown here are prefixed with `ex` for "example", but readers should use other unique label values as described above. +For a traditional partition layout where the [.filename]#/#, [.filename]#/var#, [.filename]#/tmp#, and [.filename]#/usr# directories are separate file systems on their own partitions, create a GPT partitioning scheme, then create the partitions as shown. +Partition sizes shown are typical for a 20G target disk. +If more space is available on the target disk, larger swap or [.filename]#/var# partitions may be useful. +Labels shown here are prefixed with `ex` for "example", but readers should use other unique label values as described above. By default, FreeBSD's [.filename]#gptboot# expects the first UFS partition to be the [.filename]#/# partition. @@ -600,7 +738,8 @@ After the custom partitions have been created, select btn:[Finish] to continue w [[bsdinstall-part-zfs]] === Guided Partitioning Using Root-on-ZFS -This partitioning mode only works with whole disks and will erase the contents of the entire disk. The main ZFS configuration menu offers a number of options to control the creation of the pool. +This partitioning mode only works with whole disks and will erase the contents of the entire disk. +The main ZFS configuration menu offers a number of options to control the creation of the pool. [[bsdinstall-zfs-menu]] .ZFS Partitioning Menu @@ -635,7 +774,9 @@ Here is a summary of the `Pool Type` which can be selected in this menu: * `raidz2` - Double Redundant RAID. Allows two disks to fail concurrently. This option needs at least four disks. * `raidz3` - Triple Redundant RAID. Allows three disks to fail concurrently. This option needs at least five disks. -Once a `Pool Type` has been selected, a list of available disks is displayed, and the user is prompted to select one or more disks to make up the pool. The configuration is then validated, to ensure enough disks are selected. If not, select btn:[<Change Selection>] to return to the list of disks, or btn:[<Back>] to change the `Pool Type`. +Once a `Pool Type` has been selected, a list of available disks is displayed, and the user is prompted to select one or more disks to make up the pool. +The configuration is then validated, to ensure enough disks are selected. +If not, select btn:[<Change Selection>] to return to the list of disks, or btn:[<Back>] to change the `Pool Type`. [[bsdinstall-zfs-disk_select]] .Disk Selection @@ -657,25 +798,29 @@ To avoid accidentally erasing the wrong disk, the btn:[- Disk Info] menu can be .Analyzing a Disk image::bsdinstall-zfs-disk_info.png[] -Select kbd:[N] to configure the `Pool Name`. Enter the desired name then select btn:[<OK>] to establish it or btn:[<Cancel>] to return to the main menu and leave the default name. +Select kbd:[N] to configure the `Pool Name`. +Enter the desired name then select btn:[<OK>] to establish it or btn:[<Cancel>] to return to the main menu and leave the default name. [[bsdinstall-zfs-pool-name]] .Pool Name image::bsdinstall-zfs-pool-name.png[] -Select kbd:[S] to set the amount of swap. Enter the desired amount of swap and then select btn:[<OK>] to establish it or btn:[<Cancel>] to return to the main menu and let the default amount. +Select kbd:[S] to set the amount of swap. +Enter the desired amount of swap and then select btn:[<OK>] to establish it or btn:[<Cancel>] to return to the main menu and let the default amount. [[bsdinstall-zfs-swap-amount]] .Swap Amount image::bsdinstall-zfs-swap-amount.png[] -Once all options have been set to the desired values, select the btn:[>>> Install] option at the top of the menu. The installer then offers a last chance to cancel before the contents of the selected drives are destroyed to create the ZFS pool. +Once all options have been set to the desired values, select the btn:[>>> Install] option at the top of the menu. +The installer then offers a last chance to cancel before the contents of the selected drives are destroyed to create the ZFS pool. [[bsdinstall-zfs-warning]] .Last Chance image::bsdinstall-zfs-warning.png[] -If GELI disk encryption was enabled, the installer will prompt twice for the passphrase to be used to encrypt the disks. And after that the initializing of the encryption begins. +If GELI disk encryption was enabled, the installer will prompt twice for the passphrase to be used to encrypt the disks. +And after that the initializing of the encryption begins. [[bsdinstall-zfs-geli_password]] .Disk Encryption Password @@ -685,19 +830,24 @@ image::bsdinstall-zfs-geli_password.png[] .Initializing Encryption image::bsdinstall-zfs-init-encription.png[] -The installation then proceeds normally. To continue with the installation go to <<bsdinstall-fetching-distribution>>. +The installation then proceeds normally. +To continue with the installation go to <<bsdinstall-fetching-distribution>>. [[bsdinstall-part-shell]] === Shell Mode Partitioning -When creating advanced installations, the bsdinstall partitioning menus may not provide the level of flexibility required. Advanced users can select the btn:[Shell] option from the partitioning menu in order to manually partition the drives, create the file system(s), populate [.filename]#/tmp/bsdinstall_etc/fstab#, and mount the file systems under [.filename]#/mnt#. Once this is done, type `exit` to return to bsdinstall and continue the installation. +When creating advanced installations, the bsdinstall partitioning menus may not provide the level of flexibility required. +Advanced users can select the btn:[Shell] option from the partitioning menu in order to manually partition the drives, create the file system(s), populate [.filename]#/tmp/bsdinstall_etc/fstab#, and mount the file systems under [.filename]#/mnt#. +Once this is done, type `exit` to return to bsdinstall and continue the installation. [[bsdinstall-fetching-distribution]] == Fetching Distribution Files -Installation time will vary depending on the distributions chosen, installation media, and speed of the computer. A series of messages will indicate the progress. +Installation time will vary depending on the distributions chosen, installation media, and speed of the computer. +A series of messages will indicate the progress. -First, the installer formats the selected disk(s) and initializes the partitions. Next, in the case of a `bootonly media` or `mini memstick`, it downloads the selected components: +First, the installer formats the selected disk(s) and initializes the partitions. +Next, in the case of a `bootonly media` or `mini memstick`, it downloads the selected components: [[bsdinstall-distfile-fetching]] .Fetching Distribution Files @@ -715,7 +865,8 @@ Finally, the verified distribution files are extracted to the disk: .Extracting Distribution Files image::bsdinstall-distfile-extracting.png[] -Once all requested distribution files have been extracted, bsdinstall displays the first post-installation configuration screen. The available post-configuration options are described in the next section. +Once all requested distribution files have been extracted, bsdinstall displays the first post-installation configuration screen. +The available post-configuration options are described in the next section. [[bsdinstall-post]] == Accounts, Time Zone, Services and Hardening @@ -723,7 +874,10 @@ Once all requested distribution files have been extracted, bsdinstall displays t [[bsdinstall-post-root]] === Setting the `root` Password -First, the `root` password must be set. While entering the password, the characters being typed are not displayed on the screen. After the password has been entered, it must be entered again. This helps prevent typing errors. +First, the `root` password must be set. +While entering the password, the characters being typed are not displayed on the screen. +After the password has been entered, it must be entered again. +This helps prevent typing errors. [[bsdinstall-post-set-root-passwd]] .Setting the `root` Password @@ -732,9 +886,11 @@ image::bsdinstall-post-root-passwd.png[] [[bsdinstall-timezone]] === Setting the Time Zone -The next series of menus are used to determine the correct local time by selecting the geographic region, country, and time zone. Setting the time zone allows the system to automatically correct for regional time changes, such as daylight savings time, and perform other time zone related functions properly. +The next series of menus are used to determine the correct local time by selecting the geographic region, country, and time zone. +Setting the time zone allows the system to automatically correct for regional time changes, such as daylight savings time, and perform other time zone related functions properly. -The example shown here is for a machine located in the mainland time zone of Spain, Europe. The selections will vary according to the geographical location. +The example shown here is for a machine located in the mainland time zone of Spain, Europe. +The selections will vary according to the geographical location. [[bsdinstall-timezone-region]] .Select a Region @@ -764,18 +920,22 @@ Confirm the abbreviation for the time zone is correct. .Select Date image::bsdinstall-timezone-date.png[] -The appropriate date is selected using the arrow keys and then pressing btn:[Set Date]. Otherwise, the date selection can be skipped by pressing btn:[Skip]. +The appropriate date is selected using the arrow keys and then pressing btn:[Set Date]. +Otherwise, the date selection can be skipped by pressing btn:[Skip]. [[bsdinstall-timezone-time]] .Select Time image::bsdinstall-timezone-time.png[] -The appropriate time is selected using the arrow keys and then pressing btn:[Set Time]. Otherwise, the time selection can be skipped by pressing btn:[Skip]. +The appropriate time is selected using the arrow keys and then pressing btn:[Set Time]. +Otherwise, the time selection can be skipped by pressing btn:[Skip]. [[bsdinstall-sysconf]] === Enabling Services -The next menu is used to configure which system services will be started whenever the system boots. All of these services are optional. Only start the services that are needed for the system to function. +The next menu is used to configure which system services will be started whenever the system boots. +All of these services are optional. +Only start the services that are needed for the system to function. [[bsdinstall-config-serv]] .Selecting Additional Services to Enable @@ -794,7 +954,9 @@ Here is a summary of the services which can be enabled in this menu: [[bsdinstall-hardening]] === Enabling Hardening Security Options -The next menu is used to configure which security options will be enabled. All of these options are optional. But their use is encouraged. +The next menu is used to configure which security options will be enabled. +All of these options are optional. +But their use is encouraged. [[bsdinstall-hardening-options]] .Selecting Hardening Security Options @@ -817,7 +979,10 @@ Here is a summary of the options which can be enabled in this menu: [[bsdinstall-addusers]] === Add Users -The next menu prompts to create at least one user account. It is recommended to login to the system using a user account rather than as `root`. When logged in as `root`, there are essentially no limits or protection on what can be done. Logging in as a normal user is safer and more secure. +The next menu prompts to create at least one user account. +It is recommended to login to the system using a user account rather than as `root`. +When logged in as `root`, there are essentially no limits or protection on what can be done. +Logging in as a normal user is safer and more secure. Select btn:[Yes] to add new users. @@ -825,7 +990,8 @@ Select btn:[Yes] to add new users. .Add User Accounts image::bsdinstall-adduser1.png[] -Follow the prompts and input the requested information for the user account. The example shown in <<bsdinstall-add-user2>> creates the `asample` user account. +Follow the prompts and input the requested information for the user account. +The example shown in <<bsdinstall-add-user2>> creates the `asample` user account. [[bsdinstall-add-user2]] .Enter User Information @@ -849,13 +1015,16 @@ Here is a summary of the information to input: * `Enter password again` - The password must be typed again for verification. * `Lock out the account after creation?` - Typically `no` so that the user can login. -After entering everything, a summary is shown for review. If a mistake was made, enter `no` and try again. If everything is correct, enter `yes` to create the new user. +After entering everything, a summary is shown for review. +If a mistake was made, enter `no` and try again. +If everything is correct, enter `yes` to create the new user. [[bsdinstall-add-user3]] .Exit User and Group Management image::bsdinstall-adduser3.png[] -If there are more users to add, answer the `Add another user?` question with `yes`. Enter `no` to finish adding users and continue the installation. +If there are more users to add, answer the `Add another user?` question with `yes`. +Enter `no` to finish adding users and continue the installation. For more information on adding users and user management, see crossref:basics[users-synopsis,“Users and Basic Account Management”]. @@ -885,7 +1054,8 @@ After any final configuration is complete, select btn:[Exit]. .Manual Configuration image::bsdinstall-final-modification-shell.png[] -bsdinstall will prompt if there are any additional configuration that needs to be done before rebooting into the new system. Select btn:[Yes] to exit to a shell within the new system or btn:[No] to proceed to the last step of the installation. +bsdinstall will prompt if there are any additional configuration that needs to be done before rebooting into the new system. +Select btn:[Yes] to exit to a shell within the new system or btn:[No] to proceed to the last step of the installation. [[bsdinstall-final-main]] .Complete the Installation @@ -893,13 +1063,24 @@ image::bsdinstall-mainexit.png[] If further configuration or special setup is needed, select btn:[Live CD] to boot the install media into Live CD mode. -If the installation is complete, select btn:[Reboot] to reboot the computer and start the new FreeBSD system. Do not forget to remove the FreeBSD install media or the computer may boot from it again. +If the installation is complete, select btn:[Reboot] to reboot the computer and start the new FreeBSD system. +Do not forget to remove the FreeBSD install media or the computer may boot from it again. -As FreeBSD boots, informational messages are displayed. After the system finishes booting, a login prompt is displayed. At the `login:` prompt, enter the username added during the installation. Avoid logging in as `root`. Refer to crossref:basics[users-superuser,“The Superuser Account”] for instructions on how to become the superuser when administrative access is needed. +As FreeBSD boots, informational messages are displayed. +After the system finishes booting, a login prompt is displayed. +At the `login:` prompt, enter the username added during the installation. +Avoid logging in as `root`. +Refer to crossref:basics[users-superuser,“The Superuser Account”] for instructions on how to become the superuser when administrative access is needed. -The messages that appeared during boot can be reviewed by pressing kbd:[Scroll-Lock] to turn on the scroll-back buffer. The kbd:[PgUp], kbd:[PgDn], and arrow keys can be used to scroll back through the messages. When finished, press kbd:[Scroll-Lock] again to unlock the display and return to the console. To review these messages once the system has been up for some time, type `less /var/run/dmesg.boot` from a command prompt. Press kbd:[q] to return to the command line after viewing. +The messages that appeared during boot can be reviewed by pressing kbd:[Scroll-Lock] to turn on the scroll-back buffer. +The kbd:[PgUp], kbd:[PgDn], and arrow keys can be used to scroll back through the messages. +When finished, press kbd:[Scroll-Lock] again to unlock the display and return to the console. +To review these messages once the system has been up for some time, type `less /var/run/dmesg.boot` from a command prompt. +Press kbd:[q] to return to the command line after viewing. -If sshd was enabled in <<bsdinstall-config-serv>>, the first boot may be a bit slower as the system will generate the RSA and DSA keys. Subsequent boots will be faster. The fingerprints of the keys will be displayed, as seen in this example: +If sshd was enabled in <<bsdinstall-config-serv>>, the first boot may be a bit slower as the system will generate the RSA and DSA keys. +Subsequent boots will be faster. +The fingerprints of the keys will be displayed, as seen in this example: [source,shell] .... @@ -942,9 +1123,12 @@ Starting sshd. Refer to crossref:security[openssh,"OpenSSH"] for more information about fingerprints and SSH. -FreeBSD does not install a graphical environment by default. Refer to crossref:x11[x11,The X Window System] for more information about installing and configuring a graphical window manager. +FreeBSD does not install a graphical environment by default. +Refer to crossref:x11[x11,The X Window System] for more information about installing and configuring a graphical window manager. -Proper shutdown of a FreeBSD computer helps protect data and hardware from damage. _Do not turn off the power before the system has been properly shut down!_ If the user is a member of the `wheel` group, become the superuser by typing `su` at the command line and entering the `root` password. Then, type `shutdown -p now` and the system will shut down cleanly, and if the hardware supports it, turn itself off. +Proper shutdown of a FreeBSD computer helps protect data and hardware from damage. +_Do not turn off the power before the system has been properly shut down!_ If the user is a member of the `wheel` group, become the superuser by typing `su` at the command line and entering the `root` password. +Then, type `shutdown -p now` and the system will shut down cleanly, and if the hardware supports it, turn itself off. [[bsdinstall-network]] == Network Interfaces @@ -952,25 +1136,34 @@ Proper shutdown of a FreeBSD computer helps protect data and hardware from damag [[bsdinstall-config-network-dev]] === Configuring Network Interfaces -Next, a list of the network interfaces found on the computer is shown. Select the interface to configure. +Next, a list of the network interfaces found on the computer is shown. +Select the interface to configure. [[bsdinstall-configure-net-interface]] .Choose a Network Interface image::bsdinstall-configure-network-interface.png[] -If an Ethernet interface is selected, the installer will skip ahead to the menu shown in <<bsdinstall-configure-net-ipv4>>. If a wireless network interface is chosen, the system will instead scan for wireless access points: +If an Ethernet interface is selected, the installer will skip ahead to the menu shown in <<bsdinstall-configure-net-ipv4>>. +If a wireless network interface is chosen, the system will instead scan for wireless access points: [[bsdinstall-wireless-scan]] .Scanning for Wireless Access Points image::bsdinstall-configure-wireless-scan.png[] -Wireless networks are identified by a Service Set Identifier (SSID), a short, unique name given to each network. SSIDs found during the scan are listed, followed by a description of the encryption types available for that network. If the desired SSID does not appear in the list, select btn:[Rescan] to scan again. If the desired network still does not appear, check for problems with antenna connections or try moving the computer closer to the access point. Rescan after each change is made. +Wireless networks are identified by a Service Set Identifier (SSID), a short, unique name given to each network. +SSIDs found during the scan are listed, followed by a description of the encryption types available for that network. +If the desired SSID does not appear in the list, select btn:[Rescan] to scan again. +If the desired network still does not appear, check for problems with antenna connections or try moving the computer closer to the access point. +Rescan after each change is made. [[bsdinstall-wireless-accesspoints]] .Choosing a Wireless Network image::bsdinstall-configure-wireless-accesspoints.png[] -Next, enter the encryption information for connecting to the selected wireless network. WPA2 encryption is strongly recommended as older encryption types, like WEP, offer little security. If the network uses WPA2, input the password, also known as the Pre-Shared Key (PSK). For security reasons, the characters typed into the input box are displayed as asterisks. +Next, enter the encryption information for connecting to the selected wireless network. +WPA2 encryption is strongly recommended as older encryption types, like WEP, offer little security. +If the network uses WPA2, input the password, also known as the Pre-Shared Key (PSK). +For security reasons, the characters typed into the input box are displayed as asterisks. [[bsdinstall-wireless-wpa2]] .WPA2 Setup @@ -982,14 +1175,18 @@ Next, choose whether or not an IPv4 address should be configured on the Ethernet .Choose IPv4 Networking image::bsdinstall-configure-network-interface-ipv4.png[] -There are two methods of IPv4 configuration. DHCP will automatically configure the network interface correctly and should be used if the network provides a DHCP server. Otherwise, the addressing information needs to be input manually as a static configuration. +There are two methods of IPv4 configuration. +DHCP will automatically configure the network interface correctly and should be used if the network provides a DHCP server. +Otherwise, the addressing information needs to be input manually as a static configuration. [NOTE] ==== -Do not enter random network information as it will not work. If a DHCP server is not available, obtain the information listed in <<bsdinstall-collect-network-information, Required Network Information>> from the network administrator or Internet service provider. +Do not enter random network information as it will not work. +If a DHCP server is not available, obtain the information listed in <<bsdinstall-collect-network-information, Required Network Information>> from the network administrator or Internet service provider. ==== -If a DHCP server is available, select btn:[Yes] in the next menu to automatically configure the network interface. The installer will appear to pause for a minute or so as it finds the DHCP server and obtains the addressing information for the system. +If a DHCP server is available, select btn:[Yes] in the next menu to automatically configure the network interface. +The installer will appear to pause for a minute or so as it finds the DHCP server and obtains the addressing information for the system. [[bsdinstall-net-ipv4-dhcp]] .Choose IPv4DHCP Configuration @@ -1011,9 +1208,13 @@ The next screen will ask if the interface should be configured for IPv6. If IPv6 .Choose IPv6 Networking image::bsdinstall-configure-network-interface-ipv6.png[] -IPv6 also has two methods of configuration. StateLess Address AutoConfiguration (SLAAC) will automatically request the correct configuration information from a local router. Refer to http://tools.ietf.org/html/rfc4862[rfc4862] for more information. Static configuration requires manual entry of network information. +IPv6 also has two methods of configuration. +StateLess Address AutoConfiguration (SLAAC) will automatically request the correct configuration information from a local router. +Refer to http://tools.ietf.org/html/rfc4862[rfc4862] for more information. +Static configuration requires manual entry of network information. -If an IPv6 router is available, select btn:[Yes] in the next menu to automatically configure the network interface. The installer will appear to pause for a minute or so as it finds the router and obtains the addressing information for the system. +If an IPv6 router is available, select btn:[Yes] in the next menu to automatically configure the network interface. +The installer will appear to pause for a minute or so as it finds the router and obtains the addressing information for the system. [[bsdinstall-net-ipv6-slaac]] .Choose IPv6 SLAAC Configuration @@ -1028,13 +1229,18 @@ image::bsdinstall-configure-network-interface-ipv6-static.png[] * `IPv6 Address` - The IPv6 address assigned to this computer. The address must be unique and not already in use by another piece of equipment on the local network. * `Default Router` - The IPv6 address of the network's default gateway. -The last network configuration menu is used to configure the Domain Name System (DNS) resolver, which converts hostnames to and from network addresses. If DHCP or SLAAC was used to autoconfigure the network interface, the `Resolver Configuration` values may already be filled in. Otherwise, enter the local network's domain name in the `Search` field. `DNS #1` and `DNS #2` are the IPv4 and/or IPv6 addresses of the DNS servers. At least one DNS server is required. +The last network configuration menu is used to configure the Domain Name System (DNS) resolver, which converts hostnames to and from network addresses. +If DHCP or SLAAC was used to autoconfigure the network interface, the `Resolver Configuration` values may already be filled in. +Otherwise, enter the local network's domain name in the `Search` field. +`DNS #1` and `DNS #2` are the IPv4 and/or IPv6 addresses of the DNS servers. +At least one DNS server is required. [[bsdinstall-net-dns-config]] .DNS Configuration image::bsdinstall-configure-network-ipv4-dns.png[] -Once the interface is configured, select a mirror site that is located in the same region of the world as the computer on which FreeBSD is being installed. Files can be retrieved more quickly when the mirror is close to the target computer, reducing installation time. +Once the interface is configured, select a mirror site that is located in the same region of the world as the computer on which FreeBSD is being installed. +Files can be retrieved more quickly when the mirror is close to the target computer, reducing installation time. [[bsdinstall-netinstall-mirror]] .Choosing a Mirror @@ -1045,28 +1251,39 @@ image::bsdinstall-netinstall-mirrorselect.png[] This section covers basic installation troubleshooting, such as common problems people have reported. -Check the Hardware Notes (link:https://www.FreeBSD.org/releases/[https://www.freebsd.org/releases/]) document for the version of FreeBSD to make sure the hardware is supported. If the hardware is supported and lock-ups or other problems occur, build a custom kernel using the instructions in crossref:kernelconfig[kernelconfig,Configuring the FreeBSD Kernel] to add support for devices which are not present in the [.filename]#GENERIC# kernel. The default kernel assumes that most hardware devices are in their factory default configuration in terms of IRQs, I/O addresses, and DMA channels. If the hardware has been reconfigured, a custom kernel configuration file can tell FreeBSD where to find things. +Check the Hardware Notes (link:https://www.FreeBSD.org/releases/[https://www.freebsd.org/releases/]) document for the version of FreeBSD to make sure the hardware is supported. +If the hardware is supported and lock-ups or other problems occur, build a custom kernel using the instructions in crossref:kernelconfig[kernelconfig,Configuring the FreeBSD Kernel] to add support for devices which are not present in the [.filename]#GENERIC# kernel. +The default kernel assumes that most hardware devices are in their factory default configuration in terms of IRQs, I/O addresses, and DMA channels. +If the hardware has been reconfigured, a custom kernel configuration file can tell FreeBSD where to find things. [NOTE] ==== -Some installation problems can be avoided or alleviated by updating the firmware on various hardware components, most notably the motherboard. Motherboard firmware is usually referred to as the BIOS. Most motherboard and computer manufacturers have a website for upgrades and upgrade information. +Some installation problems can be avoided or alleviated by updating the firmware on various hardware components, most notably the motherboard. +Motherboard firmware is usually referred to as the BIOS. +Most motherboard and computer manufacturers have a website for upgrades and upgrade information. -Manufacturers generally advise against upgrading the motherboard BIOS unless there is a good reason for doing so, like a critical update. The upgrade process _can_ go wrong, leaving the BIOS incomplete and the computer inoperative. +Manufacturers generally advise against upgrading the motherboard BIOS unless there is a good reason for doing so, like a critical update. +The upgrade process _can_ go wrong, leaving the BIOS incomplete and the computer inoperative. ==== -If the system hangs while probing hardware during boot, or it behaves strangely during install, ACPI may be the culprit. FreeBSD makes extensive use of the system ACPI service on the i386 and amd64 platforms to aid in system configuration if it is detected during boot. Unfortunately, some bugs still exist in both the ACPI driver and within system motherboards and BIOS firmware. ACPI can be disabled by setting the `hint.acpi.0.disabled` hint in the third stage boot loader: +If the system hangs while probing hardware during boot, or it behaves strangely during install, ACPI may be the culprit. +FreeBSD makes extensive use of the system ACPI service on the i386 and amd64 platforms to aid in system configuration if it is detected during boot. +Unfortunately, some bugs still exist in both the ACPI driver and within system motherboards and BIOS firmware. +ACPI can be disabled by setting the `hint.acpi.0.disabled` hint in the third stage boot loader: [source,shell] .... set hint.acpi.0.disabled="1" .... -This is reset each time the system is booted, so it is necessary to add `hint.acpi.0.disabled="1"` to the file [.filename]#/boot/loader.conf#. More information about the boot loader can be found in crossref:boot[boot-synopsis,“Synopsis”]. +This is reset each time the system is booted, so it is necessary to add `hint.acpi.0.disabled="1"` to the file [.filename]#/boot/loader.conf#. +More information about the boot loader can be found in crossref:boot[boot-synopsis,“Synopsis”]. [[using-live-cd]] == Using the Live CD -The welcome menu of bsdinstall, shown in <<bsdinstall-choose-mode>>, provides a btn:[Live CD] option. This is useful for those who are still wondering whether FreeBSD is the right operating system for them and want to test some of the features before installing. +The welcome menu of bsdinstall, shown in <<bsdinstall-choose-mode>>, provides a btn:[Live CD] option. +This is useful for those who are still wondering whether FreeBSD is the right operating system for them and want to test some of the features before installing. The following points should be noted before using the btn:[Live CD]: |