Merge branch 'add-vpn-documentation-warning' into 'master'

Add warning about reading the VPN documentation

Closes #46

See merge request rogs/yams!24

README.org

@@ -219,5 +219,6 @@ YAMS wouldn't be possible without:
   + [[https://github.com/isaac152][isaac152]]
   + [[https://gitlab.com/jataggart][Jay Taggart]]
 - The YAMS community for testing and feedback
+- https://patorjk.com/software/taag/ for the ascii art!
 
 And most importantly: Thank you for using YAMS! 🙏

docs.org

@@ -270,14 +270,39 @@ 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"
+
+
+██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗
+██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝
+██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗
+██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║
+╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝
+ ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝
+
+
+EOF
+    log_warning "READ THIS EXTREMELY CAREFULLY"
+    log_warning "YOU MUST READ YOUR VPN DOCUMENTATION!"
+    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_warning "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"

install.sh

@@ -203,14 +203,39 @@ 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"
+
+
+██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗
+██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝
+██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗
+██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║
+╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝
+ ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝
+
+
+EOF
+    log_warning "READ THIS EXTREMELY CAREFULLY"
+    log_warning "YOU MUST READ YOUR VPN DOCUMENTATION!"
+    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_warning "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"