From 613f2d3b867c5efb580ba7c4e78c1bc96967d34f Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 22:51:20 -0500 Subject: [PATCH 01/11] =?UTF-8?q?Pi-hole=20is=20now=20a=20registered=20tra?= =?UTF-8?q?demark:=20replace=20=E2=84=A2=20with=20=C2=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jacob Salmela --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f8813fa..b2f3908f 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@

-## The multi-platform, network-wide ad blocker +## 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. +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 @@ -53,9 +53,9 @@ 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**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) 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 Pi-hole™ as their DNS server. +Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) 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 Pi-hole as their DNS server. -## What is Pi-hole™ and how do I install it? +## What is Pi-hole and how do I install it?

@@ -73,7 +73,7 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei ## 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. +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 @@ -102,7 +102,7 @@ Domains can be whitelisted and blacklisted using either the web interface or the ### Settings -The settings page lets you control and configure your Pi-hole™. You can do things like: +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 @@ -113,7 +113,7 @@ The settings page lets you control and configure your Pi-hole™. You can do th #### 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. +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.

@@ -137,7 +137,7 @@ The same output can be achieved on the CLI by running `chronometer.sh -j` You can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-pi-holes-stats-over-ssh-or-on-an-lcd-using-chronometer/240) 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 LCD](http://i.imgur.com/nBEqycp.jpg) -## Pi-hole™ Projects +## Pi-hole Projects - [An ad blocking Magic Mirror](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware) - [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py) From 38d213ee6cdb02cc8667c4dd5c1f3a3cd6db7f24 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 22:55:50 -0500 Subject: [PATCH 02/11] add section about additional ways to support us Signed-off-by: Jacob Salmela --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b2f3908f..a1d69a78 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,9 @@ Digital Ocean helps with our infrastructure, but our developers are all voluntee - ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY) - ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL +### Other Ways To Support Us +If you're not the type to give away money, there are [other ways support us](https://pi-hole.net/donate): 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](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%20install/basic-install.sh) in case you want to read over it first!) From 527fe2f5e176e0c185f01996d38e6568c97f7b2d Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 23:06:42 -0500 Subject: [PATCH 03/11] wordsmithing using Pi-hole as your DNS server, gravity, and additional blocklists. Signed-off-by: Jacob Salmela --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1d69a78..d4744972 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,11 @@ 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**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) 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 Pi-hole as their DNS server. +Once installed, [configure your router to have **DHCP clients use the Pi-hole as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) 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](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026); 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?

@@ -68,6 +72,7 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei - [Users Forum](https://discourse.pi-hole.net/) - [FAQs](https://discourse.pi-hole.net/c/faqs) +- [Feature requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) - [Wiki](https://github.com/pi-hole/pi-hole/wiki) - ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole) - ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/) @@ -78,9 +83,12 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei 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 +### Gravity: Finding Ads To Block -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`. +The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/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](https://wally3k.github.io/) is a good resource for finding additional domains to block. From e5e26413e98c106eee52fcca4134e280b03bb39c Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 23:28:47 -0500 Subject: [PATCH 04/11] new executive summary above the fold Signed-off-by: Jacob Salmela --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d4744972..7782dc54 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,26 @@ ## 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 +Block ads for **all** your devices _without_ the need to install client-side software.

+## Executive Summary +The Pi-hole blocks ads at the DNS-level, so all your devices are protected. + +- **Easy-to-install** - our intelligent installer walks you through the process with no additional software needed on client devices +- **Universal** - ads are blocked in _non-browser locations_ such as ad-supported mobile apps and smart TVs +- **Quick** - installation takes less than ten minutes and it [_really_ is _that easy_](https://discourse.pi-hole.net/t/new-pi-hole-questions/3971/5?u=jacob.salmela) +- **Informative** - an administrative Web interface shows ad-blocking statistics +- **Lightweight** - designed to run on [minimal resources](https://discourse.pi-hole.net/t/hardware-software-requirements/273) +- **Scalable** - even in large environments, [Pi-hole can handle hundreds of millions of queries](https://pi-hole.net/2017/05/24/how-much-traffic-can-pi-hole-handle/) (with the right hardware specs) +- **Powerful** - advertisements are blocked over IPv4 _and_ IPv6 +- **Fast** - it speeds up high-cost, high-latency networks by caching DNS queries and saves bandwidth by not downloading advertisement elements +- **Versatile** - Pi-hole can function also function as a DHCP server + + ## 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. From fbd55dd74058a385edd881133672469b99dbc811 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 23:33:49 -0500 Subject: [PATCH 05/11] tweaks to donation verbiage Signed-off-by: Jacob Salmela --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7782dc54..5199e534 100644 --- a/README.md +++ b/README.md @@ -29,27 +29,26 @@ The Pi-hole blocks ads at the DNS-level, so all your devices are protected. - **Fast** - it speeds up high-cost, high-latency networks by caching DNS queries and saves bandwidth by not downloading advertisement elements - **Versatile** - Pi-hole can function also function as a DHCP server +# Pi-hole Is Free, But Powered By Your Donations -## 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. +[Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) helps with our infrastructure, but [our developers](https://github.com/orgs/pi-hole/people) are all volunteers so *your donations help keep us innovating*. - ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY) - ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL -### Other Ways To Support Us -If you're not the type to give away money, there are [other ways support us](https://pi-hole.net/donate): 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. +## Other Ways To Support Us +If you'd rather not send money, there are [other ways to support us](https://pi-hole.net/donate): 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 +# 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%20install/basic-install.sh) in case you want to read over it first!) -### `curl -sSL https://install.pi-hole.net | bash` +#### `curl -sSL https://install.pi-hole.net | bash` -#### Alternative Semi-Automated Install Methods +## 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. +### 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 @@ -70,7 +69,7 @@ If your router does not support setting the DNS server, you can [use Pi-hole's b 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? +# What is Pi-hole and how do I install it?

From 9348a8ab15f5dcd0c1b7d927ee70cbcbdb77d7bd Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 11 Jul 2017 23:36:40 -0500 Subject: [PATCH 06/11] move technical details to the bottom of the page in light of showing off Pi-holes features first. Signed-off-by: Jacob Salmela --- README.md | 60 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5199e534..7a4c58dd 100644 --- a/README.md +++ b/README.md @@ -74,36 +74,9 @@ Alternatively, you can manually set each device to use Pi-hole as their DNS serv

+# Overview Of Features -## Get Help Or Connect With Us On The Web - -- [Users Forum](https://discourse.pi-hole.net/) -- [FAQs](https://discourse.pi-hole.net/c/faqs) -- [Feature requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) -- [Wiki](https://github.com/pi-hole/pi-hole/wiki) -- ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole) -- ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/) -- ![YouTube](https://assets.pi-hole.net/static/youtube.png) [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) -- [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](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. - -### Gravity: Finding Ads To Block - -The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/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](https://wally3k.github.io/) 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 Dashboard (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: @@ -155,6 +128,35 @@ The same output can be achieved on the CLI by running `chronometer.sh -j` You can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-pi-holes-stats-over-ssh-or-on-an-lcd-using-chronometer/240) 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 LCD](http://i.imgur.com/nBEqycp.jpg) +## Get Help Or Connect With Us On The Web + +- [Users Forum](https://discourse.pi-hole.net/) +- [FAQs](https://discourse.pi-hole.net/c/faqs) +- [Feature requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) +- [Wiki](https://github.com/pi-hole/pi-hole/wiki) +- ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole) +- ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/) +- ![YouTube](https://assets.pi-hole.net/static/youtube.png) [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) +- [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](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. + +### Gravity: Finding Ads To Block + +The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/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](https://wally3k.github.io/) 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. + + ## Pi-hole Projects - [An ad blocking Magic Mirror](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware) From 24df5f5208b1b55e94406ff8d3fac2af65e07acf Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 12 Jul 2017 00:36:12 -0500 Subject: [PATCH 07/11] describe settings page in the order they appear on the dashboard--also add screenshots Signed-off-by: Jacob Salmela --- README.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 86 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7a4c58dd..6b14b40b 100644 --- a/README.md +++ b/README.md @@ -78,31 +78,108 @@ Alternatively, you can manually set each device to use Pi-hole as their DNS serv ## The Dashboard (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: +The [dashboard](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will (by default) be enabled during installation so you can view stats, change settings, and configure your Pi-hole. -`http://192.168.1.x/admin/index.php` or `http://pi.hole/admin` +![Pi-hole Dashboard](https://assets.pi-hole.net/static/dashboard.png) -![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png) +There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168): -### Whitelist and blacklist +1. `http:///admin/` +2. `http:/pi.hole/admin/` (when using Pi-hole as your DNS server) +3. `http://pi.hole/` (when using Pi-hole as your DNS server) + +### The Query Log + +If enabled, the query log will show all of the DNS queries requested by clients using Pi-hole as their DNS server. Forwarded domains will show in green, and blocked (_Pi-holed_) domains will show in red. You can also white or black list domains from within this section. -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

- +

+#### Long-term Statistics +Using our Faster-Than-Light Engine ([FTL](https://github.com/pi-hole/FTL)), Pi-hole can store all of the domains queried in a database for retrieval or analysis later on. You can view this data as a graph, individual queries, or top clients/advertisers. + +

+ +

+ +### Whitelist And Blacklist + +Domains can be [whitelisted](https://discourse.pi-hole.net/t/commonly-whitelisted-domains/212) and/or [blacklisted](https://discourse.pi-hole.net/t/commonly-blacklisted-domains/305) using either the dashboard or [the `pihole` command](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738). + +

+ +

+ +#### Additional Blocklists +By default, Pi-hole blocks over 100,000 known ad-serving domains. You can expand the blocking power of your Pi-hole by [adding additional lists](https://discourse.pi-hole.net/t/how-do-i-add-additional-block-lists-to-pi-hole/259) such as the ones found on [The Big Blocklist Collection](https://wally3k.github.io/). + +

+ +

+ +### Enable And Disable Pi-hole +Sometimes you may want to stop using Pi-hole or turn it back on. You can trigger this via the dashboard or command line. + +

+ +

+ +### Tools + +

+ +

+ + +#### Update Ad Lists +This runs `gravity` to download any newly-added domains from your source lists. + +#### Query Ad Lists +You can find out what list a certain domain was on. This is useful for troubleshooting sites that may not work properly due to a blocked domain. + +#### `tail`ing Log Files +You can watch the log files in real time to help debug any issues, or just see what's happening with your Pi-hole. + +#### Pi-hole Debugger +If you are having trouble with your Pi-hole, this is the place to go. You can run the debugger and it will attempt to diagnose any issues and then link to an FAQ with instructions on rectifying the problem. + +

+ +

+ +If run [via the command line](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738#debug), you will see red/yellow/green text, which makes it easy to identify any problems. + +

+ +

+ + +After the debugger has finished, you have the option to upload it to our secure server for 48 hours. All you need to do then is provide one of our developers the unique token generated by the debugger (this is usually done via [our forums](https://discourse.pi-hole.net/c/bugs-problems-issues)). + +

+ +

+ +However, most of the time, you will be able to solve any issues without any intervention from us. But if you can't, we're always around to help out. + ### Settings The settings page lets you control and configure your Pi-hole. You can do things like: +- view networking information +- flush logs or disable the logging of queries - enable Pi-hole's built-in DHCP server -- exclude domains from the graphs +- manage block lists +- exclude domains from the graphs and enable privacy options - configure upstream DNS servers +- restart Pi-hole's services +- back up some of Pi-hole's important files - and more! -![Settings page](https://assets.pi-hole.net/static/settings212.png) +![Settings page](https://assets.pi-hole.net/static/settings-page.png) -#### Built-in DHCP Server +## 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.

@@ -147,11 +224,6 @@ The Pi-hole is an **advertising-aware DNS/Web server**. If an ad domain is queri The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/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](https://wally3k.github.io/) 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. From 03387391def4e473faf670e85f67752e617627aa Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 12 Jul 2017 00:53:14 -0500 Subject: [PATCH 08/11] wordsmith DHCP server section, API section, and chronometer2 section. Also add more images Signed-off-by: Jacob Salmela --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 51 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6b14b40b..36fc5312 100644 --- a/README.md +++ b/README.md @@ -181,31 +181,69 @@ The settings page lets you control and configure your Pi-hole. You can do thing ## 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. +Pi-hole ships with a [built-in DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026). 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. + +One nice feature of using Pi-hole's DHCP server if you can set hostnames and DHCP reservations so you'll [see hostnames in the query log instead of IP addresses](https://discourse.pi-hole.net/t/how-do-i-show-hostnames-instead-of-ip-addresses-in-the-dashboard/3530). You can still do this without using Pi-hole's DHCP server; it just takes a little more work. If you do plan to use Pi-hole's DHCP server, be sure to disable DHCP on your router first. +

- +

-## API - -A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON: +## The FTL Engine: Our API +A 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" -} + "domains_being_blocked":111175, + "dns_queries_today":15669, + "ads_blocked_today":1752, + "ads_percentage_today":11.181314, + "unique_domains":1178, + "queries_forwarded":9177, + "queries_cached":4740, + "unique_clients":18 + } ``` +More details on the API can be found [here](https://discourse.pi-hole.net/t/pi-hole-api/1863) and on [the repo itself](https://github.com/pi-hole/FTL). The same output can be achieved on the CLI by running `chronometer.sh -j` -## Real-time Statistics +### Real-time Statistics, Courtesy Of The Time Cops -You can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-pi-holes-stats-over-ssh-or-on-an-lcd-using-chronometer/240) 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 LCD](http://i.imgur.com/nBEqycp.jpg) +Using [chronometer2](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/chronometer.sh), you can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-pi-holes-stats-over-ssh-or-on-an-lcd-using-chronometer/240) via `ssh` or on an LCD screen such as the [2.8" LCD screen from Adafruit](http://amzn.to/1P0q1Fj). -## Get Help Or Connect With Us On The Web +Simply run `pihole -c` for some detailed information. +``` +|¯¯¯(¯)__|¯|_ ___|¯|___ Pi-hole: v3.2 +| ¯_/¯|__| ' \/ _ \ / -_) AdminLTE: v3.2 +|_| |_| |_||_\___/_\___| FTL: v2.10 + —————————————————————————————————————————————————————————— + Hostname: pihole (Raspberry Pi 1, Model B) + Uptime: 11 days, 12:55:01 + Task Load: 0.35 0.16 0.15 (Active: 5 of 33 tasks) + CPU usage: 48% (1 core @ 700 MHz, 47c) + RAM usage: 12% (Used: 54 MB of 434 MB) + HDD usage: 20% (Used: 1 GB of 7 GB) + LAN addr: 192.168.1.100 (Gateway: 192.168.1.1) + Pi-hole: Active (Blocking: 111175 sites) + Ads Today: 11% (1759 of 15812 queries) + Fwd DNS: 208.67.222.222 (Alt DNS: 3 others) + —————————————————————————————————————————————————————————— + Recently blocked: www.google-analytics.com + Top Advertiser: www.example.org + Top Domain: www.example.org + Top Client: somehost +``` + +

+ +

+ +

+ +

+ +# Get Help Or Connect With Us On The Web - [Users Forum](https://discourse.pi-hole.net/) - [FAQs](https://discourse.pi-hole.net/c/faqs) From f4c7d389e5926903c90652d3adc3654fc1f1ef71 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 12 Jul 2017 01:03:09 -0500 Subject: [PATCH 09/11] more wordsmithing and updating links Signed-off-by: Jacob Salmela --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 36fc5312..2c95e0b3 100644 --- a/README.md +++ b/README.md @@ -169,15 +169,18 @@ The settings page lets you control and configure your Pi-hole. You can do thing - view networking information - flush logs or disable the logging of queries -- enable Pi-hole's built-in DHCP server -- manage block lists +- [enable Pi-hole's built-in DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026) +- [manage block lists](https://discourse.pi-hole.net/t/how-do-i-add-additional-block-lists-to-pi-hole/259) - exclude domains from the graphs and enable privacy options - configure upstream DNS servers - restart Pi-hole's services - back up some of Pi-hole's important files - and more! -![Settings page](https://assets.pi-hole.net/static/settings-page.png) +

+ +

+ ## Built-in DHCP Server @@ -191,7 +194,9 @@ One nice feature of using Pi-hole's DHCP server if you can set hostnames and DHC ## The FTL Engine: Our API -A read-only API can be accessed at `admin/api.php`. It returns the following JSON: +A read-only API can be accessed at `admin/api.php` (the same output can be achieved on the CLI by running `pihole -c -j`). + +It returns the following JSON: ``` json { "domains_being_blocked":111175, @@ -204,9 +209,8 @@ A read-only API can be accessed at `admin/api.php`. It returns the following JSO "unique_clients":18 } ``` -More details on the API can be found [here](https://discourse.pi-hole.net/t/pi-hole-api/1863) and on [the repo itself](https://github.com/pi-hole/FTL). -The same output can be achieved on the CLI by running `chronometer.sh -j` +More details on the API can be found [here](https://discourse.pi-hole.net/t/pi-hole-api/1863) and on [the repo itself](https://github.com/pi-hole/FTL). ### Real-time Statistics, Courtesy Of The Time Cops @@ -254,20 +258,12 @@ Simply run `pihole -c` for some detailed information. - ![YouTube](https://assets.pi-hole.net/static/youtube.png) [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) - [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -## Technical Details +# 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](https://github.com/pi-hole/pi-hole/blob/master/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. - -#### 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. +To summarize into a short sentence, the Pi-hole is an **advertising-aware DNS/Web server**. And while quite outdated at this point, [this original blog post about Pi-hole](https://jacobsalmela.com/2015/06/16/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0/) goes into **great detail** about how it was setup and how it works. Syntactically, it's no longer accurate, but the same basic principles and logic still apply to Pi-hole's current state. -## Pi-hole Projects +# Pi-hole Projects - [An ad blocking Magic Mirror](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware) - [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py) @@ -288,7 +284,7 @@ The automated install is only for a clean install of a Debian family or Fedora b - [Pi-hole Droid - open source Android client](https://github.com/friimaind/pi-hole-droid) - [Windows DNS Swapper](https://github.com/roots84/DNS-Swapper), see [#1400](https://github.com/pi-hole/pi-hole/issues/1400) -## Coverage +# 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) From bc1065a7fc83c2b0a4e93b50e7c1a1eb264f8454 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 12 Jul 2017 01:18:50 -0500 Subject: [PATCH 10/11] reorganize sections. install instructions first. also added more wordsmithing and links to interesting pi-hole.net articles Signed-off-by: Jacob Salmela --- README.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2c95e0b3..980a9d93 100644 --- a/README.md +++ b/README.md @@ -29,16 +29,6 @@ The Pi-hole blocks ads at the DNS-level, so all your devices are protected. - **Fast** - it speeds up high-cost, high-latency networks by caching DNS queries and saves bandwidth by not downloading advertisement elements - **Versatile** - Pi-hole can function also function as a DHCP server -# Pi-hole Is Free, But Powered By Your Donations - -[Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) helps with our infrastructure, but [our developers](https://github.com/orgs/pi-hole/people) are all volunteers so *your donations help keep us innovating*. - -- ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY) -- ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL - -## Other Ways To Support Us -If you'd rather not send money, there are [other ways to support us](https://pi-hole.net/donate): 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](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%20install/basic-install.sh) in case you want to read over it first!) @@ -74,6 +64,29 @@ Alternatively, you can manually set each device to use Pi-hole as their DNS serv

+# Pi-hole Is Free, But Powered By Your Donations + +[Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) helps with our infrastructure, but [our developers](https://github.com/orgs/pi-hole/people) are all volunteers so *your donations help keep us innovating*. + +- ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY) +- ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL + +## Other Ways To Support Us +### Affiliate Links +If you'd rather not send money, there are [other ways to support us](https://pi-hole.net/donate): 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; or you can support us in some non-tangible ways as listed below. + +### Contributing Code Via Pull Requests + +We don't work on Pi-hole for monetary reasons; we work on it because we think it's fun and we think our software is important in today's world. To that end, we welcome all contributors--from novices to masters. + +If you feel you have some code to contribute, we're happy to take a look. Just make sure to fill out our template when submitting a pull request. We're all volunteers on the project and without all the information in the template, it's very difficult for us to quickly get the code merged in. + +You'll find that the [install script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) and the [debug script](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/piholeDebug.sh) have an abundance of comments. These are two important scripts but we think they can also be a valuable resource to those who want to learn how to write scripts or code a program, which is why they are fully commented. So we encourage anyone who likes to tinker to read through it and submit a PR for us to review. + +### Presenting About Pi-hole + +Word-of-mouth has immensely helped our project grow. If you are going to be presenting about Pi-hole at a conference, meetup, or even for a school project, [get a hold of us for some free swag](https://pi-hole.net/2017/05/17/giving-a-presentation-on-pi-hole-contact-us-first-for-some-goodies-and-support/) to hand out to your audience. + # Overview Of Features ## The Dashboard (Web Interface) @@ -96,6 +109,8 @@ If enabled, the query log will show all of the DNS queries requested by clients

+The query log and graphs are what have helped people [discover what sort of traffic is traversing their networks](https://pi-hole.net/2017/07/06/round-3-what-really-happens-on-your-network/). + #### Long-term Statistics Using our Faster-Than-Light Engine ([FTL](https://github.com/pi-hole/FTL)), Pi-hole can store all of the domains queried in a database for retrieval or analysis later on. You can view this data as a graph, individual queries, or top clients/advertisers. @@ -139,7 +154,7 @@ This runs `gravity` to download any newly-added domains from your source lists. You can find out what list a certain domain was on. This is useful for troubleshooting sites that may not work properly due to a blocked domain. #### `tail`ing Log Files -You can watch the log files in real time to help debug any issues, or just see what's happening with your Pi-hole. +You can [watch the log files](https://discourse.pi-hole.net/t/how-do-i-watch-and-interpret-the-pihole-log-file/276) in real time to help debug any issues, or just see what's happening with your Pi-hole. #### Pi-hole Debugger If you are having trouble with your Pi-hole, this is the place to go. You can run the debugger and it will attempt to diagnose any issues and then link to an FAQ with instructions on rectifying the problem. From ea8927e1da9ab21a0b2fcadcee0d11151be186b3 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 12 Jul 2017 01:21:47 -0500 Subject: [PATCH 11/11] add facebook page to contact info Signed-off-by: Jacob Salmela --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 980a9d93..0ba43d7c 100644 --- a/README.md +++ b/README.md @@ -268,6 +268,7 @@ Simply run `pihole -c` for some detailed information. - [FAQs](https://discourse.pi-hole.net/c/faqs) - [Feature requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) - [Wiki](https://github.com/pi-hole/pi-hole/wiki) +- [Facebook](https://www.facebook.com/ThePiHole/) - ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole) - ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/) - ![YouTube](https://assets.pi-hole.net/static/youtube.png) [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)