Go to file

Jacob Salmela 93664aeb4e cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section		2016-01-04 20:32:46 -06:00
advanced	Resolve merge confict	2015-12-06 20:22:34 -08:00
automated install	fixes #145	2016-01-02 17:20:33 -06:00
block hulu ads	preparing files for merge and for testing automated install	2015-06-16 11:15:15 -05:00
LICENSE	Initial commit	2014-06-08 10:02:55 -05:00
README.md	cleaning up the readme	2016-01-04 20:32:46 -06:00
gravity.sh	Merge branch 'master' into ipv6	2016-01-01 18:34:33 -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 your router to have DHCP clients use the Pi as their DNS server 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.

Pi-hole Is Free, But Powered By Your Donations

How Does It Work?

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

Pi-hole Projects

Coverage

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

The Pi-hole is an advertising-aware DNS/Web server. If an ad domain is queried, a small Web page or GIF is delivered in place of the advertisement.

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 (if you decide to use the mahakala list).

Whitelist and blacklist

You can add a whitelist.txt or blacklist.txt in /etc/pihole/ and the script will apply those files automatically. Put one domain per line.

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

Help

See the Wiki entry for more details
There is also an FAQ section on pi-hole.net

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.