diff --git a/README.md b/README.md index 2ad76aa..59b7b10 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,38 @@ # Cloud Init Script -This script automates the setup of a virtual machine using an Ubuntu Cloud Image in Proxmox, with the option to create a template and clone it. +This script automates the setup of a virtual machine using an Ubuntu Cloud Image in Proxmox, with options to create a template, clone it, and override any existing virtual machine with the same ID. ## Usage -You can execute this script directly using `curl` with the following command: +You can execute this script directly using `curl` with the following commands: -### Default Storage (`proxmox`) +### 1. **Default Storage (`proxmox`) and Default VM Name (`ubuntu-cloudinit2404`):** -To run the script using the default storage (`proxmox`): +To run the script using the default storage (`proxmox`) and the default VM name (`ubuntu-cloudinit2404`): ```bash -curl -sSL https://git.nixc.us/colin/cloud-init/raw/branch/main/install.sh | bash +curl -sSL https://git.nixc.us/colin/cloud-init/install.sh | bash ``` -### Specify a Different Storage +### 2. **Specify a Different Storage:** -If you want to specify a different storage, replace `other_storage_name` with your desired storage name: +To specify a different storage (`local`) while using the default VM name (`ubuntu-cloudinit2404`): ```bash -curl -sSL https://git.nixc.us/colin/cloud-init/raw/branch/main/install.sh | bash -s -- other_storage_name +curl -sSL https://git.nixc.us/colin/cloud-init/install.sh | bash -s -- local +``` + +### 3. **Specify a Different Storage and Custom VM Name:** + +To specify both a different storage (`local`) and a custom VM name (`custom-vm-name`): + +```bash +curl -sSL https://git.nixc.us/colin/cloud-init/install.sh | bash -s -- local custom-vm-name ``` ## Notes -- The script is designed to exit immediately if any step fails, ensuring that errors are caught early. -- The default storage location is set to `proxmox`, but it can be overridden by providing a different storage name as an argument. - +- **VM Replacement:** The script will delete any existing virtual machine with the same ID (`8000`) before creating a new one. +- **Defaults:** The default storage location is set to `proxmox`, and the default VM name is `ubuntu-cloudinit2404`. Both can be overridden by providing arguments. +No license or contributors are defined for this script. \ No newline at end of file