@@ -1,280 +1,43 @@
#!/usr/bin/env bash
#!/usr/bin/env bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: MickLesk (CanbiZ)
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
source /dev/stdin <<< $( curl -fsSL https: //raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func )
COMMUNITY_SCRIPTS_URL = " ${ COMMUNITY_SCRIPTS_URL :- https : //raw.githubusercontent.com/community-scripts/ProxmoxVED /main } "
source <( curl -fsSL " ${ COMMUNITY_SCRIPTS_CORE_URL :- https : //raw.githubusercontent.com/community-scripts/core/main } /pve/vm-core.func " )
load_functions
function header_info {
clear
cat <<"EOF"
__ __ __ __ ____ _____ _ ____ ___
/ / / /___ ___ / /_ ________ / / / __ \/ ___/ | | / / | / /
/ / / / __ ` __ \/ __ \/ ___/ _ \/ / / / / /\_ _ \ | | / / /| _/ /
/ /_/ / / / / / / /_/ / / / __/ / / /_/ /___/ / | | / / / / /
\_ ___/_/ /_/ /_/_.___/_/ \_ __/_/ \_ ___//____/ | ___/_/ /_/
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 = ""
APP = "Umbrel OS"
APP_TYPE = "vm"
NSAPP = "umbrel-os-vm"
var_os = "umbrel-os"
var_version = "n.d."
YW = $( echo "\033[33m" )
BL = $( echo "\033[36m" )
HA = $( echo "\033[1;34m" )
RD = $( echo "\033[01;31m" )
BGN = $( echo "\033[4;92m" )
GN = $( echo "\033[1;92m" )
DGN = $( echo "\033[32m" )
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 } "
THIN = "discard=on,ssd=1,"
header_info
echo -e "\n Loading..."
set -e
trap 'error_handler $LINENO "$BASH_COMMAND"' ERR
trap cleanup EXIT
trap 'post_update_to_api "failed" "130"' SIGINT
trap 'post_update_to_api "failed" "143"' SIGTERM
trap 'post_update_to_api "failed" "129"; exit 129' SIGHUP
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 } "
post_update_to_api "failed" " ${ exit_code } "
echo -e " \n $error_message \n "
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
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( ) {
local exit_code = $?
popd >/dev/null
if [ [ " ${ POST_TO_API_DONE :- } " = = "true" && " ${ POST_UPDATE_DONE :- } " != "true" ] ] ; then
if [ [ $exit_code -eq 0 ] ] ; then
post_update_to_api "done" "none"
else
post_update_to_api "failed" " $exit_code "
fi
fi
rm -rf $TEMP_DIR
}
vm_require_arch amd64
TEMP_DIR = $( mktemp -d)
pushd $TEMP_DIR >/dev/null
if whiptail --backtitle "Proxmox VE Helper Scripts" --title "Umbrel OS VM" --yesno "This will create a New Umbrel OS 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 –
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–
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 –
exit 105
fi
return 0
fi
# Check for Proxmox VE 9.x: allow 9.0 and 9.2
if [ [ " $PVE_VER " = ~ ^9\. ( [ 0-9] +) ] ] ; then
local MINOR = " ${ BASH_REMATCH [1] } "
if ( ( MINOR < 0 || MINOR > 2) ) ; then
msg_error "This version of Proxmox VE is not supported."
msg_error "Supported: Proxmox VE version 9.0 –
exit 105
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 – –
exit 105
}
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
}
# Ensure pv is installed or abort with instructions
function ensure_pv( ) {
if ! command -v pv & >/dev/null; then
msg_info "Installing required package: pv"
if ! apt-get update -qq & >/dev/null || ! apt-get install -y pv & >/dev/null; then
msg_error "Failed to install pv automatically."
echo -e "\nPlease run manually on the Proxmox host:\n apt install pv\n"
exit 237
fi
msg_ok "Installed pv"
fi
}
# Download an .xz file and validate it
# Args: $1=url $2=cache_file
function download_and_validate_xz( ) {
local url = " $1 "
local file = " $2 "
# If file exists, check validity
if [ [ -s " $file " ] ] ; then
if xz -t " $file " & >/dev/null; then
msg_ok " Using cached image $( basename " $file " ) "
return 0
else
msg_error " Cached file $( basename " $file " ) is corrupted. Deleting and retrying download... "
rm -f " $file "
fi
fi
# Download fresh file
msg_info " Downloading image: $( basename " $file " ) "
if ! curl -fSL -o " $file " " $url " ; then
msg_error " Download failed: $url "
rm -f " $file "
exit 115
fi
# Validate again
if ! xz -t " $file " & >/dev/null; then
msg_error " Downloaded file $( basename " $file " ) is corrupted. Please try again later. "
rm -f " $file "
exit 115
fi
msg_ok " Downloaded and validated $( basename " $file " ) "
}
# Extract .xz with pv
# Args: $1=cache_file $2=target_img
function extract_xz_with_pv( ) {
set -o pipefail
local file = " $1 "
local target = " $2 "
msg_info " Decompressing $( basename " $file " ) to $target "
if ! xz -dc " $file " | pv -N "Extracting" >" $target " ; then
msg_error " Failed to extract $file "
rm -f " $target "
exit 115
fi
msg_ok " Decompressed to $target "
}
function default_settings( ) {
vm_apply_machine_type "q35"
VMID = $( get_valid_nextid)
MACHINE = " -machine q35"
FORMAT = ""
DISK_SIZE = "32G"
HN = "umbrelos"
CPU_TYPE = ""
@@ -286,223 +49,27 @@ 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 } q35 ${ CL } "
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } ${ DISK_SIZE } ${ CL } "
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } ${ HN } ${ CL } "
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } KVM64 ${ 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 } "
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 } "
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Umbrel OS VM using the above default settings ${ CL } "
vm_echo_default_settings
}
function advanced_settings( ) {
METHOD = "advanced"
[ -z " ${ VMID :- } " ] && VMID = $( get_valid_nextid)
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
VMID = $( get_valid_nextid)
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
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } Virtual Machine ID: ${ BGN } $VMID ${ CL } "
break
else
exit-script
fi
done
vm_prompt_vmid " ${ VMID :- $( get_valid_nextid) } "
vm_prompt_machine_type "q35"
vm_prompt_disk_size "32G"
vm_prompt_disk_cache "none"
vm_prompt_hostname "umbrelos"
vm_prompt_cpu_model "kvm64"
vm_prompt_cpu_cores "2"
vm_prompt_ram "4096 "
vm_prompt_bridge "vmbr0"
vm_prompt_mac " $GEN_MAC "
vm_prompt_vlan
vm_prompt_mtu
vm_prompt_verbose "no"
vm_prompt_start_vm "yes"
if MACH = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "MACHINE TYPE" --radiolist --cancel-button Exit-Script "Choose Machine Type" 10 58 2 \
"q35" "Modern (PCIe, UEFI, default)" ON \
"i440fx" "Legacy (older compatibility)" OFF \
3>& 1 1>& 2 2>& 3) ; then
if [ " $MACH " = "q35" ] ; then
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } q35 ${ CL } "
FORMAT = ""
MACHINE = " -machine q35"
else
echo -e " ${ CONTAINERTYPE } ${ BOLD } ${ DGN } Machine Type: ${ BGN } i440fx ${ CL } "
FORMAT = ",efitype=4m"
MACHINE = ""
fi
else
exit-script
fi
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 } "
exit-script
fi
else
exit-script
fi
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
if [ $DISK_CACHE = "1" ] ; then
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Cache: ${ BGN } Write Through ${ CL } "
DISK_CACHE = "cache=writethrough,"
else
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Cache: ${ BGN } None ${ CL } "
DISK_CACHE = ""
fi
else
exit-script
fi
if VM_NAME = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Hostname" 8 58 umbrelos --title "HOSTNAME" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $VM_NAME ] ; then
HN = "umbrelos"
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
else
HN = $( echo " ${ VM_NAME ,, } " | tr -cs 'a-z0-9-' '-' | sed 's/^-//;s/-$//' )
if [ " $HN " != " ${ VM_NAME ,, } " ] ; then
whiptail --backtitle "Proxmox VE Helper Scripts" --title "HOSTNAME ADJUSTED" --msgbox " Invalid characters detected. Hostname has been adjusted to:\n\n $HN " 10 58
fi
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } $HN ${ CL } "
fi
else
exit-script
fi
if CPU_TYPE1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --title "CPU MODEL" --radiolist "Choose CPU Model" --cancel-button Exit-Script 10 58 2 \
"KVM64" "Default – ON \
"Host" "Use host CPU features (faster, no migration)" OFF \
3>& 1 1>& 2 2>& 3) ; then
case " $CPU_TYPE1 " in
"Host" )
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } Host ${ CL } "
CPU_TYPE = " -cpu host"
; ;
*)
echo -e " ${ OS } ${ BOLD } ${ DGN } CPU Model: ${ BGN } KVM64 ${ CL } "
CPU_TYPE = ""
; ;
esac
else
exit-script
fi
while true; do
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" ; fi
if [ [ " $CORE_COUNT " = ~ ^[ 1-9] [ 0-9] *$ ] ] ; then
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } $CORE_COUNT ${ CL } "
break
fi
whiptail --backtitle "Proxmox VE Helper Scripts" --title "INVALID INPUT" --msgbox "CPU Cores must be a positive integer (e.g., 2)." 8 58
else
exit-script
fi
done
while true; do
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
if [ -z " $RAM_SIZE " ] ; then RAM_SIZE = "2048" ; fi
if [ [ " $RAM_SIZE " = ~ ^[ 1-9] [ 0-9] *$ ] ] ; then
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM Size: ${ BGN } $RAM_SIZE ${ CL } "
break
fi
whiptail --backtitle "Proxmox VE Helper Scripts" --title "INVALID INPUT" --msgbox "RAM Size must be a positive integer in MiB (e.g., 2048)." 8 58
else
exit-script
fi
done
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
else
exit-script
fi
while true; do
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 } "
break
fi
if [ [ " $MAC1 " = ~ ^( [ 0-9A-Fa-f] { 2} :) { 5} [ 0-9A-Fa-f] { 2} $ ] ] ; then
MAC = " $MAC1 "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } MAC Address: ${ BGN } $MAC1 ${ CL } "
break
fi
whiptail --backtitle "Proxmox VE Helper Scripts" --title "INVALID INPUT" --msgbox "Invalid MAC address format. Use XX:XX:XX:XX:XX:XX (e.g., AA:BB:CC:DD:EE:FF)." 8 58
else
exit-script
fi
done
while true; do
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 } "
break
fi
if [ [ " $VLAN1 " = ~ ^[ 0-9] +$ ] ] && [ " $VLAN1 " -ge 1 ] && [ " $VLAN1 " -le 4094 ] ; then
VLAN = " ,tag= $VLAN1 "
echo -e " ${ VLANTAG } ${ BOLD } ${ DGN } VLAN: ${ BGN } $VLAN1 ${ CL } "
break
fi
whiptail --backtitle "Proxmox VE Helper Scripts" --title "INVALID INPUT" --msgbox "VLAN must be a number between 1 and 4094, or leave blank for default." 8 58
else
exit-script
fi
done
while true; do
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 } "
break
fi
if [ [ " $MTU1 " = ~ ^[ 0-9] +$ ] ] && [ " $MTU1 " -ge 576 ] && [ " $MTU1 " -le 65520 ] ; then
MTU = " ,mtu= $MTU1 "
echo -e " ${ DEFAULT } ${ BOLD } ${ DGN } Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
break
fi
whiptail --backtitle "Proxmox VE Helper Scripts" --title "INVALID INPUT" --msgbox "MTU Size must be a number between 576 and 65520, or leave blank for default." 8 58
else
exit-script
fi
done
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"
else
echo -e " ${ GATEWAY } ${ BOLD } ${ DGN } Start VM when completed: ${ BGN } no ${ CL } "
START_VM = "no"
fi
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "ADVANCED SETTINGS COMPLETE" --yesno "Ready to create a Umbrel OS VM?" --no-button Do-Over 10 58) ; then
if vm_confirm_advanced_settings "Ready to create a Umbrel OS VM?" ; then
echo -e " ${ CREATING } ${ BOLD } ${ DGN } Creating a Umbrel OS VM using the above advanced settings ${ CL } "
else
header_info
@@ -511,128 +78,79 @@ function 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
echo -e " ${ DEFAULT } ${ BOLD } ${ BL } Using Default Settings ${ CL } "
default_settings
else
header_info
echo -e " ${ ADVANCED } ${ BOLD } ${ RD } Using Advanced Settings ${ CL } "
advanced_settings
fi
}
check_roo t
arch_check
pve_check
ssh_check
ensure_pv
start_script
vm_prefligh t
vm_start_script "Use Default Settings?\n\nDefaults:\n• 2 CPU Cores\n• 4 GB RAM\n• 32 GB Disk" 13 58
post_to_api_vm
msg_info "Validating Storage "
STORAGE_MENU = ( )
while read -r tag type free; do
ITEM = " Type: $type Free: $free "
STORAGE_MENU += ( " $tag " " $ITEM " "OFF" )
done < <( pvesm status -content images | awk 'NR>1 {printf "%s %s %s\n", $1, $2, $6}' )
vm_select_storage " $HN "
if [ ${# STORAGE_MENU [@] } -eq 0 ] ; then
msg_error "Unable to detect a valid storage location."
exit 119
elif [ $(( ${# STORAGE_MENU [@] } / 3 )) -eq 1 ] ; then
STORAGE = ${ STORAGE_MENU [0] }
else
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 " \
16 70 6 \
" ${ STORAGE_MENU [@] } " 3>& 1 1>& 2 2>& 3)
done
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 Umbrel OS installer ISO "
UMBREL_RELEASE = " $( curl -fsSL --max-time 20 https://api.umbrel.com/latest-release 2>/dev/null |
sed -n 's/.*"version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' ) "
[ [ -z " $UMBREL_RELEASE " ] ] && UMBREL_RELEASE = "latest"
var_version = " $UMBREL_RELEASE "
URL = "https://download.umbrel.com/release/latest /umbrelos-amd64.img.xz "
CACHE_DIR = "/var/lib/vz/template/cache"
CACHE_FILE = " $CACHE_DIR / $( basename " $URL " ) "
FILE_IMG = " /var/lib/vz/template/tmp/ ${ CACHE_FILE ##*/%.xz } "
URL = " https://download.umbrel.com/release/ ${ UMBREL_RELEASE } /umbrelos-amd64-usb-installer.iso "
# The upstream file name is the same for every release, so the version goes into
# the cached name -- otherwise the cache serves 1.7.4 to someone asking for 2.0.
ISO_NAME = " umbrelos- ${ UMBREL_RELEASE } -amd64-usb-installer.iso "
CACHE_DIR = "/var/lib/vz/template/iso"
CACHE_FILE = " ${ CACHE_DIR } / ${ ISO_NAME } "
mkdir -p " $CACHE_DIR "
msg_ok " ${ CL } ${ BL } ${ URL } ${ CL } "
mkdir -p " $CACHE_DIR " " $( dirname " $FILE_IMG " ) "
# download.umbrel.com answers 307 for any name at all, so a redirect proves
# nothing about the file existing. Size is what separates an ISO from a 404 page.
msg_info "Downloading the Umbrel OS installer ISO (approximately 1.8 GB)"
vm_fetch_image " $URL " " $CACHE_FILE " --cache --min-bytes $(( 1024 * 1024 * 1024 )) || exit 115
download_and_validate_xz " $URL " " $CACHE_FILE "
qm create $VMID ${ MACHINE } -bios ovmf -agent 1 -tablet 0 -localtime 1 ${ CPU_TYPE } \
msg_info "Creating a Umbrel OS VM "
# Umbrel requires EFI: the installer ISO has no legacy boot path. Its own
# console runs on tty1, so this VM is driven through noVNC, not the serial line.
qm create " $VMID " ${ MACHINE } -bios ovmf -agent enabled = 1 -tablet 0 -localtime 1 ${ 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 >/dev/null
extract_xz_with_pv " $CACHE_FILE " " $FILE_IMG "
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 " " $FILE_IMG " " $STORAGE " --format raw 2>& 1 || true ) "
DISK_REF = " $( printf '%s\n' " $IMPORT_OUT " | sed -n "s/.*imported disk '\([^']\+\)'.*/\1/p" | tr -d "\r\"'" ) "
[ [ -z " $DISK_REF " ] ] && DISK_REF = " $( pvesm list " $STORAGE " | awk -v id = " $VMID " '$5 ~ ("vm-"id"-disk-") {print $1":"$5}' | sort | tail -n1) "
qm set $VMID \
--efidisk0 ${ STORAGE } :0,efitype= 4m \
--scsi0 ${ DISK_REF } ,ssd= 1,discard= on \
--boot order = scsi0 \
--serial0 socket >/dev/null
qm set $VMID --agent enabled = 1 >/dev/null
qm resize $VMID scsi0 ${ DISK_SIZE } >/dev/null
DESCRIPTION = $(
cat <<EOF
<div align='center'>
<a href='https://community-scripts.org' 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>
<h2 style='font-size: 24px; margin: 20px 0;'>Umbrel OS VM</h2>
<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>
<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
if whiptail --backtitle "Proxmox VE Helper Scripts" --title "Image Cache" \
--yesno " Keep downloaded Umbrel OS image for future VMs?\n\nFile: $CACHE_FILE " 10 70; then
msg_ok "Keeping cached image"
else
rm -f " $CACHE_FILE "
msg_ok "Deleted cached image"
fi
rm -f " $FILE_IMG "
-net0 " virtio,bridge= $BRG ,macaddr= $MAC $VLAN $MTU " -onboot 1 -ostype l26 -scsihw virtio-scsi-pci \
-efidisk0 " ${ STORAGE } :1,efitype=4m,pre-enrolled-keys=0 " \
-scsi0 " ${ STORAGE } : ${ DISK_SIZE %G } , ${ DISK_CACHE :- } ${ THIN %, } " \
-cdrom " local:iso/ ${ ISO_NAME } " -boot order = 'scsi0;ide2' >/dev/null
set_description
msg_ok " Created a Umbrel OS VM ${ CL } ${ BL } ( ${ HN } ) "
if [ [ " ${ VM_UNATTENDED :- 0 } " = = "1" ] ] ; then
KEEP_IMAGE = " ${ VM_KEEP_IMAGE :- yes } "
elif vm_dialog yesno "Image Cache" \
" Keep downloaded Umbrel OS installer ISO for future VMs?\n\nFile: $CACHE_FILE " 10 70; then
KEEP_IMAGE = "yes"
else
KEEP_IMAGE = "no"
fi
if [ [ " $KEEP_IMAGE " = = "yes" ] ] ; then
msg_ok "Keeping cached ISO"
else
msg_warn "The ISO is still attached to the VM, so it is removed after the install"
KEEP_IMAGE = "no"
fi
if [ " $START_VM " = = "yes" ] ; then
msg_info "Starting Umbrel OS VM"
qm start $VMID
$STD $VMID
msg_ok "Started Umbrel OS VM"
fi
post_update_to_api "done" "none"
echo -e " \n ${ INFO } ${ BOLD } ${ YW } Next Steps: ${ CL } "
echo -e " ${ TAB } 1. Open the VM console in Proxmox (noVNC) "
echo -e " ${ TAB } 2. The installer asks which storage device to install umbrelOS on. "
echo -e " ${ TAB } Pick the ${ BL } sda ${ CL } entry -- ${ BL } sr0 ${ CL } is the installer ISO itself "
echo -e " ${ TAB } 3. Confirm, wait for it to finish, then press a key to power off "
echo -e " ${ TAB } 4. Detach the ISO ( ${ BL } qm set ${ VMID } --ide2 none ${ CL } ) and start the VM "
echo -e " ${ TAB } 5. umbrelOS is then reachable at ${ BL } http://umbrel.local ${ CL } "
if [ [ " $KEEP_IMAGE " = = "no" ] ] ; then
echo -e " ${ TAB } Delete ${ BL } ${ CACHE_FILE } ${ CL } once the ISO is detached "
fi
msg_ok "Completed successfully!\n"
github-actions[bot]