Installation

From Alpine Linux
Revision as of 06:26, 12 September 2024 by Prabuanand (talk | contribs) (rephrased some sentences. Refactored Verifyind downloaded image section)


This page exists to provide a basic overview to get started. Before actually installing, it can help to skim through the Frequently Asked Questions (FAQ), as well as to refer to the official installation guide at docs.alpinelinux.org.

Tip: This is a wiki!

If something isn't correct, or is incomplete, you will have to figure it out, or ask for the correct solution in the community.

And then carefully edit the wiki page.

Just as those before who did it for you.

Minimal Hardware Requirements

  • At least 128 MB of RAM. [A graphical desktop system may require up to 512 minimum.]. Note that an installation itself (from ISO) generally requires at least 320 MB during installation.
  • At least 0-700 MB space on a writable storage device. [Only required in "sys" or "data" mode installations (explained below). It is optional in "diskless" mode, where it may be used to save newer data and configurations states of a running system.]
Note:

For architectures other than X86, refer to their respective pages:

Installation Overview

Note: Refer custom installation instructions for headless system, virtualization etc

The installation procedure for Alpine Linux requires basic understanding the three modes of running Alpine Linux i.e Diskless Mode, Data Disk Mode and System Disk Mode . The general course outlined below is common for all the three modes.

General course of action

  1. Download the installation image.
  2. Verify the downloaded image.
  3. Prepare the Installation media (e.g.: CD, DVD, USB drive, SD Card, etc).
  4. Verify the Installation media before using it.
  5. Boot the target computer using the Installation media.
  6. Follow the Installation steps to complete the Base configuration i.e complete the pre-setup of "diskless" Alpine Linux system.
Note: It is really helpful for many cases to first complete the base configuration, then proceed with installation of the target system with any one of the various alternate courses of action.

Alternate courses of action

Examples of preparation options:

  • Download and install some specific driver or software tool.
  • Preparing a Custom partitioning of the harddisk or filesystem scheme that avoids overwrite of an entire disk.
  • Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager apk.
  • Use more specific setup-scripts afterwards in order to proceed with the final installation in a custom way.


Examples of proceeding options:

  • setup-lbu to configure a "local backup" location for the diskless system, and lbu commit to then save the local configuration state.
  • setup-apkcache to configure a local package cache storage location.
  • setup-disk to add a "data" mode partition,
  • Use setup-disk to complete a classic or traditional hard-disk installation using "sys" disk mode onto a partition or to an entire disk.
  • Use setup-disk to Dualboot Alpine Linux along side another operating system.

There are many more setup-scripts available. All these tools may also be run later to adjust specific configurations. For example, to set up a graphical environment as covered under Post-Installation below.

Alpine Linux modes

Alpine Linux can be installed and run in following three modes.

Diskless Mode

This means the entire operating system with all applications are first loaded into RAM and then only run from there. This is the method already used to boot the .iso installation images, however setup-alpine can also configure the installed system to continue to boot like this if "disk=none" is specified. The mode is extremely fast and can save on unnecessary disk spin-ups, power, and wear. It is similar to what other linux distributions may call a "frugal" install or boot into with a "toram" option.

Custom configurations and package installations may optionally still be preserved or "persist" across reboots by using the Alpine local backup tool lbu. It enables committing and reverting system states by using .apkovl files that are saved to writable storage and loaded when booting. If additional or updated packages have been added to the system, these may also be made available for automatic (re)installation during the boot phase without any (re)downloading, by enabling a local package cache on the writable storage.

[FIXME-1: Storing local configs and the package cache on internal disks still require some manual steps to have the partition listed, i.e. making a /etc/fstab entry, mountpoint, and mount, *before* running setup-alpine. The linked workaround also still requires to commit these configurations to disk manually before rebooting.]

If a writable partition is available, setup-alpine can be told to store the configs and the package cache on that writable partition. (Later, another directory on that same partition or another available partition may also be mounted as /home, or for example, for selected important applications to keep their run-time and user data on it.)

The boot device of the newly configured local "diskless" system may remain the initial (and possibly read-only) installation media. But it is also possible to copy the boot system to a partition (e.g. /dev/sdXY) with setup-bootable.

Data Disk Mode

