arno/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole synced 2024-11-13 19:28:59 +00:00
Code Issues Releases Wiki Activity
627 Commits 8 Branches 109 Tags 19 MiB
Shell 83.8%
Python 12.4%
Roff 2.5%
Dockerfile 1.3%
7c41e5bafc
Go to file
Dan Schaper 7c41e5bafc Merge pull request #367 from yoosi/fix-trailling-whitespace 
Fix trailing whitespace
2016-03-05 23:17:31 -08:00
.github Create ISSUE_TEMPLATE.md 2016-02-17 22:23:01 +00:00
advanced remove trailing whitespace whitelist.sh 2016-03-05 21:15:53 -08:00
automated install remove trailing whitespace basic-install.sh 2016-03-05 21:16:23 -08:00
block hulu ads ATV Hulu domain add 2016-02-02 12:20:30 -05:00
adlists.default remove trailing whitespace adlists.default 2016-03-05 21:13:23 -08:00
CONTRIBUTING.md Add to contributor info 2016-02-05 12:22:23 -05:00
gravity.sh remove trailing whitespace gravity.sh 2016-03-05 21:13:43 -08:00
LICENSE Initial commit 2014-06-08 10:02:55 -05:00
README.md remove trailing whitespace README.md 2016-03-05 21:12:58 -08:00

README.md

Automated Install

Designed For Raspberry Pi A+, B, B+, 2, Zero (with an Ethernet adapter), and also works on most Debian based distros!
  1. Install Raspbian on Raspberry Pi variants or a Debian based distribution on other hardware or virtual machines
  2. Run the command below

curl -L install.pi-hole.net | bash

Alternative Semi-Automated install

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

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.