mirror of
https://github.com/pi-hole/pi-hole.git
synced 2024-12-04 20:13:17 +00:00
162 lines
9.9 KiB
Markdown
162 lines
9.9 KiB
Markdown
<p align="center">
|
|
<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
|
|
<a href=https://codeclimate.com/github/pi-hole/pi-hole><img src="https://codeclimate.com/github/pi-hole/pi-hole/badges/gpa.svg"></a>
|
|
<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="https://assets.pi-hole.net/static/Vortex_text.png" width=210>
|
|
</p>
|
|
|
|
## 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
|
|
|
|
<p align="center">
|
|
<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
|
|
</p>
|
|
|
|
## 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](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
|
|
-  Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
|
|
|
|
### One-Step Automated Install
|
|
1. Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
|
|
2. Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated_install/basic-install.sh) 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
|
|
|
|
```bash
|
|
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**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) 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](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
|
|
|
|
## Installing the Pi-hole (Click to Watch!)
|
|
<p align="center">
|
|
<a href=https://www.youtube.com/watch?v=TzFLJqUeirA><img src="https://assets.pi-hole.net/static/global.png"></a>
|
|
</p>
|
|
|
|
## Would you like to know more?
|
|
|
|
**Watch the 60-second video below to get a quick overview**
|
|
<p align="center">
|
|
<a href=https://youtu.be/9Eti3xibiho><img src="https://assets.pi-hole.net/static/blackhole_web.png"></a>
|
|
</p>
|
|
|
|
## Get Help Or Connect With Us On The Web
|
|
|
|
- [Users Forum](https://discourse.pi-hole.net/)
|
|
- [FAQs](https://discourse.pi-hole.net/c/faqs)
|
|
- [Wiki](https://github.com/pi-hole/pi-hole/wiki)
|
|
-  [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
|
|
-  [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
|
|
-  [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
|
|
- [](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
## 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](http://pi-hole.net/faq/is-it-possible-to-change-the-blank-page-that-takes-place-of-the-ads-to-something-else/) since it is just a simple Webpage taking place of the ads.
|
|
|
|
### Gravity
|
|
|
|
The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/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](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). 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](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) 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`
|
|
|
|
<p align="center">
|
|
<a href=https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard><img src="https://assets.pi-hole.net/static/dashboard.png"></a>
|
|
</p>
|
|
|
|
### Whitelist and blacklist
|
|
|
|
Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
|
|
<p align="center">
|
|
<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/controlpanel.png"></a>
|
|
</p>
|
|
|
|
## API
|
|
|
|
A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
|
|
|
|
``` 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](http://pi-hole.net/faq/install-the-real-time-lcd-monitor-chronometer/) via `ssh` or on an [2.8" LCD screen](http://amzn.to/1P0q1Fj). This is accomplished via [`chronometer.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/chronometer.sh). 
|
|
|
|
## Pi-hole Projects
|
|
|
|
- [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
|
|
- [Get LED alerts for each blocked ad](http://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
|
|
- [Pi-hole on Ubuntu 14.04 on VirtualBox](http://hbalagtas.blogspot.com/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
|
|
- [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/)
|
|
- [Splunk: Pi-hole Visualizser](https://splunkbase.splunk.com/app/3023/)
|
|
- [Pi-hole Chrome extension](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([open source](https://github.com/packtloss/pihole-extension))
|
|
- [Go Bananas for CHiP-hole ad blocking](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037)
|
|
- [Sky-Hole](http://dlaa.me/blog/post/skyhole)
|
|
- [Pi-hole in the Cloud!](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/)
|
|
- [unRaid-hole](https://github.com/spants/unraidtemplates/blob/master/Spants/unRaid-hole.xml#L13)--[Repo and more info](http://lime-technology.com/forum/index.php?PHPSESSID=c0eae3e5ef7e521f7866034a3336489d&topic=38486.0)
|
|
- [Pi-hole on/off button](http://thetimmy.silvernight.org/pages/endisbutton/)
|
|
- [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
|
|
- [Windows Tray Stat Application](https://github.com/goldbattle/copernicus)
|
|
- [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
|
|
- [Pi-Hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter) : a [Prometheus](https://prometheus.io/) exporter for Pi-Hole
|
|
|
|
## Coverage
|
|
|
|
- [Adafruit livestream install](https://www.youtube.com/watch?v=eg4u2j1HYlI)
|
|
- [TekThing: 5 fun, easy projects for a Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s)
|
|
- [Pi-hole on Adafruit's blog](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/)
|
|
- [The Defrag Show - MSDN/Channel 9](https://channel9.msdn.com/Shows/The-Defrag-Show/Defrag-Endoscope-USB-Camera-The-Final-HoloLens-Vote-Adblock-Pi-and-more?WT.mc_id=dlvr_twitter_ch9#time=20m39s)
|
|
- [MacObserver Podcast 585](http://www.macobserver.com/tmo/podcast/macgeekgab-585)
|
|
- [Medium: Block All Ads For $53](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d)
|
|
- [MakeUseOf: Adblock Everywhere, The Pi-hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/)
|
|
- [Lifehacker: Turn Your Pi Into An Ad Blocker With A Single Command](http://lifehacker.com/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-co-1686093533)!
|
|
- [Pi-hole on TekThing](https://youtu.be/8Co59HU2gY0?t=2m)
|
|
- [Pi-hole on Security Now! Podcast](http://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s)
|
|
- [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
|
|
- [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
|
|
- [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
|