tyler.durden
/
pi-hole
mirror of https://github.com/pi-hole/pi-hole.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pi-hole/README.md

61 lines
4.2 KiB
Markdown
Raw Normal View History

Link to explainer video Also clarifies that the automated install is for Raspbian installs only.
2015-12-06 06:23:44 +01:00
# Automated Install
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
##### Designed For Raspberry Pi B, B+, 2, and Zero (with an Ethernet adapter)
New, easier-to-remember installation command Also a picture of the Web interface and how to access it since it is now included in the automated installer.
2015-10-27 23:59:01 +01:00
1. Install Raspbian
Updated install instructions Also a screenshot of the dialog-based installer
2015-11-16 03:54:15 +01:00
2. Run the command below
New, easier-to-remember installation command Also a picture of the Web interface and how to access it since it is now included in the automated installer.
2015-10-27 23:59:01 +01:00
Updated install instructions Also a screenshot of the dialog-based installer
2015-11-16 03:54:15 +01:00
### ```curl -L install.pi-hole.net | bash```
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
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/).
New, easier-to-remember installation command Also a picture of the Web interface and how to access it since it is now included in the automated installer.
2015-10-27 23:59:01 +01:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
## Pi-hole Is Free, But Powered By Your Donations
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "Free, but powered by donations")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
New, easier-to-remember installation command Also a picture of the Web interface and how to access it since it is now included in the automated installer.
2015-10-27 23:59:01 +01:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
## How Does It Work?
Link to explainer video Also clarifies that the automated install is for Raspbian installs only.
2015-12-06 06:23:44 +01:00
**Watch the 60-second video below to get a quick overview**
Initial commit
2014-06-08 17:02:55 +02:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
[![Pi-hole exlplained](http://i.imgur.com/qNybJDX.png)](https://vimeo.com/135965232)
Link to Security Now! mention
2015-10-28 00:22:54 +01:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
## Pi-hole Projects
- [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/)
adding more coverage - Rob's post on medium.com - TekThing video Also posting about plans to partner up with Rob for his new service that can help reduce the flame war surrounding ad blocking
2015-12-26 04:14:19 +01:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
## Coverage
- [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)
adding more coverage - Rob's post on medium.com - TekThing video Also posting about plans to partner up with Rob for his new service that can help reduce the flame war surrounding ad blocking
2015-12-26 04:14:19 +01:00
## Partnering With Optimal.com
Pi-hole will be teaming up with [Rob Leathern's subscription service to avoid ads](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d). This service is unique and will help content-creators and publishers [still make money from visitors who are using an ad ablocker](http://techcrunch.com/2015/12/17/the-new-optimal/).
Link to Security Now! mention
2015-10-28 00:22:54 +01:00
## Technical Details
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
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.
donate buttons and link to Web interface
2015-07-27 01:36:01 +02:00
A more detailed explanation of the installation can be found [here](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0).
Giving the README some much needed love
2015-03-20 18:50:49 +01:00
## Gravity
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
The [gravity.sh](https://github.com/jacobsalmela/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/jacobsalmela/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)).
Giving the README some much needed love
2015-03-20 18:50:49 +01:00
donate buttons and link to Web interface
2015-07-27 01:36:01 +02:00
## Whitelist and blacklist
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
You can add a `whitelist.txt` or `blacklist.txt` in `/etc/pihole/` and the script will apply those files automatically. Put one domain per line.
donate buttons and link to Web interface
2015-07-27 01:36:01 +02:00
## Web Interface
New, easier-to-remember installation command Also a picture of the Web interface and how to access it since it is now included in the automated installer.
2015-10-27 23:59:01 +01:00
The [Web interface](https://github.com/jacobsalmela/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`
![Web](http://i.imgur.com/m114SCn.png)
donate buttons and link to Web interface
2015-07-27 01:36:01 +02:00
cleaning up the readme - removed most of the video images to reduce clutter - converged the "coverage" and "video" sections into a bulleted list of links - added a new project link (pi-hole on/off button) - moved projects up in the page so it's easier to find and see what people are doing with Pi-hole - removed custom conf section since it will be suited better in the wiki or FAQs - added a help section
2016-01-05 03:32:46 +01:00
## Help
- See the [Wiki](https://github.com/jacobsalmela/pi-hole/wiki/Customization) entry for more details
- There is also an [FAQ section on pi-hole.net](http://pi-hole.net)
preparing files for merge and for testing automated install I haven't merged anything before, so hopefully, I won't mess it up too bad!
2015-06-16 18:15:15 +02:00
Giving the README some much needed love
2015-03-20 18:50:49 +01:00
## Other Operating Systems
donate buttons and link to Web interface
2015-07-27 01:36:01 +02:00
This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install `dnsmasq` and a Webserver, it should work OK. The automated install only works for a clean install of Raspiban right now since that is how the project originated.