From dc0b432b69c97f725063e308c234f1ee6f4e5c63 Mon Sep 17 00:00:00 2001 From: Thorsten Date: Mon, 20 Jan 2025 09:03:56 +0100 Subject: [PATCH] New Script: Proxmox Mail Gateway Post Installer (#1559) * Create post-pmg-install.sh Adding Proxmox Mail Gateway Post Installer * Create post-pmg-install.json * Apply suggestions from code review I'll merge it, but this text string are 1:1 copy from the post-pbs-install.sh script. Maybe we should also fix them there. Co-authored-by: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> * smaller fixes * update ascii to slant --------- Co-authored-by: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com> --- json/post-pmg-install.json | 47 ++++++++++ misc/post-pmg-install.sh | 177 +++++++++++++++++++++++++++++++++++++ 2 files changed, 224 insertions(+) create mode 100644 json/post-pmg-install.json create mode 100644 misc/post-pmg-install.sh diff --git a/json/post-pmg-install.json b/json/post-pmg-install.json new file mode 100644 index 00000000..2924d51f --- /dev/null +++ b/json/post-pmg-install.json @@ -0,0 +1,47 @@ +{ +"name": "Proxmox Mail Gateway Post Install", +"slug": "post-pmg-install", +"categories": [ + 1 +], +"date_created": "2025-01-20", +"type": "misc", +"updateable": false, +"privileged": false, +"interface_port": null, +"documentation": null, +"website": null, +"logo": "https://raw.githubusercontent.com/home-assistant/brands/master/core_integrations/proxmoxve/icon.png", +"description": "The script will give options to Disable the Enterprise Repo, Add/Correct PMG Sources, Enable the No-Subscription Repo, Add Test Repo, Disable Subscription Nag, Update Proxmox Mail Gateway and Reboot PMG.", +"install_methods": [ + { + "type": "default", + "script": "misc/post-pmg-install.sh", + "resources": { + "cpu": null, + "ram": null, + "hdd": null, + "os": null, + "version": null + } + } +], +"default_credentials": { + "username": null, + "password": null +}, +"notes": [ + { + "text": "Proxmox Mail Gateway ONLY", + "type": "info" + }, + { + "text": "Execute within the Proxmox Mail Gateway Shell", + "type": "info" + }, + { + "text": "It is recommended to answer β€œyes” (y) to all options presented during the process.", + "type": "info" + } +] +} diff --git a/misc/post-pmg-install.sh b/misc/post-pmg-install.sh new file mode 100644 index 00000000..d29fbf2a --- /dev/null +++ b/misc/post-pmg-install.sh @@ -0,0 +1,177 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: thost96 (thost96) +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE + +header_info() { + clear + cat <<"EOF" + ____ __ _________ ____ __ ____ __ ____ + / __ \/ |/ / ____/ / __ \____ _____/ /_ / _/___ _____/ /_____ _/ / / + / /_/ / /|_/ / / __ / /_/ / __ \/ ___/ __/ / // __ \/ ___/ __/ __ `/ / / + / ____/ / / / /_/ / / ____/ /_/ (__ ) /_ _/ // / / (__ ) /_/ /_/ / / / +/_/ /_/ /_/\____/ /_/ \____/____/\__/ /___/_/ /_/____/\__/\__,_/_/_/ + +EOF +} + +RD=$(echo "\033[01;31m") +YW=$(echo "\033[33m") +GN=$(echo "\033[1;92m") +CL=$(echo "\033[m") +BFR="\\r\\033[K" +HOLD="-" +CM="${GN}βœ“${CL}" +CROSS="${RD}βœ—${CL}" + +set -euo pipefail +shopt -s inherit_errexit nullglob + +msg_info() { + local msg="$1" + echo -ne " ${HOLD} ${YW}${msg}..." +} + +msg_ok() { + local msg="$1" + echo -e "${BFR} ${CM} ${GN}${msg}${CL}" +} + +msg_error() { + local msg="$1" + echo -e "${BFR} ${CROSS} ${RD}${msg}${CL}" +} + +start_routines() { + header_info + VERSION="$(awk -F'=' '/^VERSION_CODENAME=/{ print $NF }' /etc/os-release)" + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "PMG SOURCES" --menu "This will set the correct sources to update and install Proxmox Mail Gateway.\n \nChange to Proxmox Mail Gateway sources?" 14 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Changing to Proxmox Mail Gateway Sources" + cat </etc/apt/sources.list +deb http://deb.debian.org/debian ${VERSION} main contrib +deb http://deb.debian.org/debian ${VERSION}-updates main contrib +deb http://security.debian.org/debian-security ${VERSION}-security main contrib +EOF + msg_ok "Changed to Proxmox Mail Gateway Sources" + ;; + no) + msg_error "Selected no to Correcting Proxmox Mail Gateway Sources" + ;; + esac + + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "PMG-ENTERPRISE" --menu "The 'pmg-enterprise' repository is only available to users who have purchased a Proxmox Mail Gateway subscription.\n \nDisable 'pmg-enterprise' repository?" 14 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Disabling 'pmg-enterprise' repository" + cat </etc/apt/sources.list.d/pmg-enterprise.list +# deb https://enterprise.proxmox.com/debian/pmg ${VERSION} pmg-enterprise +EOF + msg_ok "Disabled 'pmg-enterprise' repository" + ;; + no) + msg_error "Selected no to disabling 'pmg-enterprise' repository" + ;; + esac + + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "PMG-NO-SUBSCRIPTION" --menu "The 'pmg-no-subscription' repository provides access to all of the open-source components of Proxmox Mail Gateway.\n \nEnable 'pmg-no-subscription' repository?" 14 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Enabling 'pmg-no-subscription' repository" + cat </etc/apt/sources.list.d/pmg-install-repo.list +deb http://download.proxmox.com/debian/pmg ${VERSION} pmg-no-subscription +EOF + msg_ok "Enabled 'pmg-no-subscription' repository" + ;; + no) + msg_error "Selected no to enabling 'pmg-no-subscription' repository" + ;; + esac + + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "PMG TEST" --menu "The 'pmgtest' repository can give advanced users access to new features and updates before they are officially released.\n \nAdd (Disabled) 'pmgtest' repository?" 14 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Adding 'pmgtest' repository and set disabled" + cat </etc/apt/sources.list.d/pmgtest-for-beta.list +# deb http://download.proxmox.com/debian/pmg ${VERSION} pmgtest +EOF + msg_ok "Added 'pmgtest' repository" + ;; + no) + msg_error "Selected no to adding 'pmgtest' repository" + ;; + esac + + if [[ ! -f /etc/apt/apt.conf.d/no-nag-script ]]; then + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "SUBSCRIPTION NAG" --menu "This will disable the nag message reminding you to purchase a subscription every time you log in to the web interface.\n \nDisable subscription nag?" 14 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + whiptail --backtitle "Proxmox VE Helper Scripts" --msgbox --title "Support Subscriptions" "Supporting the software's development team is essential. Check their official website's Support Subscriptions for pricing. Without their dedicated work, we wouldn't have this exceptional software." 10 58 + msg_info "Disabling subscription nag" + echo "DPkg::Post-Invoke { \"dpkg -V proxmox-widget-toolkit | grep -q '/proxmoxlib\.js$'; if [ \$? -eq 1 ]; then { echo 'Removing subscription nag from UI...'; sed -i '/data\.status.*{/{s/\!//;s/active/NoMoreNagging/}' /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js; }; fi\"; };" >/etc/apt/apt.conf.d/no-nag-script + apt --reinstall install proxmox-widget-toolkit &>/dev/null + msg_ok "Disabled subscription nag (Delete browser cache)" + ;; + no) + whiptail --backtitle "Proxmox VE Helper Scripts" --msgbox --title "Support Subscriptions" "Supporting the software's development team is essential. Check their official website's Support Subscriptions for pricing. Without their dedicated work, we wouldn't have this exceptional software." 10 58 + msg_error "Selected no to disabling subscription nag" + ;; + esac + fi + + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "UPDATE" --menu "\nUpdate Proxmox Mail Gateway now?" 11 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Updating Proxmox Mail Gateway (Patience)" + apt-get update &>/dev/null + apt-get -y dist-upgrade &>/dev/null + msg_ok "Updated Proxmox Mail Gateway" + ;; + no) + msg_error "Selected no to updating Proxmox Mail Gateway" + ;; + esac + + CHOICE=$(whiptail --backtitle "Proxmox VE Helper Scripts" --title "REBOOT" --menu "\nReboot Proxmox Mail Gateway now? (recommended)" 11 58 2 \ + "yes" " " \ + "no" " " 3>&2 2>&1 1>&3) + case $CHOICE in + yes) + msg_info "Rebooting Proxmox Mail Gateway" + sleep 2 + msg_ok "Completed Post Install Routines" + reboot + ;; + no) + msg_error "Selected no to reboot Proxmox Mail Gateway (Reboot recommended)" + msg_ok "Completed Post Install Routines" + ;; + esac +} + +header_info +echo -e "\nThis script will Perform Post Install Routines.\n" +while true; do + read -p "Start the Proxmox Mail Gateway Post Install Script (y/n)?" yn + case $yn in + [Yy]*) break ;; + [Nn]*) clear; exit ;; + *) echo "Please answer yes or no." ;; + esac +done + +start_routines