rEFInd

https://wiki.archlinux.org/title/REFInd
Admin
rEFInd is a UEFI boot manager capable of launching kernels as EFI boot stubs, designed to be...
Tokens:8,263
Snippets:81
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install rEFInd with local keys

Source: https://wiki.archlinux.org/title/REFInd/index

This command installs rEFInd and signs its EFI binaries using your provided local Machine Owner Key (MOK). Ensure your keys are placed in `/etc/refind.d/keys` before execution.

```bash
# refind-install --localkeys
```

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

### Manually install rEFInd to fallback boot path

Source: https://wiki.archlinux.org/title/REFInd/index

This procedure manually installs rEFInd to the default fallback boot path (`_esp_/EFI/BOOT/bootx64.efi`) on the ESP. This is useful if the standard installation method fails or for specific boot configurations.

```bash
# mkdir -p _esp_/EFI/BOOT
# cp /usr/share/refind/refind_x64.efi _esp_/EFI/BOOT/bootx64.efi
```

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

### Installing Memtest86+ EFI for rEFInd

Source: https://wiki.archlinux.org/title/REFInd/index

This command copies the Memtest86+ EFI executable to the designated directory for rEFInd to detect and offer as a bootable tool. Ensure the source path `/boot/memtest86+/memtest.efi` is correct for your installation.

```shell
# cp /boot/memtest86+/memtest.efi _esp_/EFI/tools/memtest86.efi

```

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

### Install rEFInd with HashTool for Secure Boot

Source: https://wiki.archlinux.org/title/REFInd/index

This command installs rEFInd and configures it to work with HashTool for Secure Boot. After booting, HashTool will prompt you to enroll the hashes of rEFInd, its drivers, and the kernel. Ensure your kernel is on the ESP or use KeyTool for broader access.

```bash
# refind-install --preloader /usr/share/preloader-signed/PreLoader.efi
```

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

### Manually install rEFInd to ESP

Source: https://wiki.archlinux.org/title/REFInd/index

These commands manually install rEFInd by copying its EFI executable to the EFI System Partition (ESP). This is an alternative to the refind-install script.

```bash
# mkdir -p _esp_/EFI/refind
# cp /usr/share/refind/refind_x64.efi _esp_/EFI/refind/
```

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

### Install rEFInd with shim for Secure Boot

Source: https://wiki.archlinux.org/title/REFInd/index

This command installs rEFInd using shim as the bootloader, suitable for Secure Boot environments. Upon booting, MokManager will launch, requiring you to enroll the hashes of rEFInd (grubx64.efi), its drivers, and the kernel.

```bash
# refind-install --shim /usr/share/shim-signed/shimx64.efi
```

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

### Install rEFInd with shim and local keys for Secure Boot

Source: https://wiki.archlinux.org/title/REFInd/index

This command installs rEFInd using shim and your local Machine Owner Key (MOK) for signing. It automatically signs rEFInd and its drivers. You must also sign your kernel with the same key.

```bash
# refind-install --shim /usr/share/shim-signed/shimx64.efi --localkeys
```

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

### Configure rEFInd Kernel Boot Parameters with refind_linux.conf

Source: https://wiki.archlinux.org/title/REFInd/index

This `refind_linux.conf` example demonstrates how to define boot entries with specific kernel parameters, including root partition, read-write mode, EFI memory map, and initramfs image selection. It also shows how to handle fallback initramfs and systemd targets.

```plaintext
/boot/refind_linux.conf

"Boot using default options"     "root=PARTUUID=_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX_ rw add_efi_memmap"
"Boot using fallback initramfs"  "root=PARTUUID=_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX_ rw add_efi_memmap initrd=boot\initramfs-%v-fallback.img"
"Boot to terminal"               "root=PARTUUID=_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX_ rw add_efi_memmap systemd.unit=multi-user.target"
```

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

### Specify rEFInd Initrd Parameters with Booster Generated Images

Source: https://wiki.archlinux.org/title/REFInd/index

This example shows how to specify initramfs images when using Booster, including external microcode initramfs. It highlights the need for correct path separators (backslashes) and the order of specification for multiple initrd parameters.

```plaintext
initrd=boot\amd-ucode.img initrd=\boot\booster-%v.img
```

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

