summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-08-13 10:51:23 +0300
committerLars Wirzenius <liw@liw.fi>2023-08-13 12:25:08 +0300
commit25ee42219476595521107bb395beaf32e141d5f5 (patch)
tree20ffcf1f6fa98d4b2a49351975989302e1a6451e
parent265daf6c6f263a0d29ff05edd894fea1a9035618 (diff)
downloadv-i-25ee42219476595521107bb395beaf32e141d5f5.tar.gz
docs(tutorial.md): tidy up and make things smoother for user
We now tell user to run write-and-config.sh using bash, to avoid having to tell user to make the scripts executable. Fix the command to "eject" (power down) installer drive. Fix sample target spec by adding hostname. Also, show how install an SSH key to root's authorized_keys. Show how to pre-configure installer for wifi.a Link to target spec spec from installer. Sponsored-by: author
-rwxr-xr-xpublish-release.sh2
-rw-r--r--tutorial.md23
-rwxr-xr-xwrite-and-config.sh2
3 files changed, 20 insertions, 7 deletions
diff --git a/publish-release.sh b/publish-release.sh
index 741b17b..76c21d3 100755
--- a/publish-release.sh
+++ b/publish-release.sh
@@ -10,7 +10,7 @@ version="$(basename "$dir")"
mkdir "$dir"
xz -0vT0 <"$img" >"$dir/v-i.img.xz"
cp configure-installer write-and-config.sh "$dir/"
-for file in NEWS.md README.md tutorial.md; do
+for file in NEWS.md README.md tutorial.md spec.md; do
sed "s/VERSION/$version/" "$file" >tmp.md
pandoc tmp.md -o "$dir/$(basename "$file" .md).html"
rm tmp.md
diff --git a/tutorial.md b/tutorial.md
index 5ba8ce4..53171f1 100644
--- a/tutorial.md
+++ b/tutorial.md
@@ -39,6 +39,14 @@ The steps:
to log in as `root` using SSH. Password logins are not allowed for
SSH. You can also log in via the console, as `root`, without a
password.
+
+ The installer configuration file can specify a wifi access point to
+ connect to, if you need that.
+
+ ~~~yaml
+ wifi_name: DadItIsThisOne
+ wifi_password: hunter2
+ ~~~
4. Insert USB drive and find out the device allocated it. I prefer GNOME
Disks for this, but you can also look up the device of the USB
@@ -57,8 +65,7 @@ The steps:
prefer GNOME Disks for this, but from the command line:
~~~sh
- sync
- eject /dev/sdx
+ udisksctl power-off -b /dev/sdx
~~~
7. Move the USB drive to the target machine and boot off the drive.
@@ -74,7 +81,7 @@ The steps:
~~~sh
iwctl station wlan0 get-networks
- iwctl stations wlan0 connect DadItIsThisOne
+ iwctl station wlan0 connect DadItIsThisOne
~~~
Substitute the name of the network as needed. Enter wifi password
@@ -86,11 +93,17 @@ The steps:
will be encrypted using LUKS, with the password "hunter2".
~~~yaml
+ hostname: x220
drive: /dev/nvme0n1
luks: hunter2
+ ansible_vars:
+ user_pub: |
+ ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPQe6lsTapAxiwhhEeE/ixuK+5N8esCsMWoekQqjtxjP
~~~
- See [spec.md][] for a full description of the specification file.
+ The SSH public key will be added to the root user's
+ `authorized_keys` file. See [spec.md][] for a full description of
+ the target specification file.
10. Install. Add the `--verbose` option to `./v-i` if you want to know
what's happening. The first time you run this on a given v-i USB
@@ -114,5 +127,5 @@ The steps:
13. Optional: Let me know how it went.
-[spec.md]: spec.md
+[spec.md]: spec.html
diff --git a/write-and-config.sh b/write-and-config.sh
index 1d293d3..a758100 100755
--- a/write-and-config.sh
+++ b/write-and-config.sh
@@ -25,4 +25,4 @@ done
echo
echo "Configure installer"
-./configure-installer "$config" "$dev"
+python3 ./configure-installer "$config" "$dev"