This mode also runs from system RAM, thus it enjoys the same accelerated operation speed as "diskless" mode. However, swap storage and the entire /var directory tree get mounted from a persistent storage device (two newly created partitions). The directory /var holds e.g. all log files, mailspools, databases, etc., as well as lbu backup commits and the package cache. This mode is useful for having RAM accelerated servers with variable amounts of user-data that exceed the available RAM size. It enables the entire current system state (not just the boot state) to survive a system crash in accordance with the particular filesystem guarantees.

[FIXME-2]: Setup-alpine will create the data partition and mount it as /var, but setup-alpine's "data" disk mode can not yet configure lbu config storage settings automatically. The current workaround, is to select "none" at the 'where to store configs' prompt (as the new data partition is not listed anyway) and configure lbu manually after setup-alpine exits, and before rebooting:

  1. Identify the created data partition, e.g. /dev/sdXY, and its filesystemtype, e.g. using lsblk
  2. Manually edit the lbu backups location in /etc/lbu/lbu.conf and configure LBU_MEDIA=sdXY (according to the previous findings).
  3. Save the configuration on that partition for the next boot with lbu commit.
  4. If (a new) partition fails to get mounted, execute: mkdir /media/sdXY ; echo "/dev/sdXY /media/sdXY fstype noauto,rw 0 0" >> /etc/fstab, and try lbu commit again.

In data disk mode, the boot device may also remain the initial (and possibly read-only) installation media, or be copied to a partition (e.g. /dev/sdXY) with setup-bootable.

System Disk Mode

This is a traditional hard-disk install. If this mode is selected, the setup-alpine script deletes the existing partitions and creates three partitions on the selected storage device, /boot, swap and / (the filesystem root). This mode may, for example, be used for generic desktop and development machines.

Refer #Custom partitioning of the harddisk, if you do not want to use entire disk for Alpine Linux.

Preparing for the installation

Note: This "Additional Details" section needs to be consolidated with the work at https://docs.alpinelinux.org (not finished) (Restructuring things there, moving and linking from here or there?).


Downloading installation image

Download the stable-release installation image-file for the target computer's architecture with their corresponding sha256 (checksum) and GPG (signature) files.

Note: Download sha256 (checksum) and GPG (signature) files only from official site and not from mirrors.

Now you have three files of the following format..

alpine-standard-*.iso
alpine-standard-*.iso.sha256
alpine-standard-*.iso.asc

alpine-standard-3.20.3-x86_64.iso is the 3.20.3 version Standard image file in iso format for x86_64 architecture. Image file can also be gz for certain cases.

Verifying downloaded image

This two-stage verification ensures that the downloaded image is safe to use.

Ensure that all the three downloaded files remain in the same folder. Issue the following commands to verify the checksum and GPG signature of a downloaded image-file.

The sha256 checksum verifies the integrity of the downloaded image i.e no modifications occurred during download.

sha256sum -c alpine-*.iso.sha256

The GPG signature verifies the link between the downloaded image to the individual who signed it. Signature verification involves two steps:

Step 1. Download and import the gpg signature from official website

curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;

Step 2. Verify that the image signature matches with the one downloded in Step 1.

gpg --verify alpine-<version>.iso.asc alpine-<version>.iso

There are three utilities involved in the verification stage i.e sha256, curl and gpg. All the three utilities or their equivalents are available in every operating system including Linux, windows, Mac and BSD derivaties. From Security point of view, if you don't have them already, download and install them first and verify the images before proceeding further.

Preparing installation media

Note: These instructions are exclusively for x86_64 and x86. For ARM boards, see Alpine on ARM.

All data currently on the installation media will be lost, when the Alpine Linux image is written on it. Be extremely careful to correctly identify the device name for the installation media.

In Linux, dd command can write the downloaded image file to the installation media i.e target device. To identify the target device, all connected "bulk storage devices" can be listed with lsblk and blkid.

 # lsblk
 NAME            MAJ:MIN RM   SIZE RO TYPE  MOUNTPOINT
 sdX               0:0    0  64,0G  0 disk  
 ├─sdX1            0:1    0     2G  0 part  
 └─sdX2            0:2    0    30G  0 part  /mnt/sdX2
 
 # blkid
 /dev/sdX1: LABEL="some" UUID="..." TYPE="vfat"
 /dev/sdX2: LABEL="other" UUID="..." TYPE="ext4"

For example, if /dev/sdX is the desired target device, ensure that all mounted partitions of the target device are un-mounted first. In the above case, for device sdX with partitions sdX1 and sdX2, the partition sdX2 needs to be unmounted:

