Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-15 02:42:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clean up known remaining colour output issues (#1613)

Browse source 
* Print newline on error message

* Output last three lines of error if update fails

* Consistent error messages & housekeeping

* Add shellcheck directive to ignore COL_TABLE
* Quoted and braced variables for codebase consistency
* Escaped newlines correctly
* Made error messages consistent (indenting and wording)
* Removed consecutive echos

* Conditional formatting consistency

* Braced, quoted and used [[ on conditionals

* Fix specific ShellCheck issues

* Fixed issues that could be safely changed without extensive testing

* Update SELinux whiptail behaviour & more

* Colourised some strings
* Fixed multiple line string indenting
* Made output consistent with existing codebase
* Removed sequential echos
* Make SELinux whiptail use "--defaultno", and change text wording

* Add help text for hostrecord, and colourise output

* this should fix the tests...

Signed-off-by: Adam Warner <adamw@rner.email>

* revert changes to `update_package_cache()` to prove tests

Signed-off-by: Adam Warner <adamw@rner.email>
This commit is contained in:
WaLLy3K 2017-07-27 03:00:08 +10:00 committed by Adam Warner
parent b09c660833
commit fdf2649f2f
4 changed files with 194 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
advanced/Scripts/update.sh
View file

@ -19,10 +19,9 @@ readonly PI_HOLE_FILES_DIR="/etc/.pihole"
# shellcheck disable=SC2034 # shellcheck disable=SC2034
PH_TEST=true PH_TEST=true
# Have to ignore the following rule as spaces in paths are not supported by ShellCheck # shellcheck disable=SC1090
#shellcheck disable=SC1090
source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
# shellcheck disable=SC1091
source "/opt/pihole/COL_TABLE" source "/opt/pihole/COL_TABLE"
# is_repo() sourced from basic-install.sh # is_repo() sourced from basic-install.sh
@ -51,15 +50,15 @@ GitCheckUpdateAvail() {
# defaults to the current one. # defaults to the current one.
REMOTE="$(git rev-parse "@{upstream}")" REMOTE="$(git rev-parse "@{upstream}")"
if [[ ${#LOCAL} == 0 ]]; then if [[ "${#LOCAL}" == 0 ]]; then
echo -e " ${COL_LIGHT_RED}Error: Local revision could not be obtained, ask Pi-hole support." echo -e "\\n ${COL_LIGHT_RED}Error: Local revision could not be obtained, please contact Pi-hole Support
echo -e " Additional debugging output:${COL_NC}" Additional debugging output:${COL_NC}"
git status git status
exit exit
fi fi
if [[ ${#REMOTE} == 0 ]]; then if [[ "${#REMOTE}" == 0 ]]; then
echo -e " ${COL_LIGHT_RED}Error: Remote revision could not be obtained, ask Pi-hole support." echo -e "\\n ${COL_LIGHT_RED}Error: Remote revision could not be obtained, please contact Pi-hole Support
echo -e " Additional debugging output:${COL_NC}" Additional debugging output:${COL_NC}"
git status git status
exit exit
fi fi
@ -94,13 +93,15 @@ FTLcheckUpdate() {
main() { main() {
local pihole_version_current local pihole_version_current
local web_version_current local web_version_current
#shellcheck disable=1090,2154 local basicError="\\n ${COL_LIGHT_RED}Unable to complete update, please contact Pi-hole Support${COL_NC}"
# shellcheck disable=1090,2154
source "${setupVars}" source "${setupVars}"
#This is unlikely # This is unlikely
if ! is_repo "${PI_HOLE_FILES_DIR}" ; then if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
echo -e " ${COL_LIGHT_RED}Critical Error: Core Pi-hole repo is missing from system!" echo -e "\\n ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!
echo -e " Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}" Please re-run install script from https://pi-hole.net${COL_NC}"
exit 1; exit 1;
fi fi
@ -108,18 +109,18 @@ main() {
if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
core_update=true core_update=true
echo -e " ${INFO} Pi-hole Core:\t${COL_YELLOW}update available${COL_NC}" echo -e " ${INFO} Pi-hole Core:\\t${COL_YELLOW}update available${COL_NC}"
else else
core_update=false core_update=false
echo -e " ${INFO} Pi-hole Core:\t${COL_LIGHT_GREEN}up to date${COL_NC}" echo -e " ${INFO} Pi-hole Core:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
fi fi
if FTLcheckUpdate ; then if FTLcheckUpdate ; then
FTL_update=true FTL_update=true
echo -e " ${INFO} FTL:\t\t${COL_YELLOW}update available${COL_NC}" echo -e " ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
else else
FTL_update=false FTL_update=false
echo -e " ${INFO} FTL:\t\t${COL_LIGHT_GREEN}up to date${COL_NC}" echo -e " ${INFO} FTL:\\t\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
fi fi
# Logic: Don't update FTL when there is a core update available # Logic: Don't update FTL when there is a core update available
@ -132,19 +133,19 @@ main() {
echo "" echo ""
fi fi
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
echo -e " ${COL_LIGHT_RED}Critical Error: Web Admin repo is missing from system!" echo -e "\\n ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!
echo -e " Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}" Please re-run install script from https://pi-hole.net${COL_NC}"
exit 1; exit 1;
fi fi
if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
web_update=true web_update=true
echo -e " ${INFO} Web Interface:\t${COL_YELLOW}update available${COL_NC}" echo -e " ${INFO} Web Interface:\\t${COL_YELLOW}update available${COL_NC}"
else else
web_update=false web_update=false
echo -e " ${INFO} Web Interface:\t${COL_LIGHT_GREEN}up to date${COL_NC}" echo -e " ${INFO} Web Interface:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
fi fi
# Logic # Logic
@ -163,25 +164,24 @@ main() {
echo -e " ${TICK} Everything is up to date!" echo -e " ${TICK} Everything is up to date!"
exit 0 exit 0
fi fi
elif ! ${core_update} && ${web_update} ; then elif ! ${core_update} && ${web_update} ; then
echo "" echo ""
echo -e " ${INFO} Pi-hole Web Admin files out of date" echo -e " ${INFO} Pi-hole Web Admin files out of date"
getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}" getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
elif ${core_update} && ! ${web_update} ; then elif ${core_update} && ! ${web_update} ; then
echo "" echo ""
echo -e " ${INFO} Pi-hole core files out of date" echo -e " ${INFO} Pi-hole core files out of date"
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}" getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1 ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
echo -e "${basicError}" && exit 1
elif ${core_update} && ${web_update} ; then elif ${core_update} && ${web_update} ; then
echo "" echo ""
echo -e " ${INFO} Updating Pi-hole core and web admin files" echo -e " ${INFO} Updating Pi-hole core and web admin files"
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}" getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1 ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || \
echo -e "${basicError}" && exit 1
else else
echo -e " ${COL_LIGHT_RED}Update script has malfunctioned, fallthrough reached. Please contact support${COL_NC}" echo -e " ${COL_LIGHT_RED}Update script has malfunctioned, please contact Pi-hole Support${COL_NC}"
exit 1 exit 1
fi fi
else # Web Admin not installed, so only verify if core is up to date else # Web Admin not installed, so only verify if core is up to date
@ -193,38 +193,36 @@ main() {
fi fi
else else
echo "" echo ""
echo -e " ${INFO} Pi-hole core files out of date" echo -e " ${INFO} Pi-hole Core files out of date"
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}" getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1 ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
echo -e "${basicError}" && exit 1
fi fi
fi fi
if [[ "${web_update}" == true ]]; then if [[ "${web_update}" == true ]]; then
web_version_current="$(/usr/local/bin/pihole version --admin --current)" web_version_current="$(/usr/local/bin/pihole version --admin --current)"
echo "" echo ""
echo -e " ${INFO} Web Admin version is now at ${web_version_current/* v/v}" echo -e " ${INFO} Web Admin version is now at ${web_version_current/* v/v}
echo -e " ${INFO} If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'" ${INFO} If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
fi fi
if [[ "${core_update}" == true ]]; then if [[ "${core_update}" == true ]]; then
pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)" pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
echo "" echo ""
echo -e " ${INFO} Pi-hole version is now at ${pihole_version_current/* v/v}" echo -e " ${INFO} Pi-hole version is now at ${pihole_version_current/* v/v}
echo -e " ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'" ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
fi fi
if [[ ${FTL_update} == true ]]; then if [[ "${FTL_update}" == true ]]; then
FTL_version_current="$(/usr/bin/pihole-FTL tag)" FTL_version_current="$(/usr/bin/pihole-FTL tag)"
echo "" echo -e "\\n ${INFO} FTL version is now at ${FTL_version_current/* v/v}"
echo -e " ${INFO} FTL version is now at ${FTL_version_current/* v/v}"
start_service pihole-FTL start_service pihole-FTL
enable_service pihole-FTL enable_service pihole-FTL
fi fi
echo "" echo ""
exit 0 exit 0
} }
main main

20
advanced/Scripts/webpage.sh
View file

@ -29,6 +29,7 @@ Options:
-c, celsius Set Celsius as preferred temperature unit -c, celsius Set Celsius as preferred temperature unit
-f, fahrenheit Set Fahrenheit as preferred temperature unit -f, fahrenheit Set Fahrenheit as preferred temperature unit
-k, kelvin Set Kelvin as preferred temperature unit -k, kelvin Set Kelvin as preferred temperature unit
-r, hostrecord Add a name to the DNS associated to an IPv4/IPv6 address
-h, --help Show this help dialog -h, --help Show this help dialog
-i, interface Specify dnsmasq's interface listening behavior -i, interface Specify dnsmasq's interface listening behavior
Add '-h' for more info on interface usage" Add '-h' for more info on interface usage"
@ -392,12 +393,23 @@ RemoveDHCPStaticAddress() {
} }
SetHostRecord() { SetHostRecord() {
if [ -n "${args[3]}" ]; then if [[ "${1}" == "-h" ]] || [[ "${1}" == "--help" ]]; then
echo "Usage: pihole -a hostrecord <domain> [IPv4-address],[IPv6-address]
Example: 'pihole -a hostrecord home.domain.com 192.168.1.1,2001:db8:a0b:12f0::1'
Add a name to the DNS associated to an IPv4/IPv6 address
Options:
\"\" Empty: Remove host record
-h, --help Show this help dialog"
exit 0
fi
if [[ -n "${args[3]}" ]]; then
change_setting "HOSTRECORD" "${args[2]},${args[3]}" change_setting "HOSTRECORD" "${args[2]},${args[3]}"
echo "Setting host record for ${args[2]} -> ${args[3]}" echo -e " ${TICK} Setting host record for ${args[2]} to ${args[3]}"
else else
change_setting "HOSTRECORD" "" change_setting "HOSTRECORD" ""
echo "Removing host record" echo -e " ${TICK} Removing host record"
fi fi
ProcessDNSSettings ProcessDNSSettings
@ -474,7 +486,7 @@ main() {
"resolve" ) ResolutionSettings;; "resolve" ) ResolutionSettings;;
"addstaticdhcp" ) AddDHCPStaticAddress;; "addstaticdhcp" ) AddDHCPStaticAddress;;
"removestaticdhcp" ) RemoveDHCPStaticAddress;; "removestaticdhcp" ) RemoveDHCPStaticAddress;;
"hostrecord" ) SetHostRecord;; "-r" | "hostrecord" ) SetHostRecord "$3";;
"-i" | "interface" ) SetListeningMode "$@";; "-i" | "interface" ) SetListeningMode "$@";;
"-t" | "teleporter" ) Teleporter;; "-t" | "teleporter" ) Teleporter;;
"adlist" ) CustomizeAdLists;; "adlist" ) CustomizeAdLists;;

