Compare commits

...

301 Commits

Author SHA1 Message Date
Adam Warner
bef0a2fef0 Merge pull request #987 from pi-hole/development
Pi-Hole Core release v2.10
2016-12-21 18:21:59 +00:00
DL6ER
c48e6c91f5 Merge pull request #999 from pi-hole/fix/install_deps_exit
Fix/install deps exit
2016-12-21 16:00:48 +01:00
DL6ER
f082b5ba54 Merge pull request #1001 from pi-hole/cleanup/remove_legacy_detect
Remove v1 legacy detection code.
2016-12-21 13:49:34 +01:00
DL6ER
8841bdd252 Reset the if's 2016-12-21 12:57:02 +01:00
DL6ER
58261098fb We should not call a function that Dan deleted 2016-12-21 12:07:44 +01:00
DL6ER
9432d3035a Merge branch 'development' into cleanup/remove_legacy_detect
Conflicts:
	automated install/basic-install.sh
2016-12-21 12:01:58 +01:00
DL6ER
9907fc2770 Merge branch 'development' into fix/install_deps_exit
Conflicts:
	automated install/basic-install.sh
2016-12-21 11:54:52 +01:00
DL6ER
d42caa8672 Merge pull request #1000 from pi-hole/fix/tab_space
Tabs to spaces and formatting.
2016-12-21 11:41:30 +01:00
Dan Schaper
8117ec8e20 Remove v1 legacy detection code.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-20 17:50:44 -08:00
Dan Schaper
ff2783f9fc Tabs to spaces and formatting.
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 17:22:57 -08:00
Dan Schaper
156a51c945 Remove extra display only variable.
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 17:04:46 -08:00
Dan Schaper
c72ffae4a2 Don't install extra packages (openresolv was installed over resolvconf). No longer need --fix-missing.
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 17:02:51 -08:00
Dan Schaper
7f3b0030ea LF
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 16:47:43 -08:00
Dan Schaper
9a626948f8 Use debconf for Deb/Ubu package installations.
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>

Alphabetic sort of dependency names

Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 16:22:31 -08:00
Dan Schaper
5c43df66a8 Remove spinner function, masked return values.
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 16:22:08 -08:00
Dan Schaper
d0e3c546f8 CRLF to CR (Win to Unix line endings)
Signed-off-by: Dan Schaper <dschaper@ganymeade.com>
2016-12-20 15:00:37 -08:00
DL6ER
a9cb93d801 Merge pull request #998 from pi-hole/LordKelvin
Lord Kelvin
2016-12-20 17:54:52 +01:00
DL6ER
ee8f29d178 Fixed typo, extended help text 2016-12-20 16:28:28 +01:00
DL6ER
da363070c7 Added Kelvin 2016-12-20 12:21:08 +01:00
DL6ER
50cf891e01 Merge pull request #996 from pi-hole/allowemptysecondDNSserver
Allow disabling second DNS server
2016-12-19 19:30:27 +01:00
DL6ER
715838cf89 Allow disabling second DNS server 2016-12-19 13:42:42 +01:00
DL6ER
372c699cc6 Merge pull request #993 from pi-hole/fix/one_step_refactor
Rename variables in one step
2016-12-17 00:15:20 +01:00
Dan Schaper
8cb01cdd29 One step to rename variables.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-16 15:08:30 -08:00
Adam Warner
10982a0f45 Merge pull request #990 from pi-hole/dontkillsetupVars.conf
Don't kill setupVars.conf on update/fresh install
2016-12-16 13:55:33 +00:00
DL6ER
d4c378ed5d Remove PIHOLE_INTERFACE if already set (not PIHOLE_DOMAIN) 2016-12-16 13:20:25 +01:00
DL6ER
7872f68a45 Only try to remove parts inthe file if the file already exists 2016-12-16 13:13:35 +01:00
DL6ER
ec8c848106 Don't kill already existing setupVars.conf on update (and fresh install) 2016-12-16 12:53:00 +01:00
Mcat12
3b50ce8c54 Merge pull request #977 from pi-hole/activatewebUIpw
Add password to webUI after update if there is none
2016-12-15 14:05:11 -05:00
DL6ER
1eeaa01234 Always put the information that we added a password if we did (not only on update but also on fresh install) 2016-12-15 15:22:44 +01:00
DL6ER
e2898217d2 Made message shorter 2016-12-15 15:20:41 +01:00
DL6ER
f81dadc5d0 Fix final message 2016-12-15 14:10:55 +01:00
Mcat12
a0019d86c5 Merge pull request #983 from pi-hole/cronpath
Fix missing path information for cron
2016-12-15 07:01:20 -05:00
Adam Warner
4348653431 Merge pull request #985 from pi-hole/pi.hole
A man has no name. Even though his name is Jaqen H'ghar
2016-12-15 08:49:22 +00:00
Dan Schaper
09cfa9bb20 Merge pull request #986 from pi-hole/autoCompletes
add missing pihole autocomplete commands
2016-12-14 12:58:50 -08:00
Promofaux
e7713a9028 add missing pihole autocomplete commands 2016-12-14 19:53:40 +00:00
Promofaux
906a1753be specifically comment out gravity.list addn-host 2016-12-14 19:42:20 +00:00
Promofaux
a3d519b671 no need to remove list, because of echo > 2016-12-14 19:33:15 +00:00
Promofaux
8591f9d576 check for list before removing it 2016-12-14 19:31:57 +00:00
Promofaux
c10ec5548f remove code that replaces tokens in 01-pihole.conf 2016-12-14 19:29:44 +00:00
Promofaux
684ac98c8e Remove hostname and pi.hole entries, move to /etc/pihole/local.list 2016-12-14 19:28:01 +00:00
Promofaux
db89fa9881 initial support for additional hosts file 2016-12-14 19:26:55 +00:00
Adam Warner
9a80421d73 Merge pull request #981 from pi-hole/quiet-dhcp
Improvement of backend of web UI Settings page
2016-12-14 19:11:49 +00:00
Mcat12
2ddacf40c0 Merge pull request #984 from pi-hole/Mcat12-auto-ipv6
Automatically enable IPv6
2016-12-14 13:59:55 -05:00
Mcat12
92f4824884 Automatically enable IPv6 2016-12-14 13:52:14 -05:00
DL6ER
9a2ffabc33 Fix missing path information 2016-12-14 17:33:20 +01:00
DL6ER
2977168da1 dnsmasq "bogus-priv" property 2016-12-14 16:16:25 +01:00
DL6ER
85e3f37503 dnsmasq "domain-needed" property 2016-12-14 16:09:57 +01:00
DL6ER
ba015c1918 Set domain name via Settings page 2016-12-14 14:24:09 +01:00
DL6ER
1556adb678 Also remove quiet-dhcp setting when disabling/enabling the Pi-Hole DHCP server 2016-12-14 12:12:36 +01:00
Adam Warner
6bfe729112 Merge pull request #979 from pi-hole/wwwdatapassword
Prevent web UI password change by web user
2016-12-13 16:33:41 +00:00
DL6ER
c340668870 Merge pull request #976 from pi-hole/websettingspage
Add necessary backend for the new "Settings" page of the web UI
2016-12-13 17:32:18 +01:00
DL6ER
207422f83a Added a missing space 2016-12-13 15:54:41 +01:00
DL6ER
004ba28378 Prevent web UI password change by web user 2016-12-13 15:52:28 +01:00
DL6ER
6f38801ed8 Add "Interface appearence" option 2016-12-13 14:59:52 +01:00
Adam Warner
1509eb7d82 Merge pull request #978 from pi-hole/Mcat12-adzhosts-list
Update ADZHOSTS list
2016-12-13 12:13:37 +00:00
DL6ER
b8d2bfc890 Wait 5 seconds before rebooting so the web UI can finish loading before being unreachable due to the reboot 2016-12-13 12:42:40 +01:00
Mcat12
8a2ee95e4a Update ADZHOSTS list 2016-12-12 15:30:47 -05:00
DL6ER
bc91716082 Suppress logging of DHCP actions to /var/log/pihole.log 2016-12-12 17:14:52 +01:00
DL6ER
a00034a6a7 Add password to webUI after update if there is none 2016-12-12 17:03:53 +01:00
DL6ER
8dc0dc4d69 Add DHCP-Server backend 2016-12-12 15:34:05 +01:00
DL6ER
2f4b7ce3dd Update dnsmasq file when changing upstream DNS servers and restart the service to get it active 2016-12-12 14:17:02 +01:00
DL6ER
d4f83cb1d4 Be able to set API_QUERY_LOG_SHOW 2016-12-12 13:15:07 +01:00
DL6ER
aaab3306a8 Add restart DNS capability 2016-12-12 10:38:21 +01:00
DL6ER
2bafa2f2ac Add reboot option 2016-12-11 22:33:27 +01:00
DL6ER
9ac378ae09 Set domains and clients which are excluded by the API 2016-12-11 19:30:04 +01:00
DL6ER
bf867bd9fd Set DNS servers from web UI 2016-12-11 16:54:27 +01:00
Adam Warner
7fd9ff43af Merge pull request #970 from trinapicot/fix/remove_lighty_conf
Update uninstall.sh for check on lighttpd installation
2016-12-09 23:40:50 +00:00
Adam Warner
bebb569c43 Merge pull request #964 from pi-hole/queryadsonlyexactmatches
pihole -q: Add option to show all partial or only exact matches
2016-12-09 23:25:15 +00:00
Mcat12
74e33bb1a0 Merge pull request #973 from pi-hole/taillog
Add tail argument to automatically "tail -f" pihole.log
2016-12-08 16:40:17 -05:00
Mcat12
b591df55b0 Tell user how to exit tail command 2016-12-08 16:35:50 -05:00
Mcat12
bddf31443c Merge pull request #974 from pi-hole/Mcat12-add-reconfigure-help
Add Reconfigure command to Pi-hole's list of commands
2016-12-08 15:55:36 -05:00
Mcat12
b9e0e88fe9 Update pihole 2016-12-08 15:47:30 -05:00
DL6ER
5120d9ec33 Add tail option 2016-12-08 21:15:03 +01:00
trinapicot
0a423ffd40 Fix check for lighttpd install before configuration directory removal 2016-12-07 20:31:34 -07:00
DL6ER
c0886cb5c6 pihole -q <domain> is partial matching (as before), pihole -q <domain> -exact is exact matching (new behavior) 2016-12-06 13:18:01 +01:00
DL6ER
294df8690c Do only one grep on each of the lists and count the number of non-empty lines in the result. Improves speed by factor of 2x 2016-12-06 09:55:17 +01:00
DL6ER
fb72ac9904 Show only exact matches for pihole -q 2016-12-06 08:18:49 +01:00
Mcat12
b6639d9e7e Merge pull request #962 from pi-hole/queryblacklist
Also query blacklist with pihole -q
2016-12-05 18:11:26 -05:00
DL6ER
74cb79252c Only looking for blocking entries (do not scan whitelist.txt) 2016-12-05 17:12:28 +01:00
DL6ER
6cd3c93472 Also query white- and blacklist 2016-12-05 17:09:49 +01:00
DL6ER
eb63e75379 No need for pipe here 2016-12-05 17:06:20 +01:00
Mcat12
f98de3d5db Merge pull request #941 from DL6ER/caseinsensitive
Improvements for black-/whitelist scripts
2016-12-04 14:33:10 -05:00
Mcat12
fab7d60373 Merge pull request #960 from unseen1980/patch-1
Ad blocker with armbian and orange pi
2016-12-04 14:20:48 -05:00
Christos Koutsiaris
b4e5358145 Ad blocker with armbian and orange pi 2016-12-04 18:40:01 +00:00
Adam Warner
486db1e797 Merge pull request #956 from trinapicot/development
Add check for lighty.conf before trying to move it
2016-12-03 17:11:16 +00:00
DL6ER
78cb43d0dc Revert "Simplified EscapeRegexp()"
This reverts commit 509cfd15f2.
2016-12-03 00:32:37 +01:00
trinapicot
870454330d Add check for lighty.conf before trying to move it 2016-12-02 13:54:11 -07:00
DL6ER
509cfd15f2 Simplified EscapeRegexp() 2016-12-02 14:17:34 +01:00
DL6ER
2061daa902 Don't forget to escape also the slash "/" 2016-12-02 14:11:17 +01:00
DL6ER
629ca970a1 Changed from single quoted filter expression to double quotes as reqeusted by codacy 2016-12-02 14:08:54 +01:00
DL6ER
c8ad6f23a8 Properly escape any special characters before using them in regexp manner 2016-12-02 12:57:04 +01:00
Mcat12
d8912fd0a7 Merge pull request #952 from pi-hole/fix/exit_codes
Fix/exit codes
2016-12-01 18:24:30 -05:00
Dan Schaper
925c80edd4 Catch more 1's
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-01 15:10:06 -08:00
Dan Schaper
2f6afd375b Merge pull request #942 from pi-hole/PromoFaux-patch-2
Update gravity.sh
2016-12-01 14:00:38 -08:00
Dan Schaper
d92646324c Double worded
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-01 13:59:58 -08:00
Dan Schaper
c9fe62a691 Clarify what the command is doing.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-01 13:58:40 -08:00
Dan Schaper
cb52ad3ba3 Revert other branch chages.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-01 13:31:35 -08:00
Dan Schaper
2ec4acfe52 Begin fixing exit values.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2016-12-01 12:21:08 -08:00
Mcat12
1c64f1d0cf Merge pull request #940 from pi-hole/PromoFaux-patch-1
Update .pullapprove.yml
2016-11-22 17:20:57 -05:00
Mcat12
48f4f44289 Merge pull request #944 from pi-hole/feature/Issue_template
Update ISSUE_TEMPLATE.md
2016-11-22 16:23:36 -05:00
Dan Schaper
80c19cbf7d Update ISSUE_TEMPLATE.md 2016-11-22 12:05:19 -08:00
Adam Warner
c97cfde9f9 Update gravity.sh
Only include domain part of lines that contain `/` e.g `www.fakenewswatch.com/megynkelly`
2016-11-21 22:51:59 +00:00
DL6ER
7b26b308ad No need for echo and pipe here! 2016-11-21 15:50:05 +01:00
DL6ER
4c10634d85 Convert domain names to lower case before checking validity of the domain 2016-11-21 15:49:11 +01:00
Mcat12
3ba7d7640f Merge pull request #933 from DL6ER/delayedreactivation
Add possiblity for delayed reactivation of blocking
2016-11-21 08:26:26 -05:00
Adam Warner
907995a221 Update .pullapprove.yml
reflect new approvers team
2016-11-21 13:13:39 +00:00
DL6ER
7bf0985a57 Extended help text of main pihole command 2016-11-21 11:30:34 +01:00
Dan Schaper
3ca21d8c8a Merge pull request #931 from pi-hole/update_tests
Add piholeDebug to CI Travis tests
2016-11-20 15:51:14 -08:00
Dan Schaper
a3a87c8883 Merge pull request #937 from pi-hole/feature/README
README updates
2016-11-20 15:23:49 -08:00
Adam Warner
de4401823e Merge pull request #924 from DL6ER/webpage.sh
Add webpage.sh
2016-11-20 21:43:44 +00:00
Adam Warner
3ee10f5983 Merge pull request #938 from DL6ER/another_done
Another done
2016-11-20 19:21:58 +00:00
Dan Schaper
0fc8ac8d4d Codacy Badge for Master 2016-11-20 09:44:39 -08:00
Dan Schaper
41bb53a29f Remove CC Badge, Link Vortex to Discourse 2016-11-20 09:42:45 -08:00
DL6ER
cdee6d55d3 Minor change 2016-11-20 17:40:22 +01:00
DL6ER
e5a1afaa26 Added another missing "done" 2016-11-20 17:31:27 +01:00
DL6ER
f50cbe74cb Changed -web (webpage) to -a (admin) 2016-11-20 15:15:27 +01:00
Dan Schaper
5dbbf91917 Link to AdminLTE 2016-11-19 15:08:35 -08:00
Mcat12
7424a29960 Update wiki link 2016-11-19 15:03:32 -08:00
Dan Schaper
eb22ca2467 Reset Code Stylings to group defalut 2016-11-19 15:03:12 -08:00
Dan Schaper
ddbcbe5458 Merge in git method instructions from other branch.
Move some bits around.

