Skip to content

Commit

Permalink
better usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
nothub committed Nov 24, 2023
1 parent 1b8b031 commit 64fbf7d
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,47 @@ 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]
```

### 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'
```
Expand Down

0 comments on commit 64fbf7d

Please sign in to comment.