moparisthebest/pi-hole
1
0
Fork 0
mirror of https://github.com/moparisthebest/pi-hole synced 2024-11-21 08:45:05 -05:00
Code Issues Releases Wiki Activity
356 Commits 13 Branches 3 Tags 655 KiB
Shell 99.9%
HTML 0.1%
cfd6e0d65d
Go to file
Jacob Salmela cfd6e0d65d more coverage and an API
2016-01-10 10:40:58 -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
gravity.sh Merge branch 'master' into ipv6 2016-01-01 18:34:33 -06:00
LICENSE Initial commit 2014-06-08 10:02:55 -05:00
README.md more coverage and an API 2016-01-10 10:40:58 -06: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

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

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.892423238348
}

Web

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.