Alpine Linux - User contributions [en]

Installation

2022-07-10T05:32:10Z

Danielfdickinson: Add link to netbooting guide for install via iPXE

[[Image:hdd_mount.png|left|link=]]
<br />

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)]].

{{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, the regular installation procedure starts with three basic steps (additional details for all the steps follow [[Installation#additional details|below]]):<br>

# Downloading and verifying the proper [http://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, ...).
# Booting the computer from the prepared disk or storage device.

The boot process of the 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.

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</br>
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_Linux_package_management|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-Install|Post-Install]] 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 used to boot for the .iso installation images. It's 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 and boot into with a "toram" option. However, <code>[[Alpine_setup_scripts#setup-alpine|setup-alpine]]</code> can also configure the installed system to boot like this if "disk=none" is specified.

Custom configurations and package selections 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_Linux_package_management#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>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. For example, after running <code>setup-alpine</code> and before rebooting:

# Set LBU_MEDIA=sdXY in /etc/lbu/lbu.conf
# Execute a corresponding <code>echo "/dev/sdXY /media/sdXY <fstype> rw 0 0" >> /etc/fstab</code>
# Save the configuration for the next boot with <code>lbu commit</code>.

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>[[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 [[Desktops|desktop]] and development machines.

For custom partitioning, see [[Setting_up_disks_manually]].

To install along side another operating systems, see [[Installing_Alpine_on_HDD_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>setup-alpine</code> session]]

The <code>[[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>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 fron 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 "Post-Install" below, for some common things to do after installation.

= Further Installation Instructions =

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

=== Post-Installation ===



{{Note|A [[Post installation|Post Installation]] wiki page has been created, however, its information is better to be kept at their individually manageable topic pages and only directly referenced (linked) from the list in the [[Installation]] overview page in the future. If you would like to help with this process please go ahead.}}

* [[Setting up a new user]] ''(to allow remote, console, or graphical logins)''
* [[Tutorials_and_Howtos#Networking|Setting up Networking]] ''(including non-standard configurations)''
* [[Package_management|Package Management (apk)]] ''(how to search/add/del packages etc.)''
** [[Package_management#Upgrade_a_Running_System|Upgrading Alpine]] ''(checking for and installing updates)''
** [[Repositories#Enabling_the_community_repository|Enabling the community repository]] ''(access to additional packages)''
* [[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)''
<br>

* [[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)''
<br>

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

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

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

* [[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]]

<br>
Also see other [[:Category:Installation|Installation Category]] pages.

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

* [[FAQ|FAQs]]

* [[Contribute|How to Contribute]]
* [[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]]

Netboot Alpine Linux using iPXE

2022-07-10T05:28:14Z

Danielfdickinson: Fix typo in ipxeboot network name

<h2>Copy the files needed by iPXE to a web server</h2>
<ul>
<li><p>For this guide we will provide the files at http://ipxe-boot.example.com/ from the directory <code>/var/www/ixpe-boot.example.com/</code> on the web server, which is writable by your non-root admin user. We also assume the web server follows symlinks within <code>/var/www/ipxe-boot.example.com</code> (but not outside that directory tree).</p>
</li>
<li><p>Copy the netboot tarball (for example the [https://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-netboot-3.16.0-x86_64.tar.gz 3.16.0 stable release of Alpine's netboot image for x86_64]) to your non-root admin user on your web server.</p>
</li>
<li><p>Extract the netboot tarball to your webserver directory. For example:</p>

<pre>tar -C /var/www/ipxe-boot.example.com -xzf alpine-netboot-3.16.0-x86_64.tar.gz</pre>

</li>
<li><p>This will create a directory structure such as:</p>

<pre>boot/
boot/initramfs-lts
boot/config-virt
boot/dtbs-virt/
boot/System.map-lts
boot/vmlinuz-virt
boot/System.map-virt
boot/config-lts
boot/initramfs-virt
boot/modloop-lts
boot/modloop-virt
boot/dtbs-lts/
boot/vmlinuz-lts</pre>

</li>
</ul>
<h2 class="atx" id="create-an-ipxe-boot-script">Create an iPXE boot script</h2>
<p>For example, create a script called <code>boot.ipxe</code> with contents:</p>

<pre>#!ipxe

set base-url http://ipxe-boot.example.com

kernel ${base-url}/boot/vmlinuz-virt console=tty0 modules=loop,squashfs quiet nomodeset alpine_repo=https://dl-cdn.alpinelinux.org/alpine/v3.16/main modloop=http://ipxe-boot.example.com/boot/modloop-virt
initrd ${base-url}/boot/initramfs-virt
boot</pre>

<h2 class="atx" id="boot-using-the-ipxe-boot-script">Boot using the iPXE boot script</h2>
<h3 class="atx" id="using-qemu-for-testing">Using QEMU (for testing)</h3>
<p>Assuming you have the binary <code>qemu-system-x86_64</code> on your system:</p>

<pre>qemu-system-x86_64 -boot n -m 512M -enable-kvm -device virtio-net,netdev=n1 -netdev user,id=n1,tftp=$(pwd),bootfile=/boot.ipxe</pre>

<h3 class="atx" id="using-libvirt">Using Libvirt</h3>
<ul>
<li><p>Copy the <code>boot.ipxe</code> script to your webserver at <code>/var/www/ipxe-boot.example.com/boot.ipxe</code> (substituting for your actual directory, of course).</p>
</li>
<li><p>Create a new NAT network with XML such:</p>
<pre><network>
<name>ipxeboot</name>
<forward mode="nat">
<nat>
<port start="1024" end="65535"/>
</nat>
</forward>
<bridge name="virbr1" stp="on" delay="0"/>
<mac address="52:54:00:a4:10:b3"/>
<domain name="ipxeboot"/>
<ip address="192.168.129.1" netmask="255.255.255.0">
<dhcp>
<range start="192.168.129.128" end="192.168.129.254"/>
<bootp file="http://ipxe-boot.example.com/boot.ipxe"/>
</dhcp>
</ip>
</network></pre>

</li>
<li><p>Use <code>virt-install</code> such as:</p>

<pre>virt-install -n vm-name --memory 512 --vcpus 1 --pxe --disk size=5,bus=virtio --network network=ipxeboot,model=virtio --input tablet --video virtio --os-variant id=http://alpinelinux.org/alpinelinux/3.13</pre>

</li>
</ul>
<h3 class="atx" id="on-vultrcom">On Vultr.com</h3>
<p><em>NOTE</em>: Other cloud providers have similar features, but I haven't used them.</p>
<p>[https://www.vultr.com/docs/ipxe-boot-feature/ iPXE Boot Feature - Vultr.com]</p>
<h2 class="atx" id="see-also">See Also</h2>
<p>[https://boot.alpinelinux.org/ Alpine linux netboot server]</p>

Netboot Alpine Linux using iPXE

2022-07-10T05:26:38Z

Danielfdickinson: Add topic "Netboot Alpine Linux using iPXE"

<h2>Copy the files needed by iPXE to a web server</h2>
<ul>
<li><p>For this guide we will provide the files at http://ipxe-boot.example.com/ from the directory <code>/var/www/ixpe-boot.example.com/</code> on the web server, which is writable by your non-root admin user. We also assume the web server follows symlinks within <code>/var/www/ipxe-boot.example.com</code> (but not outside that directory tree).</p>
</li>
<li><p>Copy the netboot tarball (for example the [https://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-netboot-3.16.0-x86_64.tar.gz 3.16.0 stable release of Alpine's netboot image for x86_64]) to your non-root admin user on your web server.</p>
</li>
<li><p>Extract the netboot tarball to your webserver directory. For example:</p>

<pre>tar -C /var/www/ipxe-boot.example.com -xzf alpine-netboot-3.16.0-x86_64.tar.gz</pre>

</li>
<li><p>This will create a directory structure such as:</p>

<pre>boot/
boot/initramfs-lts
boot/config-virt
boot/dtbs-virt/
boot/System.map-lts
boot/vmlinuz-virt
boot/System.map-virt
boot/config-lts
boot/initramfs-virt
boot/modloop-lts
boot/modloop-virt
boot/dtbs-lts/
boot/vmlinuz-lts</pre>

</li>
</ul>
<h2 class="atx" id="create-an-ipxe-boot-script">Create an iPXE boot script</h2>
<p>For example, create a script called <code>boot.ipxe</code> with contents:</p>

<pre>#!ipxe

set base-url http://ipxe-boot.example.com

kernel ${base-url}/boot/vmlinuz-virt console=tty0 modules=loop,squashfs quiet nomodeset alpine_repo=https://dl-cdn.alpinelinux.org/alpine/v3.16/main modloop=http://ipxe-boot.example.com/boot/modloop-virt
initrd ${base-url}/boot/initramfs-virt
boot</pre>

<h2 class="atx" id="boot-using-the-ipxe-boot-script">Boot using the iPXE boot script</h2>
<h3 class="atx" id="using-qemu-for-testing">Using QEMU (for testing)</h3>
<p>Assuming you have the binary <code>qemu-system-x86_64</code> on your system:</p>

<pre>qemu-system-x86_64 -boot n -m 512M -enable-kvm -device virtio-net,netdev=n1 -netdev user,id=n1,tftp=$(pwd),bootfile=/boot.ipxe</pre>

<h3 class="atx" id="using-libvirt">Using Libvirt</h3>
<ul>
<li><p>Copy the <code>boot.ipxe</code> script to your webserver at <code>/var/www/ipxe-boot.example.com/boot.ipxe</code> (substituting for your actual directory, of course).</p>
</li>
<li><p>Create a new NAT network with XML such:</p>
<pre><network>
<name>ipxeboot</name>
<forward mode="nat">
<nat>
<port start="1024" end="65535"/>
</nat>
</forward>
<bridge name="virbr1" stp="on" delay="0"/>
<mac address="52:54:00:a4:10:b3"/>
<domain name="ipxeboot"/>
<ip address="192.168.129.1" netmask="255.255.255.0">
<dhcp>
<range start="192.168.129.128" end="192.168.129.254"/>
<bootp file="http://ipxe-boot.example.com/boot.ipxe"/>
</dhcp>
</ip>
</network></pre>

</li>
<li><p>Use <code>virt-install</code> such as:</p>

<pre>virt-install -n vm-name --memory 512 --vcpus 1 --pxe --disk size=5,bus=virtio --network network=ipxeeboot,model=virtio --input tablet --video virtio --os-variant id=http://alpinelinux.org/alpinelinux/3.13</pre>

</li>
</ul>
<h3 class="atx" id="on-vultrcom">On Vultr.com</h3>
<p><em>NOTE</em>: Other cloud providers have similar features, but I haven't used them.</p>
<p>[https://www.vultr.com/docs/ipxe-boot-feature/ iPXE Boot Feature - Vultr.com]</p>
<h2 class="atx" id="see-also">See Also</h2>
<p>[https://boot.alpinelinux.org/ Alpine linux netboot server]</p>

Testing modified install images and packages

2022-07-10T05:05:03Z

Danielfdickinson: Add new topic "Testing modified install images and packages"

<h2>Overview</h2>
<p>Modifying packages that are part of the install diskless boot (e.g. on install media), or the parameters that can be accepted by the boot process, is a little more involved than modifying individual packages, especially for netboot images. This author discovered that then when working on [https://gitlab.alpinelinux.org/alpine/mkinitfs/-/issues/26 feat: answerfile kernel cmdline parameter (#26) · Issues · alpine / mkinitfs · GitLab] an issue he opened to request / offer to develop an improvement to unattended installation by adding the option of applying a <code>setup-alpine</code> 'answerfile' automatically via netboot, by providing a URL to a new <code>answerfile</code> kernel commandline parameter.</p>
<h2 class="atx" id="the-easy-part">The easy part</h2>
<ul>
<li>Update the list of options accepted by the installer using the kernel command line by modifying [https://gitlab.alpinelinux.org/alpine/mkinitfs mkinitfs] <code>initramfs-init.in</code> and updating the <code>man</code> page in <code>mkinitfs-bootparam.7.in</code>.</li>
<li>Install the new <code>mkinitfs</code> into one's build environment using <code>make install</code> in <code>mkinitfs</code>.</li>
<li>Build a new image using <code>scripts/mkimage.sh</code> from [https://gitlab.alpinelinux.org/alpine/aports aports] with the appropriate parameters.</li>
<li>You now have an image that will accept your new parameter.</li>
</ul>
<h2 class="atx" id="challenge-1">Challenge #1</h2>
<ul>
<li>In the case of <code>answerfile</code> an additional change needs to be make to the <code>firstboot</code> initscript, which is part of the <code>openrc</code> package.</li>
<li>That means building a new <code>openrc</code> package and getting it into the generated image.</li>
<li>To do that one has to point <code>scripts/mkimage.sh</code> at the package repository created when building the modified <code>openrc</code> package.</li>
<li>This is sufficient for images where all the packages used during boot and install are present on the install media.</li>
</ul>
<h2 class="atx" id="challenge-2-netboot">Challenge #2 (netboot)</h2>
<ul>
<li>For netboot, however, the process is more involved because the <code>openrc</code> package has to be downloaded from an external repository during the boot process.</li>
<li>This would seem easy; one might think you one could just supply put the <code>packages</code> directory created during the <code>openrc</code> build on a web server and using the <code>alpine_repo=<URI_of_repo></code>, but the problem is that <code>alpine_repo</code> only accepts a single repository.</li>
<li>In addition the package list must be signed by a key which appears in the image (that part is easy using the <code>mkimage.sh</code> parameters).</li>
<li>This means one must have include <em>all</em> the packages netboot and install will require in the new repository.</li>
<li>There is one more gotcha; One must include all the <em>dependencies</em> for the packages in the repository or the packages will fail to install.</li>
</ul>
<h3 class="atx" id="one-method-of-creating-the-necessary-signed-repository">One method of creating the necessary signed repository</h3>
<h4 class="atx" id="identify-all-the-base-packages-needed-by-netboot">Identify all the base packages needed by netboot</h4>
<ul>
<li>In the <code>mkinitfs</code> repository issue <code>grep pkgs initfamfs-init.in</code> and make note of all the packages that may be used by the initramfs.</li>
<li>In <code>aports</code>, <code>grep apks scripts/*</code>. This will identify all base packages added by the <code>mkimage.sh</code> script.</li>
<li>You also need <code>linux-lts linux-virt wireless-regdb scanelf alpine-conf alpine-base openssl</code></li>
</ul>
<h4 class="atx" id="identify-all-the-dependencies-of-the-base-packages">Identify all the dependencies of the base packages</h4>
<ul>
<li><p>Create a file with the list of base packages on a single line, separated by spaces. For example a file named <code>~/base-packages.lst</code> containing:</p>

<pre>package1 package2 package3</pre>

</li>
<li><p>Install the package <code>lua-aports</code></p>
</li>
<li><p>From a package directory in a package from <code>aports</code>, issue the following command:</p>

<pre>ap recursive-deps $(cat ~/base-packages.lst) >~/base-deps.lst</pre>

</li>
</ul>
<h4 class="atx" id="build-all-required-packages">Build all required packages</h4>
<h5 class="atx" id="create-required-list-of-package-directories-in-aports">Create required list of package directories in <code>aports</code></h5>
<ul>
<li><p>Take the list of base packages and dependencies above and create a single file with all packages on a single line, separated by spaces. For <code>~/base-deps.lst</code> above you could do:</p>

<pre>cat ~/base-deps.lst ~/base-pkgs.lst | tr $'\n' ' ' >~/oneline-deps.lst</pre>

</li>
<li><p>From a package directory in a package from <code>aports</code>, issue the following command:</p>

<pre>ap builddirs $(cat ~/oneline-deps.lst) >~/packages-to-build.lst</pre>

</li>
</ul>
<h5 class="atx" id="create-a-directory-for-the-package-repository">Create a directory for the package repository</h5>
<pre><code class="fenced-code-block language-shell">mkdir -p ~/packages/main</code></pre>
<h5 class="atx" id="add-this-directory-to-the-system-apk-repositories">Add this directory to the system APK repositories</h5>
<ul>
<li><p><strong>NOTE</strong>: This will break things if you are not running latest (edge) Alpine in your build environment</p>
</li>
<li><p>Assuming your user home dir is <code>/home/user</code>, then to the file <code>/etc/apk/repositories</code> add</p>

<pre>/home/user/packages/main</pre>

</li>
</ul>
<h5 class="atx" id="build-the-packages">Build the packages</h5>

<pre>cd ~
for pdir in $(cat ~/packages-to-build.lst); do (cd $pdir && abuild -r -m | tee -a ~/build.log); done</pre>

<h4 class="atx" id="build-a-netboot-image">Build a netboot image</h4>
<p>From the <code>aports</code> directory:</p>

<pre>./scripts/mkimage.sh --profile netboot --repository /home/user/packages/main</pre>

<h3 class="atx" id="copy-to-your-netboot-server-and-netboot">Copy to your netboot server and netboot</h3>

<p>See [[Netboot Alpine Linux using iPXE]] and adjust paths as necessary.</p>

Developer Documentation

2022-07-10T04:43:11Z

Danielfdickinson: Add a new 'misc' topic "Testing modified install images and packages"

[[Image:package_system.svg|right|link=]]

== Package management ==

* [[Alpine Linux package management|Package Management (apk)]] ''(How to add/remove packages on your Alpine)''  
** [[Comparison with other distros]]
** [[apk spec]]
* [[Repositories#Upgrading_to_edge|Upgrading to Edge]]
* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)''
** [[Back Up a Flash Memory Installation]]
** [[Manually editing a existing apkovl]]

* [[How to setup a Alpine Linux mirror]]
* [[How to use xdelta and download only differential update files]]
* [[How to make a custom ISO image]]
** [[Burning ISOs]]

== Init system ==
* [[initramfs init]]
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically launch at next reboot)''
** [[Multiple Instances of Services]]
* [[Writing Init Scripts]]

== Development ==
=== Configuring your system ===
* [[Repositories#Upgrading_to_edge|Upgrading to Edge]] 


* [[Setting up the build environment on HDD]] 

** [[Creating_an_Alpine_package#Setup_your_system_and_account|Setup your system and account for building packages]]
** [[Abuild_and_Helpers#abuild-keygen|Abuild-keygen]]

* [[Installing Alpine Linux in a chroot]] 
** [[Buildlab]] ''(Tool for creating and managing chroots)''
* [[Install Alpine on LXC]]
* Install Alpine on [[Install Alpine on VirtualBox|VirtualBox]], [[Install Alpine on VMware|VMware]], [[Install Alpine on coLinux|coLinux]], [[Qemu]],  or [[Install Alpine on Amazon EC2|Amazon EC2]]

* [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''
** [[Xen Dom0 on USB or SD]]
** [[Create Alpine Linux PV DomU]]
** [[Xen LiveCD]]

* [[Setting up a basic vserver]] 
* [[Setting up a compile vserver]] for official or for [[Setting up a compile vserver for third party packages|third party]] packages 


=== Building from source and creating packages ===

* [[Aports tree]] 
* [[Abuild and Helpers]] ''(Scripts for packaging)''



* [[Creating an Alpine package]]



** [[Package policies]]
** [[Package Maintainers]]
* [[Custom Kernel]]
* [[APKBUILD Reference]]
* [[APKBUILD examples]]
* [[Alpine package format]]
* [[Apkindex format]]

* [[Development using git]] 
** [[Development using git:Basic usage|Basic usage]]
** [[Package Maintainers]]
** [[Creating patches]]
** [[Development using git:Developer repositories|Developer repositories]]
** [[Development using git:Cgit|Cgit]]
** [[Cgit|Another cgit page]]

=== Misc ===

* [[Alpine Package Testing Suite]] ''work in progress''
* [[Alpine Release Testing Checklist]]
* [[Running glibc programs]]
* [[Alpine Source Map by boot sequence]]
* [[Testing modified install images and packages]]

== Alpine Configuration Framework ==
{{Draft|Needs to be organized/consolidated.}}

* [[Alpine Configuration Framework Design]] (Why ACF is the way it is)
* [[Writing User Documentation for ACF]]
* [[ACF mvc.lua reference|mvc.lua reference]] - mvc.lua is the core of ACF
* [[ACF mvc.lua example|mvc.lua example]] - build a simple (command-line) application
* [[ACF acf www-controller.lua reference|acf www-controller reference]] - ACF www application functions
* [[ACF acf www example|acf www-controller example]] - webify the above examples
* [[ACF how to write]] - Step by step howto for writing acfs
* [[ACF core principles]] - Things that are standard across the application
* [[LuaPosix]] - Documentation for the Lua Posix functions
* [[ACF Libraries]] - Document the libraries and common functions
* [[Writing ACF Views]] - Guide for writing a view
* [[Writing ACF Controllers]] - Guide for writing a controller
* [[Writing ACF Models]] - Guide for writing a model

* [[ACF css]]
* [[ACF packages]]
* [[APKBUILD examples:ACF]]
* [[Apk.lua]]
* [[Changing passwords for ACF]]
* [[Generating SSL certs with ACF]]
* [[Generating SSL certs with ACF 1.9]]
* [[Getting started with ACF development]]
* [[Managing ACF]]

== Alpine-developed Utilities ==
* [[Alpine Wall]] - [[How-To Alpine Wall]] - [[Alpine Wall User's Guide]] ''(a new firewall management framework)''

== Alpine Design Docs ==
* [[Architecture]]
* [[File Formats]]

[[Category:Development]]