# umount /dev/sdX2

Note: In dd command, do not specify partition number for target device i.e use /dev/sdX and not /dev/sdX1

The syntax for dd command is as follows:

# dd if=<iso-image-file> of=<target-device> bs=4M status=progress; eject <target-device>

If your version of dd does not support the option "status=progress", remove it. The eject command removes the target device from the system and ensures the write cache is completely flushed.

A complete example for dd command with image file alpine-standard-3.20.3-x86_64.iso and target device /dev/sdd is shown below:

Warning: Below command will overwrite data on target device /dev/sdd. Modify if and of according to the name of your image file and target device


# dd if=~/Downloads/alpine-standard-3.20.3-x86_64.iso of=/dev/sdd bs=4M status=progress; eject /dev/sdd

In Windows, Rufus has been tested to create bootable USB flash drives and worked for Alpine Linux 3.12.x with the following settings:

  • Partition scheme: MBR Target system: BIOS or UEFI
  • File system: FAT32 Cluster size: 4096 bytes (default)

Verifying Installation media

After detaching and re-attaching the device, a bit-wise comparison can verify the data written to the device (instead of just data buffered in RAM). If the comparison terminates with an end-of-file error on the .iso file side, all the contents from the image have been written (and re-read) successfully:

 # cmp ~/Downloads/alpine-standard-3.20.3-x86_64.iso /dev/sdX
 cmp: EOF on alpine-standard-3.20.3-x86_64.iso

Booting Installation Media

Insert the Installation media to a proper drive or port of the computer and turn the machine on, or restart it, if already running.

Note: To successfully boot and install Alpine Linux, disable secure boot in the BIOS. Once Alpine Linux is installed, this can be enabled.

If the computer does not automatically boot from the desired device, one needs to bring up the boot menu and choose the media to boot from. Depending on the computer, the menu may be accessed by repeatedly pressing a key quickly when booting starts. Some computers require that you press the button before starting the computer and hold it down while the computer boots. Typical keys are: F9-F12, sometimes F7 or F8. If these don't bring up the boot menu, it may be necessary to enter the BIOS configuration and adjust the boot settings, for which typical keys are: Del F1 F2 F6 or Esc.

Installation Step Details

Boot Process

The boot process of the alpine installation image first copies the entire operating system into the RAM memory, and then already starts a complete Alpine Linux system from there. It will initially only provide a basic command line environment that does not depend on reading from any (possibly slow) initial boot media, anymore.

Local log-in is possible as the user root. Initially, the root user has no password.

At the command prompt, an interactive script named setup-alpine is available to configure and install the initial Alpine Linux system. Launch the Alpine Linux Installation by running the setup-alpine script :

#setup-alpine

Base configuration

The question-and-answer dialog of setup-alpine takes care of the base configuration.

It allows to configure the system to boot into one of three different Alpine Linux "disk" modes: "diskless"(none), "data" or "sys".

Example setup-alpine session

