.github | ||
.idea | ||
advanced | ||
automated_install | ||
block hulu ads | ||
test | ||
.gitattributes | ||
.gitignore | ||
.pullapprove.yml | ||
.travis.yml | ||
adlists.default | ||
autotest | ||
CONTRIBUTING.md | ||
gravity.sh | ||
LICENSE | ||
pihole | ||
README.md | ||
requirements.txt |
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_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 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
.
Pi-hole Projects
- Pi-hole stats in your Mac's menu bar
- Get LED alerts for each blocked ad
- Pi-hole on Ubuntu 14.04 on VirtualBox
- Docker Pi-hole container (x86 and ARM)
- Splunk: Pi-hole Visualizser
- Pi-hole Chrome extension (open source)
- Go Bananas for CHiP-hole ad blocking
- Sky-Hole
- Pi-hole in the Cloud!
- unRaid-hole--Repo and more info
- Pi-hole on/off button
- Minibian Pi-hole
- Windows Tray Stat Application
- Let your blink1 device blink when Pi-hole filters ads
- Pi-Hole Prometheus exporter : a Prometheus exporter for Pi-Hole
Coverage
- Adafruit livestream install
- TekThing: 5 fun, easy projects for a Raspberry Pi
- Pi-hole on Adafruit's blog
- The Defrag Show - MSDN/Channel 9
- MacObserver Podcast 585
- Medium: Block All Ads For $53
- MakeUseOf: Adblock Everywhere, The Pi-hole Way
- Lifehacker: Turn Your Pi Into An Ad Blocker With A Single Command!
- Pi-hole on TekThing
- Pi-hole on Security Now! Podcast
- Foolish Tech Show
- Pi-hole on Ubuntu
- Catchpoint: iOS 9 Ad Blocking