From f767f066ada9fd2adef5a78895f50842570fa23a Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Fri, 3 Feb 2017 15:18:28 -0600 Subject: [PATCH 1/3] Update outdated text and describe features from recent versions --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 561e4f09..6ae8d628 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ 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 the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-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?

@@ -100,6 +100,17 @@ 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: + +- enable Pi-hole's built-in DHCP server +- exclude domains from the graphs +- configure upstream DNS servers +- and more! + + + ## API A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON: From fcdd33b585bc941c2d87f190b8264064dcd64687 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Fri, 3 Feb 2017 15:21:42 -0600 Subject: [PATCH 2/3] Update and remove old FAQ links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ae8d628..c9f16d9e 100644 --- a/README.md +++ b/README.md @@ -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. 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. +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 @@ -103,7 +103,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: - + - enable Pi-hole's built-in DHCP server - exclude domains from the graphs - configure upstream DNS servers @@ -128,7 +128,7 @@ 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 LCD](http://i.imgur.com/nBEqycp.jpg) +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 From ad5c011b6c3d8d933310f1aa697aa3a9f0e1a259 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Fri, 3 Feb 2017 15:33:44 -0600 Subject: [PATCH 3/3] Add new screenshots from latest version --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c9f16d9e..429fc275 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei ## 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 @@ -91,13 +91,13 @@ The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) `http://192.168.1.x/admin/index.php` or `http://pi.hole/admin` -![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard.png) +![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png) ### 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

- +

### Settings @@ -109,7 +109,14 @@ The settings page lets you control and configure your Pi-hole. You can do thing - configure upstream DNS servers - and more! +![Settings page](https://assets.pi-hole.net/static/settings212.png) +#### 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