mirror of https://github.com/pi-hole/pi-hole synced 2024-11-18 06:08:21 +00:00

Mcat12 c03268707a Merge pull request #489 from pi-hole/development

Next Release

2016-05-22 20:46:40 -04:00

8.1 KiB

Raw Blame History

Automated Install

Designed For Raspberry Pi A+, B, B+, 2, Zero, and 3B (with an Ethernet/Wi-Fi adapter) (Works on most Debian distributions!)

Install Raspbian
Run the command below

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

Alternative Semi-Automated install

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

Pi-hole Is Free, But Powered By Your Donations

Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the montly fee.

Paypal	Bitcoin	Optimal.com
	1hXEKGKExiPAQ7y5CFPwWiEXUXB6wDuqX	Sign up for Optimal.com using our link to provide us with a small monthly amount. Your money will also support content-creators.

Catch us out on the net:

Twitter: @The_Pi_Hole

reddit: /r/pihole

How Does It Work?

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

Pi-hole Projects

Coverage

Partnering With Optimal.com

Sign up for Optimal.com's service using our link. This service splits your money between your favorite ad blockers and free Websites. This allows you to block ads while still supporting those sites that currently depend on ads for revenue.

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.

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 (if you decide to use the mahakala list).

Whitelist and blacklist

Domains can be whitelisted and blacklisted using two pre-installed scripts. See the wiki page for more details

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

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 acheived 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.

Help

See the Wiki entry for more details
There is also an FAQ section on pi-hole.net

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 based system, such as the Raspberry Pi.

8.1 KiB Raw Blame History