2024-12-20 18:54:00 +01:00
#!/bin/bash
2025-02-02 19:21:58 +01:00
# ==========================================================
# ProxMenu - A menu-driven script for Proxmox VE management
# ==========================================================
# Author : MacRimi
# Copyright : (c) 2024 MacRimi
# License : MIT (https://raw.githubusercontent.com/MacRimi/ProxMenux/main/LICENSE)
2025-07-04 20:30:19 +02:00
# Version : 1.3
# Last Updated: 04/07/2025
2025-02-02 19:21:58 +01:00
# ==========================================================
# Description:
# This script installs and configures ProxMenux, a menu-driven
# tool for managing Proxmox VE.
#
# - Ensures the script is run with root privileges.
# - Displays an installation confirmation prompt.
# - Installs required dependencies:
# - whiptail (for interactive terminal menus)
# - curl (for downloading remote files)
# - jq (for handling JSON data)
# - Python 3 and virtual environment (for translations)
# - Configures the Python virtual environment and installs googletrans.
# - Creates necessary directories for storing ProxMenux data.
# - Downloads required files from GitHub, including:
# - Cache file (`cache.json`) for translation caching.
# - Utility script (`utils.sh`) for core functions.
# - Main script (`menu.sh`) to launch ProxMenux.
# - Sets correct permissions for execution.
# - Displays final instructions on how to start ProxMenux.
#
# This installer ensures a smooth setup process and prepares
# the system for running ProxMenux efficiently.
# ==========================================================
# Configuration ============================================
2024-12-20 18:54:00 +01:00
REPO_URL = "https://raw.githubusercontent.com/MacRimi/ProxMenux/main"
2025-02-02 19:21:58 +01:00
UTILS_URL = "https://raw.githubusercontent.com/MacRimi/ProxMenux/main/scripts/utils.sh"
2024-12-20 21:44:20 +01:00
INSTALL_DIR = "/usr/local/bin"
2024-12-20 21:41:34 +01:00
BASE_DIR = "/usr/local/share/proxmenux"
2025-02-06 17:20:32 +01:00
CONFIG_FILE = " $BASE_DIR /config.json "
2025-02-02 19:21:58 +01:00
CACHE_FILE = " $BASE_DIR /cache.json "
2025-02-25 00:04:46 +01:00
UTILS_FILE = " $BASE_DIR /utils.sh "
2024-12-20 21:41:34 +01:00
LOCAL_VERSION_FILE = " $BASE_DIR /version.txt "
2025-02-25 17:44:17 +01:00
MENU_SCRIPT = "menu"
2025-02-06 17:20:32 +01:00
VENV_PATH = "/opt/googletrans-env"
2024-12-20 21:41:34 +01:00
2025-02-25 00:04:46 +01:00
if ! source <( curl -sSf " $UTILS_URL " ) ; then
echo " Error: Could not load utils.sh from $UTILS_URL "
exit 1
fi
2025-02-02 19:41:11 +01:00
2025-07-04 20:30:19 +02:00
cleanup_corrupted_files( ) {
if [ -f " $CONFIG_FILE " ] && ! jq empty " $CONFIG_FILE " >/dev/null 2>& 1; then
echo "Cleaning up corrupted configuration file..."
rm -f " $CONFIG_FILE "
fi
if [ -f " $CACHE_FILE " ] && ! jq empty " $CACHE_FILE " >/dev/null 2>& 1; then
echo "Cleaning up corrupted cache file..."
rm -f " $CACHE_FILE "
fi
}
2025-02-02 19:21:58 +01:00
# ==========================================================
2025-07-04 20:30:19 +02:00
check_existing_installation( ) {
local has_venv = false
local has_config = false
local has_language = false
local has_menu = false
if [ -f " $INSTALL_DIR / $MENU_SCRIPT " ] ; then
has_menu = true
fi
if [ -d " $VENV_PATH " ] && [ -f " $VENV_PATH /bin/activate " ] ; then
has_venv = true
fi
if [ -f " $CONFIG_FILE " ] ; then
if jq empty " $CONFIG_FILE " >/dev/null 2>& 1; then
has_config = true
local current_language = $( jq -r '.language // empty' " $CONFIG_FILE " 2>/dev/null)
if [ [ -n " $current_language " && " $current_language " != "null" && " $current_language " != "empty" ] ] ; then
has_language = true
fi
else
echo "Warning: Corrupted config file detected, removing..."
rm -f " $CONFIG_FILE "
fi
fi
if [ " $has_venv " = true ] && [ " $has_language " = true ] ; then
echo "translation"
elif [ " $has_menu " = true ] && [ " $has_venv " = false ] ; then
echo "normal"
elif [ " $has_menu " = true ] ; then
echo "unknown"
else
echo "none"
fi
}
uninstall_proxmenu( ) {
local install_type = " $1 "
local force_clean = " $2 "
if [ " $force_clean " != "force" ] ; then
if ! whiptail --title "Uninstall ProxMenu" --yesno "Are you sure you want to uninstall ProxMenu?" 10 60; then
return 1
fi
fi
echo "Uninstalling ProxMenu..."
if [ -f " $VENV_PATH /bin/activate " ] ; then
echo "Removing googletrans and virtual environment..."
source " $VENV_PATH /bin/activate "
pip uninstall -y googletrans >/dev/null 2>& 1
deactivate
rm -rf " $VENV_PATH "
fi
if [ " $install_type " = "translation" ] && [ " $force_clean " != "force" ] ; then
DEPS_TO_REMOVE = $( whiptail --title "Remove Translation Dependencies" --checklist \
"Select translation-specific dependencies to remove:" 15 60 3 \
"python3-venv" "Python virtual environment" OFF \
"python3-pip" "Python package installer" OFF \
"python3" "Python interpreter" OFF \
3>& 1 1>& 2 2>& 3)
if [ -n " $DEPS_TO_REMOVE " ] ; then
echo "Removing selected dependencies..."
read -r -a DEPS_ARRAY <<< " $( echo " $DEPS_TO_REMOVE " | tr -d '"' ) "
for dep in " ${ DEPS_ARRAY [@] } " ; do
echo " Removing $dep ... "
apt-mark auto " $dep " >/dev/null 2>& 1
apt-get -y --purge autoremove " $dep " >/dev/null 2>& 1
done
apt-get autoremove -y --purge >/dev/null 2>& 1
fi
fi
rm -f " $INSTALL_DIR / $MENU_SCRIPT "
rm -rf " $BASE_DIR "
[ -f /root/.bashrc.bak ] && mv /root/.bashrc.bak /root/.bashrc
if [ -f /etc/motd.bak ] ; then
mv /etc/motd.bak /etc/motd
else
sed -i '/This system is optimised by: ProxMenux/d' /etc/motd
fi
echo "ProxMenu has been uninstalled."
return 0
}
handle_installation_change( ) {
local current_type = " $1 "
local new_type = " $2 "
if [ " $current_type " = " $new_type " ] ; then
2025-07-04 22:37:16 +02:00
return 0
2025-07-04 20:30:19 +02:00
fi
case " $current_type - $new_type " in
"translation-1" | "translation-normal" )
if whiptail --title "Installation Type Change" \
--yesno "Switch from Translation to Normal Version?\n\nThis will remove translation components." 10 60; then
echo "Preparing for installation type change..."
uninstall_proxmenu "translation" "force" >/dev/null 2>& 1
return 0
else
return 1
fi
; ;
"normal-2" | "normal-translation" )
if whiptail --title "Installation Type Change" \
--yesno "Switch from Normal to Translation Version?\n\nThis will add translation components." 10 60; then
return 0
else
return 1
fi
; ;
*)
return 0
; ;
esac
}
2025-02-06 17:20:32 +01:00
update_config( ) {
local component = " $1 "
local status = " $2 "
local timestamp = $( date -u +"%Y-%m-%dT%H:%M:%SZ" )
2025-07-04 20:30:19 +02:00
local tracked_components = ( "dialog" "curl" "jq" "python3" "python3-venv" "python3-pip" "virtual_environment" "pip" "googletrans" )
2025-02-06 17:20:32 +01:00
if [ [ " ${ tracked_components [@] } " = ~ " ${ component } " ] ] ; then
mkdir -p " $( dirname " $CONFIG_FILE " ) "
2025-07-04 20:30:19 +02:00
if [ ! -f " $CONFIG_FILE " ] || ! jq empty " $CONFIG_FILE " >/dev/null 2>& 1; then
echo '{}' > " $CONFIG_FILE "
fi
local tmp_file = $( mktemp)
if jq --arg comp " $component " --arg stat " $status " --arg time " $timestamp " \
'.[$comp] = {status: $stat, timestamp: $time}' " $CONFIG_FILE " > " $tmp_file " 2>/dev/null; then
mv " $tmp_file " " $CONFIG_FILE "
else
2025-02-06 17:20:32 +01:00
echo '{}' > " $CONFIG_FILE "
2025-07-04 20:30:19 +02:00
jq --arg comp " $component " --arg stat " $status " --arg time " $timestamp " \
'.[$comp] = {status: $stat, timestamp: $time}' " $CONFIG_FILE " > " $tmp_file " && mv " $tmp_file " " $CONFIG_FILE "
2025-02-06 17:20:32 +01:00
fi
2025-07-04 20:30:19 +02:00
[ -f " $tmp_file " ] && rm -f " $tmp_file "
2025-02-06 17:20:32 +01:00
fi
}
2025-02-02 19:21:58 +01:00
2025-02-06 17:20:32 +01:00
show_progress( ) {
local step = " $1 "
local total = " $2 "
local message = " $3 "
2025-02-06 20:26:20 +01:00
echo -e " \n ${ BOLD } ${ BL } ${ TAB } Installing ProxMenu: Step $step of $total ${ CL } "
2025-02-25 00:19:37 +01:00
echo
2025-02-25 00:55:42 +01:00
msg_info2 " $message "
2025-02-06 17:20:32 +01:00
}
2025-07-04 20:30:19 +02:00
select_language( ) {
if [ -f " $CONFIG_FILE " ] && jq empty " $CONFIG_FILE " >/dev/null 2>& 1; then
local existing_language = $( jq -r '.language // empty' " $CONFIG_FILE " 2>/dev/null)
if [ [ -n " $existing_language " && " $existing_language " != "null" && " $existing_language " != "empty" ] ] ; then
LANGUAGE = " $existing_language "
msg_ok " Using existing language configuration: $LANGUAGE "
return 0
fi
fi
LANGUAGE = $( whiptail --title "Select Language" --menu "Choose a language for the menu:" 20 60 12 \
"en" "English (Recommended)" \
"es" "Spanish" \
"fr" "French" \
"de" "German" \
"it" "Italian" \
"pt" "Portuguese" 3>& 1 1>& 2 2>& 3)
if [ -z " $LANGUAGE " ] ; then
msg_error "No language selected. Exiting."
exit 1
fi
mkdir -p " $( dirname " $CONFIG_FILE " ) "
if [ ! -f " $CONFIG_FILE " ] || ! jq empty " $CONFIG_FILE " >/dev/null 2>& 1; then
echo '{}' > " $CONFIG_FILE "
fi
local tmp_file = $( mktemp)
if jq --arg lang " $LANGUAGE " '. + {language: $lang}' " $CONFIG_FILE " > " $tmp_file " 2>/dev/null; then
mv " $tmp_file " " $CONFIG_FILE "
else
echo " {\"language\": \" $LANGUAGE \"} " > " $CONFIG_FILE "
fi
[ -f " $tmp_file " ] && rm -f " $tmp_file "
msg_ok " Language set to: $LANGUAGE "
}
2025-07-04 22:37:16 +02:00
# Show installation confirmation for new installations
show_installation_confirmation( ) {
local install_type = " $1 "
case " $install_type " in
"1" )
if whiptail --title "ProxMenux - Normal Version Installation" \
--yesno "ProxMenux Normal Version will install:\n\n• dialog (interactive menus) - Official Debian package\n• curl (file downloads) - Official Debian package\n• jq (JSON processing) - Official Debian package\n• ProxMenux core files (/usr/local/share/proxmenux)\n\nThis is a lightweight installation with minimal dependencies.\n\nProceed with installation?" 18 70; then
return 0
else
return 1
fi
; ;
"2" )
if whiptail --title "ProxMenux - Translation Version Installation" \
--yesno "ProxMenux Translation Version will install:\n\n• dialog (interactive menus)\n• curl (file downloads)\n• jq (JSON processing)\n• python3 + python3-venv + python3-pip\n• Google Translate library (googletrans)\n• Virtual environment (/opt/googletrans-env)\n• Translation cache system\n• ProxMenux core files\n\nThis version requires more dependencies for translation support.\n\nProceed with installation?" 18 70; then
return 0
else
return 1
fi
; ;
esac
}
2025-07-04 20:30:19 +02:00
2025-07-04 22:37:16 +02:00
####################################################
2025-07-04 20:30:19 +02:00
install_normal_version( ) {
local total_steps = 3
local current_step = 1
show_progress $current_step $total_steps "Installing basic dependencies"
if ! dpkg -l | grep -qw "jq" ; then
msg_info "Installing jq..."
apt-get update > /dev/null 2>& 1
if apt-get install -y jq > /dev/null 2>& 1; then
msg_ok "jq installed successfully."
update_config "jq" "installed"
else
msg_error "Failed to install jq. Please install it manually."
update_config "jq" "failed"
return 1
fi
else
msg_ok "jq is already installed."
update_config "jq" "already_installed"
fi
BASIC_DEPS = ( "dialog" "curl" )
for pkg in " ${ BASIC_DEPS [@] } " ; do
if ! dpkg -l | grep -qw " $pkg " ; then
msg_info " Installing $pkg ... "
if apt-get install -y " $pkg " > /dev/null 2>& 1; then
msg_ok " $pkg installed successfully. "
update_config " $pkg " "installed"
else
msg_error " Failed to install $pkg . Please install it manually. "
update_config " $pkg " "failed"
return 1
fi
else
msg_ok " $pkg is already installed. "
update_config " $pkg " "already_installed"
fi
done
( ( current_step++) )
show_progress $current_step $total_steps "Creating directories and configuration"
mkdir -p " $BASE_DIR "
mkdir -p " $INSTALL_DIR "
if [ ! -f " $CONFIG_FILE " ] ; then
echo '{}' > " $CONFIG_FILE "
fi
msg_ok "Directories and configuration created."
( ( current_step++) )
show_progress $current_step $total_steps "Downloading necessary files"
FILES = (
" $UTILS_FILE $REPO_URL /scripts/utils.sh "
" $INSTALL_DIR / $MENU_SCRIPT $REPO_URL / $MENU_SCRIPT "
" $LOCAL_VERSION_FILE $REPO_URL /version.txt "
)
for file in " ${ FILES [@] } " ; do
IFS = " " read -r dest url <<< " $file "
msg_info " Downloading ${ dest ##*/ } ... "
sleep 2
if wget -qO " $dest " " $url " ; then
msg_ok " ${ dest ##*/ } downloaded successfully. "
else
msg_error " Failed to download ${ dest ##*/ } . Check your Internet connection. "
return 1
fi
done
chmod +x " $INSTALL_DIR / $MENU_SCRIPT "
}
####################################################
install_translation_version( ) {
2025-02-06 17:20:32 +01:00
local total_steps = 4
local current_step = 1
2025-07-04 20:30:19 +02:00
show_progress $current_step $total_steps "Language selection"
select_language
( ( current_step++) )
show_progress $current_step $total_steps "Installing system dependencies"
if ! dpkg -l | grep -qw "jq" ; then
msg_info "Installing jq..."
apt-get update > /dev/null 2>& 1
if apt-get install -y jq > /dev/null 2>& 1; then
msg_ok "jq installed successfully."
update_config "jq" "installed"
else
msg_error "Failed to install jq. Please install it manually."
update_config "jq" "failed"
return 1
fi
else
msg_ok "jq is already installed."
update_config "jq" "already_installed"
fi
DEPS = ( "dialog" "curl" "python3" "python3-venv" "python3-pip" )
for pkg in " ${ DEPS [@] } " ; do
if ! dpkg -l | grep -qw " $pkg " ; then
msg_info " Installing $pkg ... "
if apt-get install -y " $pkg " > /dev/null 2>& 1; then
msg_ok " $pkg installed successfully. "
update_config " $pkg " "installed"
else
msg_error " Failed to install $pkg . Please install it manually. "
update_config " $pkg " "failed"
return 1
fi
else
msg_ok " $pkg is already installed. "
update_config " $pkg " "already_installed"
fi
done
( ( current_step++) )
show_progress $current_step $total_steps "Setting up translation environment"
2025-02-06 17:20:32 +01:00
if [ ! -d " $VENV_PATH " ] || [ ! -f " $VENV_PATH /bin/activate " ] ; then
msg_info "Creating the virtual environment..."
python3 -m venv --system-site-packages " $VENV_PATH " > /dev/null 2>& 1
if [ ! -f " $VENV_PATH /bin/activate " ] ; then
msg_error "Failed to create virtual environment. Please check your Python installation."
update_config "virtual_environment" "failed"
return 1
2025-02-03 23:08:37 +01:00
else
2025-02-06 17:20:32 +01:00
msg_ok "Virtual environment created successfully."
update_config "virtual_environment" "created"
2025-02-03 23:08:37 +01:00
fi
2025-02-02 19:21:58 +01:00
else
2025-02-06 17:20:32 +01:00
msg_ok "Virtual environment already exists."
update_config "virtual_environment" "already_exists"
2025-02-02 19:21:58 +01:00
fi
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
source " $VENV_PATH /bin/activate "
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
msg_info "Upgrading pip..."
if pip install --upgrade pip > /dev/null 2>& 1; then
msg_ok "Pip upgraded successfully."
update_config "pip" "upgraded"
else
msg_error "Failed to upgrade pip."
update_config "pip" "upgrade_failed"
return 1
2025-02-02 19:21:58 +01:00
fi
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
msg_info "Installing googletrans..."
if pip install --break-system-packages --no-cache-dir googletrans = = 4.0.0-rc1 > /dev/null 2>& 1; then
msg_ok "Googletrans installed successfully."
update_config "googletrans" "installed"
else
msg_error "Failed to install googletrans. Please check your internet connection."
update_config "googletrans" "failed"
2025-02-03 23:20:42 +01:00
deactivate
2025-02-06 17:20:32 +01:00
return 1
2025-02-03 23:20:42 +01:00
fi
2025-07-04 20:30:19 +02:00
2025-02-03 23:20:42 +01:00
deactivate
2025-02-06 17:20:32 +01:00
( ( current_step++) )
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
show_progress $current_step $total_steps "Downloading necessary files"
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
mkdir -p " $BASE_DIR "
2025-05-09 12:18:14 +02:00
mkdir -p " $INSTALL_DIR "
2025-02-06 17:20:32 +01:00
FILES = (
2025-02-06 17:25:40 +01:00
" $CACHE_FILE $REPO_URL /json/cache.json "
2025-02-06 17:20:32 +01:00
" $UTILS_FILE $REPO_URL /scripts/utils.sh "
" $INSTALL_DIR / $MENU_SCRIPT $REPO_URL / $MENU_SCRIPT "
" $LOCAL_VERSION_FILE $REPO_URL /version.txt "
)
2025-07-04 20:30:19 +02:00
2025-02-06 17:20:32 +01:00
for file in " ${ FILES [@] } " ; do
IFS = " " read -r dest url <<< " $file "
msg_info " Downloading ${ dest ##*/ } ... "
2025-05-07 19:14:26 +02:00
sleep 2
2025-02-06 17:20:32 +01:00
if wget -qO " $dest " " $url " ; then
msg_ok " ${ dest ##*/ } downloaded successfully. "
2025-07-04 20:30:19 +02:00
if [ [ " $dest " = = " $CACHE_FILE " ] ] ; then
msg_ok "Cache file updated with latest translations."
fi
2025-02-06 17:20:32 +01:00
else
msg_error " Failed to download ${ dest ##*/ } . Check your Internet connection. "
return 1
fi
done
2025-07-04 20:30:19 +02:00
chmod +x " $INSTALL_DIR / $MENU_SCRIPT "
}
2025-02-02 19:21:58 +01:00
2025-07-04 20:30:19 +02:00
####################################################
show_installation_options( ) {
local current_install_type
current_install_type = $( check_existing_installation)
local menu_title = "ProxMenux Installation"
local menu_text = "Choose installation type:"
if [ " $current_install_type " != "none" ] ; then
case " $current_install_type " in
"translation" )
menu_title = "ProxMenux Update - Translation Version Detected"
; ;
"normal" )
menu_title = "ProxMenux Update - Normal Version Detected"
; ;
"unknown" )
menu_title = "ProxMenux Update - Existing Installation Detected"
; ;
esac
fi
INSTALL_TYPE = $( whiptail --backtitle "ProxMenux" --title " $menu_title " --menu " \n $menu_text " 14 70 2 \
"1" "Normal Version (English only)" \
"2" "Translation Version (Multi-language support)" 3>& 1 1>& 2 2>& 3)
if [ -z " $INSTALL_TYPE " ] ; then
msg_warn "Installation cancelled."
exit 1
fi
2025-07-04 22:37:16 +02:00
# For new installations, show confirmation with details
if [ " $current_install_type " = "none" ] ; then
if ! show_installation_confirmation " $INSTALL_TYPE " ; then
msg_warn "Installation cancelled."
exit 1
fi
fi
2025-07-04 20:30:19 +02:00
if ! handle_installation_change " $current_install_type " " $INSTALL_TYPE " ; then
msg_warn "Installation cancelled."
exit 1
fi
}
install_proxmenu( ) {
show_installation_options
case " $INSTALL_TYPE " in
"1" )
show_proxmenux_logo
msg_title "Installing ProxMenux - Normal Version"
install_normal_version
; ;
"2" )
show_proxmenux_logo
msg_title "Installing ProxMenux - Translation Version"
install_translation_version
; ;
*)
msg_error "Invalid option selected."
exit 1
; ;
esac
msg_title "ProxMenux has been installed successfully"
echo -ne " ${ GN } "
type_text "To run ProxMenux, simply execute this command in the console or terminal:"
echo -e " ${ YWB } menu ${ CL } "
echo
2025-02-06 17:20:32 +01:00
}
2025-02-03 23:08:37 +01:00
2025-02-06 17:20:32 +01:00
if [ " $( id -u) " -ne 0 ] ; then
msg_error "This script must be run as root."
exit 1
2025-02-03 23:08:37 +01:00
fi
2025-07-04 20:30:19 +02:00
cleanup_corrupted_files
install_proxmenu