diff --git a/vm/openwrt-vm.sh b/vm/openwrt-vm.sh index 48bd57287..3c7c5225b 100644 --- a/vm/openwrt-vm.sh +++ b/vm/openwrt-vm.sh @@ -1,30 +1,17 @@ -#!/usr/bin/env bash - +#!/usr/bin/env bash # Copyright (c) 2021-2026 tteck -# Author: tteck (tteckster) -# Jon Spriggs (jontheniceguy) +# Author: tteck (tteckster) | Jon Spriggs (jontheniceguy) | MickLesk (CanbiZ) # License: MIT # https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE -# Based on work from https://i12bretro.github.io/tutorials/0405.html -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/DevScripts/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" - ____ _ __ __ - / __ \____ ___ ____| | / /____/ /_ - / / / / __ \/ _ \/ __ \ | /| / / ___/ __/ -/ /_/ / /_/ / __/ / / / |/ |/ / / / /_ -\____/ .___/\___/_/ /_/|__/|__/_/ \__/ - /_/ W I R E L E S S F R E E D O M - -EOF -} -header_info -echo -e "\n Loading..." RANDOM_UUID="$(cat /proc/sys/kernel/random/uuid)" METHOD="" +APP="OpenWrt" +APP_TYPE="vm" NSAPP="openwrt-vm" var_os="openwrt" var_version=" " @@ -32,94 +19,27 @@ DISK_SIZE="1G" 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/.$//') -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}" -CLOUD="${TAB}☁️${TAB}${CL}" +header_info +echo -e "\n Loading..." set -Eeo pipefail +shopt -s inherit_errexit 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" - post_update_to_api "failed" "$exit_code" - 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" - 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 +pushd "$TEMP_DIR" >/dev/null + +vm_preflight +vm_require_tools gzip + function send_line_to_vm() { echo -e "${DGN}Sending line: ${YW}$1${CL}" for ((i = 0; i < ${#1}; i++)); do @@ -171,7 +91,7 @@ function send_line_to_vm() { "U") character="shift-u" ;; "V") character="shift-v" ;; "W") character="shift-w" ;; - "X") character="shift=x" ;; + "X") character="shift-x" ;; "Y") character="shift-y" ;; "Z") character="shift-z" ;; "!") character="shift-1" ;; @@ -190,97 +110,92 @@ function send_line_to_vm() { qm sendkey $VMID ret } -TEMP_DIR=$(mktemp -d) -pushd $TEMP_DIR >/dev/null - -if (whiptail --backtitle "Proxmox VE Helper Scripts" --title "OpenWrt VM" --yesno "This will create a New OpenWrt VM. Proceed?" 10 58); then - : -else - header_info && echo -e "⚠ User exited script \n" && exit -fi - -function msg_info() { - local msg="$1" - echo -ne " ${HOLD} ${YW}${msg}..." +function validate_ip_octets() { + local octet='(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])' + [[ "$1" =~ ^${octet}\.${octet}\.${octet}\.${octet}$ ]] } -function msg_ok() { - local msg="$1" - echo -e "${BFR} ${CM} ${GN}${msg}${CL}" +function prompt_router_input() { + local var_name="$1" title="$2" prompt="$3" default_value="$4" value + if vm_dialog inputbox "$title" "$prompt" 8 58 "$default_value" --cancel-button Exit-Script; then + value="$VM_DIALOG_RESULT" + [[ -n "$value" ]] || value="$default_value" + printf -v "$var_name" '%s' "$value" + else + exit_script + fi } -function msg_error() { - local msg="$1" - echo -e "${BFR} ${CROSS} ${RD}${msg}${CL}" +function prompt_router_ip() { + local var_name="$1" title="$2" prompt="$3" default_value="$4" label="$5" value + prompt_router_input "$var_name" "$title" "$prompt" "$default_value" + value="${!var_name}" + if ! validate_ip_octets "$value"; then + msg_error "Invalid ${label} format. Needs to be 0.0.0.0, was $value" + exit 1 + fi + echo -e "${DGN}Using ${label}: ${BGN}$value${CL}" } -# 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.2 -pve_check() { - local PVE_VER - PVE_VER="$(pveversion | awk -F'/' '{print $2}' | awk -F'-' '{print $1}')" +function prompt_router_mac() { + local var_name="$1" title="$2" prompt="$3" default_value="$4" label="$5" value + prompt_router_input "$var_name" "$title" "$prompt" "$default_value" + value="${!var_name}" + if ! validate_mac_address "$value"; then + msg_error "Invalid ${label}: $value" + exit 1 + fi + echo -e "${DGN}Using ${label}: ${BGN}$value${CL}" +} - # 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 105 +function prompt_router_vlan() { + local var_name="$1" label_var="$2" title="$3" prompt="$4" default_value="$5" input_value + while true; do + prompt_router_input "$label_var" "$title" "$prompt" "$default_value" + input_value="${!label_var}" + if [ -z "$input_value" ] || [ "$input_value" = "Default" ]; then + printf -v "$var_name" '%s' "" + printf -v "$label_var" '%s' "Default" + echo -e "${DGN}Using ${title}: ${BGN}Default${CL}" + break 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 – 9.2" - exit 105 + if validate_vlan_tag "$input_value"; then + printf -v "$var_name" '%s' ",tag=$input_value" + echo -e "${DGN}Using ${title}: ${BGN}$input_value${CL}" + break 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.2" - exit 105 + vm_dialog msgbox "INVALID INPUT" "VLAN must be a number between 1 and 4094, or leave blank for default." 8 58 + done } -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 - 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 +function prompt_router_mtu() { + local input_value + while true; do + prompt_router_input "MTU_VALUE" "MTU SIZE" "Set Interface MTU Size (leave blank for default)" "" + input_value="$MTU_VALUE" + if [ -z "$input_value" ]; then + MTU="" + MTU_VALUE="Default" + echo -e "${DGN}Using Interface MTU Size: ${BGN}Default${CL}" + break fi - fi -} - -function exit-script() { - clear - echo -e "⚠ User exited script \n" - exit + if validate_mtu "$input_value"; then + MTU=",mtu=$input_value" + echo -e "${DGN}Using Interface MTU Size: ${BGN}$input_value${CL}" + break + fi + vm_dialog msgbox "INVALID INPUT" "MTU Size must be a number between 576 and 65520, or leave blank for default." 8 58 + done } function default_settings() { VMID=$(get_valid_nextid) + vm_apply_machine_type "i440fx" HN="openwrt" CORE_COUNT="1" RAM_SIZE="256" + CPU_TYPE="" + DISK_CACHE="" BRG="vmbr0" LAN_BRG="vmbr0" MAC=$GEN_MAC @@ -306,198 +221,30 @@ function 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 "${DGN}Virtual Machine ID: ${BGN}$VMID${CL}" - break - else - exit-script - fi - done + CPU_TYPE="" + DISK_CACHE="" + vm_apply_machine_type "i440fx" + vm_prompt_vmid "${VMID:-$(get_valid_nextid)}" + vm_prompt_hostname "openwrt" + vm_prompt_cpu_cores "1" + vm_prompt_ram "256" + vm_prompt_disk_size "1G" + vm_prompt_keyboard + vm_prompt_verbose "no" + prompt_router_input "BRG" "WAN BRIDGE" "Set a WAN Bridge" "vmbr0" + echo -e "${DGN}Using WAN Bridge: ${BGN}$BRG${CL}" + prompt_router_input "LAN_BRG" "LAN BRIDGE" "Set a LAN Bridge" "vmbr0" + echo -e "${DGN}Using LAN Bridge: ${BGN}$LAN_BRG${CL}" + prompt_router_ip "LAN_IP_ADDR" "LAN IP ADDRESS" "Set a router IP" "${LAN_IP_ADDR:-192.168.1.1}" "LAN IP ADDRESS" + prompt_router_ip "LAN_NETMASK" "LAN NETMASK" "Set a router netmask" "${LAN_NETMASK:-255.255.255.0}" "LAN NETMASK" + prompt_router_mac "MAC" "WAN MAC ADDRESS" "Set a WAN MAC Address" "$GEN_MAC" "WAN MAC address" + prompt_router_mac "LAN_MAC" "LAN MAC ADDRESS" "Set a LAN MAC Address" "$GEN_MAC_LAN" "LAN MAC address" + prompt_router_vlan "VLAN" "VLAN1" "WAN VLAN" "Set a WAN Vlan (leave blank for default)" "" + prompt_router_vlan "LAN_VLAN" "VLAN2" "LAN VLAN" "Set a LAN Vlan" "999" + prompt_router_mtu + vm_prompt_start_vm "yes" - 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 - if [ -z $VM_NAME ]; then - HN="openwrt" - 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 - fi - echo -e "${DGN}Using Hostname: ${BGN}$HN${CL}" - else - exit-script - fi - - while true; do - 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 - if [ -z "$CORE_COUNT" ]; then CORE_COUNT="1"; fi - if [[ "$CORE_COUNT" =~ ^[1-9][0-9]*$ ]]; then - echo -e "${DGN}Allocated 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., 1)." 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 256 --title "RAM" --cancel-button Exit-Script 3>&1 1>&2 2>&3); then - if [ -z "$RAM_SIZE" ]; then RAM_SIZE="256"; fi - if [[ "$RAM_SIZE" =~ ^[1-9][0-9]*$ ]]; then - echo -e "${DGN}Allocated RAM: ${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., 256)." 8 58 - else - exit-script - fi - done - - 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 - - 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 - if [ -z $BRG ]; then - BRG="vmbr0" - fi - echo -e "${DGN}Using WAN Bridge: ${BGN}$BRG${CL}" - else - exit-script - fi - - 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 - if [ -z $LAN_BRG ]; then - LAN_BRG="vmbr0" - fi - echo -e "${DGN}Using LAN Bridge: ${BGN}$LAN_BRG${CL}" - else - exit-script - fi - - 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 - LAN_IP_ADDR="192.168.1.1" - fi - echo -e "${DGN}Using LAN IP ADDRESS: ${BGN}$LAN_IP_ADDR${CL}" - else - exit-script - fi - - 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 - LAN_NETMASK="255.255.255.0" - fi - echo -e "${DGN}Using LAN NETMASK: ${BGN}$LAN_NETMASK${CL}" - else - exit-script - fi - - 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 - MAC="$GEN_MAC" - else - MAC="$MAC1" - fi - echo -e "${DGN}Using WAN MAC Address: ${BGN}$MAC${CL}" - else - exit-script - fi - - 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 - LAN_MAC="$GEN_MAC_LAN" - else - LAN_MAC="$MAC2" - fi - echo -e "${DGN}Using LAN MAC Address: ${BGN}$LAN_MAC${CL}" - else - exit-script - fi - - while true; do - 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 - if [ -z "$VLAN1" ]; then - VLAN1="Default" - VLAN="" - echo -e "${DGN}Using WAN Vlan: ${BGN}$VLAN1${CL}" - break - fi - if [[ "$VLAN1" =~ ^[0-9]+$ ]] && [ "$VLAN1" -ge 1 ] && [ "$VLAN1" -le 4094 ]; then - VLAN=",tag=$VLAN1" - echo -e "${DGN}Using WAN 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 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 - if [ -z "$VLAN2" ]; then - VLAN2="Default" - LAN_VLAN="" - echo -e "${DGN}Using LAN Vlan: ${BGN}$VLAN2${CL}" - break - fi - if [[ "$VLAN2" =~ ^[0-9]+$ ]] && [ "$VLAN2" -ge 1 ] && [ "$VLAN2" -le 4094 ]; then - LAN_VLAN=",tag=$VLAN2" - echo -e "${DGN}Using LAN Vlan: ${BGN}$VLAN2${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 "${DGN}Using Interface MTU Size: ${BGN}$MTU1${CL}" - break - fi - if [[ "$MTU1" =~ ^[0-9]+$ ]] && [ "$MTU1" -ge 576 ] && [ "$MTU1" -le 65520 ]; then - MTU=",mtu=$MTU1" - echo -e "${DGN}Using 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 - START_VM="yes" - else - START_VM="no" - fi - echo -e "${DGN}Start VM when completed: ${BGN}$START_VM${CL}" - - if (whiptail --backtitle "Proxmox VE Helper Scripts" --title "ADVANCED SETTINGS COMPLETE" --yesno "Ready to create OpenWrt VM?" --no-button Do-Over 10 58); then + if vm_confirm_advanced_settings "Ready to create OpenWrt VM?"; then echo -e "${RD}Creating a OpenWrt VM using the above advanced settings${CL}" else header_info @@ -506,174 +253,92 @@ 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 "${BL}Using Default Settings${CL}" - default_settings - else - header_info - echo -e "${RD}Using Advanced Settings${CL}" - advanced_settings - fi -} - -arch_check -pve_check -ssh_check -start_script +vm_start_script "Use Default Settings?\n\nDefaults:\n• 1 CPU Core\n• 256 MB RAM\n• 1 GB Disk" 13 58 post_to_api_vm -msg_info "Validating Storage" -while read -r line; do - 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)}') - 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 - STORAGE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "Storage Pools" --radiolist \ - "Which storage pool would you like to use for the OpenWrt VM?\n\n" \ - 16 $(($MSG_MAX_LENGTH + 23)) 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}." +vm_select_storage "$HN" msg_info "Getting URL for OpenWrt Disk Image" -response=$(curl -fsSL https://openwrt.org) -stableversion=$(echo "$response" | sed -n 's/.*Current stable release - OpenWrt \([0-9.]\+\).*/\1/p' | head -n 1) -URL="https://downloads.openwrt.org/releases/$stableversion/targets/x86/64/openwrt-$stableversion-x86-64-generic-ext4-combined.img.gz" +vm_latest_from_index "https://openwrt.org" 'Current stable release - OpenWrt \K[0-9]+\.[0-9]+\.[0-9]+' || exit 115 +var_version="$VM_INDEX_LATEST" +URL="https://downloads.openwrt.org/releases/$var_version/targets/x86/64/openwrt-$var_version-x86-64-generic-ext4-combined.img.gz" msg_ok "${CL}${BL}${URL}${CL}" -curl -f#SL -o "$(basename "$URL")" "$URL" -FILE=$(basename "$URL") -msg_ok "Downloaded ${CL}${BL}$FILE${CL}" +# A mirror serving an error page returns 200, so size decides whether this +# is an image. Anything real here is far above 5 MB. +CACHE_FILE="$(vm_image_cache_path "$URL")" +vm_fetch_image "$URL" "$CACHE_FILE" --cache --min-bytes $((5 * 1024 * 1024)) || exit 115 -gunzip -f "$FILE" >/dev/null 2>&1 || true -FILE="${FILE%.*}" -msg_ok "Extracted OpenWrt Disk Image ${CL}${BL}$FILE${CL}" +FILE="$TEMP_DIR/$(basename "${CACHE_FILE%.gz}")" +vm_extract_image "$CACHE_FILE" "$FILE" || exit 115 +FILE="$VM_IMAGE_FILE" +vm_claim_vmid msg_info "Creating OpenWrt VM" qm create $VMID -cores $CORE_COUNT -memory $RAM_SIZE -name $HN \ - -onboot 1 -ostype l26 -scsihw virtio-scsi-pci --tablet 0 -if [[ "$(pvesm status | awk -v s=$STORAGE '$1==s {print $2}')" == "dir" ]]; then - qm set $VMID -efidisk0 ${STORAGE}:0,efitype=4m,size=4M -else - pvesm alloc $STORAGE $VMID vm-$VMID-disk-0 4M >/dev/null - qm set $VMID -efidisk0 ${STORAGE}:vm-$VMID-disk-0,efitype=4m,size=4M -fi + -onboot 1 -ostype l26 -scsihw virtio-scsi-pci --tablet 0 >/dev/null +vm_mark_created +vm_import_disk "$VMID" "$FILE" "$STORAGE" -IMPORT_OUT="$(qm importdisk $VMID $FILE $STORAGE --format raw 2>&1 || true)" -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" - exit 226 -fi - -qm set $VMID \ - -efidisk0 ${STORAGE}:0,efitype=4m,size=4M \ - -scsi0 ${DISK_REF} \ +$STD qm set $VMID \ + -scsi0 "${VM_IMPORTED_DISK}" \ -boot order=scsi0 \ - -tags community-script >/dev/null + -tags community-script 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}" -DESCRIPTION=$( - cat < - - Logo - - -

