Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-28 09:03:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
A black hole for Internet advertisements
407 commits 8 branches 109 tags 27 MiB
Shell 83.8%
Python 12.4%
Roff 2.5%
Dockerfile 1.3%
Find a file
Chad Howell 500f89bd84 Allow user to be chosen during install 
Allow user to be added to the "www-data" group to be chosen during install instead of hard coding user "pi".  The current user is displayed as default.  Allows install script to run on other devices that don't have the "pi" user.  Namely every device besides the Pi. :)
2016-01-19 21:43:17 -05:00
advanced Move call to CheckIPv6 function into CalcBlockedDomains, rather than relying on remembering to call it before you call CalcBlockedDomains. 2016-01-19 21:14:01 +00:00
automated install Allow user to be chosen during install 2016-01-19 21:43:17 -05:00
block hulu ads preparing files for merge and for testing automated install 2015-06-16 11:15:15 -05:00
gravity.sh Merging 2016-01-15 18:45:12 +00:00
LICENSE Initial commit 2014-06-08 10:02:55 -05:00
README.md Update README.md 2016-01-19 17:13:48 +00:00

README.md

Automated Install

Designed For Raspberry Pi B, B+, 2, and Zero (with an Ethernet adapter)
  1. Install Raspbian
  2. 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

Donate

How Does It Work?

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

Pi-hole exlplained

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

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

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

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

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 acheived on the CLI by running chronometer.sh -j

Web

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

Help

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.