Skip to content

Commit c8c85d6

Browse files
authored
Merge pull request #14 from macmpi/dev
Update README.md
2 parents a2d5c8a + 49a9f62 commit c8c85d6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,22 @@
33
[Alpine Linux documentation](https://docs.alpinelinux.org/user-handbook/0.1a/Installing/setup_alpine.html) assumes **initial setup** is carried-out on a system with a keyboard & display to interract with.\
44
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).
55

6-
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.
6+
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.\
7+
An optional script may be launched at startup, to perform automated actions/setup.
78

89

910
## Setup procedure:
1011
Please follow [Alpine Linux Wiki](https://wiki.alpinelinux.org/wiki/Installation#Installation_Overview) to download & create installation media for the target platform.\
1112
Tools provided here can be used on any plaform for any install modes (diskless, data disk, system disk).
1213

13-
Just add [**headless.apkovl.tar.gz**](https://github.com/macmpi/alpine-linux-headless-bootstrap/raw/main/headless.apkovl.tar.gz)[^2] overlay file at the root of Alpine Linux boot media (or onto any custom side-media) and boot-up the system.\
14-
With default network interface definitions (and SSID/pass file if using wifi), system can then be remotely accessed with: `ssh root@<IP>`\
14+
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.\
15+
With default network interface definitions (and [SSID/pass file](#Added-customizations) if using wifi), system can then be remotely accessed with: `ssh root@<IP>`\
1516
(system IP address may be determined with any IP scanning tools such as `nmap`).
1617

1718
As with Alpine Linux initial bring-up, `root` account has no password initially (change that during setup!).\
1819
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).
1920

20-
21+
## Added customizations:
2122
Extra files may be added next to `headless.apkovl.tar.gz` to customise boostrapping configuration (check sample files):
2223
- `wpa_supplicant.conf`[^3] (*mandatory for wifi usecase*): define wifi SSID & password.
2324
- `interfaces`[^3] (*optional*): define network interfaces at will, if defaults DCHP-based are not suitable.
@@ -38,7 +39,7 @@ Main execution steps are logged in `/var/log/messages`.
3839
[^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).
3940

4041

41-
## How to customize ?
42+
## Want to tweak more ?
4243
This repository may be forked/cloned/downloaded.\
4344
Main script file is [`headless.start`](https://github.com/macmpi/alpine-linux-headless-bootstrap/blob/main/overlay/etc/local.d/headless.start).\
4445
Execute `./make.sh` to rebuild `headless.apkovl.tar.gz` after changes.

0 commit comments

Comments
 (0)