FreeBSD Handbook

https://docs.freebsd.org/en/books/handbook
Admin
The FreeBSD Handbook is a comprehensive guide for users and administrators, covering installation,...
Tokens:862,466
Snippets:8,125
Trust Score:9.9
Update:4 days ago
Show doc for...
Tokens:
Raw
### Start virtual machine in installation mode

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Launch the virtual machine using the installation ISO to begin the OS setup.

```shell
# sh /usr/share/examples/bhyve/vmrun.sh -c 1 -m 1024M -t tap0 -d guest.img \
     -i -I FreeBSD-14.0-RELEASE-amd64-bootonly.iso guestname
```

--------------------------------

### Example output for pkg install

Source: https://docs.freebsd.org/en/books/handbook/ports

Shows the expected output when installing a package, including the list of dependencies to be installed.

```text
Updating FreeBSD repository catalogue...
FreeBSD repository is up to date.
All repositories are up to date.
The following 9 package(s) will be affected (of 0 checked):

New packages to be INSTALLED:
        ca_root_nss: 3.83
        curl: 7.86.0
        gettext-runtime: 0.21
        indexinfo: 0.3.1
        libidn2: 2.3.3
        libnghttp2: 1.48.0
        libpsl: 0.21.1_4
        libssh2: 1.10.0.3
        libunistring: 1.0

Number of packages to be installed: 9

The process will require 11 MiB more space.
3 MiB to be downloaded

Proceed with this action? [y/N]
```

--------------------------------

### Example output for pkg info

Source: https://docs.freebsd.org/en/books/handbook/ports

Shows the list of installed packages and their descriptions.

```text
ca_root_nss-3.83               Root certificate bundle from the Mozilla Project
curl-7.86.0                    Command line tool and library for transferring data with URLs
gettext-runtime-0.21.1         GNU gettext runtime libraries and programs
indexinfo-0.3.1                Utility to regenerate the GNU info page index
libidn2-2.3.3                  Implementation of IDNA2008 internationalized domain names
libnghttp2-1.48.0              HTTP/2.0 C Library
libpsl-0.21.1_6                C library to handle the Public Suffix List
libssh2-1.10.0.3               Library implementing the SSH2 protocol
libunistring-1.0               Unicode string library
pkg-1.18.4                     Package manager
```

--------------------------------

### Start QEMU with monitor enabled

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Example script to launch a QEMU virtual machine with the monitor interface enabled via stdio.

```shell
# left VM script.
/usr/local/bin/qemu-system-x86_64  -monitor stdio \
  -cpu qemu64 \
  -vga std \
  -m 4096 \
  -smp 4   \
  -cdrom ../ISO/fbsd.iso \
  -boot order=cd,menu=on \
  -blockdev driver=file,aio=threads,node-name=imgleft,filename=../VM/left.qcow2 \
  -blockdev driver=qcow2,node-name=drive0,file=imgleft \
  -device virtio-blk-pci,drive=drive0,bootindex=1  \
  -netdev tap,id=nd0,ifname=tap0,script=no,downscript=no,br=bridge0 \
  -device e1000,netdev=nd0,mac=02:20:6c:65:66:74 \
  -name "left"
```

--------------------------------

### Start virtual machine from disk

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Launch the installed virtual machine from the virtual disk image.

```shell
# sh /usr/share/examples/bhyve/vmrun.sh -c 4 -m 1024M -t tap0 -d guest.img guestname
```

--------------------------------

### Install UEFI Firmware and Start UEFI Guest

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Install the required firmware package and start a bhyve UEFI guest with specific device configurations.

```shell
# pkg -j bhyve install bhyve-firmware
```

```shell
# bhyve -A -c 4 -D -H -m 2G \
        -s 0,hostbridge \
        -s 1,lpc \
        -s 2,virtio-net,tap100 \
        -s 3,virtio-blk,/dev/zvol/zroot/vms/bhyvevm0 \
	-s 4,ahci-cd,/vms/FreeBSD-14.0-RELEASE-amd64-bootonly.iso \
        -s 31,fbuf,tcp=127.0.0.1:5900,w=1024,h=800,tablet \
        -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \
        -l com1,/dev/nmdbbhyve0A \
        bhyvevm0
```

