From 39b6089dccc229eb7ba74334a7a2b9e3f1786ee3 Mon Sep 17 00:00:00 2001 From: Roger Gonzalez Date: Fri, 14 Mar 2025 14:59:25 -0300 Subject: [PATCH] Add dramatic warning for ProtonVPN setup - Added a dramatic warning to the ProtonVPN setup process in docs.org and install.sh. - The warning highlights the importance of reading VPN documentation and provides a link to the setup documentation for each VPN provider. - The warning is intended to help users avoid common setup failures caused by not reading the VPN documentation. - The warning is displayed before proceeding with the setup process, ensuring users understand the importance of reading the documentation. --- docs.org | 27 ++++++++++++++++++++++++--- install.sh | 27 ++++++++++++++++++++++++--- 2 files changed, 48 insertions(+), 6 deletions(-) diff --git a/docs.org b/docs.org index bac7248..43bd344 100644 --- a/docs.org +++ b/docs.org @@ -270,14 +270,35 @@ configure_vpn() { read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service vpn_service=${vpn_service:-$DEFAULT_VPN_SERVICE} +# Clear screen and show dramatic warning + printf "\033c" + + cat << "EOF" +⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ +⚠️ ⚠️ +⚠️ READ THIS EXTREMELY CAREFULLY ⚠️ +⚠️ ⚠️ +⚠️ YOU MUST READ YOUR VPN DOCUMENTATION! ⚠️ +⚠️ ⚠️ +⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ +EOF + + echo + log_info "Most VPN setup failures happen because users don't read the documentation" + log_info "for their specific VPN provider. Each VPN has different requirements!" + echo + log_warning "YOUR VPN DOCUMENTATION IS HERE:" + echo "https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/${vpn_service// /-}.md" echo - log_info "Please check $vpn_service's documentation for specific configuration:" - log_info "https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/${vpn_service// /-}.md" if [ "$vpn_service" = "protonvpn" ]; then - log_info "DO NOT USE YOUR PROTON ACCOUNT USERNAME AND PASSWORD. REFER TO THE DOCUMENTATION ABOVE TO OBTAIN THE CORRECT VPN USERNAME AND PASSWORD." + log_error "DO NOT USE YOUR PROTON ACCOUNT USERNAME AND PASSWORD. REFER TO THE DOCUMENTATION ABOVE TO OBTAIN THE CORRECT VPN USERNAME AND PASSWORD." + echo fi + log_info "The next steps WILL FAIL if you don't follow the documentation correctly." + read -p "Press ENTER after you've READ the VPN documentation to continue..." -r + echo read -p "VPN username (without spaces): " vpn_user [ -z "$vpn_user" ] && log_error "VPN username cannot be empty" diff --git a/install.sh b/install.sh index 14057f6..694006b 100644 --- a/install.sh +++ b/install.sh @@ -203,14 +203,35 @@ configure_vpn() { read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service vpn_service=${vpn_service:-$DEFAULT_VPN_SERVICE} +# Clear screen and show dramatic warning + printf "\033c" + + cat << "EOF" +⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ +⚠️ ⚠️ +⚠️ READ THIS EXTREMELY CAREFULLY ⚠️ +⚠️ ⚠️ +⚠️ YOU MUST READ YOUR VPN DOCUMENTATION! ⚠️ +⚠️ ⚠️ +⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ +EOF + + echo + log_info "Most VPN setup failures happen because users don't read the documentation" + log_info "for their specific VPN provider. Each VPN has different requirements!" + echo + log_warning "YOUR VPN DOCUMENTATION IS HERE:" + echo "https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/${vpn_service// /-}.md" echo - log_info "Please check $vpn_service's documentation for specific configuration:" - log_info "https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/${vpn_service// /-}.md" if [ "$vpn_service" = "protonvpn" ]; then - log_info "DO NOT USE YOUR PROTON ACCOUNT USERNAME AND PASSWORD. REFER TO THE DOCUMENTATION ABOVE TO OBTAIN THE CORRECT VPN USERNAME AND PASSWORD." + log_error "DO NOT USE YOUR PROTON ACCOUNT USERNAME AND PASSWORD. REFER TO THE DOCUMENTATION ABOVE TO OBTAIN THE CORRECT VPN USERNAME AND PASSWORD." + echo fi + log_info "The next steps WILL FAIL if you don't follow the documentation correctly." + read -p "Press ENTER after you've READ the VPN documentation to continue..." -r + echo read -p "VPN username (without spaces): " vpn_user [ -z "$vpn_user" ] && log_error "VPN username cannot be empty"