pi-hole

mirror of https://github.com/pi-hole/pi-hole synced 2024-12-22 14:58:08 +00:00

Go to file

Adam Warner 907995a221 Update .pullapprove.yml reflect new approvers team		2016-11-21 13:13:39 +00:00
.github	Small change in template	2016-11-16 21:42:54 -08:00
.idea	Reset Code Stylings to group defalut	2016-11-19 15:03:12 -08:00
advanced	Merge pull request #924 from DL6ER/webpage.sh	2016-11-20 21:43:44 +00: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	Merge pull request #931 from pi-hole/update_tests	2016-11-20 15:51:14 -08: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.yml	2016-11-21 13:13:39 +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	Minor change	2016-11-20 17:40:22 +01:00
LICENSE	Initial commit	2014-06-08 10:02:55 -05:00
pihole	Changed -web (webpage) to -a (admin)	2016-11-20 15:15:27 +01:00
README.md	Codacy Badge for Master	2016-11-20 09:44:39 -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. The Pi-hole blocks ads the DNS-level, so all your devices are protected.

Web Browsers
Cell Phones
Smart TV's
Internet-connected home automation
Anything that communicates with the Internet

Your Support Still Matters

Digital Ocean helps with our infrastructure, but our developers are all volunteers so your donations help keep us innovating. Sending a donation using our links below helps us offset a portion of our monthly costs.

Donate via PayPal
Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL

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_installer/
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 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.

Installing the Pi-hole (Click to Watch!)

Would you like to know more?

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.

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.

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 Webserver, it should work OK. If there are other platforms you'd like supported, let us know.

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.