Alpine configuration management scripts - Revision history

John3-16: /* setup-alpine */ 1. Added "-e Empty root password" option; 2. Described "-q quick mode"; 3. Elaborated descriptions and amended style for various other options

2025-12-05T23:46:22Z

setup-alpine: 1. Added "-e Empty root password" option; 2. Described "-q quick mode"; 3. Elaborated descriptions and amended style for various other options

← Older revision		Revision as of 23:46, 5 December 2025
Line 30:		Line 30:
	<code>setup-alpine</code> itself accepts the following command-line switches:		<code>setup-alpine</code> itself accepts the following command-line switches:

	~~{{Define\|-h\|Shows the up-to-date usage help message.}}~~		;-a <var>Create an overlay file</var>
			: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.
	~~{{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 [/path/to/] <var>Create a skeletal answerfile</var>
	;-c <var>answerfile</var>		:Creates a new answerfile with default, preliminary values and with your stated filename. You can edit the file and then invoke <code>setup-alpine -f <var>/path/to/answerfile</var></code>.
	:~~Create~~ a new answerfile with default ~~choices~~. You can edit the file and then invoke <code>setup-alpine -f <var>answerfile</var></code>.		;-e <var>Create an empty root password</var>
	;-f <var>answerfile</var>		:This would erase any that preexisted, making it empty. '''''Not recommended in general use cases''''' in terms of security.
	: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.		;-f [/path/to/] <var>Run setup with stated answerfile</var>
	~~{{Define\|~~-q\|Run in "quick mode".}}		:Use an existing answerfile, which would 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 uration if one is not already active.
			;-h <var>Shows the up-to-date usage help message</var>
			;-q <var>Run in "quick mode"</var>
			:This mode will <b>not</b> prompt for:
			:* creating a root password but rather erase any that preexisted – '''''Not recommended in general use-cases'''''; equivalent to '''-e''' option ({{ic\|empty_root_password{{=}}1}}). Consider assigning root password thereafter.
			:* configuring timezone
			:* creating HTTP/FTP proxy
			:* creating '''SSH'''
			:* NTP synchronization ('''OpenNTPD'''/'''chrony''', etc.)
			:* disk configuration – no disk set up in "sys" nor "data" mode
			:* configuring local backup (''lbu'')
			:* configuring ''apk cache'' location
	<br>		<br>

John3-16: "fully-non-interactive setup-disk" moved /#Environment Variables/ from Using_an_answerfile_with_setup-alpine#Answerfile_Variables with relevant adjustments

2025-11-29T18:03:24Z

"fully-non-interactive setup-disk" moved #Environment Variables: from Using_an_answerfile_with_setup-alpine#Answerfile_Variables with relevant adjustments

← Older revision		Revision as of 18:03, 29 November 2025
Line 290:		Line 290:

	If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.		If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.

			'''Fully non-interactive''' {{ic\|setup-disk}}: {{ic\|setup-disk}} prompts to confirm whether to erase your stated target media even with the ''-m'' option and its target path being set. For a non-interactive process, prepend {{ic\|ERASE_DISKS}} as a command-line environment variable. Use the following instruction '''with caution''' and when ready to execute, as it will '''''immediately initiate''''' the {{ic\|setup-disk}} instruction, including '''erasing the target media''' with '''''no user interaction'''''. For example, if {{Path\|/dev/mmcblk9999}} is the target and ''sys'' is the mode:

			::<code>ERASE_DISKS=<var>/dev/mmcblk9999</var> setup-disk -m sys <var>/dev/mmcblk9999</var></code>

			Remember that the path very possibly may change after a reconfiguration, say, if a media is removed or moved after reboot. For safety, in ''all cases'', ensure that the target path is correctly identified, as '''''an incorrect path is bound to cause an unintended erasure of media'''''. Consider consulting {{ic\|fdisk -l}} beforehand, for example, on the media that will run the {{ic\|setup-disk}} instruction.

	<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->		<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->

Prabuanand: removed the recently added content to avoid duplication with answerfile page

2025-11-29T15:15:24Z

removed the recently added content to avoid duplication with answerfile page

← Older revision		Revision as of 15:15, 29 November 2025
Line 290:		Line 290:

	If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.		If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.
	~~{{Pill\|\|v≥3.23\|green\|palegreen}}~~
	~~If <code>DEFAULT_DISK</code> is specified (device name) and none are set in command-line, that disk is proposed by default in dialogs for use.~~
	~~{{Pill\|\|v≥3.23\|green\|palegreen}}~~
	If <code>ERASE_DISKS</code> is specified (full device path), that disk will be processed without user confirmation dialog (no dialogs if command-line target set same i.e <code>ERASE_DISKS=/dev/sda setup-disk -m sys /dev/sda</code>).

	<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->		<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->

Prabuanand: minor fixing of typos to add clarity

2025-11-29T14:41:39Z

minor fixing of typos to add clarity

Prabuanand: added note on options that have been recently enabled for working non-interactively, updted wikilinks

2025-11-29T13:47:14Z

added note on options that have been recently enabled for working non-interactively, updted wikilinks

← Older revision		Revision as of 13:47, 29 November 2025
Line 7:		Line 7:
	This is the main Alpine configuration script used during [[Installation]].		This is the main Alpine configuration script used during [[Installation]].

	The script interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below.		The script when invoked without arguments interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below. The script can also be used non-interactively [[Using an answerfile with setup-alpine\|using an answerfile]].

	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).		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).
