diff --git a/README.md b/README.md index afb8a80..13c4682 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Cloud Init Script -This script automates the setup of a virtual machine using an Ubuntu Cloud Image in Proxmox, with options to create a template and override any existing virtual machine with the same ID. +This script automates the setup of a virtual machine using a cloud image in Proxmox, with options to create a template and override any existing virtual machine with the same ID. ## Usage @@ -22,14 +22,28 @@ To specify a different storage (`local`) while using the default VM name (`ubunt curl -sSL https://git.nixc.us/colin/cloud-init/raw/branch/main/install.sh | bash -s -- local ``` -### 3. **Specify a Different Storage and Custom VM Name:** +### 3. **Specify a Different Cloud Image, VM Name, and Storage:** -To specify both a different storage (`local`) and a custom VM name (`custom-vm-name`): +To specify a custom cloud image URL, image name, distribution name, version, and storage, the script expects the following parameters in order: + +1. **Cloud Image URL**: The URL from where the cloud image will be downloaded. +2. **Image Name**: The name to save the downloaded image file. +3. **Distribution Name**: The name of the distribution (e.g., `ubuntu`, `debian`). +4. **Version**: The version of the distribution (e.g., `2404`, `11`). +5. **Storage**: The Proxmox storage location (e.g., `local`, `proxmox`). + +Example: ```bash -curl -sSL https://git.nixc.us/colin/cloud-init/raw/branch/main/install.sh | bash -s -- local custom-vm-name +curl -sSL https://git.nixc.us/colin/cloud-init/raw/branch/main/install.sh | bash -s -- https://cloud-images.ubuntu.com/noble/current/noble-server-cloudimg-amd64.img noble-server-cloudimg-amd64.img ubuntu 2404 local ``` +This command does the following: +- Downloads the cloud image from `https://cloud-images.ubuntu.com/noble/current/noble-server-cloudimg-amd64.img`. +- Saves the image as `noble-server-cloudimg-amd64.img`. +- Sets the distribution name as `ubuntu` and the version as `2404`. +- Uses `local` as the Proxmox storage location. + ## Manual Template Creation After configuring your VM, when you're ready, create a template using the following command: @@ -38,6 +52,6 @@ After configuring your VM, when you're ready, create a template using the follow qm template ``` -Where `` is the ID of the VM you created (default is `8000`). +Where `` is the ID of the VM you created. No license or contributors are defined for this script. \ No newline at end of file