rogs/yams
rogs/yams
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

Add warning about reading the VPN documentation #73

Merged
rogs merged 3 commits from add-vpn-documentation-warning into master 2025-03-14 15:30:31 -03:00
Conversation 4 Commits 3 Files Changed 3 +57 -6
3 changed files with 57 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.org
View File

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

31
docs.org
View File

@ -270,14 +270,39 @@ configure_vpn() {
read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service
vpn_service=${vpn_service:-$DEFAULT_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 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 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 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 echo
read -p "VPN username (without spaces): " vpn_user read -p "VPN username (without spaces): " vpn_user
[ -z "$vpn_user" ] && log_error "VPN username cannot be empty" [ -z "$vpn_user" ] && log_error "VPN username cannot be empty"

31
install.sh
View File

@ -203,14 +203,39 @@ configure_vpn() {
read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service read -p "VPN service? (with spaces) [$DEFAULT_VPN_SERVICE]: " vpn_service
vpn_service=${vpn_service:-$DEFAULT_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 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 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 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 echo
read -p "VPN username (without spaces): " vpn_user read -p "VPN username (without spaces): " vpn_user
[ -z "$vpn_user" ] && log_error "VPN username cannot be empty" [ -z "$vpn_user" ] && log_error "VPN username cannot be empty"