Alpine Linux - User contributions [en]

Installing Alpine in a virtual machine

2022-03-20T17:30:56Z

Viridian: /* VMware */ Link also to ESXi

This page will walk you through how to setup a virtual machine for AlpineLinux installation

= VirtualBox =

This guide describes a standard install of Alpine within a Virtual Box VM. (virtual machine)

Oracle VM [http://virtualbox.org VirtualBox] runs one or more virtual x86 or x64 guests on a host computer. 
This enables you to install and test Alpine on your main computer almost as you would any other program.

== Preparation ==

== Install Virtual Box on host ==

First you'll need to download and install Virtual Box on your host computer. Either from the official homepage (for Windows, OS X or Solaris) or from your distribution’s repository (for Linux).

Virtual Box consists of two components:

* VirtualBox platform package
* Oracle VM VirtualBox Extension Pack

Install both and start VirtualBox to check for proper operation. If you have problems, consult the VirtualBox user manual or one of the support sites for Virtual Box.

== Download Alpine ==

Download the [https://www.alpinelinux.org/downloads/ Virtual Alpine ISO], which is optimized for virtual systems, from the Alpine Download section. Save it in a location where you can find it easily.

== Setting up virtual PC ==

Start Virtual Box. You will see a mostly empty window with a couple symbols in the upper left corner. The leftmost icon is a multi pointed star. If you hover your mouse over it, the tooltip will say “New”.

Click on the multi pointed star to create a new machine. A window will pop up, asking you some questions about the virtual (guest) computer you want to create.

# Name: Choose anything you like. e.g. “Alpine”.
# Type: Linux
# Version: Other Linux, either 64 bit or 32 bit. Choose 64 bit if you downloaded the x86_64 Alpine-ISO, or 32 bit if you downloaded the x86 Alpine-ISO.
# Use the default values for the other questions, simply click “next” or “create” until the dialogue finishes.

You will see a new entry in Virtual Box, called Alpine (or the name you chose during step 1 in the dialogue above). Click on it for more information about your guest.

One of the entries should read Mass storage, and offer an IDE controller with a primary master (the virtual hard disc) and a secondary master (the virtual optical drive).

Click on the secondary master. A context menu will pop up. Select the entry “choose image” and open the Alpine ISO you downloaded earlier.

Once that is done, click on the green start arrow on the menu bar.

== Install Alpine on the virtual computer ==

Follow the steps described in the [[Installation#Installation_Handbook|Installation Handbook]], just as if you were installing Alpine on a real PC.

{{Tip|Do not reboot your virtual box after the installation. Instead, shut down the virtual machine, remove the Alpine ISO from the virtual optical drive, then restart the virtual machine.}}

== Install drivers for Virtual Box ==

Once you successfully reboot into the Alpine VM, there are two steps left:

# Enable the [[Enable_Community_Repository|Community Respository]]
# Enable [[VirtualBox_shared_folders|VirtualBox shared folders]]

These two steps install all drivers that other programs might request, and activate several comfort functions.

{{Note|The Virtualbox webcam driver is not present in the kernel provided with the Virtual Alpine ISO. To use the webcam whilst keeping the installation footprint small, install the <code>linux-firmware-none</code> package using apk, then install the <code>linux-lts</code> package to download a kernel with the appropriate drivers without pulling in hundreds of MB of uneeded firmware files. Uninstall the <code>linux-virt</code> package and reboot to use the new kernel.}}

 

= KVM / QEMU =

 

= VMware =

See instructions for installing Alpine on [[Install_Alpine_on_VMware|VMware]] and [[Install_Alpine_on_VMware_ESXi|VMware ESXi]].

== See Also ==

* [[Installation]]
* [[Post installation]]

[[Category:Virtualization]]

Installing Alpine in a virtual machine

2022-03-20T17:30:05Z

Viridian: /* VMware */ for now, link to the VMware page to aid navigation

This page will walk you through how to setup a virtual machine for AlpineLinux installation

= VirtualBox =

This guide describes a standard install of Alpine within a Virtual Box VM. (virtual machine)

Oracle VM [http://virtualbox.org VirtualBox] runs one or more virtual x86 or x64 guests on a host computer. 
This enables you to install and test Alpine on your main computer almost as you would any other program.

== Preparation ==

== Install Virtual Box on host ==

First you'll need to download and install Virtual Box on your host computer. Either from the official homepage (for Windows, OS X or Solaris) or from your distribution’s repository (for Linux).

Virtual Box consists of two components:

* VirtualBox platform package
* Oracle VM VirtualBox Extension Pack

Install both and start VirtualBox to check for proper operation. If you have problems, consult the VirtualBox user manual or one of the support sites for Virtual Box.

== Download Alpine ==

Download the [https://www.alpinelinux.org/downloads/ Virtual Alpine ISO], which is optimized for virtual systems, from the Alpine Download section. Save it in a location where you can find it easily.

== Setting up virtual PC ==

Start Virtual Box. You will see a mostly empty window with a couple symbols in the upper left corner. The leftmost icon is a multi pointed star. If you hover your mouse over it, the tooltip will say “New”.

Click on the multi pointed star to create a new machine. A window will pop up, asking you some questions about the virtual (guest) computer you want to create.

# Name: Choose anything you like. e.g. “Alpine”.
# Type: Linux
# Version: Other Linux, either 64 bit or 32 bit. Choose 64 bit if you downloaded the x86_64 Alpine-ISO, or 32 bit if you downloaded the x86 Alpine-ISO.
# Use the default values for the other questions, simply click “next” or “create” until the dialogue finishes.

You will see a new entry in Virtual Box, called Alpine (or the name you chose during step 1 in the dialogue above). Click on it for more information about your guest.

One of the entries should read Mass storage, and offer an IDE controller with a primary master (the virtual hard disc) and a secondary master (the virtual optical drive).

Click on the secondary master. A context menu will pop up. Select the entry “choose image” and open the Alpine ISO you downloaded earlier.

Once that is done, click on the green start arrow on the menu bar.

== Install Alpine on the virtual computer ==

Follow the steps described in the [[Installation#Installation_Handbook|Installation Handbook]], just as if you were installing Alpine on a real PC.

{{Tip|Do not reboot your virtual box after the installation. Instead, shut down the virtual machine, remove the Alpine ISO from the virtual optical drive, then restart the virtual machine.}}

== Install drivers for Virtual Box ==

Once you successfully reboot into the Alpine VM, there are two steps left:

# Enable the [[Enable_Community_Repository|Community Respository]]
# Enable [[VirtualBox_shared_folders|VirtualBox shared folders]]

These two steps install all drivers that other programs might request, and activate several comfort functions.

{{Note|The Virtualbox webcam driver is not present in the kernel provided with the Virtual Alpine ISO. To use the webcam whilst keeping the installation footprint small, install the <code>linux-firmware-none</code> package using apk, then install the <code>linux-lts</code> package to download a kernel with the appropriate drivers without pulling in hundreds of MB of uneeded firmware files. Uninstall the <code>linux-virt</code> package and reboot to use the new kernel.}}

 

= KVM / QEMU =

 

= VMware =

See instructions for [[Install_Alpine_on_VMware|installing Alpine on VMware]].

== See Also ==

* [[Installation]]
* [[Post installation]]

[[Category:Virtualization]]

Install Alpine on VMware Workstation

2022-03-20T17:28:45Z

Viridian: Add settings info, fix formatting

There's at least 2 ways you can setup Alpine on a VMware box.

== Option 1: sys mode, traditional hard-disk install (preferable for a dev box) ==

# Create a virtual machine (Linux, other 3.x kernel 64 bit)
## Add a hard drive with your desired size
## Add a CD/DVD to the VM that points to the Alpine ISO you downloaded
## Disable "UEFI secure boot" in Settings -> Advanced
# Boot the VM and log in with username "root"
## run <code>setup-alpine</code>
## choose '''sys''' when asked about the disk mode ([[Installation#System_Disk_Mode|sys mode]] will install Alpine to the disk)
## choose the default hard disk mounted by VMware
## reboot after the installation is complete

== Option 2: USB mode, no data preserved between reboots ==

# Create a virtual machine (Linux, other 3.x kernel 64 bit)
## add a small hard drive, e.g. 100MB for saving configs (like an usb stick)
## Add a CD/DVD to the VM that points to the Alpine ISO you downloaded
# boot into the VM
# press F2 on boot to enter the BIOS
## change the boot order so that it boots from CD, then HD, then floppy (or whatever - as long as CD is first)
# boot the machine
# now run the following commands:
## <code>mkfs.vfat /dev/sda</code>
## <code>mount /dev/sda /media/usb</code> (Or try: <code>mount -t vfat /dev/sda /media/usb</code>)
## <code>grep /dev/sda /proc/mounts >> /etc/fstab</code>
## <code>setup-alpine</code> (select no disk, save configs to 'usb')
## <code>lbu ci usb</code>

If the VM hangs at the boot prompt, reboot the VM, and when the boot prompt appears again, type <code>pax_nouderef</code> (i.e. append it to the kernel options) and press Enter. This should allow normal boot-up. 

Now you should be able to reboot and it should retain your settings because they were saved to your "usb-disk".

== VMware Tools ==

More info on this page: [[Open-vm-tools]]

For VMware Tools support you need to install the package [https://pkgs.alpinelinux.org/package/edge/community/x86_64/open-vm-tools open-vm-tools].

[[Category:Virtualization]]

Alpine configuration management scripts

2022-03-17T08:49:32Z

Viridian: Mention setup-alpine also supports FTP URLs

Feature descriptions for available Alpine Linux setup scripts ({{Path|/sbin/setup-*}}).

These scripts can be installed by using <code>apk</code> to install the <code>alpine-conf</code> package.

If you don't have an Alpine Linux install, you can find and examine the scripts in their [https://github.com/alpinelinux/alpine-conf git repository].

== setup-alpine ==

This is the main Alpine configuration and installation script.

The script interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below.

The bracketed options represent example configuration choices, formatted as they may be supplied when manually calling the auxiliary setup scripts, or using a <code>setup-alpine</code> "answerfile" (see below).

# <code>setup-keymap</code> [us us]
# [[#setup-hostname|setup-hostname]] [-n alpine-test]
# [[#setup-interfaces|setup-interfaces]] [-i < interfaces-file]
# <code>/etc/init.d/networking --quiet start &</code>
# if none of the networking interfaces were configured using dhcp, then: <code>[[#setup-dns|setup-dns]]</code> [-d example.com -n "192.168.0.1 [...]"]
# set the root password
# if not in quick mode, then: <code>[[#setup-timezone|setup-timezone]]</code> [-z UTC | -z America/New_York | -p EST+5]
# enable the new hostname (<code>/etc/init.d/hostname --quiet restart</code>)
# add <code>networking</code> and <code>urandom</code> to the '''boot''' rc level, and <code>acpid</code> and <code>crond</code> to the '''default''' rc level, and start the '''boot''' and '''default''' rc services
# extract the fully-qualified domain name and hostname from {{Path|/etc/resolv.conf}} and <code>hostname</code>, and update {{Path|/etc/hosts}}
# <code>[[#setup-proxy|setup-proxy]]</code> [-q <nowiki>"http://webproxy:8080"</nowiki>], and activate proxy if it was configured
# <code>setup-apkrepos</code> [-r (to select a mirror randomly)]
# if not in quick mode, then: <code>[[#setup-sshd|setup-sshd]]</code> [-c openssh | dropbear | none]
# if not in quick mode, then: <code>setup-ntp</code> [-c chrony | openntpd | busybox | none]
# if not in quick mode, then: <code>DEFAULT_DISK=none</code> <code>[[#setup-disk|setup-disk]]</code> <code>-q</code> [-m data /dev/sda] (see [[Installation#Installation_Overview]] about the disk modes)
# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-lbu</code> [/media/sdb1]
# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-apkcache</code> [/media/sdb1/cache | none]

<code>setup-alpine</code> itself accepts the following command-line switches:

{{Define|-h|Shows the up-to-date usage help message.}}

{{Define|-a|Create an overlay file: this creates a temporary directory and saves its location in ROOT; however, the script doesn't export this variable so I think this feature isn't currently functional.}}
;-c <var>answerfile</var>
:Create a new answerfile with default choices. You can edit the file and then invoke <code>setup-alpine -f <var>answerfile</var></code>.
;-f <var>answerfile</var>
:Use an existing answerfile, which may override some or all of the interactive prompts. You can also specify a HTTP(S) or FTP URL for <code>setup-alpine</code> to [https://gitlab.alpinelinux.org/alpine/alpine-conf/-/merge_requests/22 download] an answerfile from. Doing so will spin up a temporary networking config if one is not already active.
{{Define|-q|Run in "quick mode".}}

 

== setup-hostname ==

:<code>setup-hostname</code> [-h] [-n hostname]

Options:

'''-h''' <var>Show help</var>

'''-n''' <var>Specify hostname</var>

This script allows quick and easy setup of the system hostname by writing it to {{Path|/etc/hostname}}. The script prevents you from writing an invalid hostname (such as one that used invalid characters or starts with a '-' or is too long).
The script can be invoked manually or is called as part of the <code>setup-alpine</code> script.

 

== setup-interfaces ==
{{Cmd|setup-interfaces [-i < <var>interfaces-file</var>]}}

Note that the contents of <var>interfaces-file</var> has to be supplied as stdin, rather than naming the file as an additional argument. The contents should have the format of {{Path|/etc/network/interfaces}}, such as:

auto lo
iface lo inet loopback

auto eth0
iface eth0 inet dhcp
hostname alpine-test

 

== setup-dns ==

:<code>setup-dns</code> [-h] [-d domain name] [-n name server]

Options:

'''-h''' <var>Show help</var>

'''-d''' <var>specify search domain name</var>

'''-n''' <var>name server IP</var>

The setup-dns script is stored in {{Path|/sbin/setup-dns}} and allows quick and simple setup of DNS servers (and a DNS search domain if required). Simply running <code>setup-dns</code> will allow interactive use of the script, or the options can be specified.

The information fed to this script is written to {{Path|/etc/resolv.conf}}

Example usage (with 192.168.0.1 being the local router/dns-forwarder): {{Cmd|setup-dns -d example.org -n 192.168.0.1}}

Example {{Path|/etc/resolv.conf}}:

search example.org
nameserver 192.168.0.1

It can be run manually but is also invoked in the <code>setup-alpine</code> script unless interfaces are configured for DHCP.

 

== setup-timezone ==
:<code>setup-timezone</code> [-z UTC | -z America/New_York | -p EST+5]

Can pre-select the timezone using either of these switches:

'''-z''' <var>subfolder of</var> {{Path|/usr/share/zoneinfo}}

'''-p''' <var>POSIX TZ format</var>

 

== setup-proxy ==
:<code>setup-proxy</code> [-hq] [PROXYURL]

Options:

'''-h''' <var>Show help</var>

'''-q''' <var>Quiet mode</var> prevents changes from taking effect until after reboot

This script requests the system proxy to use in the form <code>http://<proxyurl>:<port></code> for example:
<code><nowiki>http://10.0.0.1:8080</nowiki></code>

To set no system proxy use <code>none</code>.
This script exports the following environmental variables:

<code>http_proxy=$proxyurl</code>

<code>https_proxy=$proxyurl</code>

<code>ftp_proxy=$proxyurl</code>

where <code>$proxyurl</code> is the value input.
If <code>none</code> was chosen then the value it is set to a blank value (and so no proxy is used).

 

== setup-apkrepos ==
:<code>setup-apkrepos</code> [-fhr] [REPO...]

Setup <code>apk</code> repositories.

options:

'''-f''' <var>Detect and add fastest mirror</var>

'''-r''' <var>Add a random mirror and do not prompt</var>

'''-1''' <var>Add first mirror on the list (normally a CDN)</var>

This is run as part of the <code>setup-alpine</code> script.

 

== setup-sshd ==

:<code>setup-sshd</code> [-h] [-c choice of SSH daemon]

Options:

'''-h''' <var>Show help</var>

'''-c''' <var>SSH daemon</var> where SSH daemon can be one of the following:

<code>openssh</code> install the {{Pkg|openSSH}} daemon

<code>dropbear</code> install the {{Pkg|dropbear}} daemon

<code>none</code> Do not install an SSH daemon

Example usage: {{Cmd|setup-sshd -c dropbear}}

The setup-sshd script is stored in {{Path|/sbin/setup-sshd}} and allows quick and simple setup of either the OpenSSH or Dropbear SSH daemon & client.
It can be run manually but is also invoked in the <code>setup-alpine</code> script.

 

== setup-ntp ==

''From [https://en.wikipedia.org/wiki/Network_Time_Protocol Wikipedia]'':

The '''Network Time Protocol (NTP)''' is a networking protocol for clock synchronization between computer systems over packet-switched, variable-latency data networks.

 

{{Cmd|usage: setup-ntp [-h] [-c choice of NTP daemon]

Setup NTP time synchronization

options:
-h Show this help
-c Choice of NTP daemon: busybox openntpd chrony none}}

<code>setup-ntp</code> script is stored in {{Path|/sbin/setup-ntp}} and allows quick and simple setup of the NTP client,
It can be run manually but is also invoked in the <code>setup-alpine</code> script.

 

== setup-disk ==

:<code>DEFAULT_DISK=none setup-disk -q</code> [-m data | sys] [<var>mountpoint directory</var> | /dev/sda ...]

In "sys" mode, it's an installer, it permanently installs Alpine on the disk, in "data" mode, it provides a larger and persistent /var volume.

This script accepts the following command-line switches:

;-k <var>kernel flavor</var>
;-o <var>apkovl file</var>
:Restore system from <var>apkovl file</var>
;-m data | sys
:Don't prompt for installation mode. With '''-m data''', the supplied devices are formatted to use as a {{Path|/var}} volume.
{{Define|-r|Use RAID1 with a single disk (degraded mode)}}
{{Define|-L|Create and use volumes in a LVM group}}
;-s <var>swap size in MB</var>
:Use 0 to disable swap
{{Define|-q|Exit quietly if no disks are found}}
{{Define|-v|Verbose mode}}

The script also honors the following environment variables:

<code>BOOT_SIZE</code>
:Size of the boot partition in MB; defaults to 100. Only used if '''-m sys''' is specified or interactively selected.

<code>SWAP_SIZE</code>
:Size of the swap volume in MB; set to 0 to disable swap. If not specified, will default to twice RAM, up to 4096, but won't be more than 1/3 the size of the smallest disk, and if less than 64 will just be 0. Only used if '''-m sys''' is specified or interactively selected.

<code>ROOTFS</code>
:Filesystem to use for the / volume; defaults to ext4. Only used if '''-m sys''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>BOOTFS</code>
:Filesystem to use for the /boot volume; defaults to ext4. Only used if '''-m sys''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>VARFS</code>
:Filesystem to use for the /var volume; defaults to ext4. Only used if '''-m data''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>SYSROOT</code>
:Mountpoint to use when creating volumes and doing traditional disk install ('''-m sys'''). Defaults to {{Path|/mnt}}.

<code>MBR</code>
:Path of MBR binary code, defaults to {{Path|/usr/share/syslinux/mbr.bin}}.

<code>BOOTLOADER</code>
:Bootloader to use, defaults to syslinux. Supported bootloaders are: grub syslinux zipl.

<code>DISKLABEL</code>
:Disklabel to use, defaults to dos. Supported disklabels are: dos gpt eckd.



=== Partitioning ===

If you have complex partitioning needs, that go beyond above alpine-disk options, you can partition, format, and mount your volumes manually, and then just supply the root mountpoint to <code>setup-disk</code>. Doing so implicitly behaves as though '''-m sys''' had also been specified.

See [[Setting up disks manually]] for more information.

==== RAID ====
<code>setup-disk</code> will automatically build a RAID array if you supply the '''-r''' switch, or if you specify more than one device. The array will always be [https://en.m.wikipedia.org/wiki/Standard_RAID_levels#RAID_1 RAID1] (and [https://raid.wiki.kernel.org/index.php/RAID_superblock_formats#The_version-0.90_Superblock_Format --metadata=0.90]) for the /boot volumes, but will be [https://en.m.wikipedia.org/wiki/Standard_RAID_levels#RAID_5 RAID5] (and [https://raid.wiki.kernel.org/index.php/RAID_superblock_formats#The_version-1_Superblock_Format --metadata=1.2] for non-boot volumes when 3 or more devices are supplied.

If you instead want to build your RAID array manually, see [[Setting up a software RAID array]]. Then format and mount the disks, and supply the root mountpoint to <code>setup-disk</code>.

==== LVM ====
<code>setup-disk</code> will automatically build and use volumes in a LVM group if you supply the '''-L''' switch. The group and volumes created by the script will have the following names:

* volume group: '''vg0'''
* swap volume: '''lv_swap''' (only created when swap size > 0)
* root volume: '''lv_root''' (only created when '''-m sys''' is specified or interactively selected)
* var volume: '''lv_var''' (only created when '''-m data''' is specified or interactively selected)

The '''lv_var''' or '''lv_root''' volumes are created to occupy all remaining space in the volume group.

If you need to change any of these settings, you can use <code>vgrename</code>, <code>lvrename</code>, <code>lvreduce</code> or <code>lvresize</code>.

If you instead want to build your LVM system manually, see [[Setting up Logical Volumes with LVM]]. Then format and mount the disks, and supply the root mountpoint to <code>setup-disk</code>.



 

== setup-lbu ==

This script will only be invoked for by <code>setup-alpine</code> when installing <code>data</code> installation types (ramdisk)

It configures where <code>lbu commit</code> will store the .apkovl backup. See [[Alpine local backup]] for more information.

When started, <code>setup-lbu</code> will prompt where to store your data. The options it will prompt for will be taken from the directories found in <code>/media</code> (except for <code>cdrom</code>). [not sure how these are mounted: are they automatically mounted by setup-lbu? Does the user have to manually mount using another tty?]

 

== setup-apkcache ==

This script will only be invoked for by <code>setup-alpine</code> when installing <code>data</code> installation types (ramdisk)

It configures where to save the apk package files. The apkcache is where apk stores downloaded packages, such that the system does not need to download them again on each reboot, and doesn't have to depend on the network. See [[Local APK cache]] for a detailed explanation.

You should be able to use a partition that you set up in the previous steps.

 

== setup-bootable ==
This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

It allows to create boot media that boots the system running from RAM memory (diskless) like the installation images, but using a writable (i.e. not iso9660) filesystem. So that it can also serve to store local customizations (e.g. apkovl files and cached packages).

First, the script copies files from an ISO image (as file on a CD/DVD/USB etc.) onto a USB-Stick/CompactFlash/SDCard etc., or harddisk partition. And then, it installs the syslinux bootloader to make the device bootable.

However, its current syslinux installation seems to fail on non-FAT32 partitions. So in these cases, you may start over with a FAT32 filesystem, or rather with the desired filesystem and using <code>setup-bootable</code> only with the <code>-u</code> option, to skip the syslinux install, and then refer to the [[Create_a_Bootable_Device#Manually_copying_Alpine_files|manual method]] to fix the problem, or use one of the other bootloader options, instead.

{{Tip| The [[Bootloaders]] page shows different ways to setup booting, and multi-boot menus!}}

The setup-bootable script accepts the following arguments and command-line switches (you can run <code>setup-bootable -h</code> to see a usage message).

{{Cmd|setup-bootable <var>source</var> [<var>dest</var>]}}

The argument <var>source</var> can be a directory or an ISO (will be mounted to <code>MNT</code> or {{Path|/mnt}}) or a URL (will be downloaded with <code>WGET</code> or <code>wget</code>). The argument <var>dest</var> can be a directory mountpoint, or will default to {{Path|/media/usb}} if not supplied.

{{Define|-k|Keep alpine_dev in {{Path|syslinux.cfg}}; otherwise, replace with UUID.}}
{{Define|-u|Upgrade mode: keep existing {{Path|syslinux.cfg}} and don't run <code>syslinux</code>}}
{{Define|-f|Overwrite {{Path|syslinux.cfg}} even if '''-u''' was specified.}}
{{Define|-s|Force the running of <code>syslinux</code> even if '''-u''' was specified.}}
{{Define|-v|Verbose mode}}

The script will ensure that <var>source</var> and <var>dest</var> are available; will copy the contents of <var>source</var> to <var>dest</var>, ensuring first that there's enough space; and unless '''-u''' was specified, will make <var>dest</var> bootable.

Suppose the target device is /dev/sdXY, then this partition can be prepared for booting with
{{Cmd|# setup-bootable -v /media/<installation-media-device> /dev/sdXY
}}

For the manual way to set up boot media see [[Create_a_Bootable_Device#Manually_copying_Alpine_files|Manually_copying_Alpine_files]].

 

== setup-xorg-base ==

This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

It configures a graphical environment, installing basic Xorg packages and udev (replacing mdev), and is also required for Wayland sessions.

The script installs, among other packages, e.g.: <code>xorg-server xf86-input-libinput xinit udev</code>.

Additional packages to install may be supplied as arguments.
{{cmd|setup-xorg-base [additional package(s) to install]}}

==== Video packages (optional) ====

You may install specific xf86 xorg driver packages for your video card's chipset, as they may support specific features, effects and acceleration modes, and avoid error messages during X initialization.

However, the most basic X features should work fine with just using the default kernel video-modesetting drivers.

Info about the particular video cards that are installed in the computer may be found in the list of PCI devices:
{{cmd|# apk add pciutils
$ lspci}}

To see available video driver packages run:
{{cmd|$ apk search xf86-video}}

For example,
* For an Sis video chipset install 'xf86-video-sis'.
{{Cmd|# apk add xf86-video-sis}}

Others:
* For Intel video chipsets install 'xf86-video-intel' and see [[Intel Video]].
{{Tip|In some cases, freezes on suspend/resume stop happening when changing the video port the monitor is connected to.}}
* For AMD Radeon Video see [[Radeon_Video]]
* For Alix1D use xf86-video-geode.
* In KVM/QEMU guests see [[QEMU#Using_Xorg_inside_Qemu|Xorg within KVM/QEMU]]
* In VirtualBox guests use xf86-video-vboxvideo, and install the [[VirtualBox_guest_additions|VirtualBox guest additions]] as well. They contain important parts for the driver.
* In VMware guests use xf86-video-vmware
* In Hyper-V guests use xf86-video-fbdev and install the [[Hyper-V_guest_services|Hyper-V guest services]] as well.

==== Input packages ====

If the Numlock settings are not working, or getting 'setleds not found' errors:

{{cmd|# apk add kbd}}

If some input device is not working at all, the available xf86-input drivers can be listed with:
{{cmd|$ apk search xf86-input}}

You probably at least want {{cmd| xf86-input-libinput}} or {{cmd| xf86-input-evdev}}

libinput is for Wayland with wrapper for Xorg. evdev is Xorg only. 

Typical legacy drivers (not packaged. at least as of 2/2022):

{{cmd|# apk add xf86-input-mouse xf86-input-keyboard}}

And for touchpad tapping support on many laptops, also:

{{Cmd|# apk add xf86-input-synaptics}}

==== Configure xorg-server (optional) ====

On most systems, xorg should be able to autodetect all devices. However you can still configure xorg-server by hand by launching:
{{Cmd|# Xorg -configure}}
This will create a `/root/xorg.conf.new` file. You can modify this file to fit your needs. 
(When finished modifying and testing the above configuration file, move it to `/etc/X11/xorg.conf` for normal usage.)

==== Keyboard Layout (optional) ====

If you use a keyboard layout different than "us", and you are using a window manager or desktop environment that does not support to configure the keyboard layout itself, then you need to

* [[Enable_Community_Repository#Using_community_repositories|Enable the "community" repository]]

and install setxkbmap:

{{Cmd|# apk add setxkbmap}}

Then try
# setxkbmap <%a language layout from /usr/share/X11/xkb/rules/xorg.lst%>

In order to make it persistent add this section to /etc/X11/xorg.conf:
{{Cmd|Section "InputClass"
Identifier "Keyboard Default"
MatchIsKeyboard "yes"
Option "XkbLayout" "<%a language layout from /usr/share/X11/xkb/rules/xorg.lst%>"
EndSection
}}

Another way to change the keymap when logging into X is to use ~/.xinitrc. The following example loads a British keymap, simply add this line to the beginning of the file:
<code>setxkbmap gb &</code>

If you need to create the ~/.xinitrc file, you may also want to add a second line like <code>exec openbox-session</code> to still start the window manager with <code>startx</code> or <code>xinit</code>.

 

== Documentation needed ==

=== setup-xen-dom0 ===

 

=== setup-mta ===
Uses ssmtp.

This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

 

=== setup-acf ===
This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

This script was named <code>setup-webconf</code> before Alpine 1.9 beta 4.

See [[:Category:ACF|ACF pages]] for more information.

= See also =
* [[Installation]]
* [[Post installation]]

[[Category:Installation]]

Alpine configuration management scripts

2022-03-17T08:48:09Z

Viridian: Mention that setup-alpine can dl answerfiles

Feature descriptions for available Alpine Linux setup scripts ({{Path|/sbin/setup-*}}).

These scripts can be installed by using <code>apk</code> to install the <code>alpine-conf</code> package.

If you don't have an Alpine Linux install, you can find and examine the scripts in their [https://github.com/alpinelinux/alpine-conf git repository].

== setup-alpine ==

This is the main Alpine configuration and installation script.

The script interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below.

The bracketed options represent example configuration choices, formatted as they may be supplied when manually calling the auxiliary setup scripts, or using a <code>setup-alpine</code> "answerfile" (see below).

# <code>setup-keymap</code> [us us]
# [[#setup-hostname|setup-hostname]] [-n alpine-test]
# [[#setup-interfaces|setup-interfaces]] [-i < interfaces-file]
# <code>/etc/init.d/networking --quiet start &</code>
# if none of the networking interfaces were configured using dhcp, then: <code>[[#setup-dns|setup-dns]]</code> [-d example.com -n "192.168.0.1 [...]"]
# set the root password
# if not in quick mode, then: <code>[[#setup-timezone|setup-timezone]]</code> [-z UTC | -z America/New_York | -p EST+5]
# enable the new hostname (<code>/etc/init.d/hostname --quiet restart</code>)
# add <code>networking</code> and <code>urandom</code> to the '''boot''' rc level, and <code>acpid</code> and <code>crond</code> to the '''default''' rc level, and start the '''boot''' and '''default''' rc services
# extract the fully-qualified domain name and hostname from {{Path|/etc/resolv.conf}} and <code>hostname</code>, and update {{Path|/etc/hosts}}
# <code>[[#setup-proxy|setup-proxy]]</code> [-q <nowiki>"http://webproxy:8080"</nowiki>], and activate proxy if it was configured
# <code>setup-apkrepos</code> [-r (to select a mirror randomly)]
# if not in quick mode, then: <code>[[#setup-sshd|setup-sshd]]</code> [-c openssh | dropbear | none]
# if not in quick mode, then: <code>setup-ntp</code> [-c chrony | openntpd | busybox | none]
# if not in quick mode, then: <code>DEFAULT_DISK=none</code> <code>[[#setup-disk|setup-disk]]</code> <code>-q</code> [-m data /dev/sda] (see [[Installation#Installation_Overview]] about the disk modes)
# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-lbu</code> [/media/sdb1]
# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-apkcache</code> [/media/sdb1/cache | none]

<code>setup-alpine</code> itself accepts the following command-line switches:

{{Define|-h|Shows the up-to-date usage help message.}}

{{Define|-a|Create an overlay file: this creates a temporary directory and saves its location in ROOT; however, the script doesn't export this variable so I think this feature isn't currently functional.}}
;-c <var>answerfile</var>
:Create a new answerfile with default choices. You can edit the file and then invoke <code>setup-alpine -f <var>answerfile</var></code>.
;-f <var>answerfile</var>
:Use an existing answerfile, which may override some or all of the interactive prompts. You can also specify a HTTP(S) URL for <code>setup-alpine</code> to [https://gitlab.alpinelinux.org/alpine/alpine-conf/-/merge_requests/22 download] an answerfile from. Doing so will spin up a temporary networking config if one is not already active.
{{Define|-q|Run in "quick mode".}}

 

== setup-hostname ==

:<code>setup-hostname</code> [-h] [-n hostname]

Options:

'''-h''' <var>Show help</var>

'''-n''' <var>Specify hostname</var>

This script allows quick and easy setup of the system hostname by writing it to {{Path|/etc/hostname}}. The script prevents you from writing an invalid hostname (such as one that used invalid characters or starts with a '-' or is too long).
The script can be invoked manually or is called as part of the <code>setup-alpine</code> script.

 

== setup-interfaces ==
{{Cmd|setup-interfaces [-i < <var>interfaces-file</var>]}}

Note that the contents of <var>interfaces-file</var> has to be supplied as stdin, rather than naming the file as an additional argument. The contents should have the format of {{Path|/etc/network/interfaces}}, such as:

auto lo
iface lo inet loopback

auto eth0
iface eth0 inet dhcp
hostname alpine-test

 

== setup-dns ==

:<code>setup-dns</code> [-h] [-d domain name] [-n name server]

Options:

'''-h''' <var>Show help</var>

'''-d''' <var>specify search domain name</var>

'''-n''' <var>name server IP</var>

The setup-dns script is stored in {{Path|/sbin/setup-dns}} and allows quick and simple setup of DNS servers (and a DNS search domain if required). Simply running <code>setup-dns</code> will allow interactive use of the script, or the options can be specified.

The information fed to this script is written to {{Path|/etc/resolv.conf}}

Example usage (with 192.168.0.1 being the local router/dns-forwarder): {{Cmd|setup-dns -d example.org -n 192.168.0.1}}

Example {{Path|/etc/resolv.conf}}:

search example.org
nameserver 192.168.0.1

It can be run manually but is also invoked in the <code>setup-alpine</code> script unless interfaces are configured for DHCP.

 

== setup-timezone ==
:<code>setup-timezone</code> [-z UTC | -z America/New_York | -p EST+5]

Can pre-select the timezone using either of these switches:

'''-z''' <var>subfolder of</var> {{Path|/usr/share/zoneinfo}}

'''-p''' <var>POSIX TZ format</var>

 

== setup-proxy ==
:<code>setup-proxy</code> [-hq] [PROXYURL]

Options:

'''-h''' <var>Show help</var>

'''-q''' <var>Quiet mode</var> prevents changes from taking effect until after reboot

This script requests the system proxy to use in the form <code>http://<proxyurl>:<port></code> for example:
<code><nowiki>http://10.0.0.1:8080</nowiki></code>

To set no system proxy use <code>none</code>.
This script exports the following environmental variables:

<code>http_proxy=$proxyurl</code>

<code>https_proxy=$proxyurl</code>

<code>ftp_proxy=$proxyurl</code>

where <code>$proxyurl</code> is the value input.
If <code>none</code> was chosen then the value it is set to a blank value (and so no proxy is used).

 

== setup-apkrepos ==
:<code>setup-apkrepos</code> [-fhr] [REPO...]

Setup <code>apk</code> repositories.

options:

'''-f''' <var>Detect and add fastest mirror</var>

'''-r''' <var>Add a random mirror and do not prompt</var>

'''-1''' <var>Add first mirror on the list (normally a CDN)</var>

This is run as part of the <code>setup-alpine</code> script.

 

== setup-sshd ==

:<code>setup-sshd</code> [-h] [-c choice of SSH daemon]

Options:

'''-h''' <var>Show help</var>

'''-c''' <var>SSH daemon</var> where SSH daemon can be one of the following:

<code>openssh</code> install the {{Pkg|openSSH}} daemon

<code>dropbear</code> install the {{Pkg|dropbear}} daemon

<code>none</code> Do not install an SSH daemon

Example usage: {{Cmd|setup-sshd -c dropbear}}

The setup-sshd script is stored in {{Path|/sbin/setup-sshd}} and allows quick and simple setup of either the OpenSSH or Dropbear SSH daemon & client.
It can be run manually but is also invoked in the <code>setup-alpine</code> script.

 

== setup-ntp ==

''From [https://en.wikipedia.org/wiki/Network_Time_Protocol Wikipedia]'':

The '''Network Time Protocol (NTP)''' is a networking protocol for clock synchronization between computer systems over packet-switched, variable-latency data networks.

 

{{Cmd|usage: setup-ntp [-h] [-c choice of NTP daemon]

Setup NTP time synchronization

options:
-h Show this help
-c Choice of NTP daemon: busybox openntpd chrony none}}

<code>setup-ntp</code> script is stored in {{Path|/sbin/setup-ntp}} and allows quick and simple setup of the NTP client,
It can be run manually but is also invoked in the <code>setup-alpine</code> script.

 

== setup-disk ==

:<code>DEFAULT_DISK=none setup-disk -q</code> [-m data | sys] [<var>mountpoint directory</var> | /dev/sda ...]

In "sys" mode, it's an installer, it permanently installs Alpine on the disk, in "data" mode, it provides a larger and persistent /var volume.

This script accepts the following command-line switches:

;-k <var>kernel flavor</var>
;-o <var>apkovl file</var>
:Restore system from <var>apkovl file</var>
;-m data | sys
:Don't prompt for installation mode. With '''-m data''', the supplied devices are formatted to use as a {{Path|/var}} volume.
{{Define|-r|Use RAID1 with a single disk (degraded mode)}}
{{Define|-L|Create and use volumes in a LVM group}}
;-s <var>swap size in MB</var>
:Use 0 to disable swap
{{Define|-q|Exit quietly if no disks are found}}
{{Define|-v|Verbose mode}}

The script also honors the following environment variables:

<code>BOOT_SIZE</code>
:Size of the boot partition in MB; defaults to 100. Only used if '''-m sys''' is specified or interactively selected.

<code>SWAP_SIZE</code>
:Size of the swap volume in MB; set to 0 to disable swap. If not specified, will default to twice RAM, up to 4096, but won't be more than 1/3 the size of the smallest disk, and if less than 64 will just be 0. Only used if '''-m sys''' is specified or interactively selected.

<code>ROOTFS</code>
:Filesystem to use for the / volume; defaults to ext4. Only used if '''-m sys''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>BOOTFS</code>
:Filesystem to use for the /boot volume; defaults to ext4. Only used if '''-m sys''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>VARFS</code>
:Filesystem to use for the /var volume; defaults to ext4. Only used if '''-m data''' is specified or interactively selected. Supported filesystems are: ext2 ext3 ext4 [[Btrfs|btrfs]] xfs.

<code>SYSROOT</code>
:Mountpoint to use when creating volumes and doing traditional disk install ('''-m sys'''). Defaults to {{Path|/mnt}}.

<code>MBR</code>
:Path of MBR binary code, defaults to {{Path|/usr/share/syslinux/mbr.bin}}.

<code>BOOTLOADER</code>
:Bootloader to use, defaults to syslinux. Supported bootloaders are: grub syslinux zipl.

<code>DISKLABEL</code>
:Disklabel to use, defaults to dos. Supported disklabels are: dos gpt eckd.



=== Partitioning ===

If you have complex partitioning needs, that go beyond above alpine-disk options, you can partition, format, and mount your volumes manually, and then just supply the root mountpoint to <code>setup-disk</code>. Doing so implicitly behaves as though '''-m sys''' had also been specified.

See [[Setting up disks manually]] for more information.

==== RAID ====
<code>setup-disk</code> will automatically build a RAID array if you supply the '''-r''' switch, or if you specify more than one device. The array will always be [https://en.m.wikipedia.org/wiki/Standard_RAID_levels#RAID_1 RAID1] (and [https://raid.wiki.kernel.org/index.php/RAID_superblock_formats#The_version-0.90_Superblock_Format --metadata=0.90]) for the /boot volumes, but will be [https://en.m.wikipedia.org/wiki/Standard_RAID_levels#RAID_5 RAID5] (and [https://raid.wiki.kernel.org/index.php/RAID_superblock_formats#The_version-1_Superblock_Format --metadata=1.2] for non-boot volumes when 3 or more devices are supplied.

If you instead want to build your RAID array manually, see [[Setting up a software RAID array]]. Then format and mount the disks, and supply the root mountpoint to <code>setup-disk</code>.

==== LVM ====
<code>setup-disk</code> will automatically build and use volumes in a LVM group if you supply the '''-L''' switch. The group and volumes created by the script will have the following names:

* volume group: '''vg0'''
* swap volume: '''lv_swap''' (only created when swap size > 0)
* root volume: '''lv_root''' (only created when '''-m sys''' is specified or interactively selected)
* var volume: '''lv_var''' (only created when '''-m data''' is specified or interactively selected)

The '''lv_var''' or '''lv_root''' volumes are created to occupy all remaining space in the volume group.

If you need to change any of these settings, you can use <code>vgrename</code>, <code>lvrename</code>, <code>lvreduce</code> or <code>lvresize</code>.

If you instead want to build your LVM system manually, see [[Setting up Logical Volumes with LVM]]. Then format and mount the disks, and supply the root mountpoint to <code>setup-disk</code>.



 

== setup-lbu ==

This script will only be invoked for by <code>setup-alpine</code> when installing <code>data</code> installation types (ramdisk)

It configures where <code>lbu commit</code> will store the .apkovl backup. See [[Alpine local backup]] for more information.

When started, <code>setup-lbu</code> will prompt where to store your data. The options it will prompt for will be taken from the directories found in <code>/media</code> (except for <code>cdrom</code>). [not sure how these are mounted: are they automatically mounted by setup-lbu? Does the user have to manually mount using another tty?]

 

== setup-apkcache ==

This script will only be invoked for by <code>setup-alpine</code> when installing <code>data</code> installation types (ramdisk)

It configures where to save the apk package files. The apkcache is where apk stores downloaded packages, such that the system does not need to download them again on each reboot, and doesn't have to depend on the network. See [[Local APK cache]] for a detailed explanation.

You should be able to use a partition that you set up in the previous steps.

 

== setup-bootable ==
This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

It allows to create boot media that boots the system running from RAM memory (diskless) like the installation images, but using a writable (i.e. not iso9660) filesystem. So that it can also serve to store local customizations (e.g. apkovl files and cached packages).

First, the script copies files from an ISO image (as file on a CD/DVD/USB etc.) onto a USB-Stick/CompactFlash/SDCard etc., or harddisk partition. And then, it installs the syslinux bootloader to make the device bootable.

However, its current syslinux installation seems to fail on non-FAT32 partitions. So in these cases, you may start over with a FAT32 filesystem, or rather with the desired filesystem and using <code>setup-bootable</code> only with the <code>-u</code> option, to skip the syslinux install, and then refer to the [[Create_a_Bootable_Device#Manually_copying_Alpine_files|manual method]] to fix the problem, or use one of the other bootloader options, instead.

{{Tip| The [[Bootloaders]] page shows different ways to setup booting, and multi-boot menus!}}

The setup-bootable script accepts the following arguments and command-line switches (you can run <code>setup-bootable -h</code> to see a usage message).

{{Cmd|setup-bootable <var>source</var> [<var>dest</var>]}}

The argument <var>source</var> can be a directory or an ISO (will be mounted to <code>MNT</code> or {{Path|/mnt}}) or a URL (will be downloaded with <code>WGET</code> or <code>wget</code>). The argument <var>dest</var> can be a directory mountpoint, or will default to {{Path|/media/usb}} if not supplied.

{{Define|-k|Keep alpine_dev in {{Path|syslinux.cfg}}; otherwise, replace with UUID.}}
{{Define|-u|Upgrade mode: keep existing {{Path|syslinux.cfg}} and don't run <code>syslinux</code>}}
{{Define|-f|Overwrite {{Path|syslinux.cfg}} even if '''-u''' was specified.}}
{{Define|-s|Force the running of <code>syslinux</code> even if '''-u''' was specified.}}
{{Define|-v|Verbose mode}}

The script will ensure that <var>source</var> and <var>dest</var> are available; will copy the contents of <var>source</var> to <var>dest</var>, ensuring first that there's enough space; and unless '''-u''' was specified, will make <var>dest</var> bootable.

Suppose the target device is /dev/sdXY, then this partition can be prepared for booting with
{{Cmd|# setup-bootable -v /media/<installation-media-device> /dev/sdXY
}}

For the manual way to set up boot media see [[Create_a_Bootable_Device#Manually_copying_Alpine_files|Manually_copying_Alpine_files]].

 

== setup-xorg-base ==

This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

It configures a graphical environment, installing basic Xorg packages and udev (replacing mdev), and is also required for Wayland sessions.

The script installs, among other packages, e.g.: <code>xorg-server xf86-input-libinput xinit udev</code>.

Additional packages to install may be supplied as arguments.
{{cmd|setup-xorg-base [additional package(s) to install]}}

==== Video packages (optional) ====

You may install specific xf86 xorg driver packages for your video card's chipset, as they may support specific features, effects and acceleration modes, and avoid error messages during X initialization.

However, the most basic X features should work fine with just using the default kernel video-modesetting drivers.

Info about the particular video cards that are installed in the computer may be found in the list of PCI devices:
{{cmd|# apk add pciutils
$ lspci}}

To see available video driver packages run:
{{cmd|$ apk search xf86-video}}

For example,
* For an Sis video chipset install 'xf86-video-sis'.
{{Cmd|# apk add xf86-video-sis}}

Others:
* For Intel video chipsets install 'xf86-video-intel' and see [[Intel Video]].
{{Tip|In some cases, freezes on suspend/resume stop happening when changing the video port the monitor is connected to.}}
* For AMD Radeon Video see [[Radeon_Video]]
* For Alix1D use xf86-video-geode.
* In KVM/QEMU guests see [[QEMU#Using_Xorg_inside_Qemu|Xorg within KVM/QEMU]]
* In VirtualBox guests use xf86-video-vboxvideo, and install the [[VirtualBox_guest_additions|VirtualBox guest additions]] as well. They contain important parts for the driver.
* In VMware guests use xf86-video-vmware
* In Hyper-V guests use xf86-video-fbdev and install the [[Hyper-V_guest_services|Hyper-V guest services]] as well.

==== Input packages ====

If the Numlock settings are not working, or getting 'setleds not found' errors:

{{cmd|# apk add kbd}}

If some input device is not working at all, the available xf86-input drivers can be listed with:
{{cmd|$ apk search xf86-input}}

You probably at least want {{cmd| xf86-input-libinput}} or {{cmd| xf86-input-evdev}}

libinput is for Wayland with wrapper for Xorg. evdev is Xorg only. 

Typical legacy drivers (not packaged. at least as of 2/2022):

{{cmd|# apk add xf86-input-mouse xf86-input-keyboard}}

And for touchpad tapping support on many laptops, also:

{{Cmd|# apk add xf86-input-synaptics}}

==== Configure xorg-server (optional) ====

On most systems, xorg should be able to autodetect all devices. However you can still configure xorg-server by hand by launching:
{{Cmd|# Xorg -configure}}
This will create a `/root/xorg.conf.new` file. You can modify this file to fit your needs. 
(When finished modifying and testing the above configuration file, move it to `/etc/X11/xorg.conf` for normal usage.)

==== Keyboard Layout (optional) ====

If you use a keyboard layout different than "us", and you are using a window manager or desktop environment that does not support to configure the keyboard layout itself, then you need to

* [[Enable_Community_Repository#Using_community_repositories|Enable the "community" repository]]

and install setxkbmap:

{{Cmd|# apk add setxkbmap}}

Then try
# setxkbmap <%a language layout from /usr/share/X11/xkb/rules/xorg.lst%>

In order to make it persistent add this section to /etc/X11/xorg.conf:
{{Cmd|Section "InputClass"
Identifier "Keyboard Default"
MatchIsKeyboard "yes"
Option "XkbLayout" "<%a language layout from /usr/share/X11/xkb/rules/xorg.lst%>"
EndSection
}}

Another way to change the keymap when logging into X is to use ~/.xinitrc. The following example loads a British keymap, simply add this line to the beginning of the file:
<code>setxkbmap gb &</code>

If you need to create the ~/.xinitrc file, you may also want to add a second line like <code>exec openbox-session</code> to still start the window manager with <code>startx</code> or <code>xinit</code>.

 

== Documentation needed ==

=== setup-xen-dom0 ===

 

=== setup-mta ===
Uses ssmtp.

This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

 

=== setup-acf ===
This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually.

This script was named <code>setup-webconf</code> before Alpine 1.9 beta 4.

See [[:Category:ACF|ACF pages]] for more information.

= See also =
* [[Installation]]
* [[Post installation]]

[[Category:Installation]]

Post installation

2022-03-16T20:06:24Z

Viridian: Fix formatting, improve wording

{{Draft|Still might be missing some things but (i think) it is mostly complete}}

{{Note|This [[Post installation|Post Installation]] wiki page has been created, however, its information is better to be kept in their (even already existing!) own and individually manageable ("authoritative") topic pages and only directly referenced (linked) from the list in the [[Installation]] overview page. (Not to be duplicated here and to never get updated again!) If you would like to help with this process please go ahead.}}

== General Notes ==

* When '''#''' is displayed before a command, that means the command needs to be run with root privileges.

* Anything in < > is likely just a placeholder that you need to replace (example: <editor> file.txt).

* Some information in here might be a repeat of information in other wiki pages. If you find a section where that is the case, please add a link to the original wiki page.

 

== Network setup ==

==== Wi-Fi ====

* [[Wi-Fi]]
* [[NetworkManager]]

==== Ethernet (Wired) ====

{{Expand|Documentation on Ethernet (Wired) internet setup needs to be created/expanded, maybe information from other wiki's/docs might be helpful?}}

* [[Ethernet|Ethernet]]
* [[NetworkManager]]

 

== Creating a new standard user account ==

After installing Alpine by default you only get a root account. You will probably want to create an account that is not root,

{{cmd|# adduser <YourUsername>}}
{{Note|replace <YourUsername> with the username of your choice}}

 

You will probably want to install '''doas''' so you can allow <YourUsername> to use root privileges:

{{cmd|# apk add doas}}

 

If you want your user to be able to use root privileges, first add them to the '''wheel''' group:

{{cmd|# adduser <YourUsername> wheel}}

 

You will then want to allow members of the '''wheel''' group to use root privileges with '''doas'''. To do this, open the '''doas''' config file:

{{cmd|# <editor> /etc/doas.d/doas.conf}}

Add the following line and save the file:

{{cmd|permit persist :wheel}}

 

To switch to your new account, type '''exit''' in the shell and login as the new user.

 

==== Groups ====

Groups are needed for certain operations on your system (e.g <code>audio</code> to manage your system audio). Below is a list of groups:
{{Note|may be incomplete, if you see a group missing please add it along with a description}}

{{Cmd|disk:x:6:root,adm Only if need usage with virtual machines and access to other partitions over new disks for
lp:x:7:lp If you need use printing services and printers management
floppy:x:11:root Backward compatible group, use only if need access to external special devices
audio:x:18: Need for audio listening and management of sound volumes as normal user
cdrom:x:19: For access to disk writers and mounting DVD, BR or CD-ROM disk as normal user
dialout:x:20:root Need for dial private connections and use of modems as normal users
tape:x:26:root Need this if planning to use special devices for backup. Rarely used on servers
video:x:27:root For usage of cameras, more than one GPU special features, as normal user
netdev:x:28: For network connections management as normal user
kvm:x:34:kvm Only if as normal user will manage graphically virtual machines. Rarely used on servers
games:x:35: Need if you want to play games also especially needed to share score between users
cdrw:x:80: To write RW-DVD, RW-BR or RW-CD disk on a disk writing device
apache:x:81: Need if you will perform development as normal user and want to publish locally on web server
usb:x:85: Need to access to special USB devices, deprecated group
users:x:100:games If you plan to used common files for all users, mandatory as desktop usage
input:x:23 Needed if you want your mouse and keyboard to work in a graphical desktop environment (xorg only? idk) }}
 

To add your user to a group use the following command:

{{Cmd|# adduser <YourUsername> <group>}}
{{Note|you need to log out for the group change(s) to take effect}}

 

== Repositories ==

The Alpine software repositories have three branches:

* '''Main''': Main packages are the Alpine software that have direct support and updates from the Alpine core and main team. They also have official special documentation, are always available for all releases and will have substitutions if some are not continued from upstream. Commonly, those packages are selected due to their responsibility and stability with respect to upstream availability. When those in ''testing'' perform well or are mature, they go to the ''main'' branch.
* '''Community''': Community packages are those made by users in concert with the official developers and integrated into the Alpine packages. They are user supported. Support could end if the user ends support with respect to Alpine work. For example, could not include substitution in next release due to lack of support by the upstream author. They are in ''edge'', and when accepted, go to the ''community'' branch.
* '''Edge''': New packages come into testing repositories of the edge Alpine version and are those made by any contributor or manpower on Alpine. The edge contains unstable current development content. This branch has no release linked or related to Alpine. They are in ''testing'' and when accepted, go to the ''community'' branch.

 

By default only the '''main''' repository is enabled. Most users will probably want to enable the '''community''' repository. To enable a repository, remove the '''#''' in front of the URL along with any blank space.

 

(Example) Disabled:
{{cat|/etc/apk/repositories|#http://dl-cdn.alpinelinux.org/alpine/v3.15/community}}

(Example) Enabled:
{{cat|/etc/apk/repositories|http://dl-cdn.alpinelinux.org/alpine/v3.15/community}}

 

To edit the repositories, open the <code>/etc/apk/repositories</code> file in a text editor:

{{cmd|# <editor> /etc/apk/repositories}}

 

Example default configuration:

{{cat|/etc/apk/repositories|#/media/cdrom/apks
http://dl-cdn.alpinelinux.org/alpine/v3.15/main
# http://dl-cdn.alpinelinux.org/alpine/v3.15/community
#http://dl-cdn.alpinelinux.org/alpine/edge/main
#http://dl-cdn.alpinelinux.org/alpine/edge/community
#http://dl-cdn.alpinelinux.org/alpine/edge/testing}}

{{Note|The edge repositories contain unstable and/or possibly untested packages. Use at your own risk!}}

 

To avoid having to manually update the verison in '''/etc/apk/repositories''' for each Alpine Linux update, change '''v3.15''' to '''latest-stable'''.

Example:
{{cat|/etc/apk/repositories|#/media/cdrom/apks
http://dl-cdn.alpinelinux.org/alpine/latest-stable/main
http://dl-cdn.alpinelinux.org/alpine/latest-stable/community
#http://dl-cdn.alpinelinux.org/alpine/edge/main
#http://dl-cdn.alpinelinux.org/alpine/edge/community
#http://dl-cdn.alpinelinux.org/alpine/edge/testing}}

{{Note|Changing the repositories to latest-stable may initiate unexpected release upgrades. Do this at your own risk!}}

 

For [https://en.wikipedia.org/wiki/HTTPS#Technical security reasons], it may be a good idea to change the url's from '''http''' to '''https'''

Example:
{{cat|/etc/apk/repositories|#/media/cdrom/apks
https://dl-cdn.alpinelinux.org/alpine/v3.15/main
https://dl-cdn.alpinelinux.org/alpine/v3.15/community
#https://dl-cdn.alpinelinux.org/alpine/edge/main
#https://dl-cdn.alpinelinux.org/alpine/edge/community
#https://dl-cdn.alpinelinux.org/alpine/edge/testing}}

{{Note|Some Alpine Linux package mirrors may not support HTTPS. If that is the case, you will need to revert back or change mirrors.}}

 

Once you have edited '''/etc/apk/repositories''', sync the repositories with:

{{cmd|# apk update}}

 

== Installing a Display Server (for graphical sessions) ==

==== Xorg ====
Most desktop environments (DE) or Windows Managers (WM) require Xorg (also called: X11, X). While in the future many will fully migrate to [[Wayland]], currently Xorg is still widely used.

 

There are two ways you can get Xorg installed.

 

By default Alpine Linux provides a script that will install Xorg. Run the following command to install Xorg:
{{cmd|# setup-xorg-base}}

or

{{cmd|# apk add xorg-server xorg-server-common xorg-server-dev xorgproto xorgxrdp xorgxrdp-dev}}
{{Note| the apk add method is probably incomplete}}

 

==== Wayland ====
''See also: [[Wayland]]''

{{Expand|Wayland documentation needs to be expanded}}

 

== Fonts ==

If you plan to use a graphical desktop environment, you may need/want to install fonts.
{{Note|depending on the desktop environment/window manager fonts may or may not be installed automatically or as dependencies}}

'''See: [[Fonts|Fonts]]'''

 

== Installing a desktop environment or window manager ==

'''See: [[Desktop environments and Window managers]]'''

 

== Sound ==

By default Alpine does not come with any sound management out of the box. These are your options:

* [[PipeWire]]
* [[PulseAudio]]
* [[ALSA]]

{{Note|If you are unsure, {{Pkg|pipewire}} is the recommended option}}

 

== Language support ==

{{Expand}}

* Fix unicode defaults: <code>sed -i 's/#unicode="NO"/#unicode="NO"\nunicode="YES"/' /etc/rc.conf</code>
* <code>apk add musl-locales</code> Installs a limited set of locales (languages) for musl (C library) generated console messages.
* Listing defined locales is possible with <code>locale -a</code>
* <code>cp /etc/profile.d/locale.sh /etc/profile.d/locale.sh.sh</code> Copies the default locale settings. Then the custom override file can be edited <code>nano /etc/profile.d/locale.sh.sh</code>.
* <code>apk add lang</code> Pulls in the translation packages of all installed packages.
* <code>apk list hunspell*</code> To list available hunspell dictionary packages.
* <code>apk list *-xy *-xy-*</code> To list translation packages for your specific (xy) language (for example, pt for Portuguese).

 

== Miscellaneous ==

Some other miscellaneous things that might be useful:

==== Basic tools ====

Alpine is a minimalist Linux distribution. If you expected a behavior like other Linux distributions, the similarity to them will be minimal at best. To install a selection of commonly used packages, run:

{{Cmd|# apk add sed attr dialog bash bash-completion grep util-linux pciutils usbutils binutils findutils readline lsof less nano curl}}

{{Cmd|<nowiki>$ export PAGER=less</nowiki>}}

 

== Troubleshooting ==

==== I don't have permission to do anything in my user's home directory! ====

By default the permissions of your new user(s) home directory may be limited to the root account. Run one of these commands to change that:

{{cmd|# chown <YourUserName> /home/<YourUserName> && chmod 700 /home/<YourUsername>}}

or

{{cmd|# chown <YourUserName> /home/<YourUserName> && chmod 750 /home/<YourUsername>}}

 

== See also ==
* [[Installation]]
* [[Alpine newbie]]
* [[Comparison with other distros]]

[[Category:Newbie]]
[[Category:Installation]]

Alpine Linux:FAQ

2022-03-16T19:56:04Z

Viridian: Fix formatting, tweak wording

[[Image:filetypes.svg|64px|left|link=]]
This is a list of '''frequently asked questions''' about Alpine Linux. 
If your question is not answered on this page, use the search box above to find work in progress pages not linked here, or in case of no answer, edit this page and write down your question.
{{Tip| Prepare your question. Think it through. Make it simple and understandable.}}

=General=

Alpine Linux is used heavily in containers (e.g. Docker images) on servers, so many of its main packages are focused on server services.

== Where to start? ==

The [[Installation]] page and [[Post_installation|Post installation]] page provide a basic orientation.

A broader overview may be found on the official [https://alpinelinux.org/about About] page and at the [[Alpine Linux:Overview|wiki overview]].

Please note that testing is safer on your own virtual machine or on a public [https://distrotest.net/AlpineLinux/ DistroTest.net].

== I have found a bug, where can I report it? ==

You can report it on the [https://gitlab.alpinelinux.org/groups/alpine/-/issues bugtracker], but search it first to see if the issue has already been reported.

== Are there any details about the releases available? ==
Yes, please check the [https://alpinelinux.org/releases/ releases] page.

== How can I contribute? ==
You can contribute by:
* Using the software and giving feedback.
* Documenting your [https://www.alpinelinux.org Alpine Linux] experiences on this [[Main_Page|wiki]].
* In many other ways.
Please visit [[Contribute|Contribute page]] to read more about this topic.

== Why don't I have man pages or where is the 'man' command? ==
The <code>man</code> command and '''man pages''' are not installed by default.

Install the <code>man</code> command:
{{cmd|# apk add mandoc}}
Install basic manual pages. {{pkg|man-pages}} package provides the system's ''core'' manual pages:
{{cmd|# apk add man-pages}}
Install the <code>apropos</code> command to search in '''man pages''':
{{cmd|# apk add mandoc-apropos}}
Once installed, add documentation for the package where you need it. For example, say you installed {{pkg|nftables}} and you now require its '''man pages''':
{{cmd|# apk add nftables-doc}}
To always install the documentation companion package add the {{pkg|docs}} meta package. Keep in mind not all packages have a corresponding documentation package and even when it has one it may not include '''man pages''':
{{cmd|# apk add docs}}

== What is the difference between edge and stable releases? ==
Stable releases are just what they sound like: initially a point-in-time snapshot of the package archives, but then maintained with bugfixes only in order to keep a stable environment.

[[Edge]] is more of a rolling-release, with the latest and greatest packages available in the online repositories. 
Occasionally, snapshot ISO images of the then-current state of [[edge]] are made and are available for download. 
Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.

== What architectures does Alpine support? ==
As Alpine uses the Linux kernel, it supports:
* '''aarch64''': The 64-bit only ARM execution state of the ARMv8 device machines.
* '''armhf''': The newer ARM hard-float for newer, more powerful 32-bit devices alongside 64-bit
* '''armv7''': The 32-bit only ARM execution state of the ARMv7 devices machines.
* '''s390x''': For the Super powered IBM mainframes, especially IBM Z and IBM LinuxONE servers.
* '''ppc64le''': For 64-bit PowerPC devices with pure little-endian mode, mostly for POWER8 and POWER9
* '''x86''': (i386, PC 32bit) and x86_64 (i686, PC 64bit and amd64)
* '''x86_64''': The popular AMD64 compatible 64-bit x86 based machines, i386 is not recommended for newer/latest hardware.

'''Please check [https://alpinelinux.org/downloads Download] page for media availability on each one''' and check [[Alpine_Linux:Releases|Releases]] pages for latest.

== What kinds of release of Alpine Linux are available? ==
Please check the [https://alpinelinux.org/releases/ Releases] page for more information.

=Setup=

== What is the difference between ''sys'', ''data'', and ''diskless'' when running <code>setup-alpine</code> or <code>setup-disk</code>? ==

'''sys:''' This mode is a traditional disk install. The following partitions will be created on the disk: ''/boot/'', ''/'' (filesystem root) and ''swap''.
This mode may be used for development boxes, desktops, virtual servers, etc.

'''data:''' This mode uses your disk(s) for data storage, not for the operating system. Runs from the media and only a ''/var/'' is created on disk. The system itself will run from a ''tmpfs'' (RAM). Use this mode if you only want to use the disk(s) for data, like ''mailspool'', ''databases'', ''logs'', etc.

'''diskless:''' No disks are to be used. [[Alpine local backup]] may still be used in this mode.

These modes are explained further on the [[Installation#Installation_Overview|'''Installation''']] page.

== How do I upgrade Alpine? ==

To upgrade to a new stable release or edge:
<code>apk upgrade --available</code>

==Why don't my cron jobs run?==

Start service ''crond'' and add it to runlevel:

: {{cmd|rc-service crond start && rc-update add crond}}

After that the cron daemon is started automatically on system boot and executes the scripts placed in the folders under ''/etc/periodic/'' - there are folders for ''15min'', ''hourly'', ''daily'', ''weekly'' and ''monthly'' scripts.

To check whether your scripts are likely to run, use the ''run-parts'' command, for example:

: {{cmd|run-parts --test /etc/periodic/15min}}

This command will tell you what should run but will not actually execute the scripts.

If the results of the test are not as expected, check the following:

* Make sure the script is executable - if unsure, issue the command {{cmd|chmod a+x /etc/periodic/[path/scriptname]}}
* Make sure the first line of your script is <code>#!/bin/sh</code>
* Do not use periods on your script file names - this stops them from working; for example: {{Path|/etc/periodic/daily/myscript}} will run, but {{Path|/etc/periodic/daily/myscript.sh}} won't.

= Time and timezones =

== How do I set the local timezone? ==

If you wish to edit the ''timezone'' (TZ) after installation, run the [[Alpine_setup_scripts#setup-timezone|setup-timezone]] script.

= Packages =

== Can you build an apk package for ...? ==
Yes, we probably can. 
Please create a [https://gitlab.alpinelinux.org/alpine/aports/issues/new issue] in the [https://gitlab.alpinelinux.org bugtracker]. Prefix it with "feat" in the title and include a short description (one-line), a URL for the home page, and a URL for the source package.

== How can I build my own package? ==
Please see the [[Creating an Alpine package]] page.

== What does "required by: world[$pkgname]" mean? ==

It means that the package you try to install does not exist in the repositories you have configured.

Maybe you forgot to add community, testing or unmaintained to ''/etc/apk/repositories''?

Or is the package in a [[Alpine_Linux_package_management#Repository_pinning|pinned repository]] and you forgot to suffix the package with the repo tag? Example:

{{cmd|apk add experimental-package@testing}}

== How can I find out if a certain package exists in Alpine? ==

If you want to only search repositories you have configured in /etc/apk/repositories, then <code>apk search $pkgname</code> should get you sorted. If you want to search all repositories have a look at the [https://pkgs.alpinelinux.org/ online pkg oracle]

== WARNING: Ignoring APKINDEX.xxxx.tar.gz ==
If you get <code>WARNING: Ignoring APKINDEX.xxxx.tar.gz: No such file or directory</code> while running [[Alpine_Linux_package_management|package related tools]], check your {{Path|/etc/apk/repositories}} file.

To check the content of the repositories file
{{Cmd|cat /etc/apk/repositories}}

or
{{Cmd|setup-apkrepos}}

= Dynamic DNS =
== How do I schedule a regular dynamic DNS update? ==
You'll want to install the {{pkg|ez-ipupdate}} package:
{{cmd|apk add ez-ipupdate}}

After that, create a new file at {{path|/etc/ez-ipupdate.conf}} with contents similar to:
service-type=dyndns
user=myusername:mypassword
interface=eth1
host=myhostname.dyndns.org

Make the new ip cache directory:
{{cmd|mkdir /var/cache/ez-ipupdate
lbu add /var/cache/ez-ipupdate}}

Then schedule a new cron job with this command:
{{cmd|echo >> /var/log/ez-ipupdate && \ /bin/date >> /var/log/ez-ipupdate && \ ez-ipupdate --config-file /etc/ez-ipupdate.conf -f -F /var/run/ez-ipupdate.pid \ --cache-file /var/cache/ez-ipupdate/ipcache --quiet >> /var/log/ez-ipupdate 2>&1}}

Don't forget to backup your settings!
{{cmd|lbu ci}}

= Terminal =

== How to enable/fix colors for git? ==

The problem is not in git itself or terminal, but in the <tt>less</tt> command.
Busybox’s <tt>less</tt> doesn’t support <tt>-r</tt> (<tt>--raw-control-chars</tt>) and <tt>-R</tt> (<tt>--RAW-CONTROL-CHARS</tt>) options.

The simplest (yet not ideal) solution is to install GNU less:

{{cmd|apk add less}}

= Old questions, no longer frequently asked =

== Alpine freezes during boot from Compact Flash, how can I fix? ==
Most Compact Flash card readers do not support proper DMA. 
You should append '''nodma''' to the ''append'' line in {{path|syslinux.cfg}}.

== How do I remove the CDROM? ==
Since the modloop loopback device is on CDROM you cannot just run <code>eject</code>. You need to unmount the modloop first. 
Unmounting both the modloop and the CDROM in one step can be done by executing:
{{Cmd|/etc/init.d/modloop stop}}

Then it's possible to eject the CDROM:
{{Cmd|eject}}

== How can I install a custom firmware in a diskless system? ==

The modules and firmware are both special images which are mounted as read-only. 
To fix this issue you can copy the firmware directory to your writeable media (cf/usb) and copy your custom firmware to it. 
After reboot Alpine should automatically use the directory on your local storage instead of the loopback device.

== How do I play my .ogg/.mp3 files? ==
First, the sound card should be recognized (you must have {{path|/dev/snd/*****}} files)

{{pkg|sox}}, {{pkg|mpg123}}, etc all use the oss sound driver, while Alpine uses ALSA drivers. 
So you need to load the snd-pcm-oss compatibility module. 
While you're at it, you might need {{pkg|aumix}} to turn up the sound volume
{{cmd|echo snd-pcm-oss >> /etc/modules
modprobe snd-pcm-oss
apk_add aumix sox
aumix (set volume settings)
play really_cool_song.mp3}}

== OpenNTPD reports an error with "adjtime" ==
Your log contains something like:
reply from 85.214.86.126: offset 865033148.784255 delay 0.055466, next query 32s
reply from 202.150.212.24: offset 865033148.779314 delay 0.400771, next query 3s
adjusting local clock by 865033148.779835s
adjtime failed: Invalid argument

{{pkg|openntpd}} is supposed to make small adjustments in the time without causing time jumps. 
If the adjustment is too big then something is clearly wrong and ntpd gives up. (its actually adjtime(3) that has a limit on how big adjustments are allowed)

You can make ntpd set the time at startup by adding ''-s'' option to ntpd. This is done by setting '''NTPD_OPTS="-s"''' in {{path|/etc/conf.d/ntpd}}.

== Using a cron job to keep the time in sync ==
Add the following to {{path|/etc/periodic/daily}} (or use another folder under the {{path|/etc/periodic}} heirarchy if you want to run the script more/less frequently)

Example: file called {{path|do-ntp}}
<pre>
#!/bin/sh
ntpd -d -q -n -p uk.pool.ntp.org</pre>

This queries the uk time server pool - you can modify this to suit your localisation, or just use ''pool.ntp.org''. More info here: [http://www.pool.ntp.org/zone/@ http://www.pool.ntp.org/zone/@]

== Windows clients reports an error when trying to sync ==
{{pkg|openntpd}} needs to run for a while before it is satisfied it is in sync.
Until then it will set a flag "clock not synchronized" and Windows will report an error while trying to sync with your {{pkg|openntpd}} server.

Only thing to do is wait, do something else for 15-20mins and then check.

[[Category:Newbie]]