Alpine Linux - User contributions [en]

Installation

2025-07-30T20:42:57Z

Wackbyte: /* Downloading installation image */ formatting and style, reorder file name explanation

[[Image:hdd_mount.png|left|link=]]
 

This page exists to provide a basic overview to get started. Before actually installing, it can help to skim through the [[Alpine_Linux:FAQ| Frequently Asked Questions (FAQ)]], as well as to refer to the official installation guide at [https://docs.alpinelinux.org/ 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 [https://alpinelinux.org/community/ community].

And then carefully [[Help:Editing|edit]] the wiki page.

Just as those before who did it for you.}}

== Minimal Hardware Requirements ==
{{Main|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 [[#System Disk Mode|"sys"]] or [[#Data Disk Mode|"data"]] mode installations. It is optional in [[#Diskless Mode|"diskless"]] mode, where it may be used to save newer data and configurations states of a running system.]
* A working internet connection is required to complete [[#System Disk Mode|"sys"]] mode installation or use '''Extended image''' if available for your architecture.

{{Note|Refer [[#Custom Installation Instructions|custom installation instructions]] for headless system, virtualization etc. Most of the steps outlined on this page applies to all [[Architecture#Architectures_supported|Architectures]] supported by Alpine Linux. For more specific installation instructions, refer to their respective pages.}}

== Installation Overview ==

Alpine Linux can be installed and run in [[Setting_up_disks_manually#Alpine_Linux_modes|three modes]] i.e [[#Diskless_Mode|Diskless Mode]], [[#Data_Disk_Mode|Data Disk Mode]] and [[#System_Disk_Mode|System Disk Mode]]. The installation procedure for Alpine Linux '''requires basic understanding of the three modes''' explained in brief below:

==== Diskless Mode ====
{{Main|Diskless Mode}}
In Diskless mode the entire operating system with all applications are first loaded into RAM and then only run from there. This mode is extremely fast and can save on unnecessary disk spin-ups, power, and wear. Alpine Linux uses this method to boot the .iso installation images. The [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script configures the installed system to continue to boot like this if "disk=none" is specified.

==== Data Disk Mode ====
{{Main|Data Disk Mode}}
In Data Disk mode also the operating system runs from system RAM, thus it enjoys the same accelerated operation speed as "diskless" mode. However, swap storage and the entire {{Path|/var}} directory tree get mounted from a persistent storage device. This mode is useful for having RAM accelerated servers with variable amounts of user-data that exceed the available RAM size.

==== System Disk Mode ====

System or '''sys''' Disk Mode is the traditional hard-disk install. Alpine Linux can be installed to an entire [[#setup-alpine based System Disk Install|'''hard disk''']] using <code>setup-alpine</code> script or to custom partitions using [[Setting_up_disks_manually|<code>setup-disk</code>]]. For further info, refer [[Setting_up_disks_manually|System Disk Mode]].

=== General course of action ===

It is really helpful for many use cases to [[#Preparing for the installation|prepare]] and complete the [[#Installation Step Details|installation]] until the [[#Base configuration|base configuration]] step, then proceed with installation of the target system with any one of the various [[#Alternative courses of action|alternative]] courses of action.

=== Alternative courses of action ===

Examples of preparation options:

* Download some specific driver to configure the hardware, and/or install some software tool that may be missing in the live system by using the Alpine package manager <code>[[Alpine Package Keeper|apk]]</code>.
* Do a [[Setting up disks manually#Manual partitioning|manual partitioning]] of the hard disk that avoids overwrite of an entire disk.

Examples of such options:

* To install Alpine Linux on an '''entire hard disk''' with optional [[Alpine setup scripts#Environment Variables|environment variables]], proceed to [[#setup-alpine based System Disk Install|setup-alpine based System Disk Install]].
* Use {{ic|setup-disk}} script to complete a [[Setting up disks manually|traditional hard disk installation]] on a partition or to [[Dualbooting|dualboot]] or to configure [[Setting up disks manually#RAID|RAID]], [[Setting up disks manually#Encryption|encryption]] or [[Setting up disks manually#LVM|LVM]] for [[#System Disk Mode|"system"]] disk mode or to add a [[#Data Disk Mode|"data"]] mode partition.
* Create a [[Create a Bootable Device#Using setup-bootable|customizable boot media]] i.e a boot device with a writable filesystem for '''[[#Diskless Mode|diskless]]''' or '''[[#Data Disk Mode|data]]''' disk-mode.
* Configure a [[Diskless Mode#Using an internal disk for persistent storage|internal disk for persistent storage]] to save the local configuration state and local package cache for the [[#Diskless Mode|diskless]] system or '''[[#Data Disk Mode|data]]''' disk-mode.

There are many more [[Alpine setup scripts|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|Post-Installation]] below.

== Preparing for the installation ==

=== Downloading installation image ===

Installation image files are available in the '''iso''', '''tar.gz''', and '''img.gz''' formats. Download the [https://alpinelinux.org/downloads/ stable release installation image file] for the target computer's architecture with the corresponding <code>sha256</code> checksum and <code>GPG</code> signature files.
{{Tip|Only download the <code>sha256</code> checksum and <code>GPG</code> signature files from the [https://alpinelinux.org/downloads/ official site] and not from mirrors.}}

Now you have three files in the following format:
<pre>
alpine-standard-*.iso
alpine-standard-*.iso.sha256
alpine-standard-*.iso.asc
</pre>

<code>alpine-standard-{{AlpineLatest}}-x86_64.iso</code> is the '''standard''' image file for version '''{{AlpineLatest}}''' and the '''x86_64''' architecture in the '''iso''' format.

=== Verifying downloaded image ===

From Security point of view, verify the downloaded image file for both checksum and GPG signature before proceeding further. The three required utilities i.e <code>sha256</code>, <code>curl</code> and <code>gpg</code> or their equivalents are available in every operating system including Linux, windows, Mac and BSD derivaties.

{{Tip|Ensure that all the three downloaded files remain in the same folder. If not, adjust the commands accordingly.}}

The <code>sha256</code> checksum verifies the integrity of the downloaded image i.e no modifications occurred during download.
{{Cmd|sha256sum -c alpine-*.iso.'''sha256'''}}

The <code>GPG</code> 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
{{Cmd|curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;}}

Step 2. Verify that the image signature matches with the one downloaded in Step 1.
{{Cmd|gpg --verify alpine-*.iso.'''asc''' alpine-*.'''iso'''}}

=== Preparing installation media ===
{{Seealso|Burning ISOs}}

{{Warning|All data currently on the installation media will be '''erased''', when Alpine Linux installation image is written on it. Correctly identify the device name for the installation media using commands <code>lsblk</code> and <code>blkid</code>.}}
If downloaded image file is in '''img.gz''' format, unzip it using the command {{ic|gunzip alpine-rpi-{{AlpineLatest}}-aarch64.img.gz}} to {{ic|alpine-rpi-{{AlpineLatest}}-aarch64.img}} first before using with {{ic|dd}} command. In Linux {{ic|dd}} command can be used to write image files in both '''iso''' and '''img''' format to the installation media.

If '''tar.gz''' format image file is downloaded, follow the [[Create a Bootable Device#Manually copying Alpine files|instructions]] to create the installation media.

Modify the input file('''if''') of the {{ic|dd}} command according to the name and path to your image file and and the target device i.e output file('''of''') should be a device name '''/dev/sdX''' instead of partition like '''/dev/sdbXY''':{{Cmd|# dd if{{=}}alpine-standard-{{AlpineLatest}}-x86_64.iso of{{=}}/dev/sdX bs{{=}}4M status{{=}}progress; eject /dev/sdX}}

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

In Windows and Mac OS, [https://www.balena.io/etcher/ Etcher] can be used to create an installation media.

=== 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:

{{Cmd|# cmp ~/Downloads/alpine-standard-{{AlpineLatest}}-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-{{AlpineLatest}}-x86_64.iso</Code>}}

=== Booting Installation Media ===

Insert the [[#Preparing_installation_media|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 [[UEFI#Secure boot|secure boot]] in the BIOS. Once Alpine Linux is installed, this can be [[UEFI_Secure_Boot|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: {{key|F9}}-{{key|F12}}, sometimes {{key|F7}} or {{key|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: {{key|Del}} {{key|F1}} {{key|F2}} {{key|F6}} or {{key|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 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 <code>root</code>. Initially, the '''root''' user has no password.

At the command prompt, an interactive script named [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] is available to configure and install Alpine Linux. The script can be customized by the optional [[Alpine_setup_scripts#Environment_Variables|environment variables]], in case of [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']] mode. For e.g {{Codeline|<code>USE_EFI{{=}}1 BOOT_SIZE{{=}}512 setup-alpine</code>}}, sets the disklabel type to gpt, creates 512MB '''/boot''' partition with '''vfat''' filesystem and uses <code>grub</code> as bootloader.

=== Base configuration ===

Launch the Alpine Linux Installation by running the [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script :

{{Cmd|# setup-alpine}}

The question-and-answer dialog of <code>setup-alpine</code> takes care of the base configuration. It sets up a network connection to access Internet to configure the system to boot into one of three different Alpine Linux "disk" modes: [[Installation#Diskless_Mode|'''"diskless"'''(none)]], [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']]. If you choose to edit any option, the relevant file is opened in [[BusyBox#vi| '''vi''' editor]] for editing.

{{Tip| If you have access to a wired network, consider using [https://docs.alpinelinux.org/user-handbook/0.1a/Installing/setup_alpine.html#_setup_alpine_q Quick Mode], to complete the base configuration quickly.}}

[[File:Installation-alpine-alpine-setup-3-setup-scripts.png|350px|thumb|right|Example <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> session]]

The <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 ''' (Set up network connection to access Internet.)
#* Available interfaces are: '''eth0''' '''wlan0'''.(List depends on your hardware.)
#* Which one do you want to initialize? (or '?' or 'done') [eth0] (Enter 'done' after configuring '''atleast''' one interface for Internet access.)
#* Do you want to do any manual network configuration? (y/n) [n] (Default uses "DHCP".)
# '''DNS Servers''' (If none of the interfaces configured in previous step uses dhcp, set DNS server. If unsure, leave DNS domain name blank and using <code>[https://quad9.net/ 9.9.9.9 2620:fe::fe]</code> 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.)
# '''Set up 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. Default is "busybox".)
# '''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 [[#Alternative courses of action|alternative courses of action]] to proceed further.

=== setup-alpine based System Disk Install ===

<code>setup-alpine</code> script based system disk installation, needs an ''' entire hard disk(s)''' for Alpine Linux and uses a partitioning layout with (/)root partition, /boot partition and a swap partition, where [[Alpine_setup_scripts#Environment_Variables|environment variables]] determine filesystem, size of the boot partition and the bootloader used. If your use case matches the above, at the final step of [[#Base configuration|base configuration]], type the appropriate hard disk '''device name''' instead of '''none'''. If multiple disks are chosen, [[Alpine_setup_scripts#RAID|RAID]] is used.

* At the '''Disk Mode''' stage, '''sda''' or relevant disk(s) 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(s) appears. ''The following disk is selected:'' '''sda (128.0 GB JMicron Tech ).'''
{{Warning|Pay close attention to the disk name and size. If you enter '''sys''' in the next step, no further questions will be asked and data on the chosen disk(s) will be overwritten!. Enter {{key|Ctrl}}+{{key|c}} to abort the installation process. Proceed only if you are 100% sure.}}
* How would you like to use it? ('sys', 'data', 'lvm' or '?' for help) '''sys'''

If '''sys''' is chosen, the <code>setup-alpine</code> script will complete the traditional hard-disk installation of Alpine Linux on the chosen disk(s) without further questions. Once the installation is complete, you can skip the next steps and proceed to [[#Reboot|reboot]] the system to boot into the newly installed Alpine Linux and [[Installation#Post-Installation|configure]] further.

=== Custom partitioning ===

[[Setting_up_disks_manually#Manual_partitioning|Manual partitioning]] of the harddisk may be needed to prepare the harddisk for "sys" mode install using [[Setting_up_disks_manually|<code>setup-disk</code>]] and for storing the config file using [[Alpine_local_backup|<code>lbu commit</code>]] and package cache for [[Diskless Mode|Diskless]] and for /var mount for [[Data Disk Mode|Data disk]] mode installs. Refer [[Setting up disks manually|Setting up disks manually]] page for specific configurations related to [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]], [[Setting_up_disks_manually#LVM|LVM]], etc...

=== Preparing for the first boot ===
If [[#System_Disk_Mode|System Disk Mode]] of installation was performed, ignore this section and proceed to [[#Reboot|reboot]].

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#Preparing_installation_media|installation media]], create a [[Create_a_Bootable_Device|customizable boot device]]. Once everything is in place, save your customized configuration with {{ic|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 {{ic|poweroff}} or {{ic|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 at [[Installation#Post-Installation|Post-Installation]], for some common things to do after installation.

== Custom Installation Instructions ==


* [[Installation on a headless host]]
* [[Kernels]] ''(kernel selection, e.g. for VMs or RPi)''
* [[How to make a custom ISO image with mkimage]] ''(installation media with its own configuration)''
* [[Directly booting an ISO file]] ''(without flashing it to a disk or device)''
* [[Alpine Linux in a chroot]]
* [[Netboot Alpine Linux using iPXE]]
* [[:Category:Virtualization|Virtualization]]
* [[Using an answerfile with setup-alpine]]

Also see other [[:Category:Installation|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 [https://wiki.archlinux.org/ ArchWiki], or [https://wiki.gentoo.org/wiki/ Gentoo wiki] are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}


* [[Tutorials_and_Howtos#Desktop|Guide to daily drive]] Alpine Linux as a desktop OS
* [[Tutorials_and_Howtos#Services|Hosting services]] like mail/web/ssh/Firewall/VPN servers
* [[Tutorials_and_Howtos#Virtualization|Virtualization]] guide for using Alpine Linux as both guest and host
* Guide to [[OpenRC|OpenRC]] - Init system used to configure services

== See also ==

* [[Tutorials and Howtos]]
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

[[Category:Installation]]

Installation

2025-07-30T20:34:26Z

Wackbyte: /* Alternative courses of action */ formatting

[[Image:hdd_mount.png|left|link=]]
 

This page exists to provide a basic overview to get started. Before actually installing, it can help to skim through the [[Alpine_Linux:FAQ| Frequently Asked Questions (FAQ)]], as well as to refer to the official installation guide at [https://docs.alpinelinux.org/ 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 [https://alpinelinux.org/community/ community].

And then carefully [[Help:Editing|edit]] the wiki page.

Just as those before who did it for you.}}

== Minimal Hardware Requirements ==
{{Main|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 [[#System Disk Mode|"sys"]] or [[#Data Disk Mode|"data"]] mode installations. It is optional in [[#Diskless Mode|"diskless"]] mode, where it may be used to save newer data and configurations states of a running system.]
* A working internet connection is required to complete [[#System Disk Mode|"sys"]] mode installation or use '''Extended image''' if available for your architecture.

{{Note|Refer [[#Custom Installation Instructions|custom installation instructions]] for headless system, virtualization etc. Most of the steps outlined on this page applies to all [[Architecture#Architectures_supported|Architectures]] supported by Alpine Linux. For more specific installation instructions, refer to their respective pages.}}

== Installation Overview ==

Alpine Linux can be installed and run in [[Setting_up_disks_manually#Alpine_Linux_modes|three modes]] i.e [[#Diskless_Mode|Diskless Mode]], [[#Data_Disk_Mode|Data Disk Mode]] and [[#System_Disk_Mode|System Disk Mode]]. The installation procedure for Alpine Linux '''requires basic understanding of the three modes''' explained in brief below:

==== Diskless Mode ====
{{Main|Diskless Mode}}
In Diskless mode the entire operating system with all applications are first loaded into RAM and then only run from there. This mode is extremely fast and can save on unnecessary disk spin-ups, power, and wear. Alpine Linux uses this method to boot the .iso installation images. The [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script configures the installed system to continue to boot like this if "disk=none" is specified.

==== Data Disk Mode ====
{{Main|Data Disk Mode}}
In Data Disk mode also the operating system runs from system RAM, thus it enjoys the same accelerated operation speed as "diskless" mode. However, swap storage and the entire {{Path|/var}} directory tree get mounted from a persistent storage device. This mode is useful for having RAM accelerated servers with variable amounts of user-data that exceed the available RAM size.

==== System Disk Mode ====

System or '''sys''' Disk Mode is the traditional hard-disk install. Alpine Linux can be installed to an entire [[#setup-alpine based System Disk Install|'''hard disk''']] using <code>setup-alpine</code> script or to custom partitions using [[Setting_up_disks_manually|<code>setup-disk</code>]]. For further info, refer [[Setting_up_disks_manually|System Disk Mode]].

=== General course of action ===

It is really helpful for many use cases to [[#Preparing for the installation|prepare]] and complete the [[#Installation Step Details|installation]] until the [[#Base configuration|base configuration]] step, then proceed with installation of the target system with any one of the various [[#Alternative courses of action|alternative]] courses of action.

=== Alternative courses of action ===

Examples of preparation options:

* Download some specific driver to configure the hardware, and/or install some software tool that may be missing in the live system by using the Alpine package manager <code>[[Alpine Package Keeper|apk]]</code>.
* Do a [[Setting up disks manually#Manual partitioning|manual partitioning]] of the hard disk that avoids overwrite of an entire disk.

Examples of such options:

* To install Alpine Linux on an '''entire hard disk''' with optional [[Alpine setup scripts#Environment Variables|environment variables]], proceed to [[#setup-alpine based System Disk Install|setup-alpine based System Disk Install]].
* Use {{ic|setup-disk}} script to complete a [[Setting up disks manually|traditional hard disk installation]] on a partition or to [[Dualbooting|dualboot]] or to configure [[Setting up disks manually#RAID|RAID]], [[Setting up disks manually#Encryption|encryption]] or [[Setting up disks manually#LVM|LVM]] for [[#System Disk Mode|"system"]] disk mode or to add a [[#Data Disk Mode|"data"]] mode partition.
* Create a [[Create a Bootable Device#Using setup-bootable|customizable boot media]] i.e a boot device with a writable filesystem for '''[[#Diskless Mode|diskless]]''' or '''[[#Data Disk Mode|data]]''' disk-mode.
* Configure a [[Diskless Mode#Using an internal disk for persistent storage|internal disk for persistent storage]] to save the local configuration state and local package cache for the [[#Diskless Mode|diskless]] system or '''[[#Data Disk Mode|data]]''' disk-mode.

There are many more [[Alpine setup scripts|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|Post-Installation]] below.

== Preparing for the installation ==

=== Downloading installation image ===

Installation image files are available in '''iso''' or '''tar.gz''' or '''img.gz''' formats. Download the [https://alpinelinux.org/downloads/ stable-release installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
{{Tip| Download <code>sha256</code> (checksum) and <code>GPG</code> (signature) files only from [https://alpinelinux.org/downloads/ official] site and not from mirrors.}}

Now you have three files of the following format..
<pre>
alpine-standard-*.iso
alpine-standard-*.iso.sha256
alpine-standard-*.iso.asc
</pre>

''alpine-standard-{{AlpineLatest}}-x86_64.iso'' is the '''{{AlpineLatest}}''' version '''Standard''' image file in '''iso''' format for '''x86_64''' architecture.

=== Verifying downloaded image ===

From Security point of view, verify the downloaded image file for both checksum and GPG signature before proceeding further. The three required utilities i.e <code>sha256</code>, <code>curl</code> and <code>gpg</code> or their equivalents are available in every operating system including Linux, windows, Mac and BSD derivaties.

{{Tip|Ensure that all the three downloaded files remain in the same folder. If not, adjust the commands accordingly.}}

The <code>sha256</code> checksum verifies the integrity of the downloaded image i.e no modifications occurred during download.
{{Cmd|sha256sum -c alpine-*.iso.'''sha256'''}}

The <code>GPG</code> 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
{{Cmd|curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;}}

Step 2. Verify that the image signature matches with the one downloaded in Step 1.
{{Cmd|gpg --verify alpine-*.iso.'''asc''' alpine-*.'''iso'''}}

=== Preparing installation media ===
{{Seealso|Burning ISOs}}

{{Warning|All data currently on the installation media will be '''erased''', when Alpine Linux installation image is written on it. Correctly identify the device name for the installation media using commands <code>lsblk</code> and <code>blkid</code>.}}
If downloaded image file is in '''img.gz''' format, unzip it using the command {{ic|gunzip alpine-rpi-{{AlpineLatest}}-aarch64.img.gz}} to {{ic|alpine-rpi-{{AlpineLatest}}-aarch64.img}} first before using with {{ic|dd}} command. In Linux {{ic|dd}} command can be used to write image files in both '''iso''' and '''img''' format to the installation media.

If '''tar.gz''' format image file is downloaded, follow the [[Create a Bootable Device#Manually copying Alpine files|instructions]] to create the installation media.

Modify the input file('''if''') of the {{ic|dd}} command according to the name and path to your image file and and the target device i.e output file('''of''') should be a device name '''/dev/sdX''' instead of partition like '''/dev/sdbXY''':{{Cmd|# dd if{{=}}alpine-standard-{{AlpineLatest}}-x86_64.iso of{{=}}/dev/sdX bs{{=}}4M status{{=}}progress; eject /dev/sdX}}

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

In Windows and Mac OS, [https://www.balena.io/etcher/ Etcher] can be used to create an installation media.

=== 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:

{{Cmd|# cmp ~/Downloads/alpine-standard-{{AlpineLatest}}-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-{{AlpineLatest}}-x86_64.iso</Code>}}

=== Booting Installation Media ===

Insert the [[#Preparing_installation_media|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 [[UEFI#Secure boot|secure boot]] in the BIOS. Once Alpine Linux is installed, this can be [[UEFI_Secure_Boot|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: {{key|F9}}-{{key|F12}}, sometimes {{key|F7}} or {{key|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: {{key|Del}} {{key|F1}} {{key|F2}} {{key|F6}} or {{key|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 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 <code>root</code>. Initially, the '''root''' user has no password.

At the command prompt, an interactive script named [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] is available to configure and install Alpine Linux. The script can be customized by the optional [[Alpine_setup_scripts#Environment_Variables|environment variables]], in case of [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']] mode. For e.g {{Codeline|<code>USE_EFI{{=}}1 BOOT_SIZE{{=}}512 setup-alpine</code>}}, sets the disklabel type to gpt, creates 512MB '''/boot''' partition with '''vfat''' filesystem and uses <code>grub</code> as bootloader.

=== Base configuration ===

Launch the Alpine Linux Installation by running the [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script :

{{Cmd|# setup-alpine}}

The question-and-answer dialog of <code>setup-alpine</code> takes care of the base configuration. It sets up a network connection to access Internet to configure the system to boot into one of three different Alpine Linux "disk" modes: [[Installation#Diskless_Mode|'''"diskless"'''(none)]], [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']]. If you choose to edit any option, the relevant file is opened in [[BusyBox#vi| '''vi''' editor]] for editing.

{{Tip| If you have access to a wired network, consider using [https://docs.alpinelinux.org/user-handbook/0.1a/Installing/setup_alpine.html#_setup_alpine_q Quick Mode], to complete the base configuration quickly.}}

[[File:Installation-alpine-alpine-setup-3-setup-scripts.png|350px|thumb|right|Example <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> session]]

The <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 ''' (Set up network connection to access Internet.)
#* Available interfaces are: '''eth0''' '''wlan0'''.(List depends on your hardware.)
#* Which one do you want to initialize? (or '?' or 'done') [eth0] (Enter 'done' after configuring '''atleast''' one interface for Internet access.)
#* Do you want to do any manual network configuration? (y/n) [n] (Default uses "DHCP".)
# '''DNS Servers''' (If none of the interfaces configured in previous step uses dhcp, set DNS server. If unsure, leave DNS domain name blank and using <code>[https://quad9.net/ 9.9.9.9 2620:fe::fe]</code> 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.)
# '''Set up 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. Default is "busybox".)
# '''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 [[#Alternative courses of action|alternative courses of action]] to proceed further.

=== setup-alpine based System Disk Install ===

<code>setup-alpine</code> script based system disk installation, needs an ''' entire hard disk(s)''' for Alpine Linux and uses a partitioning layout with (/)root partition, /boot partition and a swap partition, where [[Alpine_setup_scripts#Environment_Variables|environment variables]] determine filesystem, size of the boot partition and the bootloader used. If your use case matches the above, at the final step of [[#Base configuration|base configuration]], type the appropriate hard disk '''device name''' instead of '''none'''. If multiple disks are chosen, [[Alpine_setup_scripts#RAID|RAID]] is used.

* At the '''Disk Mode''' stage, '''sda''' or relevant disk(s) 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(s) appears. ''The following disk is selected:'' '''sda (128.0 GB JMicron Tech ).'''
{{Warning|Pay close attention to the disk name and size. If you enter '''sys''' in the next step, no further questions will be asked and data on the chosen disk(s) will be overwritten!. Enter {{key|Ctrl}}+{{key|c}} to abort the installation process. Proceed only if you are 100% sure.}}
* How would you like to use it? ('sys', 'data', 'lvm' or '?' for help) '''sys'''

If '''sys''' is chosen, the <code>setup-alpine</code> script will complete the traditional hard-disk installation of Alpine Linux on the chosen disk(s) without further questions. Once the installation is complete, you can skip the next steps and proceed to [[#Reboot|reboot]] the system to boot into the newly installed Alpine Linux and [[Installation#Post-Installation|configure]] further.

=== Custom partitioning ===

[[Setting_up_disks_manually#Manual_partitioning|Manual partitioning]] of the harddisk may be needed to prepare the harddisk for "sys" mode install using [[Setting_up_disks_manually|<code>setup-disk</code>]] and for storing the config file using [[Alpine_local_backup|<code>lbu commit</code>]] and package cache for [[Diskless Mode|Diskless]] and for /var mount for [[Data Disk Mode|Data disk]] mode installs. Refer [[Setting up disks manually|Setting up disks manually]] page for specific configurations related to [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]], [[Setting_up_disks_manually#LVM|LVM]], etc...

=== Preparing for the first boot ===
If [[#System_Disk_Mode|System Disk Mode]] of installation was performed, ignore this section and proceed to [[#Reboot|reboot]].

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#Preparing_installation_media|installation media]], create a [[Create_a_Bootable_Device|customizable boot device]]. Once everything is in place, save your customized configuration with {{ic|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 {{ic|poweroff}} or {{ic|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 at [[Installation#Post-Installation|Post-Installation]], for some common things to do after installation.

== Custom Installation Instructions ==


* [[Installation on a headless host]]
* [[Kernels]] ''(kernel selection, e.g. for VMs or RPi)''
* [[How to make a custom ISO image with mkimage]] ''(installation media with its own configuration)''
* [[Directly booting an ISO file]] ''(without flashing it to a disk or device)''
* [[Alpine Linux in a chroot]]
* [[Netboot Alpine Linux using iPXE]]
* [[:Category:Virtualization|Virtualization]]
* [[Using an answerfile with setup-alpine]]

Also see other [[:Category:Installation|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 [https://wiki.archlinux.org/ ArchWiki], or [https://wiki.gentoo.org/wiki/ Gentoo wiki] are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}


* [[Tutorials_and_Howtos#Desktop|Guide to daily drive]] Alpine Linux as a desktop OS
* [[Tutorials_and_Howtos#Services|Hosting services]] like mail/web/ssh/Firewall/VPN servers
* [[Tutorials_and_Howtos#Virtualization|Virtualization]] guide for using Alpine Linux as both guest and host
* Guide to [[OpenRC|OpenRC]] - Init system used to configure services

== See also ==

* [[Tutorials and Howtos]]
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

[[Category:Installation]]

Installation

2025-07-30T20:29:27Z

Wackbyte: /* General course of action */ formatting

[[Image:hdd_mount.png|left|link=]]
 

This page exists to provide a basic overview to get started. Before actually installing, it can help to skim through the [[Alpine_Linux:FAQ| Frequently Asked Questions (FAQ)]], as well as to refer to the official installation guide at [https://docs.alpinelinux.org/ 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 [https://alpinelinux.org/community/ community].

And then carefully [[Help:Editing|edit]] the wiki page.

Just as those before who did it for you.}}

== Minimal Hardware Requirements ==
{{Main|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 [[#System Disk Mode|"sys"]] or [[#Data Disk Mode|"data"]] mode installations. It is optional in [[#Diskless Mode|"diskless"]] mode, where it may be used to save newer data and configurations states of a running system.]
* A working internet connection is required to complete [[#System Disk Mode|"sys"]] mode installation or use '''Extended image''' if available for your architecture.

{{Note|Refer [[#Custom Installation Instructions|custom installation instructions]] for headless system, virtualization etc. Most of the steps outlined on this page applies to all [[Architecture#Architectures_supported|Architectures]] supported by Alpine Linux. For more specific installation instructions, refer to their respective pages.}}

== Installation Overview ==

Alpine Linux can be installed and run in [[Setting_up_disks_manually#Alpine_Linux_modes|three modes]] i.e [[#Diskless_Mode|Diskless Mode]], [[#Data_Disk_Mode|Data Disk Mode]] and [[#System_Disk_Mode|System Disk Mode]]. The installation procedure for Alpine Linux '''requires basic understanding of the three modes''' explained in brief below:

==== Diskless Mode ====
{{Main|Diskless Mode}}
In Diskless mode the entire operating system with all applications are first loaded into RAM and then only run from there. This mode is extremely fast and can save on unnecessary disk spin-ups, power, and wear. Alpine Linux uses this method to boot the .iso installation images. The [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script configures the installed system to continue to boot like this if "disk=none" is specified.

==== Data Disk Mode ====
{{Main|Data Disk Mode}}
In Data Disk mode also the operating system runs from system RAM, thus it enjoys the same accelerated operation speed as "diskless" mode. However, swap storage and the entire {{Path|/var}} directory tree get mounted from a persistent storage device. This mode is useful for having RAM accelerated servers with variable amounts of user-data that exceed the available RAM size.

==== System Disk Mode ====

System or '''sys''' Disk Mode is the traditional hard-disk install. Alpine Linux can be installed to an entire [[#setup-alpine based System Disk Install|'''hard disk''']] using <code>setup-alpine</code> script or to custom partitions using [[Setting_up_disks_manually|<code>setup-disk</code>]]. For further info, refer [[Setting_up_disks_manually|System Disk Mode]].

=== General course of action ===

It is really helpful for many use cases to [[#Preparing for the installation|prepare]] and complete the [[#Installation Step Details|installation]] until the [[#Base configuration|base configuration]] step, then proceed with installation of the target system with any one of the various [[#Alternative courses of action|alternative]] courses of action.

=== Alternative courses of action ===

Examples of preparation options:

* Download some specific driver to configure the hardware, and/or install some software tool that may be missing in the live system by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.
* Do a [[Setting_up_disks_manually#Manual_partitioning|Manual partitioning]] of the harddisk that avoids overwrite of an entire disk.

Examples of such options:

* To install Alpine Linux on an '''entire hard disk''' with optional [[Alpine_setup_scripts#Environment_Variables|environment variables]], proceed to [[#setup-alpine_based_System_Disk_Install|setup-alpine based System Disk Install]].
* Use {{ic|setup-disk}} script to complete a [[Setting_up_disks_manually|traditional hard-disk installation]] on a partition or to [[Dualbooting|Dualboot]] or to configure [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]] or [[Setting_up_disks_manually#LVM|LVM]] for [[#System_Disk_Mode|"system"]] disk mode or to add a [[#Data Disk Mode|"data"]] mode partition.
* Create a [[Create_a_Bootable_Device#Using_setup-bootable|customizable boot media]] i.e a boot device with a writable filesystem for '''[[#Diskless_Mode|diskless]]''' or '''[[#Data_Disk_Mode|data]]''' disk-mode.
* Configure a [[Diskless_Mode#Using_an_internal_disk_for_persistent_storage|internal disk for persistent storage]] to save the local configuration state and local package cache for the [[#Diskless Mode|diskless]] system or '''[[#Data_Disk_Mode|data]]''' disk-mode.

There are many more [[Alpine_setup_scripts|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|Post-Installation]] below.

== Preparing for the installation ==

=== Downloading installation image ===

Installation image files are available in '''iso''' or '''tar.gz''' or '''img.gz''' formats. Download the [https://alpinelinux.org/downloads/ stable-release installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
{{Tip| Download <code>sha256</code> (checksum) and <code>GPG</code> (signature) files only from [https://alpinelinux.org/downloads/ official] site and not from mirrors.}}

Now you have three files of the following format..
<pre>
alpine-standard-*.iso
alpine-standard-*.iso.sha256
alpine-standard-*.iso.asc
</pre>

''alpine-standard-{{AlpineLatest}}-x86_64.iso'' is the '''{{AlpineLatest}}''' version '''Standard''' image file in '''iso''' format for '''x86_64''' architecture.

=== Verifying downloaded image ===

From Security point of view, verify the downloaded image file for both checksum and GPG signature before proceeding further. The three required utilities i.e <code>sha256</code>, <code>curl</code> and <code>gpg</code> or their equivalents are available in every operating system including Linux, windows, Mac and BSD derivaties.

{{Tip|Ensure that all the three downloaded files remain in the same folder. If not, adjust the commands accordingly.}}

The <code>sha256</code> checksum verifies the integrity of the downloaded image i.e no modifications occurred during download.
{{Cmd|sha256sum -c alpine-*.iso.'''sha256'''}}

The <code>GPG</code> 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
{{Cmd|curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;}}

Step 2. Verify that the image signature matches with the one downloaded in Step 1.
{{Cmd|gpg --verify alpine-*.iso.'''asc''' alpine-*.'''iso'''}}

=== Preparing installation media ===
{{Seealso|Burning ISOs}}

{{Warning|All data currently on the installation media will be '''erased''', when Alpine Linux installation image is written on it. Correctly identify the device name for the installation media using commands <code>lsblk</code> and <code>blkid</code>.}}
If downloaded image file is in '''img.gz''' format, unzip it using the command {{ic|gunzip alpine-rpi-{{AlpineLatest}}-aarch64.img.gz}} to {{ic|alpine-rpi-{{AlpineLatest}}-aarch64.img}} first before using with {{ic|dd}} command. In Linux {{ic|dd}} command can be used to write image files in both '''iso''' and '''img''' format to the installation media.

If '''tar.gz''' format image file is downloaded, follow the [[Create a Bootable Device#Manually copying Alpine files|instructions]] to create the installation media.

Modify the input file('''if''') of the {{ic|dd}} command according to the name and path to your image file and and the target device i.e output file('''of''') should be a device name '''/dev/sdX''' instead of partition like '''/dev/sdbXY''':{{Cmd|# dd if{{=}}alpine-standard-{{AlpineLatest}}-x86_64.iso of{{=}}/dev/sdX bs{{=}}4M status{{=}}progress; eject /dev/sdX}}

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

In Windows and Mac OS, [https://www.balena.io/etcher/ Etcher] can be used to create an installation media.

=== 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:

{{Cmd|# cmp ~/Downloads/alpine-standard-{{AlpineLatest}}-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-{{AlpineLatest}}-x86_64.iso</Code>}}

=== Booting Installation Media ===

Insert the [[#Preparing_installation_media|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 [[UEFI#Secure boot|secure boot]] in the BIOS. Once Alpine Linux is installed, this can be [[UEFI_Secure_Boot|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: {{key|F9}}-{{key|F12}}, sometimes {{key|F7}} or {{key|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: {{key|Del}} {{key|F1}} {{key|F2}} {{key|F6}} or {{key|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 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 <code>root</code>. Initially, the '''root''' user has no password.

At the command prompt, an interactive script named [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] is available to configure and install Alpine Linux. The script can be customized by the optional [[Alpine_setup_scripts#Environment_Variables|environment variables]], in case of [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']] mode. For e.g {{Codeline|<code>USE_EFI{{=}}1 BOOT_SIZE{{=}}512 setup-alpine</code>}}, sets the disklabel type to gpt, creates 512MB '''/boot''' partition with '''vfat''' filesystem and uses <code>grub</code> as bootloader.

=== Base configuration ===

Launch the Alpine Linux Installation by running the [[Alpine_setup_scripts#setup-alpine|<code>setup-alpine</code>]] script :

{{Cmd|# setup-alpine}}

The question-and-answer dialog of <code>setup-alpine</code> takes care of the base configuration. It sets up a network connection to access Internet to configure the system to boot into one of three different Alpine Linux "disk" modes: [[Installation#Diskless_Mode|'''"diskless"'''(none)]], [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']]. If you choose to edit any option, the relevant file is opened in [[BusyBox#vi| '''vi''' editor]] for editing.

{{Tip| If you have access to a wired network, consider using [https://docs.alpinelinux.org/user-handbook/0.1a/Installing/setup_alpine.html#_setup_alpine_q Quick Mode], to complete the base configuration quickly.}}

[[File:Installation-alpine-alpine-setup-3-setup-scripts.png|350px|thumb|right|Example <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> session]]

The <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 ''' (Set up network connection to access Internet.)
#* Available interfaces are: '''eth0''' '''wlan0'''.(List depends on your hardware.)
#* Which one do you want to initialize? (or '?' or 'done') [eth0] (Enter 'done' after configuring '''atleast''' one interface for Internet access.)
#* Do you want to do any manual network configuration? (y/n) [n] (Default uses "DHCP".)
# '''DNS Servers''' (If none of the interfaces configured in previous step uses dhcp, set DNS server. If unsure, leave DNS domain name blank and using <code>[https://quad9.net/ 9.9.9.9 2620:fe::fe]</code> 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.)
# '''Set up 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. Default is "busybox".)
# '''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 [[#Alternative courses of action|alternative courses of action]] to proceed further.

=== setup-alpine based System Disk Install ===

<code>setup-alpine</code> script based system disk installation, needs an ''' entire hard disk(s)''' for Alpine Linux and uses a partitioning layout with (/)root partition, /boot partition and a swap partition, where [[Alpine_setup_scripts#Environment_Variables|environment variables]] determine filesystem, size of the boot partition and the bootloader used. If your use case matches the above, at the final step of [[#Base configuration|base configuration]], type the appropriate hard disk '''device name''' instead of '''none'''. If multiple disks are chosen, [[Alpine_setup_scripts#RAID|RAID]] is used.

* At the '''Disk Mode''' stage, '''sda''' or relevant disk(s) 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(s) appears. ''The following disk is selected:'' '''sda (128.0 GB JMicron Tech ).'''
{{Warning|Pay close attention to the disk name and size. If you enter '''sys''' in the next step, no further questions will be asked and data on the chosen disk(s) will be overwritten!. Enter {{key|Ctrl}}+{{key|c}} to abort the installation process. Proceed only if you are 100% sure.}}
* How would you like to use it? ('sys', 'data', 'lvm' or '?' for help) '''sys'''

If '''sys''' is chosen, the <code>setup-alpine</code> script will complete the traditional hard-disk installation of Alpine Linux on the chosen disk(s) without further questions. Once the installation is complete, you can skip the next steps and proceed to [[#Reboot|reboot]] the system to boot into the newly installed Alpine Linux and [[Installation#Post-Installation|configure]] further.

=== Custom partitioning ===

[[Setting_up_disks_manually#Manual_partitioning|Manual partitioning]] of the harddisk may be needed to prepare the harddisk for "sys" mode install using [[Setting_up_disks_manually|<code>setup-disk</code>]] and for storing the config file using [[Alpine_local_backup|<code>lbu commit</code>]] and package cache for [[Diskless Mode|Diskless]] and for /var mount for [[Data Disk Mode|Data disk]] mode installs. Refer [[Setting up disks manually|Setting up disks manually]] page for specific configurations related to [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]], [[Setting_up_disks_manually#LVM|LVM]], etc...

=== Preparing for the first boot ===
If [[#System_Disk_Mode|System Disk Mode]] of installation was performed, ignore this section and proceed to [[#Reboot|reboot]].

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#Preparing_installation_media|installation media]], create a [[Create_a_Bootable_Device|customizable boot device]]. Once everything is in place, save your customized configuration with {{ic|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 {{ic|poweroff}} or {{ic|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 at [[Installation#Post-Installation|Post-Installation]], for some common things to do after installation.

== Custom Installation Instructions ==


* [[Installation on a headless host]]
* [[Kernels]] ''(kernel selection, e.g. for VMs or RPi)''
* [[How to make a custom ISO image with mkimage]] ''(installation media with its own configuration)''
* [[Directly booting an ISO file]] ''(without flashing it to a disk or device)''
* [[Alpine Linux in a chroot]]
* [[Netboot Alpine Linux using iPXE]]
* [[:Category:Virtualization|Virtualization]]
* [[Using an answerfile with setup-alpine]]

Also see other [[:Category:Installation|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 [https://wiki.archlinux.org/ ArchWiki], or [https://wiki.gentoo.org/wiki/ Gentoo wiki] are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}


* [[Tutorials_and_Howtos#Desktop|Guide to daily drive]] Alpine Linux as a desktop OS
* [[Tutorials_and_Howtos#Services|Hosting services]] like mail/web/ssh/Firewall/VPN servers
* [[Tutorials_and_Howtos#Virtualization|Virtualization]] guide for using Alpine Linux as both guest and host
* Guide to [[OpenRC|OpenRC]] - Init system used to configure services

== See also ==

* [[Tutorials and Howtos]]
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

[[Category:Installation]]

Alpine local backup

2025-07-30T19:05:41Z

Wackbyte: add space

Local backup utility ({{ic|lbu}}) is the Alpine Linux tool to manage [[Diskless Mode]] installations. For these installations, {{ic|lbu}} tool must be used to [[#Committing changes|commit the changes]] whenever [[Alpine Package Keeper]] is used.

When Alpine Linux boots in diskless mode, it initially only loads a few required packages from the boot device. However, local adjustments to what-gets-loaded-into-RAM are possible, e.g. installing a package or adjusting the configuration files in {{path|/etc}}. The modifications can be saved with {{ic|lbu}} tool to an overlay file i.e [[Diskless Mode#Apkovl|apkovl]] file that can be automatically loaded when booting, to restore the saved state.

By default, an {{ic|lbu commit}} only stores modifications below {{Path|/etc}}, with the exception of the {{Path|/etc/init.d/}} directory. If a user was created during the {{ic|setup-alpine}} script, that user's home directory is also added to the paths that <code>lbu</code> will backup up. However, [[#Include_special_files.2Ffolders_to_the_apkovl|lbu include]] enables modifying that set of included files, and can be used to specify additional files or folders.

== Overview ==

The <code>lbu</code> tool has several subcommands to manage the .apkovl:
{|
|-
| lbu commit
| lbu ci
| Create a backup of config to writeable media
|-
| lbu package
| lbu pkg
| Create backup package
|-
| lbu status
| lbu st
| Check what files have been changed since last commit
|-
| lbu list
| lbu ls
| Lists files that would go to tar package. Same as: {{Codeline|lbu package -v /dev/null}}
|-
| lbu diff
|
| Run a diff against last commit
|-
| lbu include
| lbu inc or lbu add
| Add filename(s) to include list{{Path|/etc/apk/protected_paths.d/lbu.list}}
|-
| lbu exclude
| lbu ex or lbu delete
| Add filename(s) to exclude list {{Path|/etc/apk/protected_paths.d/lbu.list}}
|-
| lbu list-backup
| lbu lb
| Show old commits
|-
| lbu revert
|
|Revert to older commit
|-
|}

In the examples below, you will find some characters with special meaning:
* '''|''' = '''or''' ''('lbu commit|ci' means that you can type ether 'lbu commit' or 'lbu ci')''
* '''[ ]''' = '''optional''' ''(In 'lbu commit|ci [-nv]' you can skip the '-n', '-v' or '-nv' part if you don't want it)''

== Committing changes ==

When you "commit" or save changes you've made to your system, <code>lbu</code> will generate a file named something like {{Path|<var>myboxname</var>.apkovl.tar.gz}} ''('myboxname' will be the same as the hostname)''.
The file (which contains your modifications) is called your "apkovl".
You will need to save your apkovl on suitable media (floppy, usb, cf, etc.).
<pre>
usage: lbu commit|ci [-nv] [<media>]

Options:
-d Remove old apk overlay files.
-e Protect configuration with a password.
-n Don't commit, just show what would have been committed.
-p <password> Give encryption password on the command-line
-v Verbose mode.

The following values for <media> are supported: floppy usb
If <media> is not specified, the environment variable LBU_MEDIA will be used.

Password protection will use aes-256-cbc encryption. Other ciphers can be
used by setting the DEFAULT_CIPHER or ENCRYPTION environment variables.
For possible ciphers, try: openssl -v

The password used to encrypt the file, can be specified with the -p
option or by using the PASSWORD environment variable.

The environment variable can also be set in /etc/lbu/lbu.conf
</pre>

== Creating an .apkovl "package" elsewhere than on the configured media ==

To "commit" changes, but override the destination of the generated apkovl file, use <code>lbu package</code> instead of <code>lbu commit</code>:

<pre>
usage: lbu package|pkg -v [<dirname>|<filename>]

Options:
-v Verbose mode.

If <dirname> is a directory, a package named <hostname>.apkovl.tar.gz will
be created in the specified directory.

If <filename> is specified, and is not a directory, a package with the
specified name will be created.

If neither <dirname> nor <filename> is specified, a package named
<hostname>.apkovl.tar.gz will be created in the current working directory.
</pre>

To create an apkovl from a client on a remote server, it's possible to use <code>lbu package</code> via SSH with {{Path|-}} as the apkovl name on the server:{{Cmd|ssh root@client "lbu package -" > client.apkovl.tar.gz}}

== Checking what will be added to your apkovl ==

<code>lbu status</code> lists what will be saved the next time you run <code>lbu commit</code>. Its default output is incremental, that is, it shows
only the files that have changed since the last commit. 
This can be overridden with the <code>-a</code> flag:

<pre>
usage: lbu status|st [-av]

Options:
-a Compare all files, not just since last commit.
-v show include and exclude lists.
</pre>

Another option is <code>lbu list</code>. This works like <code>lbu status -a</code> but the format of the output is a bit different. (It's strictly equivalent to <code>lbu package -v /dev/null</code>).

usage: lbu list|ls

A third option is <code>lbu diff</code>. This shows the same incremental changes that <code>lbu status</code> (without <code>-a</code>) does, but in a different format.

usage: lbu diff

== Include special files/folders to the apkovl ==

Assume you have some files you want to save permanently, but they are not located in {{Path|/etc}}. 
e.g. {{Path|/root/.ssh/authorized_keys}} (used by <code>sshd</code> to authenticate ssh-users). Such files/folders can be added to lbu's ''include'' list with the following command:

<pre>
usage: lbu include|inc|add [-rv] <file> ...
lbu include|inc|add [-v] -l

Options:
-l List contents of include list.
-r Remove specified file(s) from include list.
-v Verbose mode.
</pre>

{{Note|This information used to be maintained in {{Path|/etc/lbu/include}}. Now it's maintained together with the ''exclude'' list in {{Path|/etc/apk/protected_paths.d/lbu.list}}. Either way, the command <code>lbu include</code> only modifies lbu's configuration. You will need to run <code>lbu commit</code> to actually create/modify your apkovl.}}

== Exclude specific files/folders from the apkovl ==

Assume you have some files located in {{Path|/etc}} or one of its subfolders you ''do not'' want to save.
It could be a log file or status file that for some reason isn't in {{Path|/var/log/}} but in a location that would otherwise be tracked by <code>lbu</code>.
Such files/folders can be added to lbu's ''exclude'' list by manually editing the file or using the following command:
<pre>
usage: lbu exclude|ex|delete [-rv] <file> ...
lbu exclude|ex|delete [-v] -l

Options:
-l List contents of exclude list.
-r Remove specified file(s) from exclude list.
-v Verbose mode.
</pre>
{{Note|As stated above, this information is now maintained in {{Path|/etc/apk/protected_paths.d/lbu.list}}. The command <code>lbu exclude</code> also only modifies lbu's configuration. You will need to run <code>lbu commit</code> to actually create/modify your apkovl.}}

== Multiple backup versions ==

Lbu can keep multiple backups so you can revert back to older configurations. Set BACKUP_LIMIT in {{Path|/etc/lbu/lbu.conf}} to the number of backups you want to keep. Based on BACKUP_LIMIT, the previously active .apkovl will be renamed before creating the new file.

You can list the currently available backups and revert to an older one with the following commands:{{Cmd|<nowiki># lbu list-backup [<media>]
# lbu revert <filename> [<media>]</nowiki>}}

Nothing is changed on your running system when "reverting", it only affects which apkovl is loaded at the next boot.

== Saving and loading ISO image customizations ==

ISO boot images can save running states to [[Diskless Mode#Using an internal disk for persistent storage|system partitions]] and automatically loaded when booting the ISO boot image.

== Execute a script as part of a backup ==

Sometimes it's necessary to run a script before or after a backup. Scripts in two optional directories enable that:

/etc/lbu/pre-package.d
/etc/lbu/post-package.d

Files in those directories are run using run-script rules (meaning they must have the executable bit set, they are run in alphabetical order, and cannot contain an extension. e.g. {{Path|runme}} works, but {{Path|runme.sh}} does not. Also the shebang line on the first line should be indicated, e.g. #!/bin/sh .)

The scripts in {{Path|pre-package.d}} are run before apkovl is created. Scripts in {{Path|post-package.d}} are run after apkovl is created.

=== Example ===

Rather than adding the raw database directories to {{Path|/etc/lbu/include}}, you can do a "database dump". e.g. {{Pkg|postgresql}}:

* Create {{Path|/etc/lbu/pre-package.d/sqldump}} with the following contents: <pre>pg_dumpall -U postgres | gzip -c >/root/pgdatabases.gz</pre>
* Mark the file executable: <code>chmod +x /etc/lbu/pre-package.d/sqldump</code>
* Create {{Path|/etc/lbu/post-package.d/sqldumpdelete}} with the following contents: <pre>rm -f /root/pgdatabases.gz</pre>
* Mark the file executable: <code>chmod +x /etc/lbu/post-package.d/sqldumpdelete</code>
* Finally, add the database dump file to the list of files to back up: <code>lbu include root/pgdatabases.gz</code>

Now when you do a <code>lbu commit</code>, the sql databases are dumped and gzipped to {{Path|/root/pgdatabases.gz}}.
The temporary file is deleted at the end of the lbu commit.

On a catastrophic restore, the databases are not automatically restored (that's not lbu's job), but you will find a complete database dump in the {{Path|/root}} directory, where it can be restored manually.

P.s. These scripts are also launched when starting the commands: diff, list-backup, package, revert, status.

== See also ==

* [Diskless Mode]]
* [[Back Up a Flash Memory Installation]]
* [[Manually editing a existing apkovl]]

[[Category:Installation]]
[[Category:Booting]]
[[Category:Package Manager]]
[[category: Diskless]]