mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-15 02:42:58 +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

Jacob Salmela 9348a8ab15 move technical details to the bottom of the page in light of showing off Pi-holes features first. Signed-off-by: Jacob Salmela <github@decoy.email>		2017-07-11 23:36:40 -05:00
.github	Grammar and signoff instructions.	2017-06-22 12:59:07 -07:00
.idea	accidentally the idea file	2017-02-20 21:36:27 +00:00
advanced	put "no password will be set" on a newline.	2017-07-06 20:54:09 -05:00
automated install	Colour Tweaks (#1549 )	2017-07-01 22:08:17 +10:00
block hulu ads	ATV Hulu domain add	2016-02-02 12:20:30 -05:00
test	Integrate DL's update.sh fixes.	2017-06-25 14:39:09 -07:00
.editorconfig	Update .editorconfig	2017-04-06 14:55:21 -07:00
.gitattributes	linux style line endings enforced	2017-02-20 21:12:04 +00:00
.gitignore	Revert reversion.	2017-02-20 13:25:28 -08:00
.pullapprove.yml	Merge pull request #1533 from pi-hole/dschaper-patch-1	2017-06-17 12:23:04 -04:00
.travis.yml	add travis and python requirements	2016-11-01 23:53:11 -05:00
adlists.default	newline	2017-03-31 21:12:17 +01:00
autotest	setupVar tests passing for debian & centos	2016-10-10 23:14:39 -05:00
CONTRIBUTING.md	Match the Pi-hole brand (#1358 )	2017-04-03 17:29:57 +02:00
gravity.sh	Remove /* from IPv6 as well as IPv4	2017-06-26 09:51:21 -04:00
LICENSE	Update LICENSE of the project to EUPL v1.2	2017-06-03 15:06:00 +02:00
pihole	Colourise tailFunc (#1550 )	2017-07-02 15:21:00 +02:00
README.md	move technical details to the bottom of the page in light of showing off Pi-holes features first.	2017-07-11 23:36:40 -05:00
requirements.txt	add travis and python requirements	2016-11-01 23:53:11 -05:00

README.md

Pi-hole®: The multi-platform, network-wide ad blocker

Block ads for all your devices without the need to install client-side software.

Executive Summary

The Pi-hole blocks ads at the DNS-level, so all your devices are protected.

Easy-to-install - our intelligent installer walks you through the process with no additional software needed on client devices
Universal - ads are blocked in non-browser locations such as ad-supported mobile apps and smart TVs
Quick - installation takes less than ten minutes and it really is that easy
Informative - an administrative Web interface shows ad-blocking statistics
Lightweight - designed to run on minimal resources
Scalable - even in large environments, Pi-hole can handle hundreds of millions of queries (with the right hardware specs)
Powerful - advertisements are blocked over IPv4 and IPv6
Fast - it speeds up high-cost, high-latency networks by caching DNS queries and saves bandwidth by not downloading advertisement elements
Versatile - Pi-hole can function also function as a DHCP server

Pi-hole Is Free, But Powered By Your Donations

Digital Ocean helps with our infrastructure, but our developers are all volunteers so your donations help keep us innovating.

Donate via PayPal
Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL

Other Ways To Support Us

If you'd rather not send money, there are other ways to support us: you can sign up for services through our affiliate links, which will also help us offset some of the costs associated with keeping Pi-hole operational.

One-Step 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

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

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\ install/
bash basic-install.sh

Or

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-hole as their DNS server and then any device that connects to your network will have ads blocked without any further configuration.

If your router does not support setting the DNS server, you can use Pi-hole's built in DHCP server; just be sure to disable DHCP on your router first.

Alternatively, you can manually set each device to use Pi-hole as their DNS server.

What is Pi-hole and how do I install it?

Overview Of Features

The Dashboard (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

Settings

The settings page lets you control and configure your Pi-hole. You can do things like:

enable Pi-hole's built-in DHCP server
exclude domains from the graphs
configure upstream DNS servers
and more!

Built-in DHCP Server

Pi-hole ships with a built-in DHCP server. This allows you to let your network devices use Pi-hole as their DNS server if your router does not let you adjust the DHCP options.

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.

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.

Gravity: Finding Ads To Block

The gravity.sh script does most of the magic. The script pulls in over 100,000 known ad-serving domains from many sources and aggregates them into a single list.

Additional Blocklists

You can also use Pi-hole to block additional domains beyond the defaults. It can even be used to block malware or phising domains. The Big Blocklist Collection is a good resource for finding additional domains to block.

Other Operating Systems

The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight modifications that we can help you work through. If you can install dnsmasq and a web server, it should work OK. If there are other platforms you'd like supported, let us know.