diff --git a/README.md b/README.md index 8e12509..d42f85f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Generate customized Debian ISO images for automatic deployments. ## Usage -Run `build.sh` to generate a hands-free iso image. +Run `build.sh` to generate a hands-free ISO image. ``` ./build.sh [-u username] [-p password] [-n hostname] [-d domain] [-a package] [-i iso_url] [-s sign_key] [-o path] [-v] [-h] @@ -12,24 +12,39 @@ Run `build.sh` to generate a hands-free iso image. ### Requirements -The following command installs all requirements to use the tool on a Debian based system: +The following command installs all requirements to build an ISO image on a Debian based system: ```sh sudo apt update sudo apt install curl git gnupg pwgen whois xorriso ``` -### Example +### Clone repo + +Clone this repository and `cd` into it. ```sh git clone https://github.com/nothub/debian-autoinstall.git cd debian-autoinstall -# customize authorized ssh keys +``` + +### SSH keys + +To include SSH keys for remote access, add them to the `configs/authorized_keys` file. + +```sh curl -sSLo configs/authorized_keys https://github.com/nothub.keys +echo "ssh-ed25519 AAAA... foo" >> configs/authorized_keys +echo "ssh-ed25519 AAAA... bar" >> configs/authorized_keys +``` + +### Build ISO + +```sh # set user and password ./build.sh -u 'hub' -p 'changeme' # set hostname and domain -./build.sh -n 'calculon' -d 'home.arpa' +./build.sh -n 'calculon' -d 'example.org' # include additional apt packages ./build.sh -a 'strace' -a 'unattended-upgrades' ```