mirror of https://github.com/pi-hole/pi-hole synced 2024-11-17 21:59:55 +00:00

Go to file

Dan Schaper c1a3f003e8 Rename the only utilty function left that didn't say `repo`		2016-11-02 11:18:13 -07:00
.github	Update PULL_REQUEST_TEMPLATE.md	2016-10-24 14:50:47 -07:00
advanced	Rename the only utilty function left that didn't say `repo`	2016-11-02 11:18:13 -07:00
automated install	Merge pull request #894 from diginc/InstallFixes_UnitTests	2016-11-02 09:42:20 -07:00
block hulu ads	ATV Hulu domain add	2016-02-02 12:20:30 -05:00
test	Clarify which DNS entry we are modifying.	2016-11-02 08:52:23 -07:00
.codeclimate.yml	Create .codeclimate.yml	2016-10-28 15:02:03 +01:00
.gitattributes	Update .gitattributes	2016-10-17 18:31:06 -07:00
.gitignore	Keep .yml's from going to user local repos.	2016-11-02 09:52:15 -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	Move contributer file	2016-10-08 12:06:23 -04:00
gravity.sh	Update var names from setupVars.conf in gravity.sh	2016-11-02 04:21:54 -07: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	reduce complexity and un needed cat	2016-11-01 23:00:14 -05:00
requirements.txt	add travis and python requirements	2016-11-01 23:53:11 -05:00

README.md

Automated Install

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

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

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

Alternative Semi-Automated install

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

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

How It Works

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

Pi-hole Is Free, But Powered By Your Donations

Send a one-time donation using our link below to provide us with a small portion of the monthly fee.

: Donate
: Donate
: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL

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.