1
0
mirror of https://github.com/moparisthebest/pi-hole synced 2024-11-10 11:25:05 -05:00
pi-hole/README.md
Jacob Salmela 23713d82a0 1.6 million instead of 900,000
Updating to reflect the latest amount of domains the Pi-hole blocks.
2015-09-06 10:16:11 -05:00

2.9 KiB

Raspberry Pi Ad Blocker

A black hole for ads, hence Pi-hole

Pi-hole

The Pi-hole is a DNS/Web server that will block ads for any device on your network.

Coverage

Featured on MakeUseOf and Lifehacker!

Automated Install

  1. Install Raspbian
  2. Set a static IP address
  3. Run the command below

curl -s "https://raw.githubusercontent.com/jacobsalmela/pi-hole/master/automated%20install/basic-install.sh" | bash

Once installed, configure any device to use the Raspberry Pi as its DNS server and the ads will be blocked. You can also configure your router's DHCP options to assign the Pi as clients DNS server so they do not need to do it manually.

A more detailed explanation of the installation can be found here.

Donate

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.

Whitelist and blacklist

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

Web Interface

I am also working on a Web interface so you can view stats and change settings.

Custom Config File

If you want to use your own variables for the gravity script (i.e. storing the files in a different location) and don't want to have to change them every time there is an update to the script, create a file called /etc/pihole/pihole.conf. In it, you should add your own variables in a similar fashion as shown below:

origin=/var/run/pihole
adList=/etc/dnsmasq.d/adList

See this PR for more details.

How It Works

A technical and detailed description can be found here!

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.

Donate