2025-01-21 09:07:45 +01:00
#!/usr/bin/env bash
2026-01-06 13:28:12 +01:00
# Copyright (c) 2021-2026 community-scripts ORG
2026-02-05 08:03:04 +01:00
# Author: thost96 (thost96) | michelroegl-brunner | MickLesk
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
# ==============================================================================
# Docker VM - Creates a Docker-ready Virtual Machine
# ==============================================================================
source <( curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVE/raw/branch/main/misc/api.func) 2>/dev/null
source <( curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVE/raw/branch/main/misc/vm-core.func) 2>/dev/null
source <( curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVE/raw/branch/main/misc/cloud-init.func) 2>/dev/null || true
load_functions
# ==============================================================================
# SCRIPT VARIABLES
# ==============================================================================
APP = "Docker"
APP_TYPE = "vm"
NSAPP = "docker-vm"
var_os = "debian"
var_version = "13"
2025-01-21 09:07:45 +01:00
GEN_MAC = 02:$( openssl rand -hex 5 | awk '{print toupper($0)}' | sed 's/\(..\)/\1:/g; s/.$//' )
2025-02-10 09:13:09 +01:00
RANDOM_UUID = " $( cat /proc/sys/kernel/random/uuid) "
METHOD = ""
2025-05-29 19:25:25 +02:00
DISK_SIZE = "10G"
2026-02-05 08:03:04 +01:00
USE_CLOUD_INIT = "no"
OS_TYPE = ""
OS_VERSION = ""
2025-01-21 09:07:45 +01:00
THIN = "discard=on,ssd=1,"
2026-02-05 08:03:04 +01:00
# ==============================================================================
# ERROR HANDLING & CLEANUP
# ==============================================================================
2025-01-21 09:07:45 +01:00
set -e
trap 'error_handler $LINENO "$BASH_COMMAND"' ERR
trap cleanup EXIT
2025-04-15 15:20:46 +02:00
trap 'post_update_to_api "failed" "INTERRUPTED"' SIGINT
2025-02-10 09:13:09 +01:00
trap 'post_update_to_api "failed" "TERMINATED"' SIGTERM
2026-02-05 08:03:04 +01:00
2025-01-21 09:07:45 +01:00
function error_handler( ) {
local exit_code = " $? "
local line_number = " $1 "
local command = " $2 "
local error_message = " ${ RD } [ERROR] ${ CL } in line ${ RD } $line_number ${ CL } : exit code ${ RD } $exit_code ${ CL } : while executing command ${ YW } $command ${ CL } "
Archlinux-VM: fix LVM/LVM-thin storage and improve error reporting | VM's add correct exit_code for analytics (#11842)
* fix(archlinux-vm): fix LVM/LVM-thin storage and improve error reporting
- Add catch-all (*) case for storage types (LVM, LVM-thin, zfspool)
Previously only nfs/dir/cifs and btrfs were handled, leaving
DISK_EXT, DISK_REF, and DISK_IMPORT unset on LVM/LVM-thin storage
- Fix error_handler to send numeric exit_code to API instead of
bash command text (which caused 'Unknown error' in telemetry)
- Replace fragile pvesm alloc for EFI disk with Proxmox-managed
:0,efitype=4m (consistent with docker-vm.sh)
- Modernize disk import: auto-detect qm disk import vs qm importdisk,
parse output to get correct disk reference instead of guessing names
- Use --format flag (double dash) consistent with modern Proxmox API
- Remove unused FORMAT variable (EFI type now always set correctly)
- Remove fragile eval-based disk name construction
* fix(vm): fix LVM/LVM-thin storage and error reporting for all VM scripts
- Add catch-all (*) case to storage type detection in all VM scripts
that were missing it (debian-vm, debian-13-vm, ubuntu2204/2404/2504,
nextcloud-vm, owncloud-vm, opnsense-vm, pimox-haos-vm)
- Add catch-all to mikrotik-routeros (had zfspool but not lvm/lvmthin)
- Fix error_handler in ALL 14 VM scripts to send numeric exit_code
to post_update_to_api instead of bash command text, which caused
'Unknown error' in telemetry because the API expects a number
2026-02-12 20:06:02 +01:00
post_update_to_api "failed" " ${ exit_code } "
2025-01-21 09:07:45 +01:00
echo -e " \n $error_message \n "
cleanup_vmid
}
2026-02-05 08:03:04 +01:00
# ==============================================================================
# OS SELECTION FUNCTIONS
# ==============================================================================
function select_os( ) {
if OS_CHOICE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "SELECT OS" --radiolist \
"Choose Operating System for Docker VM" 14 68 4 \
"debian13" "Debian 13 (Trixie) - Latest" ON \
"debian12" "Debian 12 (Bookworm) - Stable" OFF \
"ubuntu2404" "Ubuntu 24.04 LTS (Noble)" OFF \
"ubuntu2204" "Ubuntu 22.04 LTS (Jammy)" OFF \
3>& 1 1>& 2 2>& 3) ; then
case $OS_CHOICE in
debian13)
OS_TYPE = "debian"
OS_VERSION = "13"
OS_CODENAME = "trixie"
OS_DISPLAY = "Debian 13 (Trixie)"
; ;
debian12)
OS_TYPE = "debian"
OS_VERSION = "12"
OS_CODENAME = "bookworm"
OS_DISPLAY = "Debian 12 (Bookworm)"
; ;
ubuntu2404)
OS_TYPE = "ubuntu"
OS_VERSION = "24.04"
OS_CODENAME = "noble"
OS_DISPLAY = "Ubuntu 24.04 LTS"
; ;
ubuntu2204)
OS_TYPE = "ubuntu"
OS_VERSION = "22.04"
OS_CODENAME = "jammy"
OS_DISPLAY = "Ubuntu 22.04 LTS"
; ;
esac
echo -e " ${ OS } ${ BOLD } ${ DGN } Operating System: ${ BGN } ${ OS_DISPLAY } ${ CL } "
else
exit_script
2025-01-21 09:07:45 +01:00
fi
}
2026-02-05 08:03:04 +01:00
function select_cloud_init( ) {
if [ " $OS_TYPE " = "ubuntu" ] ; then
USE_CLOUD_INIT = "yes"
echo -e " ${ CLOUD :- ${ TAB } ☁️ ${ TAB } ${ CL } } ${ BOLD } ${ DGN } Cloud-Init: ${ BGN } yes (Ubuntu requires Cloud-Init) ${ CL } "
return
2025-07-28 11:00:09 +02:00
fi
2026-02-05 08:03:04 +01:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "CLOUD-INIT" \
--yesno "Enable Cloud-Init for VM configuration?\n\nCloud-Init allows automatic configuration of:\n- User accounts and passwords\n- SSH keys\n- Network settings (DHCP/Static)\n- DNS configuration\n\nYou can also configure these settings later in Proxmox UI.\n\nNote: Debian without Cloud-Init will use nocloud image with console auto-login." 18 68) ; then
USE_CLOUD_INIT = "yes"
echo -e " ${ CLOUD :- ${ TAB } ☁️ ${ TAB } ${ CL } } ${ BOLD } ${ DGN } Cloud-Init: ${ BGN } yes ${ CL } "
else
USE_CLOUD_INIT = "no"
echo -e " ${ CLOUD :- ${ TAB } ☁️ ${ TAB } ${ CL } } ${ BOLD } ${ DGN } Cloud-Init: ${ BGN } no ${ CL } "
2025-01-21 09:07:45 +01:00
fi
}
2026-02-05 08:03:04 +01:00
function get_image_url( ) {
local arch = $( dpkg --print-architecture)
case $OS_TYPE in
debian)
if [ " $USE_CLOUD_INIT " = "yes" ] ; then
echo " https://cloud.debian.org/images/cloud/ ${ OS_CODENAME } /latest/debian- ${ OS_VERSION } -generic- ${ arch } .qcow2 "
else
echo " https://cloud.debian.org/images/cloud/ ${ OS_CODENAME } /latest/debian- ${ OS_VERSION } -nocloud- ${ arch } .qcow2 "
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
; ;
ubuntu)
echo " https://cloud-images.ubuntu.com/ ${ OS_CODENAME } /current/ ${ OS_CODENAME } -server-cloudimg- ${ arch } .img "
; ;
esac
2025-01-21 09:07:45 +01:00
}
2026-02-05 08:03:04 +01:00
# ==============================================================================
# SETTINGS FUNCTIONS
# ==============================================================================
2025-01-21 09:07:45 +01:00
function default_settings( ) {
2026-02-05 08:03:04 +01:00
select_os
select_cloud_init
2025-05-07 12:37:46 +02:00
VMID = $( get_valid_nextid)
2026-02-05 08:03:04 +01:00
FORMAT = ""
MACHINE = " -machine q35"
2025-01-21 09:07:45 +01:00
DISK_CACHE = ""
2025-06-18 22:08:23 +02:00
DISK_SIZE = "10G"
2025-01-21 09:07:45 +01:00
HN = "docker"
2026-02-05 08:03:04 +01:00
CPU_TYPE = " -cpu host"
2025-01-21 09:07:45 +01:00
CORE_COUNT = "2"
RAM_SIZE = "4096"
BRG = "vmbr0"
MAC = " $GEN_MAC "
VLAN = ""
MTU = ""
START_VM = "yes"
2025-02-10 09:13:09 +01:00
METHOD = "default"
2026-02-05 08:03:04 +01:00
2025-05-05 21:36:25 +02:00
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } Virtual Machine ID: ${ BGN } ${ VMID } ${ CL } "
2026-02-05 08:03:04 +01:00
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } Q35 (Modern) ${ CL } "
2025-05-05 21:36:25 +02:00
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } ${ DISK_SIZE } ${ CL } "
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Cache: ${ BGN } None ${ CL } "
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } ${ HN } ${ CL } "
2026-02-05 08:03:04 +01:00
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } Host ${ CL } "
2025-05-05 21:36:25 +02:00
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } ${ CORE_COUNT } ${ CL } "
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } ${ RAM_SIZE } ${ CL } "
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } Bridge: ${ BGN } ${ BRG } ${ CL } "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } ${ MAC } ${ CL } "
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } Default ${ CL } "
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } Default ${ CL } "
echo -e " ${ GATEWAY } ${ BOLD } ${ DGN } Start VM when completed: ${ BGN } yes ${ CL } "
2026-02-05 08:03:04 +01:00
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Docker VM using the above settings ${ CL } "
2025-01-21 09:07:45 +01:00
}
function advanced_settings( ) {
2026-02-05 08:03:04 +01:00
select_os
select_cloud_init
# SSH Key selection for Cloud-Init VMs
if [ " $USE_CLOUD_INIT " = "yes" ] ; then
configure_cloudinit_ssh_keys || true
fi
2025-02-10 09:13:09 +01:00
METHOD = "advanced"
2025-05-07 12:37:46 +02:00
[ -z " ${ VMID :- } " ] && VMID = $( get_valid_nextid)
2026-02-05 08:03:04 +01:00
# VM ID
2025-01-21 09:07:45 +01:00
while true; do
2025-05-07 12:37:46 +02:00
if VMID = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Virtual Machine ID" 8 58 $VMID --title "VIRTUAL MACHINE ID" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-01-21 09:07:45 +01:00
if [ -z " $VMID " ] ; then
2025-05-07 12:37:46 +02:00
VMID = $( get_valid_nextid)
2025-01-21 09:07:45 +01:00
fi
if pct status " $VMID " & >/dev/null || qm status " $VMID " & >/dev/null; then
echo -e " ${ CROSS } ${ RD } ID $VMID is already in use ${ CL } "
sleep 2
continue
fi
2025-05-05 22:17:27 +02:00
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } Virtual Machine ID: ${ BGN } $VMID ${ CL } "
2025-01-21 09:07:45 +01:00
break
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
done
2026-02-05 08:03:04 +01:00
# Machine Type
2025-01-21 09:07:45 +01:00
if MACH = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "MACHINE TYPE" --radiolist --cancel-button Exit-Script "Choose Type" 10 58 2 \
2026-02-05 08:03:04 +01:00
"q35" "Q35 (Modern, PCIe)" ON \
"i440fx" "i440fx (Legacy, PCI)" OFF \
2025-01-21 09:07:45 +01:00
3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ $MACH = q35 ] ; then
2026-02-05 08:03:04 +01:00
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } Q35 (Modern) ${ CL } "
2025-01-21 09:07:45 +01:00
FORMAT = ""
MACHINE = " -machine q35"
else
2026-02-05 08:03:04 +01:00
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } i440fx (Legacy) ${ CL } "
2025-01-21 09:07:45 +01:00
FORMAT = ",efitype=4m"
MACHINE = ""
fi
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# Disk Size
2025-05-05 16:49:22 +02:00
if DISK_SIZE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Disk Size in GiB (e.g., 10, 20)" 8 58 " $DISK_SIZE " --title "DISK SIZE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
DISK_SIZE = $( echo " $DISK_SIZE " | tr -d ' ' )
if [ [ " $DISK_SIZE " = ~ ^[ 0-9] +$ ] ] ; then
DISK_SIZE = " ${ DISK_SIZE } G "
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } $DISK_SIZE ${ CL } "
elif [ [ " $DISK_SIZE " = ~ ^[ 0-9] +G$ ] ] ; then
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } $DISK_SIZE ${ CL } "
else
echo -e " ${ DISKSIZE } ${ BOLD } ${ RD } Invalid Disk Size. Please use a number (e.g., 10 or 10G). ${ CL } "
2026-02-05 08:03:04 +01:00
exit_script
2025-05-05 16:49:22 +02:00
fi
else
2026-02-05 08:03:04 +01:00
exit_script
2025-05-05 16:49:22 +02:00
fi
2026-02-05 08:03:04 +01:00
# Disk Cache
2025-01-21 09:07:45 +01:00
if DISK_CACHE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "DISK CACHE" --radiolist "Choose" --cancel-button Exit-Script 10 58 2 \
"0" "None (Default)" ON \
"1" "Write Through" OFF \
3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ $DISK_CACHE = "1" ] ; then
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Cache: ${ BGN } Write Through ${ CL } "
2025-01-21 09:07:45 +01:00
DISK_CACHE = "cache=writethrough,"
else
2025-05-05 22:17:27 +02:00
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Cache: ${ BGN } None ${ CL } "
2025-01-21 09:07:45 +01:00
DISK_CACHE = ""
fi
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# Hostname
2025-05-29 19:25:25 +02:00
if VM_NAME = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Hostname" 8 58 docker --title "HOSTNAME" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $VM_NAME ] ; then
2025-05-29 19:25:25 +02:00
HN = "docker"
2025-01-21 09:07:45 +01:00
else
2025-05-05 22:17:27 +02:00
HN = $( echo ${ VM_NAME ,, } | tr -d ' ' )
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# CPU Model
2025-01-21 09:07:45 +01:00
if CPU_TYPE1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "CPU MODEL" --radiolist "Choose" --cancel-button Exit-Script 10 58 2 \
2026-02-05 08:03:04 +01:00
"1" "Host (Recommended)" ON \
"0" "KVM64" OFF \
2025-01-21 09:07:45 +01:00
3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ $CPU_TYPE1 = "1" ] ; then
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } Host ${ CL } "
2025-01-21 09:07:45 +01:00
CPU_TYPE = " -cpu host"
else
2025-05-05 22:17:27 +02:00
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } KVM64 ${ CL } "
2025-01-21 09:07:45 +01:00
CPU_TYPE = ""
fi
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# CPU Cores
2025-01-21 09:07:45 +01:00
if CORE_COUNT = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Allocate CPU Cores" 8 58 2 --title "CORE COUNT" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $CORE_COUNT ] ; then
2025-01-21 09:07:45 +01:00
CORE_COUNT = "2"
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } $CORE_COUNT ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# RAM Size
if RAM_SIZE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Allocate RAM in MiB" 8 58 4096 --title "RAM" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $RAM_SIZE ] ; then
2026-02-05 08:03:04 +01:00
RAM_SIZE = "4096"
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } $RAM_SIZE ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# Bridge
2025-01-21 09:07:45 +01:00
if BRG = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a Bridge" 8 58 vmbr0 --title "BRIDGE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $BRG ] ; then
2025-01-21 09:07:45 +01:00
BRG = "vmbr0"
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } Bridge: ${ BGN } $BRG ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# MAC Address
2025-05-05 22:17:27 +02:00
if MAC1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a MAC Address" 8 58 $GEN_MAC --title "MAC ADDRESS" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $MAC1 ] ; then
2025-01-21 09:07:45 +01:00
MAC = " $GEN_MAC "
else
MAC = " $MAC1 "
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } $MAC ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# VLAN
if VLAN1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a Vlan (leave blank for default)" 8 58 --title "VLAN" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $VLAN1 ] ; then
2025-01-21 09:07:45 +01:00
VLAN1 = "Default"
VLAN = ""
else
VLAN = " ,tag= $VLAN1 "
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } $VLAN1 ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# MTU
2025-01-21 09:07:45 +01:00
if MTU1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Interface MTU Size (leave blank for default)" 8 58 --title "MTU SIZE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-05-05 22:17:27 +02:00
if [ -z $MTU1 ] ; then
2025-01-21 09:07:45 +01:00
MTU1 = "Default"
MTU = ""
else
MTU = " ,mtu= $MTU1 "
fi
2026-02-05 08:03:04 +01:00
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
2025-01-21 09:07:45 +01:00
else
2026-02-05 08:03:04 +01:00
exit_script
2025-01-21 09:07:45 +01:00
fi
2026-02-05 08:03:04 +01:00
# Start VM
2025-01-21 09:07:45 +01:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "START VIRTUAL MACHINE" --yesno "Start VM when completed?" 10 58) ; then
2025-05-05 22:17:27 +02:00
echo -e " ${ GATEWAY } ${ BOLD } ${ DGN } Start VM when completed: ${ BGN } yes ${ CL } "
2025-01-21 09:07:45 +01:00
START_VM = "yes"
else
2025-05-05 22:17:27 +02:00
echo -e " ${ GATEWAY } ${ BOLD } ${ DGN } Start VM when completed: ${ BGN } no ${ CL } "
2025-01-21 09:07:45 +01:00
START_VM = "no"
fi
2026-02-05 08:03:04 +01:00
# Confirm
2025-05-29 19:25:25 +02:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "ADVANCED SETTINGS COMPLETE" --yesno "Ready to create a Docker VM?" --no-button Do-Over 10 58) ; then
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Docker VM using the above advanced settings ${ CL } "
2025-01-21 09:07:45 +01:00
else
header_info
2025-05-05 22:17:27 +02:00
echo -e " ${ ADVANCED } ${ BOLD } ${ RD } Using Advanced Settings ${ CL } "
2025-01-21 09:07:45 +01:00
advanced_settings
fi
}
function start_script( ) {
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "SETTINGS" --yesno "Use Default Settings?" --no-button Advanced 10 58) ; then
header_info
2025-05-05 22:17:27 +02:00
echo -e " ${ DEFAULT } ${ BOLD } ${ BL } Using Default Settings ${ CL } "
2025-01-21 09:07:45 +01:00
default_settings
else
header_info
2025-05-05 22:17:27 +02:00
echo -e " ${ ADVANCED } ${ BOLD } ${ RD } Using Advanced Settings ${ CL } "
2025-01-21 09:07:45 +01:00
advanced_settings
fi
}
2026-02-05 08:03:04 +01:00
# ==============================================================================
# MAIN EXECUTION
# ==============================================================================
header_info
2025-01-21 09:07:45 +01:00
check_root
arch_check
pve_check
2026-02-05 08:03:04 +01:00
if whiptail --backtitle "Proxmox VE Helper Scripts" --title "Docker VM" --yesno "This will create a New Docker VM. Proceed?" 10 58; then
:
else
header_info && echo -e " ${ CROSS } ${ RD } User exited script ${ CL } \n " && exit
fi
2025-01-21 09:07:45 +01:00
start_script
2025-02-10 09:13:09 +01:00
post_to_api_vm
2025-01-21 09:07:45 +01:00
2026-02-05 08:03:04 +01:00
# ==============================================================================
# STORAGE SELECTION
# ==============================================================================
2025-01-21 09:07:45 +01:00
msg_info "Validating Storage"
while read -r line; do
2025-05-05 22:17:27 +02:00
TAG = $( echo $line | awk '{print $1}' )
TYPE = $( echo $line | awk '{printf "%-10s", $2}' )
FREE = $( echo $line | numfmt --field 4-6 --from-unit= K --to= iec --format %.2f | awk '{printf( "%9sB", $6)}' )
2025-01-21 09:07:45 +01:00
ITEM = " Type: $TYPE Free: $FREE "
OFFSET = 2
if [ [ $(( ${# ITEM } + $OFFSET )) -gt ${ MSG_MAX_LENGTH :- } ] ] ; then
MSG_MAX_LENGTH = $(( ${# ITEM } + $OFFSET ))
fi
STORAGE_MENU += ( " $TAG " " $ITEM " "OFF" )
done < <( pvesm status -content images | awk 'NR>1' )
2026-02-05 08:03:04 +01:00
2025-01-21 09:07:45 +01:00
VALID = $( pvesm status -content images | awk 'NR>1' )
if [ -z " $VALID " ] ; then
msg_error "Unable to detect a valid storage location."
exit
elif [ $(( ${# STORAGE_MENU [@] } / 3 )) -eq 1 ] ; then
STORAGE = ${ STORAGE_MENU [0] }
else
2026-02-05 08:03:04 +01:00
if [ -n " $SPINNER_PID " ] && ps -p $SPINNER_PID >/dev/null; then kill $SPINNER_PID >/dev/null; fi
printf "\e[?25h"
2025-01-21 09:07:45 +01:00
while [ -z " ${ STORAGE : +x } " ] ; do
STORAGE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "Storage Pools" --radiolist \
2025-04-17 02:49:55 -04:00
" Which storage pool would you like to use for ${ HN } ?\nTo make a selection, use the Spacebar.\n " \
2025-01-21 09:07:45 +01:00
16 $(( $MSG_MAX_LENGTH + 23 )) 6 \
2025-04-15 15:20:46 +02:00
" ${ STORAGE_MENU [@] } " 3>& 1 1>& 2 2>& 3)
2025-01-21 09:07:45 +01:00
done
fi
msg_ok " Using ${ CL } ${ BL } $STORAGE ${ CL } ${ GN } for Storage Location. "
msg_ok " Virtual Machine ID is ${ CL } ${ BL } $VMID ${ CL } . "
2026-02-05 08:03:04 +01:00
# ==============================================================================
# PREREQUISITES
# ==============================================================================
if ! command -v virt-customize & >/dev/null; then
msg_info "Installing libguestfs-tools"
apt-get -qq update >/dev/null
apt-get -qq install libguestfs-tools lsb-release -y >/dev/null
apt-get -qq install dhcpcd-base -y >/dev/null 2>& 1 || true
msg_ok "Installed libguestfs-tools"
fi
# ==============================================================================
# IMAGE DOWNLOAD
# ==============================================================================
msg_info " Retrieving the URL for the ${ OS_DISPLAY } Qcow2 Disk Image "
URL = $( get_image_url)
CACHE_DIR = "/var/lib/vz/template/cache"
CACHE_FILE = " $CACHE_DIR / $( basename " $URL " ) "
mkdir -p " $CACHE_DIR "
2025-01-21 09:07:45 +01:00
msg_ok " ${ CL } ${ BL } ${ URL } ${ CL } "
2026-02-05 08:03:04 +01:00
if [ [ ! -s " $CACHE_FILE " ] ] ; then
curl -f#SL -o " $CACHE_FILE " " $URL "
echo -en "\e[1A\e[0K"
msg_ok " Downloaded ${ CL } ${ BL } $( basename " $CACHE_FILE " ) ${ CL } "
else
msg_ok " Using cached image ${ CL } ${ BL } $( basename " $CACHE_FILE " ) ${ CL } "
fi
# ==============================================================================
# STORAGE TYPE DETECTION
# ==============================================================================
2025-05-05 16:49:22 +02:00
STORAGE_TYPE = $( pvesm status -storage " $STORAGE " | awk 'NR>1 {print $2}' )
2025-01-21 09:07:45 +01:00
case $STORAGE_TYPE in
nfs | dir)
DISK_EXT = ".qcow2"
DISK_REF = " $VMID / "
2026-02-05 08:03:04 +01:00
DISK_IMPORT = "--format qcow2"
2025-01-21 09:07:45 +01:00
THIN = ""
; ;
btrfs)
DISK_EXT = ".raw"
DISK_REF = " $VMID / "
2026-02-05 08:03:04 +01:00
DISK_IMPORT = "--format raw"
2025-01-21 09:07:45 +01:00
FORMAT = ",efitype=4m"
THIN = ""
; ;
2026-02-05 08:03:04 +01:00
*)
DISK_EXT = ""
DISK_REF = ""
DISK_IMPORT = "--format raw"
; ;
2025-01-21 09:07:45 +01:00
esac
2026-02-05 08:03:04 +01:00
# ==============================================================================
# IMAGE CUSTOMIZATION WITH DOCKER
# ==============================================================================
msg_info " Preparing ${ OS_DISPLAY } image with Docker "
WORK_FILE = $( mktemp --suffix= .qcow2)
cp " $CACHE_FILE " " $WORK_FILE "
export LIBGUESTFS_BACKEND_SETTINGS = dns = 8.8.8.8,1.1.1.1
DOCKER_PREINSTALLED = "no"
# Install qemu-guest-agent and Docker during image customization
msg_info "Installing base packages in image"
if virt-customize -a " $WORK_FILE " --install qemu-guest-agent,curl,ca-certificates >/dev/null 2>& 1; then
msg_ok "Installed base packages"
msg_info "Installing Docker (this may take 2-5 minutes)"
if virt-customize -q -a " $WORK_FILE " --run-command "curl -fsSL https://get.docker.com | sh" >/dev/null 2>& 1 &&
virt-customize -q -a " $WORK_FILE " --run-command "systemctl enable docker" >/dev/null 2>& 1; then
msg_ok "Installed Docker"
msg_info "Configuring Docker daemon"
# Optimize Docker daemon configuration
virt-customize -q -a " $WORK_FILE " --run-command "mkdir -p /etc/docker" >/dev/null 2>& 1
virt-customize -q -a " $WORK_FILE " --run-command ' cat > /etc/docker/daemon.json << EOF
{
"storage-driver" : "overlay2" ,
"log-driver" : "json-file" ,
"log-opts" : {
"max-size" : "10m" ,
"max-file" : "3"
}
}
EOF' >/dev/null 2>& 1
DOCKER_PREINSTALLED = "yes"
msg_ok "Configured Docker daemon"
else
msg_ok "Docker will be installed on first boot"
fi
else
msg_ok "Packages will be installed on first boot"
fi
msg_info "Finalizing image (hostname, SSH config)"
# Set hostname and prepare for unique machine-id
virt-customize -q -a " $WORK_FILE " --hostname " ${ HN } " >/dev/null 2>& 1
virt-customize -q -a " $WORK_FILE " --run-command "truncate -s 0 /etc/machine-id" >/dev/null 2>& 1
virt-customize -q -a " $WORK_FILE " --run-command "rm -f /var/lib/dbus/machine-id" >/dev/null 2>& 1
# Configure SSH for Cloud-Init
if [ " $USE_CLOUD_INIT " = "yes" ] ; then
virt-customize -q -a " $WORK_FILE " --run-command "sed -i 's/^#*PermitRootLogin.*/PermitRootLogin yes/' /etc/ssh/sshd_config" >/dev/null 2>& 1 || true
virt-customize -q -a " $WORK_FILE " --run-command "sed -i 's/^#*PasswordAuthentication.*/PasswordAuthentication yes/' /etc/ssh/sshd_config" >/dev/null 2>& 1 || true
else
# Configure auto-login for nocloud images (no Cloud-Init)
virt-customize -q -a " $WORK_FILE " --run-command "mkdir -p /etc/systemd/system/serial-getty@ttyS0.service.d" >/dev/null 2>& 1 || true
virt-customize -q -a " $WORK_FILE " --run-command ' cat > /etc/systemd/system/serial-getty@ttyS0.service.d/autologin.conf << EOF
[ Service]
ExecStart =
ExecStart = -/sbin/agetty --autologin root --noclear %I \$ TERM
EOF' >/dev/null 2>& 1 || true
virt-customize -q -a " $WORK_FILE " --run-command "mkdir -p /etc/systemd/system/getty@tty1.service.d" >/dev/null 2>& 1 || true
virt-customize -q -a " $WORK_FILE " --run-command ' cat > /etc/systemd/system/getty@tty1.service.d/autologin.conf << EOF
[ Service]
ExecStart =
ExecStart = -/sbin/agetty --autologin root --noclear %I \$ TERM
EOF' >/dev/null 2>& 1 || true
fi
msg_ok "Finalized image"
# Create first-boot Docker install script (fallback if virt-customize failed)
if [ " $DOCKER_PREINSTALLED " = "no" ] ; then
virt-customize -q -a " $WORK_FILE " --run-command ' cat > /root/install-docker.sh << "DOCKERSCRIPT"
#!/bin/bash
exec > /var/log/install-docker.log 2>& 1
echo " [ $( date) ] Starting Docker installation "
for i in { 1..30} ; do
ping -c 1 8.8.8.8 >/dev/null 2>& 1 && break
sleep 2
2025-01-21 09:07:45 +01:00
done
2026-02-05 08:03:04 +01:00
apt-get update
apt-get install -y qemu-guest-agent curl ca-certificates
curl -fsSL https://get.docker.com | sh
systemctl enable docker
systemctl start docker
mkdir -p /etc/docker
cat > /etc/docker/daemon.json << DAEMON
{
"storage-driver" : "overlay2" ,
"log-driver" : "json-file" ,
"log-opts" : { "max-size" : "10m" , "max-file" : "3" }
}
DAEMON
systemctl restart docker
touch /root/.docker-installed
echo " [ $( date) ] Docker installation completed "
DOCKERSCRIPT
chmod +x /root/install-docker.sh' >/dev/null 2>& 1
virt-customize -q -a " $WORK_FILE " --run-command ' cat > /etc/systemd/system/install-docker.service << "DOCKERSERVICE"
[ Unit]
Description = Install Docker on First Boot
After = network-online.target
Wants = network-online.target
ConditionPathExists = !/root/.docker-installed
[ Service]
Type = oneshot
ExecStart = /root/install-docker.sh
RemainAfterExit = yes
[ Install]
WantedBy = multi-user.target
DOCKERSERVICE
systemctl enable install-docker.service' >/dev/null 2>& 1
2025-05-29 19:25:25 +02:00
fi
2025-01-21 09:07:45 +01:00
2026-02-05 08:03:04 +01:00
# Resize disk to target size
msg_info " Resizing disk image to ${ DISK_SIZE } "
qemu-img resize " $WORK_FILE " " ${ DISK_SIZE } " >/dev/null 2>& 1
msg_ok "Resized disk image"
# ==============================================================================
# VM CREATION
# ==============================================================================
msg_info "Creating Docker VM shell"
2025-05-05 21:56:16 +02:00
qm create $VMID -agent 1${ MACHINE } -tablet 0 -localtime 1 -bios ovmf${ CPU_TYPE } -cores $CORE_COUNT -memory $RAM_SIZE \
2026-02-05 08:03:04 +01:00
-name $HN -tags community-script -net0 virtio,bridge= $BRG ,macaddr= $MAC $VLAN $MTU -onboot 1 -ostype l26 -scsihw virtio-scsi-pci >/dev/null
msg_ok "Created VM shell"
# ==============================================================================
# DISK IMPORT
# ==============================================================================
msg_info " Importing disk into storage ( $STORAGE ) "
if qm disk import --help >/dev/null 2>& 1; then
IMPORT_CMD = ( qm disk import)
else
IMPORT_CMD = ( qm importdisk)
fi
IMPORT_OUT = " $( " ${ IMPORT_CMD [@] } " " $VMID " " $WORK_FILE " " $STORAGE " ${ DISK_IMPORT :- } 2>& 1 || true ) "
DISK_REF_IMPORTED = " $( printf '%s\n' " $IMPORT_OUT " | sed -n "s/.*successfully imported disk '\([^']\+\)'.*/\1/p" | tr -d "\r\"'" ) "
[ [ -z " $DISK_REF_IMPORTED " ] ] && DISK_REF_IMPORTED = " $( pvesm list " $STORAGE " | awk -v id = " $VMID " '$5 ~ ("vm-"id"-disk-") {print $1":"$5}' | sort | tail -n1) "
[ [ -z " $DISK_REF_IMPORTED " ] ] && {
msg_error "Unable to determine imported disk reference."
echo " $IMPORT_OUT "
exit 1
}
msg_ok " Imported disk ( ${ CL } ${ BL } ${ DISK_REF_IMPORTED } ${ CL } ) "
# Clean up work file
rm -f " $WORK_FILE "
# ==============================================================================
# VM CONFIGURATION
# ==============================================================================
msg_info "Attaching EFI and root disk"
qm set " $VMID " \
--efidisk0 " ${ STORAGE } :0,efitype=4m " \
--scsi0 " ${ DISK_REF_IMPORTED } , ${ DISK_CACHE } ${ THIN %, } " \
--boot order = scsi0 \
--serial0 socket >/dev/null
2025-05-05 21:56:16 +02:00
qm set $VMID --agent enabled = 1 >/dev/null
2025-01-21 09:07:45 +01:00
2026-02-05 08:03:04 +01:00
msg_ok "Attached EFI and root disk"
# Set VM description
set_description
# Cloud-Init configuration
if [ " $USE_CLOUD_INIT " = "yes" ] ; then
msg_info "Configuring Cloud-Init"
setup_cloud_init " $VMID " " $STORAGE " " $HN " "yes"
msg_ok "Cloud-Init configured"
fi
# Start VM
2025-01-21 09:07:45 +01:00
if [ " $START_VM " = = "yes" ] ; then
msg_info "Starting Docker VM"
2026-02-05 08:03:04 +01:00
qm start $VMID >/dev/null 2>& 1
2025-01-21 09:07:45 +01:00
msg_ok "Started Docker VM"
fi
2026-02-05 08:03:04 +01:00
# ==============================================================================
# FINAL OUTPUT
# ==============================================================================
VM_IP = ""
if [ " $START_VM " = = "yes" ] ; then
set +e
for i in { 1..10} ; do
VM_IP = $( qm guest cmd " $VMID " network-get-interfaces 2>/dev/null |
jq -r '.[] | select(.name != "lo") | ."ip-addresses"[]? | select(."ip-address-type" == "ipv4") | ."ip-address"' 2>/dev/null |
grep -v "^127\." | head -1) || true
[ -n " $VM_IP " ] && break
sleep 3
done
set -e
fi
echo -e " \n ${ INFO } ${ BOLD } ${ GN } Docker VM Configuration Summary: ${ CL } "
echo -e " ${ TAB } ${ DGN } VM ID: ${ BGN } ${ VMID } ${ CL } "
echo -e " ${ TAB } ${ DGN } Hostname: ${ BGN } ${ HN } ${ CL } "
echo -e " ${ TAB } ${ DGN } OS: ${ BGN } ${ OS_DISPLAY } ${ CL } "
[ -n " $VM_IP " ] && echo -e " ${ TAB } ${ DGN } IP Address: ${ BGN } ${ VM_IP } ${ CL } "
if [ " $DOCKER_PREINSTALLED " = "yes" ] ; then
echo -e " ${ TAB } ${ DGN } Docker: ${ BGN } Pre-installed (via get.docker.com) ${ CL } "
else
echo -e " ${ TAB } ${ DGN } Docker: ${ BGN } Installing on first boot ${ CL } "
echo -e " ${ TAB } ${ YW } ⚠️ Wait 2-3 minutes for installation to complete ${ CL } "
echo -e " ${ TAB } ${ YW } ⚠️ Check progress: ${ BL } cat /var/log/install-docker.log ${ CL } "
fi
if [ " $USE_CLOUD_INIT " = "yes" ] ; then
display_cloud_init_info " $VMID " " $HN " 2>/dev/null || true
fi
2025-02-10 09:13:09 +01:00
post_update_to_api "done" "none"
2026-01-06 22:57:40 +01:00
msg_ok "Completed successfully!\n"