A black hole for Internet advertisements
Go to file
zbholman cac9c63325 Added removal of pihole user to the uninstall.sh
Not sure if I should have created a variable for the username or if the echo is necessary. And this is my first time doing a pull request, hopefully it works out lol.
2016-11-16 17:06:30 -05:00
.github Update PULL_REQUEST_TEMPLATE.md 2016-10-24 14:50:47 -07:00
advanced Merge pull request #857 from pi-hole/feature/debugUpdate 2016-10-29 23:15:07 +01:00
automated install Added removal of pihole user to the uninstall.sh 2016-11-16 17:06:30 -05:00
block hulu ads ATV Hulu domain add 2016-02-02 12:20:30 -05:00
.codeclimate.yml Create .codeclimate.yml 2016-10-28 15:02:03 +01:00
.gitattributes Update .gitattributes 2016-10-17 18:31:06 -07:00
.gitignore .DS_Store banished! 2016-03-28 16:02:36 -05:00
.pullapprove.yml Update .pullapprove.yml 2016-10-25 12:36:05 +01:00
CONTRIBUTING.md Move contributer file 2016-10-08 12:06:23 -04:00
LICENSE Initial commit 2014-06-08 10:02:55 -05:00
README.md Update README.md 2016-10-29 14:46:09 +01:00
adlists.default Remove problem list, sends in Unicode - Not adware 2016-10-19 20:15:36 -07:00
gravity.sh Merge pull request #849 from pi-hole/aManHasNoNameResolution 2016-10-27 19:41:07 +01:00
pihole create list.sh. Combines whitelist and blacklist scripts in an effort to reduce code duplication. 2016-10-26 09:36:02 +01:00

README.md

Bountysource Code Climate

Automated Install

Designed For Raspberry Pi A+, B, B+, 2, 3B, and Zero (with an Ethernet/Wi-Fi adapter) Works on most Debian and CentOS/RHEL based distributions!

  1. Install Raspbian
  2. Run the command below (downloads this script in case you want to read over it first!)

curl -L https://install.pi-hole.net | bash

Alternative Semi-Automated install

wget -O basic-install.sh https://install.pi-hole.net
chmod +x basic-install.sh
./basic-install.sh

If you wish to read over the script before running it, then after the wget command, do nano basic-install.sh to open a text viewer

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.

How To Install Pi-hole

60-second install tutorial

How It Works

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

Pi-hole exlplained

Pi-hole Is Free, But Powered By Your Donations

Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the monthly fee.

Get Help Or Connect With Us On The Web

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. You can also replace ads with any image you want since it is just a simple Webpage taking place of the ads.

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

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 or http://pi.hole/admin

Pi-hole Advanced Stats Dashboard

Whitelist and blacklist

Domains can be whitelisted and blacklisted using two pre-installed scripts. See the wiki page for more details Whitelist editor in the Web interface

API

A basic read-only API can be accessed at /admin/api.php. It returns the following JSON:

{
    "domains_being_blocked": "136708",
    "dns_queries_today": "18108",
    "ads_blocked_today": "14648",
    "ads_percentage_today": "80.89"
}

The same output can be achieved on the CLI by running chronometer.sh -j

Real-time Statistics

You can view real-time stats via ssh or on an 2.8" LCD screen. This is accomplished via chronometer.sh. Pi-hole LCD

Pi-hole Projects

Coverage

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 is only for a clean install of a Debian based system, such as the Raspberry Pi.