Alpine Linux - User contributions [en]

User talk:Sb1

2023-05-23T14:24:19Z

Sb1:

Hi,
I noticed your recent edits to Installation page made quite a development on an optional matter ('''headless config'''), that may still be of interest for many. 
I can see a few downsides on how it stands now:
* instructions for an ''optional thing'' are becoming very long (and yet incomplete)
* described method requires quite some familiarity with Alpine, whereas this guide is intended for new comers
* that solution has several pitfalls (it will transfer all same settings to any server installed with said apkovl, etc...)

I'm not sure why a reference to a straightforward and working third-party solution is now removed from wiki. 
Wiki is not official doc, and any mention does not express endorsement: quality external references are just fine in wiki. Referring to ''backdoor'' is irrelevant on this topic: it is not a good place to state personal judgement. 
As for the longer option you describe, it may fit better into tutorial section where things could be detailed more.

Would you reconsider the edits in that part?

:We could add the link (https://github.com/macmpi/alpine-linux-headless-bootstrap) to the main [[Raspberry Pi]] page. [[User:Bbbhltz|bbbhltz]] ([[User talk:Bbbhltz|talk]]) 15:18, 20 May 2023 (UTC)

::That third-party apkovl solution works on any Alpine platform it is not limited to Pi-thing: I've been successfully using it on x86_64, x86,... So referring to it from main install page makes sense --[[User:Alpwik|Alpwik]] ([[User talk:Alpwik|talk]]) 15:07, 21 May 2023 (UTC)

* That headless.apkovl has too many security complaints filed, and unfortunately the author has not yet chosen to take the secure-defaults-first approach. The overlay makes users accept publicly shipped "private"(not) keys, by default, and continues starting that unsecured sshd root login server after an installation, by default. Obviously wrong things, but the issues that got filed are hidden as "closed" without actually fixing the wrong behavior. That was the reason for the link removal, to not have users directed to it, at least not without prominent warning. At the moment, sadly, instead of fixing the defaults, the github readme actually kind of hides the facts in in descriptive footnotes that do not mention the consequences. --[[User:Sb1|Sb1]]
:: Ok, noted you are not happy with that solution, it's your own opinion. Please consider there are many different opinions out there (repo stars appreciations give some clues; you can discuss the topic there, etc...). This '''wiki is not a place for advocacy''', revenge statement or frustration expression: this does not help users and make things very confusing. Please consider reverting your last changes. --[[User:Alpwik|Alpwik]] ([[User talk:Alpwik|talk]]) 06:23, 23 May 2023 (UTC)

::: Sorry both of you. It appears that I made a change on the page by accident. My son touched the keyboard when I wasn't looking. Please feel free to "undo" whatever I just change on the Installation page. [[User:Bbbhltz|bbbhltz]] ([[User talk:Bbbhltz|talk]]) 07:33, 23 May 2023 (UTC)

:::: * The primary install wiki page for alpine would really not help users *learning to use alpine*, if just plugged with links to external packages, and worse if leaving out security relevant information. It's thus actually preferable to provide notes about imminent security facts and explaining the alternative of using the setup-alpine tools. Consequently, I looked up and added that information, which was missing in edits made by newly created user accounts. Concerning the topic of how to create an only-pre-configured headless install media, i.e. without a sshd that is already fully-configured for a particular system, I guess this would only need some one-liner to only set up starting the completion of the sshd install *after* the next boot (and then not doing an lbu commit after rebooting, to get a new sshd configuration for every new "headless" setup-alpine run after a reboot). --[[User:Sb1|Sb1]]

Installation

2023-05-23T10:58:05Z

Sb1: /* The general course of action */ small wording improvements

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continues to start its passwordless root login ssh-daemon on boot even after the user completed an installation [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself (only for special cases). [For example, for a "headless" system without a display and keyboard. Such a system can be properly installed after first booting the install media on some computer with a display and keyboard attached, or in a virtual machine, and completing an intermediate "diskless" setup of just the boot media (more details below), i.e. using the offical <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp auto-configuration, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the custom configs as "local backup". Then your completed setup, including its securely created own private keys, will readily get restored on every subsequent (headless) boot from your custom-build <code><hostname>.apkovl.tar.gz</code> file stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:43:26Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continues to start its passwordless root login ssh-daemon on boot even after the user completed an installation [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. One of those can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp auto-configuration, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the custom configs as "local backup". Then your completed setup, including its securely created own private keys, will readily get restored on every subsequent (headless) boot from your custom-build <code><hostname>.apkovl.tar.gz</code> file stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:34:06Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continues to start its passwordless root login ssh-daemon on boot even after the user completed an installation [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. One of those can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:30:56Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continues to start its passwordless root login ssh-daemon on boot even after the user completed an installation [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. This can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:30:11Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continues to start its passwordless root login ssh-daemon on boot even after completing an installation [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. This can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:28:25Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their own headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continuing to start its passwordless root login ssh-daemon on boot after completing the initial install [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. This can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:27:21Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continuing to start its passwordless root login ssh-daemon on boot after completing the initial install [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. This can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> to configure the system's network, possibly for dhcp if needed, a ssh server, and a login user. Then 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:26:11Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continuing to start its passwordless root login ssh-daemon on boot after completing the initial install [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, customizing the setup of the installation media itself for special cases. [For example, for a "headless" system without a display and keyboard. This can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:19:52Z

Sb1: /* The general course of action */

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly known "private"(not) keys for their headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continuing to start its passwordless root login ssh-daemon on boot after completing the initial install [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a customizing setup of the installation media itself. [For example, a "headless" system without a display and keyboard can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T23:17:52Z

Sb1: /* The general course of action */ ok, lets keep mentioning the external offer with due diligence

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* Be careful to understand the risks of using third-party packages [https://gitlab.alpinelinux.org/alpine/aports/-/issues/14904 not endorsed by alpine] but offered for installation of headless systems, when that package does not fix its defaults after issues got filed, like making users accept publicly know "private" keys for their headless servers by default [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/7 1], or by default continuing to start its passwordless root login ssh-daemon on boot after completing the initial install [https://github.com/macmpi/alpine-linux-headless-bootstrap/issues/6 2].}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a customizing setup of the installation media itself. [For example, a "headless" system without a display and keyboard can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T22:56:52Z

Sb1:

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* For headless system, initial network setup may be fed by pre-built <code>apkovl</code> overlay file, custom-made or via [https://github.com/macmpi/alpine-linux-headless-bootstrap/ 3rd party]}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a customizing setup of the installation media itself. [For example, a "headless" system without a display and keyboard can be properly installed after 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-22T22:55:19Z

Sb1: /* The general course of action */ Preparing a headless install is just one particular example.

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|
* For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.
* For headless system, initial network setup may be fed by pre-built <code>apkovl</code> overlay file, custom-made or via [https://github.com/macmpi/alpine-linux-headless-bootstrap/ 3rd party]}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a customizing setup of the installation media itself. [For example, a "headless" system without a display and keyboard can be properly installed 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

User talk:Sb1

2023-05-22T22:26:39Z

Sb1:

User talk:Sb1

2023-05-22T22:25:49Z

Sb1:

Raspberry Pi Zero W - Installation

2023-05-18T13:49:30Z

Sb1: rm link to page marked for deletion

{{TOC right}}

{{Delete|This page may be consolidated into the main Raspberry Pi installation page and then deleted.}}

= Introduction =
This wiki describes how I installed Alpine Linux 3.9.2 armhf on a Raspberry Pi Zero W. I had problems with it initially as WiFi wouldn't connect when going through the setup-alpine script and when I was able to get it connect (after numerous failed manual attempts) it wouldn't reconnect on reboot. The solution documented below adds and starts the rngd service prior to running setup-alpine which fixes the wifi connection problems and allows you to walk through the setup script successfully. It also adds the rngd and wpa_supplicant services to start at boot and removes the network service from the rc-update list completely, which seems like the wrong thing to do and probably is - networking still gets started, probably as a dependency to something else, and it starts after rngd and wpa_supplicant, which is what I needed. When the networking service was set to "boot" (which it was out of the box) it was starting before rngd and wpa_supplicant so wlan0 would never connect.

I need to go back through this again but it should work as written. Some steps may not be necessary for your use case and some steps may not be necessary at all, but don't seem to hurt. I'm still learning about Alpine Linux and hope to improve this process as I do more reading and experimentation.

Update - 7 Dec 2019 - I went through installation again on a Pi Zero W with Alpine 3.10.3 for armhf. First boot after writing the image to the SD card seems to work ok as far as WiFi functionality is concerned. Setup script completes and I was able to connect to WiFi and pull down packages etc. I decided to not install the rngd related packages at this point to see how a reboot looked, answer is not good. The dhcp request just times out. Running setup-alpine again at this point also doesn't work. If you start over and rewrite the image to the SD card, the first boot will again work ok, it's only rebooting that breaks Wifi. I think it's best to follow the steps for installing the rngd related packages and configuring the service to start at boot. Note that you can install what you need on first boot using apk, you don't need to copy the packages to the SD card offline as written below.

= Write image to SD =
First, format an SD card with the FAT filesystem. That can be done with a graphical tool like GParted once the SD card is mounted on your operating system. The following assumes the SD card device is at /dev/sdb1.

Mount the SD card:
{{Cmd|sudo mount /dev/sdb1 /mnt}}

Then, copy the files:
{{Cmd|tar -xzvf alpine-rpi-3.9.2-armhf.tar.gz -C /mnt --no-same-owner}}
If you have no means to mount the SD card normally with an SD reader, it can be mounted via USB via the Raspberry Pi Zero W, using the usbbootgui tool to mount as eMMC/SD card reader. On Ubuntu, this can be installed as follows:
{{Cmd|sudo add-apt-repository ppa:rpi-distro/ppa}}
{{Cmd|sudo apt install usbbootgui}}

A GUI should open as soon as you plug in your Pi; otherwise run
{{Cmd|usbbootgui}}

= Edit cmdline.txt and add line for serial console (Optional)=

This is for my use case and optional if you are using a local keyboard and monitor. I do not connect a keyboard and monitor but rather do the setup via the Pi's serial GPIO pins.

Create a file called cmdline.txt in the root of the SD card and place the following text in it:
{{Cmd|modules{{=}}loop,squashfs,sd-mod,usb-storage quiet dwc_otg.lpm_enable{{=}}0 console{{=}}tty1 console{{=}}ttyAMA0,115200}}

= Create usercfg.txt and edit (Optional) =

This is mostly optional I believe and applies to my use case where I will be running the Pi in a headless appliance type mode. I reduce the memory allocated for the GPU, turn off audio (not sure I still need this on the Zero W), disable bluetooth (which I think puts the serial console back on the real uart, again, need to double check), add w1 for a temperature sensor, and set the enable_uart to 1 (may not be necessary, need to verify and add comments). This can be done by creating a file called usercfg.txt at the base of the SD card with the following contents:
{{Cmd|gpu_mem{{=}}16
dtparam{{=}}audio{{=}}off
dtoverlay{{=}}pi3-disable-bt
dtoverlay{{=}}w1-gpio
enable_uart{{=}}1}}

= Create cache folder and add rng-tools packages =
{{Cmd|mkdir /mnt/cache}}
I copied/pasted the following into the cache dir on the SD card. I have another Alpine env to apk fetch packages from (chroot on Fedora)
{{Cmd|rng-tools-6.3.1-r1.652a1399.apk
rng-tools-openrc-6.3.1-r1.e9b063f8.apk}}

= Boot Pi with prepared SD card, login as root and add packages =

I'm still new to Alpine, not sure if the setup-apkcache step is necessary or accomplishes anything here.
{{Cmd|localhost:~# setup-apkcache
Enter apk cache directory (or '?' or 'none') [/var/cache/apk]: /media/mmcblk0p1/cache/

localhost:~# apk add --allow-untrusted /media/mmcblk0p1/cache/rng-tools-6.3.1-r1.652a1399.apk
(1/1) Installing rng-tools (6.3.1-r1)
Executing busybox-1.29.3-r10.trigger
OK: 8 MiB in 21 packages

localhost:~# apk add --allow-untrusted /media/mmcblk0p1/cache/rng-tools-openrc-6.3.1-r1.e9b063f8.apk
(1/1) Installing rng-tools-openrc (6.3.1-r1)
OK: 8 MiB in 22 packages}}

= Start rngd service =
{{Cmd|localhost:~# service rngd start
* Caching service dependencies ...
[ ok ]
* Starting rngd ...

Initalizing available sources
[ ok ]}}

= Run setup-alpine. Wifi connection should setup ok with rngd running. =
The setup process turns off the rngd service at some point, but that happens after wifi is connected.
{{Cmd|setup-alpine}}

= Configure services and reboot =
Removing networking from boot results in it not being present in any stage which seems like the wrong fix, but it runs after rngd and wpa_supplicant, which is what we want:
{{Cmd|pet-protect:~# rc-update add rngd boot
* service rngd added to runlevel boot

pet-protect:~# rc-update add wpa_supplicant boot
* service wpa_supplicant added to runlevel boot

pet-protect:~# rc-update del networking boot
* service networking removed from runlevel boot

pet-protect:~# rc-update -u
* Caching service dependencies ...
[ ok ]

pet-protect:~# lbu commit -d
pet-protect:~# reboot}}

[[category:Installation]]
[[category: Raspberry]]

Installation

2023-05-17T15:57:59Z

Sb1:

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

This page exists to provide the basic overview to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:33:04Z

Sb1: /* Data Disk Mode */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to the previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:31:35Z

Sb1: /* Data Disk Mode */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:30:53Z

Sb1: /* Data Disk Mode */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 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 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:21:16Z

Sb1: /* Data Disk Mode */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine's "data" disk mode will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:17:30Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> stored on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:16:04Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> 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 <code><hostname>.apkovl.tar.gz</code> on the boot media (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:11:42Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, a custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:10:53Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:09:53Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture, together with the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:08:54Z

Sb1: /* The general course of action */

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the target computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:07:54Z

Sb1:

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

This page exists to point out the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T12:05:49Z

Sb1:

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty 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 (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:59:33Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/ docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding some third-party backdoor package. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:56:16Z

Sb1: latest ver

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/ docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:54:38Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:53:18Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a basic setup of the initial "diskless" installation media in order to prepare for the installation of the target system. For example, also to download and install some specific driver or software tool. And to possibly use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation in a custom way. A most basic pre-setup of just the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, for where to store configs, and for the location of the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:44:10Z

Sb1: /* Data Disk Mode */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> exits, and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:42:43Z

Sb1: /* Data Disk Mode */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu 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 running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> but before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:38:28Z

Sb1: /* Data Disk Mode */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but '''can not yet configure lbu storage settings automatically'''. The '''current workaround''', is to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:32:48Z

Sb1: /* Diskless Mode */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on '''internal disks still require''' [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:27:48Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optionally, custom setup of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:24:01Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs as local backup. Then your completed setup, including its securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:21:43Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs. Then your completed setup, including securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It is really helpful for many cases that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, also to download and install some specific driver or software tool. And then also to use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, in order to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:17:39Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs. Then your completed setup, including securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, in case the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:17:08Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs. Then your completed setup, including securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media from your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, if the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:15:34Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs. Then your completed setup, including securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media with your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, if the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-17T11:14:53Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Bluproper-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to install a headless system without relying on adding a third-party backdoor. [A headless install is properly 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 (moree details below), i.e. using the offical <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs. Then your completed setup, including securely created own private keys, will readily get (re)loaded on a next (headless) boot of the boot media with your custom-build <code><hostname>.apkovl.tar.gz</code> on it (or on an auxilary media or server location, if the boot media is read-only).]
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-16T00:37:57Z

Sb1: /* Completing the installation */ setup-alpine can create user now

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, yet, to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations can get readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== 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 [[Installation#Post-Installation|Post-Installation]] below, for some common things to do after installation.

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-16T00:24:37Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, yet, to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations can get readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': '''"diskless"'''(none), '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== Completing the installation ===

The installation script installs only the base operating system. '''No''' applications e.g. web server, mail server, desktop environment, or web browser are installed, and <code>root</code> is the only user.

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

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-16T00:22:55Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, yet, to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations can get readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to boot into one of three different '''Alpine Linux disk modes''': '''"diskless"''', '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== Completing the installation ===

The installation script installs only the base operating system. '''No''' applications e.g. web server, mail server, desktop environment, or web browser are installed, and <code>root</code> is the only user.

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

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-16T00:18:56Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional customization of the installation media, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, yet, to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations can get readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to
boot into one of three different '''Alpine Linux disk modes''': '''"diskless"''', '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== Completing the installation ===

The installation script installs only the base operating system. '''No''' applications e.g. web server, mail server, desktop environment, or web browser are installed, and <code>root</code> is the only user.

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

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-15T18:03:42Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional installation media customization, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, yet, to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations can get readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to
boot into one of three different '''Alpine Linux disk modes''': '''"diskless"''', '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== Completing the installation ===

The installation script installs only the base operating system. '''No''' applications e.g. web server, mail server, desktop environment, or web browser are installed, and <code>root</code> is the only user.

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

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]

Installation

2023-05-15T18:00:40Z

Sb1: /* The general course of action */

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

This page explains the basics to get started. But before actually installing, it can also help to skim through the [[Alpine_Linux:FAQ| Frequenty Asked Questions (FAQ)]].

NOTE: This is an unofficial guide. Refer to the official installation guide at [https://docs.alpinelinux.org/user-handbook/0.1a/index.html docs.alpinelinux.org].

{{Tip|This is a wiki!
If something isn't correct (anymore), or still incomplete, you will have to try figuring it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==

* At least 100 MB of RAM. [A graphical desktop system may require up to 1 GB minimum.]
* 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.]

For more information please check [[Requirements]]

== Installation Overview ==

=== The general course of action ===
{{Note|For single-board-computer (SBC) architectures which can not boot .iso images, see [[Alpine_on_ARM|Alpine on ARM]] for peculiarities.}}

As usual, starting an installation procedure requires some basic steps (additional details for all the steps follow [[Installation#Basic Installation Step Details|below]]): 

# Downloading and verifying the proper [https://alpinelinux.org/downloads/ stable-release ISO installation image-file] for the computer's architecture, and the corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.
# Either burning the ISO image-file onto a blank CD/DVD/Blu-ray disk with disk burning software, or flashing the installation image onto a bootable storage device (USB-device, CF-/MMC-/SD-card, floppy, ...).
# Optional installation media customization, e.g. to do an install on a headless system. With alpine, this is done by first booting the install media either 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 (details below), i.e. configuring the system's network for dhcp, a ssh server, and a login user, but disks only "none" for now, and to store configs on the boot media (if it is writable, otherwise on a separate storage media). Then calling <code>[[Alpine_local_backup|lbu commit]]</code> to store the configs, and all customizations are readily loaded from the created .apkovl.tar.gz file on the next boot.
# Booting the target computer from the prepared disk or storage device.

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 <code>root</code>. Initially, the root user has no password.

At the command prompt, an interactive script named <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> is available to configure and install the initial Alpine Linux system.

The question-and-answer dialog of <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> takes care of the base configuration and allows to configure the system to
boot into one of three different '''Alpine Linux disk modes''': '''"diskless"''', '''"data"''', or '''"sys"'''.

These modes are explained in more detail in the following subsections.

{{Note|It can be helpful to know that it is possible to first only complete a base configuration of the initial "diskless" installation system in order to to prepare the system. For example, to download and install some specific driver or software tool. And then use more specific [[Alpine_setup_scripts|setup-scripts]] afterwards, to proceed with the final installation. The base configuration of the "diskless" system may be completed by running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and answering "none" when asked for the disk to use, and where to store configs, as well as for the location for the package cache.

Examples of preparation options:

* Preparing a custom partitioning or filesystem scheme that avoids to use and/or overwrite an entire disk ([[Installation#Custom_partitioning_of_the_harddisk|details below]]).
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.

Examples of proceeding options:

* <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the diskless system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a "data" mode partition, or do a classic full install of the "diskless" system onto a "sys" disk or partition.

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 [[Installation#Post-Installation|Post-Installation]] below.
}}

==='''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 <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_local_backup|lbu]]</code>. 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 [[Alpine_Package_Keeper#Local_Cache|local package cache]] on the writable storage.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 FIXME-1]: Storing local configs and the package cache on an ''internal'' disk still requires [[Alpine_local_backup#Saving_and_loading_ISO_image_customizations|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, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''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 {{Path|/var}} directory tree get mounted from a persistent storage device (two newly created partitions). The directory {{Path|/var}} holds e.g. all log files, mailspools, databases, etc., as well as <code>[[Alpine_local_backup|lbu]]</code> 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.

[[https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10474 FIXME-2]]: Setup-alpine will create the data partition and mount it as /var, but can not yet configure lbu storage settings automatically. It is currently necessary to select "none" at the 'where to store configs' prompt (the new data partition is not listed) and configure lbu manually, i.e. after running <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> and before rebooting:

# Identify the created data partition, e.g. <code>/dev/sd''XY''</code>, and its filesystemtype, e.g. using <code>''lsblk''</code>
# Manually edit the lbu backups location in <code>/etc/lbu/lbu.conf</code> and configure <code>LBU_MEDIA=sd''XY''</code> (according to previous findings).
# Save the configuration on that partition for the next boot with <code>lbu commit</code>.
# If (a new) partition fails to get mounted, execute: <code>mkdir /media/''sdXY'' ; echo "/dev/sd''XY'' /media/sd''XY'' ''fstype'' noauto,rw 0 0" >> /etc/fstab</code>, and try <code>lbu commit</code> 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 <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>.

==='''System Disk Mode'''===
This is a traditional hard-disk install.

If this mode is selected, the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script creates three partitions on the selected storage device, {{Path|/boot}}, {{Path|swap}} and {{Path|/}} (the filesystem root). This mode may, for example, be used for generic [[:Category:Desktop|desktop]] and development machines.

For custom partitioning, see [[Setting up disks manually]].

To install along side another operating systems, see [[Dualbooting]].

== Basic Installation Step Details ==

{{Expand| }}

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

=== Verifying the downloaded image-file ===

{| class="wikitable" style="width:95%; align=center"
|+ Commands to verify the checksum and GPG signature of a downloaded image-file on different systems.
|-
! width=100px | OS type
! <code>SHA256</code> check !! <code>SHA256</code> calculation (to be compared manually) !! <code>GPG</code> signature verification
|-
! Linux
| <code>sha256sum -c alpine-*.iso.sha256</code> || || <code>curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;</code>
<code> gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! MACOS
| - ? - || <code>shasum -a 256 alpine-*.iso</code> || - ? -
|-
! OpenBSD
| <code>sha256 -C alpine-*.sha256 alpine-*.iso</code> || || <code>doas pkg_add gnupg;
ftp -o - https://alpinelinux.org/keys/ncopa.asc | gpg --import ;
gpg --verify alpine-<version>.iso.asc alpine-<version>.iso</code>
|-
! FreeBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! NetBSD
| - ? - || <code>/usr/local/bin/shasum -a 256 alpine-*.iso</code> || - ? -
|-
! Windows (PowerShell installed)
| - ? - || <code>Get-FileHash .\alpine-<image-version>.iso -Algorithm SHA256</code> || - ? -
|}

=== Flashing (direct data writing) the installation image-file onto a device or media ===

==== Unix/Linux ====

Under Unix (and thus Linux), "everything is a file" and the data in the image-file can be written to a device or media with the <code>dd</code> command. Afterward, executing the <code>eject</code> command removes the target device from the system and ensures the write cache is completely flushed.

dd if=<iso-file-to-read-in> of=<target-device-node-to-write-out-to> bs=4M oflag=sync status=progress; eject <target-device-node-to-write-to>

Be careful to correctly identify the target device as any data on it '''will''' be lost! All connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.

# 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, first make sure you un-mount all mounted partitions of the target device. For example sdX1 and sdX2:

umount /dev/sdX1 /dev/sdX2

For <code>dd</code>'s output-file (<code>of=</code>), however, do '''not''' specify a partition number. For example, write to sdX, '''not''' sdX1:

Warning: '''This will overwrite the target device /dev/sdX''', so before executing, make sure you have a backup of the data if you can't afford to lose it.

dd if=~/Downloads/alpine-standard-3.00.0-x86_64.iso of=/dev/sdX bs=4M oflag=sync status=progress; eject /dev/sdX

==== Windows ====

For example, there is the [https://rufus.ie/ Rufus] program. Rufus will enable you to create bootable USB flash drives under Windows.

Rufus has been tested and works for Alpine Linux 3.12.x with the following settings:
* '''Partition scheme''': <code>MBR</code>
* '''Target system''': <code>BIOS or UEFI</code>
* '''File system''': <code>FAT32</code>
* '''Cluster size''': <code>4096 bytes (default)</code>

=== Verifying the written 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.00.0-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.00.0-x86_64.iso

=== Booting from external devices ===

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

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.`

=== Custom partitioning of the harddisk ===

It is possible to specify configurations for RAID, encryption, LVM, etc. as well as manual partitioning.

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 <code>[[Alpine_local_backup|lbu commit]]</code>, 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.

See [[Setting up disks manually]] for the alpine options for RAID, encryption, LVM, etc. and manual partitioning.

=== Questions asked by <code>setup-alpine</code> ===
[[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''' (For example, automatic IP address discovery with the "DHCP" protocol.)
* '''DNS Servers''' (Domain Name Servers to query. For privacy reasons it is NOT recommended to route every local request to servers like google's <s>8.8.8.8</s> .)
* '''Timezone'''
* '''Proxy''' (Proxy server to use for accessing the web. Use "none" for direct connections to the internet.)
* '''Mirror''' (From where to download packages. Choose the organization you trust giving your usage patterns to.)
* '''SSH''' (Secure SHell remote access server. "Openssh" is part of the default install image. Use "none" to disable remote login, e.g. on laptops.)
* '''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.)
* '''Disk Mode''' (Select between diskless (disk="none"), "data" or "sys", as described above.)
{{Warning|The data on a chosen device will be overwritten!}}

=== Preparing for the first boot ===

If <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> 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 <code><nowiki>lsblk</nowiki></code> (after installing it with <code>apk add lsblk</code>) and/or <code>blkid</code>, similar to previously identifying the initial installation media device.

The procedure to copy the boot system is explained at <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code>

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

=== Rebooting and testing the new system ===

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 <code>poweroff</code> or <code>reboot</code>.

=== Completing the installation ===

The installation script installs only the base operating system. '''No''' applications e.g. web server, mail server, desktop environment, or web browser are installed, and <code>root</code> is the only user.

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

= Further Installation Instructions =

{{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.}}

=== Installation ===

* [[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)''
* [[Dualbooting|Dual/multi-boot install to HDD partition]]
* [[Netboot Alpine Linux using iPXE]]
Also see other [[:Category:Installation|Installation Category]] pages.

=== Post-Installation ===



* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[Alpine_Package_Keeper|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Alpine_Package_Keeper#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Managing_repositories|Enable the community repository]] ''(access to additional packages)''
* [[Alpine_Linux:FAQ#Why_don.27t_I_have_man_pages_or_where_is_the_.27man.27_command.3F|man command/man pages]]
* [[Change default shell]]
* [[Running glibc programs]] ''(installation and development)''
 

* [[Alpine_local_backup|Local backup utility <code>lbu</code>]] ''(persisting RAM system configurations)''
** [[Back Up a Flash Memory Installation]] ''("diskless mode" systems)''
** [[Manually_editing_a_existing_apkovl]] ''(the stored custom configs)''
 

* [[OpenRC|Init System (OpenRC)]] ''(configure a service to automatically boot at next reboot)''
** [[Writing Init Scripts]]
** [[Multiple Instances of Services]]
 

* [[Alpine setup scripts#setup-xorg-base|<code>setup-xorg-base</code>]] ''(setup graphical base environment)''
** [[Tutorials_and_Howtos#Desktop|Desktop Environments]]
 

* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''
 

* [[How to get regular stuff working]] ''(things one may miss in a too lightweight installation )''
* Running applications and services in their own [[Firejail Security Sandbox]]

=== Broader Usage Guides ===

* See: [[Tutorials and Howtos]]

= General Documentation =

{{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], are to a large degree, also applicable to configuring the software on Alpine Linux, thus can be very useful.}}

* [[Alpine_Linux:FAQ|FAQs]]
* [[Alpine_Linux:Contribute|How to Contribute]]
* [[:Category_talk:Developer_Documentation|Developer Documentation]]
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
* [[Comparison with other distros]] ''(how common things are done on Alpine)''

----
[[Category:Installation]]