Changes for FR #897

Support For DHCP IP Reservation

Main:
  - added If statement to skipp SetStaticIPv4 if dhcpRserv=1

getStaticIPv4Settings:
  - Added Whiptail asking if user wants to use DHCP reservation Settings, this will add dhcpReserv and
    skip setStaticIPv4 while still logging everything.
ConfigExample files:
  - Added staticReserv=0 to config examples. so it can be used with Unattended install
    * 0 means static ip will be setup.
    * 1 means DHCP Reservation will be used and no chage will be made to the interfaces

LatestUpdate.md

@@ -5,7 +5,26 @@ patch release notes.
 
 Everytime Test branch is merged into master, a new entry should be created with the date and changes being merged.
 
-##Jan 6th 2020
+## Jan 7th 2020
+
+Changes for FR #897
+Support For DHCP IP Reservation
+
+Main:
+  - added If statement to skipp SetStaticIPv4 if dhcpRserv=1
+
+getStaticIPv4Settings:
+  - Added Whiptail asking if user wants to use DHCP reservation Settings, this will add dhcpReserv and
+    skip setStaticIPv4 while still logging everything.
+ConfigExample files:
+  - Added staticReserv=0 to config examples. so it can be used with Unattended install
+    * 0 means static ip will be setup.
+    * 1 means DHCP Reservation will be used and no chage will be made to the interfaces
+
+
+Updated LatestChanges
+
+## Jan 6th 2020
 
 * Removed Unecessary pipe on availableInterfaces
 * Changed OS Support messages accross the script
@@ -36,7 +55,7 @@ Everytime Test branch is merged into master, a new entry should be created with
     - the script now checks for hostname length right at the beginning and prompts for a new one.
     - HOST_NAME to host_name, as best practice variables with capitals, should be used by system variables only.
 * fixed ubuntu 18.04 being detected as not supported OS, now fully supported and tested.
-* changed how scripts are copied to /opt/pivpn, it hat a lot of long repetitive lines, now it copies all *.sh files making it easier to manage when adding new scripts/features
+* changed how scripts are copied to /opt/pivpn, it hat a lot of long repetitive lines, now it copies all `*.sh` files making it easier to manage when adding new scripts/features
 * Changed how supported OS are presented when maybeOS_Support() is called.
 
 ## Sept 1st 2019

auto_install/install.sh

