kyle/kp-pihole-sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update pihole-sync

Browse Source
This commit is contained in:
David Schroeder
2024-02-26 08:45:29 -06:00
parent c03bf9d1a8
commit dc41b5b907
1 changed files with 187 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
pihole-sync
View File

@@ -6,9 +6,11 @@
# Steve Jenkins (stevejenkins.com) # Steve Jenkins (stevejenkins.com)
# https://github.com/stevejenkins/pihole-cloudsync # https://github.com/stevejenkins/pihole-cloudsync
# Extended by Michael Gamlem III (michael@mgamlem3.com)
# https://github.com/mgamlem3/pihole-cloudsync
version='5.0' version='5.1.2'
update='December 26, 2020' update='July 2022'
# SETUP # SETUP
# Follow the instructions in the README to set up your own private Git # Follow the instructions in the README to set up your own private Git
@@ -22,6 +24,8 @@ update='December 26, 2020'
# --initpull Initialize Secondary Pi-hole in "Pull" mode # --initpull Initialize Secondary Pi-hole in "Pull" mode
# --push, --upload, --up, -u Push (upload) your Pi-hole lists to a remote Git repo # --push, --upload, --up, -u Push (upload) your Pi-hole lists to a remote Git repo
# --pull, --download, --down, -d Pull (download) your lists from a remote Git repo # --pull, --download, --down, -d Pull (download) your lists from a remote Git repo
# --setupcronpush Setup cronjob to push daily
# --setupcronpull Setup cronjob to pull daily
# --help, -h, -? Show the current version of pihole-cloudsync # --help, -h, -? Show the current version of pihole-cloudsync
# --version, -v Show version number # --version, -v Show version number
@@ -32,202 +36,201 @@ update='December 26, 2020'
# Project Home: https://github.com/stevejenkins/pihole-cloudsync # Project Home: https://github.com/stevejenkins/pihole-cloudsync
########################################################################### ###########################################################################
# CONSTANTS # CONSTANTS
if [ -f "/opt/my-pihole-sync/pihole-sync" ]; then personal_git_dir='/usr/local/bin/my-pihole-lists'
personal_git_dir='/opt/my-pihole-sync' pihole_dir='/etc/pihole'
elif [ -f "/etc/pihole/my-pihole-sync/pihole-sync" ]; then gravity_db='/etc/pihole/gravity.db'
personal_git_dir='/etc/pihole/my-pihole-sync' dnsmasq_dir='/etc/dnsmasq.d/'
else
personal_git_dir='/usr/local/bin/my-pihole-sync'
fi
# if [ -d "/opt/docker-pi-hole/etc-pihole" ]; then
# pihole_dir='/opt/docker-pi-hole/etc-pihole'
# gravity_db='/opt/docker-pi-hole/etc-pihole/gravity.db'
# dnsmasq_dir='/opt/docker-pi-hole/etc-dnsmasq.d/'
# else
pihole_dir='/etc/pihole'
gravity_db='/etc/pihole/gravity.db'
dnsmasq_dir='/etc/dnsmasq.d/'
# fi
ad_list='adlist.csv' ad_list='adlist.csv'
custom_list='custom.list' custom_list='custom.list'
domain_list='domainlist.csv' domain_list='domainlist.csv'
cname_list='05-pihole-custom-cname.conf' cname_list='05-pihole-custom-cname.conf'
localdomains_list='02-local-domains.conf'
########################################################################### ###########################################################################
# SHOULDN'T NEED TO EDIT BELOW THIS LINE # SHOULDN'T NEED TO EDIT BELOW THIS LINE
# Force sudo if not running with root privileges # Force sudo if not running with root privileges
SUDO='' SUDO=''
if [ "$EUID" -ne 0 ] if [ "$EUID" -ne 0 ]; then
then SUDO='sudo' SUDO='sudo'
fi fi
# FUNCTIONS # FUNCTIONS
push_initialize () { push_initialize() {
# Go to Pi-hole directory, exit if doesn't exist # Go to Pi-hole directory, exit if doesn't exist
cd $pihole_dir || exit cd $pihole_dir || exit
# Verify Custom and CNAME lists exist # Verify Custom and CNAME lists exist
touch $custom_list $SUDO touch $custom_list
touch $dnsmasq_dir/$cname_list $SUDO touch $dnsmasq_dir/$cname_list
# touch $dnsmasq_dir/$localdomains_list
# Copy local Custom and CNAME lists to local Git repo # Copy local Custom and CNAME lists to local Git repo
cp $custom_list $personal_git_dir $SUDO cp $custom_list $personal_git_dir
cp $dnsmasq_dir/$cname_list $personal_git_dir $SUDO cp $dnsmasq_dir/$cname_list $personal_git_dir
# Go to local Git repo directory # Go to local Git repo directory
cd $personal_git_dir || exit cd $personal_git_dir || exit
# Export Ad and Domain lists from Gravity database # Export Ad and Domain lists from Gravity database
sqlite3 $gravity_db -header -csv "SELECT * FROM adlist" >$ad_list $SUDO sqlite3 $gravity_db -header -csv "SELECT * FROM adlist" >$ad_list
sqlite3 $gravity_db -header -csv "SELECT * FROM domainlist" >$domain_list $SUDO sqlite3 $gravity_db -header -csv "SELECT * FROM domainlist" >$domain_list
# Add all lists to local Git repo # Add all lists to local Git repo
git add . $SUDO git add .
echo "Local Pi-hole initialized in Push mode and local lists were added to local Git repo. Run 'pihole-cloudsync --push' to push to remote Git repo."; echo "Local Pi-hole initialized in Push mode and local lists were added to local Git repo. Run 'pihole-cloudsync --push' to push to remote Git repo."
} }
pull_initialize () { pull_initialize() {
# Go to Pi-hole directory, exit if doesn't exist # Go to Pi-hole directory, exit if doesn't exist
cd $personal_git_dir || exit cd $personal_git_dir || exit
# Update local Git repo from remote Git repo # Update local Git repo from remote Git repo
git remote update > /dev/null $SUDO git remote update >/dev/null
# Remove -q option if you don't want to run in "quiet" mode # Remove -q option if you don't want to run in "quiet" mode
git fetch --all -q $SUDO git fetch --all -q
git reset --hard origin/main -q $SUDO git reset --hard origin/master -q
# Stop DNS server # Stop DNS server
$SUDO service pihole-FTL stop $SUDO service pihole-FTL stop
# Overwrite local files # Overwrite local files
cp $custom_list $pihole_dir $SUDO cp $custom_list $pihole_dir
cp $cname_list $dnsmasq_dir $SUDO cp $cname_list $dnsmasq_dir
# if [[ $(/sbin/ip -o -4 addr list eth0 | awk '{print $4}' | cut -d/ -f1) != *"10.10.10.11"* ]]; then
# cp $localdomains_list $dnsmasq_dir
# fi
# Overwrite local database tables # Overwrite local database tables
sqlite3 $gravity_db "DROP TABLE adlist;" $SUDO sqlite3 $gravity_db "DELETE FROM adlist;"
sqlite3 $gravity_db -header -csv ".import adlist.csv adlist" $SUDO sqlite3 $gravity_db -header -csv ".import --skip 1 adlist.csv adlist"
sqlite3 $gravity_db "DROP TABLE domainlist;"
sqlite3 $gravity_db -header -csv ".import domainlist.csv domainlist" if [ -s domainlist.csv ]; then
$SUDO sqlite3 $gravity_db "DELETE FROM domainlist;"
$SUDO sqlite3 $gravity_db -header -csv ".import --skip 1 domainlist.csv domainlist"
fi
# Restart Pi-hole to pick up changes # Restart Pi-hole to pick up changes
$SUDO pihole -g $SUDO pihole -g
# Display success messages # Display success messages
echo "Local Pi-hole initialized in Pull mode and first pull successfully completed."; echo "Local Pi-hole initialized in Pull mode and first pull successfully completed."
echo "Future pulls can now be perfomed with 'pihole-cloudsync --pull'."; echo "Future pulls can now be perfomed with 'pihole-cloudsync --pull'."
} }
push () { push() {
# Go to Pi-hole directory, exit if doesn't exist # Go to Pi-hole directory, exit if doesn't exist
cd $pihole_dir || exit cd $pihole_dir || exit
# Copy local Custom and CNAME lists to local Git repo # Copy local Custom and CNAME lists to local Git repo
cp $custom_list $personal_git_dir $SUDO cp $custom_list $personal_git_dir
cp $dnsmasq_dir/$cname_list $personal_git_dir $SUDO cp $dnsmasq_dir/$cname_list $personal_git_dir
# cp $dnsmasq_dir/$localdomains_list $personal_git_dir
# Go to local Git repo directory # Go to local Git repo directory
cd $personal_git_dir || exit cd $personal_git_dir || exit
# Export Ad and Domain lists from Gravity database # Export Ad and Domain lists from Gravity database
sqlite3 $gravity_db -header -csv "SELECT * FROM adlist" >$ad_list $SUDO sqlite3 $gravity_db -header -csv "SELECT * FROM adlist" >$ad_list
sqlite3 $gravity_db -header -csv "SELECT * FROM domainlist" >$domain_list $SUDO sqlite3 $gravity_db -header -csv "SELECT * FROM domainlist" >$domain_list
# Compare local files to remote Git repo # Compare local files to remote Git repo
git remote update > /dev/null $SUDO git remote update >/dev/null
# If local files are different than remote, update remote Git repo # If local files are different than remote, update remote Git repo
CHANGED=$(git --work-tree=$personal_git_dir status --porcelain) CHANGED=$($SUDO git --work-tree=$personal_git_dir status --porcelain)
if [ -n "${CHANGED}" ]; then if [ -n "${CHANGED}" ]; then
echo 'Local Pi-hole lists are different than remote Git repo. Updating remote repo...'; echo 'Local Pi-hole lists are different than remote Git repo. Updating remote repo...'
rightnow=$(date +"%B %e, %Y %l:%M%p") rightnow=$(date +"%B %e, %Y %l:%M%p")
# Remove -q option if you don't want to run in "quiet" mode # Remove -q option if you don't want to run in "quiet" mode
git commit -a -m "Updated $rightnow" -q $SUDO git commit -a -m "Updated $rightnow" -q
git push -q $SUDO git push -q
echo 'Done!'; echo 'Done!'
exit 0 exit 0
else else
# If local files are the same as remote, do nothing and exit # If local files are the same as remote, do nothing and exit
echo 'Remote Git repo matches local Pi-hole lists. No further action required.'; echo 'Remote Git repo matches local Pi-hole lists. No further action required.'
exit 0 exit 0
fi fi
} }
pull () { pull() {
# Go to Pi-hole directory, exit if doesn't exist # Go to Pi-hole directory, exit if doesn't exist
cd $personal_git_dir || exit cd $personal_git_dir || exit
# Update local Git repo from remote Git repo # Update local Git repo from remote Git repo
git remote update > /dev/null $SUDO git remote update >/dev/null
CHANGED=$(git log HEAD..origin/main --oneline) CHANGED=$($SUDO git log HEAD..origin/master --oneline)
if [ -n "${CHANGED}" ]; then if [ -n "${CHANGED}" ]; then
echo 'Remote Git repo is different than local Pi-hole lists. Updating local lists...'; echo 'Remote Git repo is different than local Pi-hole lists. Updating local lists...'
git fetch --all -q # Remove -q option if you don't want to run in "quiet" mode
git reset --hard origin/main -q $SUDO git fetch --all -q
$SUDO git reset --hard origin/master -q
$SUDO service pihole-FTL stop $SUDO service pihole-FTL stop
cp $custom_list $pihole_dir $SUDO cp $custom_list $pihole_dir
cp $cname_list $dnsmasq_dir $SUDO cp $cname_list $dnsmasq_dir
# if [[ $(/sbin/ip -o -4 addr list eth0 | awk '{print $4}' | cut -d/ -f1) != *"10.10.10.11"* ]]; then $SUDO sqlite3 $gravity_db "DELETE FROM adlist;"
# cp $localdomains_list $dnsmasq_dir $SUDO sqlite3 $gravity_db -header -csv ".import --skip 1 adlist.csv adlist"
# fi
sqlite3 $gravity_db "DROP TABLE adlist;" if [ -s domainlist.csv ]; then
sqlite3 $gravity_db -header -csv ".import adlist.csv adlist" $SUDO sqlite3 $gravity_db "DELETE FROM domainlist;"
sqlite3 $gravity_db "DROP TABLE domainlist;" $SUDO sqlite3 $gravity_db -header -csv ".import --skip 1 domainlist.csv domainlist"
sqlite3 $gravity_db -header -csv ".import domainlist.csv domainlist" fi
$SUDO pihole -g $SUDO pihole -g
echo 'Done!'; echo 'Done!'
exit 0 exit 0
else else
echo 'Local Pi-hole lists match remote Git repo. No further action required.'; echo 'Local Pi-hole lists match remote Git repo. No further action required.'
exit 0 exit 0
fi fi
} }
setup_cron_push() {
echo "Setting cron job for push"
(
crontab -l
echo "00 01,07,13,19 * * * sudo /usr/local/bin/pihole-cloudsync/pihole-cloudsync --push > /dev/null 2>&1"
) | crontab
exit 0
}
setup_cron_pull() {
echo "Setting cron job for pull"
(
crontab -l
echo "05 01,07,13,19 * * * sudo /usr/local/bin/pihole-cloudsync/pihole-cloudsync --pull > /dev/null 2>&1"
) | crontab
exit 0
}
########################################################################### ###########################################################################
# Check to see whether a command line option was provided # Check to see whether a command line option was provided
if [ -z "$1" ] if [ -z "$1" ]; then
then
echo "Missing command line option. Try --push, --pull, or --help." echo "Missing command line option. Try --push, --pull, or --help."
exit 1 exit 1
fi fi
# Determine which action to perform (InitPush, InitPull, Push, Pull, or Help) # Determine which action to perform (InitPush, InitPull, Push, Pull, or Help)
for arg in "$@" for arg in "$@"; do
do
# Initialize - adds primary Pi-hole's lists to local Git repo before first push/upload # Initialize - adds primary Pi-hole's lists to local Git repo before first push/upload
if [ "$arg" == "--initpush" ] if [ "$arg" == "--initpush" ]; then
then echo "$arg option detected. Initializing local Git repo for Push/Upload."
echo "$arg option detected. Initializing local Git repo for Push/Upload.";
push_initialize push_initialize
exit 0 exit 0
# Initialize - adds primary Pi-hole's lists to local Git repo before first push/upload # Initialize - adds primary Pi-hole's lists to local Git repo before first push/upload
elif [ "$arg" == "--initpull" ] elif [ "$arg" == "--initpull" ]; then
then echo "$arg option detected. Initializing local Git repo for Pull/Download."
echo "$arg option detected. Initializing local Git repo for Pull/Download.";
pull_initialize pull_initialize
exit 0 exit 0
# Push / Upload - Pushes updated local Pi-hole lists to remote Git repo # Push / Upload - Pushes updated local Pi-hole lists to remote Git repo
elif [ "$arg" == "--push" ] || [ "$arg" == "--upload" ] || [ "$arg" == "--up" ] || [ "$arg" == "-u" ] elif [ "$arg" == "--push" ] || [ "$arg" == "--upload" ] || [ "$arg" == "--up" ] || [ "$arg" == "-u" ]; then
then
echo "$arg option detected. Running in Push/Upload mode." echo "$arg option detected. Running in Push/Upload mode."
push push
exit 0 exit 0
# Pull / Download - Pulls updated Pi-hole lists from remote Git repo # Pull / Download - Pulls updated Pi-hole lists from remote Git repo
elif [ "$arg" == "--pull" ] || [ "$arg" == "--download" ] || [ "$arg" == "--down" ]|| [ "$arg" == "-d" ] elif [ "$arg" == "--pull" ] || [ "$arg" == "--download" ] || [ "$arg" == "--down" ] || [ "$arg" == "-d" ]; then
then
echo "$arg option detected. Running in Pull/Download mode." echo "$arg option detected. Running in Pull/Download mode."
pull pull
exit 0 exit 0
elif [ "$arg" == "--setupcronpush" ]; then
echo "$arg option detected."
setup_cron_push
exit 0
elif [ "$arg" == "--setupcronpull" ]; then
echo "$arg option detected."
setup_cron_pull
exit 0
# Help - Displays help dialog # Help - Displays help dialog
elif [ "$arg" == "--help" ] || [ "$arg" == "-h" ] || [ "$arg" == "-?" ] elif [ "$arg" == "--help" ] || [ "$arg" == "-h" ] || [ "$arg" == "-?" ]; then
then cat <<EOF
cat << EOF
Usage: pihole-cloudsync <option> Usage: pihole-cloudsync <option>
Options: Options:
@@ -246,10 +249,9 @@ Project Home: https://github.com/stevejenkins/pihole-cloudsync
EOF EOF
# Version - Displays version number # Version - Displays version number
elif [ "$arg" == "--version" ] || [ "$arg" == "-v" ] elif [ "$arg" == "--version" ] || [ "$arg" == "-v" ]; then
then echo 'pihole-cloudsync v'$version' - Updated '"$update"
echo 'pihole-cloudsync v'$version' - Updated '"$update"; echo 'https://github.com/stevejenkins/pihole-cloudsync'
echo 'https://github.com/stevejenkins/pihole-cloudsync';
# Invalid command line option was passed # Invalid command line option was passed
else else