Merge pull request #19 from macmpi/dev

version 1.0

Author: macmpi

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 macmpi
+Copyright (c) 2022-2023 macmpi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,45 +4,46 @@
 However, in many cases one might want to deploy a headless system that is only available through a network connection (ethernet, wifi or as USB ethernet gadget).
 
 This repo provides an **overlay file** to initially bootstrap[^1] a headless system (leveraging Alpine distro's `initramfs` feature): it starts a ssh server to log-into from another Computer, so that actual install on fresh system (or rescue on existing disk-based system) can then be performed remotely.\
-An optional script may be launched at startup, to perform automated actions/setup.
+An optional script may also be launched during that same initial bootstrap, to perform fully automated setup.
 
 
 ## Setup procedure:
 Please follow [Alpine Linux Wiki](https://wiki.alpinelinux.org/wiki/Installation#Installation_Overview) to download & create installation media for the target platform.\
 Tools provided here can be used on any plaform for any install modes (diskless, data disk, system disk).
 
-Just add [**headless.apkovl.tar.gz**](https://is.gd/apkovl_master)[^2] overlay file at the root of Alpine Linux boot media (or onto any custom side-media) and boot-up the system.\
-With default network interface definitions (and [SSID/pass file](#extra-configuration) if using wifi), system can then be remotely accessed with: `ssh root@<IP>`\
+Just add [**headless.apkovl.tar.gz**](https://is.gd/apkovl_master)[^2] overlay file *as-is* at the root of Alpine Linux boot media (or onto any custom side-media) and boot-up the system.\
+With default DCHP-based network interface definitions (and [SSID/pass file](#extra-configuration) if using wifi), system can then be remotely accessed with: `ssh root@<IP>`\
 (system IP address may be determined with any IP scanning tools such as `nmap`).
 
-As with Alpine Linux initial bring-up, `root` account has no password initially (change that during setup!).\
+As with Alpine Linux initial bring-up, `root` account has no password initially (change that during target setup!).\
 From there, actual system install can be performed as usual with `setup-alpine` for instance (check [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):
 - `wpa_supplicant.conf`[^3] (*mandatory for wifi usecase*): define wifi SSID & password.
+- `unattended.sh`[^3] (*optional*): provide a deployment script to automate setup & customizations during initial bootstrap.
 - `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[^2] (not stored). Providing an empty key file will trigger new keys generation (ssh server may take longer to start).
-- `unattended.sh`[^3] (*optional*): create custom automated deployment script to further tune & extend actual setup (backgrounded).
 
 
-**Goody:** seamless USB-ethernet gadget boostrapping (PiZero for instance):\
-On supporting Pi devices, just add `dtoverlay=dwc2` in `usercfg.txt` (or `config.txt`), and plug USB cable into Computer port.\
-With Computer set-up to share networking with USB interface as 10.42.0.1 gateway, one can log into device from Computer with: `ssh [email protected]`
+**Goody:** seamless USB-serial & USB-ethernet gadget mode (PiZero for instance):\
+On supporting Pi devices, just add `dtoverlay=dwc2,dr_mode=peripheral` in `usercfg.txt` (or `config.txt`), and plug USB cable into host Computer port.\
+Serial terminal can then be connected-to from host Computer (xon/xoff flow control: e.g. on Linux with `cu -l ttyACM0`).\
+Alternatively, with host Computer set-up to share networking with USB interface as 10.42.0.1 gateway, one can log into device from host with: `ssh [email protected]`.
 
-Main execution steps are logged in `/var/log/messages`.
+Main execution steps are logged: `cat /var/log/messages | grep headless`.
 
 [^1]: Initial boot fully preserves system's original state (config files & installed packages): a fresh system will therefore come-up as unconfigured.
 
-[^2]: 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/etc/ssh) 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).
+[^2]: 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/.trash) 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).
 
 [^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).
 
 
 ## Want to tweak more ?
 This repository may be forked/cloned/downloaded.\
-Main script file is [`headless.start`](https://github.com/macmpi/alpine-linux-headless-bootstrap/blob/main/overlay/etc/local.d/headless.start).\
+Main script file is [`headless.start`](https://github.com/macmpi/alpine-linux-headless-bootstrap/tree/main/overlay/usr/local/bin/headless_bootstrap).\
 Execute `./make.sh` to rebuild `headless.apkovl.tar.gz` after changes.
 
 

headless.apkovl.tar.gz

@@ -1,8 +1,30 @@
-#!/bin/sh
+#!/bin/busybox sh
 
-# Copyright 2022 - 2023, macmpi
+# SPDX-FileCopyrightText: Copyright 2022-2023, macmpi
 # SPDX-License-Identifier: MIT
 
-chmod 600 overlay/etc/ssh/ssh_host_*_key
-chmod +x overlay/etc/local.d/headless.start
-tar czvf headless.apkovl.tar.gz -C overlay etc --owner=0 --group=0
+
+command -v doas > /dev/null || alias doas="/usr/bin/sudo"
+
+build_path="$(mktemp -d)"
+if [ -n "$build_path" ]; then
+	cp -r overlay "$build_path"/.
+	find "$build_path"/overlay/ -exec touch -md "$(date '+%F 00:00:00')" {} \;
+
+	# setting owner/groups for runtime (won't affect mtime)
+	find "$build_path"/overlay/etc -type d -exec chmod 755 {} \;
+	chmod +x "$build_path"/overlay/etc/init.d/*
+	find "$build_path"/overlay/usr -type d -exec chmod 755 {} \;
+	chmod +x "$build_path"/overlay/usr/local/bin/*
+	chmod 777 "$build_path"/overlay/tmp
+	chmod 700 "$build_path"/overlay/tmp/.trash
+	chmod 600 "$build_path"/overlay/tmp/.trash/ssh_host_*_key
+	doas chown -R 0:0 "$build_path"/overlay/*
+
+	doas tar -cvf "$build_path"/headless.apkovl.tar -C "$build_path"/overlay etc usr tmp
+	gzip -nk9 "$build_path"/headless.apkovl.tar && mv "$build_path"/headless.apkovl.tar.gz .
+	touch -md "$(date '+%F 00:00:00')" headless.apkovl.tar.gz
+
+	doas rm -rf "$build_path"
+fi
+

make.sh

@@ -0,0 +1,12 @@
+#!/sbin/openrc-run
+
+# SPDX-FileCopyrightText: Copyright 2022-2023, macmpi
+# SPDX-License-Identifier: MIT
+
+description="Headless main boostrappring script"
+name="Headless bootstrap"
+
+command="/usr/local/bin/headless_bootstrap"
+command_background=true
+pidfile="/run/${RC_SVCNAME}.pid"
+

overlay/etc/init.d/headless_bootstrap

@@ -0,0 +1,12 @@
+#!/sbin/openrc-run
+
+# SPDX-FileCopyrightText: Copyright 2022-2023, macmpi
+# SPDX-License-Identifier: MIT
+
+description="Headless cleanup script"
+name="Headless cleanup"
+
+command="/tmp/.trash/headless_cleanup"
+command_background=true
+pidfile="/run/${RC_SVCNAME}.pid"
+

overlay/etc/init.d/headless_cleanup

@@ -0,0 +1,12 @@
+#!/sbin/openrc-run
+
+# SPDX-FileCopyrightText: Copyright 2022-2023, macmpi
+# SPDX-License-Identifier: MIT
+
+description="Headless unattended setup script (optional)"
+name="Headless unattended"
+
+command="/tmp/headless_unattended"
+command_background=true
+pidfile="/run/${RC_SVCNAME}.pid"
+