arno/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole synced 2024-12-23 07:18:07 +00:00
Code Issues Releases Wiki Activity

Giving the README some much needed love

Browse Source
This commit is contained in:
Jacob Salmela 2015-03-20 12:50:49 -05:00
parent a8874fb606
commit 0ae8168351
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,4 +1,23 @@
pi-hole # Raspberry Pi Ad Blocker
======= **A black hole for ads, hence Pi-hole**
Raspberry Pi Ad Blocker (A black hole for ads, hence Pi-hole) ![Pi-hole](http://www.hdwallpapersimages.com/wp-content/uploads/2014/03/Black-Hole-Images-540x303.jpg)
The Pi-hole is a DNS/Web server that will **block ads for any device**.
## Automated Install
On a clean installation of Raspbian, you can run this command to **auto-install the Pi-hole**. Once installed, configure any device to use the Raspberry Pi as your DNS server and the ads will be blocked.
```curl -s "https://raw.githubusercontent.com/jacobsalmela/pi-hole/master/automated%20install/basic-install.sh" | bash```
## Gravity
The [gravity-adv.sh](https://github.com/jacobsalmela/pi-hole/blob/master/gravity-adv.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 120,000 entries](http://jacobsalmela.com/blocking-ads-from-120000-domains/).
## Whitelist and blacklist
You can add a whitelist or blacklist in ```/etc/pihole/``` and the script will apply those files automatically.
## 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 only works for a clean install of Raspiban right now since that is how the project originated.
## Optimizations
I am working on some great optimizations to allow the script to run much faster. I also have a bunch of new sources for ad domains but I still need to see if the lists are OK.