Pi-hole/pi-hole: A black hole for Internet advertisements

mirror of https://github.com/pi-hole/pi-hole.git synced 2024-12-24 13:50:17 +00:00

A black hole for Internet advertisements

ad-blocker blocker cloud dashboard dhcp dhcp-server dnsmasq dns-server hacktoberfest pi-hole raspberry-pi shell

Find a file

Mcat12 fc3d4b3def Update README.md		2016-11-19 14:57:38 -08:00
.github	Small change in template	2016-11-16 21:42:54 -08:00
.idea	Add git clone method to installers	2016-11-19 14:44:13 -08:00
advanced	Add countdown timer	2016-11-18 13:27:06 -08:00
automated install	Merge pull request #899 from diginc/configureFirewall_unittest	2016-11-19 11:07:38 -08:00
block hulu ads	ATV Hulu domain add	2016-02-02 12:20:30 -05:00
test	move PH_TRUE to Dockerfiles to DRY	2016-11-03 22:34:04 -05:00
.gitattributes	Update .gitattributes	2016-10-17 18:31:06 -07:00
.gitignore	Use explicit calls for function to self-document	2016-11-02 11:39:22 -07:00
.pullapprove.yml	Update pullapprove into master	2016-10-30 17:15:35 +00:00
.travis.yml	add travis and python requirements	2016-11-01 23:53:11 -05:00
adlists.default	Update last modified date for adlist	2016-10-30 06:37:36 -07:00
autotest	setupVar tests passing for debian & centos	2016-10-10 23:14:39 -05:00
CONTRIBUTING.md	Add GSG/Shell link	2016-11-16 13:55:29 -08:00
gravity.sh	Fix typo	2016-11-19 14:00:56 -05:00
LICENSE	Initial commit	2014-06-08 10:02:55 -05:00
pihole	Stash all changed files, clean directory and pull updates.	2016-11-02 10:39:27 -07:00
README.md	Update README.md	2016-11-19 14:57:38 -08:00
requirements.txt	add travis and python requirements	2016-11-01 23:53:11 -05:00

README.md

The multi-platform, network-wide ad blocker

Block ads for all your devices without the need to install client-side software. Because Pi-hole blocks ads the DNS-level, ads can be blocked in non-traditional places such as in apps or on smart TVs.

Your Support Still Matters

Digital Ocean helps with our infrastructure, but our developers are all volunteers, so your donations are what help keep us motivated to keep working on the project. Send a one-time donation using our links below to help us with a small portion of our monthly costs.

: Donate
: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL

Automated Install

Install a supported operating system
Run the command below (it downloads this script in case you want to read over it first!)

`curl -sSL https://install.pi-hole.net | bash`

Alternative Semi-Automated Install Methods

Clone our repository and run the automated installer from your device.

git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
cd Pi-hole/automated_installer/
(Optionally nano|vi|vim|cat the basic-install.sh file to verify the actions it will take)
bash basic-install.sh

If you wish to read over the script before running it, then after the wget command, run nano basic-install.sh to open the file in a text viewer.

wget -O basic-install.sh https://install.pi-hole.net
bash 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.

How To Install Pi-hole (Click to Watch!)

How It Works

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

Get Help Or Connect With Us On The Web

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.

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 is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. If there are other platforms you'd like supported, let us know.

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). This script is controlled by the pihole command. Please run pihole -h to see what commands can be run via pihole.

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 or http://pi.hole/admin

Whitelist and blacklist

Domains can be whitelisted and blacklisted using either the web interface or the command line. See the wiki page for more details

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

Real-time Statistics

You can view real-time stats via ssh or on an 2.8" LCD screen. This is accomplished via chronometer.sh.