Merge branch 'devel' into new/rev-server

Signed-off-by: DL6ER <[email protected]>
pi-hole · Jun 4, 2020 · 3ccfcb4 · 3ccfcb4
2 parents 373d59f + 8dd1419
commit 3ccfcb4
Show file tree

Hide file tree

Showing 155 changed files with 6,555 additions and 11,672 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,19 +1,20 @@
 **In raising this issue, I confirm the following:** `{please fill the checkboxes, e.g: [X]}`
 
 - [] I have read and understood the [contributors guide](https://github.com/pi-hole/AdminLTE/blob/master/CONTRIBUTING.md).
-- [] The issue I am reporting can be *replicated*.
+- [] The issue I am reporting can be _replicated_.
 - [] The issue I am reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/AdminLTE/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/AdminLTE/issues)).
 
 **How familiar are you with the the source code relevant to this issue?:**
 
 `{Replace this with a number from 1 to 10. 1 being not familiar, and 10 being very familiar}`
 
 ---
-**Expected behaviour:**
+
+**Expected behavior:**
 
 `{A detailed description of what you expect to see}`
 
-**Actual behaviour:**
+**Actual behavior:**
 
 `{A detailed description and/or screenshots of what you do see}`
 
@@ -29,9 +30,9 @@
 
 `{Steps of what you have done to fix this}`
 
-> * `{Please delete this quoted section when opening your issue}`
-> * You must follow the template instructions. Failure to do so will result in your issue being closed.
-> * Please [submit any feature requests here](https://discourse.pi-hole.net/c/feature-requests), so it is votable and trackable by the community.
-> * Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
-> * Detail helps us understand and resolve an issue quicker, but please ensure it's relevant.
-> * _This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+> - `{Please delete this quoted section when opening your issue}`
+> - You must follow the template instructions. Failure to do so will result in your issue being closed.
+> - Please [submit any feature requests here](https://discourse.pi-hole.net/c/feature-requests), so it is votable and trackable by the community.
+> - Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
+> - Detail helps us understand and resolve an issue quicker, but please ensure it's relevant.
+> - _This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -26,7 +26,7 @@
 
 `{A detailed list of any necessary changes}`
 
-> * `{Please delete this quoted section when opening your pull request}`
-> * You must follow the template instructions. Failure to do so will result in your issue being closed.
-> * Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
-> * Detail helps us understand an issue quicker, but please ensure it's relevant.
+> - `{Please delete this quoted section when opening your pull request}`
+> - You must follow the template instructions. Failure to do so will result in your issue being closed.
+> - Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
+> - Detail helps us understand an issue quicker, but please ensure it's relevant.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,5 +1,14 @@
 name: Tests
-on: [push, pull_request]
+
+on:
+  push:
+    branches:
+      - devel
+      - master
+  pull_request:
+    branches:
+      - "**"
+
 env:
   CI: true
 
@@ -8,22 +17,14 @@ jobs:
     name: Node ${{ matrix.node }}
     runs-on: ubuntu-latest
 
-    strategy:
-      fail-fast: false
-      matrix:
-        node: [12]
-
     steps:
       - name: Clone repository
         uses: actions/checkout@v2
 
       - name: Set Node.js version
         uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node }}
-
-      - run: node --version
-      - run: npm --version
+          node-version: "12.x"
 
       - name: Install npm dependencies
         run: npm ci

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,8 +6,8 @@ Please read and understand the contribution guide before creating an issue or pu
 
 ## Etiquette
 
-- Our goal for Pi-hole is **stability before features**.  This means we focus on squashing critical bugs before adding new features.  Often, we can do both in tandem, but bugs will take priority over a new feature.
-- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project.  It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that.
+- Our goal for Pi-hole is **stability before features**. This means we focus on squashing critical bugs before adding new features. Often, we can do both in tandem, but bugs will take priority over a new feature.
+- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project. It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that.
 - Please be considerate towards the developers and other users when raising issues or presenting pull requests.
 - Respect our decision(s), and do not be upset or abusive if your submission is not used.
 

diff --git a/README.md b/README.md
@@ -1,8 +1,14 @@
 <p align="center">
