ashikk
/
alpine-linux-headless-bootstrap
mirror of https://github.com/macmpi/alpine-linux-headless-bootstrap.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Headless Alpine Linux deployment scripts
26 Commits 2 Branches 6 Tags 470 KiB
Shell 100%
Go to file
macmpi 5193a9296b SPDX stuff 2023-05-12 14:04:17 +02:00
overlay/etc SPDX stuff 2023-05-12 14:04:17 +02:00
LICENSE Initial commit 2022-07-08 22:41:32 +02:00
LICENSE.spdx SPDX stuff 2023-05-12 14:04:17 +02:00
README.md allow to inject custom ssh keys 2023-05-11 17:54:12 +02:00
headless.apkovl.tar.gz SPDX stuff 2023-05-12 14:04:17 +02:00
make.sh SPDX stuff 2023-05-12 14:04:17 +02:00
sample_interfaces SPDX stuff 2023-05-12 14:04:17 +02:00
sample_unattended.sh SPDX stuff 2023-05-12 14:04:17 +02:00
sample_wpa_supplicant.conf SPDX stuff 2023-05-12 14:04:17 +02:00

README.md

Deploy Alpine Linux on a headless system

Alpine Linux documentation assumes initial setup is carried-out on a system with a keyboard & display to interract with.
However, there are many cases where one might want to deploy a headless system, only available through a network connection (ethernet, wifi or as USB ethernet gadget).

This repo provides an overlay file to initially boot such headless system (leveraging Alpine distro's initramfs feature): it enables a basic ssh server to log-into from another Computer, in order to finalize system setup.

Install procedure:

Please follow Alpine Linux Wiki 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.gz1 overlay file at the root of Alpine Linux boot media (or onto any custom side-media) and boot the system.

With default network interface definitions (and SSID/pass file if using wifi), one may then access the system under ssh 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 after setup!).
From there, system install can be fine-tuned as usual with setup-alpine for instance (check wiki for details).

Add-on files may be added next to headless.apkovl.tar.gz to customise setup (sample files are provided):

  • wpa_supplicant.conf (mandatory for wifi usecase): define wifi SSID & password.
  • interfaces (optional): define network interfaces at will, if defaults DCHP-based are not suitable.
  • ssh_host_*_key* (optional): provide custom ssh keys to be injected (can be stored), instead of bundled ones1 (not stored).
  • unattended.sh (optional): make custom automated deployment script to further tune & extend setup (backgrounded).

Note: these files are linux text files: Windows/macOS users need to use text editors supporting linux text line-ending (such as notepad++, BBEdit or any other).

Goody: seamless USB bootstrapping for PiZero devices (or similar which can support USB ethernet gadget networking):
Just add dtoverlay=dwc2 in usercfg.txt (or config.txt), and plug-in USB to 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 root@10.42.0.2 !...

Main execution steps are logged in /var/log/messages.

How to customize further ?

This repository may be forked/cloned/downloaded.
Main script file is headless.start.
Execute ./make.sh to rebuild headless.apkovl.tar.gz after changes.

Credits

Thanks for the initial guides & scripts from @sodface and @davidmytton.

  1. About bundled ssh keys: as this package is essentially intended to quickly bootstrap system in order to configure it, it purposely embeds some ssh keys so that bootstrapping is as fast as possible. Those (temporary) keys are moved in RAM /tmp, so they will not be saved/reused once permanent configuration is set (with or without ssh server voluntarily installed in permanent setup). ↩︎