-
Notifications
You must be signed in to change notification settings - Fork 5
/
piholesync.rsync.sh
executable file
·106 lines (97 loc) · 5.41 KB
/
piholesync.rsync.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
#!/bin/bash -x
# shellcheck disable=SC2086
# README
#Version 2.1
#-----------------------------
#Credit to redditor /u/jvinch76 https://www.reddit.com/user/jvinch76 for creating the basis for this modification.
#-----------------------------
#Original Source https://www.reddit.com/r/pihole/comments/9gw6hx/sync_two_piholes_bash_script/
#Previous Pastebin https://pastebin.com/KFzg7Uhi
#-----------------------------
#Reddit link https://www.reddit.com/r/pihole/comments/9hi5ls/dual_pihole_sync_20/
#-----------------------------
#Improvements: check for existence of files before rsync and skip if not present, allow for remote command to be run without password by adding ssh keys to remote host no no longer require hard coding password in this script, HAPASS removed
#-----------------------------
#
#I had been thinking of a script like his to keep my primary and secondary pihole in sync, but could not find the motivation to create it.
#/u/jvinch76 did the heavy lifting and I made changes I hope you find useful.
#
#I modified the code to increase the frequency of the sync to every 5 minutes and reduce the file writes by using rsync to compare the files and only transfer changes.
#Furthermore, gravity will be updated and services restarted only if files are modified and a sync occurs.
#
#I am unsure of the performance cost, but it is likely there is a trade-off with rsync being more cpu heavy, but this script reduces the disk write to minimal amounts if no sync is necessary.
#
#Why run dual piholes?
#If you are not, you really, really should be. If the primary pihole is being updated, undergoing maintenance, running a backup, or simply failed you will not have a backup pihole available.
#This will happen on your network. Your only other option during an outage (usually unexpected) is to configure your DHCP server to forward to a non-pihole, public DNS, thusly defeating why you have pihole installed in the first place.
#Furthermore, DNS is high availability by design and the secondary\tertiary DNS always receives some portion of the DNS traffic and if configured with a public DNS IP, your devices will be bypassing the safety of pihole blocking.
#If you are running a single pihole and have that pihole listed as the only DNS entry in your DHCP setting, all devices on your network will immediately be unable to resolve DNS if that pihole goes offline.
#I recommend running a PI3 as your primary and a PI3/PI2/ZeroW as your secondary. PI2/ZeroW is more than sufficient as a secondary and emergency failover.
#
#What about using my pihole for DHCP?
#I still prefer to use my router for DHCP, if you need help refer to /u/jvinch76 post https://www.reddit.com/r/pihole/comments/9gw6hx/sync_two_piholes_bash_script/
#or other docs about using pihole for DHCP with this script.
#
#/u/LandlordTiberius
# INSTALLATION STEPS ON PRIMARY PIHOLE
#1. Login to pihole
#2. type "SUDO NANO ~/piholesync.rsync.sh" to create file
#3. cut and paste all information in this code snippet
#4. edit PIHOLE2 and HAUSER to match your SECONDARY pihole settings
#5. save and exit
#6. type "chmod +x ~/piholesync.rsync.sh" to make file executable
# CREATE SSH file transfer permissions
#7. type "ssh-keygen"
#8. type "ssh-copy-id [email protected]" <- type the same HAUSER and IP as PIHOLE2, this IP is specific to your network, 192.168.101.254 is an example only
#9. type "yes" - YOU MUST TYPE "yes", not "y"
#10. type the password of your secondary pihole
# ENABLE REMOTE COMMANDS USING SSH Keys ON Remote pihole
#11 type "cd ~/.ssh"
#12. type "eval `ssh-agent`" <- this step may not be needed, depending upon what is running on your primary pihole
#13. type "ssh-add id_rsa.pub"
#14. type "scp id_rsa.pub [email protected]:~/.ssh/"
#15. login to secondary pihole (PIHOLE2) by typing "ssh [email protected]"
#16. type "cd ~/.ssh"
#17. type "cat id_rsa.pub >> authorized_keys"
#18. type "exit"
# see https://www.dotkam.com/2009/03/10/run-commands-remotely-via-ssh-with-no-password/ for further information on running ssh commands remotely without a password.
# INSTALL CRON Job
#19. type "crontab -e"
#20. scroll to the bottom of the editor, and on a new blank line,
#21. type "*/5 * * * * /bin/bash /root/piholesync.rsync.sh" <- this will run rsync every 5 minutes, edit per your preferences\tolerence, see https://crontab.guru/every-5-minutes for help
#22. save and exit
#VARS
FILES=(black.list blacklist.txt regex.list whitelist.txt lan.list pihole-FTL.conf) #list of files you want to sync
PIHOLEDIR=/etc/pihole #working dir of pihole
PIHOLE2=192.168.101.254 #IP of 2nd PiHole
HAUSER=root #user of second pihole
#LOOP FOR FILE TRANSFER
RESTART=0 # flag determine if service restart is needed
for FILE in "${FILES[@]}"
do
if [[ -f $PIHOLEDIR/$FILE ]]; then
RSYNC_COMMAND=$(rsync -ai $PIHOLEDIR/$FILE $HAUSER@$PIHOLE2:$PIHOLEDIR)
if [[ -n "${RSYNC_COMMAND}" ]]; then
# rsync copied changes
RESTART=1 # restart flagged
# else
# no changes
fi
# else
# file does not exist, skipping
fi
done
FILE="adlists.list"
RSYNC_COMMAND=$(rsync -ai $PIHOLEDIR/$FILE $HAUSER@$PIHOLE2:$PIHOLEDIR)
if [[ -n "${RSYNC_COMMAND}" ]]; then
# rsync copied changes, update GRAVITY
ssh $HAUSER@$PIHOLE2 "sudo -S pihole -g"
# else
# no changes
fi
if [ $RESTART == "1" ]; then
# INSTALL FILES AND RESTART pihole
ssh $HAUSER@$PIHOLE2 "sudo -S service pihole-FTL stop"
ssh $HAUSER@$PIHOLE2 "sudo -S pkill pihole-FTL"
ssh $HAUSER@$PIHOLE2 "sudo -S service pihole-FTL start"
fi