--------------------------------

### Install a port using make

Source: https://docs.freebsd.org/en/books/handbook/ports

Navigate to the port directory and run make install to fetch, extract, patch, configure, build, and install the software.

```bash
# cd /usr/ports/sysutils/lsof
# make install
```

--------------------------------

### Existing Linux library configuration

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Example of an existing library setup on the FreeBSD system.

```text
/compat/linux/lib/libc.so.4.6.27
/compat/linux/lib/libc.so.4 -> libc.so.4.6.27
```

--------------------------------

### Boot virtual machine from disk

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Start the virtual machine using the virtual disk without the installation ISO.

```shell
# bhyve -A -H -P -s 0:0,hostbridge -s 1:0,lpc -s 2:0,virtio-net,tap0 \
    -s 3:0,virtio-blk,./linux.img -l com1,stdio -c 4 -m 1024M linuxguest
```

--------------------------------

### SSH host key generation output

Source: https://docs.freebsd.org/en/books/handbook/bsdinstall

Example output shown when sshd is enabled during installation, displaying the generation of RSA and DSA host keys with fingerprints and randomart images, followed by the starting of sshd.

```text
Generating public/private rsa1 key pair.
Your identification has been saved in /etc/ssh/ssh_host_key.
Your public key has been saved in /etc/ssh/ssh_host_key.pub.
The key fingerprint is:
10:a0:f5:af:93:ae:a3:1a:b2:bb:3c:35:d9:5a:b3:f3 root@machine3.example.com
The key's randomart image is:
+--[RSA1 1024]----+
|    o..          |
|   o . .         |
|  .   o          |
|       o         |
|    o   S        |
|   + + o         |
|o . + *          |
|o+ ..+ .         |
|==o..o+E         |
+-----------------+
Generating public/private dsa key pair.
Your identification has been saved in /etc/ssh/ssh_host_dsa_key.
Your public key has been saved in /etc/ssh/ssh_host_dsa_key.pub.
The key fingerprint is:
7e:1c:ce:dc:8a:3a:18:13:5b:34:b5:cf:d9:d1:47:b2 root@machine3.example.com
The key's randomart image is:
+--[ DSA 1024]----+
|       ..     . .|
|      o  .   . + |
|     . ..   . E .|
|    . .  o o . . |
|     +  S = .    |
|    +  . = o     |
|     +  . * .    |
|    . .  o .     |
|      .o. .      |
+-----------------+
Starting sshd.
```

--------------------------------

### Launch Info Documentation

Source: https://docs.freebsd.org/en/books/handbook/basics

Start the info documentation viewer.

```bash
info
```

--------------------------------

### Install Wayfire and dependencies

Source: https://docs.freebsd.org/en/books/handbook/wayland

Install the required packages to get the Wayfire compositor and associated utilities running.

```shell
# pkg install wayfire wf-shell alacritty swaylock-effects swayidle wlogout kanshi mako wlsunset
```

--------------------------------

### Restart obspamd and start obspamlogd

Source: https://docs.freebsd.org/en/books/handbook/firewalls

Commands to complete the greylisting setup: restart the obspamd service and start the obspamlogd service.

```shell
#  service obspamd restart
#  service obspamlogd start
```

--------------------------------

### Configure APT sources for arm64

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Example content for /compat/ubuntu/etc/apt/sources.list on arm64 architectures.

```text
deb http://ports.ubuntu.com/ubuntu-ports bionic main universe restricted multiverse
```

--------------------------------

### Configure APT sources for amd64

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Example content for /compat/ubuntu/etc/apt/sources.list on amd64 architectures.

