diff --git a/README.md b/README.md index 731b745..ad9aecc 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ The script will use the `EF00` partition to install a ZFSBootMenu EFI executable ``` During execution 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 The scripts takes the following installation steps. @@ -39,27 +40,27 @@ The scripts takes the following installation steps. We make the following opinionated flavor choices. Feel free to change them to your liking. -* Arch Linux locale is set to `en_US.UTF-8` -* Keymap is `de-latin1` - * Consult `/etc/vconsole.conf` - * Change `zfs set org.zfsbootmenu:commandline=...` -* No X.Org Server, Wayland compositors or other GUI elements get installed -* Timezone is `Etc/UTC` - * Check `timedatectl set-timezone ` +- Arch Linux locale is set to `en_US.UTF-8` +- Keymap is `de-latin1` + - Consult `/etc/vconsole.conf` + - Change `zfs set org.zfsbootmenu:commandline=...` +- No X.Org Server, Wayland compositors or other GUI elements get installed +- Timezone is `Etc/UTC` + - Check `timedatectl set-timezone ` # Post-run manual steps After installation you're going to want to at least touch these points in your new Arch Linux install: -* Package manager hook: `pacman` does not have a hook to do ZFS snapshots - * See [this GitHub gist](https://gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c#file-arch_on_zfs-txt-L238) and [zfs-snapshotter.bash](https://github.com/Soulsuke/arch-zfs-tools/blob/master/zfs-snapshotter.bash) for inspiration -* Hostname: Installation chose a pseudo-randomly generated 8-character string with `pwgen` - * Check `hostnamectl set-hostname ` -* Unprivileged user accounts: The OS was installed with `root` and unprivileged `build` users -* Passwords - * ZFS: The password for all datasets underneath `zpool` is `password`. - * Local `root` account: The local `root` account's password is `password`. -* Arch User Repository (AUR) helper: We installed [paru](https://github.com/Morganamilo/paru) as our AUR helper, we installed from GitHub via `makepkg -si`. +- Package manager hook: `pacman` does not have a hook to do ZFS snapshots + - See [this GitHub gist](https://gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c#file-arch_on_zfs-txt-L238) and [zfs-snapshotter.bash](https://github.com/Soulsuke/arch-zfs-tools/blob/master/zfs-snapshotter.bash) for inspiration +- Hostname: Installation chose a pseudo-randomly generated 8-character string with `pwgen` + - Check `hostnamectl set-hostname ` +- Unprivileged user accounts: The OS was installed with `root` and unprivileged `build` users +- Passwords + - ZFS: The password for all datasets underneath `zpool` is `password`. + - Local `root` account: The local `root` account's password is `password`. +- Arch User Repository (AUR) helper: We installed [paru](https://github.com/Morganamilo/paru) as our AUR helper, we installed from GitHub via `makepkg -si`. # Development @@ -71,20 +72,20 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/) f Commit _types_ besides `fix` and `feat` are: -* `build`: Project structure, directory layout, build instructions for roll-out -* `refactor`: Keeping functionality while streamlining or otherwise improving function flow -* `test`: Working on test coverage -* `docs`: Documentation for project or components +- `build`: Project structure, directory layout, build instructions for roll-out +- `refactor`: Keeping functionality while streamlining or otherwise improving function flow +- `test`: Working on test coverage +- `docs`: Documentation for project or components ### Commit scopes The following _scopes_ are known for this project. A Conventional Commits commit message may optionally use one of the following scopes or none: -* `iso`: Changing Arch Linux ISO CD -* `zbm`: Adjusting ZFSBootMenu's behavior -* `zfs`: A change to how ZFS interacts with the system, either a pool or a dataset -* `os`: Getting an perating system set up to correctly work in a ZFS boot environment -* `meta`: Affects the project's repo layout, readme content, file names etc. +- `iso`: Changing Arch Linux ISO CD +- `zbm`: Adjusting ZFSBootMenu's behavior +- `zfs`: A change to how ZFS interacts with the system, either a pool or a dataset +- `os`: Getting an perating system set up to correctly work in a ZFS boot environment +- `meta`: Affects the project's repo layout, readme content, file names etc. # Credits @@ -92,13 +93,13 @@ Most of what's here was shamelessly copied and slightly adapted for personal use Thanks to: -* Jonathan Kirszling: - * [github.com/eoli3n/arch-config/tree/master/scripts/zfs/install](https://github.com/eoli3n/arch-config/tree/master/scripts/zfs/install) - * [github.com/eoli3n/archiso-zfs](https://github.com/eoli3n/archiso-zfs) -* Maurizio Oliveri: - * [github.com/Soulsuke/arch-zfs-tools](https://github.com/Soulsuke/arch-zfs-tools) - * [gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c](https://gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c) -* Zach Dykstra, Andrew J. Hesford and all other [ZFSBootMenu contributors](https://github.com/zbm-dev/zfsbootmenu/graphs/contributors): - * Their [ZFSBootMenu testing helper scripts](https://github.com/zbm-dev/zfsbootmenu/tree/master/testing/helpers) ([chroot-arch.sh](https://github.com/zbm-dev/zfsbootmenu/blob/master/testing/helpers/chroot-arch.sh), [install-arch.sh](https://github.com/zbm-dev/zfsbootmenu/blob/master/testing/helpers/install-arch.sh)) -* [github.com/kongkrit](https://github.com/kongkrit): - * [gist.github.com/kongkrit/a0585e179e33c2adf92db4050ec5171d](https://gist.github.com/kongkrit/a0585e179e33c2adf92db4050ec5171d) +- Jonathan Kirszling: + - [github.com/eoli3n/arch-config/tree/master/scripts/zfs/install](https://github.com/eoli3n/arch-config/tree/master/scripts/zfs/install) + - [github.com/eoli3n/archiso-zfs](https://github.com/eoli3n/archiso-zfs) +- Maurizio Oliveri: + - [github.com/Soulsuke/arch-zfs-tools](https://github.com/Soulsuke/arch-zfs-tools) + - [gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c](https://gist.github.com/Soulsuke/6a7d1f09f7fef968a2f32e0ff32a5c4c) +- Zach Dykstra, Andrew J. Hesford and all other [ZFSBootMenu contributors](https://github.com/zbm-dev/zfsbootmenu/graphs/contributors): + - Their [ZFSBootMenu testing helper scripts](https://github.com/zbm-dev/zfsbootmenu/tree/master/testing/helpers) ([chroot-arch.sh](https://github.com/zbm-dev/zfsbootmenu/blob/master/testing/helpers/chroot-arch.sh), [install-arch.sh](https://github.com/zbm-dev/zfsbootmenu/blob/master/testing/helpers/install-arch.sh)) +- [github.com/kongkrit](https://github.com/kongkrit): + - [gist.github.com/kongkrit/a0585e179e33c2adf92db4050ec5171d](https://gist.github.com/kongkrit/a0585e179e33c2adf92db4050ec5171d)