@@ -1,71 +1,45 @@
#!/usr/bin/env bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: thost96 (thost96) | Co-Author: michelroegl-brunner
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
# Author: thost96 (thost96) | Co-Author: michelroegl-brunner | Refactored: MickLesk
# License: MIT | https://github.com/community-scripts/ProxmoxVED /raw/main/LICENSE
source /dev/stdin <<< $( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func)
# ==============================================================================
# Docker VM - Creates a Docker-ready Virtual Machine
# ==============================================================================
function header_info( ) {
clear
cat <<"EOF"
____ __ _ ____ ___
/ __ \_ ___ _____/ /_____ _____ | | / / | / /
/ / / / __ \/ ___/ //_/ _ \/ ___/ | | / / /| _/ /
/ /_/ / /_/ / /__/ ,< / __/ / | | / / / / /
/_____/\_ ___/\_ __/_/| _| \_ __/_/ | ___/_/ /_/
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"
EOF
}
header_info
echo -e "\n Loading..."
GEN_MAC = 02:$( openssl rand -hex 5 | awk '{print toupper($0)}' | sed 's/\(..\)/\1:/g; s/.$//' )
RANDOM_UUID = " $( cat /proc/sys/kernel/random/uuid) "
METHOD = ""
NSAPP = "docker-vm"
var_os = "debian"
var_version = "12"
DISK_SIZE = "10G"
YW = $( echo "\033[33m" )
BL = $( echo "\033[36m" )
RD = $( echo "\033[01;31m" )
BGN = $( echo "\033[4;92m" )
GN = $( echo "\033[1;92m" )
DGN = $( echo "\033[32m" )
CL = $( echo "\033[m" )
CL = $( echo "\033[m" )
BOLD = $( echo "\033[1m" )
BFR = "\\r\\033[K"
HOLD = " "
TAB = " "
CM = " ${ TAB } ✔️ ${ TAB } ${ CL } "
CROSS = " ${ TAB } ✖️ ${ TAB } ${ CL } "
INFO = " ${ TAB } 💡 ${ TAB } ${ CL } "
OS = " ${ TAB } 🖥️ ${ TAB } ${ CL } "
CONTAINERTYPE = " ${ TAB } 📦 ${ TAB } ${ CL } "
DISKSIZE = " ${ TAB } 💾 ${ TAB } ${ CL } "
CPUCORE = " ${ TAB } 🧠 ${ TAB } ${ CL } "
RAMSIZE = " ${ TAB } 🛠️ ${ TAB } ${ CL } "
CONTAINERID = " ${ TAB } 🆔 ${ TAB } ${ CL } "
HOSTNAME = " ${ TAB } 🏠 ${ TAB } ${ CL } "
BRIDGE = " ${ TAB } 🌉 ${ TAB } ${ CL } "
GATEWAY = " ${ TAB } 🌐 ${ TAB } ${ CL } "
DEFAULT = " ${ TAB } ⚙️ ${ TAB } ${ CL } "
MACADDRESS = " ${ TAB } 🔗 ${ TAB } ${ CL } "
VLANTAG = " ${ TAB } 🏷️ ${ TAB } ${ CL } "
CREATING = " ${ TAB } 🚀 ${ TAB } ${ CL } "
ADVANCED = " ${ TAB } 🧩 ${ TAB } ${ CL } "
CLOUD = " ${ TAB } ☁️ ${ TAB } ${ CL } "
USE_CLOUD_INIT = "no"
OS_TYPE = ""
OS_VERSION = ""
THIN = "discard=on,ssd=1,"
# ==============================================================================
# ERROR HANDLING & CLEANUP
# ==============================================================================
set -e
trap 'error_handler $LINENO "$BASH_COMMAND"' ERR
trap cleanup EXIT
trap 'post_update_to_api "failed" "INTERRUPTED"' SIGINT
trap 'post_update_to_api "failed" "TERMINATED"' SIGTERM
function error_handler( ) {
local exit_code = " $? "
local line_number = " $1 "
@@ -76,140 +50,96 @@ function error_handler() {
cleanup_vmid
}
function get_valid_nextid( ) {
local try_id
try_id = $( pvesh get /cluster/nextid)
while true; do
if [ -f " /etc/pve/qemu-server/ ${ try_id } .conf " ] || [ -f " /etc/pve/lxc/ ${ try_id } .conf " ] ; then
try_id = $(( try_id + 1 ))
continue
# ==============================================================================
# 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
fi
}
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
fi
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 } "
fi
}
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 "
fi
if lvs --noheadings -o lv_name | grep -qE " (^|[-_]) ${ try_id } ( $|[-_]) " ; then
try_id = $(( try_id + 1 ) )
continue
fi
break
done
echo " $try_id "
}
function cleanup_vmid( ) {
if qm status $VMID & >/dev/null; then
qm stop $VMID & >/dev/null
qm destroy $VMID & >/dev/null
fi
}
function cleanup( ) {
popd >/dev/null
post_update_to_api "done" "none"
rm -rf $TEMP_DIR
}
TEMP_DIR = $( mktemp -d)
pushd $TEMP_DIR >/dev/null
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
function msg_info( ) {
local msg = " $1 "
echo -ne " ${ TAB } ${ YW } ${ HOLD } ${ msg } ${ HOLD } "
}
function msg_ok( ) {
local msg = " $1 "
echo -e " ${ BFR } ${ CM } ${ GN } ${ msg } ${ CL } "
}
function msg_error( ) {
local msg = " $1 "
echo -e " ${ BFR } ${ CROSS } ${ RD } ${ msg } ${ CL } "
}
function check_root( ) {
if [ [ " $( id -u) " -ne 0 || $( ps -o comm = -p $PPID ) = = "sudo" ] ] ; then
clear
msg_error "Please run this script as root."
echo -e "\nExiting..."
sleep 2
exit
fi
}
# This function checks the version of Proxmox Virtual Environment (PVE) and exits if the version is not supported.
# Supported: Proxmox VE 8.0.x – 8.9.x, 9.0 and 9.1
pve_check( ) {
local PVE_VER
PVE_VER = " $( pveversion | awk -F'/' '{print $2}' | awk -F'-' '{print $1}' ) "
# Check for Proxmox VE 8.x: allow 8.0– 8.9
if [ [ " $PVE_VER " = ~ ^8\. ( [ 0-9] +) ] ] ; then
local MINOR = " ${ BASH_REMATCH [1] } "
if ( ( MINOR < 0 || MINOR > 9) ) ; then
msg_error "This version of Proxmox VE is not supported."
msg_error "Supported: Proxmox VE version 8.0 – 8.9"
exit 1
fi
return 0
fi
# Check for Proxmox VE 9.x: allow 9.0 and 9.1
if [ [ " $PVE_VER " = ~ ^9\. ( [ 0-9] +) ] ] ; then
local MINOR = " ${ BASH_REMATCH [1] } "
if ( ( MINOR < 0 || MINOR > 1) ) ; then
msg_error "This version of Proxmox VE is not supported."
msg_error "Supported: Proxmox VE version 9.0 – 9.1"
exit 1
fi
return 0
fi
# All other unsupported versions
msg_error "This version of Proxmox VE is not supported."
msg_error "Supported versions: Proxmox VE 8.0 – 8.x or 9.0 – 9.1"
exit 1
}
function arch_check( ) {
if [ " $( dpkg --print-architecture) " != "amd64" ] ; then
echo -e " \n ${ INFO } ${ YWB } This script will not work with PiMox! \n "
echo -e " \n ${ YWB } Visit https://github.com/asylumexp/Proxmox for ARM64 support. \n "
echo -e "Exiting..."
sleep 2
exit
fi
}
function ssh_check( ) {
if command -v pveversion >/dev/null 2>& 1; then
if [ -n " ${ SSH_CLIENT : +x } " ] ; then
if whiptail --backtitle "Proxmox VE Helper Scripts" --defaultno --title "SSH DETECTED" --yesno "It's suggested to use the Proxmox shell instead of SSH, since SSH can create issues while gathering variables. Would you like to proceed with using SSH?" 10 62; then
echo "you've been warned"
else
clear
exit
fi
fi
fi
}
function exit-script( ) {
clear
echo -e " \n ${ CROSS } ${ RD } User exited script ${ CL } \n "
exit
; ;
ubuntu )
echo " https://cloud-images.ubuntu.com/ ${ OS_CODENAME } /current/ ${ OS_CODENAME } -server-cloudimg- ${ arch } .img "
; ;
esac
}
# ==============================================================================
# SETTINGS FUNCTIONS
# ==============================================================================
function default_settings( ) {
select_os
select_cloud_init
VMID = $( get_valid_nextid)
FORMAT = ",efitype=4m "
MACHINE = ""
FORMAT = ""
MACHINE = " -machine q35 "
DISK_CACHE = ""
DISK_SIZE = "10G"
HN = "docker"
CPU_TYPE = ""
CPU_TYPE = " -cpu host "
CORE_COUNT = "2"
RAM_SIZE = "4096"
BRG = "vmbr0"
@@ -218,12 +148,13 @@ function default_settings() {
MTU = ""
START_VM = "yes"
METHOD = "default"
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } Virtual Machine ID: ${ BGN } ${ VMID } ${ CL } "
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } i440fx ${ CL } "
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } Q35 (Modern) ${ CL } "
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 } "
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } KVM64 ${ CL } "
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } Host ${ CL } "
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 } "
@@ -231,12 +162,17 @@ function default_settings() {
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 } "
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Docker VM using the above default settings ${ CL } "
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Docker VM using the above settings ${ CL } "
}
function advanced_settings( ) {
select_os
select_cloud_init
METHOD = "advanced"
[ -z " ${ VMID :- } " ] && VMID = $( get_valid_nextid)
# VM ID
while true; do
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
if [ -z " $VMID " ] ; then
@@ -250,27 +186,29 @@ function advanced_settings() {
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } Virtual Machine ID: ${ BGN } $VMID ${ CL } "
break
else
exit- script
exit_ script
fi
done
# Machine Type
if MACH = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "MACHINE TYPE" --radiolist --cancel-button Exit-Script "Choose Type" 10 58 2 \
"i440fx" "Machine i440fx " ON \
"q35" "Machine q35 " OFF \
"q35" "Q35 (Modern, PCIe) " ON \
"i440fx" "i440fx (Legacy, PCI) " OFF \
3>& 1 1>& 2 2>& 3) ; then
if [ $MACH = q35 ] ; then
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } $MACH ${ CL } "
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } Q35 (Modern) ${ CL } "
FORMAT = ""
MACHINE = " -machine q35"
else
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } $MACH ${ CL } "
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } i440fx (Legacy) ${ CL } "
FORMAT = ",efitype=4m"
MACHINE = ""
fi
else
exit- script
exit_ script
fi
# Disk Size
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
@@ -280,12 +218,13 @@ function advanced_settings() {
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 } "
exit- script
exit_ script
fi
else
exit- script
exit_ script
fi
# Disk Cache
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 \
@@ -298,24 +237,25 @@ function advanced_settings() {
DISK_CACHE = ""
fi
else
exit- script
exit_ script
fi
# Hostname
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
if [ -z $VM_NAME ] ; then
HN = "docker"
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
else
HN = $( echo ${ VM_NAME ,, } | tr -d ' ' )
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
fi
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
else
exit- script
exit_ script
fi
# CPU Model
if CPU_TYPE1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "CPU MODEL" --radiolist "Choose" --cancel-button Exit-Script 10 58 2 \
"0 " "KVM64 (Default )" ON \
"1 " "Host " OFF \
"1 " "Host (Recommended )" ON \
"0 " "KVM64 " OFF \
3>& 1 1>& 2 2>& 3) ; then
if [ $CPU_TYPE1 = "1" ] ; then
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } Host ${ CL } "
@@ -325,80 +265,78 @@ function advanced_settings() {
CPU_TYPE = ""
fi
else
exit- script
exit_ script
fi
# CPU Cores
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
if [ -z $CORE_COUNT ] ; then
CORE_COUNT = "2"
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } $CORE_COUNT ${ CL } "
else
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } $CORE_COUNT ${ CL } "
fi
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } $CORE_COUNT ${ CL } "
else
exit- script
exit_ script
fi
if RAM_SIZE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Allocate RAM in MiB" 8 58 2048 --title "RAM" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
# 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
if [ -z $RAM_SIZE ] ; then
RAM_SIZE = "2048 "
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } $RAM_SIZE ${ CL } "
else
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } $RAM_SIZE ${ CL } "
RAM_SIZE = "4096 "
fi
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } $RAM_SIZE ${ CL } "
else
exit- script
exit_ script
fi
# Bridge
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
if [ -z $BRG ] ; then
BRG = "vmbr0"
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } Bridge: ${ BGN } $BRG ${ CL } "
else
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } Bridge: ${ BGN } $BRG ${ CL } "
fi
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } Bridge: ${ BGN } $BRG ${ CL } "
else
exit- script
exit_ script
fi
# MAC Address
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
MAC = " $GEN_MAC "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } $MAC ${ CL } "
else
MAC = " $MAC1 "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } $MAC1 ${ CL } "
fi
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } $MAC ${ CL } "
else
exit- script
exit_ script
fi
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
# 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
if [ -z $VLAN1 ] ; then
VLAN1 = "Default"
VLAN = ""
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } $VLAN1 ${ CL } "
else
VLAN = " ,tag= $VLAN1 "
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } $VLAN1 ${ CL } "
fi
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } $VLAN1 ${ CL } "
else
exit- script
exit_ script
fi
# MTU
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
if [ -z $MTU1 ] ; then
MTU1 = "Default"
MTU = ""
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
else
MTU = " ,mtu= $MTU1 "
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
fi
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
else
exit- script
exit_ script
fi
# Start VM
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "START VIRTUAL MACHINE" --yesno "Start VM when completed?" 10 58) ; then
echo -e " ${ GATEWAY } ${ BOLD } ${ DGN } Start VM when completed: ${ BGN } yes ${ CL } "
START_VM = "yes"
@@ -407,6 +345,7 @@ function advanced_settings() {
START_VM = "no"
fi
# Confirm
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 } "
else
@@ -427,13 +366,28 @@ function start_script() {
advanced_settings
fi
}
# ==============================================================================
# MAIN EXECUTION
# ==============================================================================
header_info
check_root
arch_check
pve_check
ssh_check
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
start_script
post_to_api_vm
# ==============================================================================
# STORAGE SELECTION
# ==============================================================================
msg_info "Validating Storage"
while read -r line; do
TAG = $( echo $line | awk '{print $1}' )
@@ -446,6 +400,7 @@ while read -r line; do
fi
STORAGE_MENU += ( " $TAG " " $ITEM " "OFF" )
done < <( pvesm status -content images | awk 'NR>1' )
VALID = $( pvesm status -content images | awk 'NR>1' )
if [ -z " $VALID " ] ; then
msg_error "Unable to detect a valid storage location."
@@ -453,6 +408,8 @@ if [ -z "$VALID" ]; then
elif [ $(( ${# STORAGE_MENU [@] } / 3 )) -eq 1 ] ; then
STORAGE = ${ STORAGE_MENU [0] }
else
if [ -n " $SPINNER_PID " ] && ps -p $SPINNER_PID >/dev/null; then kill $SPINNER_PID >/dev/null; fi
printf "\e[?25h"
while [ -z " ${ STORAGE : +x } " ] ; do
STORAGE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "Storage Pools" --radiolist \
" Which storage pool would you like to use for ${ HN } ?\nTo make a selection, use the Spacebar.\n " \
@@ -462,112 +419,288 @@ else
fi
msg_ok " Using ${ CL } ${ BL } $STORAGE ${ CL } ${ GN } for Storage Location. "
msg_ok " Virtual Machine ID is ${ CL } ${ BL } $VMID ${ CL } . "
msg_info "Retrieving the URL for the Debian 12 Qcow2 Disk Image"
URL = " https://cloud.debian.org/images/cloud/bookworm/latest/debian-12-nocloud- $( dpkg --print-architecture) .qcow2 "
sleep 2
msg_ok " ${ CL } ${ BL } ${ URL } ${ CL } "
curl -f#SL -o " $( basename " $URL " ) " " $URL "
echo -en "\e[1A\e[0K"
FILE = $( basename $URL )
msg_ok " Downloaded ${ CL } ${ BL } ${ FILE } ${ CL } "
# ==============================================================================
# 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 "
msg_ok " ${ CL } ${ BL } ${ URL } ${ CL } "
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
# ==============================================================================
STORAGE_TYPE = $( pvesm status -storage " $STORAGE " | awk 'NR>1 {print $2}' )
case $STORAGE_TYPE in
nfs | dir)
DISK_EXT = ".qcow2"
DISK_REF = " $VMID / "
DISK_IMPORT = "-format qcow2"
DISK_IMPORT = "-- format qcow2"
THIN = ""
; ;
btrfs)
DISK_EXT = ".raw"
DISK_REF = " $VMID / "
DISK_IMPORT = "-format raw"
DISK_IMPORT = "-- format raw"
FORMAT = ",efitype=4m"
THIN = ""
; ;
*)
DISK_EXT = ""
DISK_REF = ""
DISK_IMPORT = "--format raw"
; ;
esac
for i in { 0,1} ; do
disk = " DISK $i "
eval DISK${ i } = vm-${ VMID } -disk-${ i } ${ DISK_EXT :- }
eval DISK${ i } _REF = ${ STORAGE } :${ DISK_REF :- } ${ !disk }
# ==============================================================================
# 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
done
if ! command -v virt-customize & >/dev/null; then
msg_info "Installing Pre-Requisite libguestfs-tools onto Host"
apt-get -qq update >/dev/null
apt-get -qq install libguestfs-tools lsb-release -y >/dev/null
# Workaround for Proxmox VE 9.0 libguestfs issue
apt-get -qq install dhcpcd-base -y >/dev/null 2>& 1 || true
msg_ok "Installed libguestfs-tools successfully"
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
fi
msg_info "Adding Docker and Docker Compose Plugin to Debian 12 Qcow2 Disk Image"
virt-customize -q -a " ${ FILE } " --install qemu-guest-agent,apt-transport-https,ca-certificates,curl,gnupg,software-properties-common,lsb-release >/dev/null &&
virt-customize -q -a " ${ FIL E} " --run-command "mkdir -p /etc/apt/keyrings && curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg" >/dev/null &&
virt-customize -q -a " ${ FILE } " --run-command "echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian bookworm stable' > /etc/apt/sources.list.d/docker.list" >/dev/null &&
virt-customize -q -a " ${ FILE } " --run-command "apt-get update -qq && apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin" >/dev/null &&
virt-customize -q -a " ${ FILE } " --run-command "systemctl enable docker" >/dev/null &&
virt-customize -q -a " ${ FILE } " --hostname " ${ HN } " >/dev/null &&
virt-customize -q -a " ${ FILE } " --run-command "echo -n > /etc/machine-id" >/dev/null
msg_ok "Added Docker and Docker Compose Plugin to Debian 12 Qcow2 Disk Image successfully"
# Resize disk to target size
msg_info " Resizing disk image to ${ DISK_SIZE } "
qemu-img resize " $WORK_FILE " " ${ DISK_SIZ E} " >/dev/null 2>& 1
msg_ok "Resized disk image"
msg_info "Expanding root partition to use full disk space"
qemu-img create -f qcow2 expanded.qcow2 ${ DISK_SIZE } >/dev/null 2>& 1
virt-resize --expand /dev/sda1 ${ FILE } expanded.qcow2 >/dev/null 2>& 1
mv expanded.qcow2 ${ FILE } >/dev/null 2>& 1
msg_ok "Expanded image to full size"
# ==============================================================================
# VM CREATION
# ==============================================================================
msg_info "Creating Docker VM shell"
msg_info "Creating a Docker VM"
qm create $VMID -agent 1${ MACHINE } -tablet 0 -localtime 1 -bios ovmf${ CPU_TYPE } -cores $CORE_COUNT -memory $RAM_SIZE \
-name $HN -tags community-script -net0 virtio,bridge= $BRG ,macaddr= $MAC $VLAN $MTU -onboot 1 -ostype l26 -scsihw virtio-scsi-pci
pvesm alloc $STORAGE $VMID $DISK0 4M 1>& /dev/null
qm importdisk $VMID ${ FILE } $STORAGE ${ DISK_IMPORT :- } 1>& /dev/null
qm set $VMID \
-efidisk0 ${ DISK0_REF } ${ FORMAT } \
-scsi0 ${ DISK1_REF } ,${ DISK_CACHE } ${ THIN } size = ${ DISK_SIZE } \
-boot order = scsi0 \
-serial0 socket >/dev/null
qm resize $VMID scsi0 8G >/dev/null
-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
qm set $VMID --agent enabled = 1 >/dev/null
DESCRIPTION = $(
cat <<EOF
<div align='center'>
<a href='https://Helper-Scripts.com' target='_blank' rel='noopener noreferrer'>
<img src='https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/images/logo-81x112.png' alt='Logo' style='width:81px;height:112px;'/>
</a>
msg_ok "Attached EFI and root disk"
<h2 style='font-size: 24px; margin: 20px 0;'>Docker VM</h2>
# Set VM description
set_description
<p style='margin: 16px 0;'>
<a href='https://ko-fi.com/community_scripts' target='_blank' rel='noopener noreferrer'>
<img src='https://img.shields.io/badge/☕-Buy us a coffee-blue' alt='spend Coffee' />
</a>
</p>
# 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
<span style='margin: 0 10px;'>
<i class="fa fa-github fa-fw" style="color: #f5f5f5;"></i>
<a href='https://github.com/community-scripts/ProxmoxVE' target='_blank' rel='noopener noreferrer' style='text-decoration: none; color: #00617f;'>GitHub</a>
</span>
<span style='margin: 0 10px;'>
<i class="fa fa-comments fa-fw" style="color: #f5f5f5;"></i>
<a href='https://github.com/community-scripts/ProxmoxVE/discussions' target='_blank' rel='noopener noreferrer' style='text-decoration: none; color: #00617f;'>Discussions</a>
</span>
<span style='margin: 0 10px;'>
<i class="fa fa-exclamation-circle fa-fw" style="color: #f5f5f5;"></i>
<a href='https://github.com/community-scripts/ProxmoxVE/issues' target='_blank' rel='noopener noreferrer' style='text-decoration: none; color: #00617f;'>Issues</a>
</span>
</div>
EOF
)
qm set $VMID -description " $DESCRIPTION " >/dev/null
msg_ok " Created a Docker VM ${ CL } ${ BL } ( ${ HN } ) "
# Start VM
if [ " $START_VM " = = "yes" ] ; then
msg_info "Starting Docker VM"
qm start $VMID
qm start $VMID >/dev/null 2>& 1
msg_ok "Started Docker VM"
fi
# ==============================================================================
# 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
post_update_to_api "done" "none"
msg_ok "Completed successfully!\n"