### Copy fwupdx64.efi Binary

Source: https://wiki.archlinux.org/title/REFInd/index

Copies the fwupdx64.efi binary and firmware file to the rEFInd tools directory on the EFI System Partition (ESP). This command assumes fwupd-efi is installed.

```shell
# cp /usr/lib/fwupd/efi/fwupdx64.efi _esp_/EFI/tools/fwupx64.efi
```

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

### Create rEFInd boot entry using efibootmgr

Source: https://wiki.archlinux.org/title/REFInd/index

This command creates a boot entry in the UEFI NVRAM for rEFInd. Replace `_/dev/sdX_` and `_Y_` with your EFI system partition's device and partition number. This step can be skipped if rEFInd is installed to the fallback path.

```bash
# efibootmgr --create --disk _/dev/sdX_ --part _Y_ --loader /EFI/refind/refind_x64.efi --label "rEFInd Boot Manager" --unicode
```

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

### Copy rEFInd drivers

Source: https://wiki.archlinux.org/title/REFInd/index

This command copies necessary driver files for rEFInd to load various file systems or architectures. Place the specific driver file (e.g., `ext4_x64.efi`) into the `drivers_x64` directory within the rEFInd installation path on your ESP.

```bash
# mkdir _esp_/EFI/refind/drivers_x64
# cp /usr/share/refind/drivers_x64/**drivername**_x64.efi _esp_/EFI/refind/drivers_x64/
```

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

### Manual Boot Entry for Arch Linux in rEFInd

Source: https://wiki.archlinux.org/title/REFInd/index

Defines a manual boot entry for Arch Linux in rEFInd's configuration file. It specifies the kernel, initramfs, and boot options, and includes options for fallback initramfs and booting to the terminal. The `volume` directive may need adjustment based on your partition setup.

```refind.conf
... 

menuentry "Arch Linux" {
	icon     /EFI/refind/icons/os_arch.png
	volume   "Arch Linux"
	loader   /boot/vmlinuz-linux
	initrd   /boot/initramfs-linux.img
	options  "root=PARTUUID=_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX_ rw add_efi_memmap"
	submenuentry "Boot using fallback initramfs" {
		initrd /boot/initramfs-linux-fallback.img
	}
	submenuentry "Boot to terminal" {
		add_options "systemd.unit=multi-user.target"
	}
}
...
```

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

### Clone External rEFInd Theme

Source: https://wiki.archlinux.org/title/REFInd/index

Clones an external rEFInd theme from a Git repository into the rEFInd themes directory. This is a convenient way to install themes hosted on platforms like GitHub. Replace '_url-to-theme_' and '_theme-name_' with actual values.

```shell
# git clone _url-to-theme_ _esp_/EFI/refind/themes/_theme-name_
```

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

### Configure Kernel Boot Options for Btrfs Subvolume

Source: https://wiki.archlinux.org/title/REFInd/index

Sets up the kernel boot parameters in refind_linux.conf to boot from a specific Btrfs subvolume. This includes adding the 'subvol=_subvolume_' option to 'rootflags' and prepending the subvolume name to the initramfs path.

```config
/boot/refind_linux.conf
"Boot using standard options"  "root=PARTUUID=_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX_ rw **rootflags=subvol=_subvolume_** initrd=_**subvolume**_\boot\initramfs-%v.img"
```

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

### Configuring rEFInd to Show Tools

Source: https://wiki.archlinux.org/title/REFInd/index

This snippet shows how to configure rEFInd to display various third-party tools in its boot menu. The `showtools` option in `refind.conf` allows you to specify which tools, such as UEFI Shell, Memtest86+, or gdisk, should be visible.

```refind.conf
... 
showtools shell, memtest, mok_tool, gdisk, fwupdate ...
...
```

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

### Sign kernel with Machine Owner Key

Source: https://wiki.archlinux.org/title/REFInd/index

This command signs your kernel using the specified private key and certificate, a necessary step when using local Machine Owner Keys (MOK) with rEFInd for Secure Boot.

```bash
# sbsign --key /etc/refind.d/keys/refind_local.key --cert /etc/refind.d/keys/refind_local.crt --output /boot/vmlinuz-linux /boot/vmlinuz-linux
```

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

### Set Custom rEFInd Background Banner

