diff --git a/README.md b/README.md index 6642931..5f0053b 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,9 @@ The script will create a single ZFS zpool `zpool` on the zpool partition with da ## Options -The following options can be given either by exporting them as shell variables prior to script execution or in a file named `archzbm_settings.env` that lives in your current working directory where you're about to execute the script. File format is identical to shell variable assignments of the form `VAR=value` or `VAR='value'`. +The following options can be given either by exporting them as shell variables prior to script execution or in a file named `archzbm_settings.env` that lives in your current working directory where you're about to execute the script. You can walk yourself through an interactive questionnaire that helps create a valid `archzbm_settings.env` file. Check out [Command line setup help](#command-line-setup-help) for details on the questionnaire. + +If you instead want to define settings yourself with an `archzbm_settings.env` file its file format is identical to shell variable assignments of the form `VAR=value` or `VAR='value'`. If `./archzbm_settings.env` exists the script will `source` its content and `export` all variables for use in future steps. @@ -225,6 +227,24 @@ ssh-rsa Eahajei8,,ssh-ed25519 kaeD0mas ... This syntax crutch allows you to use the full range of Dropbear-supported `authorized_keys` stanzas, see [man 8 dropbear](https://man.archlinux.org/man/extra/dropbear/dropbear.8.en) for what's available. Whether or not this is useful to you is another topic :) At least the functionality for stanzas is there by separating values in `ARCHZBM_SSH_AUTH_KEYS` with double-commas. +## Command line setup help + +An interactive questionnaure can guide you through settings and goes like this: + +![Command line setup questionnaire](https://i.imgur.com/QntUYRH.mp4) + +To do the questionnaire yourself start this script with the `setup` argument: + +``` +export SCRIPT_URL='https://quico.space/quico-os-setup/arch-zbm/raw/branch/main/setup.sh' && curl -s "${SCRIPT_URL}" | bash -s -- setup +``` + +When done rerun it without that argument: + +``` +export SCRIPT_URL='https://quico.space/quico-os-setup/arch-zbm/raw/branch/main/setup.sh' && curl -s "${SCRIPT_URL}" | bash +``` + # Steps The script takes the following installation steps.