X-Git-Url: https://code.delx.au/refind/blobdiff_plain/7b85c1b8c0aca2e8e9443083f628e5493bc64cfa..9b877e67c541f1c08950930a0ad8e0c6ee2ea2e9:/docs/refind/installing.html diff --git a/docs/refind/installing.html b/docs/refind/installing.html index e5c6221..68a93c8 100644 --- a/docs/refind/installing.html +++ b/docs/refind/installing.html @@ -15,7 +15,7 @@ href="mailto:rodsmith@rodsbooks.com">rodsmith@rodsbooks.com

Originally written: 3/14/2012; last Web page update: -12/11/2012, referencing rEFInd 0.5.1

+12/30/2012, referencing rEFInd 0.6.2

I'm a technical writer and consultant specializing in Linux technologies. This Web page is provided free of charge and with no annoying outside ads; however, I did take time to prepare it, and Web hosting does cost money. If you find this Web page useful, please consider making a small donation to help keep this site up and running. Thanks!

@@ -92,7 +92,7 @@ href="mailto:rodsmith@rodsbooks.com">rodsmith@rodsbooks.com

Important: A rEFInd zip file, when uncompressed, creates a directory called refind-version, where version is the version number. This directory includes a subdirectory called refind that holds the boot loader, along with another that holds documentation, as well as miscellaneous files in refind-version itself. When I refer to "the refind directory" on this page, I mean the directory with that precise name, not the refind-version directory that is its parent.

-

Once you've uncompressed a rEFInd binary zip file, you must install it to your computer's ESP (or conceivably to some other location). The details of how you do this depend on your OS and your computer (UEFI-based PC vs. Macintosh). The upcoming sections provide details. For Linux and Mac OS X, you can use the installation script, install.sh, which provides easy one-command installation on most systems. Occasionally this script will fail, though, so I also provide explicit instructions for Linux and Mac OS X. Installation under Windows also must be done manually. In some cases, you'll have to deviate from the default naming conventions, as described in a section on this topic. If you're upgrading rEFInd, see the section on upgrading. Finally, I describe how to install some additional components you might find useful. Note that this page describes installing the main rEFInd program; if you want to use the EFI filesystem drivers included with rEFInd, you should consult the page on using drivers with rEFInd.

+

Once you've uncompressed a rEFInd binary zip file, you must install it to your computer's ESP (or conceivably to some other location). The details of how you do this depend on your OS and your computer (UEFI-based PC vs. Macintosh). The upcoming sections provide details. For Linux and Mac OS X, you can use the installation script, install.sh, which provides easy one-command installation on most systems. Occasionally this script will fail, though, so I also provide explicit instructions for Linux and Mac OS X. Installation under Windows also must be done manually. You can even install rEFInd using an EFI shell (version 2 only). In some cases, you'll have to deviate from the default naming conventions, as described in a section on this topic. If you're upgrading rEFInd, see the section on upgrading. Finally, I describe how to install some additional components you might find useful.

Installing rEFInd Using install.sh under Linux or Mac OS X

@@ -103,7 +103,7 @@ href="mailto:rodsmith@rodsbooks.com">rodsmith@rodsbooks.com

Quick install.sh Instructions

-

Under Linux, the install.sh script installs rEFInd to your disk's ESP. Under Mac OS X, the script installs rEFInd to your current OS X boot partition by default; but you can install to your ESP instead by passing the script the --esp option.

+

Under Linux, the install.sh script installs rEFInd to your disk's ESP. Under Mac OS X, the script installs rEFInd to your current OS X boot partition by default; but you can install to your ESP instead by passing the script the --esp option. Under either OS, you can install to something other than the currently-running OS by using the --root /mountpoint option. (See Table 1 for details.)

Before running this script under Linux, you should ensure that your ESP is mounted at /boot or /boot/efi, as described in more detail in the Installing rEFInd Manually Using Linux section. (If you installed Linux in EFI mode, chances are your ESP is properly mounted.) This precaution isn't necessary under OS X.

