2023-05-22 11:54:10 +01:00
#!/usr/bin/env bash
2026-01-06 13:28:12 +01:00
# Copyright (c) 2021-2026 tteck
2023-05-22 11:54:10 +01:00
# Author: tteck (tteckster)
# Jon Spriggs (jontheniceguy)
# License: MIT
2024-11-02 08:48:05 +01:00
# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
2023-05-22 11:54:10 +01:00
# Based on work from https://i12bretro.github.io/tutorials/0405.html
2025-04-01 10:25:46 +02:00
source /dev/stdin <<< $( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func)
2025-02-10 09:13:09 +01:00
2023-05-22 11:54:10 +01:00
function header_info {
2023-05-23 07:36:27 -04:00
clear
2023-05-22 11:54:10 +01:00
cat <<"EOF"
2023-05-23 07:36:27 -04:00
____ _ __ __
/ __ \_ ___ ___ ____| | / /____/ /_
/ / / / __ \/ _ \/ __ \ | /| / / ___/ __/
/ /_/ / /_/ / __/ / / / | / | / / / / /_
\_ ___/ .___/\_ __/_/ /_/| __/| __/_/ \_ _/
/_/ W I R E L E S S F R E E D O M
2023-05-22 11:54:10 +01:00
EOF
}
header_info
2025-09-15 13:17:45 +02:00
echo -e "\n Loading..."
2025-02-10 09:13:09 +01:00
RANDOM_UUID = " $( cat /proc/sys/kernel/random/uuid) "
METHOD = ""
NSAPP = "openwrt-vm"
var_os = "openwrt"
var_version = " "
2025-09-15 13:17:45 +02:00
DISK_SIZE = "1G"
2023-05-23 07:36:27 -04:00
GEN_MAC = 02:$( openssl rand -hex 5 | awk '{print toupper($0)}' | sed 's/\(..\)/\1:/g; s/.$//' )
GEN_MAC_LAN = 02:$( openssl rand -hex 5 | awk '{print toupper($0)}' | sed 's/\(..\)/\1:/g; s/.$//' )
2025-05-07 12:37:46 +02:00
2023-05-22 11:54:10 +01:00
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" )
2025-09-15 13:17:45 +02:00
BOLD = $( echo "\033[1m" )
2023-05-22 11:54:10 +01:00
BFR = "\\r\\033[K"
2025-09-15 13:17:45 +02:00
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 } "
2023-09-26 11:43:20 -04:00
set -Eeo pipefail
2023-05-23 07:36:27 -04:00
trap 'error_handler $LINENO "$BASH_COMMAND"' ERR
2023-05-22 11:54:10 +01:00
trap cleanup EXIT
2026-02-23 14:30:48 +01:00
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
2023-05-23 07:36:27 -04:00
function error_handler( ) {
local exit_code = " $? "
local line_number = " $1 "
local command = " $2 "
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 "
2023-05-23 07:36:27 -04:00
local error_message = " ${ RD } [ERROR] ${ CL } in line ${ RD } $line_number ${ CL } : exit code ${ RD } $exit_code ${ CL } : while executing command ${ YW } $command ${ CL } "
echo -e " \n $error_message \n "
2025-09-16 11:40:05 +02:00
cleanup_vmid
2023-05-22 11:54:10 +01:00
}
2023-05-23 07:36:27 -04:00
2025-05-07 12:37:46 +02:00
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 "
}
2025-09-16 11:40:05 +02:00
function cleanup_vmid( ) {
if qm status $VMID & >/dev/null; then
qm stop $VMID & >/dev/null
qm destroy $VMID & >/dev/null
fi
}
2023-05-23 07:36:27 -04:00
2023-05-22 11:54:10 +01:00
function cleanup( ) {
core/vm's: ensure script state is sent on script exit (#11991)
* Ensure API update is sent on script exit
Add exit-time telemetry handling across scripts to avoid orphaned "installing" records. Introduce local exit_code capture in api_exit_script and cleanup handlers and, when POST_TO_API_DONE is true but POST_UPDATE_DONE is not, post a final status (marking failures on non-zero exit codes, or marking done/failed in VM cleanups based on exit code). Changes touch misc/build.func, misc/vm-core.func and various vm/*-vm.sh cleanup functions to reliably send post_update_to_api on normal or early exits.
* Update api.func
* fix(telemetry): add missing exit codes to explain_exit_code()
- Add curl error codes: 4, 5, 8, 23, 25, 30, 56, 78
- Add code 10: Docker/privileged mode required (used in ~15 scripts)
- Add code 75: Temporary failure (retry later)
- Add BSD sysexits.h codes: 64-77
- Sync error_handler.func fallback with canonical api.func
2026-02-16 17:14:00 +01:00
local exit_code = $?
2023-05-22 11:54:10 +01:00
popd >/dev/null
core/vm's: ensure script state is sent on script exit (#11991)
* Ensure API update is sent on script exit
Add exit-time telemetry handling across scripts to avoid orphaned "installing" records. Introduce local exit_code capture in api_exit_script and cleanup handlers and, when POST_TO_API_DONE is true but POST_UPDATE_DONE is not, post a final status (marking failures on non-zero exit codes, or marking done/failed in VM cleanups based on exit code). Changes touch misc/build.func, misc/vm-core.func and various vm/*-vm.sh cleanup functions to reliably send post_update_to_api on normal or early exits.
* Update api.func
* fix(telemetry): add missing exit codes to explain_exit_code()
- Add curl error codes: 4, 5, 8, 23, 25, 30, 56, 78
- Add code 10: Docker/privileged mode required (used in ~15 scripts)
- Add code 75: Temporary failure (retry later)
- Add BSD sysexits.h codes: 64-77
- Sync error_handler.func fallback with canonical api.func
2026-02-16 17:14:00 +01:00
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
2025-04-09 18:59:56 +02:00
rm -rf $TEMP_DIR
2023-05-22 11:54:10 +01:00
}
2023-05-23 07:36:27 -04:00
TEMP_DIR = $( mktemp -d)
2025-04-09 18:59:56 +02:00
pushd $TEMP_DIR >/dev/null
2023-05-22 11:54:10 +01:00
function send_line_to_vm( ) {
echo -e " ${ DGN } Sending line: ${ YW } $1 ${ CL } "
2023-05-22 07:40:19 -04:00
for ( ( i = 0; i < ${# 1 } ; i++) ) ; do
2023-05-22 11:54:10 +01:00
character = ${ 1 : i : 1 }
case $character in
2023-05-22 07:40:19 -04:00
" " ) character = "spc" ; ;
"-" ) character = "minus" ; ;
"=" ) character = "equal" ; ;
"," ) character = "comma" ; ;
"." ) character = "dot" ; ;
"/" ) character = "slash" ; ;
"'" ) character = "apostrophe" ; ;
";" ) character = "semicolon" ; ;
'\' ) character = "backslash" ; ;
'`' ) character = "grave_accent" ; ;
"[" ) character = "bracket_left" ; ;
"]" ) character = "bracket_right" ; ;
"_" ) character = "shift-minus" ; ;
"+" ) character = "shift-equal" ; ;
"?" ) character = "shift-slash" ; ;
"<" ) character = "shift-comma" ; ;
">" ) character = "shift-dot" ; ;
'"' ) character = "shift-apostrophe" ; ;
":" ) character = "shift-semicolon" ; ;
"|" ) character = "shift-backslash" ; ;
"~" ) character = "shift-grave_accent" ; ;
"{" ) character = "shift-bracket_left" ; ;
"}" ) character = "shift-bracket_right" ; ;
"A" ) character = "shift-a" ; ;
"B" ) character = "shift-b" ; ;
"C" ) character = "shift-c" ; ;
"D" ) character = "shift-d" ; ;
"E" ) character = "shift-e" ; ;
"F" ) character = "shift-f" ; ;
"G" ) character = "shift-g" ; ;
"H" ) character = "shift-h" ; ;
"I" ) character = "shift-i" ; ;
"J" ) character = "shift-j" ; ;
"K" ) character = "shift-k" ; ;
"L" ) character = "shift-l" ; ;
"M" ) character = "shift-m" ; ;
"N" ) character = "shift-n" ; ;
"O" ) character = "shift-o" ; ;
"P" ) character = "shift-p" ; ;
"Q" ) character = "shift-q" ; ;
"R" ) character = "shift-r" ; ;
"S" ) character = "shift-s" ; ;
"T" ) character = "shift-t" ; ;
"U" ) character = "shift-u" ; ;
"V" ) character = "shift-v" ; ;
"W" ) character = "shift-w" ; ;
"X" ) character = "shift=x" ; ;
"Y" ) character = "shift-y" ; ;
"Z" ) character = "shift-z" ; ;
"!" ) character = "shift-1" ; ;
"@" ) character = "shift-2" ; ;
"#" ) character = "shift-3" ; ;
'$' ) character = "shift-4" ; ;
"%" ) character = "shift-5" ; ;
"^" ) character = "shift-6" ; ;
"&" ) character = "shift-7" ; ;
"*" ) character = "shift-8" ; ;
"(" ) character = "shift-9" ; ;
")" ) character = "shift-0" ; ;
2023-05-22 11:54:10 +01:00
esac
2025-04-09 18:59:56 +02:00
qm sendkey $VMID " $character "
2023-05-22 11:54:10 +01:00
done
2025-04-09 18:59:56 +02:00
qm sendkey $VMID ret
2023-05-22 11:54:10 +01:00
}
TEMP_DIR = $( mktemp -d)
2025-04-09 18:59:56 +02:00
pushd $TEMP_DIR >/dev/null
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "OpenWrt VM" --yesno "This will create a New OpenWrt VM. Proceed?" 10 58) ; then
2023-05-23 07:36:27 -04:00
:
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
header_info && echo -e "⚠ User exited script \n" && exit
2023-05-22 11:54:10 +01:00
fi
function msg_info( ) {
local msg = " $1 "
echo -ne " ${ HOLD } ${ YW } ${ msg } ... "
}
2023-05-23 07:36:27 -04:00
2023-05-22 11:54:10 +01:00
function msg_ok( ) {
local msg = " $1 "
echo -e " ${ BFR } ${ CM } ${ GN } ${ msg } ${ CL } "
}
2023-05-23 07:36:27 -04:00
function msg_error( ) {
local msg = " $1 "
echo -e " ${ BFR } ${ CROSS } ${ RD } ${ msg } ${ CL } "
}
2025-08-06 13:46:07 +02:00
# This function checks the version of Proxmox Virtual Environment (PVE) and exits if the version is not supported.
2025-11-22 14:35:13 +01:00
# Supported: Proxmox VE 8.0.x – 8.9.x, 9.0 and 9.1
2025-07-28 11:00:09 +02:00
pve_check( ) {
local PVE_VER
PVE_VER = " $( pveversion | awk -F'/' '{print $2}' | awk -F'-' '{print $1}' ) "
2025-08-06 13:46:07 +02:00
# Check for Proxmox VE 8.x: allow 8.0– 8.9
2025-07-28 11:00:09 +02:00
if [ [ " $PVE_VER " = ~ ^8\. ( [ 0-9] +) ] ] ; then
local MINOR = " ${ BASH_REMATCH [1] } "
2025-08-06 13:46:07 +02:00
if ( ( MINOR < 0 || MINOR > 9) ) ; then
2025-07-28 11:00:09 +02:00
msg_error "This version of Proxmox VE is not supported."
2025-08-06 13:46:07 +02:00
msg_error "Supported: Proxmox VE version 8.0 – 8.9"
core: standardize exit codes and add mappings (#12467)
* Standardize exit codes and add mappings
Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics.
* Set exit code 115 for update_os errors
Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases.
* Add tools/addon exit codes and use them
Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations.
* Standardize exit codes in exporter addons
Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation.
* Use specific exit codes in addon scripts
Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh.
* Use specific exit codes in addon scripts
Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting.
* Use specific exit codes in PVE scripts
Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions.
* Standardize exit codes and behaviors
Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include:
- container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1).
- fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1).
- kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1).
- lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0).
- nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1).
- pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1.
These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate.
* Use exit 105 for unsupported PVE versions
Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts.
* Use specific exit codes in VM scripts
Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
2026-03-02 10:55:20 +01:00
exit 105
2025-07-28 11:00:09 +02:00
fi
return 0
2025-04-15 15:20:46 +02:00
fi
2025-07-28 11:00:09 +02:00
2025-11-22 14:35:13 +01:00
# Check for Proxmox VE 9.x: allow 9.0 and 9.1
2025-07-28 11:00:09 +02:00
if [ [ " $PVE_VER " = ~ ^9\. ( [ 0-9] +) ] ] ; then
2025-08-06 13:46:07 +02:00
local MINOR = " ${ BASH_REMATCH [1] } "
2025-11-22 14:35:13 +01:00
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"
core: standardize exit codes and add mappings (#12467)
* Standardize exit codes and add mappings
Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics.
* Set exit code 115 for update_os errors
Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases.
* Add tools/addon exit codes and use them
Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations.
* Standardize exit codes in exporter addons
Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation.
* Use specific exit codes in addon scripts
Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh.
* Use specific exit codes in addon scripts
Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting.
* Use specific exit codes in PVE scripts
Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions.
* Standardize exit codes and behaviors
Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include:
- container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1).
- fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1).
- kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1).
- lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0).
- nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1).
- pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1.
These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate.
* Use exit 105 for unsupported PVE versions
Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts.
* Use specific exit codes in VM scripts
Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
2026-03-02 10:55:20 +01:00
exit 105
2025-07-28 11:00:09 +02:00
fi
2025-08-06 13:46:07 +02:00
return 0
2025-07-28 11:00:09 +02:00
fi
# All other unsupported versions
msg_error "This version of Proxmox VE is not supported."
2025-11-22 14:35:13 +01:00
msg_error "Supported versions: Proxmox VE 8.0 – 8.x or 9.0 – 9.1"
core: standardize exit codes and add mappings (#12467)
* Standardize exit codes and add mappings
Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics.
* Set exit code 115 for update_os errors
Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases.
* Add tools/addon exit codes and use them
Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations.
* Standardize exit codes in exporter addons
Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation.
* Use specific exit codes in addon scripts
Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh.
* Use specific exit codes in addon scripts
Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting.
* Use specific exit codes in PVE scripts
Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions.
* Standardize exit codes and behaviors
Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include:
- container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1).
- fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1).
- kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1).
- lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0).
- nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1).
- pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1.
These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate.
* Use exit 105 for unsupported PVE versions
Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts.
* Use specific exit codes in VM scripts
Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
2026-03-02 10:55:20 +01:00
exit 105
2023-05-23 07:36:27 -04:00
}
function arch_check( ) {
if [ " $( dpkg --print-architecture) " != "amd64" ] ; then
echo -e " \n ${ CROSS } This script will not work with PiMox! \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
2023-09-09 05:13:17 -04:00
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
2023-05-23 07:36:27 -04:00
echo "you've been warned"
else
clear
exit
fi
fi
fi
}
function exit-script( ) {
clear
echo -e "⚠ User exited script \n"
exit
}
2023-05-22 11:54:10 +01:00
function default_settings( ) {
2025-05-08 13:23:22 +02:00
VMID = $( get_valid_nextid)
2025-09-15 13:17:45 +02:00
HN = "openwrt"
2023-05-22 11:54:10 +01:00
CORE_COUNT = "1"
RAM_SIZE = "256"
BRG = "vmbr0"
2025-09-15 13:17:45 +02:00
LAN_BRG = "vmbr0"
2023-05-22 11:54:10 +01:00
MAC = $GEN_MAC
LAN_MAC = $GEN_MAC_LAN
2025-09-15 13:17:45 +02:00
VLAN = ""
2026-01-13 21:16:36 +01:00
LAN_VLAN = ""
2023-07-11 12:16:46 +02:00
LAN_IP_ADDR = "192.168.1.1"
LAN_NETMASK = "255.255.255.0"
2023-05-22 11:54:10 +01:00
MTU = ""
START_VM = "yes"
2025-02-10 09:13:09 +01:00
METHOD = "default"
2025-09-15 13:17:45 +02:00
DISK_SIZE = "1G"
echo -e " ${ CONTAINERID } ${ BOLD } ${ DGN } VMID: ${ BGN } ${ VMID } ${ CL } "
echo -e " ${ HOSTNAME } ${ BOLD } ${ DGN } Hostname: ${ BGN } ${ HN } ${ CL } "
echo -e " ${ CPUCORE } ${ BOLD } ${ DGN } CPU Cores: ${ BGN } ${ CORE_COUNT } ${ CL } "
echo -e " ${ RAMSIZE } ${ BOLD } ${ DGN } RAM: ${ BGN } ${ RAM_SIZE } ${ CL } "
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } ${ DISK_SIZE } ${ CL } "
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } WAN Bridge: ${ BGN } ${ BRG } ${ CL } "
echo -e " ${ BRIDGE } ${ BOLD } ${ DGN } LAN Bridge: ${ BGN } ${ LAN_BRG } ${ CL } "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } WAN MAC: ${ BGN } ${ MAC } ${ CL } "
echo -e " ${ MACADDRESS } ${ BOLD } ${ DGN } LAN MAC: ${ BGN } ${ LAN_MAC } ${ CL } "
2023-05-22 11:54:10 +01:00
}
2023-05-23 07:36:27 -04:00
2023-05-22 11:54:10 +01:00
function advanced_settings( ) {
2025-02-10 09:13:09 +01:00
METHOD = "advanced"
2025-05-07 12:37:46 +02:00
[ -z " ${ VMID :- } " ] && VMID = $( get_valid_nextid)
2023-05-23 07:36:27 -04: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
2023-05-23 07:36:27 -04:00
if [ -z " $VMID " ] ; then
2025-05-07 12:37:46 +02:00
VMID = $( get_valid_nextid)
2023-05-23 07:36:27 -04: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
echo -e " ${ DGN } Virtual Machine ID: ${ BGN } $VMID ${ CL } "
break
else
exit-script
fi
done
2023-09-09 05:13:17 -04:00
if VM_NAME = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set Hostname" 8 58 openwrt --title "HOSTNAME" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $VM_NAME ] ; then
2023-05-23 07:36:27 -04:00
HN = "openwrt"
else
2025-04-09 18:59:56 +02:00
HN = $( echo ${ VM_NAME ,, } | tr -d ' ' )
2023-05-23 07:36:27 -04:00
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using Hostname: ${ BGN } $HN ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if CORE_COUNT = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Allocate CPU Cores" 8 58 1 --title "CORE COUNT" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $CORE_COUNT ] ; then
2023-05-23 07:36:27 -04:00
CORE_COUNT = "1"
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Allocated Cores: ${ BGN } $CORE_COUNT ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if RAM_SIZE = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Allocate RAM in MiB" 8 58 256 --title "RAM" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $RAM_SIZE ] ; then
2023-05-23 07:36:27 -04:00
RAM_SIZE = "256"
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Allocated RAM: ${ BGN } $RAM_SIZE ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2025-09-15 13:17:45 +02:00
if DISK_SIZE = $( whiptail --backtitle "Proxmox VE Helper Scripts" \
--inputbox "Set Disk Size in GiB (e.g., 1, 2, 4)" 8 58 "1" \
--title "DISK SIZE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ [ " $DISK_SIZE " = ~ ^[ 0-9] +$ ] ] ; then
DISK_SIZE = " ${ DISK_SIZE } G "
fi
echo -e " ${ DISKSIZE } ${ BOLD } ${ DGN } Disk Size: ${ BGN } ${ DISK_SIZE } ${ CL } "
else
exit-script
fi
2023-09-09 05:13:17 -04:00
if BRG = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a WAN Bridge" 8 58 vmbr0 --title "WAN BRIDGE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $BRG ] ; then
2023-05-23 07:36:27 -04:00
BRG = "vmbr0"
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using WAN Bridge: ${ BGN } $BRG ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if LAN_BRG = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a LAN Bridge" 8 58 vmbr0 --title "LAN BRIDGE" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $LAN_BRG ] ; then
2023-05-23 07:36:27 -04:00
LAN_BRG = "vmbr0"
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using LAN Bridge: ${ BGN } $LAN_BRG ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2025-04-09 18:59:56 +02:00
if LAN_IP_ADDR = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a router IP" 8 58 $LAN_IP_ADDR --title "LAN IP ADDRESS" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $LAN_IP_ADDR ] ; then
2023-07-11 12:16:46 +02:00
LAN_IP_ADDR = "192.168.1.1"
fi
echo -e " ${ DGN } Using LAN IP ADDRESS: ${ BGN } $LAN_IP_ADDR ${ CL } "
else
exit-script
fi
2025-04-09 18:59:56 +02:00
if LAN_NETMASK = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a router netmask" 8 58 $LAN_NETMASK --title "LAN NETMASK" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $LAN_NETMASK ] ; then
2023-07-11 12:16:46 +02:00
LAN_NETMASK = "255.255.255.0"
fi
echo -e " ${ DGN } Using LAN NETMASK: ${ BGN } $LAN_NETMASK ${ CL } "
else
exit-script
fi
2025-04-09 18:59:56 +02:00
if MAC1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a WAN MAC Address" 8 58 $GEN_MAC --title "WAN MAC ADDRESS" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $MAC1 ] ; then
2023-05-23 07:36:27 -04:00
MAC = " $GEN_MAC "
else
MAC = " $MAC1 "
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using WAN MAC Address: ${ BGN } $MAC ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2025-04-09 18:59:56 +02:00
if MAC2 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a LAN MAC Address" 8 58 $GEN_MAC_LAN --title "LAN MAC ADDRESS" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
if [ -z $MAC2 ] ; then
2023-05-23 07:36:27 -04:00
LAN_MAC = " $GEN_MAC_LAN "
else
LAN_MAC = " $MAC2 "
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using LAN MAC Address: ${ BGN } $LAN_MAC ${ CL } "
2023-05-22 11:54:10 +01:00
else
2023-05-23 07:36:27 -04:00
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if VLAN1 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a WAN Vlan (leave blank for default)" 8 58 --title "WAN VLAN" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $VLAN1 ] ; then
2023-05-23 07:36:27 -04:00
VLAN1 = "Default"
VLAN = ""
2023-05-22 11:54:10 +01:00
else
VLAN = " ,tag= $VLAN1 "
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using WAN Vlan: ${ BGN } $VLAN1 ${ CL } "
2023-05-23 07:36:27 -04:00
else
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if VLAN2 = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "Set a LAN Vlan" 8 58 999 --title "LAN VLAN" --cancel-button Exit-Script 3>& 1 1>& 2 2>& 3) ; then
2025-04-09 18:59:56 +02:00
if [ -z $VLAN2 ] ; then
2026-01-13 21:16:36 +01:00
VLAN2 = "Default"
LAN_VLAN = ""
2023-05-22 11:54:10 +01:00
else
LAN_VLAN = " ,tag= $VLAN2 "
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using LAN Vlan: ${ BGN } $VLAN2 ${ CL } "
2023-05-23 07:36:27 -04:00
else
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04: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-04-09 18:59:56 +02:00
if [ -z $MTU1 ] ; then
2023-05-23 07:36:27 -04:00
MTU1 = "Default"
MTU = ""
2023-05-22 11:54:10 +01:00
else
MTU = " ,mtu= $MTU1 "
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Using Interface MTU Size: ${ BGN } $MTU1 ${ CL } "
2023-05-23 07:36:27 -04:00
else
exit-script
2023-05-22 11:54:10 +01:00
fi
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "START VIRTUAL MACHINE" --yesno "Start VM when completed?" 10 58) ; then
2023-05-22 11:54:10 +01:00
START_VM = "yes"
else
START_VM = "no"
fi
2023-06-03 18:29:30 +03:00
echo -e " ${ DGN } Start VM when completed: ${ BGN } $START_VM ${ CL } "
2023-05-23 07:36:27 -04:00
2023-09-09 05:13:17 -04:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "ADVANCED SETTINGS COMPLETE" --yesno "Ready to create OpenWrt VM?" --no-button Do-Over 10 58) ; then
2023-05-23 07:36:27 -04:00
echo -e " ${ RD } Creating a OpenWrt VM using the above advanced settings ${ CL } "
2023-05-22 11:54:10 +01:00
else
header_info
echo -e " ${ RD } Using Advanced Settings ${ CL } "
advanced_settings
fi
}
2023-05-23 07:36:27 -04:00
2023-05-22 11:54:10 +01:00
function start_script( ) {
2023-09-09 05:13:17 -04:00
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "SETTINGS" --yesno "Use Default Settings?" --no-button Advanced 10 58) ; then
2023-05-22 11:54:10 +01:00
header_info
echo -e " ${ BL } Using Default Settings ${ CL } "
default_settings
else
header_info
echo -e " ${ RD } Using Advanced Settings ${ CL } "
advanced_settings
fi
}
2023-05-23 07:36:27 -04:00
arch_check
pve_check
ssh_check
2023-05-22 11:54:10 +01:00
start_script
2025-02-10 09:13:09 +01:00
post_to_api_vm
2023-05-23 07:36:27 -04:00
2023-05-22 11:54:10 +01:00
msg_info "Validating Storage"
while read -r line; do
2025-04-09 18:59:56 +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)}' )
2023-05-22 11:54:10 +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' )
VALID = $( pvesm status -content images | awk 'NR>1' )
if [ -z " $VALID " ] ; then
echo -e " \n ${ RD } ⚠ Unable to detect a valid storage location. ${ CL } "
echo -e "Exiting..."
exit
elif [ $(( ${# STORAGE_MENU [@] } / 3 )) -eq 1 ] ; then
STORAGE = ${ STORAGE_MENU [0] }
else
while [ -z " ${ STORAGE : +x } " ] ; do
2023-09-09 05:13:17 -04:00
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 the OpenWrt VM?\n\n" \
2023-05-22 11:54:10 +01:00
16 $(( $MSG_MAX_LENGTH + 23 )) 6 \
2025-04-15 15:20:46 +02:00
" ${ STORAGE_MENU [@] } " 3>& 1 1>& 2 2>& 3)
2023-05-22 11:54:10 +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 } . "
2023-05-23 07:36:27 -04:00
msg_info "Getting URL for OpenWrt Disk Image"
2023-05-22 11:54:10 +01:00
2025-04-01 10:25:46 +02:00
response = $( curl -fsSL https://openwrt.org)
2025-02-07 16:01:49 +01:00
stableversion = $( echo " $response " | sed -n 's/.*Current stable release - OpenWrt \([0-9.]\+\).*/\1/p' | head -n 1)
2023-10-15 08:43:44 -04:00
URL = " https://downloads.openwrt.org/releases/ $stableversion /targets/x86/64/openwrt- $stableversion -x86-64-generic-ext4-combined.img.gz "
2023-05-22 11:54:10 +01:00
msg_ok " ${ CL } ${ BL } ${ URL } ${ CL } "
2025-04-03 16:01:23 +02:00
curl -f#SL -o " $( basename " $URL " ) " " $URL "
2025-09-15 13:17:45 +02:00
FILE = $( basename " $URL " )
2023-05-22 11:54:10 +01:00
msg_ok " Downloaded ${ CL } ${ BL } $FILE ${ CL } "
2025-09-15 13:17:45 +02:00
gunzip -f " $FILE " >/dev/null 2>& 1 || true
FILE = " ${ FILE %.* } "
msg_ok " Extracted OpenWrt Disk Image ${ CL } ${ BL } $FILE ${ CL } "
2023-05-23 07:36:27 -04:00
msg_info "Creating OpenWrt VM"
2026-01-08 15:10:57 +01:00
qm create $VMID -cores $CORE_COUNT -memory $RAM_SIZE -name $HN \
2023-05-22 11:54:10 +01:00
-onboot 1 -ostype l26 -scsihw virtio-scsi-pci --tablet 0
2025-10-02 00:29:12 +02:00
if [ [ " $( pvesm status | awk -v s = $STORAGE '$1==s {print $2}' ) " = = "dir" ] ] ; then
2026-01-08 15:10:57 +01:00
qm set $VMID -efidisk0 ${ STORAGE } :0,efitype= 4m,size= 4M
2025-10-02 00:29:12 +02:00
else
2026-01-08 15:10:57 +01:00
pvesm alloc $STORAGE $VMID vm-$VMID -disk-0 4M >/dev/null
qm set $VMID -efidisk0 ${ STORAGE } :vm-$VMID -disk-0,efitype= 4m,size= 4M
2025-10-02 00:29:12 +02:00
fi
2025-09-15 13:17:45 +02:00
2026-01-08 15:10:57 +01:00
IMPORT_OUT = " $( qm importdisk $VMID $FILE $STORAGE --format raw 2>& 1 || true ) "
2025-09-15 13:17:45 +02:00
DISK_REF = " $( printf '%s\n' " $IMPORT_OUT " | sed -n "s/.*successfully imported disk '\([^']\+\)'.*/\1/p" ) "
if [ [ -z " $DISK_REF " ] ] ; then
DISK_REF = " $( pvesm list " $STORAGE " | awk -v id = " $VMID " '$1 ~ ("vm-"id"-disk-") {print $1}' | sort | tail -n1) "
fi
if [ [ -z " $DISK_REF " ] ] ; then
msg_error "Unable to determine imported disk reference."
echo " $IMPORT_OUT "
core: standardize exit codes and add mappings (#12467)
* Standardize exit codes and add mappings
Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics.
* Set exit code 115 for update_os errors
Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases.
* Add tools/addon exit codes and use them
Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations.
* Standardize exit codes in exporter addons
Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation.
* Use specific exit codes in addon scripts
Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh.
* Use specific exit codes in addon scripts
Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting.
* Use specific exit codes in PVE scripts
Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions.
* Standardize exit codes and behaviors
Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include:
- container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1).
- fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1).
- kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1).
- lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0).
- nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1).
- pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1.
These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate.
* Use exit 105 for unsupported PVE versions
Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts.
* Use specific exit codes in VM scripts
Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
2026-03-02 10:55:20 +01:00
exit 226
2025-09-15 13:17:45 +02:00
fi
2026-01-08 15:10:57 +01:00
qm set $VMID \
-efidisk0 ${ STORAGE } :0,efitype= 4m,size= 4M \
-scsi0 ${ DISK_REF } \
2023-05-22 11:54:10 +01:00
-boot order = scsi0 \
2025-06-18 22:08:23 +02:00
-tags community-script >/dev/null
2026-01-05 15:28:54 +01:00
msg_ok "Attached disk"
msg_info " Resizing disk to ${ DISK_SIZE } "
qm disk resize " $VMID " scsi0 " ${ DISK_SIZE } " >/dev/null
msg_ok " Resized disk to ${ DISK_SIZE } "
2025-06-18 22:08:23 +02:00
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>
2025-06-22 21:40:54 +02:00
<h2 style = 'font-size: 24px; margin: 20px 0;' >OpenWrt VM</h2>
2025-06-18 22:08:23 +02:00
<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
)
2026-01-08 15:10:57 +01:00
qm set $VMID -description " $DESCRIPTION " >/dev/null
2023-11-27 09:56:24 -05:00
2023-11-01 03:40:43 -04:00
msg_ok " Created OpenWrt VM ${ CL } ${ BL } ( ${ HN } ) "
2023-05-23 07:36:27 -04:00
msg_info "OpenWrt is being started in order to configure the network interfaces."
2025-04-09 18:59:56 +02:00
qm start $VMID
2023-05-22 11:54:10 +01:00
sleep 15
2025-09-16 11:40:05 +02:00
msg_info "Waiting for OpenWrt to boot..."
for i in { 1..30} ; do
if qm status " $VMID " | grep -q "running" ; then
sleep 5
msg_ok "OpenWrt is running"
break
fi
sleep 1
done
2023-05-23 07:36:27 -04:00
msg_ok "Network interfaces are being configured as OpenWrt initiates."
2025-09-16 11:40:05 +02:00
if qm status " $VMID " | grep -q "running" ; then
2025-09-15 13:17:45 +02:00
send_line_to_vm ""
send_line_to_vm "uci delete network.@device[0]"
send_line_to_vm "uci set network.wan=interface"
send_line_to_vm "uci set network.wan.device=eth1"
send_line_to_vm "uci set network.wan.proto=dhcp"
send_line_to_vm "uci delete network.lan"
send_line_to_vm "uci set network.lan=interface"
send_line_to_vm "uci set network.lan.device=eth0"
send_line_to_vm "uci set network.lan.proto=static"
send_line_to_vm " uci set network.lan.ipaddr= ${ LAN_IP_ADDR } "
send_line_to_vm " uci set network.lan.netmask= ${ LAN_NETMASK } "
send_line_to_vm "uci commit"
send_line_to_vm "halt"
2025-09-16 11:40:05 +02:00
msg_ok "Network interfaces configured in OpenWrt"
else
msg_error "VM is not running"
core: standardize exit codes and add mappings (#12467)
* Standardize exit codes and add mappings
Replace generic exit 1 usages with specific numeric exit codes and add corresponding explanations to the error lookup. This commit updates multiple misc/* scripts to return distinct codes for validation, Proxmox/LXC, networking, download and curl errors (e.g. 103-123, 64, 107-120, 206, 0 for explicit user cancels). It also updates curl error handling to propagate the original curl exit code and adds new entries in explain_exit_code and the error handler to improve diagnostics.
* Set exit code 115 for update_os errors
Change exit status from 6 to 115 in misc/alpine-install.func's update_os() error handlers when failing to download tools.func or when the expected functions are missing. This gives a distinct exit code for these specific failure cases.
* Add tools/addon exit codes and use them
Introduce exit codes 232-238 for Tools & Addon scripts in misc/api.func and misc/error_handler.func. Update addon scripts (tools/addon/adguardhome-sync.sh, tools/addon/copyparty.sh, tools/addon/cronmaster.sh) to return specific codes instead of generic exit 1: 238 for unsupported OS and 233 when the application is not installed/upgrade prerequisites are missing. This makes failures more descriptive and aligns scripts with the central error explanations.
* Standardize exit codes in exporter addons
Unify exit codes across exporter addon scripts: return 238 for unsupported OS detections and 233 when an update is requested but the exporter is not installed. Applied to nextcloud-exporter.sh, pihole-exporter.sh, prometheus-paperless-ngx-exporter.sh, and qbittorrent-exporter.sh to make failure modes distinguishable for callers/automation.
* Use specific exit codes in addon scripts
Replace generic exit 1 with distinct exit codes across multiple addon scripts to enable finer-grained error handling in automation. Exit codes introduced: 10 for Docker/Compose missing or user-declined Docker install, 233 for "nothing to update" cases, and 238 for unsupported OS cases. Affected files: tools/addon/arcane.sh, coolify.sh, dockge.sh, dokploy.sh, filebrowser-quantum.sh, filebrowser.sh, immich-public-proxy.sh, jellystat.sh, runtipi.sh.
* Use specific exit codes in addon scripts
Replace generic exit 1 with specific exit codes across multiple addon scripts to improve error signaling and handling. Files updated: tools/addon/add-netbird-lxc.sh (exit 238 on unsupported distro), tools/addon/add-tailscale-lxc.sh (treat user cancel as exit 0), tools/addon/glances.sh (exit 233 when not installed), tools/addon/komodo.sh (distinct exits for missing compose, legacy DB, backup/download failures, docker checks), tools/addon/netdata.sh (distinct exits for unsupported PVE versions, OS/codename detection, repo lookups), and tools/addon/phpmyadmin.sh (distinct exits for unsupported OS, network/download issues, package install/start failures, and invalid input). These changes make failures easier to identify and automate recovery or reporting.
* Use specific exit codes in PVE scripts
Replace generic exit 1 with distinct exit codes across tools/pve scripts to provide clearer failure signals for callers. post-pve-install.sh now returns 105 for unsupported Proxmox versions; pve-privilege-converter.sh uses 104 for non-root, 234 when no containers, and 235 for backup/conversion failures; update-apps.sh maps backup failures to 235, missing containers/selections to 234 (and UI cancellations to 0), missing backup storage to 119, and returns the actual container update exit code on failure. These changes improve diagnostics and allow external tooling to react to specific error conditions.
* Standardize exit codes and behaviors
Adjust exit codes and abort handling across multiple PVE helper scripts to provide clearer outcomes for automation and interactive flows. Changes include:
- container-restore-from-backup.sh, core-restore-from-backup.sh: return 235 when no backups found (was 1).
- fstrim.sh: treat user cancellation of non-ext4 warning as non-error (exit 0 instead of 1).
- kernel-clean.sh: treat no selection or user abort as non-error (exit 0 instead of 1).
- lxc-delete.sh: return 234 when no containers are present; treat no selection as non-error (exit 0).
- nic-offloading-fix.sh: use specific non-zero codes for root check and tool install failures (exit 104, 237) and 236 when no matching interfaces (was 1).
- pbs_microcode.sh, post-pmg-install.sh, post-pbs-install.sh: use distinct exit codes (232 and 105) for detected VM/PVE/unsupported distro conditions instead of generic 1.
These modifications make scripts return distinct codes for different failure modes and ensure user-initiated aborts or benign conditions exit with 0 where appropriate.
* Use exit 105 for unsupported PVE versions
Standardize error handling by replacing generic exit 1 with exit 105 in pve_check() across multiple VM template scripts to indicate unsupported Proxmox VE versions. Also add API exit code 226 message for "Proxmox: VM disk import or post-creation setup failed" in misc/api.func. Affected files include misc/api.func and various vm/*-vm.sh scripts.
* Use specific exit codes in VM scripts
Replace generic exit 1 with distinct exit codes across vm/*.sh to make failures more actionable for callers. Changes include: use 226 for missing imported-disk references, 237 for pv installation failures, 115 for download/extract/ISO-related failures, 214 for insufficient disk space during FreeBSD decompression, and 119 for missing storage detection. Updated scripts: archlinux-vm.sh, docker-vm.sh, haos-vm.sh, openwrt-vm.sh, opnsense-vm.sh, truenas-vm.sh, umbrel-os-vm.sh.
2026-03-02 10:55:20 +01:00
exit 226
2025-09-16 11:40:05 +02:00
fi
2025-09-15 13:17:45 +02:00
msg_info "Waiting for OpenWrt to shut down..."
until qm status " $VMID " | grep -q "stopped" ; do
2023-05-22 11:54:10 +01:00
sleep 2
done
2025-09-15 13:17:45 +02:00
msg_ok "OpenWrt has shut down"
msg_info "Adding bridge interfaces on Proxmox side"
2026-01-08 15:10:57 +01:00
qm set $VMID \
-net0 virtio,bridge= ${ LAN_BRG } ,macaddr= ${ LAN_MAC } ${ LAN_VLAN } ${ MTU } \
-net1 virtio,bridge= ${ BRG } ,macaddr= ${ MAC } ${ VLAN } ${ MTU } >/dev/null
2025-09-15 13:17:45 +02:00
msg_ok "Bridge interfaces added"
if [ " $START_VM " = "yes" ] ; then
2023-05-23 07:36:27 -04:00
msg_info "Starting OpenWrt VM"
2026-01-08 15:10:57 +01:00
qm start $VMID
2023-05-23 07:36:27 -04:00
msg_ok "Started OpenWrt VM"
2023-05-22 11:54:10 +01:00
fi
2025-09-15 13:17:45 +02:00
2023-05-22 11:54:10 +01:00
VLAN_FINISH = ""
2025-09-15 13:17:45 +02:00
if [ -z " $VLAN " ] && [ " $VLAN2 " != "999" ] ; then
2023-05-22 11:54:10 +01:00
VLAN_FINISH = " Please remember to adjust the VLAN tags to suit your network."
fi
2025-02-10 09:13:09 +01:00
post_update_to_api "done" "none"
2025-09-15 13:17:45 +02:00
msg_ok " Completed Successfully! ${ VLAN_FINISH : + \n $VLAN_FINISH } "