Create a Bootable Device: Difference between revisions

From Alpine Linux
m (fixed small typo)
(rephrased sentence for clarity and added information related to pi)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Note|These instructions are exclusively for x86_64 and x86. For ARM boards, see [[Alpine_on_ARM#Preparing_installation_media]].}}
This page is about preparing a directly customizable boot media or '''customizable boot device''' for Alpine Linux, i.e a USB-Stick/CompactFlash/SDCard or SSD/NVMe harddisk based boot device with a writable filesystem i.e. non-iso9660.  


This page is about creating directly customizable boot devices. If you are looking for instructions on creating (flashing) read-only (iso9660 "CD" filesystem) images onto installation media, see the [[Installation#Flashing_.28direct_data_writing.29_the_installation_image-file_onto_a_device_or_media|Installation]] page instead.
A customizable boot device is basically an Alpine system in '''[[Diskless_Mode|diskless]]''' or '''[[Data_Disk_Mode|data]]''' disk-mode installed to (and booting from) a device with a writable filesystem. A customizable boot device allows <code>[[Alpine_local_backup|Local Backup Utility]](lbu)</code> utility to store local customizations as [[Diskless Mode#Apkovl|apkovl]] file and [[Diskless Mode#Local Package Cache|local package cache]]. It also allows to upgrade the kernel with its modules and firmware that is used to boot the system with the [[Diskless Mode#Upgrading_a_Diskless_System|update-kernel]] script.


A directly customizable Alpine Linux boot medium is basically an Alpine system in '''[[Installation#Diskless_Mode|diskless]]''' or '''[[Installation#Data_Disk_Mode|data]]''' disk-mode installed to (and booting from) a device with a writable filesystem. It allows to also upgrade the kernel with its modules and firmware that is used to boot the system with the <code>[[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs|update-kernel]]</code> script.
== Requirements ==


The more general local customizations, the configs (.apkovl) and the package cache, may of course also be stored on the same device, as long as the hardware is not being set to be write-locked by a hardware switch.
* An Alpine Linux [[Installation#Preparing_installation_media|'''installation media''']], can be CD/DVD/USB or an <code>.iso</code>file like <code>alpine-standard-{{AlpineLatest}}-x86_64.iso</code> or an compressed tarball file like <code>alpine-rpi-{{AlpineLatest}}-aarch64.tar.gz</code> or <code>.img.gz</code> file like <code>alpine-rpi-{{AlpineLatest}}-aarch64.img.gz</code> containing the desired [https://alpinelinux.org/downloads/ Alpine release].
* A device like an USB drive (flash, external HD/SSD/NVMe, card reader, etc.) or a CF "CompactFlash", or SDcard which will be used as a '''customizable boot device'''.


== Preparing customizable boot device ==
= Requirements =


* An Alpine Linux CD-ROM or an .iso file containing the desired Alpine release ([https://alpinelinux.org/downloads/ Download]).
To create a customizable boot device on a FAT32 filesystem for x86_64 and x86 using [[#Using setup-bootable|setup-bootable]] script is the preferred method. For [[Raspberry Pi]], using the image file i.e img.gz and following the [[Installation#Preparing installation media|installation media preparation steps]] with the SD card results in a customizable boot device. For other filesystems/architectures refer [[#Manually copying Alpine files|Manually copying Alpine files]] section.  
* A device like an USB drive (flash, external HD, card reader, etc.) or a CF "CompactFlash", or SDcard.


= Using setup-bootable  =
=== Using setup-bootable  ===


This is now the preferable method to create a directly customizable bootable device.
Customizable boot device can be created on a FAT32 filesystem using the [[Alpine_setup_scripts#setup-bootable|Setup-bootable]] script by following these steps. If you have an existing Alpine Linux machine and <code>iso</code> file, proceed directly to step 2.  


It consists an [[Installation]] of a '''diskless''' or '''data''' mode system with configs and package cache on the target device, and using the <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code> script to make the device bootable.
# Complete the [[Installation|Installation]] until the [[Installation#Base_configuration|base configuration]] step by booting from an Alpine Linux [[Installation#Preparing_installation_media|'''installation media''']]. Perform the initial execution of <Code>setup-alpine</Code> as described in the base configuration step answering "none" to all disk-related questions.
# Ensure that '''customizable boot device''' is plugged in before installing the necessary tools:{{Cmd|# apk add dosfstools util-linux}}
#:{{Warning|Use <Code>lsblk</Code> to identify the correct device name for your '''customizable boot device''' and use it instead of {{Path|/dev/sdX}} used here. If you are unsure, do not proceed, seek [[Alpine Linux:Support|support]].}}
# To nuke EVERYTHING on the disk {{Path|/dev/sdX}}, so it doesn't have weird stuff that affects later, issue the command:{{Cmd|# wipefs --all /dev/sdX}}
# [[Setting_up_disks_manually#Creating_partitions|Create a partition]] sdXY with the desired size, set the type to win95 fat, and set the bootable flag on it, or use the following command to use entire disk:{{Cmd|<nowiki># echo 'type=c, bootable' | sfdisk /dev/sdX</nowiki>}}
# [[Setting_up_disks_manually#Formatting_partitions|Format]] the newly created partition: {{cmd|# mkfs.vfat /dev/sda1}}
# If booted from an Alpine Linux [[Installation#Preparing_installation_media|'''installation media''']], use {{ic|mount}} command to figure out where the install media files are mounted. A read only('''ro''') mount will appear for '''/media/cdrom''' or '''/media/usb''' or something else, depending on your environment and adjust {{Path|media/cdrom}} in the command :{{Cmd|# setup-bootable -v /media/cdrom /dev/sdXY}}
# Alternatively, if you have an existing Alpine Linux machine with <code>.iso</code> file, issue the command: {{Cmd|# setup-bootable -v <code>alpine-standard-{{AlpineLatest}}-x86_64.iso</code> /dev/sdXY}}


= Manually copying Alpine files =
=== Manually copying Alpine files ===


If you can't/won't use '''setup-bootable''', you can manually create a customizable (writable) USB boot device instead.
The '''customizable boot device''' can be created by manually copying Alpine Linux files from both ISO(.iso) and tarballs (.tar.gz files) with a one line tweak (see below).


=== Copying ISO/tarball contents to a USB stick ===
# Install some prerequisites. The {{pkg|syslinux}} is required only for x86_64 and x86. (If you're not currently using Alpine Linux then you probably have these installed already, otherwise you'll have to figure out how to install them.)
 
#: {{Cmd|# apk add dosfstools syslinux}}
This method is written for copying files from an Alpine ISO file but also works for Alpine tarballs (.tar.gz files) with a one line tweak (see below).
 
# Install some prerequisites. (If you're not currently using Alpine Linux then you probably have these installed already, otherwise you'll have to figure out how to install them.)
#: {{Cmd|apk add dosfstools<BR>apk add syslinux}}
# Set the environment variable 'mydev' to the [https://en.wikipedia.org/wiki/Device_file device file] name of the USB stick that Alpine Linux is to be installed to:
# Set the environment variable 'mydev' to the [https://en.wikipedia.org/wiki/Device_file device file] name of the USB stick that Alpine Linux is to be installed to:
#: {{Warning | BE SURE TO GET THIS RIGHT OR ELSE YOU COULD OVERWRITE THE WRONG DISK! }}
#: {{Warning | BE SURE TO GET THIS RIGHT OR ELSE YOU COULD OVERWRITE THE WRONG DISK! }}
#: {{Note|If USB stick's device name ends in a digit, you might have to replace all instances of <code>${mydev}1</code> with <code>${mydev}p1</code> below.}}
#: {{Note|If USB stick's device name ends in a digit, you might have to replace all instances of <code>${mydev}1</code> with <code>${mydev}p1</code> below.}}
#: {{Cmd|<nowiki>mydev=/dev/sdU</nowiki>}}
#: {{Cmd|<nowiki>mydev=/dev/sda</nowiki>}}
# Make sure that the target drive's existing partitions, if any, are not mounted:
# Make sure that the target drive's existing partitions, if any, are not mounted:
#: {{Cmd|umount -q $mydev?}}
#: {{Cmd|umount -q $mydev?}}
Line 49: Line 51:
EOF</nowiki>}}
EOF</nowiki>}}
# Format the new FAT32 partition with a FAT32 filesystem:
# Format the new FAT32 partition with a FAT32 filesystem:
#: {{Cmd|<nowiki>mkdosfs -F32 ${mydev}1</nowiki>}}
#:{{Cmd|<nowiki>mkdosfs -F32 ${mydev}1</nowiki>}}
#: {{Tip|For ARM boards like [[Raspberry Pi]], ignore the next three steps and go to the 9th step related to tarball. Refer  [[Alpine_on_ARM#Preparing_installation_media|Alpine on ARM]] for more information.}}  
# Copy the [https://wiki.syslinux.org/wiki/index.php?title=Mbr syslinux executable boot code] into the bootstrap code area of the MBR boot sector (if you're not currently using Alpine Linux you may need to adjust the path to syslinux's mbr.bin file):
# Copy the [https://wiki.syslinux.org/wiki/index.php?title=Mbr syslinux executable boot code] into the bootstrap code area of the MBR boot sector (if you're not currently using Alpine Linux you may need to adjust the path to syslinux's mbr.bin file):
#: {{Cmd|<nowiki>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=$mydev</nowiki>}}
#: {{Cmd|<nowiki>dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=$mydev</nowiki>}}
# Install the syslinux bootloader files onto the FAT32 filesystem. (Ignore the "Hidden (2048) does not match sectors (62)" messages - modern systems use the partition table. If you are getting "no previous syslinux boot sector found" error, try adding <code>--install</code> flag):
# Install the syslinux bootloader files onto the FAT32 filesystem. (Ignore the "Hidden (2048) does not match sectors (62)" messages - modern systems use the partition table. If you are getting "no previous syslinux boot sector found" error, try adding <code>--install</code> flag):
#: {{Cmd|syslinux ${mydev}1}}
#: {{Cmd|syslinux ${mydev}1}}
# Copy the Alpine files to the FAT32 filesystem (to copy the contents of an Alpine {{Path|.tar.gz}} tarball instead of copying {{Path|/media/cdrom}}, set <code>$alpinetarball</code> to the path to the tarball and replace the 'cp' line with: <code>tar -p -s --atime-preserve --same-owner --one-top-level=/media/$mydevname -zxvf "$alpinetarball"</code>):
# Copy the Alpine files to the FAT32 filesystem (to copy the contents of an Alpine {{Path|.tar.gz}} tarball instead, see next item):
#: {{Cmd|<nowiki>mydevname=$(basename $mydev)1
#: {{Cmd|<nowiki>mydevname=$(basename $mydev)1
mkdir -p /media/$mydevname
mkdir -p /media/$mydevname
mount -t vfat ${mydev}1 /media/$mydevname
mount -t vfat ${mydev}1 /media/$mydevname
cp -aT /media/cdrom /media/$mydevname  # -T to copy hidden files
cp -aT /media/cdrom /media/$mydevname  # -T to copy hidden files
umount /media/$mydevname</nowiki>}}
# If you instead want to copy the contents of an Alpine {{Path|.tar.gz}} tarball, do this:
#: {{Cmd|<nowiki>mydevname=$(basename $mydev)1
mytarball=/path/to/alpine-tarball.tar.gz
mkdir -p /media/$mydevname
mount -t vfat ${mydev}1 /media/$mydevname
tar -p -s --atime-preserve --same-owner --one-top-level=/media/$mydevname -zxvf $mytarball
umount /media/$mydevname</nowiki>}}
umount /media/$mydevname</nowiki>}}
# (''Optional'') Remove any .apkovl overlay files that were transferred as part of the copy process. Do this if you want an unmodified, vanilla install.
# (''Optional'') Remove any .apkovl overlay files that were transferred as part of the copy process. Do this if you want an unmodified, vanilla install.
Line 65: Line 75:
umount /media/$mydevname</nowiki>}}
umount /media/$mydevname</nowiki>}}