Line 293:		Line 293:

	If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.		If <code>MBR</code> is specified, sets the Path of MBR binary code. For syslinux, defaults to {{Path\|/usr/share/syslinux/mbr.bin}}.
			{{Pill\|\|v≥3.23\|green\|palegreen}}
			If <code>DEFAULT_DISK</code> is specified (device name) and none are set in command-line, that disk is proposed by default in dialogs for use.
			{{Pill\|\|v≥3.23\|green\|palegreen}}
			If <code>ERASE_DISKS</code> is specified (full device path), that disk will be processed without use confirmation dialog (no dialogs if command-line target set same).

	<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->		<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->

	=== Partitioning ===		=== Partitioning ===

	{{Main\|Setting up disks manually}}		{{Main\|Setting up disks manually}}
	If you have complex partitioning needs, that go beyond [[#Environment Variables\|environment variables]] for <code>setup-alpine</code>, 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.		If you have complex partitioning needs, that go beyond [[#Environment Variables\|environment variables]] for <code>setup-alpine</code>, 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.
Line 306:		Line 311:

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

Line 441:		Line 447:

	=== setup-mta ===		=== setup-mta ===

	Uses ssmtp.		Uses ssmtp.

Line 448:		Line 455:

	=== setup-acf ===		=== setup-acf ===

	:<code>setup-acf</code> [-ahn] [-e email] [-l address] [PACKAGE...]		:<code>setup-acf</code> [-ahn] [-e email] [-l address] [PACKAGE...]

Line 468:		Line 476:
	See [[:Category:ACF\|ACF pages]] for more information.		See [[:Category:ACF\|ACF pages]] for more information.

	= See also =		== See also ==

	* [[Installation]]		* [[Installation]]
	* [[~~Installation#Post~~-~~Install~~\|~~Post Install~~]]		* [[Using an answerfile with setup-alpine\|Non-interactive Installation using an answerfile]]

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

John3-16: /* setup-apkrepos */ 1. Added option "-o Only enable a community repo for every defined repo"; 2. Added sample cli for both adding both community repo and fastest mirror

2025-11-24T03:21:01Z

setup-apkrepos: 1. Added option "-o Only enable a community repo for every defined repo"; 2. Added sample cli for both adding both community repo and fastest mirror

← Older revision		Revision as of 03:21, 24 November 2025
Line 159:		Line 159:
	'''-1''' <var>Add first mirror on the list (normally a CDN)</var>		'''-1''' <var>Add first mirror on the list (normally a CDN)</var>

			Therefore, say, to add the fastest mirror and its community repo:
			{{Cmd\|setup-apkrepos -cf}}
	This is run as part of the <code>setup-alpine</code> script.		This is run as part of the <code>setup-alpine</code> script.

	<br>		<br>

John3-16: /* setup-apkrepos */ added option Only enable a community repo for every defined repo"

2025-11-24T03:14:29Z

setup-apkrepos: added option Only enable a community repo for every defined repo"

← Older revision		Revision as of 03:14, 24 November 2025
Line 152:		Line 152:

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

			'''-o''' <var>Only enable a community repo for every defined repo</var>

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

Prabuanand: added documentation for update-conf

2025-11-15T04:11:00Z

added documentation for update-conf

@@ Line 1: / Line 1: @@
-Feature descriptions for available Alpine Linux setup scripts ({{Path|/usr/sbin/setup-*}}).
+The {{pkg|alpine-conf}} package containing the Alpine configuration management scripts is part of base installation of [[Alpine Package Keeper]] when installing Alpine Linux. Most of these scripts can be understood by examining them at ({{Path|/usr/sbin/}}). Feature descriptions for available Alpine Linux setup scripts ({{Path|/usr/sbin/setup-*}}).
 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].
@@ Line 420: / Line 418: @@
 This script is used to set up a desktop environment. This is a replacement for the now-removed <code>alpine-desktop</code> package.
 {{:Include:Setup-desktop}}
 == Documentation needed ==

Prabuanand: Prabuanand moved page Alpine setup scripts to Alpine configuration management scripts: Tools cover more than setup scripts, the new title is more appropriate

2025-11-15T03:54:57Z

Prabuanand moved page Alpine setup scripts to Alpine configuration management scripts: Tools cover more than setup scripts, the new title is more appropriate

← Older revision	Revision as of 03:54, 15 November 2025
(No difference)

Prabuanand: changed case

2025-10-23T03:52:46Z

changed case

← Older revision		Revision as of 03:52, 23 October 2025
Line 285:		Line 285:
	*512 MB if the total disk size is greater than 8 GB		*512 MB if the total disk size is greater than 8 GB

	If <code>ROOT_SIZE</code> is specified, sets the size of the ~~Root~~ partition in MB; defaults to 100% of remaining free space. Only used if '''-m sys''' is specified or interactively selected.		If <code>ROOT_SIZE</code> is specified, sets the size of the root partition in MB; defaults to 100% of remaining free space. Only used if '''-m sys''' is specified or interactively selected.

	If <code>SWAP_SIZE</code> is specified, sets the 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.		If <code>SWAP_SIZE</code> is specified, sets the 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.

← Older revision		Revision as of 14:41, 29 November 2025
Line 5:		Line 5:
	== setup-alpine ==		== setup-alpine ==

	This is the main Alpine configuration script used during [[Installation]].		This is the main Alpine configuration script used during [[Installation]]. This script interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below. This script can also be used non-interactively [[Using an answerfile with setup-alpine\|using an answerfile]].

	~~The~~ script ~~when invoked without arguments~~ interactively walks the user through executing several auxiliary <code>setup-*</code> scripts, in the order shown below. ~~The~~ script can also be used non-interactively [[Using an answerfile with setup-alpine\|using an answerfile]].

	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).		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).
Line 26:		Line 24:
	# if not in quick mode, then: <code>[[#setup-sshd\|setup-sshd]]</code> [-c openssh \| dropbear \| none]		# 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>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 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\|Installation Overview]] about the disk modes)
	# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-lbu</code> [{{Path\|/media/sdb1}}]		# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-lbu</code> [{{Path\|/media/sdb1}}]
	# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-apkcache</code> [{{Path\|/media/sdb1/cache}} \| none]		# if installation mode selected during setup-disk was "data" instead of "sys", then: <code>setup-apkcache</code> [{{Path\|/media/sdb1/cache}} \| none]


	<code>setup-alpine</code> itself accepts the following command-line switches:		<code>setup-alpine</code> itself accepts the following command-line switches:
Line 296:		Line 293:
	If <code>DEFAULT_DISK</code> is specified (device name) and none are set in command-line, that disk is proposed by default in dialogs for use.		If <code>DEFAULT_DISK</code> is specified (device name) and none are set in command-line, that disk is proposed by default in dialogs for use.
	{{Pill\|\|v≥3.23\|green\|palegreen}}		{{Pill\|\|v≥3.23\|green\|palegreen}}
	If <code>ERASE_DISKS</code> is specified (full device path), that disk will be processed without ~~use~~ confirmation dialog (no dialogs if command-line target set same).		If <code>ERASE_DISKS</code> is specified (full device path), that disk will be processed without user confirmation dialog (no dialogs if command-line target set same i.e <code>ERASE_DISKS=/dev/sda setup-disk -m sys /dev/sda</code>).

	<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->		<!-- Writes to /tmp/ovlfiles, /tmp/alpine-install-diskmode.out, and /tmp/sfdisk.out but that never seems to be used elsewhere. -->
Line 348:		Line 345:

	== setup-devd ==		== setup-devd ==

	This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually to setup a [[Device Manager\|Device manager]].		This is a standalone script; it's not invoked by <code>setup-alpine</code> but must be run manually to setup a [[Device Manager\|Device manager]].
	{{Cmd\|usage: setup-devd [ -h ] [ -C ] [ mdev {{!}} mdevd{{!}} udev ]		{{Cmd\|usage: setup-devd [ -h ] [ -C ] [ mdev {{!}} mdevd{{!}} udev ]
Line 367:		Line 365:

	== setup-bootable ==		== setup-bootable ==

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

Line 375:		Line 374:
	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.		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!}}		{{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).		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).