@@ -166,7 +166,9 @@ main(){
 		avoidStaticIPv4Ubuntu
 	else
 		getStaticIPv4Settings
-		setStaticIPv4
+		if [ $dhcpReserv -ne 1 ] || [ -z $dhcpReserv ]; then
+			setStaticIPv4
+		fi
 	fi
 
 	# Choose the user for the ovpns
@@ -636,56 +638,75 @@ getStaticIPv4Settings() {
 	fi
 
 	local ipSettingsCorrect
-	# Ask if the user wants to use DHCP settings as their static IP
+	# Some users reserve IP addresses on another DHCP Server or on their routers,
-	if (whiptail --backtitle "Calibrating network interface" --title "Static IP Address" --yesno "Do you want to use your current network settings as a static address?
+	# Lets ask them if they want to make any changes to their interfaces.
+	if (whiptail --backtitle "Calibrating network interface" --title "DHCP Reservation" --yesno \
+	"Are you Using DHCP Reservation on your Router/DHCP Server?
+These are your current Network Settings:
+
+				IP address:    ${IPv4addr}
+				Gateway:       ${IPv4gw}
+
+Yes: Keep using DHCP reservation
+No: Setup static IP address
+Don't know what DHCP Reservation is? Answer No." ${r} ${c}); then
+		dhcpReserv=1
+		echo "dhcpReserv=${dhcpReserv}" >> /tmp/setupVars.conf
+		echo "IPv4addr=${IPv4addr%/*}" >> /tmp/setupVars.conf
+		echo "IPv4gw=${IPv4gw}" >> /tmp/setupVars.conf
+	else
+		# Ask if the user wants to use DHCP settings as their static IP
+		if (whiptail --backtitle "Calibrating network interface" --title "Static IP Address" --yesno "Do you want to use your current network settings as a static address?
 					IP address:    ${IPv4addr}
 					Gateway:       ${IPv4gw}" ${r} ${c}); then
 
-		echo "IPv4addr=${IPv4addr%/*}" >> /tmp/setupVars.conf
+				echo "IPv4addr=${IPv4addr%/*}" >> /tmp/setupVars.conf
-		echo "IPv4gw=${IPv4gw}" >> /tmp/setupVars.conf
+				echo "IPv4gw=${IPv4gw}" >> /tmp/setupVars.conf
-		# If they choose yes, let the user know that the IP address will not be available via DHCP and may cause a conflict.
+				# If they choose yes, let the user know that the IP address will not be available via DHCP and may cause a conflict.
-		whiptail --msgbox --backtitle "IP information" --title "FYI: IP Conflict" "It is possible your router could still try to assign this IP to a device, which would cause a conflict.  But in most cases the router is smart enough to not do that.
+				whiptail --msgbox --backtitle "IP information" --title "FYI: IP Conflict" "It is possible your router could still try to assign this IP to a device, which would cause a conflict.  But in most cases the router is smart enough to not do that.
 If you are worried, either manually set the address, or modify the DHCP reservation pool so it does not include the IP you want.
 It is also possible to use a DHCP reservation, but if you are going to do that, you might as well set a static address." ${r} ${c}
 		# Nothing else to do since the variables are already set above
-	else
+		else
 		# Otherwise, we need to ask the user to input their desired settings.
 		# Start by getting the IPv4 address (pre-filling it with info gathered from DHCP)
 		# Start a loop to let the user enter their information with the chance to go back and edit it if necessary
-		until [[ ${ipSettingsCorrect} = True ]]; do
+			until [[ ${ipSettingsCorrect} = True ]]; do
 			# Ask for the IPv4 address
-			if IPv4addr=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 address" --inputbox "Enter your desired IPv4 address" ${r} ${c} "${IPv4addr}" 3>&1 1>&2 2>&3) ; then
+				if IPv4addr=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 address" --inputbox "Enter your desired IPv4 address" ${r} ${c} "${IPv4addr}" 3>&1 1>&2 2>&3) ; then
-			echo "::: Your static IPv4 address:    ${IPv4addr}"
+					echo "::: Your static IPv4 address:    ${IPv4addr}"
-			# Ask for the gateway
+					# Ask for the gateway
-			if IPv4gw=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 gateway (router)" --inputbox "Enter your desired IPv4 default gateway" ${r} ${c} "${IPv4gw}" 3>&1 1>&2 2>&3) ; then
+					if IPv4gw=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 gateway (router)" --inputbox "Enter your desired IPv4 default gateway" ${r} ${c} "${IPv4gw}" 3>&1 1>&2 2>&3) ; then
-				echo "::: Your static IPv4 gateway:    ${IPv4gw}"
+						echo "::: Your static IPv4 gateway:    ${IPv4gw}"
-				# Give the user a chance to review their settings before moving on
+						# Give the user a chance to review their settings before moving on
-				if (whiptail --backtitle "Calibrating network interface" --title "Static IP Address" --yesno "Are these settings correct?
+						if (whiptail --backtitle "Calibrating network interface" --title "Static IP Address" --yesno "Are these settings correct?
-					IP address:    ${IPv4addr}
+						IP address:    ${IPv4addr}
-					Gateway:       ${IPv4gw}" ${r} ${c}); then
+						Gateway:       ${IPv4gw}" ${r} ${c}); then
-					# If the settings are correct, then we need to set the pivpnIP
+							# If the settings are correct, then we need to set the pivpnIP
-					echo "IPv4addr=${IPv4addr%/*}" >> /tmp/setupVars.conf
+							echo "IPv4addr=${IPv4addr%/*}" >> /tmp/setupVars.conf
-					echo "IPv4gw=${IPv4gw}" >> /tmp/setupVars.conf
+							echo "IPv4gw=${IPv4gw}" >> /tmp/setupVars.conf
-					# After that's done, the loop ends and we move on
+							# After that's done, the loop ends and we move on
-					ipSettingsCorrect=True
+							ipSettingsCorrect=True
+						else
+							# If the settings are wrong, the loop continues
+							ipSettingsCorrect=False
+						fi
+					else
+						# Cancelling gateway settings window
+						ipSettingsCorrect=False
+						echo "::: Cancel selected. Exiting..."
+						exit 1
+					fi
 				else
-					# If the settings are wrong, the loop continues
+					# Cancelling IPv4 settings window
 					ipSettingsCorrect=False
+					echo "::: Cancel selected. Exiting..."
+					exit 1
 				fi
-			else
+			done
-				# Cancelling gateway settings window
+			# End the if statement for DHCP vs. static
-				ipSettingsCorrect=False
-				echo "::: Cancel selected. Exiting..."
-				exit 1
-			fi
-		else
-			# Cancelling IPv4 settings window
-			ipSettingsCorrect=False
-			echo "::: Cancel selected. Exiting..."
-			exit 1
 		fi
-		done
+		# End of If Statement for DCHCP Reservation
-		# End the if statement for DHCP vs. static
 	fi
 }
 

unattended_openvpn_example.conf

@@ -1,4 +1,5 @@
 IPv4dev=eth0
+staticReserv=0
 install_user=pi
 VPN=openvpn
 pivpnPROTO=udp

unattended_wireguard_example.conf

@@ -1,4 +1,5 @@
 IPv4dev=eth0
+staticReserv=0
 install_user=pi
 VPN=wireguard
 pivpnPORT=51820