quico-os-setup/arch-zbm
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

docs(zbm): Explain prep steps (#1)

Browse Source
This commit is contained in:
hygienic-books 2023-02-19 22:17:38 +01:00
parent e1d6f64a09
commit f2572c333c
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -4,9 +4,15 @@ Helper script to install Arch Linux with ZFSBootMenu from within a running Arch
# Prep # Prep
The script expects minimal prep on your end. Please make sure that before execution at least one of the following conditions are met. The script expects minimal prep on your end. Please make sure that before execution the following conditions are met.
- Your machine has exactly one partition with partition type code `BF00` ("Solaris root") - Arch live CD ISO image sees exactly one partition with partition type code `BF00` ("Solaris root")
- Arch live CD ISO image sees exactly one partition with partition type code `EF00` ("EFI system partition")
- No ZFS zpool exists
The script will create a single ZFS zpool `zpool` on the `BF00` partition with dataset child `zpool/root` which itself has one child `zpool/root/archlinux`, that's where Arch Linux gets installed. Parallel to `zpool/root` it'll create `zpool/data` with a `zpool/data/home` child dataset that gets mounted at `/home`.
The script will use the `EF00` partition to install a ZFSBootMenu EFI executable if - and only if - `efibootmgr` says that no such `ZFSBootMenu` entry exists. If ZFSBootMenu gets added to the EFI partition it'll become primary boot option.
# How to run this? # How to run this?
@ -17,6 +23,7 @@ The script expects minimal prep on your end. Please make sure that before execut
curl -s "${SCRIPT_URL}" | bash curl -s "${SCRIPT_URL}" | bash
``` ```
The script will call itself when it changes into its `chroot`, that's why we `export SCRIPT_URL`. Feel free to update `"${SCRIPT_URL}"` with whatever branch or revision you want to use from [quico.space/quico-os-setup/arch-zbm](https://quico.space/quico-os-setup/arch-zbm). Typically `.../branch/main/setup.sh` as shown above is what you want. The script will call itself when it changes into its `chroot`, that's why we `export SCRIPT_URL`. Feel free to update `"${SCRIPT_URL}"` with whatever branch or revision you want to use from [quico.space/quico-os-setup/arch-zbm](https://quico.space/quico-os-setup/arch-zbm). Typically `.../branch/main/setup.sh` as shown above is what you want.
# Steps # Steps
The scripts takes the following installation steps. The scripts takes the following installation steps.