diff --git a/docs/index.md b/docs/index.md index fbb9074..568103f 100755 --- a/docs/index.md +++ b/docs/index.md @@ -48,83 +48,4 @@ If you have something to add - anything from a typo through to a whole new featu 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, which will help you better understand how Pi-hole works. They're also a valuable resource to those who want to learn how to write scripts or code a program! We encourage anyone who likes to tinker to read through it, and submit a pull request for us to review. -### Presentations about Pi-hole -Word-of-mouth continues to help our project grow immensely, and so we are helping make this easier for people. - -If you are going to be presenting Pi-hole at a conference, meetup or even a school project, [get in touch with us](https://pi-hole.net/2017/05/17/giving-a-presentation-on-pi-hole-contact-us-first-for-some-goodies-and-support/) so we can hook you up with free swag to hand out to your audience! - ------ - -## Getting in touch with us -While we are primarily reachable on our Discourse User Forum, we can also be found on a variety of social media outlets. **Please be sure to check the FAQ's** before starting a new discussion, as we do not have the spare time to reply to every request for assistance. - -- [Frequently Asked Questions](https://discourse.pi-hole.net/c/faqs) -- [Feature Requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) - -
- -- [Reddit](https://www.reddit.com/r/pihole/) -- [Twitter](https://twitter.com/The_Pi_Hole) -- [Gitter](https://gitter.im/pi-hole/pi-hole) -- [YouTube](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) -- [Facebook](https://www.facebook.com/ThePiHole/) - ------ - -## The Origin Of Pi-hole -Pi-hole being a **advertising-aware DNS/Web server**, makes use of the following technologies: - -* [`dnsmasq`](http://www.thekelleys.org.uk/dnsmasq/doc.html) - a lightweight DNS and DHCP server -* [`curl`](https://curl.haxx.se) - A command line tool for transferring data with URL syntax -* [`lighttpd`](https://www.lighttpd.net) - webserver designed and optimized for high performance -* [`php`](https://secure.php.net) - a popular general-purpose web scripting language -* [AdminLTE Dashboard](https://github.com/almasaeed2010/AdminLTE) - premium admin control panel based on Bootstrap 3.x - -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 Pi-hole was originally 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 -- [The Big Blocklist Collection](https://wally3k.github.io) -- [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/) -- [Pi-Hole in the cloud](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/) -- [Pie in the Sky-Hole [A Pi-Hole in the cloud for ad-blocking via DNS]](https://dlaa.me/blog/post/skyhole) -- [Pi-hole Enable/Disable Button](http://thetimmy.silvernight.org/pages/endisbutton/) -- [Minibian Pi-hole](https://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole) -- [CHiP-hole: Network-wide Ad-blocker](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037) -- [Chrome Extension: Pi-Hole List Editor](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([Source Code](https://github.com/packtloss/pihole-extension)) -- [Splunk: Pi-hole Visualiser](https://splunkbase.splunk.com/app/3023/) -- [Adblocking with Pi-hole and Ubuntu 14.04 on VirtualBox](https://hbalagtas.blogspot.com.au/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html) -- [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py) -- [Pi-hole unRAID Template](https://forums.lime-technology.com/topic/36810-support-spants-nodered-mqtt-dashing-couchdb/) -- [Copernicus: Windows Tray Application](https://github.com/goldbattle/copernicus) -- [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f) -- [Pi-hole metrics](https://github.com/nlamirault/pihole_exporter) exporter for [Prometheus](https://prometheus.io/) -- [Magic Mirror with DNS Filtering](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware) -- [Pi-hole Droid: 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) -- [Pi-hole Visualizer](https://www.reddit.com/r/pihole/comments/82ikgb/pihole_visualizer_update/) ------ - -## Coverage -- [Lifehacker: Turn A Raspberry Pi Into An Ad Blocker With A Single Command](https://www.lifehacker.com.au/2015/02/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-command/) -- [MakeUseOf: Adblock Everywhere: The Raspberry Pi-Hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/) -- [Catchpoint: Ad-Blocking on Apple iOS9: Valuing the End User Experience](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/) -- [Security Now Netcast: Pi-hole](https://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s) -- [TekThing: Raspberry Pi-Hole Makes Ads Disappear!](https://youtu.be/8Co59HU2gY0?t=2m) -- [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s) -- [Block Ads on All Home Devices for $53.18](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d) -- [Pi-Hole for Ubuntu 14.04](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/) -- [MacObserver Podcast 585](https://www.macobserver.com/tmo/podcast/macgeekgab-585) -- [The Defrag Show: Endoscope USB Camera, The Final [HoloLens] Vote, Adblock Pi and more](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) -- [Adafruit: Pi-hole is a black hole for internet ads](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/) -- [Digital Trends: 5 Fun, Easy Projects You Can Try With a $35 Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s) -- [Adafruit: Raspberry Pi Quick Look at Pi Hole ad blocking server with Tony D](https://www.youtube.com/watch?v=eg4u2j1HYlI) -- [Devacron: OrangePi Zero as an Ad-Block server with Pi-Hole](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/) -- [Linux Pro: The Hole Truth](http://www.linuxpromagazine.com/Issues/2017/200/The-sysadmin-s-daily-grind-Pi-hole) -- [CryptoAUSTRALIA: How We Tried 5 Privacy Focused Raspberry Pi Projects](https://blog.cryptoaustralia.org.au/2017/10/05/5-privacy-focused-raspberry-pi-projects/) -- [CryptoAUSTRALIA: Pi-hole Workshop](https://blog.cryptoaustralia.org.au/2017/11/02/pi-hole-network-wide-ad-blocker/) -- [Know How 355: Killing ads with a Raspberry Pi-Hole!](https://www.twit.tv/shows/know-how/episodes/355) -- [Bloomberg: Inside the Brotherhood of the Ad Blockers](https://www.bloomberg.com/news/features/2018-05-10/inside-the-brotherhood-of-pi-hole-ad-blockers) - {!abbreviations.md!} diff --git a/docs/main/contact.md b/docs/main/contact.md new file mode 100755 index 0000000..c15bedc --- /dev/null +++ b/docs/main/contact.md @@ -0,0 +1,12 @@ +While we are primarily reachable on our Discourse User Forum, we can also be found on a variety of social media outlets. **Please be sure to check the FAQ's** before starting a new discussion, as we do not have the spare time to reply to every request for assistance. + +- [Frequently Asked Questions](https://discourse.pi-hole.net/c/faqs) +- [Feature Requests](https://discourse.pi-hole.net/c/feature-requests?order=votes) + +
+ +- [Reddit](https://www.reddit.com/r/pihole/) +- [Twitter](https://twitter.com/The_Pi_Hole) +- [Gitter](https://gitter.im/pi-hole/pi-hole) +- [YouTube](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w) +- [Facebook](https://www.facebook.com/ThePiHole/) \ No newline at end of file diff --git a/docs/main/coverage.md b/docs/main/coverage.md new file mode 100755 index 0000000..eb3260d --- /dev/null +++ b/docs/main/coverage.md @@ -0,0 +1,20 @@ +- [Lifehacker: Turn A Raspberry Pi Into An Ad Blocker With A Single Command](https://www.lifehacker.com.au/2015/02/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-command/) +- [MakeUseOf: Adblock Everywhere: The Raspberry Pi-Hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/) +- [Catchpoint: Ad-Blocking on Apple iOS9: Valuing the End User Experience](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/) +- [Security Now Netcast: Pi-hole](https://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s) +- [TekThing: Raspberry Pi-Hole Makes Ads Disappear!](https://youtu.be/8Co59HU2gY0?t=2m) +- [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s) +- [Block Ads on All Home Devices for $53.18](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d) +- [Pi-Hole for Ubuntu 14.04](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/) +- [MacObserver Podcast 585](https://www.macobserver.com/tmo/podcast/macgeekgab-585) +- [The Defrag Show: Endoscope USB Camera, The Final [HoloLens] Vote, Adblock Pi and more](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) +- [Adafruit: Pi-hole is a black hole for internet ads](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/) +- [Digital Trends: 5 Fun, Easy Projects You Can Try With a $35 Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s) +- [Adafruit: Raspberry Pi Quick Look at Pi Hole ad blocking server with Tony D](https://www.youtube.com/watch?v=eg4u2j1HYlI) +- [Devacron: OrangePi Zero as an Ad-Block server with Pi-Hole](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/) +- [Linux Pro: The Hole Truth](http://www.linuxpromagazine.com/Issues/2017/200/The-sysadmin-s-daily-grind-Pi-hole) +- [CryptoAUSTRALIA: How We Tried 5 Privacy Focused Raspberry Pi Projects](https://blog.cryptoaustralia.org.au/2017/10/05/5-privacy-focused-raspberry-pi-projects/) +- [CryptoAUSTRALIA: Pi-hole Workshop](https://blog.cryptoaustralia.org.au/2017/11/02/pi-hole-network-wide-ad-blocker/) +- [Know How 355: Killing ads with a Raspberry Pi-Hole!](https://www.twit.tv/shows/know-how/episodes/355) +- [Bloomberg: Inside the Brotherhood of the Ad Blockers](https://www.bloomberg.com/news/features/2018-05-10/inside-the-brotherhood-of-pi-hole-ad-blockers) + diff --git a/docs/main/origins.md b/docs/main/origins.md new file mode 100755 index 0000000..0a45be6 --- /dev/null +++ b/docs/main/origins.md @@ -0,0 +1,11 @@ +Pi-hole being a **advertising-aware DNS/Web server**, makes use of the following technologies: + +- [`dnsmasq`](http://www.thekelleys.org.uk/dnsmasq/doc.html) - a lightweight DNS and DHCP server +- [`curl`](https://curl.haxx.se) - A command line tool for transferring data with URL syntax +- [`lighttpd`](https://www.lighttpd.net) - webserver designed and optimized for high performance +- [`php`](https://secure.php.net) - a popular general-purpose web scripting language +- [AdminLTE Dashboard](https://github.com/almasaeed2010/AdminLTE) - premium admin control panel based on Bootstrap 3.x + +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 Pi-hole was originally 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. + +{!abbreviations.md!} \ No newline at end of file diff --git a/docs/main/presentations.md b/docs/main/presentations.md new file mode 100755 index 0000000..ac13660 --- /dev/null +++ b/docs/main/presentations.md @@ -0,0 +1,3 @@ +Word-of-mouth continues to help our project grow immensely, and so we are helping make this easier for people. + +If you are going to be presenting Pi-hole at a conference, meetup or even a school project, [get in touch with us](https://pi-hole.net/2017/05/17/giving-a-presentation-on-pi-hole-contact-us-first-for-some-goodies-and-support/) so we can hook you up with free swag to hand out to your audience! \ No newline at end of file diff --git a/docs/main/projects.md b/docs/main/projects.md new file mode 100755 index 0000000..dda5666 --- /dev/null +++ b/docs/main/projects.md @@ -0,0 +1,20 @@ +- [The Big Blocklist Collection](https://wally3k.github.io) +- [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/) +- [Pi-Hole in the cloud](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/) +- [Pie in the Sky-Hole [A Pi-Hole in the cloud for ad-blocking via DNS]](https://dlaa.me/blog/post/skyhole) +- [Pi-hole Enable/Disable Button](http://thetimmy.silvernight.org/pages/endisbutton/) +- [Minibian Pi-hole](https://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole) +- [CHiP-hole: Network-wide Ad-blocker](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037) +- [Chrome Extension: Pi-Hole List Editor](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([Source Code](https://github.com/packtloss/pihole-extension)) +- [Splunk: Pi-hole Visualiser](https://splunkbase.splunk.com/app/3023/) +- [Adblocking with Pi-hole and Ubuntu 14.04 on VirtualBox](https://hbalagtas.blogspot.com.au/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html) +- [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py) +- [Pi-hole unRAID Template](https://forums.lime-technology.com/topic/36810-support-spants-nodered-mqtt-dashing-couchdb/) +- [Copernicus: Windows Tray Application](https://github.com/goldbattle/copernicus) +- [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f) +- [Pi-hole metrics](https://github.com/nlamirault/pihole_exporter) exporter for [Prometheus](https://prometheus.io/) +- [Magic Mirror with DNS Filtering](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware) +- [Pi-hole Droid: 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) +- [Pi-hole Visualizer](https://www.reddit.com/r/pihole/comments/82ikgb/pihole_visualizer_update/) + diff --git a/mkdocs.yml b/mkdocs.yml index 793d1af..b99165b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,31 +37,36 @@ markdown_extensions: # Include files in other documents like {!some/dir/in/docs/filename.md!} - markdown_include.include: base_path: docs -pages: -- 'Overview & Support': 'index.md' +nav: +- Overview: index.md +- 'About Pi-hole': + - 'Contact Us': main/contact.md + - 'Pi-hole Origins': main/origins.md + - 'Presentation Support': main/presentations.md + - 'On the Web': main/coverage.md - 'Getting Started': - - 'Prerequisites': 'main/prerequesites.md' - - 'Installation': 'main/basic-install.md' - - 'Post-Install': 'main/post-install.md' - - 'Updating': 'main/update.md' + - 'Prerequisites': main/prerequesites.md + - 'Installation': main/basic-install.md + - 'Post-Install': main/post-install.md + - 'Updating': main/update.md - 'Pi-hole Core': - - 'The pihole command': 'core/pihole-command.md' + - 'The pihole command': core/pihole-command.md - 'FTLDNS': - - 'Overview': "ftldns/index.md" - - 'Configuration': "ftldns/configfile.md" - - 'DNS resolver': "ftldns/dns-resolver.md" - - 'DNS cache': "ftldns/dns-cache.md" - - 'Blocking mode': "ftldns/blockingmode.md" + - 'Overview': ftldns/index.md + - 'Configuration': ftldns/configfile.md + - 'DNS resolver': ftldns/dns-resolver.md + - 'DNS cache': ftldns/dns-cache.md + - 'Blocking mode': ftldns/blockingmode.md - 'RegEx blocking': - - "Overview": "ftldns/regex/overview.md" - - "Tutorial": "ftldns/regex/tutorial.md" - - 'Privacy levels': "ftldns/privacylevels.md" - - 'Long-term database': "ftldns/database.md" - - 'Telnet API': "ftldns/telnet-api.md" - - 'Compatibility': "ftldns/compatibility.md" - - 'Install from source': "ftldns/compile.md" - - 'Debugging FTLDNS': "ftldns/debugging.md" - - 'In-depth manual': "ftldns/in-depth.md" + - "Overview": ftldns/regex/overview.md + - "Tutorial": ftldns/regex/tutorial.md + - 'Privacy levels': ftldns/privacylevels.md + - 'Long-term database': ftldns/database.md + - 'Telnet API': ftldns/telnet-api.md + - 'Compatibility': ftldns/compatibility.md + - 'Install from source': ftldns/compile.md + - 'Debugging FTLDNS': ftldns/debugging.md + - 'In-depth manual': ftldns/in-depth.md - 'Contributing': - 'Contributing on Github': guides/github/contributing.md - 'How to sign-off commits': guides/github/how-to-signoff.md @@ -73,23 +78,25 @@ pages: - 'Configuring NGINX for Pi-hole': guides/nginx-configuration.md - 'Configuring Caddy for Pi-hole': guides/caddy-configuration.md - 'Pi-hole and OpenVPN Server': - - 'Overview': 'guides/vpn/overview.md' - - 'Installation': 'guides/vpn/installation.md' - - 'Setup OpenVPN Server': 'guides/vpn/setup-openvpn-server.md' - - 'Firewall Configuration': 'guides/vpn/firewall.md' + - 'Overview': guides/vpn/overview.md + - 'Installation': guides/vpn/installation.md + - 'Setup OpenVPN Server': guides/vpn/setup-openvpn-server.md + - 'Firewall Configuration': guides/vpn/firewall.md - 'Connecting clients': - - 'General': 'guides/vpn/clients.md' - - 'Android': 'guides/vpn/android-client.md' - - 'Optional: Only route DNS via VPN': 'guides/vpn/only-dns-via-vpn.md' - - 'Optional: Dual operation: LAN & VPN at the same time': 'guides/vpn/dual-operation.md' - - 'Optional: Full and DNS-only': 'guides/vpn/dual-VPN.md' - - 'Optional: Dynamic DNS': 'guides/vpn/dynDNS.md' + - 'General': guides/vpn/clients.md + - 'Android': guides/vpn/android-client.md + - 'Optional: Only route DNS via VPN': guides/vpn/only-dns-via-vpn.md + - 'Optional: Dual operation: LAN & VPN at the same time': guides/vpn/dual-operation.md + - 'Optional: Full and DNS-only': guides/vpn/dual-VPN.md + - 'Optional: Dynamic DNS': guides/vpn/dynDNS.md - 'TOR & Pi-hole': - 'Overview': guides/tor/overview.md - 'Basic Setup': guides/tor/setup.md - 'Using TOR': guides/tor/using-tor.md - 'Performance and other issues': guides/tor/performance-issues.md - 'Using DNSSEC': guides/tor/dnssec.md +- 'Community Projects': main/projects.md + extra: social: - type: globe