Merge branch 'CBH/Bugfix/Formatting'

automated install/basic-install.sh

@@ -63,6 +63,7 @@ else
 	fi
 fi
 
+
 if [ -d "/etc/pihole" ]; then
 		# Likely an existing install
 		upgrade=true
@@ -86,10 +87,8 @@ spinner(){
 	printf "\b"
 }
 
-
-
-
 backupLegacyPihole() {
+	# This function detects and backups the pi-hole v1 files.  It will not do anything to the current version files.
 	if [[ -f /etc/dnsmasq.d/adList.conf ]];then
 		echo "Original Pi-hole detected.  Initiating sub space transport"
 		$SUDO mkdir -p /etc/pihole/original/
@@ -184,6 +183,7 @@ use4andor6(){
 }
 
 useIPv6dialog() {
+	# Show the IPv6 address used for blocking
 	piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
 	whiptail --msgbox --backtitle "IPv6..." --title "IPv6 Supported" "$piholeIPv6 will be used to block ads." $r $c
 
@@ -254,6 +254,7 @@ setDHCPCD(){
 }
 
 setStaticIPv4() {
+	# Tries to set the IPv4 address
 	if grep -q $IPv4addr $dhcpcdFile; then
 		# address already set, noop
 		:
@@ -267,6 +268,7 @@ setStaticIPv4(){
 }
 
 installScripts() {
+	# Install the scripts from /etc/.pihole to their various locations
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing scripts..."
 	$SUDO cp /etc/.pihole/gravity.sh /usr/local/bin/gravity.sh
@@ -280,6 +282,7 @@ installScripts(){
 }
 
 installConfigs() {
+	# Install the configs from /etc/.pihole to their various locations
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing configs..."
 	$SUDO mv /etc/dnsmasq.conf /etc/dnsmasq.conf.orig
@@ -291,6 +294,7 @@ installConfigs(){
 }
 
 stopServices() {
+	# Stop dnsmasq and lighttpd
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Stopping services..."
 	$SUDO service dnsmasq stop & spinner $! || true
@@ -299,13 +303,11 @@ stopServices(){
 }
 
 checkForDependencies() {
- 		
 	#Running apt-get update/upgrade with minimal output can cause some issues with
 	#requiring user input (e.g password for phpmyadmin see #218)
 	#We'll change the logic up here, to check to see if there are any updates availible and
 	# if so, advise the user to run apt-get update/upgrade at their own discretion
 
- 		
 	#Check to see if apt-get update has already been run today
 	# it needs to have been run at least once on new installs!
 
@@ -320,12 +322,10 @@ checkForDependencies(){
 	    $SUDO apt-get -qq update & spinner $!
 	    echo " done!"
 	  fi
- 		
 		echo ":::"
 		echo -n "::: Checking apt-get for upgraded packages...."
 		updatesToInstall=$(sudo apt-get -s -o Debug::NoLocking=true upgrade | grep -c ^Inst)
 		echo " done!"
-				
 		echo ":::"
 		if [[ $updatesToInstall -eq "0" ]]; then
 			echo "::: Your pi is up to date! Continuing with pi-hole installation..."
@@ -334,7 +334,6 @@ checkForDependencies(){
 			echo "::: We recommend you run 'sudo apt-get upgrade' after installing Pi-Hole! "
 			echo ":::"
 		fi
-    
     echo ":::"
     echo "::: Checking dependencies:"
 
@@ -354,7 +353,7 @@ checkForDependencies(){
 }
 
 getGitFiles() {
-  
+	# Setup git repos for base files and web admin
 	echo ":::"
 	echo "::: Checking for existing base files..."
 	if is_repo $piholeFilesDir; then
@@ -369,26 +368,22 @@ getGitFiles(){
 		make_repo $webInterfaceDir $webInterfaceGitUrl
 	else
 		update_repo $webInterfaceDir
-  		
 	fi
-
 }
 
 is_repo() {
+	# If the directory does not have a .git folder it is not a repo
 	echo -n ":::    Checking $1 is a repo..."
-    # if the directory does not have a .git folder 
-    # it is not a repo
     if [ -d "$1/.git" ]; then
     		echo " OK!"
         return 1
     fi
     echo " not found!!"
     return 0
-    
 }
 
 make_repo() {
-    # remove the non-repod interface and clone the interface
+    # Remove the non-repod interface and clone the interface
     echo -n ":::    Cloning $2 into $1..."
     $SUDO rm -rf $1
     $SUDO git clone -q "$2" "$1" > /dev/null & spinner $!
@@ -396,7 +391,7 @@ make_repo() {
 }
 
 update_repo() {
-    # pull the latest commits
+    # Pull the latest commits
     echo -n ":::     Updating repo in $1..."
     cd "$1"
     $SUDO git pull -q > /dev/null & spinner $!
@@ -405,6 +400,7 @@ update_repo() {
 
 
 CreateLogFile() {
+	# Create logfiles if necessary
 	echo ":::"
 	$SUDO  echo -n "::: Creating log file and changing owner to dnsmasq..."
 	if [ ! -f /var/log/pihole.log ]; then
@@ -415,10 +411,10 @@ CreateLogFile(){
 	else
 		$SUDO  echo " already exists!"
 	fi
-	
 }
 
 installPiholeWeb() {
+	# Install the web interface
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing pihole custom index page..."
 	if [ -d "/var/www/html/pihole" ]; then
@@ -429,10 +425,10 @@ installPiholeWeb(){
 		$SUDO cp /etc/.pihole/advanced/index.html /var/www/html/pihole/index.html
 		$SUDO echo " done!"
 	fi
-	
 }
 
 installCron() {
+	# Install the cron job
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing latest Cron script..."
 	$SUDO cp /etc/.pihole/advanced/pihole.cron /etc/cron.d/pihole
@@ -440,6 +436,7 @@ installCron(){
 }
 
 runGravity() {
+	# Rub gravity.sh to build blacklists
 	$SUDO echo ":::"
 	$SUDO echo "::: Preparing to run gravity.sh to refresh hosts..."
 	if ls /etc/pihole/list* 1> /dev/null 2>&1; then
@@ -451,11 +448,11 @@ runGravity(){
 	echo ":::"
 
 	/usr/local/bin/gravity.sh
-	
 }
 
 
 installPihole() {
+	# Install base files and web interface
 	checkForDependencies # done
 	stopServices
 	$SUDO mkdir -p /etc/pihole/
@@ -475,6 +472,7 @@ installPihole(){
 }
 
 displayFinalMessage() {
+	# Final completion message to user
 	whiptail --msgbox --backtitle "Make it so." --title "Installation Complete!" "Configure your devices to use the Pi-hole as their DNS server using:
 
 $IPv4addr
@@ -504,5 +502,7 @@ installPihole | tee $tmpLog
 $SUDO mv $tmpLog $instalLogLoc
 
 displayFinalMessage
+
+# Start services
 $SUDO service dnsmasq start
 $SUDO service lighttpd start