Alpine Linux - User contributions [en]

Diskless Mode

2024-11-20T06:51:49Z

Armarmgc: /* Installation */ Fix casing

In Diskless mode, the entire operating system with all applications are first loaded into RAM and then only run from there. This is also the method used to boot the Alpine Linux <Code>iso</Code> installation media. Alpine Linux can be installed and configured so that the system continue to boot like this if "disk=none" is specified while running the <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script.

The mode is extremely fast and can save on unnecessary disk spin-ups, power, and wear and suitable for servers. It is similar to what other linux distributions may call a "frugal" install or boot using a "toram" option.

You can continue using your [[Installation#Preparing_installation_media|installation media]] as a [[#Boot Device|boot device]] without installing alpine to the device's internal disk, but it is also possible to install Alpine Linux to a device's internal disk and configure it so that it boots into "diskless mode" .

== Apkovl ==
{{Seealso|Alpine local backup}}

When you boot an alpine installation into diskless mode, it will initialize a fresh new root (<Code>/</Code>) and any customisations you make (such as changing the password, adding users, etc.) will be lost when you reboot. However, any custom configurations may be preserved or "persist" across reboots by using the Alpine Linux tool named <code>[[Alpine_local_backup|Local Backup Utility]](lbu)</code>. The initial and possibly read-only installation media can remain the only boot device for the "diskless" system by saving the running state to an [[#Apkovl|<Code>.apkovl</Code>]] file, and have these automatically loaded when booting from the boot device.

An '''Apkovl''' (APK Overlay file) is a file used for storing local configuration state when running Alpine Linux in [[Diskless Mode]]. It stores all configuration files that have changed from the default ones. The filename is <Code><hostname>.apkovl.tar.gz</Code> and is stored in a location whose path is defined in {{Path|/etc/lbu/lbu.conf}}. The contents from the Apkovl file are overlaid on top of the contents of the apks that are loaded on boot.

The backup tool <code>[[Alpine_local_backup|lbu]]</code> enables committing and reverting local configuration system state by using '''.apkovl''' files that are saved to a backup location and loaded when booting. In Diskless mode, for every change made to the running system to persist across reboot, the command <code>[[Alpine_local_backup|lbu commit]]</code> must be issued before rebooting the system to update the .apkovl file.

== Local Package Cache ==

When Alpine Linux boots in Diskless Mode, the remote repositories will not be available until after networking has started. That means extra packages newer not in your local boot media would not be available after a reboot, unless they were made to persistent [[Alpine_Package_Keeper#Local_Cache|local package cache]] available on a local, writable, storage device. The local package cache can be stored on the same partition as the .apkovl file.

== Installation ==
{{Seealso|Create a Bootable Device}}

Alpine Linux setup script <code>setup-alpine</code> uses <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> script to save the config and package cache to any available writable filesystem on any media other than the read-only [[Installation#Preparing_installation_media|installation media]].

Due to Bug: [https://gitlab.alpinelinux.org/alpine/alpine-conf/-/issues/10473 #10473] storing local configs and package cache on '''internal disks''' requires manual steps, i.e making an entry in {{Path|/etc/fstab}}, create mountpoint, and mount the partition before running <code>setup-alpine</code> script.

# In this case, boot the target diskless system from the [[Installation#Preparing_installation_media|installation media]] and do not proceed after the [[Installation#Boot_Process|boot process]] stage.
# If necessary partition(s) are unavailable, manually [[Setting_up_disks_manually#Creating_partitions|create]] a partition using <Code>fdisk</Code>. In the below steps, we will use /dev/sdXY as partition number. Adjust the partition identifier as per the output of {{Codeline|<Code>blkid</Code>}} 
#* Due to Bug: {{Issue|11589|The APKOVL loading of diskless setups doesn't work on btrfs and xfs filesystems, or nvme-based devices}}. So use only ext4 filesystem partitions on classic drives to store diskless mode states.
#* mkfs.ext4 creates ext4 filesystem with 64bit feature enabled by default, but extlinux may not be able to boot with that due to Issue {{Issue|14895}}. You may need to add "-O ^64bit" to mkfs.ext4 to circumvent this. The below command creates an ext4 partition with disabled journaling, to reduce write operations and allow the disk to spin down after the .apkovl and the packages have been read from the partition during the boot. Install package {{pkg|<Code>e2fsprogs</code>}} using command {{Codeline|<Code>apk add e2fsprogs</Code>}}, if the command <Code>mkfs.ext4</Code> is not available.
#: {{Cmd|mkfs.ext4 -O ^has_journal,^64bit /dev/sdXY}}
# Due to a [https://gitlab.alpinelinux.org/alpine/mkinitfs/-/issues/5 bug], the partition can not be mounted to /boot. Configure the /etc/fstab to mount the writable partition to /media/sdXY instead of /boot i.e. conforming to the hot/cold-plug mountpoints.
#: {{Cmd|mkdir /media/sdXY}}
#: {{cmd|echo "/dev/sdXY /media/sdXY ext4 noatime,ro 0 0" >> /etc/fstab}}

# Mount the partitions listed in {{Path|/etc/fstab}}.
#: {{Cmd|<code>mount -a</code>}} Look at the output of {{Codeline|<code>mount</code>}} to verify that the changes have been applied correctly. 
# If <code>setup-alpine</code> has not run before, follow the [[Installation#Installation_Step_Details|Installation steps]] to complete the [[Installation#Base_configuration|base configuration]]. The above changes should now enable you to choose the partition for saving the local configs and package cache. If asked, there is no need to first unmount the partition, that would only be needed to allow installing on its parent disk.
# If <code>setup-alpine</code> has already been used to configure the diskless system, the storage settings may be modified directly with
#: {{cmd|setup-lbu sdXY}}
# [[Alpine_Package_Keeper#Local_Cache|Local package cache]] can be enabled as follows:
#: {{cmd|mkdir /media/sdXY/cache}}
#: {{cmd|setup-apkcache /media/sdXY/cache}}
# If the partition is large enough, it can be useful to edit {{Path|lbu.conf}} to uncomment and set {{Codeline|BACKUP_LIMIT{{=}}3}}. For example, to allow reverting to a previous, working state if needed.
#: {{cmd|apk add nano}}
#: {{cmd|nano /etc/lbu/lbu.conf }}
# Finally, generate the first .apkovl file containing all the previous changes by executing <code>lbu commit</code>, so the customizations that were just made will persist a reboot.
#: {{cmd|lbu commit}}
# From now on, whenever packages are installed or newly configured, and the changes should be kept, execute <code>lbu commit</code>.

== Boot Device ==

{{Main|Create a Bootable Device}}

The initial ISO9660 filesystem based read-only [[Installation#Preparing_installation_media|installation media]] may remain the only boot device for the newly configured Alpine Linux '''Diskless''' system.

Alpine Linux running Diskless mode can also boot from a partition with a writable filesystem on USB-Stick/CompactFlash/SDCard or SSD/NVMe harddisk. This boot device is known as [[Create_a_Bootable_Device|customizable boot device]] to differentiate against [[Installation#Preparing_installation_media|installation media]]. Local customizations like apkovl files and cached packages can be stored in this customizable boot device, which also allows to upgrade the kernel with its modules and firmware with the <code>update-kernel</Code> script.

== Loading apkovl from webserver ==

Alpine's "diskless mode" ISO boot images support boot parameters to load customizations files i.e [[Alpine_local_backup#Creating_and_saving_an_apkovl_from_a_remote_host|apkovl from a webserver]].

It's possible to load an APKOVL file from a webserver, by supplying a custom url with the <code>APKOVL</code> kernel boot parameter. If you don't have a web server you can run busybox's httpd temporarily to serve an .apkovl - <code>busybox httpd -p 127.0.0.1:80</code>.

== Upgrading a Diskless System ==

When Alping Linux runs in "diskless" or "data" disk mode, Upgrading requires few extra steps in addition to the regular [[Alpine_Package_Keeper#Upgrade_a_Running_System|upgrade steps]].

If booting a "diskless" system from a read-only device, or as an iso image on writable media, it's not possible to update the boot files (kernel, modules, firmware, ...) that reside on that device.

For [[Create_a_Bootable_Device|customizable boot device]], It is possible to update the boot files. However, even then, the kernel, with its modules and firmware files, can still not be updated directly through regular packages updates. Instead, there is the <code>update-kernel</code> script that can generate initfs images and install them together with upgraded kernels.

Upgrading can be done as follows.
{{cmd|apk add mkinitfs
}}
This package is required for the generation of the initial filesystem used during boot.
* Additional initfs features that are missing in the default configuration, like the [[Btrfs|btrfs]] filesystem support (at the time of writing, to allow loading .apkovl configs and package cache during boot), may be enabled in <code>/etc/mkinitfs/mkinitfs.conf</code>.
* Available initfs features may be listed with <code>ls /etc/mkinitfs/features.d</code>
{{cmd|ls /etc/mkinitfs/features.d
apk add nano
nano /etc/mkinitfs/mkinitfs.conf
lbu commit
}}
Finally update the kernel and its boot environment.
{{cmd|update-kernel /media/sdXY/boot/
}}
* An <code>update-kernel</code> run needs at least 8 GB free ram memory to avoid a broken modloop-image.
* See <code>update-kernel --help</code> for options to manually add additional module or firmware packages.

== Kernel Options ==

Documentation about kernel command line options regarding diskless mode will be available after installing the documentation sub-package {{Pkg|mkinitfs-doc}}:

{{Cmd|man mkinitfs-bootparam}} <Pre>
If no root= parameter is given, the initramfs will build a live system
in memory from scratch. This is also called diskless mode.

When booting in diskless mode, the following options are also
available:

alpine_repo=(URL | PATH)
If set, /etc/apk/repositories will be filled with this. May be a
comma-separated list of URLs.

apkovl=(URL | [DEVICE[:FS_TYPE]:]PATH)
A HTTP, HTTPS or FTP URL to an apkovl.tar.gz file which will be
retrieved and applied. Can also be a filesystem path, optionally
prepended with the device name without the /dev/ prefix.

autodetect_serial=no
Disable automatic detection and setup of serial console.

ds=OPTIONS
Data source for tiny-cloud. If OPTIONS starts with nocloud,
tiny-cloud will be enabled.

nokeep_apk_new
Setup a fresh system, ignore any apkovl.

pkgs=PACKAGE{,PACKAGE}
Comma-separated list of packages to be installed.
ssh_key=(URL | SSH_KEY)
This setting installs openssh and places the public key given as
value in /root/.ssh/authorized_keys. If the value is an HTTP or
FTP url, its fetches the key(s) from there.

splash Enable splash screen.

usbdelay=NUMBER
Wait NUMBER seconds for USB devices to show up before searching
for boot media.

wireguard=INTERFACE;IP_ADDRESS{,IP_ADDRESS,...}[;WG_CONFIG_FILE]
Set up a wireguard interface named INTERFACE with the addresses
IP_ADDRESS and use /etc/wireguard/initrd.conf or WG_CONFIG_FILE
as a classic wg (not wg-quick) config.

zfs_force=NUMBER
Enable force importing the root zpool on boot, even if it was
previously mounted from a different system/OS.
</Pre>
== See Also ==
* [[Alpine_local_backup|Alpine Local backup Utility - ''lbu''']]
* [[Alpine_Package_Keeper#Local_Cache|Local package cache]]
* [[Manually editing a existing apkovl]]
* [[Back Up a Flash Memory Installation]]
* [[Upgrading_Alpine#Upgrading_Alpine_Linux_on_other_removable_media_(such_as_CF/USB)|Upgrading Diskless to New Alpine Linux Release]]
* [[PXE boot#Specifying an apkovl|Diskless PXE Boot]]
* [[How to make a custom ISO image with mkimage]]
* [[QEMU#Live_mode|QEMU Diskless example]]
* [[Alpine local backup#Include special files.2Ffolders to the apkovl|Include special files section]] - To include custom files outside of <code>/etc</code> in .apkovl file.

[[Category:Diskless]]

Busybox

2024-11-20T06:45:59Z

Armarmgc: add redirect to BusyBox

#REDIRECT [[BusyBox]]

Joysticks

2024-11-20T06:39:39Z

Armarmgc: fix double redirect

#REDIRECT [[Gamepad]]

Development using git with write access

2024-11-20T06:37:30Z

Armarmgc: Fix double redirect

#REDIRECT [[Git]]

Setup-xorg-base

2024-11-20T06:30:38Z

Armarmgc: add redirect

#REDIRECT [[Alpine setup scripts]]

Setup-lbu

2024-11-20T06:05:49Z

Armarmgc: Undo revision 27847 by Armarmgc (talk)

#REDIRECT [[Alpine setup scripts]]

Setup-lbu

2024-11-20T06:04:50Z

Armarmgc: make redirect link to appropriate section in the page.

#REDIRECT [[Alpine setup scripts#setup-lbu]]

Screen terminal multiplexer

2024-11-09T05:18:51Z

Armarmgc: /* Where to find more examples */ fixed list formatting

{{pkg|screen}} is a terminal multiplexer. It's a good tool for e.g. remote support. It can also be used to start a command you want to keep running after you close your console session (you can later on attach to your running session). When you enter a {{pkg|screen}} session you will not notice too much. 
To know if you are inside a {{pkg|screen}} session, use the notes in '[[#Get_help|get help]]' section mentioned below.

= Install =
In order to use {{pkg|screen}} you will have to install it:
{{cmd|apk add screen}}

= Usage =

== Start a new session ==
To enter a {{pkg|screen}} session you just enter:
{{cmd|screen}}

== List existing sessions ==
When you have started some session(s) you can list them:
{{cmd|screen -list}}
You might get a list that looks like this:
<pre>
There are screens on:
11151.pts-1.mhlab01 (Attached)
11131.pts-3.mhlab01 (Attached)
2 Sockets in /var/run/screen/S-root.
</pre>

== Attach to a existing session ==
Lets say you want to attach to a existing session (e.g. the above <code>11131.pts-3.mhlab01</code> session).
{{cmd|screen -x 11131}}
or
{{cmd|screen -x pts-3}}
{{tip|If you see <code>Attaching from inside of screen?</code>, you are already inside a screen session.}}

== Controlling a screen session ==
While inside a {{pkg|screen}} session, you can control it using keyboard shortcuts. We will only describe some of those alternatives.

{{tip|To enter a keyboard shortcut that controls the current {{pkg|screen}} session, you should click {{key|A}} while holding down {{key|CTRL}} In the below examples this procedure is described as <code>^A</code>}}
=== Get help ===
One of the most useful commands is the one that gives you 'help'. 
While in your {{pkg|screen}} session, click:
{{cmd|^A ?}}
''(Do not press/hold {{key|CTRL}} when clicking {{key|?}})''

=== Detach from a session ===
Sometimes it's useful to just detach from a session without killing it. 
{{cmd|^A d}}
{{tip|Try starting <code>ping 127.0.0.1</code> while inside a screen session and then detach from the session. After some while re-connect to the session using <code>screen -x</code>. Note that the "seq" value indicates that ping had continued running while you where detached from the session.}}

=== Close or kill a session ===
To 'kill' a session:
{{cmd|^A k}}
Confirm by clicking {{key|y}} when prompted.

You can also 'kill' your session by entering:
{{cmd|exit}}

= Extra =
== Connect to serial console ==
{{pkg|screen}} is a good tool when you need to connect to a serial console ''(e.g. if you want to configure a switch using it's serial port)''. Connecting to a serial console could look like this:
{{cmd|screen /dev/ttyS0 9600}}

== Force console users into a screen session ==
In some cases you might want to force only console users into a screen session. 
Note that the this configuration will not force SSH-users into a screen. 
Edit {{path|/etc/profile}} and add the following code to it:
<pre>
if [ -n "$PS1" ] && [ -z "$STARTED_SCREEN" ] && [ -z "$SSH_TTY" ]; then
STARTED_SCREEN=1 ; export STARTED_SCREEN
screen -RR && exit 0
echo "Screen failed! continuing with normal startup"
fi
</pre>

== Force console and SSH users into a screen session ==
The above example holds the if-statement:
&& [ -z "$SSH_TTY" ]
Remove this part from above configuration to force SSH sessions into a screen session. 
{{Note|Console users will also be forced into a screen session when folowing these instructions}}

= Other terminal multiplexers =
A similar tool is {{pkg|tmux}} which is documented [[tmux|here]].

= Configuring .screenrc (example) =
<pre>
#hardstatus off
hardstatus alwayslastline '%{= kG}[ %{y}%H%? %1`%?%{g} ][%= %{= kw}%-w%{+b yk} %n*%t%?(%u)%? %{-}%+w %=%{g}][ %{y}%l %{g}][%{W}%c:%s %{g}]'
msgwait 1
vbell off

# Huge scrollback buffer
defscrollback 5000

# No welcome message
startup_message off

# Clear the screen after closing some programs
altscreen on

# Get rid of the vertical bars
rendition so =00
caption string "%{03} "

# 256 colors
term screen-256color
terminfo rxvt-unicode 'Co#256:AB=\E[48;5;%dm:AF=\E[38;5;%dm'
termcapinfo xterm* ti@:te@
attrcolor b ".I"

# UTF-8
#defutf8 on
#utf8 on

# Default Windows

# Switch windows with F3 (prev) and F4 (next)
bindkey "^[OR" prev
bindkey "^[OS" next

# Get rid of silly xoff stuff
bind s split
bind c screen 1
bind ^c screen 1
bind 0 select 10
screen 1

# remove some stupid / dangerous key bindings
bind k
bind ^k
bind .
bind ^\
bind \\
bind ^h
bind h hardcopy
bind 'K' kill
bind '}' history

bind L screen -t dmesg 10 watch "dmesg | tail -n $((LINES-42))"
bind T screen -t htop 11 htop
bind A screen -t atop 12 atop
bind N screen -t nethogs 15 nethogs
bind V screen -t vnstat 16 vnstat
bind S screen -t ss 17 ss -s
</pre>

== Where to find more examples ==
* Archlinux forums (https://bbs.archlinux.org/viewtopic.php?id=55618)
* GithubGist (https://gist.github.com/search?utf8=%E2%9C%93&q=screenrc)
* Github (https://github.com/search?utf8=%E2%9C%93&q=screenrc)

[[Category:Shell]]

Installation

2024-11-02T23:16:48Z

Armarmgc: Fix formatting

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

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

{{Tip|This is a wiki!
If something isn't correct, or is incomplete, you will have to figure it out, or ask for the correct solution in the [https://alpinelinux.org/community/ community].

And then carefully edit the wiki page.

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

== Minimal Hardware Requirements ==
{{Main|Requirements}}
* At least 128 MB of RAM. [A graphical desktop system may require up to 512 minimum.]. Note that an installation itself (from ISO) generally requires at least 320 MB during installation.
* At least 0-700 MB space on a writable storage device. [Only required in [[#System Disk Mode|"sys"]] or [[#Data Disk Mode|"data"]] mode installations. It is optional in [[#Diskless Mode|"diskless"]] mode, where it may be used to save newer data and configurations states of a running system.]
* A working internet connection is required to complete [[#System Disk Mode|"sys"]] mode installation.

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

== Installation Overview ==

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

====Diskless Mode====
In Diskless mode the entire operating system with all applications are first loaded into RAM and then only run from there. Alpine Linux uses this method to boot the .iso installation images. The <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script configures 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. For further info, refer [[Setting_up_disks_manually#Diskless_Mode| Diskless Mode]].

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

====System Disk Mode====

System or '''sys''' Disk Mode is the traditional hard-disk install. <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> script based [[#setup-alpine based System Disk Install|install]] supports only [[Setting_up_disks_manually#Default_Layout|default layout]]. For further info, refer [[Setting_up_disks_manually#System_Disk_Mode|System Disk Mode]].

=== General course of action ===

{{Note| It is really helpful for many use cases to [[#Preparing_for_the_installation|prepare]] and complete the [[#Installation_Step_Details|Installation]] until the [[#Base_configuration|base configuration]] step, then proceed with installation of the target system with any one of the various [[#Alternate courses of action|alternate]] courses of action.}}

=== Alternate courses of action ===

Examples of preparation options:
* Download and install some specific driver or software tool.
* Do a [[Setting_up_disks_manually#Manual_partitioning|Manual partitioning]] of the harddisk that avoids overwrite of an entire disk.
* Installing something that may be missing in the live system to configure the hardware, e.g. by using the alpine package manager <code>[[Alpine_Package_Keeper|apk]]</code>.
* Use more specific [[Alpine_setup_scripts|setup-scripts]] in order to proceed with the final installation in a custom way.

Examples of proceeding options:

* To install Alpine Linux on an '''entire hard disk''' with [[Setting_up_disks_manually#Default_Layout|default layout]] proceed with [[#setup-alpine_based_System_Disk_Install|setup-alpine based System Disk Install]]
* Use <code>[[Alpine_setup_scripts#setup-lbu|setup-lbu]]</code> to configure a "local backup" location for the [[#Diskless Mode|diskless]] system, and <code>[[Alpine_local_backup|lbu commit]]</code> to then save the local configuration state.
* Use <code>[[Alpine_setup_scripts#setup-apkcache|setup-apkcache]]</code> to configure a local package cache storage location.
* Use <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to add a [[#Data Disk Mode|"data"]] mode partition
* Use <code>[[Alpine_setup_scripts#setup-disk|setup-disk]]</code> to complete a [[Setting_up_disks_manually#Custom_Layout|traditional hard-disk installation]] or to [[Dualbooting|Dualboot]] or to configure [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]] or [[Setting_up_disks_manually#LVM|LVM]] for both [[#Data Disk Mode|"data"]] disk and [[#System_Disk_Mode|"system"]] disk mode or to use [[Setting_up_disks_manually#Environment_variables|environment variables]].
* Use <code>[[Alpine_setup_scripts#setup-bootable|setup-bootable]]</code> to create a [[Create_a_Bootable_Device#Using_setup-bootable|customizable boot media]] for '''[[Installation#Diskless_Mode|diskless]]''' or '''[[Installation#Data_Disk_Mode|data]]''' disk-mode i.e a boot device with a writable filesystem.

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.

== Preparing for the installation ==


=== Downloading installation image ===

Download the [https://alpinelinux.org/downloads/ stable-release installation image-file] for the target computer's architecture with their corresponding <code>sha256</code> (checksum) and <code>GPG</code> (signature) files.

{{Note|Download <code>sha256</code> (checksum) and <code>GPG</code> (signature) files only from [https://alpinelinux.org/downloads/ official] site and not from mirrors.}}

Now you have three files of the following format..

<pre>
alpine-standard-*.iso
alpine-standard-*.iso.sha256
alpine-standard-*.iso.asc
</pre>
''alpine-standard-3.20.3-x86_64.iso'' is the '''3.20.3''' version '''Standard''' image file in '''iso''' format for '''x86_64''' architecture. Image file can also be '''gz''' for certain cases.

=== Verifying downloaded image ===

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

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

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

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

Step 1. Download and import the gpg signature from official website
{{Cmd|curl https://alpinelinux.org/keys/ncopa.asc | gpg --import ;}}

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

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

{{Note|These instructions are exclusively for x86_64 and x86. For ARM boards, see [[Alpine on ARM#Preparing installation media|Alpine on ARM]].}}

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

In Linux, <code>dd</code> command can write the downloaded image file to the installation media i.e target device. To identify the target device, all connected "bulk storage devices" can be listed with <code><nowiki>lsblk</nowiki></code> and <code><nowiki>blkid</nowiki></code>.
<pre>
# 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"
</pre>

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

{{Note| In <code>dd</code> command, do not specify partition number for target device i.e use '''/dev/sdX''' and not '''/dev/sdX1'''}}

The syntax for <code>dd</code> command is as follows:
{{Cmd|# dd if{{=}}<iso-image-file> of{{=}}<target-device> bs{{=}}4M status{{=}}progress; eject <target-device>}}

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

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

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

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

In Windows, [https://rufus.ie/ Rufus] has been tested to create bootable USB flash drives and worked 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 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:
<pre>
# cmp ~/Downloads/alpine-standard-3.20.3-x86_64.iso /dev/sdX
cmp: EOF on alpine-standard-3.20.3-x86_64.iso
</pre>

=== Booting Installation Media ===

Insert the [[#Preparing_installation_media|Installation media]] to a proper drive or port of the computer and turn the machine on, or restart it, if already running.
{{Note| To successfully boot and install Alpine Linux, disable [[Alpine_and_UEFI#How_to_boot_unsigned_code?|secure boot]] in the BIOS. Once Alpine Linux is installed, this can be [[UEFI_Secure_Boot|enabled]].}}
If the computer does not automatically boot from the desired device, one needs to bring up the boot menu and choose the media to boot from. Depending on the computer, the menu may be accessed by repeatedly pressing a key quickly when booting starts. Some computers require that you press the button ''before'' starting the computer and hold it down while the computer boots. Typical keys are: {{key|F9}}-{{key|F12}}, sometimes {{key|F7}} or {{key|F8}}. If these don't bring up the boot menu, it may be necessary to enter the BIOS configuration and adjust the boot settings, for which typical keys are: {{key|Del}} {{key|F1}} {{key|F2}} {{key|F6}} or {{key|Esc}}.

== Installation Step Details ==

=== Boot Process ===

The boot process of the alpine installation image first copies the entire operating system into the RAM memory, and then 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>setup-alpine</code> is available to configure and install the initial Alpine Linux system. Using [[Setting_up_disks_manually#Environment_variables|environment variables]] at this stage is optional. Launch the Alpine Linux Installation by running the <code>setup-alpine</code> script :

{{Cmd|# setup-alpine}}

=== Base configuration ===
The question-and-answer dialog of <code>setup-alpine</code> takes care of the base configuration.

It allows to configure the system to boot into one of three different '''Alpine Linux "disk" modes''': [[Installation#Diskless_Mode|'''"diskless"'''(none)]], [[Installation#Data_Disk_Mode|'''"data"''']] or [[Installation#System_Disk_Mode|'''"sys"''']].

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

Base configuration is complete with the above step. Refer to the [[#Alternate courses of action|alternate courses of action]] to proceed further.

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

If you have ''' entire hard disk(s)''' for Alpine Linux and [[Setting_up_disks_manually#Default_Layout|default layout]] is acceptable to you, at the final step of [[#Base configuration|base configuration]] do not choose '''none''' for the prompts in the '''Disk Mode'''.

* At the '''Disk Mode''' stage, '''sda''' or relevant disk(s) must be chosen in the below screen:
* Which disk(s) would you like to use? (or '?' for help or 'none') '''sda'''
* Confirmation for the chosen disk(s) appears. ''The following disk is selected:'' '''sda (128.0 GB JMicron Tech ).'''
* For automatic RAID configuration, you can select multiple disks as explained in [[Setting_up_disks_manually#Default_Layout|default layout]] section.
* Pay close attention and verify that the disk(s) matches your requirement. Answering '''none''' in the next step or pressing '''Ctrl+c''' will exit/abort the installation process.
 
{{Warning| If you enter '''sys''' in the next step, data on the chosen disk(s) will be overwritten! No further questions will be asked. Proceed only if you are 100% sure.}}
* How would you like to use it? ('sys', 'data', 'lvm' or '?' for help) '''sys'''

If '''sys''' is chosen, the <code>setup-alpine</code> script will complete the traditional hard-disk installation of Alpine Linux on the chosen disk as per [[Setting_up_disks_manually#Default_Layout|default layout]]. Once the installation is complete, you can skip the next steps and proceed to [[#Reboot|reboot]] the system to [[#Completing_the_installation|complete the installation]].

=== Custom partitioning ===

Refer [[Setting up disks manually|Setting up disks manually]] page for specific configurations related to [[Setting_up_disks_manually#RAID|RAID]], [[Setting_up_disks_manually#Encryption|encryption]], [[Setting_up_disks_manually#LVM|LVM]], etc. as well as to [[Setting_up_disks_manually#Manual_partitioning|manually partition]] the harddisk for "sys" mode install using [[Setting_up_disks_manually#Custom_Layout|custom layout]].

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.

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

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

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

The procedure to copy the boot system is explained at [[Alpine_setup_scripts#setup-bootable|setup-bootable]].

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

=== Reboot ===

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

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

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

=== Completing the installation ===

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

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

== Custom Installation Instructions ==


Custom-made headless apkovl can be done by first booting the install media on some computer with a display and keyboard attached, or in a virtual machine, and doing an intermediate "diskless" setup of just the boot media (more details below), i.e. using the offical <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).



* [https://github.com/macmpi/alpine-linux-headless-bootstrap/ Bootstrap Alpine Linux on a headless system] using pre-built <code>apkovl</code> overlay file.
* [[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)''
* [[Netboot Alpine Linux using iPXE]]
* [[:Category:Virtualization|Virtualization]]

Also see other [[:Category:Installation|Installation Category]] pages.

== Post-Installation ==

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


=== Daily driver guide ===

{{:Daily driver guide}}

=== Other topics ===

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


* [[Upgrading Alpine|Upgrade your OS]], when a new version is [https://www.alpinelinux.org/releases/ released].
* [[Change default shell]]
* [[Tutorials_and_Howtos#Networking_2|Setting up Networking]] ''(including non-standard configurations)''
* [[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]]
* [[Hosting services on Alpine]] ''(links to several mail/web/ssh server setup pages)''

== See also ==

* [[Tutorials and Howtos]]
* [[Alpine_Linux:FAQ|FAQs]]
* [[Comparison with other distros]] ''(how common things are done on Alpine)''
* [[Alpine_Linux:Wiki_etiquette|Wiki etiquette]] ''(to collaborate on this documentation)''
----
[[Category:Installation]]