Start adding in logos to media links

More logos

Add BC logo

Change static images to use Asset server

Add and center control panel image
2016-11-19 15:01:56 -08:00
Dan Schaper
6e54cfd2ac Further refinements.
Trying to find a good flow for information and layout.
2016-11-19 14:57:49 -08:00
Mcat12
fc3d4b3def Update README.md 2016-11-19 14:57:38 -08:00
Jacob Salmela
df55b2c516 relocate and wordsmith donations 2016-11-19 14:57:29 -08:00
Jacob Salmela
4d9fb57e22 above the fold verbage
Try to let the user know in two sentences what Pi-hole can do for them.

Also, linked to Discourse hw/sw requirements.

fixed DO referral code.
2016-11-19 14:57:02 -08:00
Dan Schaper
3ed08b5c39 Add New Logo and other changes
Remove extra break

Center Badges and move DO Slug

Bump Vortex up a bit.

Last change for now.

Move things around a bit.

Pull overlay off black hole image
2016-11-19 14:55:52 -08:00
Dan Schaper
d715471426 Center Global 2016-11-19 14:47:46 -08:00
Dan Schaper
486a4929da Add click instructions 2016-11-19 14:46:30 -08:00
Dan Schaper
aacddb745b Swap Global Image
Global image, no berry, no overlay
2016-11-19 14:46:30 -08:00
Dan Schaper
924f499303 Add DO Slug and Copy to README 2016-11-19 14:46:30 -08:00
Dan Schaper
e863a200e8 Remove CC badge 2016-11-19 14:44:43 -08:00
Dan Schaper
bb7f8ae69d Add git clone method to installers 2016-11-19 14:44:13 -08:00
DL6ER
33b6fe72da Extended help text 2016-11-19 21:57:42 +01:00
DL6ER
733919be4a Implement possibility to remove password using "pihole -web -p" 2016-11-19 21:50:15 +01:00
Dan Schaper
4333e5487b Merge pull request #932 from pi-hole/feature/debug_timeout
feature/debug_timeout
2016-11-19 12:25:38 -08:00
Dan Schaper
22ead933b6 Merge pull request #936 from pi-hole/Mcat12-patch-1
Fix typo
2016-11-19 11:08:20 -08:00
Dan Schaper
d53a3af191 Merge pull request #899 from diginc/configureFirewall_unittest
Configure firewall unittest
2016-11-19 11:07:38 -08:00
Mcat12
08e7b7e0ad Fix typo 2016-11-19 14:00:56 -05:00
Dan Schaper
68cb0782c0 Add countdown timer 2016-11-18 13:27:06 -08:00
Adam Warner
0e5a8e0033 Merge pull request #934 from DL6ER/gravity.sh-done
Added missing "done." output to gravity.sh
2016-11-18 20:10:50 +00:00
DL6ER
4945f33254 Added "-n" to first echo call 2016-11-18 17:39:34 +01:00
DL6ER
3fa05293fc Fixed file permissions 2016-11-18 17:37:13 +01:00
DL6ER
27e5f2798d Added missing "done." output 2016-11-18 17:33:46 +01:00
DL6ER
291ca0874a Fixed two more typos 2016-11-18 12:16:26 +01:00
DL6ER
96f2aa1803 fixed typo 2016-11-17 23:36:53 +01:00
DL6ER
c6857501aa Removed check for availability of nohup 2016-11-17 23:31:11 +01:00
DL6ER
3aba1607b2 Removed debug echos 2016-11-17 23:04:46 +01:00
DL6ER
f667298b64 Added possiblity for delayed reactivation of blocking 2016-11-17 22:58:00 +01:00
Dan Schaper
0f4c8d4923 Set default timeout to 60 seconds 2016-11-17 11:00:11 -08:00
Dan Schaper
6d2c5b2312 Add debug timeoute 2016-11-17 10:58:58 -08:00
Dan Schaper
a95ce11ca6 Add debug timeoute 2016-11-17 10:39:51 -08:00
Dan Schaper
808503d526 Add piholeDebug to tests 2016-11-17 10:28:51 -08:00
Adam Warner
d4b6fb9214 Merge pull request #929 from pi-hole/cleanup/PR_template
Small change in template
2016-11-17 12:43:54 +00:00
Dan Schaper
9bce5a09f3 Small change in template
Just a space, and italicize
2016-11-16 21:42:54 -08:00
Mcat12
bd61f38169 Merge pull request #926 from zbholman/patch-2
Added removal of pihole user to the uninstall.sh
2016-11-16 17:31:56 -05:00
zbholman
cac9c63325 Added removal of pihole user to the uninstall.sh
Not sure if I should have created a variable for the username or if the echo is necessary. And this is my first time doing a pull request, hopefully it works out lol.
2016-11-16 17:06:30 -05:00
Adam Warner
e6d555ac31 Merge pull request #925 from pi-hole/feature/style_guide
Add GSG/Shell link
2016-11-16 22:03:18 +00:00
Dan Schaper
fd0dd9f54c Add GSG/Shell link 2016-11-16 13:55:29 -08:00
DL6ER
88c161769d Capitalized variable names. 2016-11-16 22:33:28 +01:00
DL6ER
01bf1ae92d Compute double hashes to avoid rainbow table vulnerability 2016-11-16 22:13:47 +01:00
DL6ER
9193c71cff Minor change 2016-11-16 21:36:19 +01:00
DL6ER
db278d81e4 Added webpage.sh 2016-11-16 21:34:43 +01:00
Dan Schaper
bdad454a0d Merge pull request #920 from pi-hole/PromoFaux-patch-1
Update piholeDebug.sh
2016-11-16 11:22:04 -08:00
Adam Warner
ac8064c754 Merge pull request #918 from nlamirault/patch-2
Add Pi-Hole exporter for Prometheus
2016-11-16 18:53:00 +00:00
Dan Schaper
736e963cef Merge pull request #919 from haydenknowles/development
moved newline to correct place
2016-11-15 18:40:00 -08:00
Adam Warner
b191cd73a7 Update piholeDebug.sh
wording
2016-11-15 13:28:18 +00:00
Hayden Knowles
86d3ca48ae moved newline to correct place 2016-11-15 22:40:57 +13:00
Nicolas Lamirault
fd7e4f2268 Add Pi-Hole Prometheus exporter project 2016-11-15 09:27:16 +01:00
Dan Schaper
e9475a9739 Merge pull request #887 from brontide/dependancy_cleanup
Dependancy cleanup
2016-11-07 21:45:23 -08:00
Dan Schaper
d4270e02e9 Merge pull request #902 from elpatron68/master
Added Link to blink1_pi-hole.py
2016-11-07 21:44:28 -08:00
Mcat12
b9a263ecb2 Merge pull request #907 from pi-hole/bugfix/chronometer-interface
replace hardcoded interface with var
2016-11-07 21:35:09 -05:00
Dan Schaper
4929d415a6 Merge pull request #906 from pi-hole/Fix/send-frs-into-orbit
Direct users to Discourse for FRs
2016-11-07 17:32:28 -08:00
Dan Schaper
b9e1f518aa Merge pull request #909 from bcambl/fix_ifcfg_append
Fedora: write interface config instead of append
2016-11-07 17:23:50 -08:00
bcambl
0caa44e979 write ifcfg instead of appending 2016-11-07 12:54:31 -06:00
Jacob Salmela
ca56ca5bd8 promo-tweak
Better logic introduced by @PromoFaux
2016-11-06 11:16:48 -06:00
Jacob Salmela
a0f0dff88e replace hardcoded interface with var
setupVars.conf is already sourced, so we just need to replace the
hardcoded value with the variable name.
2016-11-06 08:18:57 -06:00
Jacob Salmela
e5cc38a210 Direct users to Discourse for FRs
It's a better platform for it because users can vote and we can have
easier discussions for it.
2016-11-06 08:08:58 -06:00
Adam Warner
6cb5bb7200 Merge pull request #903 from pi-hole/feature/PRGuide
PR against Development guide
2016-11-04 21:17:20 +00:00
Dan Schaper
563696e291 PR against Development guide
PA will tag PR to Master with -1 approval in the next release. That will deny any PR's against Master from users and changing branches after the PR is started does not appear to modify the PA actions.
2016-11-04 14:01:01 -07:00
Markus Busche
c755b3c49e Added Link to blink1_pi-hole.py 2016-11-04 21:56:14 +01:00
diginc
b9f3493dbc move PH_TRUE to Dockerfiles to DRY 2016-11-03 22:34:04 -05:00
Dan Schaper
8c08e9e473 Merge pull request #891 from pi-hole/bugfix/chronometer-domain-count
Bugfix/chronometer domain count
2016-11-03 13:55:29 -07:00
Adam Hill
c2930b0ca5 remove the debug print in mock_command 2016-11-03 08:34:44 -05:00
Adam Warner
4300759287 Fix logic. If both v6 and v4 divide by two, else dont. 2016-11-03 08:01:25 +00:00
Adam Warner
fc1854cadd Merge pull request #897 from pi-hole/feature/travisDevBadge
Update README.md
2016-11-03 07:49:30 +00:00
Adam Warner
933973b12c Merge pull request #898 from pi-hole/fix/removeCC
Remove CodeClimate yaml, Travis new ShellChecker
2016-11-03 07:48:36 +00:00
diginc
5b54b9cb11 update Pihole fixture comment 2016-11-03 00:05:19 -05:00
diginc
d2f815bba7 no longer need to write bash test scripts 2016-11-03 00:02:28 -05:00
diginc
a5a067d50f switching testinfra's Docker run from dash to bash 2016-11-02 23:58:54 -05:00
diginc
699e299345 add a comment about bash vs dash. future refact needed 2016-11-02 23:40:50 -05:00
diginc
05e114173d update comments, add configureFirewall test
* Comments to clarify some of the existing tests
* mock_command to allow recording of calls and mocking return calls in bash
* new configureFirewall test (only the first one of it's many paths)
2016-11-02 23:25:13 -05:00
Dan Schaper
d958b3ff65 Remove CodeClimate yaml, Travis new ShellChecker 2016-11-02 20:14:04 -07:00
diginc
0d7e06a141 remove old pytest output file 2016-11-02 22:13:39 -05:00
diginc
633095aee1 switch to consistent style 2016-11-02 22:13:05 -05:00
Dan Schaper
a4aeb9a1dd Update README.md 2016-11-02 20:07:51 -07:00
Eric Warnke
71005e1db3 Merge with change of spacing in development 2016-11-02 19:01:34 -04:00
Promofaux
d7d6d6f991 Update to use new Var name 2016-11-02 21:46:30 +00:00
Adam Warner
5986121cfc Merge pull request #896 from pi-hole/bugfix/649
Check for missing index.html, replace if missing.
2016-11-02 21:27:45 +00:00
Promofaux
c452a4569e .js 2016-11-02 21:17:00 +00:00
Promofaux
a182a208dc Tidy up output 2016-11-02 21:06:12 +00:00
Promofaux
d273b4b48b Check for missing index.html, replace if missing. 2016-11-02 20:57:56 +00:00
Adam Warner
afed7d4af0 Merge pull request #890 from pi-hole/feature/defensiveTweaks
Feature/defensive tweaks
2016-11-02 20:23:04 +00:00
Promofaux
b429e890ad move web interface message inside "if not update" block. Check for pi-hole deps AFTER whiptails 2016-11-02 20:16:36 +00:00
Promofaux
2f976504e8 switch out -eq for == 2016-11-02 20:06:21 +00:00
Dan Schaper
b5fc88227b Merge .gitignore 2016-11-02 12:36:00 -07:00
Dan Schaper
4b7b859db9 Gotta catch 'em all...' 2016-11-02 12:29:55 -07:00
Dan Schaper
f7d0de53bb Compare string to string. 2016-11-02 12:11:34 -07:00
Dan Schaper
603ec997ba Remove testing block. 2016-11-02 12:09:33 -07:00
Dan Schaper
f7266ef4c8 Version remote check returns -1 on failure to detect curl silent failing. Update detects loss of contact to GitHub or fallthrough condition and reports to user. 2016-11-02 12:07:59 -07:00
Dan Schaper
3d43e1568c Use explicit calls for function to self-document 2016-11-02 11:39:22 -07:00
Dan Schaper
3cf6a65da9 Remove *.yml ignoring
Travis YAML might not be good to ignore.
2016-11-02 11:32:53 -07:00
Dan Schaper
c1a3f003e8 Rename the only utilty function left that didn't say repo 2016-11-02 11:18:13 -07:00
Dan Schaper
3f61aea7fc Utility functions fully quiet now. Calling functions have the echos. 2016-11-02 11:09:53 -07:00
Dan Schaper
bd68db51e0 ShellCheck split local declaration and assignment. 2016-11-02 11:01:50 -07:00
Dan Schaper
b8a5ed710e Take echos out of utility functions and move up a level. 2016-11-02 10:51:09 -07:00
Dan Schaper
34be601dd7 Test for lexicographically less than tag version. 2016-11-02 10:42:05 -07:00
Dan Schaper
1d64ad1ccd Stash all changed files, clean directory and pull updates. 2016-11-02 10:39:27 -07:00
Dan Schaper
dfb4ac0365 Keep .yml's from going to user local repos. 2016-11-02 09:52:15 -07:00
Dan Schaper
f2d7a3d26d Merge branch 'feature/defensiveTweaks' of https://github.com/pi-hole/pi-hole into feature/defensiveTweaks 2016-11-02 09:48:00 -07:00
Dan Schaper
6d415a7384 Merge pull request #894 from diginc/InstallFixes_UnitTests
Unit tests framework and some basic tests
2016-11-02 09:42:20 -07:00
Dan Schaper
0ef8832b04 whitespace 2016-11-02 09:36:30 -07:00
Dan Schaper
e42a037b7d Grep -i instead of cat. 2016-11-02 09:28:00 -07:00
Dan Schaper
fe18d69b65 Grep should start at the beginning of line to make sure it doesn't fire on # beginning lines. 2016-11-02 09:25:32 -07:00
Dan Schaper
a1a9a7fa9e Clarify which DNS entry we are modifying. 2016-11-02 08:52:23 -07:00
Dan Schaper
07029f93e3 Match team convention in naming. 2016-11-02 08:34:56 -07:00
Dan Schaper
e99ef9c093 Cap the variables and echo out the proper environment. 2016-11-02 08:22:45 -07:00
Dan Schaper
fef9ab674e Pi-hole CORE installer variables are being changed to standardize scripts. 2016-11-02 07:53:02 -07:00
Adam Warner
ee37c37cab fix update output logic. version number variables should not be read only! 2016-11-02 14:29:20 +00:00
Dan Schaper
b636c1e1f8 Whitespace. 2016-11-02 07:00:43 -07:00
Dan Schaper
8b9f0487c0 Merge branch 'feature/defensiveTweaks' of https://github.com/pi-hole/pi-hole into feature/defensiveTweaks
# Conflicts:
#	advanced/Scripts/update.sh
#	automated install/basic-install.sh
2016-11-02 06:57:33 -07:00
Adam Warner
a6cbd5a2fd Merge pull request #895 from pi-hole/Feature/defensiveTweaks
Further tweaks to local repo handling
2016-11-02 13:42:24 +00:00
Dan Schaper
ece1667fb0 Refactor and move some bits. 2016-11-02 06:41:51 -07:00
Adam Warner
50bd8b4a09 Further tweaks to local repo handling 2016-11-02 13:34:57 +00:00
Dan Schaper
93d91353a1 All tabs now spaced 2016-11-02 05:49:33 -07:00
Dan Schaper
8dc9143b34 Just delete, no need to cd there first. 2016-11-02 05:45:29 -07:00
Dan Schaper
a0d9a1133c Factoring and combining functions 2016-11-02 05:34:39 -07:00
Dan Schaper
7740e4268c Consistency and standards basic-install start. 2016-11-02 05:17:28 -07:00
Adam Warner
f36e4ba336 Cherry picking 3f049fa79, conflict fix 2016-11-02 04:34:02 -07:00
Adam Warner
3df2ef8587 Cherry picking f6f6f6d, conflict fix 2016-11-02 04:31:28 -07:00
Adam Warner
354309fcad set QUERY_LOGGING default to true 2016-11-02 04:28:58 -07:00
Dan Schaper
e832bfc61e Merge branch 'feature/defensiveTweaks' of github.com:pi-hole/pi-hole into feature/defensiveTweaks 2016-11-02 04:22:29 -07:00
Adam Warner
99057ed859 Update var names from setupVars.conf in gravity.sh 2016-11-02 04:21:54 -07:00
Adam Warner
c47c5e466f consistency 2016-11-02 04:18:52 -07:00
Adam Warner
edd00e8e70 consistency 2016-11-02 04:12:37 -07:00
Adam Warner
82e7de2aaa Account for variable name changes 2016-11-02 04:12:21 -07:00
Adam Warner
b723714c0c Convention : https://google.github.io/styleguide/shell.xml?showone=Constants_and_Environment_Variable_Names#Constants_and_Environment_Variable_Names 2016-11-02 04:12:06 -07:00
Adam Warner
a2903b6e63 Consistency 2016-11-02 04:11:54 -07:00
Dan Schaper
9a1876571b Prototype whiptails so they don't fall to shell. Need to do this to all functions. 2016-11-02 04:11:41 -07:00
Dan Schaper
c07d7165ab Global variables CAP'ed 2016-11-02 04:11:27 -07:00
Dan Schaper
d695c5972f local variables just to be safe and make sure they stay in this function. 2016-11-02 04:11:09 -07:00
Dan Schaper
bbc09ed313 Swap variable names. 2016-11-02 04:10:57 -07:00
Promofaux
1d21b0da9a enable or disable logging from pihole command 2016-11-02 04:10:43 -07:00
Promofaux
617a147706 Wording adjustment 2016-11-02 04:10:29 -07:00
Promofaux
d4dccfdb2d Cherry pick 229439c 2016-11-02 04:08:53 -07:00
Dan Schaper
035e4bf727 Move value checks to if calls. 2016-11-02 03:55:04 -07:00
Dan Schaper
9ec5bbd560 Actually get is_repo to return a value and have it expected. 2016-11-02 03:38:35 -07:00
Dan Schaper
34482c5ed6 Modified is_repo 2016-11-02 03:09:59 -07:00
Dan Schaper
7d414b5628 Move version messages to main function, check for repos. 2016-11-02 01:12:02 -07:00
Dan Schaper
d9528dfd09 Bash is funny with returns. 2016-11-02 00:51:38 -07:00
Dan Schaper
12f5f8ba00 Begin to bring code up to Pi-hole conventions. Block installScripts and begin factoring out redundant code. 2016-11-02 00:14:25 -07:00
Dan Schaper
db0f3307e0 Only take out scripts in the directory, don't remove the directory as a whole. Need this for the future installs. 2016-11-01 22:48:30 -07:00
Dan Schaper
9c83825cb8 Merge branch 'feature/defensiveTweaks' of https://github.com/pi-hole/pi-hole into feature/defensiveTweaks 2016-11-01 22:20:32 -07:00
Dan Schaper
7a22471787 New naming convention, and reorder functions as bash would prefer them to be. 2016-11-01 22:19:40 -07:00
diginc
7548d9a8fe point shellcheck at update.sh instead 2016-11-01 23:56:46 -05:00
diginc
26789f9b36 add travis and python requirements 2016-11-01 23:53:11 -05:00
diginc
b4524839bb Merge branch 'development' of https://github.com/pi-hole/pi-hole into InstallFixes_UnitTests 2016-11-01 23:52:20 -05:00
Dan Schaper
6605c269cf Merge pull request #893 from diginc/feature/defensiveTweaks
Feature/defensive tweaks tweaks
2016-11-01 21:35:20 -07:00
diginc
c30478bf4a cleanup and use sentintel in is_repo 2016-11-01 23:21:50 -05:00
diginc
d986746ef9 missing quote added 2016-11-01 23:07:20 -05:00
diginc
a8fa061f2e quote all the assignments prevent accidental glob splitting 2016-11-01 23:02:06 -05:00
diginc
72015b0226 reduce complexity and un needed cat 2016-11-01 23:00:14 -05:00
Jacob Salmela
f8e9726922 source setupVars and check for the correct variable 2016-11-01 19:01:48 -05:00
Jacob Salmela
884363bd05 remove ipv6 check since it's already in setupVars 2016-11-01 19:01:28 -05:00
Dan Schaper
bdd240ecb6 Shellcheck catch for always true expansion. 2016-11-01 15:36:27 -07:00
Dan Schaper
04da292df9 Missed one spinner, updated and exit script if github is unreachable. 2016-11-01 12:17:38 -07:00
Dan Schaper
85b8676b8e Remove spinner, no functions here should last that long, and it masks a few potential exit avenues. 2016-11-01 12:16:46 -07:00
Dan Schaper
114bc13c23 Specify path, cron may not know where the files are located. 2016-11-01 12:03:26 -07:00
Dan Schaper
5fef5f1ed4 Break down is_repo to make sure it does what is expected. 2016-11-01 11:54:14 -07:00
Dan Schaper
807b60b0e6 Missed the second reinstaller.... 2016-11-01 11:44:16 -07:00
Dan Schaper
fbc800e556 If unattened reinstall fails, notify user and exit script immediately. 2016-11-01 11:42:18 -07:00
Dan Schaper
1991ee7a7d Google Style Guide. readonly and cap constants. 2016-11-01 11:36:44 -07:00
Dan Schaper
ffbfadbccf Detail what the script does. 2016-11-01 11:33:04 -07:00
Dan Schaper
c3e2bce956 Variables declared as strings, make sure they are strings when we use them in functions. 2016-11-01 11:26:57 -07:00
Dan Schaper
0c9520d7e3 Protect against unexepcted return values (GitHub not responding as we'd expect.) And make sure bash doesn't maul the variables and cause firing of unattended reinstall of application when values returned aren't as expected. 2016-11-01 11:18:41 -07:00
Dan Schaper
1e7e5230cc Clarify what exactly is being called and the expected returned value format 2016-11-01 11:15:21 -07:00
Dan Schaper
f1efc97357 Clairfy condition to make sure they operate as per the specs of the logic flow layout. 2016-11-01 11:04:33 -07:00
Eric Warnke
fb5ac6d6d7 We should prefer the php metapackage if it's there, falling back on php5 if it's not 2016-10-31 21:31:13 -04:00
Eric Warnke
4e7ca51beb Added dependancy for ping and lsof used in debug scripts 2016-10-31 21:24:57 -04:00
Adam Warner
d561600a31 Merge pull request #863 from brontide/wheezy_fix2
[Test] Wheezy install fix by selecting appropriate deps, made the php check …
2016-10-31 22:35:46 +00:00
Adam Warner
024e843998 Merge pull request #884 from pi-hole/PromoFaux-patch-2
Update pullapprove into master
2016-10-30 17:17:53 +00:00
Adam Warner
126f275e18 Update pullapprove into master
Requires approval of ALL members of the `admin` team.
2016-10-30 17:15:35 +00:00
Dan Schaper
c65e5ff8e0 Merge pull request #882 from pi-hole/feature/DiscourseREADME
Feature/discourse readme
2016-10-30 08:05:48 -07:00
Dan Schaper
ef13e67572 Update README.md 2016-10-30 07:11:34 -07:00
Dan Schaper
7920fcbb5e Add linux.die.net links
Add links for online manpages.
2016-10-30 07:09:03 -07:00
Dan Schaper
fa36fdeb03 Update README
Add discourse links, remove last of Optimal, bring Other Devices up to the top, update alternate install instructions.
2016-10-30 07:06:27 -07:00
Adam Warner
c143b5ccb4 Merge pull request #881 from pi-hole/feature/doc-update
Update last modified date for adlist
2016-10-30 14:04:30 +00:00
Dan Schaper
05c8406fca Update last modified date for adlist 2016-10-30 06:37:36 -07:00
Eric Warnke
65e0fcbf10 Merge branch 'development' of https://github.com/pi-hole/pi-hole into wheezy_fix2 2016-10-28 13:14:00 -04:00
Eric Warnke
977d1d1998 Merge branch 'development' of https://github.com/pi-hole/pi-hole into wheezy_fix2 2016-10-27 07:37:40 -04:00
Eric Warnke
3a4fe3e391 Wheezy install fix by selecting appropriate deps, made the php check the same 2016-10-26 14:47:29 -04:00
diginc
97c44042e1 Adding failing shellcheck test and results
Should be useful for showing others why other changes were made in the next commit.
2016-10-10 23:28:34 -05:00
diginc
a03caea549 setupVar tests passing for debian & centos 2016-10-10 23:14:39 -05:00
32 changed files with 1897 additions and 1142 deletions

View File

@@ -1,3 +0,0 @@
engines:
shellcheck:
enabled: true

View File

@@ -20,7 +20,7 @@
--- ---
**[FEATURE REQUEST | QUESTION | OTHER]:** **[FEATURE REQUEST | QUESTION | OTHER]:**
_{replace this section with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_ Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community. It's also easier for us to track.
**[BUG | ISSUE] Expected Behaviour:** **[BUG | ISSUE] Expected Behaviour:**
@@ -35,8 +35,8 @@ _{replace this section with your content or delete if not a FEATURE REQUEST/QUES
- -
- -
**(Optional) Debug Log generated by `pihole -d`:** **(Optional) Debug token generated by `pihole -d`:**
`http://termbin.com/<something>` `<token>`
_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._ _This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

View File

@@ -1,4 +1,6 @@
**By submitting this pull request, I confirm the following (please check boxes, eg [X])Failure to fill the template will close your PR:** **By submitting this pull request, I confirm the following (please check boxes, eg [X]) _Failure to fill the template will close your PR_:**
***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). - [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
- [] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist. - [] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.

6
.gitignore vendored
View File

@@ -1 +1,7 @@
.DS_Store .DS_Store
*.pyc
*.swp
__pycache__
.cache
.pullapprove.yml

22
.idea/codeStyleSettings.xml generated Normal file
View File

@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectCodeStyleSettingsManager">
<option name="PER_PROJECT_SETTINGS">
<value>
<option name="OTHER_INDENT_OPTIONS">
<value>
<option name="INDENT_SIZE" value="2" />
<option name="CONTINUATION_INDENT_SIZE" value="8" />
<option name="TAB_SIZE" value="2" />
<option name="USE_TAB_CHARACTER" value="false" />
<option name="SMART_TABS" value="false" />
<option name="LABEL_INDENT_SIZE" value="0" />
<option name="LABEL_INDENT_ABSOLUTE" value="false" />
<option name="USE_RELATIVE_INDENTS" value="false" />
</value>
</option>
</value>
</option>
<option name="USE_PER_PROJECT_SETTINGS" value="true" />
</component>
</project>

View File

@@ -25,7 +25,7 @@ groups:
- development - development
required: 2 required: 2
teams: teams:
- gravity - approvers
master: master:
approve_by_comment: approve_by_comment:
@@ -33,6 +33,6 @@ groups:
conditions: conditions:
branches: branches:
- master - master
required: 3 required: -1
teams: teams:
- gravity - admin

10
.travis.yml Normal file
View File

@@ -0,0 +1,10 @@
sudo: required
services:
- docker
language: python
python:
- "2.7"
install:
- pip install -r requirements.txt
script: py.test -vv

View File

@@ -33,5 +33,6 @@ When requesting or submitting new features, first consider whether it might be u
- Submit Pull Requests to the **development branch only**. - Submit Pull Requests to the **development branch only**.
- Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!) - Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
- Please use the [Google Style Guide for Shell](https://google.github.io/styleguide/shell.xml) for your code submission styles.
- Commit Unix line endings. - Commit Unix line endings.
- (Optional fun) keep to the theme of Star Trek/black holes/gravity. - (Optional fun) keep to the theme of Star Trek/black holes/gravity.

118
README.md
View File

@@ -1,52 +1,80 @@
[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=3011939)](https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE) [![Code Climate](https://codeclimate.com/github/pi-hole/pi-hole/badges/gpa.svg)](https://codeclimate.com/github/pi-hole/pi-hole) <p align="center">
<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
<a href="https://www.codacy.com/app/Pi-hole/pi-hole?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pi-hole/pi-hole&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c558a0f8d7124c99b02b84f0f5564238"/></a>
<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
</p>
# Automated Install <p align="center">
<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_text.png" width=210></a>
</p>
Designed For Raspberry Pi A+, B, B+, 2, 3B, and Zero (with an Ethernet/Wi-Fi adapter) ## The multi-platform, network-wide ad blocker
Works on most Debian and CentOS/RHEL based distributions!
1. Install Raspbian Block ads for **all** your devices _without_ the need to install client-side software. The Pi-hole blocks ads the DNS-level, so all your devices are protected.
2. Run the command below (downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
## `curl -L https://install.pi-hole.net | bash` - Web Browsers
- Cell Phones
- Smart TV's
- Internet-connected home automation
- Anything that communicates with the Internet
### Alternative Semi-Automated install <p align="center">
<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
</p>
## Your Support Still Matters
Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
- ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
- ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
### One-Step Automated Install
1. Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
2. Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
### `curl -sSL https://install.pi-hole.net | bash`
#### Alternative Semi-Automated Install Methods
_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
##### Clone our repository and run the automated installer from your device.
```
git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
cd Pi-hole/automated_installer/
bash basic-install.sh
```
##### Or
```bash ```bash
wget -O basic-install.sh https://install.pi-hole.net wget -O basic-install.sh https://install.pi-hole.net
chmod +x basic-install.sh bash basic-install.sh
./basic-install.sh
``` ```
If you wish to read over the script before running it, then after the `wget` command, do `nano basic-install.sh` to open a text viewer
Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/). Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
## How To Install Pi-hole ## Installing the Pi-hole (Click to Watch!)
<p align="center">
<a href=https://www.youtube.com/watch?v=TzFLJqUeirA><img src="https://assets.pi-hole.net/static/global.png"></a>
</p>
[![60-second install tutorial](http://i.imgur.com/5TEc3a6.png)](https://www.youtube.com/watch?v=TzFLJqUeirA) ## Would you like to know more?
## How It Works
**Watch the 60-second video below to get a quick overview** **Watch the 60-second video below to get a quick overview**
<p align="center">
[![Pi-hole exlplained](http://i.imgur.com/pG1m937.png)](https://youtu.be/9Eti3xibiho) <a href=https://youtu.be/9Eti3xibiho><img src="https://assets.pi-hole.net/static/blackhole_web.png"></a>
</p>
## Pi-hole Is Free, But Powered By Your Donations
Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the monthly fee.
- ![Paypal](http://i.imgur.com/3muNfxu.png) : [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
- ![Flattr](http://i.imgur.com/ZFceFRu.png) : [Donate](https://flattr.com/submit/auto?user_id=jacobsalmela&url=https://github.com/pi-hole/pi-hole)
- ![Bitcoin](http://i.imgur.com/FIlmOMG.png) : 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
## Get Help Or Connect With Us On The Web ## Get Help Or Connect With Us On The Web
- [@The_Pi_Hole](https://twitter.com/The_Pi_Hole) - [Users Forum](https://discourse.pi-hole.net/)
- [/r/pihole](https://www.reddit.com/r/pihole/) - [FAQs](https://discourse.pi-hole.net/c/faqs)
- [Pi-hole YouTube channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) - [Wiki](https://github.com/pi-hole/pi-hole/wiki)
- [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization) - ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
- [FAQs](https://pi-hole.net/help/) - ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
- ![YouTube](https://assets.pi-hole.net/static/youtube.png) [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
- [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Technical Details ## Technical Details
@@ -55,25 +83,34 @@ The Pi-hole is an **advertising-aware DNS/Web server**. If an ad domain is queri
### Gravity ### Gravity
The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
## Web Interface
The [Web interface](https://github.com/jacobsalmela/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
#### Other Operating Systems
The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a Webserver, it should work OK. If there are other platforms you'd like supported, let us know.
### Web Interface
The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
`http://192.168.1.x/admin/index.php` or `http://pi.hole/admin` `http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/gTq2GbS.png) ![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard.png)
### Whitelist and blacklist ### Whitelist and blacklist
Domains can be whitelisted and blacklisted using two pre-installed scripts. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details ![Whitelist editor in the Web interface](http://i.imgur.com/ogu2ewg.png) Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
<p align="center">
<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/controlpanel.png"></a>
</p>
## API ## API
A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON: A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
```json ``` json
{ {
"domains_being_blocked": "136708", "domains_being_blocked": "136708",
"dns_queries_today": "18108", "dns_queries_today": "18108",
@@ -103,6 +140,8 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
- [Pi-hole on/off button](http://thetimmy.silvernight.org/pages/endisbutton/) - [Pi-hole on/off button](http://thetimmy.silvernight.org/pages/endisbutton/)
- [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole) - [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
- [Windows Tray Stat Application](https://github.com/goldbattle/copernicus) - [Windows Tray Stat Application](https://github.com/goldbattle/copernicus)
- [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
- [Pi-Hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter) : a [Prometheus](https://prometheus.io/) exporter for Pi-Hole
## Coverage ## Coverage
@@ -119,7 +158,4 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
- [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s) - [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
- [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/) - [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
- [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/) - [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
- [Build an Ad-Blocker for less than 10$ with Orange-Pi](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/)
## Other Operating Systems
This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install `dnsmasq` and a Webserver, it should work OK. The automated install is only for a clean install of a Debian based system, such as the Raspberry Pi.

View File

@@ -1,4 +1,4 @@
## Pi-hole ad-list default sources. Updated 22/05/2016 ######################### ## Pi-hole ad-list default sources. Updated 29/10/2016 #########################
# # # #
# To make changes to this file: # # To make changes to this file: #
# 1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list` # # 1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list` #
@@ -28,7 +28,7 @@ https://hosts-file.net/ad_servers.txt
#http://adblock.mahakala.is/ #http://adblock.mahakala.is/
# ADZHOSTS list. Has been known to block legitimate domains # ADZHOSTS list. Has been known to block legitimate domains
#http://optimate.dl.sourceforge.net/project/adzhosts/HOSTS.txt #http://pilotfiber.dl.sourceforge.net/project/adzhosts/HOSTS.txt
# Windows 10 telemetry list # Windows 10 telemetry list
#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt #https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt

View File

@@ -20,13 +20,8 @@
# OR IN /etc/dnsmasq.conf # # OR IN /etc/dnsmasq.conf #
############################################################################### ###############################################################################
address=/pi.hole/@IPv4@
address=/pi.hole/@IPv6@
address=/@HOSTNAME@/@IPv4@
address=/@HOSTNAME@/@IPv6@
addn-hosts=/etc/pihole/gravity.list addn-hosts=/etc/pihole/gravity.list
addn-hosts=/etc/pihole/local.list
domain-needed domain-needed

View File

@@ -17,15 +17,15 @@ gravity="/etc/pihole/gravity.list"
today=$(date "+%b %e") today=$(date "+%b %e")
. /etc/pihole/setupVars.conf
CalcBlockedDomains() { CalcBlockedDomains() {
CheckIPv6
if [ -e "${gravity}" ]; then if [ -e "${gravity}" ]; then
#Are we IPV6 or IPV4? # if BOTH IPV4 and IPV6 are in use, then we need to divide total domains by 2.
if [[ -n ${piholeIPv6} ]]; then if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]]; then
#We are IPV6
blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}') blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}')
else else
#We are IPV4 # only one is set.
blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1}') blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1}')
fi fi
else else
@@ -61,14 +61,6 @@ CalcPercentBlockedToday() {
fi fi
} }
CheckIPv6() {
piholeIPv6file="/etc/pihole/.useIPv6"
if [[ -f ${piholeIPv6file} ]];then
# If the file exists, then the user previously chose to use IPv6 in the automated installer
piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
fi
}
outputJSON() { outputJSON() {
CalcQueriesToday CalcQueriesToday
CalcblockedToday CalcblockedToday
@@ -88,7 +80,7 @@ normalChrono() {
echo "| _/ |___| ' \/ _ \ / -_)" echo "| _/ |___| ' \/ _ \ / -_)"
echo "|_| |_| |_||_\___/_\___|" echo "|_| |_| |_||_\___/_\___|"
echo "" echo ""
echo " $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)" echo " ${IPV4_ADDRESS}"
echo "" echo ""
uptime | cut -d' ' -f11- uptime | cut -d' ' -f11-
#uptime -p #Doesn't work on all versions of uptime #uptime -p #Doesn't work on all versions of uptime
@@ -111,8 +103,6 @@ normalChrono() {
CalcBlockedDomains CalcBlockedDomains
echo "Blocking: ${blockedDomainsTotal}" echo "Blocking: ${blockedDomainsTotal}"
#below commented line does not add up to todaysQueryCount
#echo "Queries: $todaysQueryCountV4 / $todaysQueryCountV6"
echo "Queries: ${queriesToday}" #same total calculation as dashboard echo "Queries: ${queriesToday}" #same total calculation as dashboard
echo "Pi-holed: ${blockedToday} (${percentBlockedToday}%)" echo "Pi-holed: ${blockedToday} (${percentBlockedToday}%)"
@@ -131,7 +121,7 @@ displayHelp() {
::: -j, --json output stats as JSON formatted string ::: -j, --json output stats as JSON formatted string
::: -h, --help display this help text ::: -h, --help display this help text
EOM EOM
exit 1 exit 0
} }
if [[ $# = 0 ]]; then if [[ $# = 0 ]]; then

27
advanced/Scripts/list.sh Normal file → Executable file
View File

@@ -47,12 +47,21 @@ helpFunc() {
::: -h, --help Show this help dialog ::: -h, --help Show this help dialog
::: -l, --list Display your ${word}listed domains ::: -l, --list Display your ${word}listed domains
EOM EOM
exit 1 exit 0
}
EscapeRegexp() {
# This way we may safely insert an arbitrary
# string in our regular expressions
echo $* | sed "s/[]\\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
} }
HandleOther(){ HandleOther(){
#check validity of domain # First, convert everything to lowercase
validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/') domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
#check validity of domain
validDomain=$(perl -ne "print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/" <<< "$domain")
if [ -z "${validDomain}" ]; then if [ -z "${validDomain}" ]; then
echo "::: $1 is not a valid argument or domain name" echo "::: $1 is not a valid argument or domain name"
else else
@@ -77,12 +86,12 @@ PoplistFile() {
} }
AddDomain() { AddDomain() {
list="$2" list="$2"
domain=$(EscapeRegexp "$1")
bool=true bool=true
#Is the domain in the list we want to add it to? #Is the domain in the list we want to add it to?
grep -Ex -q "$1" ${list} > /dev/null 2>&1 || bool=false grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
if [[ "${bool}" == false ]]; then if [[ "${bool}" == false ]]; then
#domain not found in the whitelist file, add it! #domain not found in the whitelist file, add it!
@@ -101,14 +110,16 @@ AddDomain() {
RemoveDomain() { RemoveDomain() {
list="$2" list="$2"
domain=$(EscapeRegexp "$1")
bool=true bool=true
#Is it in the other list? Logic follows that if its whitelisted it should not be blacklisted and vice versa #Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
grep -Ex -q "$1" ${list} > /dev/null 2>&1 || bool=false grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
if [[ "${bool}" == true ]]; then if [[ "${bool}" == true ]]; then
# Remove it from the other one # Remove it from the other one
echo "::: Removing $1 from $list..." echo "::: Removing $1 from $list..."
echo "$1" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' ${list} # /I flag: search case-insensitive
sed -i "/${domain}/Id" ${list}
reload=true reload=true
else else
if [[ "${verbose}" == true ]]; then if [[ "${verbose}" == true ]]; then

View File

@@ -27,7 +27,7 @@ PIHOLELOG="/var/log/pihole.log"
WHITELISTMATCHES="/tmp/whitelistmatches.list" WHITELISTMATCHES="/tmp/whitelistmatches.list"
IPV6_READY=false IPV6_READY=false
TIMEOUT=60
# Header info and introduction # Header info and introduction
cat << EOM cat << EOM
::: Beginning Pi-hole debug at $(date)! ::: Beginning Pi-hole debug at $(date)!
@@ -316,6 +316,16 @@ debugLighttpd() {
echo ":::" echo ":::"
} }
countdown() {
tuvix=${TIMEOUT}
printf "::: Logging will automatically teminate in ${TIMEOUT} seconds\n"
while [ $tuvix -ge 1 ]
do
printf ":::\t${tuvix} seconds left. \r"
sleep 5
tuvix=$(( tuvix - 5 ))
done
}
### END FUNCTIONS ### ### END FUNCTIONS ###
# Gather version of required packages / repositories # Gather version of required packages / repositories
@@ -356,10 +366,9 @@ dumpPiHoleLog() {
echo -e "::: Try loading a site that you are having trouble with now from a client web browser.. \n:::\t(Press CTRL+C to finish logging.)" echo -e "::: Try loading a site that you are having trouble with now from a client web browser.. \n:::\t(Press CTRL+C to finish logging.)"
header_write "pihole.log" header_write "pihole.log"
if [ -e "${PIHOLELOG}" ]; then if [ -e "${PIHOLELOG}" ]; then
while true; do # Dummy process to use for flagging down tail to terminate
tail -f "${PIHOLELOG}" >> ${DEBUG_LOG} countdown &
log_write "" tail -n0 -f --pid=$! "${PIHOLELOG}" >> ${DEBUG_LOG}
done
else else
log_write "No pihole.log file found!" log_write "No pihole.log file found!"
printf ":::\tNo pihole.log file found!\n" printf ":::\tNo pihole.log file found!\n"
@@ -384,10 +393,13 @@ finalWork() {
# Check if tricorder.pi-hole.net is reachable and provide token. # Check if tricorder.pi-hole.net is reachable and provide token.
if [ -n "${tricorder}" ]; then if [ -n "${tricorder}" ]; then
echo "::: Your debug token is : ${tricorder}" echo "::: Your debug token is : ${tricorder}"
echo "::: Please contact the Pi-hole team with your token to being assistance." echo "::: Please contact the Pi-hole team with your token for assistance."
echo "::: Thank you." echo "::: Thank you."
else
echo "::: There was an error uploading your debug log."
echo "::: Please try again or contact the Pi-hole team for assistance."
fi fi
echo "::: Debug log can be found at : /var/log/pihole_debug.log" echo "::: A local copy of the Debug log can be found at : /var/log/pihole_debug.log"
} }
trap finalWork EXIT trap finalWork EXIT

View File

@@ -3,7 +3,9 @@
# (c) 2015, 2016 by Jacob Salmela # (c) 2015, 2016 by Jacob Salmela
# Network-wide ad blocking via your Raspberry Pi # Network-wide ad blocking via your Raspberry Pi
# http://pi-hole.net # http://pi-hole.net
# Whitelists domains # Check Pi-hole core and admin pages versions and determine what
# upgrade (if any) is required. Automatically updates and reinstalls
# application if update is detected.
# #
# Pi-hole is free software: you can redistribute it and/or modify # Pi-hole is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
@@ -12,131 +14,153 @@
# Variables # Variables
webInterfaceGitUrl="https://github.com/pi-hole/AdminLTE.git" readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
webInterfaceDir="/var/www/html/admin" readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
piholeGitUrl="https://github.com/pi-hole/pi-hole.git" readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
piholeFilesDir="/etc/.pihole" readonly PI_HOLE_FILES_DIR="/etc/.pihole"
spinner() {
local pid=${1}
local delay=0.50
local spinstr='/-\|'
while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
local temp=${spinstr#?}
printf " [%c] " "${spinstr}"
local spinstr=${temp}${spinstr%"$temp"}
sleep ${delay}
printf "\b\b\b\b\b\b"
done
printf " \b\b\b\b"
}
getGitFiles() {
# Setup git repos for directory and repository passed
# as arguments 1 and 2
echo ":::"
echo "::: Checking for existing repository..."
if is_repo "${1}"; then
update_repo "${1}"
else
make_repo "${1}" "${2}"
fi
}
is_repo() { is_repo() {
# Use git to check if directory is currently under VCS # Use git to check if directory is currently under VCS, return the value
echo -n "::: Checking $1 is a repo..." local directory="${1}"
cd "${1}" &> /dev/null || return 1
git status &> /dev/null && echo " OK!"; return 0 || echo " not found!"; return 1 git -C "${directory}" status --short &> /dev/null
return
}
prep_repo() {
# Prepare directory for local repository building
local directory="${1}"
rm -rf "${directory}" &> /dev/null
return
} }
make_repo() { make_repo() {
# Remove the non-repod interface and clone the interface # Remove the non-repod interface and clone the interface
echo -n "::: Cloning $2 into $1..." local remoteRepo="${2}"
rm -rf "${1}" local directory="${1}"
git clone -q --depth 1 "${2}" "${1}" > /dev/null & spinner $!
echo " done!" (prep_repo "${directory}" && git clone -q --depth 1 "${remoteRepo}" "${directory}" > /dev/null)
return
} }
update_repo() { update_repo() {
# Pull the latest commits local directory="${1}"
echo -n "::: Updating repo in $1..." local retVal=0
cd "${1}" || exit 1 # Pull the latest commits
git stash -q > /dev/null & spinner $!
git pull -q > /dev/null & spinner $! # Stash all files not tracked for later retrieval
echo " done!" git -C "${directory}" stash --all --quiet &> /dev/null || ${retVal}=1
# Force a clean working directory for cloning
git -C "${directory}" clean --force -d &> /dev/null || ${retVal}=1
# Fetch latest changes and apply
git -C "${directory}" pull --quiet &> /dev/null || ${retVal}=1
return ${retVal}
} }
if [ ! -d "/etc/.pihole" ]; then #This is unlikely getGitFiles() {
echo "::: Critical Error: Pi-Hole repo missing from system!" # Setup git repos for directory and repository passed
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole" # as arguments 1 and 2
exit 1; local directory="${1}"
fi local remoteRepo="${2}"
if [ ! -d "/var/www/html/admin" ]; then #This is unlikely echo ":::"
echo "::: Critical Error: Pi-Hole repo missing from system!" echo "::: Checking for existing repository..."
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole" if is_repo "${directory}"; then
exit 1; echo -n "::: Updating repository in ${directory}..."
fi update_repo "${directory}" || (echo "*** Error: Could not update local repository. Contact support."; exit 1)
echo " done!"
else
echo -n "::: Cloning ${remoteRepo} into ${directory}..."
make_repo "${directory}" "${remoteRepo}" || (echo "Unable to clone repository, please contact support"; exit 1)
echo " done!"
fi
}
echo "::: Checking for updates..." main() {
piholeVersion=$(pihole -v -p -c) local pihole_version_current
piholeVersionLatest=$(pihole -v -p -l) local pihole_version_latest
local web_version_current
local web_version_latest
webVersion=$(pihole -v -a -c) if ! is_repo "${PI_HOLE_FILES_DIR}" || ! is_repo "${ADMIN_INTERFACE_DIR}" ; then #This is unlikely
webVersionLatest=$(pihole -v -a -l) echo "::: Critical Error: One or more Pi-Hole repos are missing from system!"
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
exit 1;
fi
echo ":::" echo "::: Checking for updates..."
echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)" # Checks Pi-hole version string in format vX.X.X
echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)" pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
echo ":::" pihole_version_latest="$(/usr/local/bin/pihole version --pihole --latest)"
web_version_current="$(/usr/local/bin/pihole version --admin --current)"
web_version_latest="$(/usr/local/bin/pihole version --admin --latest)"
# Logic if [[ "${pihole_version_latest}" == "-1" || "${web_version_latest}" == "-1" ]]; then
# If latest versions are blank - we've probably hit Github rate limit (stop running `pihole -up so often!): echo "*** Unable to contact GitHub for latest version. Please try again later, contact support if this continues."
# Update anyway exit 1
# If Core up to date AND web up to date: fi
# Do nothing
# If Core up to date AND web NOT up to date:
# Pull web repo
# If Core NOT up to date AND web up to date:
# pull pihole repo, run install --unattended -- reconfigure
# if Core NOT up to date AND web NOT up to date:
# pull pihole repo run install --unattended
# Logic
# If latest versions are blank - we've probably hit Github rate limit (stop running `pihole -up so often!):
# Update anyway
# If Core up to date AND web up to date:
# Do nothing
# If Core up to date AND web NOT up to date:
# Pull web repo
# If Core NOT up to date AND web up to date:
# pull pihole repo, run install --unattended -- reconfigure
# if Core NOT up to date AND web NOT up to date:
# pull pihole repo run install --unattended
if [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
echo ":::"
echo "::: Pi-hole version is $pihole_version_current"
echo "::: Web Admin version is $web_version_current"
echo ":::"
echo "::: Everything is up to date!"
exit 0
if [[ ${piholeVersion} == ${piholeVersionLatest} && ${webVersion} == ${webVersionLatest} ]]; then elif [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
echo "::: Everything is up to date!" echo ":::"
echo "" echo "::: Pi-hole Web Admin files out of date"
exit 0 getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
elif [[ ${piholeVersion} == ${piholeVersionLatest} && ${webVersion} != ${webVersionLatest} ]]; then web_updated=true
echo "::: Pi-hole Web Admin files out of date"
getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
echo ":::" echo "::: Pi-hole core files out of date"
webVersion=$(pihole -v -a -c) getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
echo "::: Web Admin version is now at ${webVersion}" /etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
echo "::: If you had made any changes in '/var/www/html/admin', they have been stashed using 'git stash'" core_updated=true
echo ""
elif [[ ${piholeVersion} != ${piholeVersionLatest} && ${webVersion} == ${webVersionLatest} ]]; then elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
echo "::: Pi-hole core files out of date" echo "::: Updating Everything"
getGitFiles ${piholeFilesDir} ${piholeGitUrl} getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
/etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended /etc/.pihole/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
echo ":::" web_updated=true
piholeVersion=$(pihole -v -p -c) core_updated=true
echo "::: Pi-hole version is now at ${piholeVersion}" else
echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'" echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
echo "" exit 1
elif [[ ${piholeVersion} != ${piholeVersionLatest} && ${webVersion} != ${webVersionLatest} ]]; then fi
echo "::: Updating Everything"
getGitFiles ${piholeFilesDir} ${piholeGitUrl} if [[ "${web_updated}" == true ]]; then
/etc/.pihole/automated\ install/basic-install.sh --unattended web_version_current="$(/usr/local/bin/pihole version --admin --current)"
webVersion=$(pihole -v -a -c) echo ":::"
piholeVersion=$(pihole -v -p -c) echo "::: Web Admin version is now at ${web_version_current}"
echo ":::" echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
echo "::: Pi-hole version is now at ${piholeVersion}" fi
echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'"
echo ":::" if [[ "${core_updated}" == true ]]; then
echo "::: Pi-hole version is now at ${piholeVersion}" pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'" echo ":::"
echo "" echo "::: Pi-hole version is now at ${pihole_version_current}"
fi echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
fi
echo ""
exit 0
}
main

View File

@@ -14,6 +14,8 @@
latest=false latest=false
current=false current=false
DEFAULT="-1"
normalOutput() { normalOutput() {
piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0) piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0) webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
@@ -21,8 +23,8 @@ normalOutput() {
piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest})" echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest})" echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
} }
webOutput() { webOutput() {
@@ -36,14 +38,14 @@ webOutput() {
if [[ "${latest}" == true && "${current}" == false ]]; then if [[ "${latest}" == true && "${current}" == false ]]; then
webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
echo ${webVersionLatest} echo "${webVersionLatest:--1}"
elif [[ "${latest}" == false && "${current}" == true ]]; then elif [[ "${latest}" == false && "${current}" == true ]]; then
webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0) webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
echo ${webVersion} echo "${webVersion}"
else else
webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0) webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
echo "::: Web-Admin version is $webVersion (Latest version is $webVersionLatest)" echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
fi fi
} }
@@ -58,14 +60,14 @@ coreOutput() {
if [[ "${latest}" == true && "${current}" == false ]]; then if [[ "${latest}" == true && "${current}" == false ]]; then
piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
echo ${piholeVersionLatest} echo "${piholeVersionLatest:--1}"
elif [[ "${latest}" == false && "${current}" == true ]]; then elif [[ "${latest}" == false && "${current}" == true ]]; then
piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0) piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
echo ${piholeVersion} echo "${piholeVersion}"
else else
piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0) piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//') piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)" echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
fi fi
} }
@@ -84,7 +86,7 @@ helpFunc() {
::: -h, --help Show this help dialog ::: -h, --help Show this help dialog
::: :::
EOM EOM
exit 1 exit 0
} }
if [[ $# = 0 ]]; then if [[ $# = 0 ]]; then

242
advanced/Scripts/webpage.sh Executable file
View File

@@ -0,0 +1,242 @@
#!/usr/bin/env bash
# Pi-hole: A black hole for Internet advertisements
# Network-wide ad blocking via your Raspberry Pi
# http://pi-hole.net
# Web interface settings
#
# Pi-hole is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
args=("$@")
helpFunc() {
cat << EOM
::: Set admin options for the web interface of pihole
:::
::: Usage: pihole -a [options]
:::
::: Options:
::: -p, password Set web interface password, an empty input will remove any previously set password
::: -c, celsius Set Celsius temperature unit
::: -f, fahrenheit Set Fahrenheit temperature unit
::: -k, kelvin Set Kelvin temperature unit
::: -h, --help Show this help dialog
EOM
exit 0
}
SetTemperatureUnit(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/TEMPERATUREUNIT/d' /etc/pihole/setupVars.conf
# Save setting to file
echo "TEMPERATUREUNIT=${unit}" >> /etc/pihole/setupVars.conf
}
SetWebPassword(){
if [ "${SUDO_USER}" == "www-data" ]; then
echo "Security measure: user www-data is not allowed to change webUI password!"
echo "Exiting"
exit 1
fi
if [ "${SUDO_USER}" == "lighttpd" ]; then
echo "Security measure: user lighttpd is not allowed to change webUI password!"
echo "Exiting"
exit 1
fi
# Remove password from file (create backup setupVars.conf.bak)
sed -i.bak '/WEBPASSWORD/d' /etc/pihole/setupVars.conf
# Set password only if there is one to be set
if (( ${#args[2]} > 0 )) ; then
# Compute password hash twice to avoid rainbow table vulnerability
hash=$(echo -n ${args[2]} | sha256sum | sed 's/\s.*$//')
hash=$(echo -n ${hash} | sha256sum | sed 's/\s.*$//')
# Save hash to file
echo "WEBPASSWORD=${hash}" >> /etc/pihole/setupVars.conf
echo "New password set"
else
echo "Password removed"
fi
}
SetDNSServers(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/DNS_FQDN_REQUIRED/d;' /etc/pihole/setupVars.conf
# Save setting to file
echo "PIHOLE_DNS_1=${args[2]}" >> /etc/pihole/setupVars.conf
if [[ "${args[3]}" != "none" ]]; then
echo "PIHOLE_DNS_2=${args[3]}" >> /etc/pihole/setupVars.conf
else
echo "PIHOLE_DNS_2=" >> /etc/pihole/setupVars.conf
fi
# Replace within actual dnsmasq config file
sed -i '/server=/d;' /etc/dnsmasq.d/01-pihole.conf
echo "server=${args[2]}" >> /etc/dnsmasq.d/01-pihole.conf
if [[ "${args[3]}" != "none" ]]; then
echo "server=${args[3]}" >> /etc/dnsmasq.d/01-pihole.conf
fi
# Remove domain-needed entry
sed -i '/domain-needed/d;' /etc/dnsmasq.d/01-pihole.conf
# Readd it if required
if [[ "${args[4]}" == "domain-needed" ]]; then
echo "domain-needed" >> /etc/dnsmasq.d/01-pihole.conf
echo "DNS_FQDN_REQUIRED=true" >> /etc/pihole/setupVars.conf
else
# Leave it deleted if not wanted
echo "DNS_FQDN_REQUIRED=false" >> /etc/pihole/setupVars.conf
fi
# Remove bogus-priv entry
sed -i '/bogus-priv/d;' /etc/dnsmasq.d/01-pihole.conf
# Readd it if required
if [[ "${args[5]}" == "bogus-priv" ]]; then
echo "bogus-priv" >> /etc/dnsmasq.d/01-pihole.conf
echo "DNS_BOGUS_PRIV=true" >> /etc/pihole/setupVars.conf
else
# Leave it deleted if not wanted
echo "DNS_BOGUS_PRIV=false" >> /etc/pihole/setupVars.conf
fi
# Restart dnsmasq to load new configuration
RestartDNS
}
SetExcludeDomains(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/API_EXCLUDE_DOMAINS/d;' /etc/pihole/setupVars.conf
# Save setting to file
echo "API_EXCLUDE_DOMAINS=${args[2]}" >> /etc/pihole/setupVars.conf
}
SetExcludeClients(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/API_EXCLUDE_CLIENTS/d;' /etc/pihole/setupVars.conf
# Save setting to file
echo "API_EXCLUDE_CLIENTS=${args[2]}" >> /etc/pihole/setupVars.conf
}
Reboot(){
nohup bash -c "sleep 5; reboot" &> /dev/null </dev/null &
}
RestartDNS(){
if [ -x "$(command -v systemctl)" ]; then
systemctl restart dnsmasq &> /dev/null
else
service dnsmasq restart &> /dev/null
fi
}
SetQueryLogOptions(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/API_QUERY_LOG_SHOW/d;' /etc/pihole/setupVars.conf
# Save setting to file
echo "API_QUERY_LOG_SHOW=${args[2]}" >> /etc/pihole/setupVars.conf
}
EnableDHCP(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/DHCP_/d;' /etc/pihole/setupVars.conf
echo "DHCP_ACTIVE=true" >> /etc/pihole/setupVars.conf
echo "DHCP_START=${args[2]}" >> /etc/pihole/setupVars.conf
echo "DHCP_END=${args[3]}" >> /etc/pihole/setupVars.conf
echo "DHCP_ROUTER=${args[4]}" >> /etc/pihole/setupVars.conf
# Remove setting from file
sed -i '/dhcp-/d;/quiet-dhcp/d;' /etc/dnsmasq.d/01-pihole.conf
# Save setting to file
echo "dhcp-range=${args[2]},${args[3]},infinite" >> /etc/dnsmasq.d/01-pihole.conf
echo "dhcp-option=option:router,${args[4]}" >> /etc/dnsmasq.d/01-pihole.conf
# Changes the behaviour from strict RFC compliance so that DHCP requests on unknown leases from unknown hosts are not ignored. This allows new hosts to get a lease without a tedious timeout under all circumstances. It also allows dnsmasq to rebuild its lease database without each client needing to reacquire a lease, if the database is lost.
echo "dhcp-authoritative" >> /etc/dnsmasq.d/01-pihole.conf
# Use the specified file to store DHCP lease information
echo "dhcp-leasefile=/etc/pihole/dhcp.leases" >> /etc/dnsmasq.d/01-pihole.conf
# Suppress logging of the routine operation of these protocols. Errors and problems will still be logged, though.
echo "quiet-dhcp" >> /etc/dnsmasq.d/01-pihole.conf
echo "quiet-dhcp6" >> /etc/dnsmasq.d/01-pihole.conf
RestartDNS
}
DisableDHCP(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/DHCP_ACTIVE/d;' /etc/pihole/setupVars.conf
echo "DHCP_ACTIVE=false" >> /etc/pihole/setupVars.conf
# Remove setting from file
sed -i '/dhcp-/d;/quiet-dhcp/d;' /etc/dnsmasq.d/01-pihole.conf
RestartDNS
}
SetWebUILayout(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/WEBUIBOXEDLAYOUT/d;' /etc/pihole/setupVars.conf
echo "WEBUIBOXEDLAYOUT=${args[2]}" >> /etc/pihole/setupVars.conf
}
SetDNSDomainName(){
# Remove setting from file (create backup setupVars.conf.bak)
sed -i.bak '/PIHOLE_DOMAIN/d;' /etc/pihole/setupVars.conf
# Save setting to file
echo "PIHOLE_DOMAIN=${args[2]}" >> /etc/pihole/setupVars.conf
# Replace within actual dnsmasq config file
sed -i '/domain=/d;' /etc/dnsmasq.d/01-pihole.conf
echo "domain=${args[2]}" >> /etc/dnsmasq.d/01-pihole.conf
# Restart dnsmasq to load new configuration
RestartDNS
}
case "${args[1]}" in
"-p" | "password" ) SetWebPassword;;
"-c" | "celsius" ) unit="C"; SetTemperatureUnit;;
"-f" | "fahrenheit" ) unit="F"; SetTemperatureUnit;;
"-k" | "kelvin" ) unit="K"; SetTemperatureUnit;;
"setdns" ) SetDNSServers;;
"setexcludedomains" ) SetExcludeDomains;;
"setexcludeclients" ) SetExcludeClients;;
"reboot" ) Reboot;;
"restartdns" ) RestartDNS;;
"setquerylog" ) SetQueryLogOptions;;
"enabledhcp" ) EnableDHCP;;
"disabledhcp" ) DisableDHCP;;
"layout" ) SetWebUILayout;;
"-h" | "--help" ) helpFunc;;
"domainname" ) SetDNSDomainName;;
* ) helpFunc;;
esac
shift
if [[ $# = 0 ]]; then
helpFunc
fi

View File

@@ -3,7 +3,7 @@ _pihole() {
COMPREPLY=() COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}" cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}" prev="${COMP_WORDS[COMP_CWORD-1]}"
opts="blacklist chronometer debug flush help query reconfigure setupLCD uninstall updateGravity updatePihole version whitelist" opts="admin blacklist chronometer debug disable enable flush help logging query reconfigure restartdns setupLCD status tail uninstall updateGravity updatePihole version whitelist"
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) ) COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
return 0 return 0

View File

@@ -8,7 +8,7 @@
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or # the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version. # (at your option) any later version.
# #
# This file is under source-control of the Pi-hole installation and update # This file is under source-control of the Pi-hole installation and update
# scripts, any changes made to this file will be overwritten when the softare # scripts, any changes made to this file will be overwritten when the softare
# is updated or re-installed. Please make any changes to the appropriate crontab # is updated or re-installed. Please make any changes to the appropriate crontab
@@ -16,11 +16,11 @@
# Pi-hole: Update the ad sources once a week on Sunday at 01:59 # Pi-hole: Update the ad sources once a week on Sunday at 01:59
# Download any updates from the adlists # Download any updates from the adlists
59 1 * * 7 root /usr/local/bin/pihole updateGravity 59 1 * * 7 root PATH="$PATH:/usr/local/bin/" pihole updateGravity
# Pi-hole: Update Pi-hole! Uncomment to enable auto update # Pi-hole: Update Pi-hole! Uncomment to enable auto update
#30 2 * * 7 root /usr/local/bin/pihole updatePihole #30 2 * * 7 root PATH="$PATH:/usr/local/bin/" pihole updatePihole
# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control # Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
# Stats will be viewable in the Web interface thanks to the cron job above # Stats will be viewable in the Web interface thanks to the cron job above
00 00 * * * root /usr/local/bin/pihole flush 00 00 * * * root PATH="$PATH:/usr/local/bin/" pihole flush

File diff suppressed because it is too large Load Diff

View File

@@ -82,7 +82,7 @@ removeAndPurge() {
read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
case ${yn} in case ${yn} in
[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;; [Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
[Nn]* ) printf ":::\tSkipping %s" "${i}\n"; break;; [Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
* ) printf "::: You must answer yes or no!\n";; * ) printf "::: You must answer yes or no!\n";;
esac esac
done done
@@ -136,7 +136,7 @@ removeNoPurge() {
fi fi
echo "::: Removing config files and scripts..." echo "::: Removing config files and scripts..."
package_check ${i} > /dev/null package_check lighttpd > /dev/null
if [ $? -eq 1 ]; then if [ $? -eq 1 ]; then
${SUDO} rm -rf /etc/lighttpd/ &> /dev/null ${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
else else
@@ -154,6 +154,12 @@ removeNoPurge() {
${SUDO} rm /usr/local/bin/pihole &> /dev/null ${SUDO} rm /usr/local/bin/pihole &> /dev/null
${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null ${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
${SUDO} rm /etc/sudoers.d/pihole &> /dev/null ${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
# If the pihole user exists, then remove
if id "pihole" >/dev/null 2>&1; then
echo "::: Removing pihole user..."
${SUDO} userdel -r pihole
fi
echo ":::" echo ":::"
printf "::: Finished removing PiHole from your system. Sorry to see you go!\n" printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"

1
autotest Executable file
View File

@@ -0,0 +1 @@
py.test -v -f test/

View File

@@ -23,7 +23,7 @@ helpFunc() {
::: -f, --force Force lists to be downloaded, even if they don't need updating. ::: -f, --force Force lists to be downloaded, even if they don't need updating.
::: -h, --help Show this help dialog ::: -h, --help Show this help dialog
EOM EOM
exit 1 exit 0
} }
@@ -44,12 +44,14 @@ else
fi fi
#Remove the /* from the end of the IPv4addr. #Remove the /* from the end of the IPv4addr.
IPv4_address=${IPv4_address%/*} IPV4_ADDRESS=${IPV4_ADDRESS%/*}
IPV6_ADDRESS=${IPV6_ADDRESS}
# Variables for various stages of downloading and formatting the list # Variables for various stages of downloading and formatting the list
basename=pihole basename=pihole
piholeDir=/etc/${basename} piholeDir=/etc/${basename}
adList=${piholeDir}/gravity.list adList=${piholeDir}/gravity.list
localList=${piholeDir}/local.list
justDomainsExtension=domains justDomainsExtension=domains
matterAndLight=${basename}.0.matterandlight.txt matterAndLight=${basename}.0.matterandlight.txt
supernova=${basename}.1.supernova.txt supernova=${basename}.1.supernova.txt
@@ -189,7 +191,7 @@ gravity_Blacklist() {
if [[ -f "${blacklistFile}" ]]; then if [[ -f "${blacklistFile}" ]]; then
numBlacklisted=$(wc -l < "${blacklistFile}") numBlacklisted=$(wc -l < "${blacklistFile}")
plural=; [[ "$numBlacklisted" != "1" ]] && plural=s plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
echo -n "::: BlackListing $numBlacklisted domain${plural}..." echo -n "::: Blacklisting $numBlacklisted domain${plural}..."
cat ${blacklistFile} >> ${piholeDir}/${eventHorizon} cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
echo " done!" echo " done!"
else else
@@ -240,30 +242,42 @@ gravity_unique() {
gravity_hostFormat() { gravity_hostFormat() {
# Format domain list as "192.168.x.x domain.com" # Format domain list as "192.168.x.x domain.com"
echo "::: Formatting domains into a HOSTS file..." echo -n "::: Formatting domains into a HOSTS file..."
# Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
if [[ -n "${IPv4_address}" && -n "${IPv6_address}" ]];then
# Both IPv4 and IPv6 if [[ -f /etc/hostname ]]; then
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4_address" -v ipv6addr="$IPv6_address" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc} hostname=$(</etc/hostname)
elif [ -x "$(command -v hostname)" ]; then
hostname=$(hostname -f)
else
echo "::: Error: Unable to determine fully qualified domain name of host"
fi
# Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
elif [[ -n "${IPv4_address}" && -z "${IPv6_address}" ]];then echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV6_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole\n${IPV6_ADDRESS} pi.hole" > ${localList}
# Both IPv4 and IPv6
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
# Only IPv4 elif [[ -n "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4_address" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
elif [[ -z "${IPv4_address}" && -n "${IPv6_address}" ]];then echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole" > ${localList}
# Only IPv4
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
# Only IPv6 elif [[ -z "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
cat ${piholeDir}/${eventHorizon} | awk -v ipv6addr="$IPv6_address" '{sub(/\r$/,""); print ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
elif [[ -z "${IPv4_address}" && -z "${IPv6_address}" ]];then echo -e "${IPV6_ADDRESS} ${hostname}\n${IPV6_ADDRESS} pi.hole" > ${localList}
echo "::: No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values" # Only IPv6
exit 1 cat ${piholeDir}/${eventHorizon} | awk -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
fi
elif [[ -z "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
echo "::: No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values"
exit 1
fi
# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it # Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
cp ${piholeDir}/${accretionDisc} ${adList} cp ${piholeDir}/${accretionDisc} ${adList}
echo " done!"
} }
# blackbody - remove any remnant files from script processes # blackbody - remove any remnant files from script processes
@@ -287,8 +301,14 @@ gravity_advanced() {
echo -n "::: Formatting list of domains to remove comments...." echo -n "::: Formatting list of domains to remove comments...."
#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova} #awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment') #Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
#Add additional awk command to read all lines up to a '#', and then continue as we were #Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
cat ${piholeDir}/${matterAndLight} | awk -F'#' '{print $1}' | awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova} #Last awk command takes non-commented lines and if they have 2 fields, take the left field (the domain) and leave
#+ the right (IP address), otherwise grab the single field.
cat ${piholeDir}/${matterAndLight} | \
awk -F '#' '{print $1}' | \
awk -F '/' '{print $1}' | \
awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | \
sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
echo " done!" echo " done!"
numberOf=$(wc -l < ${piholeDir}/${supernova}) numberOf=$(wc -l < ${piholeDir}/${supernova})
@@ -306,7 +326,7 @@ gravity_reload() {
# Reload hosts file # Reload hosts file
echo ":::" echo ":::"
echo "::: Refresh lists in dnsmasq..." echo -n "::: Refresh lists in dnsmasq..."
#ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list! #ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
#First escape forward slashes in the path: #First escape forward slashes in the path:
@@ -314,7 +334,8 @@ gravity_reload() {
#Now replace the line in dnsmasq file #Now replace the line in dnsmasq file
# sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf # sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
pihole restartdns pihole restartdns
echo " done!"
} }
for var in "$@"; do for var in "$@"; do

206
pihole
View File

@@ -10,87 +10,107 @@
# the Free Software Foundation, either version 2 of the License, or # the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version. # (at your option) any later version.
PI_HOLE_SCRIPT_DIR="/opt/pihole"
# Must be root to use this tool # Must be root to use this tool
if [[ ! $EUID -eq 0 ]];then if [[ ! $EUID -eq 0 ]];then
if [ -x "$(command -v sudo)" ];then if [ -x "$(command -v sudo)" ];then
exec sudo bash "$0" "$@" exec sudo bash "$0" "$@"
exit $? exit $?
else else
echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo." echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo."
exit 1 exit 1
fi fi
fi fi
webpageFunc() {
/opt/pihole/webpage.sh "$@"
exit 0
}
whitelistFunc() { whitelistFunc() {
/opt/pihole/list.sh "$@" "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
exit 0 exit 0
} }
blacklistFunc() { blacklistFunc() {
/opt/pihole/list.sh "$@" "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
exit 0 exit 0
} }
debugFunc() { debugFunc() {
/opt/pihole/piholeDebug.sh "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
exit 0 exit 0
} }
flushFunc() { flushFunc() {
/opt/pihole/piholeLogFlush.sh "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
exit 0 exit 0
} }
updatePiholeFunc() { updatePiholeFunc() {
/opt/pihole/update.sh "${PI_HOLE_SCRIPT_DIR}"/update.sh
exit 0 exit 0
} }
reconfigurePiholeFunc() { reconfigurePiholeFunc() {
/etc/.pihole/automated\ install/basic-install.sh --reconfigure /etc/.pihole/automated\ install/basic-install.sh --reconfigure
exit 0; exit 0;
} }
updateGravityFunc() { updateGravityFunc() {
/opt/pihole/gravity.sh "$@" "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
exit 0 exit 0
} }
setupLCDFunction() { setupLCDFunction() {
/opt/pihole/setupLCD.sh "${PI_HOLE_SCRIPT_DIR}"/setupLCD.sh
exit 0 exit 0
}
scanList(){
domain="${1}"
list="${2}"
method="${3}"
if [[ ${method} == "-exact" ]] ; then
grep -E "(^|\s)${domain}($|\s)" "${list}"
else
grep "${domain}" "${list}"
fi
} }
queryFunc() { queryFunc() {
domain=$2 domain="${2}"
for list in /etc/pihole/list.*; do method="${3}"
count=$(grep ${domain} $list | wc -l) lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
echo "::: ${list} (${count} results)" for list in ${lists[@]}; do
if [[ ${count} > 0 ]]; then result=$(scanList ${domain} ${list} ${method})
grep ${domain} ${list} # Remove empty lines before couting number of results
fi count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
echo "" echo "::: ${list} (${count} results)"
done if [[ ${count} > 0 ]]; then
exit 0 echo "${result}"
fi
echo ""
done
exit 0
} }
chronometerFunc() { chronometerFunc() {
shift shift
/opt/pihole/chronometer.sh "$@" "${PI_HOLE_SCRIPT_DIR}"/chronometer.sh "$@"
exit 0 exit 0
} }
uninstallFunc() { uninstallFunc() {
/opt/pihole/uninstall.sh "${PI_HOLE_SCRIPT_DIR}"/uninstall.sh
exit 0 exit 0
} }
versionFunc() { versionFunc() {
shift shift
/opt/pihole/version.sh "$@" "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
exit 0 exit 0
} }
restartDNS() { restartDNS() {
@@ -115,8 +135,26 @@ restartDNS() {
piholeEnable() { piholeEnable() {
if [[ "${1}" == "0" ]] ; then if [[ "${1}" == "0" ]] ; then
#Disable Pihole #Disable Pihole
sed -i 's/^addn-hosts/#addn-hosts/' /etc/dnsmasq.d/01-pihole.conf sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
echo "::: Blocking has been disabled!" echo "::: Blocking has been disabled!"
if [[ $# > 1 ]] ; then
if [[ ${2} == *"s"* ]] ; then
tt=${2%"s"}
echo "::: Blocking will be re-enabled in ${tt} seconds"
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
elif [[ ${2} == *"m"* ]] ; then
tt=${2%"m"}
echo "::: Blocking will be re-enabled in ${tt} minutes"
tt=$((${tt}*60))
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
else
echo "::: Unknown format for delayed reactivation of the blocking!"
echo "::: Example:"
echo "::: pihole disable 5s - will disable blocking for 5 seconds"
echo "::: pihole disable 7m - will disable blocking for 7 minutes"
echo "::: Blocking will not automatically be re-enabled!"
fi
fi
else else
#Enable pihole #Enable pihole
echo "::: Blocking has been enabled!" echo "::: Blocking has been enabled!"
@@ -125,15 +163,36 @@ piholeEnable() {
restartDNS restartDNS
} }
piholeLogging() {
shift
if [[ "${1}" == "off" ]] ; then
#Disable Logging
sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
pihole -f
echo "::: Logging has been disabled!"
elif [[ "${1}" == "on" ]] ; then
#Enable logging
sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
echo "::: Logging has been enabled!"
else
echo "::: Invalid option passed, please pass 'on' or 'off'"
exit 1
fi
restartDNS
}
piholeStatus() { piholeStatus() {
if [[ $(cat /etc/dnsmasq.d/01-pihole.conf | grep "#addn-hosts=/") ]] ; then if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
#list is commented out #list is commented out
if [[ "${1}" == "web" ]] ; then if [[ "${1}" == "web" ]] ; then
echo 0; echo 0;
else else
echo "::: Pi-hole blocking is Disabled"; echo "::: Pi-hole blocking is Disabled";
fi fi
elif [[ $(cat /etc/dnsmasq.d/01-pihole.conf | grep "addn-hosts=/") ]] ; then elif [[ $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
#list set #list set
if [[ "${1}" == "web" ]] ; then if [[ "${1}" == "web" ]] ; then
echo 1; echo 1;
@@ -153,57 +212,72 @@ piholeStatus() {
fi fi
} }
tailFunc() {
echo "Press Ctrl-C to exit"
tail -F /var/log/pihole.log
exit 0
}
helpFunc() { helpFunc() {
cat << EOM cat << EOM
::: Control all PiHole specific functions! ::: Control all PiHole specific functions!
::: :::
::: Usage: pihole [options] ::: Usage: pihole [options]
::: Add -h after -w (whitelist), -b (blacklist), or -c (chronometer) for more information on usage ::: Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin) for more information on usage
::: :::
::: Options: ::: Options:
::: -w, whitelist Whitelist domains ::: -w, whitelist Whitelist domains
::: -b, blacklist Blacklist domains ::: -b, blacklist Blacklist domains
::: -d, debug Start a debugging session if having trouble ::: -d, debug Start a debugging session if having trouble
::: -f, flush Flush the pihole.log file ::: -f, flush Flush the pihole.log file
::: -t, tail Output the last lines of the pihole.log file. Lines are appended as the file grows
::: -up, updatePihole Update Pi-hole ::: -up, updatePihole Update Pi-hole
::: -r, reconfigure Reconfigure or Repair Pi-hole
::: -g, updateGravity Update the list of ad-serving domains ::: -g, updateGravity Update the list of ad-serving domains
::: -s, setupLCD Automatically configures the Pi to use the 2.8 LCD screen to display stats on it ::: -s, setupLCD Automatically configures the Pi to use the 2.8 LCD screen to display stats on it
::: -c, chronometer Calculates stats and displays to an LCD ::: -c, chronometer Calculates stats and displays to an LCD
::: -h, help Show this help dialog ::: -h, help Show this help dialog
::: -v, version Show current versions ::: -v, version Show current versions
::: -q, query Query the adlists for a specific domain ::: -q, query Query the adlists for a specific domain
::: Use pihole -q domain -exact if you want to see exact matches only
::: -l, logging Enable or Disable logging (pass 'on' or 'off')
::: -a, admin Admin webpage options
::: uninstall Uninstall Pi-Hole from your system :(! ::: uninstall Uninstall Pi-Hole from your system :(!
::: status Is Pi-Hole Enabled or Disabled ::: status Is Pi-Hole Enabled or Disabled
::: enable Enable Pi-Hole DNS Blocking ::: enable Enable Pi-Hole DNS Blocking
::: disable Disable Pi-Hole DNS Blocking ::: disable Disable Pi-Hole DNS Blocking
::: Blocking can also be disabled only temporarily, e.g.,
::: pihole disable 5m - will disable blocking for 5 minutes
::: restartdns Restart dnsmasq ::: restartdns Restart dnsmasq
EOM EOM
exit 1 exit 0
} }
if [[ $# = 0 ]]; then if [[ $# = 0 ]]; then
helpFunc helpFunc
fi fi
# Handle redirecting to specific functions based on arguments # Handle redirecting to specific functions based on arguments
case "${1}" in case "${1}" in
"-w" | "whitelist" ) whitelistFunc "$@";; "-w" | "whitelist" ) whitelistFunc "$@";;
"-b" | "blacklist" ) blacklistFunc "$@";; "-b" | "blacklist" ) blacklistFunc "$@";;
"-d" | "debug" ) debugFunc;; "-d" | "debug" ) debugFunc;;
"-f" | "flush" ) flushFunc;; "-f" | "flush" ) flushFunc;;
"-up" | "updatePihole" ) updatePiholeFunc;; "-up" | "updatePihole" ) updatePiholeFunc;;
"-r" | "reconfigure" ) reconfigurePiholeFunc;; "-r" | "reconfigure" ) reconfigurePiholeFunc;;
"-g" | "updateGravity" ) updateGravityFunc "$@";; "-g" | "updateGravity" ) updateGravityFunc "$@";;
"-s" | "setupLCD" ) setupLCDFunction;; "-s" | "setupLCD" ) setupLCDFunction;;
"-c" | "chronometer" ) chronometerFunc "$@";; "-c" | "chronometer" ) chronometerFunc "$@";;
"-h" | "help" ) helpFunc;; "-h" | "help" ) helpFunc;;
"-v" | "version" ) versionFunc "$@";; "-v" | "version" ) versionFunc "$@";;
"-q" | "query" ) queryFunc "$@";; "-q" | "query" ) queryFunc "$@";;
"uninstall" ) uninstallFunc;; "-l" | "logging" ) piholeLogging "$@";;
"enable" ) piholeEnable 1;; "uninstall" ) uninstallFunc;;
"disable" ) piholeEnable 0;; "enable" ) piholeEnable 1;;
"status" ) piholeStatus "$2";; "disable" ) piholeEnable 0 $2;;
"restartdns" ) restartDNS;; "status" ) piholeStatus "$2";;
* ) helpFunc;; "restartdns" ) restartDNS;;
"-a" | "admin" ) webpageFunc "$@";;
"-t" | "tail" ) tailFunc;;
* ) helpFunc;;
esac esac

5
requirements.txt Normal file
View File

@@ -0,0 +1,5 @@
docker-compose
pytest
pytest-xdist
pytest-cov
testinfra

0
test/__init__.py Normal file
View File

16
test/centos.Dockerfile Normal file
View File

@@ -0,0 +1,16 @@
FROM centos:7
ENV GITDIR /etc/.pihole
ENV SCRIPTDIR /opt/pihole
RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
ADD . $GITDIR
RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
RUN true && \
chmod +x $SCRIPTDIR/*
ENV PH_TEST true
#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

61
test/conftest.py Normal file
View File

@@ -0,0 +1,61 @@
import pytest
import testinfra
check_output = testinfra.get_backend(
"local://"
).get_module("Command").check_output
@pytest.fixture
def Pihole(Docker):
''' used to contain some script stubbing, now pretty much an alias.
Also provides bash as the default run function shell '''
def run_bash(self, command, *args, **kwargs):
cmd = self.get_command(command, *args)
if self.user is not None:
out = self.run_local(
"docker exec -u %s %s /bin/bash -c %s",
self.user, self.name, cmd)
else:
out = self.run_local(
"docker exec %s /bin/bash -c %s", self.name, cmd)
out.command = self.encode(cmd)
return out
funcType = type(Docker.run)
Docker.run = funcType(run_bash, Docker, testinfra.backend.docker.DockerBackend)
return Docker
@pytest.fixture
def Docker(request, args, image, cmd):
''' combine our fixtures into a docker run command and setup finalizer to cleanup '''
assert 'docker' in check_output('id'), "Are you in the docker group?"
docker_run = "docker run {} {} {}".format(args, image, cmd)
docker_id = check_output(docker_run)
def teardown():
check_output("docker rm -f %s", docker_id)
request.addfinalizer(teardown)
docker_container = testinfra.get_backend("docker://" + docker_id)
docker_container.id = docker_id
return docker_container
@pytest.fixture
def args(request):
''' -t became required when tput began being used '''
return '-t -d'
@pytest.fixture(params=['debian', 'centos'])
def tag(request):
''' consumed by image to make the test matrix '''
return request.param
@pytest.fixture()
def image(request, tag):
''' built by test_000_build_containers.py '''
return 'pytest_pihole:{}'.format(tag)
@pytest.fixture()
def cmd(request):
''' default to doing nothing by tailing null, but don't exit '''
return 'tail -f /dev/null'

16
test/debian.Dockerfile Normal file
View File

@@ -0,0 +1,16 @@
FROM debian:jessie
ENV GITDIR /etc/.pihole
ENV SCRIPTDIR /opt/pihole
RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
ADD . $GITDIR
RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
RUN true && \
chmod +x $SCRIPTDIR/*
ENV PH_TEST true
#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

View File

@@ -0,0 +1,18 @@
''' This file starts with 000 to make it run first '''
import pytest
import testinfra
run_local = testinfra.get_backend(
"local://"
).get_module("Command").run
@pytest.mark.parametrize("image,tag", [
( 'test/debian.Dockerfile', 'pytest_pihole:debian' ),
( 'test/centos.Dockerfile', 'pytest_pihole:centos' ),
])
def test_build_pihole_image(image, tag):
build_cmd = run_local('docker build -f {} -t {} .'.format(image, tag))
if build_cmd.rc != 0:
print build_cmd.stdout
print build_cmd.stderr
assert build_cmd.rc == 0

View File

@@ -0,0 +1,102 @@
import pytest
from textwrap import dedent
SETUPVARS = {
'PIHOLE_INTERFACE' : 'eth99',
'IPV4_ADDRESS' : '1.1.1.1',
'IPV6_ADDRESS' : 'FE80::240:D0FF:FE48:4672',
'PIHOLE_DNS_1' : '4.2.2.1',
'PIHOLE_DNS_2' : '4.2.2.2'
}
def test_setupVars_are_sourced_to_global_scope(Pihole):
''' currently update_dialogs sources setupVars with a dot,
then various other functions use the variables.
This confirms the sourced variables are in scope between functions '''
setup_var_file = 'cat <<EOF> /etc/pihole/setupVars.conf\n'
for k,v in SETUPVARS.iteritems():
setup_var_file += "{}={}\n".format(k, v)
setup_var_file += "EOF\n"
Pihole.run(setup_var_file)
script = dedent('''\
set -e
printSetupVars() {
# Currently debug test function only
echo "Outputting sourced variables"
echo "PIHOLE_INTERFACE=${PIHOLE_INTERFACE}"
echo "IPV4_ADDRESS=${IPV4_ADDRESS}"
echo "IPV6_ADDRESS=${IPV6_ADDRESS}"
echo "PIHOLE_DNS_1=${PIHOLE_DNS_1}"
echo "PIHOLE_DNS_2=${PIHOLE_DNS_2}"
}
update_dialogs() {
. /etc/pihole/setupVars.conf
}
update_dialogs
printSetupVars
''')
output = run_script(Pihole, script).stdout
for k,v in SETUPVARS.iteritems():
assert "{}={}".format(k, v) in output
def test_setupVars_saved_to_file(Pihole):
''' confirm saved settings are written to a file for future updates to re-use '''
set_setup_vars = '\n' # dedent works better with this and padding matching script below
for k,v in SETUPVARS.iteritems():
set_setup_vars += " {}={}\n".format(k, v)
Pihole.run(set_setup_vars).stdout
script = dedent('''\
set -e
echo start
TERM=xterm
source /opt/pihole/basic-install.sh
{}
finalExports
cat /etc/pihole/setupVars.conf
'''.format(set_setup_vars))
output = run_script(Pihole, script).stdout
for k,v in SETUPVARS.iteritems():
assert "{}={}".format(k, v) in output
def test_configureFirewall_firewalld_no_errors(Pihole):
''' confirms firewalld rules are applied when appopriate '''
mock_command('firewall-cmd', '0', Pihole)
configureFirewall = Pihole.run('''
source /opt/pihole/basic-install.sh
configureFirewall
''')
expected_stdout = '::: Configuring firewalld for httpd and dnsmasq.'
assert expected_stdout in configureFirewall.stdout
firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
assert 'firewall-cmd --state' in firewall_calls
assert 'firewall-cmd --permanent --add-port=80/tcp' in firewall_calls
assert 'firewall-cmd --permanent --add-port=53/tcp' in firewall_calls
assert 'firewall-cmd --permanent --add-port=53/udp' in firewall_calls
assert 'firewall-cmd --reload' in firewall_calls
# Helper functions
def mock_command(script, result, container):
''' Allows for setup of commands we don't really want to have to run for real in unit tests '''
''' TODO: support array of results that enable the results to change over multiple executions of a command '''
full_script_path = '/usr/local/bin/{}'.format(script)
mock_script = dedent('''\
#!/bin/bash -e
echo "\$0 \$@" >> /var/log/{script}
exit {retcode}
'''.format(script=script, retcode=result))
container.run('''
cat <<EOF> {script}\n{content}\nEOF
chmod +x {script}
'''.format(script=full_script_path, content=mock_script))
def run_script(Pihole, script):
result = Pihole.run(script)
assert result.rc == 0
return result

13
test/test_shellcheck.py Normal file
View File

@@ -0,0 +1,13 @@
import pytest
import testinfra
run_local = testinfra.get_backend(
"local://"
).get_module("Command").run
def test_scripts_pass_shellcheck():
''' Make sure shellcheck does not find anything wrong with our shell scripts '''
shellcheck = "find . -type f \( -name 'update.sh' -o -name 'piholeDebug.sh' \) | while read file; do shellcheck \"$file\"; done;"
results = run_local(shellcheck)
print results.stdout
assert '' == results.stdout