@@ -113,6 +113,7 @@ href="mailto:rodsmith@rodsbooks.com">rodsmith@rodsbooks.com

# ./install.sh Installing rEFInd on Linux.... ESP was found at /boot/efi using vfat +Installing driver for ext4 (ext4_x64.efi) Copied rEFInd binary files Copying sample configuration file as refind.conf; edit this file to configure @@ -195,28 +196,40 @@ Installation has completed successfully. though; because of the popularity of dual boots with Windows on Macs, the BIOS/legacy scans are enabled by default on Macs. +
  • On Linux, install.sh checks the filesystem type of the + /boot directory and, if a matching filesystem driver is + available, installs it. Note that the "/boot directory" may be + on a separate partition or it may be part of your root (/) + filesystem, in which case the driver for your root filesystem is + installed. If install.sh detects that the filesystem in + question is ext2fs or ext3fs, it installs the ext4fs driver, which can + handle all three of these filesystem types. This feature is unlikely to + work properly from an emergency system, although it might if you have a + separate /boot partition and if you mount that partition at + /boot in your emergency system, and the ESP at + /boot/efi.
    • +
  • If you run install.sh on Linux and if /boot/refind_linux.conf doesn't already exist, - install.sh creates this file and populates it with a couple of + install.sh creates this file and populates it with a few sample entries. If /boot is on a FAT partition (or HFS+ on a - Mac), or if it's on an ext2fs, ext3fs, ReiserFS, or HFS+ partition and - you install an appropriate driver (for instance by passing - --drivers to the script), the result is that rEFInd will - detect your kernel and will probably boot it correctly. Some systems - will require manual tweaking to refind_linux.conf, - though—for instance, to add dolvm to the boot options on - Gentoo systems that use LVM.
    • + Mac), or if it's on an ext2fs, ext3fs, ext4fs, ReiserFS, or HFS+ + partition and you install an appropriate driver, the + result is that rEFInd will detect your kernel and will probably boot it + correctly. Some systems will require manual tweaking to + refind_linux.conf, though—for instance, to add + dolvm to the boot options on Gentoo systems that use LVM.

    In addition to these quirks, you should be aware of some options that install.sh supports to enable you to customize your installation in various ways. The syntax for install.sh is as follows:

    -install.sh [--esp | --usedefault device-file] [--drivers] [--shim shim-filename] \
