Merge pull request #515 from pi-hole/development

Next Release 2.7

README.md

@@ -20,7 +20,15 @@ chmod +x basic-install.sh
 Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) and then any device that connects to your network will have ads blocked without any further configuration.  Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
 
 ## Pi-hole Is Free, But Powered By Your Donations
-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "Free, but powered by donations")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
+Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the montly fee.
+
+| Paypal | Bitcoin | Optimal.com |
+| ------ | ------- | -------- |
+| [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "Free, but powered by donations")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate") |  <center> ![1hXEKGKExiPAQ7y5CFPwWiEXUXB6wDuqX](http://todobom.com/images/bitcoin-donations.png)<br />1hXEKGKExiPAQ7y5CFPwWiEXUXB6wDuqX</center> | Sign up for [Optimal.com using our link](http://api.optimal.com/partner/v1.0/bmV0d29ya3xkbnN8OlJhc3BiZXJyeSBQaS1Ib2xl/subscribe?redirect=https%3A%2F%2Fpi-hole.net%2Fthank-you%2F) to provide us with a small monthly amount.  Your money will also support content-creators.
+
+[![Support Pi-hole by using Optimal.com](http://i.imgur.com/m8GN3Zv.png)](http://api.optimal.com/partner/v1.0/bmV0d29ya3xkbnN8OlJhc3BiZXJyeSBQaS1Ib2xl/subscribe?redirect=https%3A%2F%2Fpi-hole.net%2Fthank-you%2F)
+![](http)
+
 
 ## Catch us out on the net:
 Twitter: [@The_Pi_Hole](https://twitter.com/The_Pi_Hole)
@@ -33,6 +41,7 @@ reddit: [/r/pihole](https://www.reddit.com/r/pihole/)
 [![Pi-hole exlplained](http://i.imgur.com/qNybJDX.png)](https://vimeo.com/135965232)
 
 ## Pi-hole Projects
+- [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
 - [Get LED alerts for each blocked ad](http://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
 - [Pi-hole on Ubuntu 14.04 on VirtualBox](http://hbalagtas.blogspot.com/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
 - [x86 Docker container that runs Pi-hole](https://hub.docker.com/r/diginc/pi-hole/)
@@ -61,7 +70,7 @@ reddit: [/r/pihole](https://www.reddit.com/r/pihole/)
 
 ## Partnering With Optimal.com
 
-Pi-hole will be teaming up with [Rob Leathern's subscription service to avoid ads](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d).  This service is unique and will help content-creators and publishers [still make money from visitors who are using an ad ablocker](http://techcrunch.com/2015/12/17/the-new-optimal/).
+Sign up for Optimal.com's service [using our link](http://api.optimal.com/partner/v1.0/bmV0d29ya3xkbnN8OlJhc3BiZXJyeSBQaS1Ib2xl/subscribe?redirect=https%3A%2F%2Fpi-hole.net%2Fthank-you%2F).  This service splits your money between your favorite ad blockers and free Websites.  This allows you to block ads while still supporting those sites that currently depend on ads for revenue.
 
 ## Technical Details
 

adlists.default

@@ -1,4 +1,4 @@
-## Pi-hole ad-list default sources. Updated 21/02/2016 #########################
+## Pi-hole ad-list default sources. Updated 22/05/2016 #########################
 #                                                                              #
 #  To make changes to this file:                                               #
 #    1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list`          #
@@ -32,7 +32,7 @@ http://hosts-file.net/ad_servers.txt
 #http://optimate.dl.sourceforge.net/project/adzhosts/HOSTS.txt
 
 # Windows 10 telemetry list
-#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/hostsBlockWindowsSpy.txt
+#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt
 
 # Securemecca.com list - Also blocks "adult" sites (pornography/gambling etc)
 #http://securemecca.com/Downloads/hosts.txt
@@ -48,3 +48,6 @@ https://raw.githubusercontent.com/quidsup/notrack/master/trackers.txt
 #https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt
 #http://spam404bl.com/spam404scamlist.txt
 #http://malwaredomains.lehigh.edu/files/domains.txt
+# Following two lists should be used simultaneously: (readme https://github.com/notracking/hosts-blocklists/)
+#https://raw.github.com/notracking/hosts-blocklists/master/hostnames.txt
+#https://raw.github.com/notracking/hosts-blocklists/master/domains.txt

advanced/Scripts/blacklist.sh

@@ -10,17 +10,39 @@
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
 
-if [[ $# = 0 ]]; then
+#rootcheck
+if [[ $EUID -eq 0 ]];then
+	echo "::: You are root."
+else
+	echo "::: sudo will be used."
+	# Check if it is actually installed
+	# If it isn't, exit because the install cannot complete
+	if [[ $(dpkg-query -s sudo) ]];then
+		export SUDO="sudo"
+	else
+		echo "::: Please install sudo or run this script as root."
+		exit 1
+	fi
+fi
+
+function helpFunc()
+{
 	echo "::: Immediately blacklists one or more domains in the hosts file"
 	echo ":::"
-    echo "::: Usage: sudo pihole.sh -b domain1 [domain2 ...]"
 	echo ":::"
+	echo "::: Usage: pihole -b domain1 [domain2 ...]"
 	echo "::: Options:"
 	echo ":::  -d, --delmode			Remove domains from the blacklist"
 	echo ":::  -nr, --noreload			Update blacklist without refreshing dnsmasq"
 	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
 	echo ":::  -q, --quiet				output is less verbose"
+	echo ":::  -h, --help				Show this help dialog"
+	echo ":::  -l, --list				Display your blacklisted domains"
 	exit 1
+}
+
+if [[ $# = 0 ]]; then
+	helpFunc
 fi
 
 #globals
@@ -31,17 +53,24 @@ blacklist=$piholeDir/blacklist.txt
 reload=true
 addmode=true
 force=false
-versbose=true
+verbose=true
 
 domList=()
 domToRemoveList=()
 
+piholeIPfile=/etc/pihole/piholeIP
 piholeIPv6file=/etc/pihole/.useIPv6
 
-# Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-piholeIP=${piholeIPCIDR%/*}
+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)
+    #rm $piholeIPfile
+else
+    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
+    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
+    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
+    piholeIP=${piholeIPCIDR%/*}
+fi
 
 modifyHost=false
 
@@ -57,7 +86,6 @@ 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
 
-
 function HandleOther(){
   #check validity of domain
 	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
@@ -88,14 +116,14 @@ function AddDomain(){
 	grep -Ex -q "$1" $blacklist || bool=true
 	if $bool; then
 	  #domain not found in the blacklist file, add it!
-	  if $versbose; then
+	  if $verbose; then
 	  echo -n "::: Adding $1 to blacklist file..."
 	  fi
 		echo "$1" >> $blacklist
 		modifyHost=true
 		echo " done!"
 	else
-	if $versbose; then
+	if $verbose; then
 		echo "::: $1 already exists in $blacklist! No need to add"
 		fi
 	fi
@@ -107,12 +135,12 @@ function RemoveDomain(){
   grep -Ex -q "$1" $blacklist || bool=true
   if $bool; then
   	#Domain is not in the blacklist file, no need to Remove
-  	if $versbose; then
+  	if $verbose; then
   	echo "::: $1 is NOT blacklisted! No need to remove"
   	fi
   else
     #Domain is in the blacklist file, add to a temporary array
-    if $versbose; then
+    if $verbose; then
     echo "::: Un-blacklisting $dom..."
     fi
     domToRemoveList=("${domToRemoveList[@]}" $1)
@@ -159,14 +187,25 @@ function Reload() {
 
 	if [[ $dnsmasqPid ]]; then
 		# service already running - reload config
-		sudo kill -HUP "$dnsmasqPid"
+		$SUDO killall -s HUP dnsmasq
 	else
 		# service not running, start it up
-		sudo service dnsmasq start
+		$SUDO service dnsmasq start
 	fi
 	echo " done!"
 }
 
+function DisplayBlist() {
+	verbose=false
+	echo -e " Displaying Gravity Affected Domains \n"
+	count=1
+	while IFS= read -r AD
+	do
+		echo "${count}: $AD"
+		count=$((count+1))
+	done < "$blacklist"
+}
+
 ###################################################
 
 for var in "$@"
@@ -175,7 +214,9 @@ do
     "-nr"| "--noreload"  ) reload=false;;
     "-d" | "--delmode"   ) addmode=false;;
     "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) versbose=false;;  			
+    "-q" | "--quiet"     ) verbose=false;;
+    "-h" | "--help"	     ) helpFunc;;
+    "-l" | "--list"      ) DisplayBlist;;
     *                    ) HandleOther "$var";;
   esac
 done
@@ -185,7 +226,7 @@ PopBlacklistFile
 if $modifyHost || $force; then
 	ModifyHostFile
 else
-  if $versbose; then
+  if $verbose; then
 		echo "::: No changes need to be made"
 	fi
 	exit 1

advanced/Scripts/chronometer.sh

@@ -84,7 +84,11 @@ function normalChrono(){
 	do
 		clear
 		# Displays a colorful Pi-hole logo
-		toilet -f small -F gay Pi-hole
+		echo " ___ _     _        _"
+		echo "| _ (_)___| |_  ___| |___"
+		echo "|  _/ |___| ' \/ _ \ / -_)"
+		echo "|_| |_|   |_||_\___/_\___|"
+		echo ""
 		echo "        $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)"
 		echo ""
 		uptime | cut -d' ' -f11-
@@ -120,7 +124,7 @@ function normalChrono(){
 function displayHelp(){
  	echo "::: Displays stats about your piHole!"
     echo ":::"
-    echo "::: Usage: sudo pihole.sh -c [optional:-j]"
+    echo "::: Usage: sudo pihole -c [optional:-j]"
     echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
     echo ":::"
     echo "::: Options:"

advanced/Scripts/piholeDebug.sh

@@ -19,6 +19,7 @@ DEBUG_LOG="/var/log/pihole_debug.log"
 DNSMASQFILE="/etc/dnsmasq.conf"
 PIHOLECONFFILE="/etc/dnsmasq.d/01-pihole.conf"
 LIGHTTPDFILE="/etc/lighttpd/lighttpd.conf"
+LIGHTTPDERRFILE="/var/log/lighttpd/error.log"
 GRAVITYFILE="/etc/pihole/gravity.list"
 HOSTSFILE="/etc/hosts"
 WHITELISTFILE="/etc/pihole/whitelist.txt"
@@ -53,6 +54,19 @@ else
 fi
 
 ### Private functions exist here ###
+function versionCheck {
+	echo "#######################################" >> $DEBUG_LOG
+	echo "########## Versions Section ###########" >> $DEBUG_LOG
+	echo "#######################################" >> $DEBUG_LOG
+	
+	TMP=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+	echo "Pi-hole Version: $TMP" >> $DEBUG_LOG
+	
+	TMP=$(cd /var/www/html/admin && git describe --tags --abbrev=0)
+	echo "WebUI Version: $TMP" >> $DEBUG_LOG
+	echo >> $DEBUG_LOG
+}
+
 function compareWhitelist {
 	if [ ! -f "$WHITELISTMATCHES" ]; then
 		$SUDO touch $WHITELISTMATCHES
@@ -126,12 +140,44 @@ function checkProcesses {
 	for i in "${PROCESSES[@]}"
 	do
 		echo "" >> $DEBUG_LOG
-		echo -n $i >> "$DEBUG_LOG"
+		echo -n "$i" >> "$DEBUG_LOG"
 		echo " processes status:" >> $DEBUG_LOG
-		$SUDO systemctl -l status $i >> "$DEBUG_LOG"
+		$SUDO systemctl -l status "$i" >> "$DEBUG_LOG"
 	done
 }
 
+function debugLighttpd {
+	echo "::: Writing lighttpd to debug log..."
+	echo "#######################################" >> $DEBUG_LOG
+	echo "############ lighttpd.conf ############" >> $DEBUG_LOG
+	echo "#######################################" >> $DEBUG_LOG
+	if [ -e "$LIGHTTPDFILE" ]
+	then
+		while read -r line; do
+			if [ ! -z "$line" ]; then
+				[[ "$line" =~ ^#.*$ ]] && continue
+				echo "$line" >> $DEBUG_LOG
+			fi
+		done < "$LIGHTTPDFILE"
+		echo >> $DEBUG_LOG
+	else
+		echo "No lighttpd.conf file found!" >> $DEBUG_LOG
+		printf ":::\tNo lighttpd.conf file found\n"
+	fi
+	
+	if [ -e "$LIGHTTPDERRFILE" ]
+	then
+		echo "#######################################" >> $DEBUG_LOG
+		echo "######### lighttpd error.log ##########" >> $DEBUG_LOG
+		echo "#######################################" >> $DEBUG_LOG
+		cat "$LIGHTTPDERRFILE" >> $DEBUG_LOG
+	else
+		echo "No lighttpd error.log file found!" >> $DEBUG_LOG
+		printf ":::\tNo lighttpd error.log file found\n"
+	fi
+	echo >> $DEBUG_LOG
+}
+
 ### END FUNCTIONS ###
 
 ### Check Pi internet connections ###
@@ -148,10 +194,12 @@ echo "Gateway check:" >> $DEBUG_LOG
 echo "$GATEWAY_CHECK" >> $DEBUG_LOG
 echo >> $DEBUG_LOG
 
+versionCheck
 compareWhitelist
 compareBlacklist
 testNslookup
 checkProcesses
+debugLighttpd
 
 echo "::: Writing dnsmasq.conf to debug log..."
 echo "#######################################" >> $DEBUG_LOG
@@ -178,7 +226,6 @@ echo "########### 01-pihole.conf ############" >> $DEBUG_LOG
 echo "#######################################" >> $DEBUG_LOG
 if [ -e "$PIHOLECONFFILE" ]
 then
-	#cat "$PIHOLECONFFILE" >> $DEBUG_LOG
 	while read -r line; do
 		if [ ! -z "$line" ]; then
 			[[ "$line" =~ ^#.*$ ]] && continue
@@ -191,25 +238,6 @@ else
 	printf ":::\tNo 01-pihole.conf file found\n"
 fi
 
-echo "::: Writing lighttpd.conf to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############ lighttpd.conf ############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$LIGHTTPDFILE" ]
-then
-	#cat "$PIHOLECONFFILE" >> $DEBUG_LOG
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			[[ "$line" =~ ^#.*$ ]] && continue
-			echo "$line" >> $DEBUG_LOG
-        fi
-	done < "$LIGHTTPDFILE"
-	echo >> $DEBUG_LOG
-else
-	echo "No lighttpd.conf file found!" >> $DEBUG_LOG
-	printf ":::\tNo lighttpd.conf file found\n"
-fi
-
 echo "::: Writing size of gravity.list to debug log..."
 echo "#######################################" >> $DEBUG_LOG
 echo "############ gravity.list #############" >> $DEBUG_LOG
@@ -283,7 +311,7 @@ fi
 
 # Continuously append the pihole.log file to the pihole_debug.log file
 function dumpPiHoleLog {
-	trap '{ echo -e "\nFinishing debug write from interrupt... Quitting!" ; exit 1; }' INT
+	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
 	echo -e "::: Writing current pihole traffic to debug log...\n:::\tTry loading any/all sites that you are having trouble with now... \n:::\t(Press ctrl+C to finish)"
 	echo "#######################################" >> $DEBUG_LOG
 	echo "############# pihole.log ##############" >> $DEBUG_LOG
@@ -303,6 +331,7 @@ function dumpPiHoleLog {
 # Anything to be done after capturing of pihole.log terminates
 function finalWork {
 	echo "::: Finshed debugging!" 
+	echo "::: Debug log can be found at : /var/log/pihole_debug.log"
 }
 trap finalWork EXIT
 

advanced/Scripts/whitelist.sh

@@ -10,17 +10,39 @@
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
 
-if [[ $# = 0 ]]; then
+#rootcheck
+if [[ $EUID -eq 0 ]];then
+	echo "::: You are root."
+else
+	echo "::: sudo will be used."
+	# Check if it is actually installed
+	# If it isn't, exit because the install cannot complete
+	if [[ $(dpkg-query -s sudo) ]];then
+		export SUDO="sudo"
+	else
+		echo "::: Please install sudo or run this script as root."
+		exit 1
+	fi
+fi
+
+function helpFunc()
+{
 	echo "::: Immediately whitelists one or more domains in the hosts file"
 	echo ":::"
-    echo "::: Usage: sudo pihole.sh -w domain1 [domain2 ...]"
+	echo "::: Usage: pihole -w domain1 [domain2 ...]"
 	echo ":::"
 	echo "::: Options:"
 	echo ":::  -d, --delmode			Remove domains from the whitelist"
 	echo ":::  -nr, --noreload			Update Whitelist without refreshing dnsmasq"
 	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
 	echo ":::  -q, --quiet				output is less verbose"
+	echo ":::  -h, --help				Show this help dialog"
+	echo ":::  -l, --list				Display your whitelisted domains"
 	exit 1
+}
+
+if [[ $# = 0 ]]; then
+	helpFunc
 fi
 
 #globals
@@ -31,17 +53,24 @@ whitelist=$piholeDir/whitelist.txt
 reload=true
 addmode=true
 force=false
-versbose=true
+verbose=true
 
 domList=()
 domToRemoveList=()
 
+piholeIPfile=/etc/pihole/piholeIP
 piholeIPv6file=/etc/pihole/.useIPv6
 
-# Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-piholeIP=${piholeIPCIDR%/*}
+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)
+    #rm $piholeIPfile
+else
+    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
+    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
+    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
+    piholeIP=${piholeIPCIDR%/*}
+fi
 
 modifyHost=false
 
@@ -56,7 +85,6 @@ 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
 
-
 function HandleOther(){
   #check validity of domain
 	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
@@ -89,16 +117,16 @@ function AddDomain(){
 	grep -Ex -q "$1" $whitelist || bool=true
 	if $bool; then
 	  #domain not found in the whitelist file, add it!
-	  if $versbose; then
+	  if $verbose; then
 		echo -n "::: Adding $1 to $whitelist..."
 	  fi
 	  echo "$1" >> $whitelist
 		modifyHost=true
-		if $versbose; then
+		if $verbose; then
 	  	echo " done!"
 	  fi
 	else
-		if $versbose; then
+		if $verbose; then
 			echo "::: $1 already exists in $whitelist, no need to add!"
 		fi
 	fi
@@ -110,12 +138,12 @@ function RemoveDomain(){
   grep -Ex -q "$1" $whitelist || bool=true
   if $bool; then
   	#Domain is not in the whitelist file, no need to Remove
-  	if $versbose; then
+  	if $verbose; then
   	echo "::: $1 is NOT whitelisted! No need to remove"
   	fi
   else
     #Domain is in the whitelist file, add to a temporary array and remove from whitelist file
-    #if $versbose; then
+    #if $verbose; then
     #echo "::: Un-whitelisting $dom..."
     #fi
     domToRemoveList=("${domToRemoveList[@]}" $1)
@@ -172,14 +200,25 @@ function Reload() {
 
 	if [[ $dnsmasqPid ]]; then
 		# service already running - reload config
-		sudo kill -HUP "$dnsmasqPid"
+		$SUDO killall -s HUP dnsmasq
 	else
 		# service not running, start it up
-		sudo service dnsmasq start
+		$SUDO service dnsmasq start
 	fi
 	echo " done!"
 }
 
+function DisplayWlist() {
+	verbose=false
+	echo -e " Displaying Gravity Resistant Domains \n"
+	count=1
+	while IFS= read -r RD
+	do
+		echo "${count}: $RD"
+		count=$((count+1))
+	done < "$whitelist"
+}
+
 ###################################################
 
 for var in "$@"
@@ -188,7 +227,9 @@ do
     "-nr"| "--noreload"  ) reload=false;;
     "-d" | "--delmode"   ) addmode=false;;
     "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) versbose=false;;  			
+    "-q" | "--quiet"     ) verbose=false;;
+    "-h" | "--help"      ) helpFunc;;
+    "-l" | "--list"      ) DisplayWlist;;
     *                    ) HandleOther "$var";;
   esac
 done
@@ -198,11 +239,11 @@ PopWhitelistFile
 if $modifyHost || $force; then
 	 ModifyHostFile
 else
-  if $versbose; then
+  if $verbose; then
 	  echo ":::"
 		echo "::: No changes need to be made"
-	exit 1
 	fi
+	exit 1
 fi
 
 if $reload; then

advanced/lighttpd.conf

@@ -46,7 +46,10 @@ include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 # If the URL starts with /admin, it is the Web interface
 $HTTP["url"] =~ "^/admin/" {
 	# Create a response header for debugging using curl -I
-	setenv.add-response-header = ( "X-Pi-hole" => "The Pi-hole Web interface is working!" )
+    setenv.add-response-header = (
+        "X-Pi-hole" => "The Pi-hole Web interface is working!",
+        "X-Frame-Options" => "DENY"
+    )
 }
 
 # If the URL does not start with /admin, then it is a query for an ad domain

advanced/pihole.cron

@@ -11,16 +11,16 @@
 
 # Pi-hole: Update the ad sources once a week on Sunday at 01:59
 #          Download any updates from the adlists
-59 1    * * 7   root    /usr/local/bin/gravity.sh
+59 1    * * 7   root    /usr/local/bin/pihole updateGravity
 
 # Pi-hole: Update the Web interface shortly after gravity runs
 #          This should also update the version number if it is changed in the dashboard repo
-30 2    * * 7   root    /usr/local/bin/updateDashboard.sh
+30 2    * * 7   root    /usr/local/bin/pihole updateDashboard
 
 # Pi-hole: Parse the log file before it is flushed and save the stats to a database
 #          This will be used for a historical view of your Pi-hole's performance
-#50 23  * * *   root    /usr/local/bin/dailyLog.sh
+#50 23  * * *   root    /usr/local/bin/dailyLog.sh # note: this is outdated
 
 # Pi-hole: Flush the log daily at 11:58 so it doesn't get out of control
 #          Stats will be viewable in the Web interface thanks to the cron job above
-58 23   * * *   root    /usr/local/bin/piholeLogFlush.sh
+58 23   * * *   root    /usr/local/bin/pihole flush

advanced/pihole.sudo

@@ -0,0 +1,12 @@
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2015, 2016 by Jacob Salmela
+# Network-wide ad blocking via your Raspberry Pi
+# http://pi-hole.net
+# Allows the WebUI to use Pi-hole commands
+#
+# Pi-hole is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+
+www-data ALL=NOPASSWD: /usr/local/bin/pihole

automated install/basic-install.sh

@@ -43,7 +43,7 @@ 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}')
 
-availableInterfaces=$(ip -o link | awk '{print $2}' | grep -v "lo" | cut -d':' -f1)
+availableInterfaces=$(ip -o link | awk '{print $2}' | grep -v "lo" | cut -d':' -f1 | cut -d'@' -f1)
 dhcpcdFile=/etc/dhcpcd.conf
 
 ######## FIRST CHECK ########
@@ -58,7 +58,7 @@ else
 	if [[ $(dpkg-query -s sudo) ]];then
 		export SUDO="sudo"
 	else
-		echo "::: Please install sudo or run this as root."
+		echo "::: sudo is needed for the Web interface to run pihole commands.  Please run this script as root and it will be automatically installed."
 		exit 1
 	fi
 fi
@@ -110,7 +110,8 @@ welcomeDialogs() {
 
 	# Explain the need for a static address
 	whiptail --msgbox --backtitle "Initating network interface" --title "Static IP Needed" "The Pi-hole is a SERVER so it needs a STATIC IP ADDRESS to function properly.
-	In the next section, you can choose to use your current network settings (DHCP) or to manually edit them." $r $c
+
+In the next section, you can choose to use your current network settings (DHCP) or to manually edit them." $r $c
 }
 
 
@@ -174,7 +175,7 @@ cleanupIPv6() {
 
 use4andor6() {
 	# Let use select IPv4 and/or IPv6
-	cmd=(whiptail --separate-output --checklist "Select Protocols" $r $c 2)
+	cmd=(whiptail --separate-output --checklist "Select Protocols (press space to select)" $r $c 2)
 	options=(IPv4 "Block ads over IPv4" on
 	IPv6 "Block ads over IPv6" off)
 	choices=$("${cmd[@]}" "${options[@]}" 2>&1 >/dev/tty)
@@ -232,8 +233,10 @@ getStaticIPv4Settings() {
 					Gateway:       $IPv4gw" $r $c) then
 		# 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.
-		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
+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
+		#piholeIP is saved to a permanent file so gravity.sh can use it when updating
+		echo "${IPv4addr%/*}" > /etc/pihole/piholeIP
 		# Nothing else to do since the variables are already set above
 	else
 		# Otherwise, we need to ask the user to input their desired settings.
@@ -254,8 +257,8 @@ getStaticIPv4Settings() {
 					IP address:    $IPv4addr
 					Gateway:       $IPv4gw" $r $c)then
 					# If the settings are correct, then we need to set the piholeIP
-					# Saving it to a temporary file us to retrieve it later when we run the gravity.sh script
-					echo "${IPv4addr%/*}" > /tmp/piholeIP
+					# Saving it to a temporary file us to retrieve it later when we run the gravity.sh script. piholeIP is saved to a permanent file so gravity.sh can use it when updating
+					echo "${IPv4addr%/*}" > /etc/pihole/piholeIP
 					echo "$piholeInterface" > /tmp/piholeINT
 					# After that's done, the loop ends and we move on
 					ipSettingsCorrect=True
@@ -545,7 +548,7 @@ checkForDependencies() {
     echo ":::"
     echo "::: Checking dependencies:"
 
-  dependencies=( dnsutils bc toilet figlet dnsmasq lighttpd php5-common php5-cgi php5 git curl unzip wget )
+  dependencies=( dnsutils bc dnsmasq lighttpd php5-common php5-cgi php5 git curl unzip wget sudo)
 	for i in "${dependencies[@]}"; do
 		echo -n ":::    Checking for $i..."
 		if [ "$(dpkg-query -W -f='${Status}' "$i" 2>/dev/null | grep -c "ok installed")" -eq 0 ]; then
@@ -635,6 +638,12 @@ installPiholeWeb() {
 		$SUDO cp /etc/.pihole/advanced/index.* /var/www/html/pihole/.
 		$SUDO echo " done!"
 	fi
+	# Install Sudoer file
+	echo -n "::: Installing sudoer file..."
+	$SUDO mkdir -p /etc/sudoers.d/
+	$SUDO cp /etc/.pihole/advanced/pihole.sudo /etc/sudoers.d/pihole
+	$SUDO chmod 0440 /etc/sudoers.d/pihole
+	echo " done!"
 }
 
 installCron() {
@@ -695,12 +704,13 @@ 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
-	$piholeIPv6
+IPv4:	${IPv4addr%/*}
+IPv6:	$piholeIPv6
 
-	If you set a new IP address, you should restart the Pi.
+If you set a new IP address, you should restart the Pi.
 
-	The install log is in /etc/pihole." $r $c
+The install log is in /etc/pihole.
+View the web interface at http://pi.hole/admin or http://${IPv4addr%/*}/admin" $r $c
 }
 
 ######## SCRIPT ############
@@ -737,10 +747,10 @@ echo " done."
 
 echo ":::"
 echo "::: Installation Complete! Configure your devices to use the Pi-hole as their DNS server using:"
-echo ":::     $IPv4addr"
+echo ":::     ${IPv4addr%/*}"
 echo ":::     $piholeIPv6"
 echo ":::"
 echo "::: If you set a new IP address, you should restart the Pi."
-echo "::: "
+echo ":::"
 echo "::: The install log is located at: /etc/pihole/install.log"
-
+echo "::: View the web interface at http://pi.hole/admin or http://${IPv4addr%/*}/admin"

automated install/uninstall.sh

@@ -44,7 +44,7 @@ function removeAndPurge {
 	# Purge dependencies
 echo ":::"
 	# Nate 3/28/2016 - Removed `php5-cgi` and `php5` as they are removed with php5-common
-	dependencies=( dnsutils bc toilet figlet dnsmasq lighttpd php5-common git curl unzip wget )
+	dependencies=( dnsutils bc dnsmasq lighttpd php5-common git curl unzip wget )
 	for i in "${dependencies[@]}"; do
 		if [ "$(dpkg-query -W --showformat='${Status}\n' "$i" 2> /dev/null | grep -c "ok installed")" -eq 1 ]; then
 			while true; do
@@ -122,7 +122,8 @@ function removeNoPurge {
 	$SUDO rm -rf /etc/.pihole/ &> /dev/null
 	$SUDO rm -rf /opt/pihole/ &> /dev/null
 	$SUDO rm /usr/local/bin/pihole &> /dev/null
-	$SUDO rm /etc/bash_completion.d/pihole
+	$SUDO rm /etc/bash_completion.d/pihole &> /dev/null
+	$SUDO rm /etc/sudoers.d/pihole &> /dev/null
 
 	echo ":::"
 	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"

gravity.sh

@@ -12,6 +12,7 @@
 
 # Run this script as root or under sudo
 echo ":::"
+
 if [[ $EUID -eq 0 ]];then
 	echo "::: You are root."
 else
@@ -26,7 +27,7 @@ else
 	fi
 fi
 
-piholeIPfile=/tmp/piholeIP
+piholeIPfile=/etc/pihole/piholeIP
 piholeIPv6file=/etc/pihole/.useIPv6
 
 adListFile=/etc/pihole/adlists.list
@@ -37,7 +38,7 @@ blacklistScript=/opt/pihole/blacklist.sh
 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)
-    rm $piholeIPfile
+    #rm $piholeIPfile
 else
     # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
     IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
@@ -71,20 +72,6 @@ if [[ -r $piholeDir/pihole.conf ]];then
         . $piholeDir/pihole.conf
 fi
 
-spinner() {
-    local pid=$1
-    local delay=0.50
-    local spinstr='/-|'
-    while [ "$(ps a | awk '{print $1}' | grep "$pid")" ]; do
-        local temp=${spinstr#?}
-        printf " [%c]  " "$spinstr"
-        local spinstr=$temp${spinstr%"$temp"}
-        sleep $delay
-        printf "\b\b\b\b\b\b"
-    done
-    printf "    \b\b\b\b"
-}
-
 ###########################
 # collapse - begin formation of pihole
 function gravity_collapse() {
@@ -214,7 +201,7 @@ function gravity_Schwarzchild() {
 	echo "::: "
 	# Find all active domains and compile them into one file and remove CRs
 	echo -n "::: Aggregating list of domains..."
-	truncate -s 0 $piholeDir/$matterandlight & spinner $!
+	truncate -s 0 $piholeDir/$matterandlight
 	for i in "${activeDomains[@]}"
 	do
 		cat "$i" | tr -d '\r' >> $piholeDir/$matterandlight
@@ -225,7 +212,7 @@ function gravity_Schwarzchild() {
 function gravity_Blacklist(){
 	# Append blacklist entries if they exist
 	echo -n "::: Running blacklist script to update HOSTS file...."
-	$blacklistScript -f -nr -q > /dev/null & spinner $!
+	$blacklistScript -f -nr -q > /dev/null
 
 	numBlacklisted=$(wc -l < "/etc/pihole/blacklist.txt")
 	plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
@@ -247,7 +234,7 @@ function gravity_Whitelist() {
 	echo " done!"
 
 	echo -n "::: Running whitelist script to update HOSTS file...."
-	$whitelistScript -f -nr -q "${urls[@]}" > /dev/null & spinner $!
+	$whitelistScript -f -nr -q "${urls[@]}" > /dev/null
 	numWhitelisted=$(wc -l < "/etc/pihole/whitelist.txt")
 	plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
 	echo " $numWhitelisted domain${plural} whitelisted!"
@@ -256,7 +243,7 @@ function gravity_Whitelist() {
 function gravity_unique() {
 	# Sort and remove duplicates
 	echo -n "::: Removing duplicate domains...."
-	sort -u  $piholeDir/$supernova > $piholeDir/$eventHorizon  & spinner $!
+	sort -u  $piholeDir/$supernova > $piholeDir/$eventHorizon
 	echo " done!"
 	numberOf=$(wc -l < $piholeDir/$eventHorizon)
 	echo "::: $numberOf unique domains trapped in the event horizon."
@@ -302,7 +289,7 @@ function gravity_advanced() {
 	# This helps with that and makes it easier to read
 	# It also helps with debugging so each stage of the script can be researched more in depth
 	echo -n "::: Formatting list of domains to remove comments...."
-	awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' $piholeDir/$matterandlight | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  $piholeDir/$supernova & spinner $!
+	awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' $piholeDir/$matterandlight | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  $piholeDir/$supernova
 	echo " done!"
 
 	numberOf=$(wc -l < $piholeDir/$supernova)
@@ -329,14 +316,14 @@ function gravity_reload() {
 	$SUDO sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
 	dnsmasqPid=$(pidof dnsmasq)
 
-    find "$piholeDir" -type f -exec $SUDO chmod 666 {} \; & spinner $!
+    find "$piholeDir" -type f -exec $SUDO chmod 666 {} \;
 
 	if [[ $dnsmasqPid ]]; then
 		# service already running - reload config
-		$SUDO kill -HUP "$dnsmasqPid" & spinner $!
+		$SUDO killall -s HUP dnsmasq
 	else
 		# service not running, start it up
-		$SUDO service dnsmasq start & spinner $!
+		$SUDO service dnsmasq start
 	fi
 	echo " done!"
 }

pihole

@@ -11,10 +11,10 @@
 # (at your option) any later version.
 
 # Must be root to use this tool
-if [[ $EUID -eq 0 ]];then
-	echo "::: You are root."
-else
-	echo "::: Sudo will be used for this tool."
+if [[ ! $EUID -eq 0 ]];then
+	#echo "::: You are root."
+#else
+	#echo "::: Sudo will be used for this tool."
   # Check if it is actually installed
   # If it isn't, exit because the pihole cannot be invoked without privileges.
   if [[ $(dpkg-query -s sudo) ]];then
@@ -63,7 +63,8 @@ function setupLCDFunction {
 }
 
 function chronometerFunc {
-	$SUDO /opt/pihole/chronometer.sh
+	shift
+	$SUDO /opt/pihole/chronometer.sh "$@"
 	exit 1
 }
 
@@ -76,8 +77,8 @@ function uninstallFunc {
 function helpFunc {
 	echo "::: Control all PiHole specific functions!"
 	echo ":::"
-    echo "::: Usage: pihole.sh [options]"
-    printf ":::\tAdd -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage\n"
+	echo "::: Usage: pihole [options]"
+	echo ":::		Add -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage"
 	echo ":::"
 	echo "::: Options:"
 	echo ":::  -w, whitelist			Whitelist domains"
@@ -106,7 +107,7 @@ case "$1" in
 "-u" | "updateDashboard"	) updateDashboardFunc;;
 "-g" | "updateGravity"		) updateGravityFunc;;
 "-s" | "setupLCD"			) setupLCDFunction;;
-"-c" | "chronometer"		) chronometerFunc;;
+"-c" | "chronometer"		) chronometerFunc "$@";;
 "-h" | "help"				) helpFunc;;
 "uninstall"					) uninstallFunc;;
 *                    		) helpFunc;;