Merge pull request #55 from macmpi/dev

Version 1.5

Author: macmpi

README.md

@@ -19,12 +19,12 @@ As with Alpine Linux initial bring-up, `root` account has no password initially.
 From there, actual system install can be performed as usual with `setup-alpine` for instance (check Alpine [wiki](https://wiki.alpinelinux.org/wiki/Alpine_setup_scripts#setup-alpine) for details).
 
 ## Extra configuration:
-Extra files may be added next to `headless.apkovl.tar.gz` to customise boostrapping configuration (check sample files):
+Extra files may be added next to `headless.apkovl.tar.gz` to customise boostrapping configuration (check `sample_*` files):
 - `wpa_supplicant.conf`[^3] (*mandatory for wifi*): define wifi SSID, password and regulatory country [code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
-- `unattended.sh`[^3] (*optional*): provide a deployment script to automate setup & customizations during initial bootstrap.
+- `unattended.sh`[^3] (*optional*): provide a deployment script to automate setup & customizations during initial bootstrap *(check users' contributed [samples](https://github.com/macmpi/alpine-linux-headless-bootstrap/discussions/categories/unattended-sh-samples) and share yours)*.
 - `interfaces`[^3] (*optional*): define network interfaces at will, if defaults DCHP-based are not suitable.
 - `authorized_keys` (*optional*): provide client's public SSH key to secure `root` ssh login.
-- `ssh_host_*_key*` (*optional*): provide server's custom ssh keys to be injected (may be stored), instead of using bundled ones[^4] (not stored). Providing an empty key file will trigger new keys generation (ssh server may take longer to start).
+- `ssh_host_*_key*` (*optional*): provide server's custom ssh keys to be injected (may be stored), instead of using temporarily bundled ones[^4] (not stored). Providing an empty key file will trigger new keys generation (ssh server may take longer to start).
 - `opt-out` (*optional*): dummy file to opt-out internet features (connection status, version check, auto-update) and related links usage anonymous [telemetry](https://is.gd/privacy.php).
 - `auto-updt` (*optional*): enable automatic `headless.apkovl.tar.gz` file update with latest from master branch. If it contains `reboot` keyword all in one line, system will reboot after succesful update (unless ssh session is active or `unattended.sh` script is available).
 
@@ -36,25 +36,24 @@ Seamless USB-gadget mode on capable devices (*e.g. on PiZero*): serial console,
 (on supporting Pi devices, just add `dtoverlay=dwc2,dr_mode=peripheral` in `usercfg.txt` (or `config.txt`) to force both by software)
 - Plug USB cable into host Computer port before booting device.
   - serial terminal can then be connected-to from host Computer (e.g. `cu -l ttyACM0` on Linux. xon/xoff flow control).
-  - alternatively, with host Computer ECM/RNDIS interface set-up as 10.42.0.1 (sharing internet or not), one can log into device from host with: `ssh [email protected]`.
+  - alternatively, with host Computer ECM/RNDIS interface set-up as `10.42.0.1` (sharing internet or not), one can log into device from host with: `ssh [email protected]`.
   - volume containing `headless.apkovl.tar.gz` file may be accessed/mounted from host, and config files easily edited. Make sure to unmount properly before removing USB plug.
 
 _Note:_ optionally, same USB-gadget feature may be easily enabled on final system by installing `xg_multi` Alpine [package](https://pkgs.alpinelinux.org/packages?name=xg_multi&branch=edge&repo=&arch=&origin=&flagged=&maintainer=) and service during system setup phase (refer to [`xg_multi`](https://github.com/macmpi/xg_multi/) project).
 
+##
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/macmpi)
+
 ## Want to tweak more ?
 This repository may be forked/cloned/downloaded.\
 Main script file is [`headless_bootstrap`](https://github.com/macmpi/alpine-linux-headless-bootstrap/tree/main/overlay/tmp/.ALHB/headless_bootstrap).\
 Execute `./make_ALHB.sh` to rebuild `headless.apkovl.tar.gz` after changes.\
 (requires `busybox`; check `busybox` build options if not running from Alpine or Ubuntu)
 
-
 ## Credits
 Thanks for the initial guides & scripts from @sodface and @davidmytton.
 
 [^1]: Initial boot fully preserves system's original state (config files & installed packages): a fresh system will therefore come-up as unconfigured.
-
 [^2]: Temporarily remove `root=*` statement from kernel command-line parameters list to disable disk-based boot mode.
-
 [^3]: These files are linux text files: Windows/macOS users need to use text editors supporting linux text line-ending (such as [notepad++](https://notepad-plus-plus.org/), BBEdit or any similar).
-
-[^4]: About bundled ssh keys: this overlay is meant to **quickly bootstrap** system in order to then proceed with proper install; therefore it purposely embeds [some ssh keys](https://github.com/macmpi/alpine-linux-headless-bootstrap/tree/main/overlay/tmp/.ALHB) so that bootstrapping is as fast as possible. Those temporary keys are moved in RAM /tmp: they will **not be stored/reused** once actual system install is performed (whether or not ssh server is installed in final setup).
+[^4]: About temporarily bundled ssh keys: this overlay is meant to **quickly bootstrap** system in order to then proceed with proper install; therefore it purposely embeds [some ssh keys](https://github.com/macmpi/alpine-linux-headless-bootstrap/tree/main/overlay/tmp/.ALHB) so that bootstrapping is as fast as possible. Those temporary keys are in RAM `/tmp`: they **are discarded** once actual system install is rebooted (whether or not ssh server is installed in final setup).

headless.apkovl.tar.gz

@@ -1 +1 @@
-0e29b7d2488c97b144c39a76ca3c0793fbc96e18e6e1c1947896144c9ac38b16ace717208d639d23859d764703c2e7f6e41f7b269f78072b98ac8ce866f1c8a9  headless.apkovl.tar.gz
+3eb47a6f01bfe6ef6a26cd7a7494a8b673b6c745cc62c39633e140642ae32d906713a72c894dbe5290e0fd4f045512dd22811eb041e6d830b54ea40103532454  headless.apkovl.tar.gz

headless.apkovl.tar.gz.sha512

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: Copyright 2022-2025, macmpi
 # SPDX-License-Identifier: MIT
 
-ALHB_VERSION="1.4"
+ALHB_VERSION="1.5"
 
 _apk() {
 	local cmd="$1"
@@ -70,21 +70,7 @@ cat <<-EOF >>/tmp/.ALHB/headless_cleanup
 	rm -f /etc/runlevels/default/headless_bootstrap
 
 	# Run unattended script if available.
-	if install -m755 ${ovlpath}/unattended.sh /tmp/headless_unattended >/dev/null 2>&1; then
-		cat <<-EOF1 >/etc/init.d/headless_unattended
-			#!/sbin/openrc-run
-
-			# SPDX-FileCopyrightText: Copyright 2022-2025, macmpi
-			# SPDX-License-Identifier: MIT
-
-			description="Headless unattended setup script (optional)"
-			name="Headless unattended"
-
-			command="/tmp/headless_unattended"
-			command_background=true
-			pidfile="/run/headless_unattended.pid"
-			EOF1
-		chmod +x /etc/init.d/headless_unattended
+	if [ -f /tmp/headless_unattended ]; then
 		_logger "Starting headless_unattended service"
 		rc-service headless_unattended start
 	fi
@@ -100,7 +86,6 @@ cat <<-EOF >>/tmp/.ALHB/headless_cleanup
 	exit 0
 	EOF
 chmod +x /tmp/.ALHB/headless_cleanup
-
 cat <<-EOF >/etc/init.d/headless_cleanup
 	#!/sbin/openrc-run
 
@@ -115,6 +100,26 @@ cat <<-EOF >/etc/init.d/headless_cleanup
 	pidfile="/run/headless_cleanup.pid"
 	EOF
 chmod +x /etc/init.d/headless_cleanup
+
+if install -m755 ${ovlpath}/unattended.sh /tmp/headless_unattended >/dev/null 2>&1; then
+	cat <<-EOF >/etc/init.d/headless_unattended
+		#!/sbin/openrc-run
+
+		# SPDX-FileCopyrightText: Copyright 2022-2025, macmpi
+		# SPDX-License-Identifier: MIT
+
+		description="Headless unattended setup script (optional)"
+		name="Headless unattended"
+
+		command="/tmp/headless_unattended"
+		command_background=true
+		pidfile="/run/headless_unattended.pid"
+		EOF
+	chmod +x /etc/init.d/headless_unattended
+fi
+
+# force service dependency tree update
+rc-update --update
 }
 
 _setup_sshd() {
@@ -190,9 +195,9 @@ _updt_apkovl() {
 # URL redirects to apkovl file on github master: is.gd shortener provides basic analytics.
 # Analytics are public and can be checked at https://is.gd/stats.php?url=apkovl_master
 # Privacy policy: https://is.gd/privacy.php
-local file_url="https://is.gd/apkovl_master"
-local sha_url="https://github.com/macmpi/alpine-linux-headless-bootstrap/raw/main/headless.apkovl.tar.gz.sha512"
 local updt_status="failed, keeping original version"
+local sha_url="https://github.com/macmpi/alpine-linux-headless-bootstrap/raw/main/headless.apkovl.tar.gz.sha512"
+local file_url="https://is.gd/apkovl_master"
 
 # Ensure system date is correct to allow SSL transactions
 ntpd -N -p pool.ntp.org -n -q
@@ -216,7 +221,7 @@ else
 fi
 # Reboot if specified in auto-updt file (and no ssh session ongoing nor unattended.sh script available).
 ! pgrep -a -P "$( cat /run/sshd.pid 2>/dev/null )" 2>/dev/null | grep -q "sshd: root@pts" && \
-	! [ -f "${ovlpath}"/unattended.sh ] && \
+	! [ -f /tmp/headless_unattended ] && \
 		grep -q "^reboot$" "${ovlpath}"/auto-updt && \
 			_logger "Will reboot in 3sec..." && sleep 3 && reboot
 exit 0
@@ -351,9 +356,6 @@ rc-service networking restart
 exec 1>/dev/console 2>&1
 _logger "Alpine Linux headless bootstrap v$ALHB_VERSION by macmpi"
 
-# Help randomness for wpa_supplicant and sshd (urandom until 3.16).
-rc-service seedrng restart || rc-service urandom restart
-
 # Determine ovl file location.
 # Grab used ovl filename from dmesg.
 ovl="$( dmesg | grep -o 'Loading user settings from .*:' | awk '{print $5}' | sed 's/:.*$//' )"
@@ -375,12 +377,17 @@ if [ -c /dev/ttyGS0 ]; then
 	setconsole /dev/ttyGS0
 fi
 
+_prep_cleanup
 
-# Create banner file.
-warn=""
+# Help randomness for wpa_supplicant and sshd (urandom until 3.16).
+rc-service seedrng restart || rc-service urandom restart
+
+# Detect apkovl volume ro/rw state
 grep -q "${ovlpath}.*[[:space:]]ro[[:space:],]" /proc/mounts; is_ro=$?
 _is_ro() { return "$is_ro"; }
 
+# Create banner file.
+warn=""
 _is_ro && warn="(remount partition rw!)"
 cat <<-EOF >/tmp/.ALHB/banner
 
@@ -400,10 +407,9 @@ _setup_networking
 [ -f "${ovlpath}"/opt-out ] || _tst_version &
 
 # Setup sshd unless unattended.sh script prevents it.
-grep -q "^#NO_SSH$" "${ovlpath}"/unattended.sh >/dev/null 2>&1 \
+grep -q "^#NO_SSH$" /tmp/headless_unattended >/dev/null 2>&1 \
 	|| _setup_sshd
 
-_prep_cleanup
 _logger "Initial setup done, handing-over to clean-up"
 rc-service headless_cleanup start
 exit 0