mirror of https://github.com/pi-hole/pi-hole.git synced 2024-12-23 21:30: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

Jacob Salmela 9ee2f006ac Merge pull request #102 from jacobsalmela/lighttpd Fix #101 and add Logstalgia requirements		2015-12-01 20:10:21 -06:00
advanced	for use with logstalgia	2015-12-01 16:04:07 -06:00
automated install	final dialog verbiage	2015-11-25 18:08:17 -06:00
block hulu ads	preparing files for merge and for testing automated install	2015-06-16 11:15:15 -05:00
gravity.sh	Merge pull request #96 from dschaper/feature/AtomicFunctions	2015-11-27 18:10:51 -06:00
LICENSE	Initial commit	2014-06-08 10:02:55 -05:00
README.md	pihole in the cloud link	2015-11-25 13:36:39 -08:00

README.md

Automated Install

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.

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

Security Now! Podcast

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

Tech Blogs

Featured on MakeUseOf and Lifehacker!

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:

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

See this PR 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.