diff --git a/README.md b/README.md index 1460c83..d9ae9f3 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,25 @@ sudo ./build-cloudinit-template.sh [--docker] # +# --docker adds a Docker install to the cloud-init snippet, names the template +# with a -docker suffix and tags it "docker". Alpine and Arch use their own +# packages; the rest use Docker's convenience script from get.docker.com, so +# they get Docker CE rather than the distro build. The cloud-init user is added +# to the docker group, which is root-equivalent on that guest. +# +# The install runs on first boot of each clone, not while building: the snippet +# is a runcmd and the template is never booted. So every clone fetches Docker +# itself, and the template stays generic. It must be the third argument. +# # Optional overrides (env vars): # STORAGE Proxmox storage pool for disks (default: local-btrfs) # SNIPPET_STORAGE Storage holding cloud-init snippets, must have the