mirror of
https://github.com/moparisthebest/pi-hole
synced 2024-12-01 13:32:23 -05:00
51 lines
2.9 KiB
Markdown
51 lines
2.9 KiB
Markdown
# Raspberry Pi Ad Blocker
|
|
**A black hole for ads, hence Pi-hole**
|
|
|
|
|
|
|
|
The Pi-hole is a DNS/Web server that will **block ads for any device on your network**.
|
|
|
|
## Coverage
|
|
Featured on [MakeUseOf](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/) and [Lifehacker](http://lifehacker.com/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-co-1686093533)!
|
|
|
|
## Automated Install
|
|
|
|
1. Install Raspbian
|
|
2. Set a **static** IP address
|
|
3. Run the command below
|
|
|
|
```curl -s "https://raw.githubusercontent.com/jacobsalmela/pi-hole/master/automated%20install/basic-install.sh" | bash```
|
|
|
|
Once installed, **configure any device to use the Raspberry Pi as its DNS server and the ads will be blocked**. You can also configure your router's DHCP options to assign the Pi as clients DNS server so they do not need to do it manually.
|
|
|
|
A more detailed explanation of the installation can be found [here](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0).
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
|
|
|
|
## Gravity
|
|
The [gravity.sh](https://github.com/jacobsalmela/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).
|
|
|
|
## Whitelist and blacklist
|
|
You can add a `whitelist.txt` or `blacklist.txt` in `/etc/pihole/` and the script will apply those files automatically.
|
|
|
|
## Web Interface
|
|
I am also working on a [Web interface](https://github.com/jacobsalmela/AdminLTE#pi-hole-admin-dashboard) so you can view stats and change settings.
|
|
|
|
## Custom Config File
|
|
If you want to use your own variables for the gravity script (i.e. storing the files in a different location) and don't want to have to change them every time there is an update to the script, create a file called `/etc/pihole/pihole.conf`. In it, you should add your own variables in a similar fashion as shown below:
|
|
|
|
```
|
|
origin=/var/run/pihole
|
|
adList=/etc/dnsmasq.d/adList
|
|
```
|
|
|
|
See [this PR](https://github.com/jacobsalmela/pi-hole/pull/20) for more details.
|
|
|
|
### How It Works
|
|
A technical and detailed description can be found [here](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0)!
|
|
|
|
## 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.
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
|