mirror of
https://github.com/pi-hole/pi-hole.git
synced 2025-09-15 13:21:15 +08:00
uninstall refactor and improvement (#6339)
This commit is contained in:
Adam Warner
@ -1333,9 +1333,10 @@ disable_service() {
|
||||
# If systemctl exists,
|
||||
if is_command systemctl; then
|
||||
# use that to disable the service
|
||||
systemctl -q disable "${1}"
|
||||
systemctl -q disable --now "${1}"
|
||||
elif is_command openrc; then
|
||||
rc-update del "${1}" "${2:-default}" &> /dev/null
|
||||
|
||||
else
|
||||
# Otherwise, use update-rc.d to accomplish this
|
||||
update-rc.d "${1}" disable >/dev/null
|
||||
|
||||
@ -12,9 +12,7 @@
|
||||
source "/opt/pihole/COL_TABLE"
|
||||
# shellcheck source="./advanced/Scripts/utils.sh"
|
||||
source "/opt/pihole/utils.sh"
|
||||
|
||||
ADMIN_INTERFACE_DIR=$(getFTLConfigValue "webserver.paths.webroot")$(getFTLConfigValue "webserver.paths.webhome")
|
||||
readonly ADMIN_INTERFACE_DIR
|
||||
# getFTLConfigValue() from utils.sh
|
||||
|
||||
while true; do
|
||||
read -rp " ${QST} Are you sure you would like to remove ${COL_BOLD}Pi-hole${COL_NC}? [y/N] " answer
|
||||
@ -29,126 +27,179 @@ str="Root user check"
|
||||
if [[ ${EUID} -eq 0 ]]; then
|
||||
echo -e " ${TICK} ${str}"
|
||||
else
|
||||
# Check if sudo is actually installed
|
||||
# If it isn't, exit because the uninstall can not complete
|
||||
if [ -x "$(command -v sudo)" ]; then
|
||||
export SUDO="sudo"
|
||||
else
|
||||
echo -e " ${CROSS} ${str}
|
||||
Script called with non-root privileges
|
||||
The Pi-hole requires elevated privileges to uninstall"
|
||||
exit 1
|
||||
fi
|
||||
echo -e " ${CROSS} ${str}
|
||||
Script called with non-root privileges
|
||||
The Pi-hole requires elevated privileges to uninstall"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
readonly PI_HOLE_FILES_DIR="/etc/.pihole"
|
||||
# Get paths for admin interface, log files and database files,
|
||||
# to allow deletion where user has specified a non-default location
|
||||
ADMIN_INTERFACE_DIR=$(getFTLConfigValue "webserver.paths.webroot")$(getFTLConfigValue "webserver.paths.webhome")
|
||||
FTL_LOG=$(getFTLConfigValue "files.log.ftl")
|
||||
DNSMASQ_LOG=$(getFTLConfigValue "files.log.dnsmasq")
|
||||
WEBSERVER_LOG=$(getFTLConfigValue "files.log.webserver")
|
||||
PIHOLE_DB=$(getFTLConfigValue "files.database")
|
||||
GRAVITY_DB=$(getFTLConfigValue "files.gravity")
|
||||
MACVENDOR_DB=$(getFTLConfigValue "files.macvendor")
|
||||
|
||||
PI_HOLE_LOCAL_REPO="/etc/.pihole"
|
||||
# Setting SKIP_INSTALL="true" to source the installer functions without running them
|
||||
SKIP_INSTALL="true"
|
||||
# shellcheck source="./automated install/basic-install.sh"
|
||||
source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
|
||||
|
||||
# package_manager_detect() sourced from basic-install.sh
|
||||
package_manager_detect
|
||||
|
||||
source "${PI_HOLE_LOCAL_REPO}/automated install/basic-install.sh"
|
||||
# Functions and Variables sources from basic-install:
|
||||
# package_manager_detect(), disable_service(), stop_service(),
|
||||
# restart service() and is_command()
|
||||
# PI_HOLE_CONFIG_DIR PI_HOLE_INSTALL_DIR PI_HOLE_LOCAL_REPO
|
||||
|
||||
removeMetaPackage() {
|
||||
# Purge Pi-hole meta package
|
||||
echo ""
|
||||
echo -ne " ${INFO} Removing Pi-hole meta package...";
|
||||
eval "${SUDO}" "${PKG_REMOVE}" "pihole-meta" &> /dev/null;
|
||||
eval "${PKG_REMOVE}" "pihole-meta" &> /dev/null;
|
||||
echo -e "${OVER} ${INFO} Removed Pi-hole meta package";
|
||||
|
||||
}
|
||||
|
||||
removePiholeFiles() {
|
||||
removeWebInterface() {
|
||||
# Remove the web interface of Pi-hole
|
||||
echo -ne " ${INFO} Removing Web Interface..."
|
||||
${SUDO} rm -rf "${ADMIN_INTERFACE_DIR}" &> /dev/null
|
||||
rm -rf "${ADMIN_INTERFACE_DIR:-/var/www/html/admin/}" &> /dev/null
|
||||
echo -e "${OVER} ${TICK} Removed Web Interface"
|
||||
}
|
||||
|
||||
# Attempt to preserve backwards compatibility with older versions
|
||||
# to guarantee no additional changes were made to /etc/crontab after
|
||||
# the installation of pihole, /etc/crontab.pihole should be permanently
|
||||
# preserved.
|
||||
if [[ -f /etc/crontab.orig ]]; then
|
||||
${SUDO} mv /etc/crontab /etc/crontab.pihole
|
||||
${SUDO} mv /etc/crontab.orig /etc/crontab
|
||||
${SUDO} service cron restart
|
||||
echo -e " ${TICK} Restored the default system cron"
|
||||
fi
|
||||
removeFTL() {
|
||||
# Remove FTL and stop any running FTL service
|
||||
if is_command "pihole-FTL"; then
|
||||
# service stop & disable from basic_install.sh
|
||||
stop_service pihole-FTL
|
||||
disable_service pihole-FTL
|
||||
|
||||
# Attempt to preserve backwards compatibility with older versions
|
||||
if [[ -f /etc/cron.d/pihole ]];then
|
||||
${SUDO} rm -f /etc/cron.d/pihole &> /dev/null
|
||||
echo -e " ${TICK} Removed /etc/cron.d/pihole"
|
||||
fi
|
||||
|
||||
${SUDO} rm -rf /var/log/*pihole* &> /dev/null
|
||||
${SUDO} rm -rf /var/log/pihole/*pihole* &> /dev/null
|
||||
${SUDO} rm -rf /etc/pihole/ &> /dev/null
|
||||
${SUDO} rm -rf /etc/.pihole/ &> /dev/null
|
||||
${SUDO} rm -rf /opt/pihole/ &> /dev/null
|
||||
${SUDO} rm -f /usr/local/bin/pihole &> /dev/null
|
||||
${SUDO} rm -f /etc/bash_completion.d/pihole &> /dev/null
|
||||
${SUDO} rm -f /etc/bash_completion.d/pihole-FTL &> /dev/null
|
||||
${SUDO} rm -f /etc/sudoers.d/pihole &> /dev/null
|
||||
echo -e " ${TICK} Removed config files"
|
||||
|
||||
# Restore Resolved
|
||||
if [[ -e /etc/systemd/resolved.conf.orig ]] || [[ -e /etc/systemd/resolved.conf.d/90-pi-hole-disable-stub-listener.conf ]]; then
|
||||
${SUDO} cp -p /etc/systemd/resolved.conf.orig /etc/systemd/resolved.conf &> /dev/null || true
|
||||
${SUDO} rm -f /etc/systemd/resolved.conf.d/90-pi-hole-disable-stub-listener.conf
|
||||
systemctl reload-or-restart systemd-resolved
|
||||
fi
|
||||
|
||||
# Remove FTL
|
||||
if command -v pihole-FTL &> /dev/null; then
|
||||
echo -ne " ${INFO} Removing pihole-FTL..."
|
||||
if [[ -x "$(command -v systemctl)" ]]; then
|
||||
systemctl stop pihole-FTL
|
||||
else
|
||||
service pihole-FTL stop
|
||||
fi
|
||||
${SUDO} rm -f /etc/systemd/system/pihole-FTL.service
|
||||
rm -f /etc/systemd/system/pihole-FTL.service &> /dev/null
|
||||
if [[ -d '/etc/systemd/system/pihole-FTL.service.d' ]]; then
|
||||
read -rp " ${QST} FTL service override directory /etc/systemd/system/pihole-FTL.service.d detected. Do you wish to remove this from your system? [y/N] " answer
|
||||
case $answer in
|
||||
[yY]*)
|
||||
echo -ne " ${INFO} Removing /etc/systemd/system/pihole-FTL.service.d..."
|
||||
${SUDO} rm -R /etc/systemd/system/pihole-FTL.service.d
|
||||
rm -R /etc/systemd/system/pihole-FTL.service.d &> /dev/null
|
||||
echo -e "${OVER} ${INFO} Removed /etc/systemd/system/pihole-FTL.service.d"
|
||||
;;
|
||||
*) echo -e " ${INFO} Leaving /etc/systemd/system/pihole-FTL.service.d in place.";;
|
||||
esac
|
||||
fi
|
||||
${SUDO} rm -f /etc/init.d/pihole-FTL
|
||||
${SUDO} rm -f /usr/bin/pihole-FTL
|
||||
rm -f /etc/init.d/pihole-FTL &> /dev/null
|
||||
rm -f /usr/bin/pihole-FTL &> /dev/null
|
||||
echo -e "${OVER} ${TICK} Removed pihole-FTL"
|
||||
|
||||
# Force systemd reload after service files are removed
|
||||
if is_command "systemctl"; then
|
||||
echo -ne " ${INFO} Restarting systemd..."
|
||||
systemctl daemon-reload
|
||||
echo -e "${OVER} ${TICK} Restarted systemd..."
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
removeCronFiles() {
|
||||
# Attempt to preserve backwards compatibility with older versions
|
||||
# to guarantee no additional changes were made to /etc/crontab after
|
||||
# the installation of pihole, /etc/crontab.pihole should be permanently
|
||||
# preserved.
|
||||
if [[ -f /etc/crontab.orig ]]; then
|
||||
mv /etc/crontab /etc/crontab.pihole
|
||||
mv /etc/crontab.orig /etc/crontab
|
||||
restart_service cron
|
||||
echo -e " ${TICK} Restored the default system cron"
|
||||
echo -e " ${INFO} A backup of the most recent crontab is saved at /etc/crontab.pihole"
|
||||
fi
|
||||
|
||||
# If the pihole manpage exists, then delete and rebuild man-db
|
||||
# Attempt to preserve backwards compatibility with older versions
|
||||
if [[ -f /etc/cron.d/pihole ]];then
|
||||
rm -f /etc/cron.d/pihole &> /dev/null
|
||||
echo -e " ${TICK} Removed /etc/cron.d/pihole"
|
||||
fi
|
||||
}
|
||||
|
||||
removePiholeFiles() {
|
||||
# Remove databases (including user specified non-default paths)
|
||||
rm -f "${PIHOLE_DB:-/etc/pihole/pihole-FTL.db}" &> /dev/null
|
||||
rm -f "${GRAVITY_DB:-/etc/pihole/gravity.db}" &> /dev/null
|
||||
rm -f "${MACVENDOR_DB:-/etc/pihole/macvendor.db}" &> /dev/null
|
||||
|
||||
# Remove pihole config, repo and local files
|
||||
rm -rf "${PI_HOLE_CONFIG_DIR:-/etc/pihole}" &> /dev/null
|
||||
rm -rf "${PI_HOLE_LOCAL_REPO:-/etc/.pihole}" &> /dev/null
|
||||
rm -rf "${PI_HOLE_INSTALL_DIR:-/opt/pihole}" &> /dev/null
|
||||
|
||||
# Remove log files (including user specified non-default paths)
|
||||
# and rotated logs
|
||||
# Explicitly escape spaces, in case of trailing space in path before wildcard
|
||||
rm -f "$(printf '%q' "${FTL_LOG:-/var/log/pihole/FTL.log}")*" &> /dev/null
|
||||
rm -f "$(printf '%q' "${DNSMASQ_LOG:-/var/log/pihole/pihole.log}")*" &> /dev/null
|
||||
rm -f "$(printf '%q' "${WEBSERVER_LOG:-/var/log/pihole/webserver.log}")*" &> /dev/null
|
||||
|
||||
# remove any remnant log-files from old versions
|
||||
rm -rf /var/log/*pihole* &> /dev/null
|
||||
|
||||
# remove log directory
|
||||
rm -rf /var/log/pihole &> /dev/null
|
||||
|
||||
# remove the pihole command
|
||||
rm -f /usr/local/bin/pihole &> /dev/null
|
||||
|
||||
# remove Pi-hole's bash completion
|
||||
rm -f /etc/bash_completion.d/pihole &> /dev/null
|
||||
rm -f /etc/bash_completion.d/pihole-FTL &> /dev/null
|
||||
|
||||
# Remove pihole from sudoers for compatibility with old versions
|
||||
rm -f /etc/sudoers.d/pihole &> /dev/null
|
||||
|
||||
echo -e " ${TICK} Removed config files"
|
||||
}
|
||||
|
||||
removeManPage() {
|
||||
# If the pihole manpage exists, then delete
|
||||
if [[ -f /usr/local/share/man/man8/pihole.8 ]]; then
|
||||
${SUDO} rm -f /usr/local/share/man/man8/pihole.8 /usr/local/share/man/man8/pihole-FTL.8 /usr/local/share/man/man5/pihole-FTL.conf.5
|
||||
${SUDO} mandb -q &>/dev/null
|
||||
rm -f /usr/local/share/man/man8/pihole.8 /usr/local/share/man/man8/pihole-FTL.8 /usr/local/share/man/man5/pihole-FTL.conf.5
|
||||
# Rebuild man-db if present
|
||||
if is_command "mandb"; then
|
||||
mandb -q &>/dev/null
|
||||
fi
|
||||
echo -e " ${TICK} Removed pihole man page"
|
||||
fi
|
||||
}
|
||||
|
||||
removeUser() {
|
||||
# If the pihole user exists, then remove
|
||||
if id "pihole" &> /dev/null; then
|
||||
if ${SUDO} userdel -r pihole 2> /dev/null; then
|
||||
if userdel -r pihole 2> /dev/null; then
|
||||
echo -e " ${TICK} Removed 'pihole' user"
|
||||
else
|
||||
echo -e " ${CROSS} Unable to remove 'pihole' user"
|
||||
fi
|
||||
fi
|
||||
|
||||
# If the pihole group exists, then remove
|
||||
if getent group "pihole" &> /dev/null; then
|
||||
if ${SUDO} groupdel pihole 2> /dev/null; then
|
||||
if groupdel pihole 2> /dev/null; then
|
||||
echo -e " ${TICK} Removed 'pihole' group"
|
||||
else
|
||||
echo -e " ${CROSS} Unable to remove 'pihole' group"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
restoreResolved() {
|
||||
# Restore Resolved from saved configuration, if present
|
||||
if [[ -e /etc/systemd/resolved.conf.orig ]] || [[ -e /etc/systemd/resolved.conf.d/90-pi-hole-disable-stub-listener.conf ]]; then
|
||||
cp -p /etc/systemd/resolved.conf.orig /etc/systemd/resolved.conf &> /dev/null || true
|
||||
rm -f /etc/systemd/resolved.conf.d/90-pi-hole-disable-stub-listener.conf &> /dev/null
|
||||
systemctl reload-or-restart systemd-resolved
|
||||
fi
|
||||
}
|
||||
|
||||
completionMessage() {
|
||||
echo -e "\\n We're sorry to see you go, but thanks for checking out Pi-hole!
|
||||
If you need help, reach out to us on GitHub, Discourse, Reddit or Twitter
|
||||
Reinstall at any time: ${COL_BOLD}curl -sSL https://install.pi-hole.net | bash${COL_NC}
|
||||
@ -159,5 +210,17 @@ removePiholeFiles() {
|
||||
}
|
||||
|
||||
######### SCRIPT ###########
|
||||
# The ordering here allows clean uninstallation with nothing
|
||||
# removed before anything that depends upon it.
|
||||
# eg removeFTL relies on scripts removed by removePiholeFiles
|
||||
# removeUser relies on commands removed by removeMetaPackage
|
||||
package_manager_detect
|
||||
removeWebInterface
|
||||
removeCronFiles
|
||||
restoreResolved
|
||||
removeManPage
|
||||
removeFTL
|
||||
removeUser
|
||||
removeMetaPackage
|
||||
removePiholeFiles
|
||||
completionMessage
|
||||
|
||||
Reference in New Issue
Block a user