-<a href="https://pi-hole.net"><img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_text.png" width="150" height="255" alt="Pi-hole"></a><br/></br>
-<b>Network-wide ad blocking via your own Linux hardware</b><br/>
-</br>
-<a href="https://pi-hole.net"><img src="https://pi-hole.github.io/graphics/Screenshots/pihole-dashboard.png" alt="Pi-hole Web interface"></a><br/>
+    <a href="https://pi-hole.net/">
+        <img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_Wordmark.svg" width="150" height="260" alt="Pi-hole">
+    </a>
+    <br>
+    <strong>Network-wide ad blocking via your own Linux hardware</strong>
+    <br>
+    <br>
+    <a href="https://pi-hole.net/">
+        <img src="https://pi-hole.github.io/graphics/Screenshots/pihole-dashboard.png" alt="Pi-hole Web interface">
+    </a>
 </p>
 
 Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/)'s Web interface (based off of [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)) provides a central location to manage your Pi-hole and review the statistics generated by FTLDNS[™](https://pi-hole.net/trademark-rules-and-brand-guidelines/).
@@ -13,13 +19,15 @@ Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/)'s Web int
 - **Insightful**: use the query log, audit log, or long-term stats to gain insight into your networks activity
 
 ---
+
 <img src="https://pi-hole.github.io/graphics/Badges/browserstack-badge.png" height="80"><br>
 
 # Installation
 
 The Web interface is enabled by default when you install Pi-hole.
 
 ## Post-installation: access the Web interface and gain insight into your network's activity
+
 There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168):
 
 1. `http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/`
@@ -33,123 +41,140 @@ Once logged in (forgot your password?), you can view your network stats to see t
 - the amount of domains that were blocked
 - the upstream server queries were sent to
 - the type of queries (`A`, `AAAA`, `CNAME`, `SRV`, `TXT`, etc.)
+
 ---
 
 ## Pi-hole is free, but powered by your support
