diff --git a/documentation/content/en/books/handbook/bsdinstall/_index.adoc b/documentation/content/en/books/handbook/bsdinstall/_index.adoc --- a/documentation/content/en/books/handbook/bsdinstall/_index.adoc +++ b/documentation/content/en/books/handbook/bsdinstall/_index.adoc @@ -52,83 +52,23 @@ [[bsdinstall-synopsis]] == Synopsis -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/prodview-ukzmy5dzc6nbq[AWS Marketplace], https://azuremarketplace.microsoft.com/en-US/marketplace/apps/thefreebsdfoundation.freebsd-13_0[Microsoft Azure Marketplace], and https://console.cloud.google.com/marketplace/product/freebsd-cloud/freebsd-13[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]. -* SD card images, for embedded systems such as Raspberry Pi or BeagleBone Black. These can be downloaded from the https://www.freebsd.org/where/[Download FreeBSD] page. These files must be uncompressed and written as a raw image to an SD card, from which the board will then boot. -* Installation images, to install FreeBSD on a hard drive for the usual desktop, laptop, or server systems. - -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. - -[NOTE] -==== -Users who prefer to install FreeBSD using a graphical installer may be interested in https://ghostbsd.org[GhostBSD], https://www.midnightbsd.org[MidnightBSD] or https://nomadbsd.org[NomadBSD]. -==== +FreeBSD supports a wide variety of architectures: x86_64, ARM(R), RISC-V, PowerPC(R) among many others. After reading this chapter, you will know: -* The minimum hardware requirements and FreeBSD supported architectures. -* How to create the FreeBSD installation media. +* How to get FreeBSD and create the FreeBSD installation media. * How to start bsdinstall. * The questions bsdinstall will ask, what they mean, and how to answer them. * How to troubleshoot a failed installation. * How to access a live version of FreeBSD before committing to an installation. -Before reading this chapter, you should: - -* Read the supported hardware list that shipped with the version of FreeBSD to be installed and verify that the system's hardware is supported. - [[bsdinstall-hardware]] == Minimum Hardware Requirements -The hardware requirements to install FreeBSD vary by architecture. +The hardware requirements to install FreeBSD vary by architecture and version. 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. - -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. -+ -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. -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. - -arm64:: -Most embedded boards are 64-bit ARM computers. -A number of arm64 servers are supported. - -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. -+ -A 32-bit kernel can only use the first 2 GB of RAM. - [[bsdinstall-pre]] == Pre-Installation Tasks @@ -136,9 +76,10 @@ 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. +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. @@ -159,15 +100,14 @@ 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 (https://gparted.org/livecd.php[https://gparted.org/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 link:https://en.wikipedia.org/wiki/List_of_disk_partitioning_software[List of disk partitioning software wikipedia entry]. +link:https://gparted.org/livecd.php[GParted Live] is a free live CD which includes the GParted partition editor. + [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. -==== +====== + 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. @@ -192,10 +132,10 @@ + 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/{rel130-current}R/errata/[https://www.freebsd.org/releases/{rel130-current}R/errata/]) on the FreeBSD web site. +As these problems are discovered and fixed, they are noted in the FreeBSD Errata page of each version. 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/]). +Information and errata for all the releases can be found on the link:https://www.FreeBSD.org/releases/[FreeBSD Release Information] page. +==== [[bsdinstall-installation-media]] === Prepare the Installation Media @@ -203,28 +143,23 @@ 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/]. +FreeBSD installation files are available at the link:https://www.FreeBSD.org/where/[FreeBSD download page]. Each installation file's name includes the release version of FreeBSD, the architecture, and the type of file. -For example, to install FreeBSD 13.0 on an amd64 system from a DVD, download [.filename]#FreeBSD-13.0-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. +Installation files are available in several formats, compressed with man:xz[1] and uncompressed. 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#. - File types: -* `-bootonly.iso`: This is the smallest installation file as it only contains the installer. A working Internet connection is required during installation as the installer will download the files it needs to complete the FreeBSD installation. This file should be burned to a CD using a CD burning application. -* `-disc1.iso`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It should be burned to a CD using a CD burning application. -* `-dvd1.iso`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It also contains a set of popular binary packages for installing a window manager and some applications so that a complete system can be installed from media without requiring a connection to the Internet. This file should be burned to a DVD using a DVD burning application. -* `-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 <>. +* `*-bootonly.iso*`: This is the smallest installation file as it only contains the installer. A working Internet connection is required during installation as the installer will download the files it needs to complete the FreeBSD installation. This file should be burned to a CD using a CD burning application. +* `*-disc1.iso*`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It should be burned to a CD using a CD burning application. +* `*-dvd1.iso*`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It also contains a set of popular binary packages for installing a window manager and some applications so that a complete system can be installed from media without requiring a connection to the Internet. This file should be burned to a DVD using a DVD burning application. +* `*-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 <>. After downloading the image file, download at least one _checksum_ file from the same directory. There are two _checksum_ files available, named after the release number and the architecture name. -For example: [.filename]#CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64# and [.filename]#CHECKSUM.SHA512-FreeBSD-13.1-RELEASE-amd64#. +For example: `CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64` and `CHECKSUM.SHA512-FreeBSD-13.1-RELEASE-amd64`. After downloading one of the files (or both), calculate the _checksum_ for the image file and compare it with the one shown in the _checksum_ file. Note that you need to compare the calculated _checksum_ against the correct file, as they correspond to two different algorithms: SHA256 and SHA512. @@ -238,15 +173,16 @@ % sha256sum -c CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64 FreeBSD-13.1-RELEASE-amd64-dvd1.iso FreeBSD-13.1-RELEASE-amd64-dvd1.iso: OK .... + 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. +The `\*.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. +Several applications are available for writing the `*.img` to a USB stick. This section describes two of these utilities. [IMPORTANT] @@ -257,14 +193,14 @@ [[bsdinstall-usb-dd]] [.procedure] -**** +==== *Procedure. Using `dd` to Write the Image* + [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 `/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. + @@ -274,25 +210,26 @@ .... + If this command fails, verify that the USB stick is not mounted and that the device name is for the disk, not a partition. ++ Some operating systems might require this command to be run with man:sudo[8]. The man:dd[1] syntax varies slightly across different platforms; for example, Mac OS(R) requires a lower-case `bs=1m`. Systems like Linux(R) might buffer writes. To force all writes to complete, use man:sync[8]. -**** +==== [.procedure] -**** +==== *Procedure. Using Windows(R) to Write the Image* + [WARNING] -==== - +====== Be sure to give the correct drive letter as the existing data on the specified drive will be overwritten and destroyed. -==== +====== + . *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. +Download it from https://sourceforge.net/projects/win32diskimager/[win32diskimager home page] and extract it into a folder. . *Writing the Image with Image Writer* + @@ -302,9 +239,7 @@ 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. +==== [[bsdinstall-start]] == Starting the Installation @@ -330,31 +265,6 @@ 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]. - -If the computer loads the existing operating system instead of the FreeBSD installer, then either: - -. The installation media was not inserted early enough in the boot process. Leave the media inserted and try restarting the computer. -. The BIOS changes were incorrect or not saved. Double-check that the right boot device is selected as the first boot device. -. This system is too old to support booting from the chosen media. In this case, the Plop Boot Manager (http://www.plop.at/en/bootmanagers.html[]) can be used to boot the system from the selected media. - -=== 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 - -[source,shell] -.... - boot cd:,\ppc\loader cd:0 -.... - [[bsdinstall-view-probe]] === FreeBSD Boot Menu @@ -362,7 +272,7 @@ [[bsdinstall-newboot-loader-menu]] .FreeBSD Boot Loader Menu -image::bsdinstall-newboot-loader-menu.png[] +image::bsdinstall-newboot-loader-menu.png[FreeBSD boot loader menu] 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]. @@ -373,6 +283,7 @@ * `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. * `Escape to loader prompt`: This will boot the system into a repair prompt that contains a limited number of low-level commands. This prompt is described in crossref:boot[boot-loader,“Stage Three”]. Press kbd:[3] or kbd:[Esc] to boot into this prompt. * `Reboot`: Reboots the system. +* `Cons`: Allow to continue the installation by `video`, `serial`, `Dual (serial primary)` or `Dual (Video primary)` * `Kernel`: Loads a different kernel. * `Boot Options`: Opens the menu shown in, and described under, <>. @@ -398,7 +309,7 @@ [[bsdinstall-choose-mode]] .Welcome Menu -image::bsdinstall-choose-mode.png[] +image::bsdinstall-choose-mode.png[FreeBSD installation welcome menu] 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. @@ -424,11 +335,11 @@ [[bsdinstall-keymap]] === Selecting the Keymap Menu -Before starting the process, bsdinstall will load the keymap files as show in <>. +Before starting the process, bsdinstall will load the keymap files as shown in <>. [[bsdinstall-keymap-loading]] .Keymap Loading -image::bsdinstall-keymap-loading.png[] +image::bsdinstall-keymap-loading.png[Keymap loading] After the keymaps have been loaded, bsdinstall displays the menu shown in <>. Use the up and down arrows to select the keymap that most closely represents the mapping of the keyboard attached to the system. @@ -436,7 +347,7 @@ [[bsdinstall-keymap-10]] .Keymap Selection Menu -image::bsdinstall-keymap-10.png[] +image::bsdinstall-keymap-10.png[Keymap selection menu showing all supported keyboards] [NOTE] ==== @@ -448,7 +359,7 @@ [[bsdinstall-keymap-testing]] .Keymap Testing Menu -image::bsdinstall-keymap-testing.png[] +image::bsdinstall-keymap-testing.png[Keymap testing menu] [[bsdinstall-hostname]] === Setting the Hostname @@ -457,7 +368,7 @@ [[bsdinstall-config-hostname]] .Setting the Hostname -image::bsdinstall-config-hostname.png[] +image::bsdinstall-config-hostname.png[Setting the hostname] Type in a hostname that is unique for the network. It should be a fully-qualified hostname, such as `machine3.example.com`. @@ -469,7 +380,7 @@ [[bsdinstall-config-components]] .Selecting Components to Install -image::bsdinstall-config-components.png[] +image::bsdinstall-config-components.png[Different components that can be installed. Example: base-dbg, lib32, ports, etc.] 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. @@ -494,13 +405,13 @@ [[bsdinstall-netinstall]] === Installing from the Network -The menu shown in <> 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. +The menu shown in <> only appears when installing from a `-bootonly.iso` `-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-netinstall-notify]] .Installing from the Network -image::bsdinstall-netinstall-files.png[] +image::bsdinstall-netinstall-files.png[Indicates that certain components have not been found and will be downloaded using the network.] [[bsdinstall-partitioning]] == Allocating Disk Space @@ -509,14 +420,14 @@ [[bsdinstall-zfs-partmenu]] .Partitioning Choices -image::bsdinstall-zfs-partmenu.png[] +image::bsdinstall-zfs-partmenu.png[Shows the different partition options. Example: Manual, Shell, etc.] bsdinstall gives the user four methods for allocating disk space: +* `Auto (ZFS)` partitioning creates a root-on-ZFS system with optional GELI encryption support for _boot environments_. * `Auto (UFS)` partitioning automatically sets up the disk partitions using the `UFS` file system. * `Manual` partitioning allows advanced users to create customized partitions from menu options. * `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. @@ -525,22 +436,22 @@ === 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#. +Thus, smaller and heavier-accessed file systems should be closer to the outside of the drive, while larger partitions like `/usr` should be placed toward the inner parts of the disk. +It is a good idea to create partitions in an order similar to: `/`, swap, `/var`, and `/usr`. -The size of the [.filename]#/var# partition reflects the intended machine's usage. +The size of the `/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#. +On average, most users rarely need more than about a gigabyte of free disk space in `/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 `/var/tmp`. +When new software is installed, the packaging tools extract a temporary copy of the packages under `/var/tmp`. +Large software packages, like Firefox or LibreOffice may be tricky to install if there is not enough disk space under `/var/tmp`. ==== -The [.filename]#/usr# partition holds many of the files which support the system, including the FreeBSD Ports Collection and system source code. +The `/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. @@ -559,7 +470,7 @@ 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. +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 `/var` to the edge. [[bsdinstall-part-guided]] === Guided Partitioning Using UFS @@ -569,7 +480,8 @@ [[bsdinstall-part-guided-disk]] .Selecting from Multiple Disks -image::bsdinstall-part-guided-disk.png[] +image::bsdinstall-part-guided-disk.png[Shows the list of disks on which FreeBSD can be installed] + 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. @@ -577,13 +489,13 @@ [[bsdinstall-part-entire-part]] .Selecting Entire Disk or Partition -image::bsdinstall-part-entire-part.png[] +image::bsdinstall-part-entire-part.png[Menu asking the user if he wants to use all the available space on the disk or wants to make a partition] -After btn:[Entire Disk] is chosen, bsdinstall displays a dialog indicating that the disk will be erased. +After the btn:[Entire Disk] option is chosen, bsdinstall displays a dialog indicating that the disk will be erased. [[bsdinstall-ufs-warning]] .Confirmation -image::bsdinstall-ufs-warning.png[] +image::bsdinstall-ufs-warning.png[Menu indicating the user that all data on the disk will be deleted and asking for confirmation] The next menu shows a list with the available partition scheme types. GPT is usually the most appropriate choice for amd64 computers. @@ -593,7 +505,7 @@ [[bsdinstall-ufs-scheme]] .Select Partition Scheme -image::bsdinstall-part-manual-partscheme.png[] +image::bsdinstall-part-manual-partscheme.png[Menu showing the user the different the different types of partition that exist and requesting one of them] 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. Pressing btn:[Auto] will recreate the automatic FreeBSD partitions. @@ -611,7 +523,7 @@ [[bsdinstall-ufs-final-confirmation]] .Final Confirmation -image::bsdinstall-final-confirmation.png[] +image::bsdinstall-final-confirmation.png[Menu indicating to the user that all changes will be written to disk and informing that if he decides to continue the existing data will be permanently deleted.] To continue with the installation process, go to <>. @@ -622,13 +534,13 @@ [[bsdinstall-part-manual-create]] .Manually Create Partitions -image::bsdinstall-part-manual-create.png[] +image::bsdinstall-part-manual-create.png[Menu showing the Partition Editor.] -Highlight the installation drive ([.filename]#ada0# in this example) and select btn:[Create] to display a menu of available partition schemes: +Highlight the installation drive (`ada0` in this example) and select btn:[Create] to display a menu of available partition schemes: [[bsdinstall-part-manual-partscheme]] .Manually Create Partitions -image::bsdinstall-part-manual-partscheme.png[] +image::bsdinstall-part-manual-partscheme.png[Menu showing the different kind of partition schemes] GPT is usually the most appropriate choice for amd64 computers. Older computers that are not compatible with GPT should use MBR. @@ -636,7 +548,7 @@ [[partition-schemes]] .Partitioning Schemes -[cols="1,1", frame="none", options="header"] +[cols="25h,~", frame="none", options="header"] |=== <| Abbreviation <| Description @@ -648,10 +560,10 @@ |BSD label without an MBR, sometimes called _dangerously dedicated mode_ as non-BSD disk utilities may not recognize it. |GPT -|GUID Partition Table (http://en.wikipedia.org/wiki/GUID_Partition_Table[http://en.wikipedia.org/wiki/GUID_Partition_Table]). +|link:https://en.wikipedia.org/wiki/GUID_Partition_Table[GUID Partition Table]. |MBR -|Master Boot Record (http://en.wikipedia.org/wiki/Master_boot_record[http://en.wikipedia.org/wiki/Master_boot_record]). +|link:https://en.wikipedia.org/wiki/Master_boot_record[Master Boot Record]. |=== After the partitioning scheme has been selected and created, select btn:[Create] again to create the partitions. @@ -659,7 +571,7 @@ [[bsdinstall-part-manual-addpart]] .Manually Create Partitions -image::bsdinstall-part-manual-addpart.png[] +image::bsdinstall-part-manual-addpart.png[Menu requesting type, size, mountpoint and label for the new partition.] A standard FreeBSD GPT installation uses at least three partitions: @@ -670,7 +582,7 @@ Refer to man:gpart[8] for descriptions of the available GPT partition types. -Multiple file system partitions can be created. Some people prefer a traditional layout with separate partitions for [.filename]#/#, [.filename]#/var#, [.filename]#/tmp#, and [.filename]#/usr#. +Multiple file system partitions can be created. Some people prefer a traditional layout with separate partitions for `/`, `/var`, `/tmp`, and `/usr`. See <> for an example. The `Size` may be entered with common abbreviations: _K_ for kilobytes, _M_ for megabytes, or _G_ for gigabytes. @@ -683,13 +595,13 @@ ==== 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]#/#. +If only a single UFS partition will be created, the mountpoint should be `/`. 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/#. +Referring to labels instead of drive names and partition numbers in files like `/etc/fstab` makes the system more tolerant to hardware changes. +GPT labels appear in `/dev/gpt/` when a disk is attached. +Other partitioning schemes have different label capabilities and their labels appear in different directories in `/dev/`. [TIP] ==== @@ -702,12 +614,12 @@ .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. +For a traditional partition layout where the `/`, `/var`, `/tmp`, and `/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. +If more space is available on the target disk, larger swap or `/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. +By default, FreeBSD's `gptboot` expects the first UFS partition to be the `/` partition. [.informaltable] [cols="1,1,1,1", frame="none", options="header"] @@ -724,7 +636,7 @@ |`freebsd-ufs` |`2G` -|[.filename]#/# +|`/` |`exrootfs` |`freebsd-swap` @@ -734,17 +646,17 @@ |`freebsd-ufs` |`2G` -|[.filename]#/var# +|`/var` |`exvarfs` |`freebsd-ufs` |`1G` -|[.filename]#/tmp# +|`/tmp` |`extmpfs` |`freebsd-ufs` |accept the default (remainder of the disk) -|[.filename]#/usr# +|`/usr` |`exusrfs` |=== ==== @@ -759,7 +671,7 @@ [[bsdinstall-zfs-menu]] .ZFS Partitioning Menu -image::bsdinstall-zfs-menu.png[] +image::bsdinstall-zfs-menu.png[Menu showing the different options to configure the ZFS pool] Here is a summary of the options in this menu: @@ -768,18 +680,18 @@ * `Rescan Devices` - Repopulate the list of available disks. * `Disk Info` - This menu can be used to inspect each disk, including its partition table and various other information such as the device model number and serial number, if available. * `Pool Name` - Establish the name of the pool. The default name is _zroot_. -* `Force 4K Sectors?` - Force the use of 4K sectors. By default, the installer will automatically create partitions aligned to 4K boundaries and force ZFS to use 4K sectors. This is safe even with 512 byte sector disks, and has the added benefit of ensuring that pools created on 512 byte disks will be able to have 4K sector disks added in the future, either as additional storage space or as replacements for failed disks. Press the kbd:[Enter] key to chose to activate it or not. -* `Encrypt Disks?` - Encrypting the disks allows the user to encrypt the disks using GELI. More information about disk encryption is available in crossref:disks[disks-encrypting-geli,“Disk Encryption with geli”]. Press the kbd:[Enter] key to chose activate it or not. -* `Partition Scheme` - Choose the partition scheme. GPT is the recommended option in most cases. Press the kbd:[Enter] key to chose between the different options. +* `Force 4K Sectors?` - Force the use of 4K sectors. By default, the installer will automatically create partitions aligned to 4K boundaries and force ZFS to use 4K sectors. This is safe even with 512 byte sector disks, and has the added benefit of ensuring that pools created on 512 byte disks will be able to have 4K sector disks added in the future, either as additional storage space or as replacements for failed disks. Press the kbd:[Enter] key to choose to activate it or not. +* `Encrypt Disks?` - Encrypting the disks allows the user to encrypt the disks using GELI. More information about disk encryption is available in crossref:disks[disks-encrypting-geli,“Disk Encryption with geli”]. Press the kbd:[Enter] key to choose whether to activate it or not. +* `Partition Scheme` - Choose the partition scheme. GPT is the recommended option in most cases. Press the kbd:[Enter] key to choose between the different options. * `Swap Size` - Establish the amount of swap space. * `Mirror Swap?` - Whether to mirror the swap between the disks. Be aware that enabling mirror swap will break crash dumps. Press the kbd:[Enter] key to activate it or not. -* `Encrypt Swap?` - Whether to encrypt the swap. This will encrypt the swap with a temporary key each time the system boots, and discards it on reboot. Press the kbd:[Enter] key to chose activate it or not. More information about swap encryption in crossref:disks[swap-encrypting,“Encrypting Swap”]. +* `Encrypt Swap?` - Whether to encrypt the swap. This will encrypt the swap with a temporary key each time the system boots, and discards it on reboot. Press the kbd:[Enter] key to choose to activate it or not. More information about swap encryption in crossref:disks[swap-encrypting,“Encrypting Swap”]. Select kbd:[T] to configure the `Pool Type` and the disk(s) that will constitute the pool. [[bsdinstall-zfs-vdev_type]] .ZFS Pool Type -image::bsdinstall-zfs-vdev_type.png[] +image::bsdinstall-zfs-vdev_type.png[Menu requesting the Virtual Device type. Ex: stripe, mirror, raidz1] Here is a summary of the `Pool Type` that can be selected in this menu: @@ -796,55 +708,55 @@ [[bsdinstall-zfs-disk_select]] .Disk Selection -image::bsdinstall-zfs-disk_select.png[] +image::bsdinstall-zfs-disk_select.png[Menu requesting how many disks will be added to the pool] [[bsdinstall-zfs-vdev_invalid]] .Invalid Selection -image::bsdinstall-zfs-vdev_invalid.png[] +image::bsdinstall-zfs-vdev_invalid.png[Menu indicating that not enough disks have been selected.] If one or more disks are missing from the list, or if disks were attached after the installer was started, select btn:[- Rescan Devices] to repopulate the list of available disks. [[bsdinstall-zfs-rescan-devices]] .Rescan Devices -image::bsdinstall-zfs-rescan-devices.png[] +image::bsdinstall-zfs-rescan-devices.png[Device rescan] To avoid accidentally erasing the wrong disk, the btn:[- Disk Info] menu can be used to inspect each disk, including its partition table and various other information such as the device model number and serial number, if available. [[bsdinstall-zfs-disk_info]] .Analyzing a Disk -image::bsdinstall-zfs-disk_info.png[] +image::bsdinstall-zfs-disk_info.png[Menu showing the information of the partitions.] Select kbd:[N] to configure the `Pool Name`. Enter the desired name, then select btn:[] to establish it or btn:[] to return to the main menu and leave the default name. [[bsdinstall-zfs-pool-name]] .Pool Name -image::bsdinstall-zfs-pool-name.png[] +image::bsdinstall-zfs-pool-name.png[Menu requesting the name of the pool.] Select kbd:[S] to set the amount of swap. Enter the desired amount of swap, then select btn:[] to establish it or btn:[] to return to the main menu and let the default amount. [[bsdinstall-zfs-swap-amount]] .Swap Amount -image::bsdinstall-zfs-swap-amount.png[] +image::bsdinstall-zfs-swap-amount.png[Menu requesting the amount of swap memory] 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[] +image::bsdinstall-zfs-warning.png[Menu indicating to the user that the data will be lost] If GELI disk encryption was enabled, the installer will prompt twice for the passphrase to be used to encrypt the disks. Initialization of the encryption then begins. [[bsdinstall-zfs-geli_password]] .Disk Encryption Password -image::bsdinstall-zfs-geli_password.png[] +image::bsdinstall-zfs-geli_password.png[Menu requesting the password to encrypt the devices.] [[bsdinstall-zfs-init-encription]] .Initializing Encryption -image::bsdinstall-zfs-init-encription.png[] +image::bsdinstall-zfs-init-encription.png[Menu showing that the encryption is initializing.] The installation then proceeds normally. To continue with the installation, go to <>. @@ -853,7 +765,7 @@ === 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#. +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 `/tmp/bsdinstall_etc/fstab`, and mount the file systems under `/mnt`. Once this is done, type `exit` to return to bsdinstall and continue the installation. [[bsdinstall-fetching-distribution]] @@ -867,19 +779,19 @@ [[bsdinstall-distfile-fetching]] .Fetching Distribution Files -image::bsdinstall-distfile-fetching.png[] +image::bsdinstall-distfile-fetching.png[Menu showing the download of the different components.] Next, the integrity of the distribution files is verified to ensure they have not been corrupted during download or misread from the installation media: [[bsdinstall-distfile-verify]] .Verifying Distribution Files -image::bsdinstall-distfile-verifying.png[] +image::bsdinstall-distfile-verifying.png[Menu showing the verification of the different components.] Finally, the verified distribution files are extracted to the disk: [[bsdinstall-distfile-extract]] .Extracting Distribution Files -image::bsdinstall-distfile-extracting.png[] +image::bsdinstall-distfile-extracting.png[Menu showing the extraction of the different components.] 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. @@ -896,7 +808,7 @@ [[bsdinstall-post-set-root-passwd]] .Setting the `root` Password -image::bsdinstall-post-root-passwd.png[] +image::bsdinstall-post-root-passwd.png[Menu showing requesting the password for the root user.] [[bsdinstall-timezone]] === Setting the Time Zone @@ -909,38 +821,38 @@ [[bsdinstall-timezone-region]] .Select a Region -image::bsdinstall-timezone-region.png[] +image::bsdinstall-timezone-region.png[Menu requesting the timezone region.] The appropriate region is selected using the arrow keys and then pressing kbd:[Enter]. [[bsdinstall-timezone-country]] .Select a Country -image::bsdinstall-timezone-country.png[] +image::bsdinstall-timezone-country.png[Menu requesting the timezone country.] Select the appropriate country using the arrow keys and press kbd:[Enter]. [[bsdinstall-timezone-zone]] .Select a Time Zone -image::bsdinstall-timezone-zone.png[] +image::bsdinstall-timezone-zone.png[Menu requesting the timezone zone.] The appropriate time zone is selected using the arrow keys and pressing kbd:[Enter]. [[bsdinstall-timezone-confirmation]] .Confirm Time Zone -image::bsdinstall-timezone-confirm.png[] +image::bsdinstall-timezone-confirm.png[Menu requesting confirmation of the selected timezone.] Confirm the abbreviation for the time zone is correct. [[bsdinstall-timezone-date]] .Select Date -image::bsdinstall-timezone-date.png[] +image::bsdinstall-timezone-date.png[Menu requesting the system date.] 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[] +image::bsdinstall-timezone-time.png[Menu requesting the system time.] 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]. @@ -954,7 +866,7 @@ [[bsdinstall-config-serv]] .Selecting Additional Services to Enable -image::bsdinstall-config-services.png[] +image::bsdinstall-config-services.png[Menu showing the different services available.] Here is a summary of the services that can be enabled in this menu: @@ -975,7 +887,7 @@ [[bsdinstall-hardening-options]] .Selecting Hardening Security Options -image::bsdinstall-hardening.png[] +image::bsdinstall-hardening.png[Menu shoring the different hardening security options.] Here is a summary of the options that can be enabled in this menu: @@ -985,11 +897,12 @@ * `read_msgbuf` - Disable reading kernel message buffer for unprivileged users. Prevent unprivileged users from using man:dmesg[8] to view messages from the kernel's log buffer. * `proc_debug` - Disable process debugging facilities for unprivileged users. Disables a variety of unprivileged inter-process debugging services, including some procfs functionality, `ptrace()`, and `ktrace()`. Please note that this will also prevent debugging tools such as man:lldb[1], man:truss[1] and man:procstat[1], as well as some built-in debugging facilities in certain scripting languages like PHP. * `random_pid` - Randomize the PID of processes. -* `clear_tmp` - Clean [.filename]#/tmp# when the system starts up. +* `clear_tmp` - Clean `/tmp` when the system starts up. * `disable_syslogd` - Disable opening the syslogd network socket. By default, FreeBSD runs syslogd in a secure way with `-s`. This prevents the daemon from listening for incoming UDP requests on port 514. With this option enabled, syslogd will instead run with `-ss`, which prevents syslogd from opening any port. For more information, see man:syslogd[8]. * `disable_sendmail` - Disable the sendmail mail transport agent. * `secure_console` - Make the command prompt request the `root` password when entering single-user mode. * `disable_ddtrace` - DTrace can run in a mode that affects the running kernel. Destructive actions may not be used unless explicitly enabled. Use `-w` to enable this option when using DTrace. For more information, see man:dtrace[1]. +* `enable_aslr` - Enable address layout randomization. For more information about address layout randomization the link:https://en.wikipedia.org/wiki/Address_space_layout_randomization[Wikipedia article] can be consulted. [[bsdinstall-addusers]] === Add Users @@ -1003,14 +916,14 @@ [[bsdinstall-add-user1]] .Add User Accounts -image::bsdinstall-adduser1.png[] +image::bsdinstall-adduser1.png[Menu requesting if a user want to be added to the system.] Follow the prompts and input the requested information for the user account. The example shown in <> creates the `asample` user account. [[bsdinstall-add-user2]] .Enter User Information -image::bsdinstall-adduser2.png[] +image::bsdinstall-adduser2.png[Menu requesting different information for the new user.] Here is a summary of the information to input: @@ -1036,7 +949,7 @@ [[bsdinstall-add-user3]] .Exit User and Group Management -image::bsdinstall-adduser3.png[] +image::bsdinstall-adduser3.png[Menu showing the information of the new user and requesting if everything is correct.] 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. @@ -1050,7 +963,7 @@ [[bsdinstall-final-config]] .Final Configuration -image::bsdinstall-finalconfiguration.png[] +image::bsdinstall-finalconfiguration.png[Menu showing different options to perform before finishing the installation. Ex: Add user, Time Zone, etc.] Use this menu to make any changes or to do any additional configuration before completing the installation. @@ -1067,14 +980,14 @@ [[bsdinstall-final-modification-shell]] .Manual Configuration -image::bsdinstall-final-modification-shell.png[] +image::bsdinstall-final-modification-shell.png[Menu showing that the installation has finished. And asking if you want to open a shell to make manual changes.] bsdinstall will prompt for 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 -image::bsdinstall-mainexit.png[] +image::bsdinstall-mainexit.png[Menu showing that the installation has finished and asking whether to reboot the system or access the Live CD.] If further configuration or special setup is needed, select btn:[Live CD] to boot the install media into Live CD mode. @@ -1156,14 +1069,14 @@ [[bsdinstall-configure-net-interface]] .Choose a Network Interface -image::bsdinstall-configure-network-interface.png[] +image::bsdinstall-configure-network-interface.png[Menu showing the different network interfaces to configure.] If an Ethernet interface is selected, the installer will skip ahead to the menu shown in <>. 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[] +image::bsdinstall-configure-wireless-scan.png[Menu showing wireless network scanning.] 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. @@ -1173,7 +1086,7 @@ [[bsdinstall-wireless-accesspoints]] .Choosing a Wireless Network -image::bsdinstall-configure-wireless-accesspoints.png[] +image::bsdinstall-configure-wireless-accesspoints.png[Menu showing the different wireless networks to connect to.] Next, enter the encryption information for connecting to the selected wireless network. WPA2 encryption is strongly recommended over older encryption types such as WEP, which offer little security. @@ -1182,13 +1095,13 @@ [[bsdinstall-wireless-wpa2]] .WPA2 Setup -image::bsdinstall-configure-wireless-wpa2setup.png[] +image::bsdinstall-configure-wireless-wpa2setup.png[Menu requesting the wireless network password.] Next, choose whether or not an IPv4 address should be configured on the Ethernet or wireless interface: [[bsdinstall-configure-net-ipv4]] .Choose IPv4 Networking -image::bsdinstall-configure-network-interface-ipv4.png[] +image::bsdinstall-configure-network-interface-ipv4.png[Menu indicating if IPv4 wants to be configured for the selected interface.] 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. @@ -1205,13 +1118,13 @@ [[bsdinstall-net-ipv4-dhcp]] .Choose IPv4DHCP Configuration -image::bsdinstall-configure-network-interface-ipv4-dhcp.png[] +image::bsdinstall-configure-network-interface-ipv4-dhcp.png[Menu indicating if DHCP wants to be configured for the selected interface.] If a DHCP server is not available, select btn:[No] and input the following addressing information in this menu: [[bsdinstall-net-ipv4-static]] .IPv4 Static Configuration -image::bsdinstall-configure-network-interface-ipv4-static.png[] +image::bsdinstall-configure-network-interface-ipv4-static.png[Menu requesting data to configure IPv4 network.] * `IP Address` - The IPv4 address assigned to this computer. The address must be unique and not already in use by another device on the local network. * `Subnet Mask` - The subnet mask for the network. @@ -1221,7 +1134,7 @@ [[bsdinstall-net-ipv6]] .Choose IPv6 Networking -image::bsdinstall-configure-network-interface-ipv6.png[] +image::bsdinstall-configure-network-interface-ipv6.png[Menu indicating if IPv6 wants to be configured for the selected interface.] IPv6 also has two methods of configuration. StateLess Address AutoConfiguration (SLAAC) will automatically request the correct configuration information from a local router. @@ -1233,13 +1146,13 @@ [[bsdinstall-net-ipv6-slaac]] .Choose IPv6 SLAAC Configuration -image::bsdinstall-configure-network-interface-slaac.png[] +image::bsdinstall-configure-network-interface-slaac.png[Menu indicating if SLAAC wants to be configured for the selected interface.] If an IPv6 router is not available, select btn:[No] and input the following addressing information in this menu: [[bsdinstall-net-ipv6-static]] .IPv6 Static Configuration -image::bsdinstall-configure-network-interface-ipv6-static.png[] +image::bsdinstall-configure-network-interface-ipv6-static.png[Menu requesting data to configure IPv6 network.] * `IPv6 Address` - The IPv6 address assigned to this computer. The address must be unique and not already in use by another device on the local network. * `Default Router` - The IPv6 address of the network's default gateway. @@ -1252,22 +1165,22 @@ [[bsdinstall-net-dns-config]] .DNS Configuration -image::bsdinstall-configure-network-ipv4-dns.png[] +image::bsdinstall-configure-network-ipv4-dns.png[Menu requesting data to configure DNS for the network.] 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 -image::bsdinstall-netinstall-mirrorselect.png[] +image::bsdinstall-netinstall-mirrorselect.png[Menu requesting a network mirror.] [[bsdinstall-install-trouble]] == Troubleshooting 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 locks up 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. +Check the Hardware Notes listed on the link:https://www.FreeBSD.org/releases/[FreeBSD Release Information] page for the version of FreeBSD to make sure the hardware is supported. +If the hardware is supported and locks up 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 `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. @@ -1291,7 +1204,7 @@ 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#. +This is reset each time the system is booted, so it is necessary to add `hint.acpi.0.disabled="1"` to the file `/boot/loader.conf`. More information about the boot loader can be found in crossref:boot[boot-synopsis,“Synopsis”]. [[using-live-cd]] diff --git a/documentation/content/en/books/handbook/introduction/_index.adoc b/documentation/content/en/books/handbook/introduction/_index.adoc --- a/documentation/content/en/books/handbook/introduction/_index.adoc +++ b/documentation/content/en/books/handbook/introduction/_index.adoc @@ -87,7 +87,7 @@ === What Can FreeBSD Do? The applications to which FreeBSD can be put are truly limited only by your own imagination. -From software development to factory automation, inventory control to azimuth correction of remote satellite antennae; if it can be done with a commercial UNIX(R) product then it is more than likely that you can do it with FreeBSD too! FreeBSD also benefits significantly from literally thousands of high quality applications developed by research centers and universities around the world, often available at little to no cost. +From software development to factory automation, inventory control to azimuth correction of remote satellite antenna; if it can be done with a commercial UNIX(R) product then it is more than likely that you can do it with FreeBSD too! FreeBSD also benefits significantly from literally thousands of high quality applications developed by research centers and universities around the world, often available at little to no cost. Because the source code for FreeBSD itself is freely available, the system can also be customized to an almost unheard-of degree for special applications or projects, and in ways not generally possible with operating systems from most major commercial vendors. Here is just a sampling of some of the applications in which people are currently using FreeBSD: @@ -105,7 +105,7 @@ * _Research:_ With source code for the entire system available, FreeBSD is an excellent platform for research in operating systems as well as other branches of computer science. FreeBSD's freely available nature also makes it possible for remote groups to collaborate on ideas or shared development without having to worry about special licensing agreements or limitations on what may be discussed in open forums. * _Networking:_ Need a new router? A name server (DNS)? A firewall to keep people out of your internal network? FreeBSD can easily turn that unused PC sitting in the corner into an advanced router with sophisticated packet-filtering capabilities. * _Embedded:_ FreeBSD makes an excellent platform to build embedded systems upon. With support for the ARM(R), MIPS(R) and PowerPC(R) platforms, coupled with a robust network stack, cutting edge features, and the permissive extref:{faq}[BSD license, bsd-license-restrictions], FreeBSD makes an excellent foundation for building embedded routers, firewalls, and other devices. -* _Desktop:_ FreeBSD makes a fine choice for an inexpensive desktop solution using the freely available X11 server. FreeBSD offers a choice from many open-source desktop environments, including the standard GNOME and KDE graphical user interfaces. FreeBSD can even boot "diskless" from a central server, making individual workstations even cheaper and easier to administer. +* _Desktop:_ FreeBSD makes a fine choice for an inexpensive desktop solution using the freely available X11 server and Wayland display server. FreeBSD offers a choice from many open-source desktop environments, including the standard GNOME and KDE graphical user interfaces. FreeBSD can even boot "diskless" from a central server, making individual workstations even cheaper and easier to administer. * _Software Development:_ The basic FreeBSD system comes with a full suite of development tools including a full C/C++ compiler and debugger suite. Support for many other languages are also available through the ports and packages collection. FreeBSD is available to download free of charge, or can be obtained on either CD-ROM or DVD. @@ -114,44 +114,43 @@ [[introduction-nutshell-users]] === Who Uses FreeBSD? -FreeBSD has been known for its web serving capabilities - sites that run on FreeBSD include link:https://news.ycombinator.com/[Hacker News], link:http://www.netcraft.com/[Netcraft], link:http://www.163.com/[NetEase], link:https://signup.netflix.com/openconnect[Netflix], link:http://www.sina.com/[Sina], link:http://www.sony.co.jp/[Sony Japan], link:http://www.rambler.ru/[Rambler], link:http://www.yahoo.com/[Yahoo!], and link:http://www.yandex.ru/[Yandex]. +FreeBSD has been known for its web serving capabilities - sites that run on FreeBSD include link:https://news.ycombinator.com/[Hacker News], link:https://www.netcraft.com/[Netcraft], link:https://www.163.com/[NetEase], link:https://signup.netflix.com/openconnect[Netflix], link:https://www.sina.com/[Sina], link:https://www.sony.co.jp/[Sony Japan], link:https://www.rambler.ru/[Rambler], link:https://www.yahoo.com/[Yahoo!], and link:https://www.yandex.ru/[Yandex]. FreeBSD's advanced features, proven security, predictable release cycle, and permissive license have led to its use as a platform for building many commercial and open source appliances, devices, and products. Many of the world's largest IT companies use FreeBSD: -* link:http://www.apache.org/[Apache] - The Apache Software Foundation runs most of its public-facing infrastructure on FreeBSD, including possibly one of the largest SVN repositories in the world with over 1.4 million commits. +* link:https://www.apache.org/[Apache] - The Apache Software Foundation runs most of its public-facing infrastructure on FreeBSD, including possibly one of the largest SVN repositories in the world with over 1.4 million commits. * link:https://www.apple.com/[Apple] - Modern operating systems produced by Apple borrow code from FreeBSD for the process model, network stack, virtual file system, libraries, manual pages, and command-line utilities. -* link:http://www.cisco.com/[Cisco] - IronPort network security and anti-spam appliances run a modified FreeBSD kernel. -* link:http://www.citrix.com/[Citrix] - The NetScaler line of security appliances provide layer 4-7 load balancing, content caching, application firewall, secure VPN, and mobile cloud network access, along with the power of a FreeBSD shell. +* link:https://www.cisco.com/[Cisco] - IronPort network security and anti-spam appliances run a modified FreeBSD kernel. +* link:https://www.citrix.com/[Citrix] - The NetScaler line of security appliances provide layer 4-7 load balancing, content caching, application firewall, secure VPN, and mobile cloud network access, along with the power of a FreeBSD shell. * link:https://www.emc.com/isilon[Dell EMC Isilon] - Isilon's enterprise storage appliances are based on FreeBSD. The extremely liberal FreeBSD license allowed Isilon to integrate their intellectual property throughout the kernel and focus on building their product instead of an operating system. -* link:http://www.quest.com/KACE[Quest KACE] - The KACE system management appliances run FreeBSD because of its reliability, scalability, and the community that supports its continued development. -* link:http://www.ixsystems.com/[iXsystems] - The TrueNAS line of unified storage appliances is based on FreeBSD. -* link:http://www.juniper.net/[Juniper] - The JunOS operating system that powers all Juniper networking gear (including routers, switches, and security and networking appliances) is based on FreeBSD. Juniper is one of many vendors that showcases the symbiotic relationship between the project and vendors of commercial products. Improvements generated at Juniper are upstreamed into FreeBSD to reduce the complexity of integrating new features from FreeBSD back into JunOS in the future. -* link:http://www.mcafee.com/[McAfee] - SecurOS, the basis of McAfee enterprise firewall products including Sidewinder, is based on FreeBSD. -* link:http://www.netapp.com/[NetApp] - The Data ONTAP GX line of storage appliances are based on FreeBSD. In addition, NetApp has contributed back many features, including the new BSD licensed hypervisor, bhyve. -* link:http://www.netflix.com/[Netflix] - The OpenConnect appliance that Netflix uses to stream movies to its customers is based on FreeBSD. Netflix has made extensive contributions to the codebase and works to maintain a zero delta from mainline FreeBSD. Netflix OpenConnect appliances are responsible for delivering more than 32% of all Internet traffic in North America. -* link:http://www.sandvine.com/[Sandvine] - Sandvine uses FreeBSD as the basis of their high performance real-time network processing platforms that make up their intelligent network policy control products. -* link:http://www.sony.com/[Sony] - The PlayStation Vita, PlayStation 4, and PlayStation 5 gaming consoles run a modified version of FreeBSD. -* link:http://www.sophos.com/[Sophos] - The Sophos Email Appliance product is based on a hardened FreeBSD and scans inbound mail for spam and viruses, while also monitoring outbound mail for malware as well as the accidental loss of sensitive information. -* link:http://www.spectralogic.com/[Spectra Logic] - The nTier line of archive grade storage appliances run FreeBSD and OpenZFS. +* link:https://www.quest.com/KACE[Quest KACE] - The KACE system management appliances run FreeBSD because of its reliability, scalability, and the community that supports its continued development. +* link:https://www.ixsystems.com/[iXsystems] - The TrueNAS line of unified storage appliances is based on FreeBSD. +* link:https://www.juniper.net/[Juniper] - The JunOS operating system that powers all Juniper networking gear (including routers, switches, and security and networking appliances) is based on FreeBSD. Juniper is one of many vendors that showcases the symbiotic relationship between the project and vendors of commercial products. Improvements generated at Juniper are upstreamed into FreeBSD to reduce the complexity of integrating new features from FreeBSD back into JunOS in the future. +* link:https://www.mcafee.com/[McAfee] - SecurOS, the basis of McAfee enterprise firewall products including Sidewinder, is based on FreeBSD. +* link:https://www.netapp.com/[NetApp] - The Data ONTAP GX line of storage appliances are based on FreeBSD. In addition, NetApp has contributed back many features, including the new BSD licensed hypervisor, bhyve. +* link:https://www.netflix.com/[Netflix] - The OpenConnect appliance that Netflix uses to stream movies to its customers is based on FreeBSD. Netflix has made extensive contributions to the codebase and works to maintain a zero delta from mainline FreeBSD. Netflix OpenConnect appliances are responsible for delivering more than 32% of all Internet traffic in North America. +* link:https://www.sandvine.com/[Sandvine] - Sandvine uses FreeBSD as the basis of their high performance real-time network processing platforms that make up their intelligent network policy control products. +* link:https://www.sony.com/en/[Sony] - The PlayStation Vita, PlayStation 4, and PlayStation 5 gaming consoles run a modified version of FreeBSD. +* link:https://www.sophos.com/[Sophos] - The Sophos Email Appliance product is based on a hardened FreeBSD and scans inbound mail for spam and viruses, while also monitoring outbound mail for malware as well as the accidental loss of sensitive information. +* link:https://www.spectralogic.com/[Spectra Logic] - The nTier line of archive grade storage appliances run FreeBSD and OpenZFS. * link:https://www.stormshield.com[Stormshield] - Stormshield Network Security appliances are based on a hardened version of FreeBSD. The BSD license allows them to integrate their own intellectual property with the system while returning a great deal of interesting development to the community. -* link:http://www.weather.com/[The Weather Channel] - The IntelliStar appliance that is installed at each local cable provider's headend and is responsible for injecting local weather forecasts into the cable TV network's programming runs FreeBSD. -* link:http://www.verisign.com/[Verisign] - Verisign is responsible for operating the .com and .net root domain registries as well as the accompanying DNS infrastructure. They rely on a number of different network operating systems including FreeBSD to ensure there is no common point of failure in their infrastructure. -* link:http://www.voxer.com/[Voxer] - Voxer powers their mobile voice messaging platform with ZFS on FreeBSD. Voxer switched from a Solaris derivative to FreeBSD because of its superior documentation, larger and more active community, and more developer friendly environment. In addition to critical features like ZFS and DTrace, FreeBSD also offers TRIM support for ZFS. +* link:https://www.weather.com/[The Weather Channel] - The IntelliStar appliance that is installed at each local cable provider's headend and is responsible for injecting local weather forecasts into the cable TV network's programming runs FreeBSD. +* link:https://www.verisign.com/[Verisign] - Verisign is responsible for operating the .com and .net root domain registries as well as the accompanying DNS infrastructure. They rely on a number of different network operating systems including FreeBSD to ensure there is no common point of failure in their infrastructure. +* links:http://www.voxer.com/[Voxer] - Voxer powers their mobile voice messaging platform with ZFS on FreeBSD. Voxer switched from a Solaris derivative to FreeBSD because of its superior documentation, larger and more active community, and more developer friendly environment. In addition to critical features like ZFS and DTrace, FreeBSD also offers TRIM support for ZFS. * link:https://fudosecurity.com/en/[Fudo Security] - The FUDO security appliance allows enterprises to monitor, control, record, and audit contractors and administrators who work on their systems. Based on all of the best security features of FreeBSD including ZFS, GELI, Capsicum, HAST, and auditdistd. FreeBSD has also spawned a number of related open source projects: -* link:http://bsdrp.net/[BSD Router] - A FreeBSD-based replacement for large enterprise routers, designed to run on standard PC hardware. +* link:https://bsdrp.net/[BSD Router] - A FreeBSD-based replacement for large enterprise routers, designed to run on standard PC hardware. * link:https://www.truenas.com/[TrueNAS] is a Network Attached Storage (NAS) software that shares and protects data from modern-day threats like ransomware and malware. TrueNAS makes it easy for users and client devices to access shared data through virtually any sharing protocol. * link:https://ghostbsd.org/[GhostBSD] is derived from FreeBSD and uses the GTK environment to provide a beautiful look and comfortable experience on the modern BSD platform, offering a natural and native UNIX(R) work environment. -* link:http://mfsbsd.vx.sk/[mfsBSD] - A toolkit for building a FreeBSD system image that runs entirely from memory. +* link:https://mfsbsd.vx.sk/[mfsBSD] - A toolkit for building a FreeBSD system image that runs entirely from memory. * link:https://xigmanas.com/[XigmaNAS] - A file server distribution based on FreeBSD with a PHP-powered web interface. -* link:http://www.opnsense.org/[OPNSense] is an open source, easy-to-use and easy-to-build FreeBSD-based firewall and routing platform. OPNsense includes most of the features available in expensive commercial firewalls, and more in many cases. It brings the rich feature set of commercial offerings with the benefits of open and verifiable sources. +* link:https://www.opnsense.org/[OPNSense] is an open source, easy-to-use and easy-to-build FreeBSD-based firewall and routing platform. OPNsense includes most of the features available in expensive commercial firewalls, and more in many cases. It brings the rich feature set of commercial offerings with the benefits of open and verifiable sources. * link:https://www.midnightbsd.org[MidnightBSD] is a FreeBSD-derived operating system developed with desktop users in mind. It includes all the software expected for daily tasks such as mail, web browsing, word processing, gaming, and much more. * link:https://www.nomadbsd.org[NomadBSD] is a persistent live system for USB flash drives, based on FreeBSD. Together with automatic hardware detection and setup, it is configured to be used as a desktop system that works out of the box, but can also be used for data recovery, for educational purposes, or to test FreeBSD's hardware compatibility. -* link:http://www.pfsense.org/[pfSense] - A firewall distribution based on FreeBSD with a huge array of features and extensive IPv6 support. -* link:http://zrouter.org/[ZRouter] - An open source alternative firmware for embedded devices based on FreeBSD. Designed to replace the proprietary firmware on off-the-shelf routers. +* link:https://www.pfsense.org/[pfSense] - A firewall distribution based on FreeBSD with a huge array of features and extensive IPv6 support. A list of link:https://www.freebsdfoundation.org/about/testimonials/[testimonials from companies basing their products and services on FreeBSD] can be found at the FreeBSD Foundation website. Wikipedia also maintains a link:https://en.wikipedia.org/wiki/List_of_products_based_on_FreeBSD[list of products based on FreeBSD]. @@ -167,7 +166,7 @@ The FreeBSD Project had its genesis in the early part of 1993, partially as the brainchild of the Unofficial 386BSDPatchkit's last 3 coordinators: Nate Williams, Rod Grimes and Jordan Hubbard. The original goal was to produce an intermediate snapshot of 386BSD in order to fix a number of problems that the patchkit mechanism was just not capable of solving. -The early working title for the project was 386BSD 0.5 or 386BSD Interim in reference of that fact. +The early working title for the project was 386BSD 0.5 or 386BSD Interim in reference to that fact. 386BSD was Bill Jolitz's operating system, which had been up to that point suffering rather severely from almost a year's worth of neglect. As the patchkit swelled ever more uncomfortably with each passing day, they decided to assist Bill by providing this interim "cleanup" snapshot. @@ -288,7 +287,7 @@ # pkg install en-freebsd-doc .... -For localized versions replace the "en" with language prefix of choice. +For localized versions replace the "en" with the language prefix of choice. Be aware that some of the localised versions might be out of date and might contain information that is no longer correct or relevant. You may view the locally installed manuals with a web browser using the following URLs: @@ -298,4 +297,4 @@ The FreeBSD FAQ:: [.filename]#link:file://localhost/usr/local/share/doc/freebsd/en/books/faq/book.html[/usr/local/share/doc/freebsd/en/books/faq/book.html]# -You can always find up to date documentation at link:https://docs.FreeBSD.org/[https://docs.FreeBSD.org/]. +You can always find up to date documentation at link:https://docs.FreeBSD.org/[The Documentation Portal]. diff --git a/documentation/content/en/books/handbook/parti.adoc b/documentation/content/en/books/handbook/parti.adoc --- a/documentation/content/en/books/handbook/parti.adoc +++ b/documentation/content/en/books/handbook/parti.adoc @@ -18,5 +18,6 @@ * Teach UNIX(R) basics and fundamentals. * Show how to install the wealth of third party applications available for FreeBSD. * Introduce X, the UNIX(R) windowing system, and detail how to configure a desktop environment that makes users more productive. +* Introduce Wayland, a new display server for UNIX(R). The number of forward references in the text have been kept to a minimum so that this section can be read from front to back with minimal page flipping. diff --git a/documentation/static/images/books/handbook/bsdinstall/bsdinstall-hardening.png b/documentation/static/images/books/handbook/bsdinstall/bsdinstall-hardening.png index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 GIT binary patch literal 0 Hc$@