The setup-alpine script offers the following configuration options:

  • Keyboard Layout (Local keyboard language and usage mode, e.g. us and variant of us-nodeadkeys.)
  • Hostname (The name for the computer.)
  • Network (For example, automatic IP address discovery with the "DHCP" protocol.)
  • DNS Servers (Domain Name Servers to query. If unsure, leave DNS domain name blank and using 9.9.9.9 2620:fe::fe for DNS is typically adequate.)
  • Root password (the password used to login to the root account)
  • Timezone (Optionally display times/dates in your local time zone)
  • HTTP/FTP Proxy (Proxy server to use for accessing the web/ftp. Use "none" for direct connections to websites and FTP servers.)
  • Mirror (From where to download packages. Choose the organization you trust giving your usage patterns to.)
  • Setup a user (Setting up a regular user account)
  • NTP (Network Time Protocol client used for keeping the system clock in sync with a time server. Package "chrony" is part of the default install image.)
  • SSH (Secure SHell remote access server. "OpenSSH" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
  • In most cases, either one of following line(s) is displayed as follows: No disks found. or Available disks are: sda (128.0 GB JMicron Tech )
  • Disk Mode ( A pre-setup of the "diskless" system or base configuration is completed by answering "none" when asked for the following questions.)
    • Which disk(s) would you like to use? (or '?' for help or 'none') none
    • Enter where to store configs (/media/ or 'none') none
    • The location of the package cache none

Base configuration is complete with the above step. Refer to the alternate courses of action to proceed further.

System Disk mode Install

At the end of base configuration instead of answering none for the above prompts, the Sys Mode or traditional hard-disk install of Alpine Linux can be completed. However, this mode requires an entire hard disk for Alpine Linux.

The scripted installation creates three partitions on the selected disk, for /boot, swap and / (filesystem root). If a non-empty disk is chosen, existing partitions are deleted before the partitions are created.

If you do not have a dedicated Hard disk for Alpine linux, you have to follow custom partition or refer to alternate courses of action to proceed further.

  • At the Disk Mode stage, instead of none, sda or relevant disk must be chosen in the below screen:
  • Which disk(s) would you like to use? (or '?' for help or 'none') sda
  • Confirmation for the chosen disk appears. The following disk is selected: sda (128.0 GB JMicron Tech ).
  • Pay close attention and verify that the disk matches with your requirement. Answering none or pressing Ctrl+c will exit/abort the installation process.
Warning: If "sys" mode is chosen in the next step, the data on the chosen device will be overwritten!


  • How would you like to use it? ('sys', 'data', 'lvm' or '?' for help) sys

Now the script will complete system disk mode installation of Alpine Linux on the chosen disk. Once the traditional hard-disk install of Alpine Linux is complete, you can reboot the system to start using it.

Custom partitioning of the harddisk

Refer Setting up disks manually page for specific configurations related to RAID, encryption, LVM, etc. as well as to manually partition the harddisk.

For "diskless" or "data disk" mode installs, manual partitioning may be needed to prepare the harddisk for committing local backups of the system state with lbu commit, to have a place for a package cache, or to use it for a /var mount.

For a "sys" install, custom partitioning is needed only if the desired scheme differs from overwriting an entire disk, or using the default set of a /boot, swap and root partition on the disk.

Preparing for the first boot

If setup-alpine has finished configuring the "sys" disk mode, the system should be ready to reboot right away (see next subsection).

If the new local system was configured to run in "diskless" or "data" mode, and you do not want keep booting from the initial (and possibly read-only) installation media, the boot system needs to be copied to another device or partition.

The target partition may be identified using lsblk (after installing it with apk add lsblk) and/or blkid, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at setup-bootable

Once everything is in place, save your customized configuration with lbu commit before rebooting.

Reboot

First, remove the initial installation media from the boot drive, or detach it from the port it's connected to.

The system may now be power-cycled or rebooted to confirm everything is working correctly.

The relevant commands for this are poweroff or reboot. Login into the new system with the root account.

Completing the installation

The installation script installs only the base operating system. No applications e.g. web server, mail server, desktop environment, or web browsers are installed.

Please look under Post-Installation below, for some common things to do after installation.

Custom Installation Instructions

Custom-made headless apkovl can be done by first booting the install media on some computer with a display and keyboard attached, or in a virtual machine, and doing an intermediate "diskless" setup of just the boot media (more details below), i.e. using the offical setup-alpine to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Choosing "disks=none" for now, yet, configure to store configs on the boot media (if it is writable, otherwise on a separate storage media). And afterwards calling lbu commit to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on every subsequent (headless) boot from your custom-build <hostname>.apkovl.tar.gz stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).

Note: Specific topics should be kept on separate, individually manageable topic-pages and only get listed with a direct reference (link) on this general page.


Also see other Installation Category pages.

Post-Installation

Tip: Alpine Linux packages stay close to the upstream design. Therefore, all upstream documentation about configuring a software package, as well as good configuration guides from other distributions that stay close to upstream, e.g. those in the ArchWiki, or Gentoo wiki are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.

Daily driver guide

Alpine Linux is built to be small and resource efficient. It is still a general purpose Linux distribution designed for power users. If you feel the defaults are too lightweight for desktop use, it is easy to get most of the regular stuff working and use it as a daily driver.

Note: This guide assumes you have already installed a minimal Alpine Linux system in sys mode with working Internet by following the Installation guide. The following four steps are mandatory to install any Desktop:
  1. Create a non-privileged user account for security reasons.
  2. Ensure that community repository is enabled
  3. Install graphics driver for your video hardware.
  4. Install a desktop using Setup-desktop script or manually install any desktop of your choice.

Basics

Advanced

Other topics

Topics not strictly related to using Alpine Linux as desktop are listed below:

See also