+
 There are many reoccurring costs involved with maintaining free, open source, and privacy respecting software; expenses which [our volunteer developers](https://github.com/orgs/pi-hole/people) pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained.
 
 Make no mistake: **your support is absolutely vital to help keep us innovating!**
 
 ### Donations
+
 Sending a donation using our links below is **extremely helpful** in offsetting a portion of our monthly expenses:
 
-- <img src="https://pi-hole.github.io/graphics/Badges/paypal-badge-black.svg" width="24" height="24" alt="PP"/> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY">Donate via PayPal</a><br/>
-- <img src="https://pi-hole.github.io/graphics/Badges/bitcoin-badge-black.svg" width="24" height="24" alt="BTC"/> [Bitcoin, Bitcoin Cash, Ethereum, Litecoin](https://commerce.coinbase.com/checkout/dd304d04-f324-4a77-931b-0db61c77a41b)
+- <img src="https://pi-hole.github.io/graphics/Badges/paypal-badge-black.svg" width="24" height="24" alt="PP"> [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
+- <img src="https://pi-hole.github.io/graphics/Badges/bitcoin-badge-black.svg" width="24" height="24" alt="BTC"> [Bitcoin, Bitcoin Cash, Ethereum, Litecoin](https://commerce.coinbase.com/checkout/dd304d04-f324-4a77-931b-0db61c77a41b)
 
 ### Alternative support
+
 If you'd rather not [donate](https://pi-hole.net/donate/) (_which is okay!_), there are other ways you can help support us:
 
 - [Patreon](https://patreon.com/pihole) _Become a patron for rewards_
-- [Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) _affiliate link_
-- [Stickermule](https://www.stickermule.com/unlock?ref_id=6055890701&utm_medium=link&utm_source=invite) _earn a $10 credit after your first purchase_
+- [Digital Ocean](https://www.digitalocean.com/?refcode=344d234950e1) _affiliate link_
+- [Stickermule](https://www.stickermule.com/unlock?ref_id=6055890701&utm_medium=link&utm_source=invite) _earn a \$10 credit after your first purchase_
 - [Pi-hole Swag Store](https://pi-hole.net/shop/) _affiliate link_
-- [Amazon](http://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
+- [Amazon](https://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
 - [DNS Made Easy](https://cp.dnsmadeeasy.com/u/133706) _affiliate link_
-- [Vultr](http://www.vultr.com/?ref=7190426) _affiliate link_
 - Spreading the word about our software, and how you have benefited from it
 
 ### Contributing via GitHub
+
 We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests.
 
 If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve.
 
 ### 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 <a href="https://discourse.pi-hole.net/">Discourse User Forum</a>, 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.
 
-<ul>
-  <li><b><a href="https://discourse.pi-hole.net/c/faqs">Frequently Asked Questions</a></b></li>
-  <li><b><a href="https://github.com/pi-hole/pi-hole/wiki">Pi-hole Wiki</a></b></li>
-  <li><b><a href="https://discourse.pi-hole.net/c/feature-requests?order=votes">Feature Requests</a></b></li>
-  <li><a href="https://discourse.pi-hole.net/">Discourse User Forum</a></li>
-  <li><a href="https://www.reddit.com/r/pihole/">Reddit</a></li>
-  <li><a href="https://twitter.com/The_Pi_Hole">Twitter</a></li>
-  <li><a href="https://www.facebook.com/ThePiHole/">Facebook</a></li>
-  <li><a href="https://gitter.im/pi-hole/pi-hole">Gitter</a> (Real-time chat)</li>
-  <li><a href="https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w">YouTube</a></li>
-</ul>
+* **[Frequently Asked Questions](https://discourse.pi-hole.net/c/faqs)**
+* **[Pi-hole Wiki](https://github.com/pi-hole/pi-hole/wiki)**
+* **[Feature Requests](https://discourse.pi-hole.net/c/feature-requests?order=votes)**
+* [Discourse User Forum](https://discourse.pi-hole.net/)
+* [Reddit](https://www.reddit.com/r/pihole/)
+* [Twitter](https://twitter.com/The_Pi_Hole)
+* [Facebook](https://www.facebook.com/ThePiHole/)
+* [Gitter](https://gitter.im/pi-hole/pi-hole) (Real-time chat)
+* [YouTube](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
 
 # Features
 
 ## Mobile friendly interface
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/mobile-friendly.png" height="300" alt="Mobile friendly"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/mobile-friendly.png" height="300" alt="Mobile friendly">
 </p>
 
 ## Password protection
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/password-protection.png" height="400" alt="Password protection"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/password-protection.png" height="400" alt="Password protection">
 </p>
 
 ## Detailed graphs and doughnut charts
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/piecharts.png" alt="Pie charts"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/piecharts.png" alt="Pie charts">
 </p>
 
 ## Top lists of domains and clients
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/topdomains-clients.png" alt="Top domains/top clients"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/topdomains-clients.png" alt="Top domains/top clients">
 </p>
 
 ## A filterable and sortable query log
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/query-log-sorted.png" alt="Query log"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/query-log-sorted.png" alt="Query log">
 </p>
 
 ## An audit log
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/audit-log.png" alt="Pi-hole Web interface"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/audit-log.png" alt="Pi-hole Web interface">
 </p>
 
 ## Long Term Statistics to view data over user defined time ranges
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/long-term-stats.png" alt="Long-term stats"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/long-term-stats.png" alt="Long-term stats">
 </p>
 
 ## A built-in debugger
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/debug.png" alt="Debugger"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/debug.png" alt="Debugger">
 </p>
 
 ## Black and white lists
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/blacklist.png" alt="Blacklist"></a>
-</br></br>
-<img src="https://pi-hole.github.io/graphics/Screenshots/whitelist.png" alt="Whitelist"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/blacklist.png" alt="Blacklist">
+  <br><br>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/whitelist.png" alt="Whitelist">
 </p>
 
 ## The ability to easily manage and configure Pi-hole features
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/dashboard-settings.gif" alt="Settings"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/dashboard-settings.gif" alt="Settings">
 </p>
 
 ## ... and all the main features of the Command Line Interface!
+
 <p align="center">
-<img src="https://pi-hole.github.io/graphics/Screenshots/pihole-t.png" alt="Tail the log"></a>
-</br></br>
-<img src="https://pi-hole.github.io/graphics/Screenshots/pihole-q.png" alt="Query ad lists"></a>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/pihole-t.png" alt="Tail the log">
+  <br><br>
+  <img src="https://pi-hole.github.io/graphics/Screenshots/pihole-q.png" alt="Query ad lists">
 </p>
 
 ## API
-Full usage available [here](https://discourse.pi-hole.net/t/pi-hole-api/1863).  can be accessed at `/admin/api.php`. With either no parameters or `/admin/api.php?summary` it returns the following JSON:
-```JSON
-{  
+
+Full usage available [here](https://discourse.pi-hole.net/t/pi-hole-api/1863). Can be accessed at `/admin/api.php`. With either no parameters or `/admin/api.php?summary` it returns the following JSON:
+
+```json
+{
    "domains_being_blocked":243038,
    "dns_queries_today":2385,
    "ads_blocked_today":414,