OpenWrt VM

- -

- - spend Coffee - -

- - - - GitHub - - - - Discussions - - - - Issues - - -EOF -) -qm set $VMID -description "$DESCRIPTION" >/dev/null - +set_description msg_ok "Created OpenWrt VM ${CL}${BL}(${HN})" -msg_info "OpenWrt is being started in order to configure the network interfaces." -qm start $VMID + +msg_info "Booting OpenWrt to configure its network interfaces" +$STD qm start $VMID sleep 15 -msg_info "Waiting for OpenWrt to boot..." +VM_STATE="" for i in {1..30}; do - if qm status "$VMID" | grep -q "running"; then - sleep 5 - msg_ok "OpenWrt is running" - break + if ! VM_STATE="$(qm status "$VMID" 2>&1)"; then + msg_error "VM $VMID no longer exists: ${VM_STATE}" + exit 226 fi + [[ "$VM_STATE" == *running* ]] && break sleep 1 done -msg_ok "Network interfaces are being configured as OpenWrt initiates." - -if qm status "$VMID" | grep -q "running"; then - 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 "poweroff" - msg_ok "Network interfaces configured in OpenWrt" -else - msg_error "VM is not running" +if [[ "$VM_STATE" != *running* ]]; then + msg_error "VM $VMID did not reach running state: ${VM_STATE}" exit 226 fi +sleep 5 +msg_ok "OpenWrt is running" -msg_info "Waiting for OpenWrt to shut down..." -until qm status "$VMID" | grep -q "stopped"; do +msg_info "Configuring network interfaces in OpenWrt" +$STD send_line_to_vm "" +$STD send_line_to_vm "uci delete network.@device[0]" +$STD send_line_to_vm "uci set network.wan=interface" +$STD send_line_to_vm "uci set network.wan.device=eth1" +$STD send_line_to_vm "uci set network.wan.proto=dhcp" +$STD send_line_to_vm "uci delete network.lan" +$STD send_line_to_vm "uci set network.lan=interface" +$STD send_line_to_vm "uci set network.lan.device=eth0" +$STD send_line_to_vm "uci set network.lan.proto=static" +$STD send_line_to_vm "uci set network.lan.ipaddr=${LAN_IP_ADDR}" +$STD send_line_to_vm "uci set network.lan.netmask=${LAN_NETMASK}" +$STD send_line_to_vm "uci commit" +$STD send_line_to_vm "poweroff" +msg_ok "Network interfaces configured in OpenWrt" + +msg_info "Waiting for OpenWrt to shut down" +for i in {1..60}; do + VM_STATE="$(qm status "$VMID" 2>&1)" || break + [[ "$VM_STATE" == *stopped* ]] && break sleep 2 done +if [[ "$VM_STATE" != *stopped* ]]; then + msg_error "OpenWrt did not shut down: ${VM_STATE}" + exit 226 +fi msg_ok "OpenWrt has shut down" msg_info "Adding bridge interfaces on Proxmox side" @@ -684,13 +349,21 @@ msg_ok "Bridge interfaces added" if [ "$START_VM" = "yes" ]; then msg_info "Starting OpenWrt VM" - qm start $VMID + $STD qm start $VMID msg_ok "Started OpenWrt VM" fi VLAN_FINISH="" -if [ -z "$VLAN" ] && [ "$VLAN2" != "999" ]; then +if [ -z "$VLAN" ] && [ "${VLAN2:-999}" != "999" ]; then VLAN_FINISH=" Please remember to adjust the VLAN tags to suit your network." fi -post_update_to_api "done" "none" -msg_ok "Completed Successfully!${VLAN_FINISH:+\n$VLAN_FINISH}" +vm_print_summary \ + "LAN URL=http://${LAN_IP_ADDR}" \ + "WAN Bridge=${BRG}" \ + "LAN Bridge=${LAN_BRG}" \ + "OpenWrt Version=${var_version}" +vm_next_steps \ + "Open the LAN web UI at http://${LAN_IP_ADDR}." \ + "Login as root with a blank initial password, then set a strong password immediately." \ + "Keep WAN and LAN isolated appropriately; the defaults put both on vmbr0 until you adjust bridges/VLANs.${VLAN_FINISH}" +vm_finish