283
automated install/basic-install.sh
View file

@ -1,22 +1,21 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# shellcheck disable=SC1090
# Pi-hole: A black hole for Internet advertisements # Pi-hole: A black hole for Internet advertisements
# (c) 2017 Pi-hole, LLC (https://pi-hole.net) # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
# Network-wide ad blocking via your own hardware. # Network-wide ad blocking via your own hardware.
# #
# Installs Pi-hole # Installs and Updates Pi-hole
# #
# This file is copyright under the latest version of the EUPL. # This file is copyright under the latest version of the EUPL.
# Please see LICENSE file for your rights under this license. # Please see LICENSE file for your rights under this license.
# pi-hole.net/donate # pi-hole.net/donate
# #
# Install with this command (from your Linux machine): # Install with this command (from your Linux machine):
# #
# curl -L install.pi-hole.net | bash # curl -L install.pi-hole.net | bash
# -e option instructs bash to immediately exit if any command [1] has a non-zero exit status # -e option instructs bash to immediately exit if any command [1] has a non-zero exit status
# We do not want users to end up with a partially working install, so we exit the script # We do not want users to end up with a partially working install, so we exit the script
# instead of continuing the installation with something broken # instead of continuing the installation with something broken
@ -35,6 +34,7 @@ instalLogLoc=/etc/pihole/install.log
# This is an important file as it contains information specific to the machine it's being installed on # This is an important file as it contains information specific to the machine it's being installed on
setupVars=/etc/pihole/setupVars.conf setupVars=/etc/pihole/setupVars.conf
# Pi-hole uses lighttpd as a Web server, and this is the config file for it # Pi-hole uses lighttpd as a Web server, and this is the config file for it
# shellcheck disable=SC2034
lighttpdConfig=/etc/lighttpd/lighttpd.conf lighttpdConfig=/etc/lighttpd/lighttpd.conf
# This is a file used for the colorized output # This is a file used for the colorized output
coltable=/opt/pihole/COL_TABLE coltable=/opt/pihole/COL_TABLE
@ -79,7 +79,7 @@ reconfigure=false
runUnattended=false runUnattended=false
# If the color table file exists, # If the color table file exists,
if [[ -f ${coltable} ]]; then if [[ -f "${coltable}" ]]; then
# source it # source it
source ${coltable} source ${coltable}
# Othwerise, # Othwerise,
@ -91,8 +91,9 @@ else
TICK="[${COL_LIGHT_GREEN}✓${COL_NC}]" TICK="[${COL_LIGHT_GREEN}✓${COL_NC}]"
CROSS="[${COL_LIGHT_RED}✗${COL_NC}]" CROSS="[${COL_LIGHT_RED}✗${COL_NC}]"
INFO="[i]" INFO="[i]"
# shellcheck disable=SC2034
DONE="${COL_LIGHT_GREEN} done!${COL_NC}" DONE="${COL_LIGHT_GREEN} done!${COL_NC}"
OVER="\r\033[K" OVER="\\r\\033[K"
fi fi
# A simple function that just echoes out our logo in ASCII format # A simple function that just echoes out our logo in ASCII format
@ -122,7 +123,6 @@ show_ascii_berry() {
" "
} }
# Compatibility # Compatibility
distro_check() { distro_check() {
# If apt-get is installed, then we know it's part of the Debian family # If apt-get is installed, then we know it's part of the Debian family
@ -321,13 +321,13 @@ getGitFiles() {
# Show that we're checking it # Show that we're checking it
echo -e "${OVER} ${TICK} ${str}" echo -e "${OVER} ${TICK} ${str}"
# Update the repo, returning an error message on failure # Update the repo, returning an error message on failure
update_repo "${directory}" || { echo -e "\n ${COL_LIGHT_RED}Error: Could not update local repository. Contact support.${COL_NC}"; exit 1; } update_repo "${directory}" || { echo -e "\\n ${COL_LIGHT_RED}Error: Could not update local repository. Contact support.${COL_NC}"; exit 1; }
# If it's not a .git repo, # If it's not a .git repo,
else else
# Show an error # Show an error
echo -e "${OVER} ${CROSS} ${str}" echo -e "${OVER} ${CROSS} ${str}"
# Attempt to make the repository, showing an error on falure # Attempt to make the repository, showing an error on falure
make_repo "${directory}" "${remoteRepo}" || { echo -e "\n ${COL_LIGHT_RED}Error: Could not update local repository. Contact support.${COL_NC}"; exit 1; } make_repo "${directory}" "${remoteRepo}" || { echo -e "\\n ${COL_LIGHT_RED}Error: Could not update local repository. Contact support.${COL_NC}"; exit 1; }
fi fi
# echo a blank line # echo a blank line
echo "" echo ""
@ -380,13 +380,13 @@ get_available_interfaces() {
# A function for displaying the dialogs the user sees when first running the installer # A function for displaying the dialogs the user sees when first running the installer
welcomeDialogs() { welcomeDialogs() {
# Display the welcome dialog using an approriately sized window via the calculation conducted earlier in the script # Display the welcome dialog using an approriately sized window via the calculation conducted earlier in the script
whiptail --msgbox --backtitle "Welcome" --title "Pi-hole automated installer" "\n\nThis installer will transform your device into a network-wide ad blocker!" ${r} ${c} whiptail --msgbox --backtitle "Welcome" --title "Pi-hole automated installer" "\\n\\nThis installer will transform your device into a network-wide ad blocker!" ${r} ${c}
# Request that users donate if they enjoy the software since we all work on it in our free time # Request that users donate if they enjoy the software since we all work on it in our free time
whiptail --msgbox --backtitle "Plea" --title "Free and open source" "\n\nThe Pi-hole is free, but powered by your donations: http://pi-hole.net/donate" ${r} ${c} whiptail --msgbox --backtitle "Plea" --title "Free and open source" "\\n\\nThe Pi-hole is free, but powered by your donations: http://pi-hole.net/donate" ${r} ${c}
# Explain the need for a static address # Explain the need for a static address
whiptail --msgbox --backtitle "Initiating network interface" --title "Static IP Needed" "\n\nThe Pi-hole is a SERVER so it needs a STATIC IP ADDRESS to function properly. whiptail --msgbox --backtitle "Initiating network interface" --title "Static IP Needed" "\\n\\nThe 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}
} }
@ -400,7 +400,8 @@ verifyFreeDiskSpace() {
# Reqired space in KB # Reqired space in KB
local required_free_kilobytes=51200 local required_free_kilobytes=51200
# Calculate existing free space on this machine # Calculate existing free space on this machine
local existing_free_kilobytes=$(df -Pk | grep -m1 '\/$' | awk '{print $4}') local existing_free_kilobytes
existing_free_kilobytes=$(df -Pk | grep -m1 '\/$' | awk '{print $4}')
# If the existing space is not an integer, # If the existing space is not an integer,
if ! [[ "${existing_free_kilobytes}" =~ ^([0-9])+$ ]]; then if ! [[ "${existing_free_kilobytes}" =~ ^([0-9])+$ ]]; then
@ -414,7 +415,7 @@ verifyFreeDiskSpace() {
# exit with an error code # exit with an error code
exit 1 exit 1
# If there is insufficient free disk space, # If there is insufficient free disk space,
elif [[ ${existing_free_kilobytes} -lt ${required_free_kilobytes} ]]; then elif [[ "${existing_free_kilobytes}" -lt "${required_free_kilobytes}" ]]; then
# show an error message # show an error message
echo -e " ${CROSS} ${str} echo -e " ${CROSS} ${str}
Your system disk appears to only have ${existing_free_kilobytes} KB free Your system disk appears to only have ${existing_free_kilobytes} KB free
@ -428,7 +429,7 @@ verifyFreeDiskSpace() {
e.g: curl -L https://install.pi-hole.net | bash" e.g: curl -L https://install.pi-hole.net | bash"
fi fi
# Show there is not enough free space # Show there is not enough free space
echo -e "\n ${COL_LIGHT_RED}Insufficient free space, exiting...${COL_NC}" echo -e "\\n ${COL_LIGHT_RED}Insufficient free space, exiting...${COL_NC}"
# and exit with an error # and exit with an error
exit 1 exit 1
# Otherwise, # Otherwise,
@ -455,7 +456,7 @@ chooseInterface() {
interfaceCount=$(echo "${availableInterfaces}" | wc -l) interfaceCount=$(echo "${availableInterfaces}" | wc -l)
# If there is one interface, # If there is one interface,
if [[ ${interfaceCount} -eq 1 ]]; then if [[ "${interfaceCount}" -eq 1 ]]; then
# Set it as the interface to use since there is no other option # Set it as the interface to use since there is no other option
PIHOLE_INTERFACE="${availableInterfaces}" PIHOLE_INTERFACE="${availableInterfaces}"
# Otherwise, # Otherwise,
@ -465,7 +466,7 @@ chooseInterface() {
# use a variable to set the option as OFF to begin with # use a variable to set the option as OFF to begin with
mode="OFF" mode="OFF"
# If it's the first loop, # If it's the first loop,
if [[ ${firstLoop} -eq 1 ]]; then if [[ "${firstLoop}" -eq 1 ]]; then
# set this as the interface to use (ON) # set this as the interface to use (ON)
firstLoop=0 firstLoop=0
mode="ON" mode="ON"
@ -501,11 +502,11 @@ testIPv6() {
# will contain 162 which is the decimal value corresponding to 0xa2 # will contain 162 which is the decimal value corresponding to 0xa2
value2=$(((0x$first)%256)) value2=$(((0x$first)%256))
# the ULA test is testing for fc00::/7 according to RFC 4193 # the ULA test is testing for fc00::/7 according to RFC 4193
((($value1&254)==252)) && echo "ULA" || true (((value1&254)==252)) && echo "ULA" || true
# the GUA test is testing for 2000::/3 according to RFC 4291 # the GUA test is testing for 2000::/3 according to RFC 4291
((($value1&112)==32)) && echo "GUA" || true (((value1&112)==32)) && echo "GUA" || true
# the LL test is testing for fe80::/10 according to RFC 4193 # the LL test is testing for fe80::/10 according to RFC 4193
((($value1==254) && (($value2&192)==128))) && echo "Link-local" || true (((value1==254) && ((value2&192)==128))) && echo "Link-local" || true
} }
# A dialog for showing the user about IPv6 blocking # A dialog for showing the user about IPv6 blocking
@ -529,17 +530,17 @@ useIPv6dialog() {
# set the IPv6 address to the ULA address # set the IPv6 address to the ULA address
IPV6_ADDRESS="${ULA_ADDRESS}" IPV6_ADDRESS="${ULA_ADDRESS}"
# Show this info to the user # Show this info to the user
echo "::: Found IPv6 ULA address, using it for blocking IPv6 ads" echo -e " ${INFO} Found IPv6 ULA address, using it for blocking IPv6 ads"
# Otherwise, if the GUA_ADDRESS has a value, # Otherwise, if the GUA_ADDRESS has a value,
elif [[ ! -z "${GUA_ADDRESS}" ]]; then elif [[ ! -z "${GUA_ADDRESS}" ]]; then
# Let the user know # Let the user know
echo "::: Found IPv6 GUA address, using it for blocking IPv6 ads" echo -e " ${INFO} Found IPv6 GUA address, using it for blocking IPv6 ads"
# And assign it to the global variable # And assign it to the global variable
IPV6_ADDRESS="${GUA_ADDRESS}" IPV6_ADDRESS="${GUA_ADDRESS}"
# If none of those work, # If none of those work,
else else
# explain that IPv6 blocking will not be used # explain that IPv6 blocking will not be used
echo "::: Found neither IPv6 ULA nor GUA address, blocking IPv6 ads will not be enabled" echo -e " ${INFO} Unable to find IPv6 ULA/GUA address, IPv6 adblocking will not be enabled"
# So set the variable to be empty # So set the variable to be empty
IPV6_ADDRESS="" IPV6_ADDRESS=""
fi fi
@ -575,14 +576,14 @@ use4andor6() {
esac esac
done done
# If IPv4 is to be used, # If IPv4 is to be used,
if [[ ${useIPv4} ]]; then if [[ "${useIPv4}" ]]; then
# Run our function to get the information we need # Run our function to get the information we need
find_IPv4_information find_IPv4_information
getStaticIPv4Settings getStaticIPv4Settings
setStaticIPv4 setStaticIPv4
fi fi
# If IPv6 is to be used, # If IPv6 is to be used,
if [[ ${useIPv6} ]]; then if [[ "${useIPv6}" ]]; then
# Run our function to get this information # Run our function to get this information
useIPv6dialog useIPv6dialog
fi fi
@ -590,7 +591,7 @@ use4andor6() {
echo -e " ${INFO} IPv4 address: ${IPV4_ADDRESS}" echo -e " ${INFO} IPv4 address: ${IPV4_ADDRESS}"
echo -e " ${INFO} IPv6 address: ${IPV6_ADDRESS}" echo -e " ${INFO} IPv6 address: ${IPV6_ADDRESS}"
# If neither protocol is selected, # If neither protocol is selected,
if [ ! ${useIPv4} ] && [ ! ${useIPv6} ]; then if [[ ! "${useIPv4}" ]] && [[ ! "${useIPv6}" ]]; then
# Show an error in red # Show an error in red
echo -e " ${COL_LIGHT_RED}Error: Neither IPv4 or IPv6 selected${COL_NC}" echo -e " ${COL_LIGHT_RED}Error: Neither IPv4 or IPv6 selected${COL_NC}"
# and exit with an error # and exit with an error
@ -616,7 +617,7 @@ It is also possible to use a DHCP reservation, but if you are going to do that,
# Otherwise, we need to ask the user to input their desired settings. # 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 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 # 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 # Ask for the IPv4 address
IPV4_ADDRESS=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 address" --inputbox "Enter your desired IPv4 address" ${r} ${c} "${IPV4_ADDRESS}" 3>&1 1>&2 2>&3) || \ IPV4_ADDRESS=$(whiptail --backtitle "Calibrating network interface" --title "IPv4 address" --inputbox "Enter your desired IPv4 address" ${r} ${c} "${IPV4_ADDRESS}" 3>&1 1>&2 2>&3) || \
@ -660,7 +661,7 @@ setStaticIPv4() {
local IPADDR local IPADDR
local CIDR local CIDR
# For the Debian family, if dhcpcd.conf exists, # For the Debian family, if dhcpcd.conf exists,
if [[ -f /etc/dhcpcd.conf ]]; then if [[ -f "/etc/dhcpcd.conf" ]]; then
# check if the IP is already in the file # check if the IP is already in the file
if grep -q "${IPV4_ADDRESS}" /etc/dhcpcd.conf; then if grep -q "${IPV4_ADDRESS}" /etc/dhcpcd.conf; then
echo -e " ${INFO} Static IP already configured" echo -e " ${INFO} Static IP already configured"
@ -672,10 +673,10 @@ setStaticIPv4() {
ip addr replace dev "${PIHOLE_INTERFACE}" "${IPV4_ADDRESS}" ip addr replace dev "${PIHOLE_INTERFACE}" "${IPV4_ADDRESS}"
# Also give a warning that the user may need to reboot their system # Also give a warning that the user may need to reboot their system
echo -e " ${TICK} Set IP address to ${IPV4_ADDRESS%/*} echo -e " ${TICK} Set IP address to ${IPV4_ADDRESS%/*}
You may need to restart after the install is complete" You may need to restart after the install is complete"
fi fi
# If it's not Debian, check if it's the Fedora family by checking for the file below # If it's not Debian, check if it's the Fedora family by checking for the file below
elif [[ -f /etc/sysconfig/network-scripts/ifcfg-${PIHOLE_INTERFACE} ]];then elif [[ -f "/etc/sysconfig/network-scripts/ifcfg-${PIHOLE_INTERFACE}" ]];then
# If it exists, # If it exists,
IFCFG_FILE=/etc/sysconfig/network-scripts/ifcfg-${PIHOLE_INTERFACE} IFCFG_FILE=/etc/sysconfig/network-scripts/ifcfg-${PIHOLE_INTERFACE}
# check if the desired IP is already set # check if the desired IP is already set
@ -710,7 +711,7 @@ setStaticIPv4() {
fi fi
# Show a warning that the user may need to restart # Show a warning that the user may need to restart
echo -e " ${TICK} Set IP address to ${IPV4_ADDRESS%/*} echo -e " ${TICK} Set IP address to ${IPV4_ADDRESS%/*}
You may need to restart after the install is complete" You may need to restart after the install is complete"
fi fi
# If all that fails, # If all that fails,
else else
@ -727,7 +728,7 @@ valid_ip() {
local stat=1 local stat=1
# If the IP matches the format xxx.xxx.xxx.xxx, # If the IP matches the format xxx.xxx.xxx.xxx,
if [[ ${ip} =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then if [[ "${ip}" =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
# Save the old Interfal Field Separator in a variable # Save the old Interfal Field Separator in a variable
OIFS=$IFS OIFS=$IFS
# and set the new one to a dot (period) # and set the new one to a dot (period)
@ -737,8 +738,8 @@ valid_ip() {
# Restore the IFS to what it was # Restore the IFS to what it was
IFS=${OIFS} IFS=${OIFS}
## Evaluate each octet by checking if it's less than or equal to 255 (the max for each octet) ## Evaluate each octet by checking if it's less than or equal to 255 (the max for each octet)
[[ ${ip[0]} -le 255 && ${ip[1]} -le 255 \ [[ "${ip[0]}" -le 255 && "${ip[1]}" -le 255 \
&& ${ip[2]} -le 255 && ${ip[3]} -le 255 ]] && "${ip[2]}" -le 255 && "${ip[3]}" -le 255 ]]
# Save the exit code # Save the exit code
stat=$? stat=$?
fi fi
@ -801,13 +802,13 @@ setDNS() {
;; ;;
Custom) Custom)
# Until the DNS settings are selected, # Until the DNS settings are selected,
until [[ ${DNSSettingsCorrect} = True ]]; do until [[ "${DNSSettingsCorrect}" = True ]]; do
# #
strInvalid="Invalid" strInvalid="Invalid"
# If the first # If the first
if [ ! ${PIHOLE_DNS_1} ]; then if [[ ! "${PIHOLE_DNS_1}" ]]; then
# and second upstream servers do not exist # and second upstream servers do not exist
if [ ! ${PIHOLE_DNS_2} ]; then if [[ ! "${PIHOLE_DNS_2}" ]]; then
# #
prePopulate="" prePopulate=""
# Otherwise, # Otherwise,
@ -816,39 +817,39 @@ setDNS() {
prePopulate=", ${PIHOLE_DNS_2}" prePopulate=", ${PIHOLE_DNS_2}"
fi fi
# #
elif [ ${PIHOLE_DNS_1} ] && [ ! ${PIHOLE_DNS_2} ]; then elif [[ "${PIHOLE_DNS_1}" ]] && [[ ! "${PIHOLE_DNS_2}" ]]; then
# #
prePopulate="${PIHOLE_DNS_1}" prePopulate="${PIHOLE_DNS_1}"
# #
elif [ ${PIHOLE_DNS_1} ] && [ ${PIHOLE_DNS_2} ]; then elif [[ "${PIHOLE_DNS_1}" ]] && [[ "${PIHOLE_DNS_2}" ]]; then
# #
prePopulate="${PIHOLE_DNS_1}, ${PIHOLE_DNS_2}" prePopulate="${PIHOLE_DNS_1}, ${PIHOLE_DNS_2}"
fi fi
# Dialog for the user to enter custom upstream servers # Dialog for the user to enter custom upstream servers
piholeDNS=$(whiptail --backtitle "Specify Upstream DNS Provider(s)" --inputbox "Enter your desired upstream DNS provider(s), seperated by a comma.\n\nFor example '8.8.8.8, 8.8.4.4'" ${r} ${c} "${prePopulate}" 3>&1 1>&2 2>&3) || \ piholeDNS=$(whiptail --backtitle "Specify Upstream DNS Provider(s)" --inputbox "Enter your desired upstream DNS provider(s), seperated by a comma.\\n\\nFor example '8.8.8.8, 8.8.4.4'" ${r} ${c} "${prePopulate}" 3>&1 1>&2 2>&3) || \
{ echo -e " ${COL_LIGHT_RED}Cancel was selected, exiting installer${COL_NC}"; exit 1; } { echo -e " ${COL_LIGHT_RED}Cancel was selected, exiting installer${COL_NC}"; exit 1; }
# #
PIHOLE_DNS_1=$(echo "${piholeDNS}" | sed 's/[, \t]\+/,/g' | awk -F, '{print$1}') PIHOLE_DNS_1=$(echo "${piholeDNS}" | sed 's/[, \t]\+/,/g' | awk -F, '{print$1}')
PIHOLE_DNS_2=$(echo "${piholeDNS}" | sed 's/[, \t]\+/,/g' | awk -F, '{print$2}') PIHOLE_DNS_2=$(echo "${piholeDNS}" | sed 's/[, \t]\+/,/g' | awk -F, '{print$2}')
# If the IP is valid, # If the IP is valid,
if ! valid_ip "${PIHOLE_DNS_1}" || [ ! "${PIHOLE_DNS_1}" ]; then if ! valid_ip "${PIHOLE_DNS_1}" || [[ ! "${PIHOLE_DNS_1}" ]]; then
# store it in the variable so we can use it # store it in the variable so we can use it
PIHOLE_DNS_1=${strInvalid} PIHOLE_DNS_1=${strInvalid}
fi fi
# Do the same for the secondary server # Do the same for the secondary server
if ! valid_ip "${PIHOLE_DNS_2}" && [ "${PIHOLE_DNS_2}" ]; then if ! valid_ip "${PIHOLE_DNS_2}" && [[ "${PIHOLE_DNS_2}" ]]; then
PIHOLE_DNS_2=${strInvalid} PIHOLE_DNS_2=${strInvalid}
fi fi
# If either of the DNS servers are invalid, # If either of the DNS servers are invalid,
if [[ ${PIHOLE_DNS_1} == "${strInvalid}" ]] || [[ ${PIHOLE_DNS_2} == "${strInvalid}" ]]; then if [[ "${PIHOLE_DNS_1}" == "${strInvalid}" ]] || [[ "${PIHOLE_DNS_2}" == "${strInvalid}" ]]; then
# explain this to the user # explain this to the user
whiptail --msgbox --backtitle "Invalid IP" --title "Invalid IP" "One or both entered IP addresses were invalid. Please try again.\n\n DNS Server 1: $PIHOLE_DNS_1\n DNS Server 2: ${PIHOLE_DNS_2}" ${r} ${c} whiptail --msgbox --backtitle "Invalid IP" --title "Invalid IP" "One or both entered IP addresses were invalid. Please try again.\\n\\n DNS Server 1: $PIHOLE_DNS_1\\n DNS Server 2: ${PIHOLE_DNS_2}" ${r} ${c}
# and set the variables back to nothing # and set the variables back to nothing
if [[ ${PIHOLE_DNS_1} == "${strInvalid}" ]]; then if [[ "${PIHOLE_DNS_1}" == "${strInvalid}" ]]; then
PIHOLE_DNS_1="" PIHOLE_DNS_1=""
fi fi
if [[ ${PIHOLE_DNS_2} == "${strInvalid}" ]]; then if [[ "${PIHOLE_DNS_2}" == "${strInvalid}" ]]; then
PIHOLE_DNS_2="" PIHOLE_DNS_2=""
fi fi
# Since the settings will not work, stay in the loop # Since the settings will not work, stay in the loop
@ -856,7 +857,7 @@ setDNS() {
# Othwerise, # Othwerise,
else else
# Show the settings # Show the settings
if (whiptail --backtitle "Specify Upstream DNS Provider(s)" --title "Upstream DNS Provider(s)" --yesno "Are these settings correct?\n DNS Server 1: $PIHOLE_DNS_1\n DNS Server 2: ${PIHOLE_DNS_2}" ${r} ${c}); then if (whiptail --backtitle "Specify Upstream DNS Provider(s)" --title "Upstream DNS Provider(s)" --yesno "Are these settings correct?\\n DNS Server 1: $PIHOLE_DNS_1\\n DNS Server 2: ${PIHOLE_DNS_2}" ${r} ${c}); then
# and break from the loop since the servers are vaid # and break from the loop since the servers are vaid
DNSSettingsCorrect=True DNSSettingsCorrect=True
# Otherwise, # Otherwise,
@ -878,7 +879,7 @@ setLogging() {
local LogChoices local LogChoices
# Ask if the user wants to log queries # Ask if the user wants to log queries
LogToggleCommand=(whiptail --separate-output --radiolist "Do you want to log queries?\n (Disabling will render graphs on the Admin page useless):" ${r} ${c} 6) LogToggleCommand=(whiptail --separate-output --radiolist "Do you want to log queries?\\n (Disabling will render graphs on the Admin page useless):" ${r} ${c} 6)
# The default selection is on # The default selection is on
LogChooseOptions=("On (Recommended)" "" on LogChooseOptions=("On (Recommended)" "" on
Off "" off) Off "" off)
@ -916,12 +917,12 @@ setAdminFlag() {
# Depending on their choice # Depending on their choice
case ${WebChoices} in case ${WebChoices} in
"On (Recommended)") "On (Recommended)")
echo -e " ${INFO} Web Interface On." echo -e " ${INFO} Web Interface On"
# Set it to true # Set it to true
INSTALL_WEB=true INSTALL_WEB=true
;; ;;
Off) Off)
echo -e " ${INFO} Web Interface off." echo -e " ${INFO} Web Interface Off"
# or false # or false
INSTALL_WEB=false INSTALL_WEB=false
;; ;;
@ -939,7 +940,7 @@ version_check_dnsmasq() {
local dnsmasq_pihole_01_location="/etc/dnsmasq.d/01-pihole.conf" local dnsmasq_pihole_01_location="/etc/dnsmasq.d/01-pihole.conf"
# If the dnsmasq config file exists # If the dnsmasq config file exists
if [ -f ${dnsmasq_conf} ]; then if [[ -f "${dnsmasq_conf}" ]]; then
echo -ne " ${INFO} Existing dnsmasq.conf found..." echo -ne " ${INFO} Existing dnsmasq.conf found..."
# If gravity.list is found within this file, we presume it's from older versions on Pi-hole, # If gravity.list is found within this file, we presume it's from older versions on Pi-hole,
if grep -q ${dnsmasq_pihole_id_string} ${dnsmasq_conf}; then if grep -q ${dnsmasq_pihole_id_string} ${dnsmasq_conf}; then
@ -1048,8 +1049,8 @@ installScripts() {
# Otherwise, # Otherwise,
else else
# Show an error and exit # Show an error and exit
echo -e "${OVER} ${CROSS} ${str}" echo -e "${OVER} ${CROSS} ${str}
echo -e " ${COL_LIGHT_RED}Error: Local repo ${PI_HOLE_LOCAL_REPO} not found, exiting installer${COL_NC}" ${COL_LIGHT_RED}Error: Local repo ${PI_HOLE_LOCAL_REPO} not found, exiting installer${COL_NC}"
exit 1 exit 1
fi fi
} }
@ -1062,15 +1063,15 @@ installConfigs() {
version_check_dnsmasq version_check_dnsmasq
# If the user chose to install the dashboard, # If the user chose to install the dashboard,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# and if the Web server conf directory does not exist, # and if the Web server conf directory does not exist,
if [ ! -d "/etc/lighttpd" ]; then if [[ ! -d "/etc/lighttpd" ]]; then
# make it # make it
mkdir /etc/lighttpd mkdir /etc/lighttpd
# and set the owners # and set the owners
chown "${USER}":root /etc/lighttpd chown "${USER}":root /etc/lighttpd
# Otherwise, if the config file already exists # Otherwise, if the config file already exists
elif [ -f "/etc/lighttpd/lighttpd.conf" ]; then elif [[ -f "/etc/lighttpd/lighttpd.conf" ]]; then
# back up the original # back up the original
mv /etc/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf.orig mv /etc/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf.orig
fi fi
@ -1164,16 +1165,13 @@ update_package_cache() {
notify_package_updates_available() { notify_package_updates_available() {
# Local, named variables # Local, named variables
local str="Checking ${PKG_MANAGER} for upgraded packages" local str="Checking ${PKG_MANAGER} for upgraded packages"
echo "" echo -ne "\\n ${INFO} ${str}..."
echo -ne " ${INFO} ${str}..."
# Store the list of packages in a variable # Store the list of packages in a variable
updatesToInstall=$(eval "${PKG_COUNT}") updatesToInstall=$(eval "${PKG_COUNT}")
#echo -e "\r\033[K ${TICK} ${str}"
#echo ""
#
if [[ -d "/lib/modules/$(uname -r)" ]]; then if [[ -d "/lib/modules/$(uname -r)" ]]; then
# #
if [[ ${updatesToInstall} -eq "0" ]]; then if [[ "${updatesToInstall}" -eq 0 ]]; then
# #
echo -e "${OVER} ${TICK} ${str}... up to date!" echo -e "${OVER} ${TICK} ${str}... up to date!"
echo "" echo ""
@ -1184,10 +1182,8 @@ notify_package_updates_available() {
echo "" echo ""
fi fi
else else
#
echo -e "${OVER} ${CROSS} ${str} echo -e "${OVER} ${CROSS} ${str}
Kernel update detected. If the install fails, please reboot and try again" Kernel update detected. If the install fails, please reboot and try again\\n"
echo ""
fi fi
} }
@ -1199,7 +1195,7 @@ install_dependent_packages() {
# Add one to the counter # Add one to the counter
counter=$((counter+1)) counter=$((counter+1))
# If it equals 1, # If it equals 1,
if [ ${counter} == 1 ]; then if [[ "${counter}" == 1 ]]; then
# #
echo -e " ${INFO} Installer Dependency checks..." echo -e " ${INFO} Installer Dependency checks..."
else else
@ -1233,7 +1229,7 @@ install_dependent_packages() {
fi fi
done done
# #
if [[ ${#installArray[@]} -gt 0 ]]; then if [[ "${#installArray[@]}" -gt 0 ]]; then
# #
test_dpkg_lock test_dpkg_lock
# #
@ -1258,7 +1254,7 @@ install_dependent_packages() {
fi fi
done done
# #
if [[ ${#installArray[@]} -gt 0 ]]; then if [[ "${#installArray[@]}" -gt 0 ]]; then
# #
"${PKG_INSTALL[@]}" "${installArray[@]}" &> /dev/null "${PKG_INSTALL[@]}" "${installArray[@]}" &> /dev/null
return return
@ -1273,7 +1269,7 @@ CreateLogFile() {
echo "" echo ""
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# If the pihole log does not exist, # If the pihole log does not exist,
if [ ! -f /var/log/pihole.log ]; then if [[ ! -f "/var/log/pihole.log" ]]; then
# Make it, # Make it,
touch /var/log/pihole.log touch /var/log/pihole.log
# set the permissions, # set the permissions,
@ -1293,11 +1289,11 @@ installPiholeWeb() {
echo "" echo ""
echo " ${INFO} Installing blocking page..." echo " ${INFO} Installing blocking page..."
# If the pihole Web directory exists, # If the pihole Web directory exists,
if [ -d "/var/www/html/pihole" ]; then if [[ -d "/var/www/html/pihole" ]]; then
local str="Installing index.php" local str="Installing index.php"
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# and if the index file exists, # and if the index file exists,
if [ -f "/var/www/html/pihole/index.php" ]; then if [[ -f "/var/www/html/pihole/index.php" ]]; then
# do not overwrite it, # do not overwrite it,
echo -e " ${COL_LIGHT_GREEN}detected index.php, not overwriting${COL_NC}" echo -e " ${COL_LIGHT_GREEN}detected index.php, not overwriting${COL_NC}"
# if it doesn't exist # if it doesn't exist
@ -1310,7 +1306,7 @@ installPiholeWeb() {
local str="Installing index.js" local str="Installing index.js"
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# and if the index file exists, # and if the index file exists,
if [ -f "/var/www/html/pihole/index.js" ]; then if [[ -f "/var/www/html/pihole/index.js" ]]; then
# do not overwrite it, # do not overwrite it,
echo -e " ${COL_LIGHT_GREEN}detected index.js, not overwriting${COL_NC}" echo -e " ${COL_LIGHT_GREEN}detected index.js, not overwriting${COL_NC}"
else else
@ -1322,7 +1318,7 @@ installPiholeWeb() {
local str="Installing blockingpage.css" local str="Installing blockingpage.css"
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# and if the index file exists, # and if the index file exists,
if [ -f "/var/www/html/pihole/blockingpage.css" ]; then if [[ -f "/var/www/html/pihole/blockingpage.css" ]]; then
# do not overwrite it, # do not overwrite it,
echo -e " ${COL_LIGHT_GREEN}detected blockingpage.css, not overwriting${COL_NC}" echo -e " ${COL_LIGHT_GREEN}detected blockingpage.css, not overwriting${COL_NC}"
else else
@ -1343,15 +1339,15 @@ installPiholeWeb() {
local str="Backing up index.lighttpd.html" local str="Backing up index.lighttpd.html"
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# If the default index file exists, # If the default index file exists,
if [ -f /var/www/html/index.lighttpd.html ]; then if [[ -f "/var/www/html/index.lighttpd.html" ]]; then
# back it up # back it up
mv /var/www/html/index.lighttpd.html /var/www/html/index.lighttpd.orig mv /var/www/html/index.lighttpd.html /var/www/html/index.lighttpd.orig
echo -e "${OVER} ${TICK} ${str}" echo -e "${OVER} ${TICK} ${str}"
# Othwerwise, # Othwerwise,
else else
# don't do anything # don't do anything
echo -e "${OVER} ${CROSS} ${str}" echo -e "${OVER} ${CROSS} ${str}
echo -e " No default index.lighttpd.html file found... not backing up" No default index.lighttpd.html file found... not backing up"
fi fi
fi fi
@ -1435,9 +1431,9 @@ configureFirewall() {
# If a firewall is running, # If a firewall is running,
if firewall-cmd --state &> /dev/null; then if firewall-cmd --state &> /dev/null; then
# ask if the user wants to install Pi-hole's default firwall rules # ask if the user wants to install Pi-hole's default firwall rules
whiptail --title "Firewall in use" --yesno "We have detected a running firewall\n\nPi-hole currently requires HTTP and DNS port access.\n\n\n\nInstall Pi-hole default firewall rules?" ${r} ${c} || \ whiptail --title "Firewall in use" --yesno "We have detected a running firewall\\n\\nPi-hole currently requires HTTP and DNS port access.\\n\\n\\n\\nInstall Pi-hole default firewall rules?" ${r} ${c} || \
{ echo -e " ${INFO} Not installing firewall rulesets."; return 0; } { echo -e " ${INFO} Not installing firewall rulesets."; return 0; }
echo -e " ${TICK} Configuring FirewallD for httpd and dnsmasq." echo -e " ${TICK} Configuring FirewallD for httpd and dnsmasq"
# Allow HTTP and DNS traffice # Allow HTTP and DNS traffice
firewall-cmd --permanent --add-service=http --add-service=dns firewall-cmd --permanent --add-service=http --add-service=dns
# Reload the firewall to apply these changes # Reload the firewall to apply these changes
@ -1448,9 +1444,9 @@ configureFirewall() {
# If chain Policy is not ACCEPT or last Rule is not ACCEPT # If chain Policy is not ACCEPT or last Rule is not ACCEPT
# then check and insert our Rules above the DROP/REJECT Rule. # then check and insert our Rules above the DROP/REJECT Rule.
if iptables -S INPUT | head -n1 | grep -qv '^-P.*ACCEPT$' || iptables -S INPUT | tail -n1 | grep -qv '^-\(A\|P\).*ACCEPT$'; then if iptables -S INPUT | head -n1 | grep -qv '^-P.*ACCEPT$' || iptables -S INPUT | tail -n1 | grep -qv '^-\(A\|P\).*ACCEPT$'; then
whiptail --title "Firewall in use" --yesno "We have detected a running firewall\n\nPi-hole currently requires HTTP and DNS port access.\n\n\n\nInstall Pi-hole default firewall rules?" ${r} ${c} || \ whiptail --title "Firewall in use" --yesno "We have detected a running firewall\\n\\nPi-hole currently requires HTTP and DNS port access.\\n\\n\\n\\nInstall Pi-hole default firewall rules?" ${r} ${c} || \
{ echo -e " ${INFO} Not installing firewall rulesets."; return 0; } { echo -e " ${INFO} Not installing firewall rulesets."; return 0; }
echo -e " ${TICK} Installing new IPTables firewall rulesets." echo -e " ${TICK} Installing new IPTables firewall rulesets"
# Check chain first, otherwise a new rule will duplicate old ones # Check chain first, otherwise a new rule will duplicate old ones
iptables -C INPUT -p tcp -m tcp --dport 80 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 80 -j ACCEPT iptables -C INPUT -p tcp -m tcp --dport 80 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 80 -j ACCEPT
iptables -C INPUT -p tcp -m tcp --dport 53 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 53 -j ACCEPT iptables -C INPUT -p tcp -m tcp --dport 53 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 53 -j ACCEPT
@ -1461,31 +1457,32 @@ configureFirewall() {
# Othwerwise, # Othwerwise,
else else
# no firewall is running # no firewall is running
echo -e " ${INFO} No active firewall detected.. skipping firewall configuration." echo -e " ${INFO} No active firewall detected.. skipping firewall configuration"
# so just exit # so just exit
return 0 return 0
fi fi
echo -e " ${INFO} Skipping firewall configuration." echo -e " ${INFO} Skipping firewall configuration"
} }
# #
finalExports() { finalExports() {
# If the Web interface is not set to be installed, # If the Web interface is not set to be installed,
if [[ ${INSTALL_WEB} == false ]]; then if [[ "${INSTALL_WEB}" == false ]]; then
# and if there is not an IPv4 address, # and if there is not an IPv4 address,
if [ ${IPV4_ADDRESS} ]; then if [[ "${IPV4_ADDRESS}" ]]; then
# there is no block page, so set IPv4 to 0.0.0.0 (all IP addresses) # there is no block page, so set IPv4 to 0.0.0.0 (all IP addresses)
IPV4_ADDRESS="0.0.0.0" IPV4_ADDRESS="0.0.0.0"
fi fi
if [ ${IPV6_ADDRESS} ]; then if [[ "${IPV6_ADDRESS}" ]]; then
# and IPv6 to ::/0 # and IPv6 to ::/0
IPV6_ADDRESS="::/0" IPV6_ADDRESS="::/0"
fi fi
fi fi
# If the setup variable file exists, # If the setup variable file exists,
if [ -e "${setupVars}" ]; then if [[ -e "${setupVars}" ]]; then
sed -i.update.bak '/PIHOLE_INTERFACE/d;/IPV4_ADDRESS/d;/IPV6_ADDRESS/d;/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/QUERY_LOGGING/d;/INSTALL_WEB/d;/LIGHTTPD_ENABLED/d;' "${setupVars}" # update the variables in the file
sed -i.update.bak '/PIHOLE_INTERFACE/d;/IPV4_ADDRESS/d;/IPV6_ADDRESS/d;/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/QUERY_LOGGING/d;/INSTALL_WEB/d;' "${setupVars}"
fi fi
# echo the information to the user # echo the information to the user
{ {
@ -1526,7 +1523,7 @@ installLogrotate() {
# the local properties of the /var/log directory # the local properties of the /var/log directory
logusergroup="$(stat -c '%U %G' /var/log)" logusergroup="$(stat -c '%U %G' /var/log)"
# If the variable has a value, # If the variable has a value,
if [[ ! -z $logusergroup ]]; then if [[ ! -z "${logusergroup}" ]]; then
# #
sed -i "s/# su #/su ${logusergroup}/g;" /etc/pihole/logrotate sed -i "s/# su #/su ${logusergroup}/g;" /etc/pihole/logrotate
fi fi
@ -1539,8 +1536,8 @@ installPihole() {
create_pihole_user create_pihole_user
# If the user wants to install the Web interface, # If the user wants to install the Web interface,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
if [ ! -d "/var/www/html" ]; then if [[ ! -d "/var/www/html" ]]; then
# make the Web directory if necessary # make the Web directory if necessary
mkdir -p /var/www/html mkdir -p /var/www/html
fi fi
@ -1550,13 +1547,13 @@ installPihole() {
# Give pihole access to the Web server group # Give pihole access to the Web server group
usermod -a -G ${LIGHTTPD_GROUP} pihole usermod -a -G ${LIGHTTPD_GROUP} pihole
# If the lighttpd command is executable, # If the lighttpd command is executable,
if [ -x "$(command -v lighty-enable-mod)" ]; then if [[ -x "$(command -v lighty-enable-mod)" ]]; then
# enable fastcgi and fastcgi-php # enable fastcgi and fastcgi-php
lighty-enable-mod fastcgi fastcgi-php > /dev/null || true lighty-enable-mod fastcgi fastcgi-php > /dev/null || true
else else
# Othweise, show info about installing them # Othweise, show info about installing them
echo -e " ${INFO} Warning: 'lighty-enable-mod' utility not found echo -e " ${INFO} Warning: 'lighty-enable-mod' utility not found
Please ensure fastcgi is enabled if you experience issues\n" Please ensure fastcgi is enabled if you experience issues\\n"
fi fi
fi fi
# Install scripts, # Install scripts,
@ -1566,7 +1563,7 @@ installPihole() {
# and create the log file # and create the log file
CreateLogFile CreateLogFile
# If the user wants to install the dashboard, # If the user wants to install the dashboard,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# do so # do so
installPiholeWeb installPiholeWeb
fi fi
@ -1575,7 +1572,7 @@ installPihole() {
# Install the logrotate file # Install the logrotate file
installLogrotate installLogrotate
# Check if FTL is installed # Check if FTL is installed
FTLdetect || echo -e " ${CROSS} FTL Engine not installed." FTLdetect || echo -e " ${CROSS} FTL Engine not installed"
# Configure the firewall # Configure the firewall
configureFirewall configureFirewall
@ -1604,7 +1601,7 @@ updatePihole() {
# Create the log file # Create the log file
CreateLogFile CreateLogFile
# If the user wants to install the dasboard, # If the user wants to install the dasboard,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# do so # do so
installPiholeWeb installPiholeWeb
fi fi
@ -1625,19 +1622,17 @@ updatePihole() {
checkSelinux() { checkSelinux() {
# If the getenforce command exists, # If the getenforce command exists,
if command -v getenforce &> /dev/null; then if command -v getenforce &> /dev/null; then
echo ""
echo -ne " ${INFO} SELinux Support Detected... Mode: "
# Store the current mode in a variable # Store the current mode in a variable
enforceMode=$(getenforce) enforceMode=$(getenforce)
echo "${enforceMode}" echo -e "\\n ${INFO} SELinux mode detected: ${enforceMode}"
# If it's enforcing, # If it's enforcing,
if [[ "${enforceMode}" == "Enforcing" ]]; then if [[ "${enforceMode}" == "Enforcing" ]]; then
# Explain Pi-hole does not support it yet # Explain Pi-hole does not support it yet
whiptail --title "SELinux Enforcing Detected" --yesno "SELinux is being Enforced on your system!\n\nPi-hole currently does not support SELinux, but you may still continue with the installation.\n\nNote: Admin UI Will not function fully without setting your policies correctly\n\nContinue installing Pi-hole?" ${r} ${c} || \ whiptail --defaultno --title "SELinux Enforcing Detected" --yesno "SELinux is being ENFORCED on your system! \\n\\nPi-hole currently does not support SELinux, but you may still continue with the installation.\\n\\nNote: Web Admin will not be fully functional unless you set your policies correctly\\n\\nContinue installing Pi-hole?" ${r} ${c} || \
{ echo ""; echo -e " ${COL_LIGHT_RED}SELinux Enforcing detected, exiting installer${COL_NC}"; exit 1; } { echo -e "\\n ${COL_LIGHT_RED}SELinux Enforcing detected, exiting installer${COL_NC}"; exit 1; }
echo "" echo -e " ${INFO} Continuing installation with SELinux Enforcing
echo -e " ${INFO} Continuing installation with SELinux Enforcing" ${INFO} Please refer to official SELinux documentation to create a custom policy"
echo -e " ${INFO} Please refer to official SELinux documentation to create a custom policy"
fi fi
fi fi
} }
@ -1645,7 +1640,7 @@ checkSelinux() {
# Installation complete message with instructions for the user # Installation complete message with instructions for the user
displayFinalMessage() { displayFinalMessage() {
# If # If
if [[ ${#1} -gt 0 ]] ; then if [[ "${#1}" -gt 0 ]] ; then
pwstring="$1" pwstring="$1"
# else, if the dashboard password in the setup variables exists, # else, if the dashboard password in the setup variables exists,
elif [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) -gt 0 ]]; then elif [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) -gt 0 ]]; then
@ -1656,7 +1651,7 @@ displayFinalMessage() {
pwstring="NOT SET" pwstring="NOT SET"
fi fi
# If the user wants to install the dashboard, # If the user wants to install the dashboard,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# Store a message in a variable and display it # Store a message in a variable and display it
additional="View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin additional="View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin
@ -1678,7 +1673,7 @@ ${additional}" ${r} ${c}
update_dialogs() { update_dialogs() {
# If pihole -r "reconfigure" option was selected, # If pihole -r "reconfigure" option was selected,
if [ "${reconfigure}" = true ]; then if [[ "${reconfigure}" = true ]]; then
# set some variables that will be used # set some variables that will be used
opt1a="Repair" opt1a="Repair"
opt1b="This will retain existing settings" opt1b="This will retain existing settings"
@ -1694,7 +1689,7 @@ update_dialogs() {
opt2b="This will allow you to enter new settings" opt2b="This will allow you to enter new settings"
# Display the information to the user # Display the information to the user
UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options: \n($strAdd)" ${r} ${c} 2 \ UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\\n\\nWe have detected an existing install.\\n\\nPlease choose from the following options: \\n($strAdd)" ${r} ${c} 2 \
"${opt1a}" "${opt1b}" \ "${opt1a}" "${opt1b}" \
"${opt2a}" "${opt2b}" 3>&2 2>&1 1>&3) || \ "${opt2a}" "${opt2b}" 3>&2 2>&1 1>&3) || \
{ echo -e " ${COL_LIGHT_RED}Cancel was selected, exiting installer${COL_NC}"; exit 1; } { echo -e " ${COL_LIGHT_RED}Cancel was selected, exiting installer${COL_NC}"; exit 1; }
@ -1703,7 +1698,7 @@ update_dialogs() {
case ${UpdateCmd} in case ${UpdateCmd} in
# repair, or # repair, or
${opt1a}) ${opt1a})
echo -e " ${INFO} ${opt1a} option selected." echo -e " ${INFO} ${opt1a} option selected"
useUpdateVars=true useUpdateVars=true
;; ;;
# recongigure, # recongigure,
@ -1714,7 +1709,6 @@ update_dialogs() {
esac esac
} }
clone_or_update_repos() { clone_or_update_repos() {
# If the user wants to reconfigure, # If the user wants to reconfigure,
if [[ "${reconfigure}" == true ]]; then if [[ "${reconfigure}" == true ]]; then
@ -1725,7 +1719,7 @@ clone_or_update_repos() {
exit 1; \ exit 1; \
} }
# If the Web interface was installed, # If the Web interface was installed,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# reset it's repo # reset it's repo
resetRepo ${webInterfaceDir} || \ resetRepo ${webInterfaceDir} || \
{ echo -e " ${COL_LIGHT_RED}Unable to reset ${webInterfaceDir}, exiting installer${COL_NC}"; \ { echo -e " ${COL_LIGHT_RED}Unable to reset ${webInterfaceDir}, exiting installer${COL_NC}"; \
@ -1736,11 +1730,11 @@ clone_or_update_repos() {
else else
# so get git files for Core # so get git files for Core
getGitFiles ${PI_HOLE_LOCAL_REPO} ${piholeGitUrl} || \ getGitFiles ${PI_HOLE_LOCAL_REPO} ${piholeGitUrl} || \
{ echo "!!! Unable to clone ${piholeGitUrl} into ${PI_HOLE_LOCAL_REPO}, unable to continue."; \ { echo -e " ${COL_LIGHT_RED}Unable to clone ${piholeGitUrl} into ${PI_HOLE_LOCAL_REPO}, unable to continue${COL_NC}"; \
exit 1; \ exit 1; \
} }
# If the Web interface was installed, # If the Web interface was installed,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# get the Web git files # get the Web git files
getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} || \ getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} || \
{ echo -e " ${COL_LIGHT_RED}Unable to clone ${webInterfaceGitUrl} into ${webInterfaceDir}, exiting installer${COL_NC}"; \ { echo -e " ${COL_LIGHT_RED}Unable to clone ${webInterfaceGitUrl} into ${webInterfaceDir}, exiting installer${COL_NC}"; \
@ -1824,21 +1818,23 @@ FTLdetect() {
local str="Detecting architecture" local str="Detecting architecture"
echo -ne " ${INFO} ${str}..." echo -ne " ${INFO} ${str}..."
# If the machine is arm or aarch # If the machine is arm or aarch
if [[ ${machine} == arm* || ${machine} == *aarch* ]]; then if [[ "${machine}" == "arm"* || "${machine}" == *"aarch"* ]]; then
# ARM # ARM
# #
local rev=$(uname -m | sed "s/[^0-9]//g;") local rev
rev=$(uname -m | sed "s/[^0-9]//g;")
# #
local lib=$(ldd /bin/ls | grep -E '^\s*/lib' | awk '{ print $1 }') local lib
lib=$(ldd /bin/ls | grep -E '^\s*/lib' | awk '{ print $1 }')
# #
if [[ "$lib" == "/lib/ld-linux-aarch64.so.1" ]]; then if [[ "${lib}" == "/lib/ld-linux-aarch64.so.1" ]]; then
echo -e "${OVER} ${TICK} Detected ARM-aarch64 architecture" echo -e "${OVER} ${TICK} Detected ARM-aarch64 architecture"
# set the binary to be used # set the binary to be used
binary="pihole-FTL-aarch64-linux-gnu" binary="pihole-FTL-aarch64-linux-gnu"
# #
elif [[ "$lib" == "/lib/ld-linux-armhf.so.3" ]]; then elif [[ "${lib}" == "/lib/ld-linux-armhf.so.3" ]]; then
# #
if [ "$rev" -gt "6" ]; then if [[ "${rev}" -gt 6 ]]; then
echo -e "${OVER} ${TICK} Detected ARM-hf architecture (armv7+)" echo -e "${OVER} ${TICK} Detected ARM-hf architecture (armv7+)"
# set the binary to be used # set the binary to be used
binary="pihole-FTL-arm-linux-gnueabihf" binary="pihole-FTL-arm-linux-gnueabihf"
@ -1853,22 +1849,22 @@ FTLdetect() {
# set the binary to be used # set the binary to be used
binary="pihole-FTL-arm-linux-gnueabi" binary="pihole-FTL-arm-linux-gnueabi"
fi fi
elif [[ $machine == ppc ]]; then elif [[ "${machine}" == "ppc" ]]; then
# PowerPC # PowerPC
echo "::: Detected PowerPC architecture" echo -e "${OVER} ${TICK} Detected PowerPC architecture"
# set the binary to be used # set the binary to be used
binary="pihole-FTL-powerpc-linux-gnu" binary="pihole-FTL-powerpc-linux-gnu"
elif [[ ${machine} == x86_64 ]]; then elif [[ "${machine}" == "x86_64" ]]; then
# 64bit # 64bit
echo -e "${OVER} ${TICK} Detected x86_64 architecture" echo -e "${OVER} ${TICK} Detected x86_64 architecture"
# set the binary to be used # set the binary to be used
binary="pihole-FTL-linux-x86_64" binary="pihole-FTL-linux-x86_64"
else else
# Something else - we try to use 32bit executable and warn the user # Something else - we try to use 32bit executable and warn the user
if [[ ! ${machine} == i686 ]]; then if [[ ! "${machine}" == "i686" ]]; then
echo -e "${OVER} ${CROSS} ${str}... echo -e "${OVER} ${CROSS} ${str}...
${COL_LIGHT_RED}Not able to detect architecture (unknown: ${machine}), trying 32bit executable ${COL_LIGHT_RED}Not able to detect architecture (unknown: ${machine}), trying 32bit executable${COL_NC}
Contact support if you experience issues (e.g: FTL not running)${COL_NC}" Contact Pi-hole Support if you experience issues (e.g: FTL not running)"
else else
echo -e "${OVER} ${TICK} Detected 32bit (i686) architecture" echo -e "${OVER} ${TICK} Detected 32bit (i686) architecture"
fi fi
@ -1910,7 +1906,6 @@ FTLdetect() {
} }
main() { main() {
######## FIRST CHECK ######## ######## FIRST CHECK ########
# Show the Pi-hole logo so people know it's genuine since the logo and name are trademarked # Show the Pi-hole logo so people know it's genuine since the logo and name are trademarked
show_ascii_berry show_ascii_berry
@ -1919,18 +1914,17 @@ main() {
echo "" echo ""
# If the user's id is zero, # If the user's id is zero,
if [[ ${EUID} -eq 0 ]]; then if [[ "${EUID}" -eq 0 ]]; then
# they are root and all is good # they are root and all is good
echo -e " ${TICK} ${str}" echo -e " ${TICK} ${str}"
# Otherwise, # Otherwise,
else else
# They do not have enough privileges, so let the user know # They do not have enough privileges, so let the user know
echo -e " ${CROSS} ${str} echo -e " ${CROSS} ${str}
Script called with non-root privileges ${COL_LIGHT_RED}Script called with non-root privileges${COL_NC}
The Pi-hole requires elevated privleges to install and run The Pi-hole requires elevated privleges to install and run
Please check the installer for any concerns regarding this requirement Please check the installer for any concerns regarding this requirement
Make sure to download this script from a trusted source" Make sure to download this script from a trusted source\\n"
echo ""
echo -ne " ${INFO} Sudo utility check" echo -ne " ${INFO} Sudo utility check"
# If the sudo command exists, # If the sudo command exists,
@ -1943,7 +1937,7 @@ main() {
else else
# Let them know they need to run it as root # Let them know they need to run it as root
echo -e "${OVER} ${CROSS} Sudo utility check echo -e "${OVER} ${CROSS} Sudo utility check
Sudo is needed for the Web Interface to run pihole commands\n Sudo is needed for the Web Interface to run pihole commands\\n
${COL_LIGHT_RED}Please re-run this installer as root${COL_NC}" ${COL_LIGHT_RED}Please re-run this installer as root${COL_NC}"
exit 1 exit 1
fi fi
@ -1962,7 +1956,7 @@ main() {
done done
# If the setup variable file exists, # If the setup variable file exists,
if [[ -f ${setupVars} ]]; then if [[ -f "${setupVars}" ]]; then
# if it's running unattended, # if it's running unattended,
if [[ "${runUnattended}" == true ]]; then if [[ "${runUnattended}" == true ]]; then
echo -e " ${INFO} Performing unattended setup, no whiptail dialogs will be displayed" echo -e " ${INFO} Performing unattended setup, no whiptail dialogs will be displayed"
@ -1995,15 +1989,14 @@ main() {
# Check if SELinux is Enforcing # Check if SELinux is Enforcing
checkSelinux checkSelinux
if [[ "${useUpdateVars}" == false ]]; then
if [[ ${useUpdateVars} == false ]]; then
# Display welcome dialogs # Display welcome dialogs
welcomeDialogs welcomeDialogs
# Create directory for Pi-hole storage # Create directory for Pi-hole storage
mkdir -p /etc/pihole/ mkdir -p /etc/pihole/
stop_service dnsmasq stop_service dnsmasq
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
stop_service lighttpd stop_service lighttpd
fi fi
# Determine available interfaces # Determine available interfaces
@ -2022,7 +2015,7 @@ main() {
clone_or_update_repos clone_or_update_repos
# Install packages used by the Pi-hole # Install packages used by the Pi-hole
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# Install the Web dependencies # Install the Web dependencies
DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}") DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}")
# Otherwise, # Otherwise,
@ -2046,11 +2039,11 @@ main() {
# Clone/Update the repos # Clone/Update the repos
clone_or_update_repos clone_or_update_repos
# Source ${setupVars} for use in the rest of the functions. # Source ${setupVars} for use in the rest of the functions
source ${setupVars} source ${setupVars}
# Install packages used by the Pi-hole # Install packages used by the Pi-hole
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# Install the Web dependencies # Install the Web dependencies
DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}") DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}")
# Otherwise, # Otherwise,
@ -2074,13 +2067,14 @@ main() {
# Move the log file into /etc/pihole for storage # Move the log file into /etc/pihole for storage
mv ${tmpLog} ${instalLogLoc} mv ${tmpLog} ${instalLogLoc}
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# Add password to web UI if there is none # Add password to web UI if there is none
pw="" pw=""
# If no password is set, # If no password is set,
if [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) == 0 ]] ; then if [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) == 0 ]] ; then
# generate a random password # generate a random password
pw=$(tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c 8) pw=$(tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c 8)
# shellcheck disable=SC1091
. /opt/pihole/webpage.sh . /opt/pihole/webpage.sh
echo "WEBPASSWORD=$(HashPassword ${pw})" >> ${setupVars} echo "WEBPASSWORD=$(HashPassword ${pw})" >> ${setupVars}
fi fi
@ -2115,20 +2109,19 @@ main() {
fi fi
# If the Web interface was installed, # If the Web interface was installed,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
# If there is a password, # If there is a password,
if (( ${#pw} > 0 )) ; then if (( ${#pw} > 0 )) ; then
# display the password # display the password
echo -e " ${INFO} Web Interface password: ${COL_LIGHT_GREEN}${pw}${COL_NC} echo -e " ${INFO} Web Interface password: ${COL_LIGHT_GREEN}${pw}${COL_NC}
This can be changed using 'pihole -a -p'" This can be changed using 'pihole -a -p'\\n"
echo ""
fi fi
fi fi
# #
if [[ "${useUpdateVars}" == false ]]; then if [[ "${useUpdateVars}" == false ]]; then
# If the Web interface was installed, # If the Web interface was installed,
if [[ ${INSTALL_WEB} == true ]]; then if [[ "${INSTALL_WEB}" == true ]]; then
echo -e " View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin" echo -e " View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin"
echo "" echo ""
fi fi
@ -2145,7 +2138,7 @@ main() {
fi fi
# Display where the log file is # Display where the log file is
echo -e "\n ${INFO} The install log is located at: /etc/pihole/install.log echo -e "\\n ${INFO} The install log is located at: /etc/pihole/install.log
${COL_LIGHT_GREEN}${INSTALL_TYPE} Complete! ${COL_NC}" ${COL_LIGHT_GREEN}${INSTALL_TYPE} Complete! ${COL_NC}"
} }

6
test/test_automated_install.py
View file

@ -80,7 +80,7 @@ def test_configureFirewall_firewalld_running_no_errors(Pihole):
source /opt/pihole/basic-install.sh source /opt/pihole/basic-install.sh
configureFirewall configureFirewall
''') ''')
expected_stdout = 'Configuring FirewallD for httpd and dnsmasq.' expected_stdout = 'Configuring FirewallD for httpd and dnsmasq'
assert expected_stdout in configureFirewall.stdout assert expected_stdout in configureFirewall.stdout
firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
assert 'firewall-cmd --state' in firewall_calls assert 'firewall-cmd --state' in firewall_calls
@ -95,7 +95,7 @@ def test_configureFirewall_firewalld_disabled_no_errors(Pihole):
source /opt/pihole/basic-install.sh source /opt/pihole/basic-install.sh
configureFirewall configureFirewall
''') ''')
expected_stdout = 'No active firewall detected.. skipping firewall configuration.' expected_stdout = 'No active firewall detected.. skipping firewall configuration'
assert expected_stdout in configureFirewall.stdout assert expected_stdout in configureFirewall.stdout
def test_configureFirewall_firewalld_enabled_declined_no_errors(Pihole): def test_configureFirewall_firewalld_enabled_declined_no_errors(Pihole):
@ -444,7 +444,7 @@ def test_IPv6_only_link_local(Pihole):
source /opt/pihole/basic-install.sh source /opt/pihole/basic-install.sh
useIPv6dialog useIPv6dialog
''') ''')
expected_stdout = 'Found neither IPv6 ULA nor GUA address, blocking IPv6 ads will not be enabled' expected_stdout = 'Unable to find IPv6 ULA/GUA address, IPv6 adblocking will not be enabled'
assert expected_stdout in detectPlatform.stdout assert expected_stdout in detectPlatform.stdout
def test_IPv6_only_ULA(Pihole): def test_IPv6_only_ULA(Pihole):