```text
deb http://archive.ubuntu.com/ubuntu jammy main universe restricted multiverse
deb http://security.ubuntu.com/ubuntu/ jammy-security universe multiverse restricted main
deb http://archive.ubuntu.com/ubuntu jammy-backports universe multiverse restricted main
deb http://archive.ubuntu.com/ubuntu jammy-updates universe multiverse restricted main
```

--------------------------------

### Get information about a specific package

Source: https://docs.freebsd.org/en/books/handbook/ports

Queries details for a specific installed package.

```shell
# pkg info pkg
```

--------------------------------

### Create QEMU test environment

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Set up the directory structure for scripts, ISO images, and virtual machine files.

```shell
% mkdir -p ~/QEMU  ~/QEMU/SCRIPTS  ~/QEMU/ISO  ~/QEMU/VM
```

--------------------------------

### Install jail userland with pkgbase

Source: https://docs.freebsd.org/en/books/handbook/jails

Uses pkg(8) to install the base system from the FreeBSD-base repository into the jail root directory. This method is available starting in FreeBSD 15.0.

```shell
# pkg --rootdir /usr/local/jails/containers/classic install -r FreeBSD-base FreeBSD-set-base-jail
```

--------------------------------

### Start the 'left' virtual machine

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Execute this QEMU command to start the first virtual machine using a raw disk format.

```shell
/usr/local/bin/qemu-system-x86_64  -monitor none \
  -cpu qemu64 \
  -vga std \
  -m 4096 \
  -smp 4   \
  -cdrom ../ISO/fbsd.iso \
  -boot order=cd,menu=on \
  -blockdev driver=file,aio=threads,node-name=imgleft,filename=../VM/left.img \
  -blockdev driver=raw,node-name=drive0,file=imgleft \
  -device virtio-blk-pci,drive=drive0,bootindex=1  \
  -netdev tap,id=nd0,ifname=tap0,script=no,downscript=no,br=bridge0 \
  -device e1000,netdev=nd0,mac=02:20:6c:65:66:74 \
  -name "left"
```

--------------------------------

### Start Alpine

Source: https://docs.freebsd.org/en/books/handbook/mail

Command to launch the Alpine email client after installation from the mail/alpine port.

```shell
% alpine
```

--------------------------------

### Start Mutt

Source: https://docs.freebsd.org/en/books/handbook/mail

Command to launch the Mutt email client after installation from the mail/mutt port.

```shell
% mutt
```

--------------------------------

### Example output for pkg info pkg

Source: https://docs.freebsd.org/en/books/handbook/ports

Detailed information about the installed pkg package.

```text
pkg-1.19.0
Name           : pkg
Version        : 1.19.0
Installed on   : Sat Dec 17 11:05:28 2022 CET
Origin         : ports-mgmt/pkg
Architecture   : FreeBSD:13:amd64
Prefix         : /usr/local
Categories     : ports-mgmt
Licenses       : BSD2CLAUSE
Maintainer     : pkg@FreeBSD.org
WWW            : https://github.com/freebsd/pkg
Comment        : Package manager
Options        :
        DOCS           : on
Shared Libs provided:
        libpkg.so.4
Annotations    :
        FreeBSD_version: 1301000
        repo_type      : binary
        repository     : FreeBSD
Flat size      : 33.2MiB
Description    :
Package management tool

WWW: https://github.com/freebsd/pkg
```

--------------------------------

### Start the 'right' virtual machine

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Execute this QEMU command to start the second virtual machine, configured with qcow2 format and specific network settings.

```shell
/usr/local/bin/qemu-system-x86_64  -monitor none \
  -cpu qemu64 \
  -vga cirrus \
  -m 4096  -smp 4   \
  -cdrom ../ISO/fbsd.iso \
  -boot order=cd,menu=on \
  -drive if=none,id=drive0,cache=writeback,aio=threads,format=qcow2,discard=unmap,file=../VM/right.qcow2 \
  -device virtio-blk-pci,drive=drive0,bootindex=1  \
  -netdev tap,id=nd0,ifname=tap1,script=no,downscript=no,br=bridge0 \
  -device e1000,netdev=nd0,mac=02:72:69:67:68:74 \
  -name "right"
```