Source: https://wiki.archlinux.org/title/REFInd/index

Configures a custom background image (banner) for the rEFInd boot screen by specifying the path to the image file in the refind.conf configuration file. The banner image should be placed in the assets directory.

```config
banner assets/banner.png
```

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

### Create rEFInd Themes Directory

Source: https://wiki.archlinux.org/title/REFInd/index

Creates a directory named 'themes' within the rEFInd configuration directory on the EFI System Partition (ESP). This directory is used to store external rEFInd themes.

```shell
# mkdir _esp_/EFI/refind/themes
```

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

### Configure Btrfs Subvolume for Scanning

Source: https://wiki.archlinux.org/title/REFInd/index

Configures rEFInd to scan for boot entries within a specific Btrfs subvolume. This involves uncommenting and editing the 'also_scan_dirs' directive in refind.conf to include the subvolume path. The subvolume path should be specified relative to the ESP.

```config
_esp_/EFI/refind/refind.conf
...
also_scan_dirs +,_subvolume_/boot
...
```

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

### Load rEFInd Drivers in UEFI Shell

Source: https://wiki.archlinux.org/title/REFInd/index

Loads rEFInd's filesystem drivers (e.g., ext4_x64.efi) within the UEFI shell environment. After loading, map -r is used to refresh the mapped drives, allowing access to file systems.

```shell
Shell> load FS0:\EFI\refind\drivers\ext4_x64.efi
Shell> map -r
```

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

### Passing Escaped Quotes in rEFInd Options

Source: https://wiki.archlinux.org/title/REFInd/index

Demonstrates how to pass options containing spaces or special characters, such as `acpi_osi="Windows 2015"`, within the `options` directive of a rEFInd boot entry. Quotes within the option string must be escaped by doubling them.

```refind.conf
options  "... **acpi_osi=""Windows 2015""** "
```

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

### Include External rEFInd Theme Configuration

Source: https://wiki.archlinux.org/title/REFInd/index

Includes the configuration file of an external rEFInd theme into the main refind.conf file. This directive tells rEFInd to load the theme's settings. Replace '_theme-name_' with the actual theme directory name.

```config
include themes/_theme-name_/_theme-name_.conf
```

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

### Escaping Quotes in rEFInd Boot Parameters

Source: https://wiki.archlinux.org/title/REFInd/index

Demonstrates how to escape double quotes within a boot parameter string in `refind_linux.conf` by repeating the double quote. This is necessary for options that themselves contain spaces and require quoting, like `acpi_osi="Windows 2015"`.

```plaintext
"Boot using default options"     "... **acpi_osi=""Windows 2015""** "
```

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

### Set Custom rEFInd Icons Directory

Source: https://wiki.archlinux.org/title/REFInd/index

Specifies a custom directory for rEFInd's boot entry icons. This allows users to use their own icon sets or themes. The icons_dir directive in refind.conf points to the folder containing the icons.

```config
icons_dir assets/icons
```

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

### List Supported efifb Resolutions

Source: https://wiki.archlinux.org/title/REFInd/index

Executes the modelist.efi application from the UEFI shell to display a list of supported framebuffer (efifb) resolutions. This helps in determining appropriate resolution settings for rEFInd.

```shell
Shell> FS0:\modelist.efi
```

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

### Copy External rEFInd Theme Manually

Source: https://wiki.archlinux.org/title/REFInd/index

Manually copies an external rEFInd theme from a local path to the rEFInd themes directory. This method is useful if the theme is not available via Git. Replace '_path-to-theme_' and '_theme-name_' with actual values.

```shell
# cp -r _path-to-theme_ _esp_/EFI/refind/themes/_theme-name_
```

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

### Configure rEFInd for Arch Linux Kernel Naming Scheme

Source: https://wiki.archlinux.org/title/REFInd/index

This configuration snippet for `refind.conf` allows rEFInd to correctly identify Arch Linux kernel versions and match them with their corresponding initramfs images. Ensure this is uncommented and edited for proper boot behavior.

```plaintext
_esp_/EFI/refind/refind.conf

...
extra_kernel_version_strings "linux-hardened,linux-rt-lts,linux-zen,linux-lts,linux-rt,linux"
...
```
Tokens:
Raw