-           [--localkeys]
+install.sh [--esp | --usedefault device-file | --root mount-point ] \
+           [--nodrivers | --alldrivers] [--shim shim-filename] [--localkeys]
    -

    The details of the options are summarized in Table 1. Using some of these options in unusual conditions can generate warnings and prompts to confirm your actions. In particular, using --shim or --localkeys when you're not booted in Secure Boot mode, or failing to use --shim when you are booted in Secure Boot mode, will generate a query and a request to confirm your installation. Consult the Managing Secure Boot page for more on this topic.

    +

    The details of the options are summarized in Table 1. Broadly speaking, they come in three classes: installation location options (--esp, --usedefault, and --root), driver options (--nodrivers and --alldrivers), and Secure Boot options (--shim and --localkeys). Using some of these options in unusual conditions can generate warnings and prompts to confirm your actions. In particular, using --shim or --localkeys when you're not booted in Secure Boot mode, or failing to use --shim when you are booted in Secure Boot mode, will generate a query and a request to confirm your installation. Consult the Managing Secure Boot page for more on this topic.

    @@ -225,19 +238,27 @@ install.sh [--esp | --usedefault device-file] [--drive - + - + + + + + - - + + + + + + - + @@ -273,7 +294,7 @@ Filesystem 1K-blocks Used Available Use% Mounted on
  • Type rm refind_ia32.efi to remove the IA32 binary if you're using an x86-64 (64-bit) system; or type rm refind_x64.efi to remove the x86-64 binary if you're using an x86 (32-bit) system. You can optionally rename the binary you keep as refind.efi, but this isn't required. (Note that you must keep the version that's the correct bit width for your EFI; if you've installed a 32-bit Linux on a 64-bit PC with a 64-bit EFI, you'd keep refind_x64.efi.
    • -
  • Optionally, type rm -r drivers_ia32 to remove the x86 drivers from an x86-64 system, or rm -r drivers_x64 to remove the x86-64 drivers from a 32-bit x86 system. You may also want to remove some or all of the drivers for the architecture you are using; if you don't need them, they'll slow down the start process. See the page on drivers for more on this topic.
    • +
  • Optionally, type rm -r drivers_ia32 to remove the x86 drivers from an x86-64 system, or rm -r drivers_x64 to remove the x86-64 drivers from a 32-bit x86 system. You may also want to remove some or all of the drivers for the architecture you are using. If you don't need them, they'll slow down the start process, and worse, if you're using Secure Boot, rEFInd can load just one shim/MOK-signed driver. See the page on drivers for more on this topic.
  • Rename the configuration file by typing mv refind.conf-sample refind.conf. Consult the Editing the rEFInd Configuration File page for information on how to adjust your options.
    • @@ -434,6 +455,107 @@ $ ioreg -l -p IODeviceTree | grep firmware-abi + +

    Installing rEFInd Manually Using Windows

    +     + +

    If you can't currently boot any OS (say, because a firmware update has wiped your NVRAM entries), you may find it convenient to install rEFInd using an EFI version 2 shell. Unfortunately, the bcfg command described here is not available in the EFI version 1 shell, and the version 2 shell is unusable on many firmware implementations prior to 2.3.1. Thus, this procedure won't work for all systems.

    + +

    In addition to emergency situations, using bcfg can be desirable if efibootmgr or other OS-hosted tools don't do the job. This happens under VirtualBox, for instance. An alternative in such cases can be to use alternative names for rEFInd.

    + +

    To begin, you must have a way to launch your shell. Unfortunately, this can pose a dilemma, since without rEFInd or some other boot manager, many EFI implementations lack the means to launch a shell. Some will do so, though, if the shell is stored as shellx64.efi (for x86-64) or shellia32.efi (for x86) in the root directory of the ESP. Thus, you can try copying your shell file there. You can obtain EFI 2 shells here:

    + + + +

    Note that the shell included in rEFInd's CD-R image version is a version 1 shell, so you can't use it for this purpose. You can, however, copy rEFInd's files from the CD-R. You can even launch the version 1 shell included with rEFInd and then use that to launch a version 2 shell. Once you've booted the shell, you can proceed as follows:

    + +
      + +
    1. If you haven't installed rEFInd previously, unpack its zip file to a + FAT partition. This can be the ESP itself or another partition, such as + a USB flash drive. If you're simply repairing a lost NVRAM entry, you + needn't move your existing rEFInd files.
      2. + +
    2. Identify your filesystems, which are labelled with the form fsn:, as in fs0: for the first + filesystem, fs1: for the second, and so on. Type the + filesystem number followed by the Enter key to begin using it. You can + then type ls or dir to see the contents of the filesystem. + Chances are your ESP will be fs0:, but it could be something + else. (The following steps assume your ESP is fs0:; you'll + need to adjust them if it's not.) If rEFInd's source files are on + another device, you must identify it, too.
      3. + +

      Note: Skip ahead to step #9 if you're merely re-activating an already-installed rEFInd binary. If an entry exists but it's no longer the primary one, you can skip ahead to step #14.

      + +
    3. If necessary, create a directory for rEFInd by typing mkdir fs0:\EFI\refind. (If the fs0:\EFI + directory doesn't already exist, you must create it first, + though.)
      4. + +
    4. Change to the directory in which rEFInd's files exist.
      5. + +
    5. Type cp refind_x64.efi fs0:\EFI\refind to + copy the rEFInd binary file. (Adjust the name if you're using a 32-bit + computer.)
      6. + +
    6. Type cp refind.conf-sample + fs0:\EFI\refind\refind.conf to copy and rename the sample rEFInd + configuration file.
      7. + +
    7. Type cp -r icons fs0:\EFI\refind\ to copy + rEFInd's icons.
      8. + +
    8. Optionally, type cp -r drivers_x64 + fs0:\EFI\refind\ to copy rEFInd's 64-bit drivers. (You could + instead copy the 32-bit drivers or limit yourself to just the drivers + you need, of course.)
      9. + +
    9. Type fs0:, if necessary, to change to the + ESP.
      10. + +
    10. Type cd \EFI\refind to change to rEFInd's + installation directory.
      11. + +
    11. If you want to edit rEFInd's options, type edit + refind.conf and use the shell's built-in text editor to do so. + Press F2 followed by the Enter key to save your changes and F3 to + exit.
      12. + +
    12. Type bcfg boot dump -b to see a list of + existing NVRAM entries. Pay attention to their numbers (labelled + Option: and Variable:, with the latter number + preceded by the string Boot, as in Boot0007). You'll + want to create a boot entry for rEFInd using a number that's not in + use.
      13. + +
    13. Type bcfg boot add 3 + fs0:\EFI\refind\refind_x64.efi "rEFInd", adjusting the number + (3 in this example), filesystem (fs0:), and filename + (\EFI\refind\refind_x64.efi) as necessary for your system. If + you're used to Linux, be sure to use backslashes (\), not + Linux-style forward slashes (/) as directory separators. Note + that some shells may ignore the number you entered and use another one, + so watch for this possibility.
      14. + +
    14. Type bcfg boot mv 3 0, substituting + the option number for the entry you created for 3. This moves rEFInd to the top of the boot + order.
      15. + +
    15. Type reset to reboot the computer.
      16. + +
    + +

    With any luck, rEFInd will start up at this point. If not, you can check your settings using a shell or an emergency system for your OS of choice. In an EFI shell, you might type bcfg boot dump -b to view your boot loader entries and verify that rEFInd appears at the top of the list. Be sure to check the pathname for typos. If you continue to have problems, you might look into giving rEFInd a fallback filename that your firmware will recognize.

    +

    Alternative Naming Options

     @@ -528,7 +650,7 @@ $ ioreg -l -p IODeviceTree | grep firmware-abi
  • Drivers—You can install drivers to extend the capabilities of the EFI. rEFInd ships with filesystem drivers for ext2fs and ReiserFS, which can enable you to boot a Linux kernel with EFI stub - support from an ext2fs, ext3fs, or ReiserFS partition. (rEFInd also + support from an ext2fs, ext3fs, ext4fs, or ReiserFS partition. (rEFInd also provides ISO-9660 and HFS+ drivers.) You can find additional drivers from other sources, although they're still on the scarce side. See the Using EFI Drivers page for more on this @@ -562,6 +684,8 @@ $ ioreg -l -p IODeviceTree | grep firmware-abi +

    Some sources suggest that delayed launches of rEFInd on Macs are more common when installing rEFInd to the ESP, so if you've done this, you could try re-installing it to your OS X boot partition.

    +

    Uninstalling rEFInd
    • Table 1: Options to install.sh
    --espThis option tells install.sh to install rEFInd to the ESP of your computer. This option is only useful on OS X; on Linux, installing to the ESP is the default, so --esp is implicit on Linux. Be aware that some users have reported sluggish boots when installing rEFInd to the ESP on Macs. Installing rEFInd anywhere but the ESP makes little sense on UEFI-based PCs, except for the partial exception of removable boot media, which you can prepare with --usedefault.This option tells install.sh to install rEFInd to the ESP of your computer. This option is only useful on OS X; on Linux, installing to the ESP is a practical necessity, so --esp is implicit on Linux. Be aware that some users have reported sluggish boots when installing rEFInd to the ESP on Macs. Installing rEFInd anywhere but the ESP makes little sense on UEFI-based PCs, except for the partial exception of removable boot media, which you can prepare with --usedefault.
    --usedefault device-fileYou can install rEFInd to a disk using the default/fallback filename of EFI/BOOT/bootx64.efi (and EFI/BOOT/bootia32.efi, if the 32-bit build is available) using this option. The device-file should be an unmounted ESP, or at least a FAT partition, as in --usedefault /dev/sdc1. Your computer's NVRAM entries will not be modified when installing in this way. The intent is that you can create a bootable USB flash drive or install rEFInd on a computer that tends to "forget" its NVRAM settings with this option. This option is mutually exclusive with --esp.You can install rEFInd to a disk using the default/fallback filename of EFI/BOOT/bootx64.efi (and EFI/BOOT/bootia32.efi, if the 32-bit build is available) using this option. The device-file should be an unmounted ESP, or at least a FAT partition, as in --usedefault /dev/sdc1. Your computer's NVRAM entries will not be modified when installing in this way. The intent is that you can create a bootable USB flash drive or install rEFInd on a computer that tends to "forget" its NVRAM settings with this option. This option is mutually exclusive with --esp and --root (except for implicit use of --esp on Linux).
    --root /mount-pointThis option is intended to help install rEFInd from a "live CD" or other emergency system. To use it, you should mount your regular installation at /mount-point, including your /boot directory (if it's separate) at /mount-point/boot and (on Linux) your ESP at that location or at /mount-point/boot/efi. The install.sh script then installs rEFInd to the appropriate location—on Linux, /mount-point/boot/EFI/refind or /mount-point/boot/efi/EFI/refind, depending on where you've mounted your ESP; or on OS X, to /mount-point/EFI/refind. The script also adds an entry to your NVRAM for rEFInd at this location. You cannot use this option with either --esp or --usedefault, except for implicit use of --esp on Linux. Note that this option is not needed when doing a dual-boot Linux/OS X installation; just install normally in OS X.
    --driversOrdinarily install.sh does not install drivers; but when you specify this option, it does; it copies all the driver files for your architecture. You may want to remove unused driver files after you use this option, especially if your computer uses Secure Boot.--nodriversOrdinarily install.sh attempts to install the driver required to read /boot on Linux. This attempt works only if you're using ext2fs, ext3fs, ext4fs, or ReiserFS on the relevant partition. If you want to forego this driver installation, pass the --nodrivers option. This option is the default on OS X or when you use --usedefault.
    --alldriversWhen you specify this option, install.sh copies all the driver files for your architecture. You may want to remove unused driver files after you use this option, especially if your computer uses Secure Boot.
    --shim shim-filenameIf you pass this option to install.sh, the script will copy the specified shim program file to the target directory, copy the MokManager.efi file from the shim program file's directory to the target directory, copy the 64-bit version of rEFInd as grubx64.efi, and register shim with the firmware. (If you also specify --usedefault, the NVRAM registration is skipped.) The intent is to simplify rEFInd installation on a computer that uses Secure Boot; when so set up, rEFInd will boot in Secure Boot mode, with one caveat: The first time you boot, MokManager will launch, and you must use it to locate and install a public key. This key file will be located in the rEFInd directory under the name refind.cer. Note that I'm not providing a shim binary myself, but you can download one from here. In the not-too-distant future, most distributions will provide their own shim programs, so you'll be able to point to them—for instance, in /boot/efi/EFI/redhat/shim.efi.If you pass this option to install.sh, the script will copy the specified shim program file to the target directory, copy the MokManager.efi file from the shim program file's directory to the target directory, copy the 64-bit version of rEFInd as grubx64.efi, and register shim with the firmware. (If you also specify --usedefault, the NVRAM registration is skipped.) The intent is to simplify rEFInd installation on a computer that uses Secure Boot; when so set up, rEFInd will boot in Secure Boot mode, with one caveat: The first time you boot, MokManager will launch, and you must use it to locate and install a public key. This key file will be located in the rEFInd directory's keys subdirectory under the name refind.cer. Note that I'm not providing a shim binary myself, but you can download one from here. In the not-too-distant future, most distributions will provide their own shim programs, so you'll be able to point to them—for instance, in /boot/efi/EFI/fedora/shim.efi.
    --localkeys