Merge branch 'development' into CBH/UpstreamDNS

Conflicts:
	automated install/basic-install.sh

README.md

@@ -26,6 +26,8 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei
 - [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
 
 ## Coverage
+- [Splunk: Pi-hole Visualizser](https://splunkbase.splunk.com/app/3023/)
+- [The Defrag Show - MSDN/Channel 9](https://channel9.msdn.com/Shows/The-Defrag-Show/Defrag-Endoscope-USB-Camera-The-Final-HoloLens-Vote-Adblock-Pi-and-more?WT.mc_id=dlvr_twitter_ch9#time=20m39s)
 - [MacObserver Podcast 585](http://www.macobserver.com/tmo/podcast/macgeekgab-585)
 - [Medium: Block All Ads For $53](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d)
 - [MakeUseOf: Adblock Everywhere, The Pi-hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/)

adlists.default

@@ -0,0 +1,8 @@
+https://adaway.org/hosts.txt
+http://adblock.gjtech.net/?format=unix-hosts
+http://hosts-file.net/ad_servers.txt
+http://www.malwaredomainlist.com/hostslist/hosts.txt
+http://pgl.yoyo.org/adservers/serverlist.php?
+http://someonewhocares.org/hosts/hosts
+http://winhelp2002.mvps.org/hosts.txt
+http://mirror1.malwaredomains.com/files/justdomains

automated install/basic-install.sh

@@ -16,7 +16,9 @@
 #
 # curl -L install.pi-hole.net | bash
 
+
 ######## VARIABLES #########
+
 tmpLog=/tmp/pihole-install.log
 instalLogLoc=/etc/pihole/install.log
 
@@ -34,7 +36,9 @@ columns=$(tput cols)
 r=$(( rows / 2 ))
 c=$(( columns / 2 ))
 
+
 # Find IP used to route to outside world
+
 IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
 IPv4addr=$(ip -o -f inet addr show dev $IPv4dev | awk '{print $4}' | awk 'END {print}')
 IPv4gw=$(ip route get 8.8.8.8 | awk '{print $3}')
@@ -59,8 +63,9 @@ else
 	fi
 fi
 
-if [ -f "/etc/dnsmasq.d/01-pihole.conf" ]; then
+
-		#Likely an existing install
+if [ -d "/etc/pihole" ]; then
+		# Likely an existing install
 		upgrade=true
 	else
 		upgrade=false
@@ -68,7 +73,7 @@ fi
 
 ####### FUNCTIONS ##########
 ###All credit for the below function goes to http://fitnr.com/showing-a-bash-spinner.html
-spinner(){
+spinner() {
 	local pid=$1
 
 	spin='-\|/'
@@ -82,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.
-
-backupLegacyPihole(){
 	if [[ -f /etc/dnsmasq.d/adList.conf ]];then
 		echo "Original Pi-hole detected.  Initiating sub space transport"
 		$SUDO mkdir -p /etc/pihole/original/
@@ -100,7 +103,7 @@ backupLegacyPihole(){
 	fi
 }
 
-welcomeDialogs(){
+welcomeDialogs() {
 	# Display the welcome dialog
 	whiptail --msgbox --backtitle "Welcome" --title "Pi-hole automated installer" "This installer will transform your Raspberry Pi into a network-wide ad blocker!" $r $c
 
@@ -112,8 +115,8 @@ welcomeDialogs(){
 	In the next section, you can choose to use your current network settings (DHCP) or to manually edit them." $r $c
 }
 
-chooseInterface(){
+chooseInterface() {
-# Turn the available interfaces into an array so it can be used with a whiptail dialog
+	# Turn the available interfaces into an array so it can be used with a whiptail dialog
 	interfacesArray=()
 	firstloop=1
 
@@ -141,7 +144,7 @@ chooseInterface(){
 }
 
 
-use4andor6(){
+use4andor6() {
 	# Let use select IPv4 and/or IPv6
 	cmd=(whiptail --separate-output --checklist "Select Protocols" $r $c 2)
 	options=(IPv4 "Block ads over IPv4" on
@@ -179,14 +182,15 @@ use4andor6(){
 	fi
 }
 
-useIPv6dialog(){
+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
-	$SUDO mkdir -p /etc/pihole/
+
 	$SUDO touch /etc/pihole/.useIPv6
 }
 
-getStaticIPv4Settings(){
+getStaticIPv4Settings() {
 	# 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
@@ -241,22 +245,25 @@ getStaticIPv4Settings(){
 	fi
 }
 
-setDHCPCD(){
+setDHCPCD() {
-	#Append these lines to dhcpcd.conf to enable a static IP
+	# Append these lines to dhcpcd.conf to enable a static IP
 	echo "interface $piholeInterface
 	static ip_address=$IPv4addr
 	static routers=$IPv4gw
 	static domain_name_servers=$IPv4gw" | $SUDO tee -a $dhcpcdFile >/dev/null
 }
 
-setStaticIPv4(){
+setStaticIPv4() {
+	# Tries to set the IPv4 address
 	if grep -q $IPv4addr $dhcpcdFile; then
 		# address already set, noop
 		:
 	else
 		setDHCPCD
 		$SUDO ip addr replace dev $piholeInterface $IPv4addr
-		echo "Setting IP to $IPv4addr.  You may need to restart after the install is complete."
+		echo ":::"
+		echo "::: Setting IP to $IPv4addr.  You may need to restart after the install is complete."
+		echo ":::"
 	fi
 }
 
@@ -305,7 +312,8 @@ versionCheckDNSmasq(){
 	$SUDO sed -i "s/@DNS2@/$piholeDNS2/" /etc/dnsmasq.d/01-pihole.conf
 }
 
-installScripts(){
+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
@@ -318,16 +326,20 @@ installScripts(){
 	$SUDO echo " done."
 }
 
-installConfigs(){
+installConfigs() {
+	# Install the configs from /etc/.pihole to their various locations
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing configs..."
 	versionCheckDNSmasq
 	$SUDO mv /etc/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf.orig
 	$SUDO cp /etc/.pihole/advanced/lighttpd.conf /etc/lighttpd/lighttpd.conf 
+	$SUDO cp /etc/.pihole/advanced/dnsmasq.conf /etc/dnsmasq.conf
+	$SUDO sed -i "s/@INT@/$piholeInterface/" /etc/dnsmasq.conf
 	$SUDO echo " done."
 }
 
-stopServices(){
+stopServices() {
+	# Stop dnsmasq and lighttpd
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Stopping services..."
 	$SUDO service dnsmasq stop & spinner $! || true
@@ -335,26 +347,38 @@ stopServices(){
 	$SUDO echo " done."
 }
 
-checkForDependencies(){
+checkForDependencies() {
- 		echo ":::" 		
+	#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!
+
 	timestamp=$(stat -c %Y /var/cache/apt/)
 	timestampAsDate=$(date -d @$timestamp "+%b %e")
 	today=$(date "+%b %e")
 
 	if [ ! "$today" == "$timestampAsDate" ]; then
 	    #update package lists
-	    echo -n "::: Updating package list before install...."
+	    echo ":::"
-	    $SUDO apt-get -qq update > /dev/null & spinner $!
+	    echo -n "::: apt-get update has not been run today. Running now..."
+	    $SUDO apt-get -qq update & spinner $!
 	    echo " done!"
-	    echo -n "::: Upgrading installed apt-get packages...."
-	    $SUDO apt-get -y -qq upgrade > /dev/null & spinner $!
-	    echo " done!"
-    else
-    	echo "::: Apt-get update already run today, any more would be overkill..."    
 	  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..."
+		else
+			echo "::: There are $updatesToInstall updates availible for your pi!"
+			echo "::: We recommend you run 'sudo apt-get upgrade' after installing Pi-Hole! "
+			echo ":::"
+		fi
     echo ":::"
     echo "::: Checking dependencies:"
 
@@ -373,8 +397,8 @@ checkForDependencies(){
 	done
 }
 
-getGitFiles(){
+getGitFiles() {
-  
+	# Setup git repos for base files and web admin
 	echo ":::"
 	echo "::: Checking for existing base files..."
 	if is_repo $piholeFilesDir; then
@@ -389,26 +413,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 $!
@@ -416,7 +436,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 $!
@@ -424,7 +444,8 @@ update_repo() {
 }
 
 
-CreateLogFile(){
+CreateLogFile() {
+	# Create logfiles if necessary
 	echo ":::"
 	$SUDO  echo -n "::: Creating log file and changing owner to dnsmasq..."
 	if [ ! -f /var/log/pihole.log ]; then
@@ -435,10 +456,10 @@ CreateLogFile(){
 	else
 		$SUDO  echo " already exists!"
 	fi
-	
 }
 
-installPiholeWeb(){
+installPiholeWeb() {
+	# Install the web interface
 	$SUDO echo ":::"
 	$SUDO echo -n "::: Installing pihole custom index page..."
 	if [ -d "/var/www/html/pihole" ]; then
@@ -449,17 +470,18 @@ installPiholeWeb(){
 		$SUDO cp /etc/.pihole/advanced/index.html /var/www/html/pihole/index.html
 		$SUDO echo " done!"
 	fi
-	
 }
 
-installCron(){
+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
 	$SUDO echo " done!"
 }
 
-runGravity(){
+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
@@ -471,14 +493,14 @@ runGravity(){
 	echo ":::"
 
 	/usr/local/bin/gravity.sh
-	
 }
 
 
-installPihole(){
+installPihole() {
+	# Install base files and web interface
 	checkForDependencies # done
 	stopServices
-	
+	$SUDO mkdir -p /etc/pihole/
 	$SUDO chown www-data:www-data /var/www/html
 	$SUDO chmod 775 /var/www/html
 	$SUDO usermod -a -G www-data pi
@@ -494,8 +516,9 @@ installPihole(){
 	runGravity
 }
 
-displayFinalMessage(){
+displayFinalMessage() {
-whiptail --msgbox --backtitle "Make it so." --title "Installation Complete!" "Configure your devices to use the Pi-hole as their DNS server using:
+	# 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
 $piholeIPv6
@@ -507,6 +530,7 @@ The install log is in /etc/pihole." $r $c
 
 ######## SCRIPT ############
 # Start the installer
+$SUDO mkdir -p /etc/pihole/
 welcomeDialogs
 
 # Just back up the original Pi-hole right away since it won't take long and it gets it out of the way
@@ -527,5 +551,6 @@ $SUDO mv $tmpLog $instalLogLoc
 
 displayFinalMessage
 
+# Start services
 $SUDO service dnsmasq start
 $SUDO service lighttpd start

gravity.sh

@@ -29,6 +29,9 @@ fi
 piholeIPfile=/tmp/piholeIP
 piholeIPv6file=/etc/pihole/.useIPv6
 
+adListFile=/etc/pihole/adlists.list
+adListDefault=/etc/pihole/adlists.default
+
 if [[ -f $piholeIPfile ]];then
     # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
     piholeIP=$(cat $piholeIPfile)
@@ -45,17 +48,8 @@ if [[ -f $piholeIPv6file ]];then
     piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
 fi
 
-# Ad-list sources--one per line in single quotes
+
-# The mahakala source is commented out due to many users having issues with it blocking legitimate domains.
+
-# Uncomment at your own risk
-sources=('https://adaway.org/hosts.txt'
-'http://adblock.gjtech.net/?format=unix-hosts'
-#'http://adblock.mahakala.is/'
-'http://hosts-file.net/ad_servers.txt'
-'http://www.malwaredomainlist.com/hostslist/hosts.txt'
-'http://pgl.yoyo.org/adservers/serverlist.php?'
-'http://someonewhocares.org/hosts/hosts'
-'http://winhelp2002.mvps.org/hosts.txt')
 
 # Variables for various stages of downloading and formatting the list
 basename=pihole
@@ -96,7 +90,26 @@ spinner(){
 ###########################
 # collapse - begin formation of pihole
 function gravity_collapse() {
-	echo -n "::: Neutrino emissions detected..."
+	echo "::: Neutrino emissions detected..."
+	echo ":::"
+	#Decide if we're using a custom ad block list, or defaults.
+	if [ -f $adListFile ]; then
+		#custom file found, use this instead of default
+		echo -n "::: Custom adList file detected. Reading..."
+		sources=()
+		while read -a line; do
+			sources+=($line)
+		done < $adListFile
+		echo " done!"	
+	else
+		#no custom file found, use defaults!
+		echo -n "::: No custom adlist file detected, reading from default file..."
+				sources=()
+		while read -a line; do
+			sources+=($line)
+		done < $adListDefault
+		echo " done!"	
+	fi	
 
 	# Create the pihole resource directory if it doesn't exist.  Future files will be stored here
 	if [[ -d $piholeDir ]];then
@@ -256,10 +269,15 @@ function gravity_hostFormat() {
 	echo "::: Formatting domains into a HOSTS file..."
   # If there is a value in the $piholeIPv6, then IPv6 will be used, so the awk command modified to create a line for both protocols
   if [[ -n $piholeIPv6 ]];then
-    cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' > $piholeDir/$accretionDisc
+  	#Add dummy domain Pi-Hole.IsWorking.OK to the top of gravity.list to make ping result return a friendlier looking domain!
+    echo -e "$piholeIP Pi-Hole.IsWorking.OK \n$piholeIPv6 Pi-Hole.IsWorking.OK" > $piholeDir/$accretionDisc
+    cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $piholeDir/$accretionDisc
+    
   else
       # Otherwise, just create gravity.list as normal using IPv4
-    cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' > $piholeDir/$accretionDisc
+      #Add dummy domain Pi-Hole.IsWorking.OK to the top of gravity.list to make ping result return a friendlier looking domain!
+    echo -e "$piholeIP Pi-Hole.IsWorking.OK" > $piholeDir/$accretionDisc
+    cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >> $piholeDir/$accretionDisc
   fi
 	# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
 	cp $piholeDir/$accretionDisc $adList
@@ -313,7 +331,7 @@ function gravity_reload() {
 	echo " done!"
 }
 
-
+$SUDO cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
 gravity_collapse
 gravity_spinup
 gravity_Schwarzchild

version.txt

@@ -0,0 +1 @@
+2.4