Once installed, **configure any device to use the Raspberry Pi as its DNS server and the ads will be blocked**. You can also configure your router's DHCP options to assign the Pi as clients DNS server so they do not need to do it manually.
@ -62,5 +63,6 @@ This script will work for other UNIX-like systems with some slight **modificatio
### Examples Of The Pi-hole On Other Operating Systems
- [Sky-Hole](http://dlaa.me/blog/post/skyhole)
- [Pi-hole in the Cloud!](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/)
@ -36,58 +52,254 @@ if [[ -f /etc/dnsmasq.d/adList.conf ]];then
else
:
fi
}
echo"Updating the Pi..."
sudo apt-get update
sudo apt-get -y upgrade
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
echo"Installing tools..."
sudo apt-get -y install dnsutils
sudo apt-get -y install bc
sudo apt-get -y install toilet
# 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.
echo"Installing DNS..."
sudo apt-get -y install dnsmasq
sudo update-rc.d dnsmasq enable
In the next section, you can choose to use your current network settings (DHCP) or to manually edit them."$r$c
whiptail --msgbox --backtitle "Coming soon..." --title "IPv6 not yet supported""I need your help for IPv6. Consider donating at: http://pi-hole.net/donate"$r$c
}
getStaticIPv4Settings()
{
# Ask if the user wannts 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
# 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
# Nothing else to do since the variables are already set above
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
# Just back up the original Pi-hole right away since it won't take long and it gets it out of the way
backupLegacyPihole
# Find interfaces and let the user choose one
chooseInterface
# Let the user decide if they want to block ads over IPv4 and/or IPv6
use4andor6
# Decide is IPv4 will be used
if[["$useIPv4"=true]];then
echo"Using IPv4"
getStaticIPv4Settings
setStaticIPv4
else
useIPv4=false
echo"IPv4 will NOT be used."
fi
# Decide is IPv6 will be used
if[["$useIPv6"=true]];then
# If only IPv6 is selected, exit because it is not supported yet
if[["$useIPv6"=true]]&&[["$useIPv4"=false]];then
useIPv6dialog
exit
else
useIPv6dialog
fi
else
useIPv6=false
echo"IPv6 will NOT be used. Consider a donation at pi-hole.net/donate"
fi
# Install and log everything to a file
installPihole | tee $tmpLog
# Move the log file into /etc/pihole for storage
sudo mv $tmpLog$instalLogLoc
whiptail --msgbox --backtitle "Make it so." --title "Installation Complete!""Configure your devices to use the Pi-hole as their DNS server using this IP: $IPv4addr.
If you set a new IP address, it should work fine, but you may want to reboot the Pi at some point.
# Compiles a list of ad-serving domains by downloading them from multiple sources
piholeIPfile=/tmp/piholeIP
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
@ -11,11 +12,14 @@ if [[ -f $piholeIPfile ]];then
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
piholeIP=$(ip -4 addr show | awk '{match($0,/[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/); ip = substr($0,RSTART,RLENGTH); print ip}'| sed '/^\s*$/d'| grep -v "127.0.0.1"|(head -n1))
IPv4dev=$(ip route get 8.8.8.8 | awk '{print $5}')
piholeIPCIDR=$(ip -o -f inet addr show dev $IPv4dev| awk '{print $4}')
piholeIP=${piholeIPCIDR%/*}
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
# 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/'
@ -45,68 +49,70 @@ if [[ -r $piholeDir/pihole.conf ]];then
echo"** Local calibration requested..."
. $piholeDir/pihole.conf
fi
###########################
# collapse - begin formation of pihole
function gravity_collapse(){
echo"** Neutrino emissions detected..."
echo"** Neutrino emissions detected..."
# Create the pihole resource directory if it doesn't exist. Future files will be stored here
if[[ -d $piholeDir]];then
# Create the pihole resource directory if it doesn't exist. Future files will be stored here
if[[ -d $piholeDir]];then
# Temporary hack to allow non-root access to pihole directory
# Will update later, needed for existing installs, new installs should
# create this directory as non-root
sudo chmod 777$piholeDir
find "$piholeDir" -type f -exec sudo chmod 666{}\;
else
else
echo"** Creating pihole directory..."
mkdir $piholeDir
fi
fi
}
# patternCheck - check to see if curl downloaded any new files, and then process those
# files so they are in host format.
# patternCheck - check to see if curl downloaded any new files.
function gravity_patternCheck(){
patternBuffer=$1
# check if the patternbuffer is a non-zero length file
if[[ -s "$patternBuffer"]];then
# Some of the blocklists are copyright, they need to be downloaded
# and stored as is. They can be processed for content after they
# have been saved.
cp $patternBuffer$saveLocation
echo"Done."
else
# curl didn't download any host files, probably because of the date check
echo"Transporter logic detected no changes, pattern skipped..."
fi
patternBuffer=$1
# check if the patternbuffer is a non-zero length file
if[[ -s "$patternBuffer"]];then
# Some of the blocklists are copyright, they need to be downloaded
# and stored as is. They can be processed for content after they
# have been saved.
cp $patternBuffer$saveLocation
echo"List updated, transport successful..."
else
# curl didn't download any host files, probably because of the date check
echo"No changes detected, transport skipped..."
fi
}
# transport - curl the specified url with any needed command extentions, then patternCheck
# transport - curl the specified url with any needed command extentions
function gravity_transport(){
url=$1
cmd_ext=$2
agent=$3
# tmp file, so we don't have to store the (long!) lists in RAM
patternBuffer=$(mktemp)
heisenbergCompensator=""
if[[ -r $saveLocation]];then
# if domain has been saved, add file for date check to only download newer
heisenbergCompensator="-z $saveLocation"
fi
# Silently curl url
curl -s $cmd_ext$heisenbergCompensator -A "$agent"$url > $patternBuffer
gravity_patternCheck $patternBuffer
# Cleanup
rm -f $patternBuffer
url=$1
cmd_ext=$2
agent=$3
# tmp file, so we don't have to store the (long!) lists in RAM
patternBuffer=$(mktemp)
heisenbergCompensator=""
if[[ -r $saveLocation]];then
# if domain has been saved, add file for date check to only download newer
heisenbergCompensator="-z $saveLocation"
fi
# Silently curl url
curl -s $cmd_ext$heisenbergCompensator -A "$agent"$url > $patternBuffer
# Check for list updates
gravity_patternCheck $patternBuffer
# Cleanup
rm -f $patternBuffer
}
# spinup - main gravity function
function gravity_spinup(){
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and blank lines
for((i= 0; i < "${#sources[@]}"; i++))
do
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines
for((i= 0; i < "${#sources[@]}"; i++))
do
url=${sources[$i]}
# Get just the domain from the URL
domain=$(echo"$url"| cut -d'/' -f3)
@ -117,7 +123,7 @@ do
agent="Mozilla/10.0"
echo -n "Getting $domain list..."
echo -n " Getting $domain list:"
# Use a case statement to download lists that need special cURL commands
# to complete properly and reset the user agent when required
@ -134,33 +140,34 @@ do
# Default is a simple request
*)cmd_ext=""
esac
gravity_transport $url$cmd_ext$agent
done
gravity_transport $url$cmd_ext$agent
done
}
# Schwarzchild - aggregate domains to one list and add blacklisted domains
function gravity_Schwarzchild(){
# Find all active domains and compile them into one file and remove CRs
echo"** Aggregating list of domains..."
truncate -s 0$piholeDir/$matter
for i in "${activeDomains[@]}"
do
cat $i|tr -d '\r' >> $piholeDir/$matter
done
# Find all active domains and compile them into one file and remove CRs
echo"** Aggregating list of domains..."
truncate -s 0$piholeDir/$matter
for i in "${activeDomains[@]}"
do
cat $i|tr -d '\r' >> $piholeDir/$matter
done
}
# Append blacklist entries if they exist
if[[ -r $blacklist]];then
# Pulsar - White/blacklist application
function gravity_pulsar(){
# Append blacklist entries if they exist
if[[ -r $blacklist]];then
numberOf=$(cat $blacklist| sed '/^\s*$/d'| wc -l)
echo"** Blacklisting $numberOf domain(s)..."
cat $blacklist >> $piholeDir/$matter
fi
}
fi
function gravity_pulsar(){
# Whitelist (if applicable) domains
if[[ -r $whitelist]];then
# Whitelist (if applicable) domains
if[[ -r $whitelist]];then
# Remove whitelist entries
numberOf=$(cat $whitelist| sed '/^\s*$/d'| wc -l)
plural=;[["$numberOf" !="1"]]&&plural=s
@ -170,49 +177,65 @@ if [[ -r $whitelist ]];then
# replace "." with "\." of each line to turn each entry into a
# regexp so it can be parsed out with grep -x
awk -F '[# \t]''NF>0&&$1!="" {print "^"$1"$"}'$whitelist| sed 's/\./\\./g' > $latentWhitelist
else
else
rm $latentWhitelist
fi
fi
# Prevent our sources from being pulled into the hole
plural=;[["${#sources[@]}" !="1"]]&&plural=s
echo"** Whitelisting ${#sources[@]} ad list source${plural}..."
for url in ${sources[@]}
do
# Prevent our sources from being pulled into the hole
plural=;[["${#sources[@]}" !="1"]]&&plural=s
echo"** Whitelisting ${#sources[@]} ad list source${plural}..."
for url in ${sources[@]}
do
echo"$url"| awk -F '/''{print "^"$3"$"}'| sed 's/\./\\./g' >> $latentWhitelist