mirror of https://github.com/pi-hole/pi-hole.git synced 2024-12-24 13:50:17 +00:00

A black hole for Internet advertisements

ad-blocker blocker cloud dashboard dhcp dhcp-server dnsmasq dns-server hacktoberfest pi-hole raspberry-pi shell

Find a file

Salmela d37db4304c A few small display changes IPv6 box was missing the title. Added some IPv6 echoes.		2016-01-01 10:59:30 -06:00
advanced	Resolve merge confict	2015-12-06 20:22:34 -08:00
automated install	A few small display changes	2016-01-01 10:59:30 -06:00
block hulu ads	preparing files for merge and for testing automated install	2015-06-16 11:15:15 -05:00
gravity.sh	Fix bug in gravity.sh where IPv6 list was not always populated	2016-01-01 14:11:46 +00:00
LICENSE	Initial commit	2014-06-08 10:02:55 -05:00
README.md	adding unRaid-hole fork	2015-12-30 13:34:45 -06:00

README.md

Automated Install

Designed For Raspberry Pi B, B+, 2,

and Zero (with an Ethernet adapter)

Install Raspbian
Run the command below

`curl -L install.pi-hole.net | 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.

How Does It Work?

Watch the 60-second video below to get a quick overview

Video Coverage

TekThing

Pi-hole is mentioned at the two minute mark

Security Now! Podcast

Pi-hole is mentioned at 100 minutes and 26 seconds (the link brings you right there)

Tech Blogs

Pi-hole has been written about on:

Partnering With Optimal.com

Pi-hole will be teaming up with Rob Leathern's subscription service to avoid ads. This service is unique and will help content-creators and publishers still make money from visitors who are using an ad ablocker.

Technical Details

A more detailed explanation of the installation can be found here.

Gravity

The 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.

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

The Web interface 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

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:

piholeDir=/var/run/pihole
adList=/etc/dnsmasq.d/adList

See the Wiki entry for more details.

How It Works

A technical and detailed description can be found here!

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.