== Troubleshooting ==


=== Troubleshooting ===
=== Wrong Device Name ===
 
==== Wrong Device Name ====


If you cannot boot from the boot device and you see something like:
If you cannot boot from the boot device and you see something like:
Line 79: Line 88:
* For other options, you can run <code>cat /proc/partitions</code> to see the available disks (i.e. 'sda' or 'sdb')
* For other options, you can run <code>cat /proc/partitions</code> to see the available disks (i.e. 'sda' or 'sdb')


==== Non-FAT32 Filesystems ====
===Non-FAT32 Filesystems ===
 
===== Diskless and data mode booting =====
 
When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using <code>update-kernel</code>. See: [[Alpine_Linux_package_management#Upgrading_.22diskless.22_and_.22data.22_disk_mode_installs]]


===== Sys mode booting  =====
When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using [[Diskless_Mode#Upgrading_a_Diskless_System|<code>update-kernel</code>]] script.


Mount the boot device and edit the {{Path|syslinux.cfg}} file.
Mount the boot device and edit the {{Path|syslinux.cfg}} file.
Line 97: Line 102:
in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)
in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)


== Finishing installation ==
=== Slow USB Devices ===
 
After one has booted the previously created Alpine Linux bootable USB medium, one has to prepare USB stick to hold local customizations and run ''setup-alpine'' to finish the installation.
 
First let's find out where is our just booted USB media mounted, the location could vary.
 
# mount | grep /media
/dev/sdU1 on /media/sdU1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=utf8,shortname=mixed,errors=remount-ro)
 
Create local directory on USB media to hold local APK cache (see [[Alpine_Linux_package_management#Local_Cache|APK Local Cache]] for details).
 
# mount -o remount,rw /media/sdU1
# mkdir /media/sdU1/cache
# setup-apkcache /media/sdU1/cache
# ls -l /etc/apk/cache
lrwxrwxrwx    1 root    root            17 Oct 19 13:16 /etc/apk/cache -> /media/sdU1/cache
 
Now run ''setup-alpine'' and proceed until a question about local disk selection - in ''diskless'' mode we won't use any disk (ie. our bootable media files is basically untouched) and we are going to use ''sdU1'' to hold our system customization.
 
# setup-alpine
...
Which disk(s) would you like to use? (or '?' for help or 'none') [none]
Enter where to store configs ('floppy', 'sdU1', 'usb' or 'none') [sdU1]:
Enter apk cache directory (or '?' or 'none') [/media/sdU1/cache]:
 
After the installer finished you can see how many created/modified files are detected and will be added to the backup:
# lbu status
# lbu status | wc -l
59
# lbu commit
# ls -l /media/sdU1/*apkovl.tar.gz
-rwxr-xr-x    1 root    root          9591 Oct 19 15:23 /media/sdU1/foo.apkovl.tar.gz
 
Now all the customization are saved into the ''foo.apkovl.tar.gz'' compressed tarball on the USB stick itself.


= Troubleshooting =
=== Slow USB Devices ===
Specifying the 'waitusb=X' option at the end of the syslinux.cfg line might help with certain USB devices that take a bit longer to register. X stands for the amount of seconds kernel will wait before looking for the installation media.
Specifying the 'waitusb=X' option at the end of the syslinux.cfg line might help with certain USB devices that take a bit longer to register. X stands for the amount of seconds kernel will wait before looking for the installation media.
  append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet '''waitusb=3'''
  append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet '''waitusb=3'''


=== CF card readers ===
=== CF card readers ===
Line 145: Line 113:
Also, many CF card readers don't support DMA correctly, so you may need to add ''nodma'' to the ''append'' line of the syslinux.cfg file.
Also, many CF card readers don't support DMA correctly, so you may need to add ''nodma'' to the ''append'' line of the syslinux.cfg file.


== See Also ==
* [[Diskless Mode]]
* [[Local APK cache|Local Package Cache]]
* [[Alpine local backup]]
* [[Diskless_Mode#Upgrading_a_Diskless_System|<code>update-kernel</code> script]]


 
[[Category:Installation]][[Category:Diskless]]
 
[[Category:Installation]]

Latest revision as of 17:45, 30 September 2025

This page is about preparing a directly customizable boot media or customizable boot device for Alpine Linux, i.e a USB-Stick/CompactFlash/SDCard or SSD/NVMe harddisk based boot device with a writable filesystem i.e. non-iso9660.

A customizable boot device is basically an Alpine system in diskless or data disk-mode installed to (and booting from) a device with a writable filesystem. A customizable boot device allows Local Backup Utility(lbu) utility to store local customizations as apkovl file and local package cache. It also allows to upgrade the kernel with its modules and firmware that is used to boot the system with the update-kernel script.

Requirements

  • An Alpine Linux installation media, can be CD/DVD/USB or an .isofile like alpine-standard-3.22.2-x86_64.iso or an compressed tarball file like alpine-rpi-3.22.2-aarch64.tar.gz or .img.gz file like alpine-rpi-3.22.2-aarch64.img.gz containing the desired Alpine release.
  • A device like an USB drive (flash, external HD/SSD/NVMe, card reader, etc.) or a CF "CompactFlash", or SDcard which will be used as a customizable boot device.

Preparing customizable boot device

To create a customizable boot device on a FAT32 filesystem for x86_64 and x86 using setup-bootable script is the preferred method. For Raspberry Pi, using the image file i.e img.gz and following the installation media preparation steps with the SD card results in a customizable boot device. For other filesystems/architectures refer Manually copying Alpine files section.

Using setup-bootable

Customizable boot device can be created on a FAT32 filesystem using the Setup-bootable script by following these steps. If you have an existing Alpine Linux machine and iso file, proceed directly to step 2.

  1. Complete the Installation until the base configuration step by booting from an Alpine Linux installation media. Perform the initial execution of setup-alpine as described in the base configuration step answering "none" to all disk-related questions.
  2. Ensure that customizable boot device is plugged in before installing the necessary tools:

    # apk add dosfstools util-linux

    Warning: Use lsblk to identify the correct device name for your customizable boot device and use it instead of /dev/sdX used here. If you are unsure, do not proceed, seek support.

  3. To nuke EVERYTHING on the disk /dev/sdX, so it doesn't have weird stuff that affects later, issue the command:

    # wipefs --all /dev/sdX

  4. Create a partition sdXY with the desired size, set the type to win95 fat, and set the bootable flag on it, or use the following command to use entire disk:

    # echo 'type=c, bootable' | sfdisk /dev/sdX

  5. Format the newly created partition:

    # mkfs.vfat /dev/sda1

  6. If booted from an Alpine Linux installation media, use mount command to figure out where the install media files are mounted. A read only(ro) mount will appear for /media/cdrom or /media/usb or something else, depending on your environment and adjust media/cdrom in the command :

    # setup-bootable -v /media/cdrom /dev/sdXY

  7. Alternatively, if you have an existing Alpine Linux machine with .iso file, issue the command:

    # setup-bootable -v alpine-standard-3.22.2-x86_64.iso /dev/sdXY

Manually copying Alpine files

The customizable boot device can be created by manually copying Alpine Linux files from both ISO(.iso) and tarballs (.tar.gz files) with a one line tweak (see below).

  1. Install some prerequisites. The syslinux is required only for x86_64 and x86. (If you're not currently using Alpine Linux then you probably have these installed already, otherwise you'll have to figure out how to install them.)

    # apk add dosfstools syslinux

  2. Set the environment variable 'mydev' to the device file name of the USB stick that Alpine Linux is to be installed to:
    Warning: BE SURE TO GET THIS RIGHT OR ELSE YOU COULD OVERWRITE THE WRONG DISK!

    Note: If USB stick's device name ends in a digit, you might have to replace all instances of ${mydev}1 with ${mydev}p1 below.

    mydev=/dev/sda

  3. Make sure that the target drive's existing partitions, if any, are not mounted:

    umount -q $mydev?

  4. Copy and paste the following as a single command to wipe the target drive, create an MBR partition table, and create a single FAT32 partition (you can ignore any "Partition #1 contains a vfat signature." warning message):

    fdisk -w always $mydev <<EOF o n p 1 2048 -0 t 0c a w EOF

  5. Format the new FAT32 partition with a FAT32 filesystem:

    mkdosfs -F32 ${mydev}1

    Tip: For ARM boards like Raspberry Pi, ignore the next three steps and go to the 9th step related to tarball. Refer Alpine on ARM for more information.
  6. Copy the syslinux executable boot code into the bootstrap code area of the MBR boot sector (if you're not currently using Alpine Linux you may need to adjust the path to syslinux's mbr.bin file):

    dd bs=440 count=1 conv=notrunc if=/usr/share/syslinux/mbr.bin of=$mydev

  7. Install the syslinux bootloader files onto the FAT32 filesystem. (Ignore the "Hidden (2048) does not match sectors (62)" messages - modern systems use the partition table. If you are getting "no previous syslinux boot sector found" error, try adding --install flag):

    syslinux ${mydev}1

  8. Copy the Alpine files to the FAT32 filesystem (to copy the contents of an Alpine .tar.gz tarball instead, see next item):

    mydevname=$(basename $mydev)1 mkdir -p /media/$mydevname mount -t vfat ${mydev}1 /media/$mydevname cp -aT /media/cdrom /media/$mydevname # -T to copy hidden files umount /media/$mydevname

  9. If you instead want to copy the contents of an Alpine .tar.gz tarball, do this:

    mydevname=$(basename $mydev)1 mytarball=/path/to/alpine-tarball.tar.gz mkdir -p /media/$mydevname mount -t vfat ${mydev}1 /media/$mydevname tar -p -s --atime-preserve --same-owner --one-top-level=/media/$mydevname -zxvf $mytarball umount /media/$mydevname

  10. (Optional) Remove any .apkovl overlay files that were transferred as part of the copy process. Do this if you want an unmodified, vanilla install.

    mount -t vfat ${mydev}1 /media/$mydevname rm /media/$mydevname/*.apkovl.tar.gz umount /media/$mydevname

Troubleshooting

Wrong Device Name

If you cannot boot from the boot device and you see something like:

Mounting boot media failed.
initramfs emergency recovery shell launched. Type 'exit' to continue boot

then it is likely that the device name in syslinux.cfg is wrong. You should replace the device name in this line:

append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet

with the proper device name.

  • For boot from USB, the device name should be 'usbdisk' (as shown above)
  • For other options, you can run cat /proc/partitions to see the available disks (i.e. 'sda' or 'sdb')

Non-FAT32 Filesystems

When the boot device is formatted with a filesystem other than those supported by default, the necessary initfs features need to be added to the modloop using update-kernel script.

Mount the boot device and edit the syslinux.cfg file.

Then locate the "append" line, and change the alpine_dev= setting to match the used filesystem and add the filesystem's kernel module to the modules= list.

For example, change

append [...] alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet

to

append [...] alpine_dev=usbdisk:ext4 modules=loop,cramfs,sd-mod,usb-storage,ext4 quiet

in the case of an ext4 formatted partition. (Or correspondingly for other filesystems, if they are supported by syslinux and the Alpine Linux kernel.)

Slow USB Devices

Specifying the 'waitusb=X' option at the end of the syslinux.cfg line might help with certain USB devices that take a bit longer to register. X stands for the amount of seconds kernel will wait before looking for the installation media.

append initrd=/boot/grsec.gz alpine_dev=usbdisk:vfat modules=loop,cramfs,sd-mod,usb-storage quiet waitusb=3

CF card readers

Some CF card readers have problems with the faster CF cards on the market. If you experience problems booting the CF card even after checking BIOS settings, you may need to use an older card.

Also, many CF card readers don't support DMA correctly, so you may need to add nodma to the append line of the syslinux.cfg file.

See Also