--------------------------------

### List vmrun.sh help options

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Display the available command-line arguments for the vmrun.sh example script.

```shell
# sh /usr/share/examples/bhyve/vmrun.sh -h
```

--------------------------------

### Start Sway

Source: https://docs.freebsd.org/en/books/handbook/wayland

Launch the Sway compositor using a specific configuration file.

```shell
% sway -c ~/.config/sway/config
```

--------------------------------

### Example /boot.config content

Source: https://docs.freebsd.org/en/books/handbook/serialcomms

Displays the contents of the /boot.config file and the resulting keyboard detection status.

```text
/boot.config: -P
Keyboard: no
```

--------------------------------

### Install LXQt meta package

Source: https://docs.freebsd.org/en/books/handbook/desktop

Install the LXQt desktop environment using the meta package.

```bash
# pkg install lxqt
```

--------------------------------

### Example output of CentOS userland verification

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Shows the expected directory structure after installing the CentOS base system.

```text
total 30
lrwxr-xr-x   1 root  wheel    7 Apr 11  2018 bin -> usr/bin
drwxr-xr-x  13 root  wheel  512 Apr 11 21:10 dev
drwxr-xr-x  25 root  wheel   64 Apr 11 21:10 etc
lrwxr-xr-x   1 root  wheel    7 Apr 11  2018 lib -> usr/lib
lrwxr-xr-x   1 root  wheel    9 Apr 11  2018 lib64 -> usr/lib64
drwxr-xr-x   2 root  wheel    2 Apr 11 21:10 opt
dr-xr-xr-x   1 root  wheel    0 Apr 11 21:25 proc
lrwxr-xr-x   1 root  wheel    8 Feb 18 02:10 run -> /var/run
lrwxr-xr-x   1 root  wheel    8 Apr 11  2018 sbin -> usr/sbin
drwxr-xr-x   2 root  wheel    2 Apr 11 21:10 srv
dr-xr-xr-x   1 root  wheel    0 Apr 11 21:25 sys
drwxr-xr-x   8 root  wheel    9 Apr 11 21:10 usr
drwxr-xr-x  16 root  wheel   17 Apr 11 21:10 var
```

--------------------------------

### Start GNOME with startx

Source: https://docs.freebsd.org/en/books/handbook/desktop

Add the line 'exec gnome-session' to ~/.xinitrc to allow starting GNOME manually with startx(1).

```shell
% echo "exec gnome-session" > ~/.xinitrc
```

--------------------------------

### Example HTTP/2.0 access log output

Source: https://docs.freebsd.org/en/books/handbook/network-servers

Sample output showing HTTP/2.0 GET requests in the access log.

```text
192.168.1.205 - - [18/Oct/2020:18:34:36 -0400] "GET / HTTP/2.0" 304 -
192.0.2.205 - - [18/Oct/2020:19:19:57 -0400] "GET / HTTP/2.0" 304 -
192.0.0.205 - - [18/Oct/2020:19:20:52 -0400] "GET / HTTP/2.0" 304 -
192.0.2.205 - - [18/Oct/2020:19:23:10 -0400] "GET / HTTP/2.0" 304 -
```

--------------------------------

### Configure hostc.example.org in /etc/rc.conf

Source: https://docs.freebsd.org/en/books/handbook/advanced-networking

Example configuration for the backup host, which monitors both master hosts using two CARP VHIDs and an increased advskew.

```text
hostname="hostc.example.org"
ifconfig_em0="inet 192.168.1.5 netmask 255.255.255.0"
ifconfig_em0_alias0="inet vhid 1 advskew 100 pass testpass alias 192.168.1.50/32"
ifconfig_em0_alias1="inet vhid 2 advskew 100 pass testpass alias 192.168.1.51/32"
```

--------------------------------

### Example Password Hash Output

Source: https://docs.freebsd.org/en/books/handbook/book

