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-24 15:13:42 +00:00
Code Issues Projects Releases Packages Wiki Activity
A black hole for Internet advertisements
194 commits 8 branches 109 tags 27 MiB
Shell 83.8%
Python 12.4%
Roff 2.5%
Dockerfile 1.3%
Find a file
Mel c168bf4f2e Checks for root/non-root/sudo 
Checks if script is running as root, non-root, or sudo. For root, it sets SUDO variable to nothing and the script runs. If it's not root, then it checks to see if sudo is installed. If it is installed, then it sets SUDO variable to 'sudo' and the script runs. If it is not root and sudo is not installed, then the user does not have sufficient privileges to run the installer and it exits.
2015-11-05 22:53:12 -06:00
advanced Merge pull request #62 from jacobsalmela/lighttpd 2015-10-27 17:26:45 -05:00
automated install Checks for root/non-root/sudo 2015-11-05 22:53:12 -06:00
block hulu ads preparing files for merge and for testing automated install 2015-06-16 11:15:15 -05:00
gravity.sh Checks for root/non-root/sudo 2015-11-05 22:47:56 -06:00
LICENSE Initial commit 2014-06-08 10:02:55 -05:00
README.md Link to Security Now! mention 2015-10-27 18:22:54 -05:00

README.md

Automated Install

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

curl -L install.pi-hole.net | 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.

Donate

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

Security Now! Podcast

Pi-hole is mentioned at 100 minutes and 26 seconds (the link brings you right there) Pi-hole on Security Now!

Tech Blogs

Featured on MakeUseOf and Lifehacker!

Technical Details

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.

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

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

Web

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