arno
/
pi-hole
mirror of https://github.com/pi-hole/pi-hole
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2608 Commits
17 Branches
108 Tags
34 MiB
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '527fe2f5e1'
${ noResults }
Go to file
Jacob Salmela 527fe2f5e1
wordsmithing using Pi-hole as your DNS server, gravity, and additional blocklists. 		7 years ago
.github Grammar and signoff instructions. 7 years ago
.idea accidentally the idea file 7 years ago
advanced put "no password will be set" on a newline. 7 years ago
automated install Colour Tweaks (#1549) 7 years ago
block hulu ads ATV Hulu domain add 8 years ago
test Integrate DL's update.sh fixes. 7 years ago
.editorconfig Update .editorconfig 7 years ago
.gitattributes linux style line endings enforced 7 years ago
.gitignore Revert reversion. 7 years ago
.pullapprove.yml Merge pull request #1533 from pi-hole/dschaper-patch-1 7 years ago
.travis.yml add travis and python requirements 8 years ago
CONTRIBUTING.md Match the Pi-hole brand (#1358) 7 years ago
LICENSE Update LICENSE of the project to EUPL v1.2 7 years ago
README.md wordsmithing using Pi-hole as your DNS server, gravity, and additional blocklists. 7 years ago
adlists.default newline 7 years ago
autotest setupVar tests passing for debian & centos 8 years ago
gravity.sh Remove /* from IPv6 as well as IPv4 7 years ago
pihole Colourise tailFunc (#1550) 7 years ago
requirements.txt add travis and python requirements 8 years ago

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. The Pi-hole blocks ads at 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.

Other Ways To Support Us

If you're not the type to give away money, there are other ways 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

  1. Install a supported operating system
  2. 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?

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.

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

Pi-hole Advanced Stats Dashboard

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!

Settings page

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. Pi-hole LCD

Pi-hole Projects

Coverage