The output shows the user entry including the password hash, which starts with $6$ for SHA512.

```text
imani:$6$pzIjSvCAn.PBYQBA$PXpSeWPx3g5kscj3IMiM7tUEUSPmGexxta.8Lt9TGSi2lNQqYGKszsBPuGME0:1001:1001::0:0:imani:/usr/home/imani:/bin/sh
```

--------------------------------

### Install MATE Meta Package

Source: https://docs.freebsd.org/en/books/handbook/desktop

Install the full MATE desktop environment including extra applications.

```shell
# pkg install mate
```

--------------------------------

### Configure hosta.example.org in /etc/rc.conf

Source: https://docs.freebsd.org/en/books/handbook/advanced-networking

Example configuration for the first master host, setting the hostname, management IP, and CARP virtual IP.

```text
hostname="hosta.example.org"
ifconfig_em0="inet 192.168.1.3 netmask 255.255.255.0"
ifconfig_em0_alias0="inet vhid 1 pass testpass alias 192.168.1.50/32"
```

--------------------------------

### boot0 boot manager display

Source: https://docs.freebsd.org/en/books/handbook/boot

Example of the boot0 boot manager screen displayed at boot time when multiple operating systems are installed.

```text
F1 Win
F2 FreeBSD

Default: F2
```

--------------------------------

### Clean world before updating FreeBSD from source

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Run make cleanworld in /usr/src before following the Quick Start steps to build and install world and kernel.

```shell
# cd /usr/src
# make cleanworld
```

--------------------------------

### Install a Program As the Superuser

Source: https://docs.freebsd.org/en/books/handbook/book

Demonstrates the workflow of configuring and building a program as a standard user, then escalating to superuser privileges via su - to perform the installation.

```shell
% configure
% make
% su -
Password:
```

--------------------------------

### System /etc/crontab Configuration

Source: https://docs.freebsd.org/en/books/handbook/config

Example of a system-wide crontab file showing environment variable definitions and scheduled tasks. Comments start with # and must be on their own line.

```text
# /etc/crontab - root's crontab for FreeBSD
#
__**(1)**
#
SHELL=/bin/sh
PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin __**(2)**
#
#minute hour    mday    month   wday    who     command __**(3)**
#
# Save some entropy so that /dev/random can re-seed on boot.
*/11    *       *       *       *       operator /usr/libexec/save-entropy __**(4)**
#
# Rotate log files every hour, if necessary.
0       *       *       *       *       root    newsyslog
#
# Perform daily/weekly/monthly maintenance.
1       3       *       *       *       root    periodic daily
15      4       *       *       6       root    periodic weekly
30      5       1       *       *       root    periodic monthly
#
# Adjust the time zone if the CMOS clock keeps local time, as opposed to
# UTC time.  See adjkerntz(8) for details.
1,31    0-5     *       *       *       root    adjkerntz -a
```

--------------------------------

### Booting a Windows Guest with bhyve

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Example command to boot a Windows virtual machine using an installation ISO, requiring UEFI bootrom and wired memory.

```shell
bhyve \
      -c 2 \
      -s 0,hostbridge \
      -s 3,nvme,windows2016.img \
      -s 4,ahci-cd,install.iso \
      -s 10,virtio-net,tap0 \
      -s 31,lpc \
      -s 30,xhci,tablet \
      -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \
      -m 8G -H -w \
      windows2016
```

--------------------------------

### Example /etc/rc.conf configuration

Source: https://docs.freebsd.org/en/books/handbook/config

System-wide configuration entries for startup services and settings.

```text
sshd_enable="YES"
keyrate="fast"
defaultrouter="10.1.1.254"
```

--------------------------------

### Install and enable qemu-user-static

Source: https://docs.freebsd.org/en/books/handbook/containers

Installs the QEMU user-static package and enables the service to register image activators.

```shell
# pkg install emulators/qemu-user-static
# service qemu_user_static enable
# service qemu_user_static start
```
Tokens:
Raw