Merge branch 'master' into fedora_33_support

.github/workflows/calibreapp-image-actions.yml

@@ -0,0 +1,24 @@
+name: Compress Images
+
+on:
+  pull_request:
+    paths:
+      - '**.jpg'
+      - '**.jpeg'
+      - '**.png'
+      - '**.webp'
+
+jobs:
+  build:
+    # Only run on Pull Requests within the same repository, and not from forks.
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    name: calibreapp/image-actions
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+
+      - name: Compress Images
+        uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -9,8 +9,8 @@ on:
       - "**"
 
 env:
-  CI: true
-  NODE: 12.x
+  FORCE_COLOR: 2
+  NODE: 14.x
   PYTHON_VERSION: "3.7"
 
 jobs:
@@ -28,7 +28,7 @@ jobs:
           architecture: "x64"
 
       - name: Set up Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: "${{ env.NODE }}"
 
@@ -39,10 +39,12 @@ jobs:
           key: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}
           restore-keys: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}
 
+      # This is needed otherwise pip warns:
+      # Using legacy 'setup.py install' for DEP, since package 'wheel' is not installed.
       - run: pip install --upgrade wheel
 
       - name: Install Python dependencies
-        run: python3 -m pip install -r requirements.txt
+        run: pip install -r requirements.txt
 
       - name: Install npm dependencies
         run: npm ci

docs/extra.css

@@ -1,8 +1,3 @@
-body,
-input {
-    color: #000;
-}
-
 .md-nav {
     font-size: 14px;
     line-height: 1.4;
@@ -16,9 +11,27 @@ input {
 .md-typeset code,
 .md-typeset pre {
     white-space: pre-wrap;
-    color: #532ba8;
+    color: var(--code-color);
 }
 
 .text-center {
     text-align: center !important;
 }
+
+.md-typeset table:not([class]) th {
+    color: var(--table-foreground);
+    background-color: var(--table-background);
+}
+
+[data-md-color-scheme="default"] {
+    --code-color: #532ba8;
+    --table-foreground: var(--md-default-bg-color); /* table header backgrounds */
+    --table-background: var(--md-default-fg-color--light); /* table header (text) */
+}
+
+[data-md-color-scheme="slate"] {
+    --code-color: #a47df8;
+    --md-typeset-a-color: #7c90ff; /* links */
+    --table-foreground: #a3acdf; /* table header (text) */
+    --table-background: #272e53; /* table header backgrounds */
+}

docs/ftldns/compile.md

@@ -23,9 +23,9 @@ sudo dnf install gcc gmp-devel gmp-static m4 cmake libidn-devel readline-devel x
 Compile and install a recent version using:
 
 ```bash
-wget https://ftp.gnu.org/gnu/nettle/nettle-3.6.tar.gz
-tar -xzf nettle-3.6.tar.gz
-cd nettle-3.6
+wget https://ftp.gnu.org/gnu/nettle/nettle-3.7.2.tar.gz
+tar -xzf nettle-3.7.2.tar.gz
+cd nettle-3.7.2
 ./configure --libdir=/usr/local/lib
 make -j $(nproc)
 sudo make install

docs/ftldns/configfile.md

@@ -46,7 +46,7 @@ Rate-limiting may be disabled altogether by setting `RATE_LIMIT=0/0` (this resul
 
 #### `MAXLOGAGE=24.0` {#maxlogage data-toc-label='Max Log Age'}
 
-Up to how many hours of queries should be imported from the database and logs? Maximum is 24.0
+Up to how many hours of queries should be imported from the database and logs? Values greater than the hard-coded maximum of 24h need a locally compiled  `FTL` with a changed compile-time value.
 
 #### `PRIVACYLEVEL=0|1|2|3` {#privacylevel data-toc-label='Privacy Level'}
 

docs/ftldns/interfaces.md

@@ -0,0 +1,42 @@
+# Interface binding behavior
+
+## Interface listening settings
+
+Pi-hole offers three choices for interface listening behavior on its dashboard:
+
+![Available interface listening behavior settings](/images/interface-listening.png)
+
+### Listen on all interfaces
+
+This setting accepts DNS queries only from hosts whose address is on a local subnet, i.e. a subnet for which an interface exists on the server. It is intended to be set as a default on installation, to allow unconfigured installations to be useful but also safe from being used for DNS amplification attacks if (accidentally) running public.
+
+The `dnsmasq` option `local-service` is used.
+
+### Listen only on interface `eth0`
+
+Listen only on the specified interface. The loopback (`lo`) interface is automatically added to the list of interfaces to use when this option is used. When the optional settings `bind-interfaces` or `bind-dynamic` are in effect, IP alias interface labels (e.g. `eth1:0`) are checked, rather than interface names.
+
+In the degenerate case when an interface has one address, this amounts to the same thing but when an interface has multiple addresses it allows control over which of those addresses are accepted. The same effect is achievable in default mode by using `listen-address`.
+
+The `dnsmasq` option `interface=eth0` is used (the interface may be different).
+
+### Listen on all interfaces, permit all origins
+
+We intentionally add this option to disable any possible `local-service` settings from other files. This truly allows any traffic to be replied to and a dangerous thing to do. You should always ask yourself if the first option doesn't work for you as well.
+
+The `dnsmasq` option `except-interface=nonexisting` is used.
+
+## Technical details
+
+By default, FTL binds the wildcard address, even when it is listening on only some interfaces. It then discards requests that it shouldn't reply to. This has the big advantage of working even when interfaces come and go and change address (this happens way more often than one would think).
+
+If this is not what you want, you can add the option
+
+``` plain
+bind-interfaces
+```
+
+to some file like `/etc/dnsmasq.d/99-user.conf` and see [the comment above](#listen-only-on-interface-eth0). This config forces FTL to really bind only the interfaces it is listening on.
+About the only time when this is useful is when running another nameserver on the same port on the same machine.
+
+{!abbreviations.md!}

docs/guides/dns/cloudflared.md

@@ -58,6 +58,8 @@ sudo chmod +x /usr/local/bin/cloudflared
 cloudflared -v
 ```
 
+Note: Users [have reported](https://github.com/cloudflare/cloudflared/issues/38) that the current version of cloudflared produces a segementation fault error on Raspberry Pi Zero W, Model 1B and 2B. As a workaround you can use an older version provided at <https://bin.equinox.io/a/4SUTAEmvqzB/cloudflared-2018.7.2-linux-arm.tar.gz> instead.
+
 #### `cloudflared` archive page
 
 You can find all `cloudflared` binary releases on <https://dl.equinox.io/cloudflare/cloudflared/stable/archive>.

docs/guides/vpn/wireguard/server.md

@@ -12,7 +12,7 @@
 Installing everything we will need for a `wireguard` connections is as simple as running:
 
 ```bash
-sudo apt-get install wireguard wireguard-tools wireguard-dkms
+sudo apt-get install wireguard wireguard-tools
 ```
 
 For Ubuntu 18.04 and lower, you need to do some extra steps:
@@ -20,9 +20,11 @@ For Ubuntu 18.04 and lower, you need to do some extra steps:
 ```bash
 sudo add-apt-repository ppa:wireguard/wireguard
 sudo apt update
-sudo apt install wireguard wireguard-tools wireguard-dkms
+sudo apt install wireguard wireguard-tools
 ```
 
+If you're running a kernel older than 5.6 (check with `uname -r`), you will also need to install `wireguard-dkms`
+
 If there is no `wireguard` package available for your system, you can follow the instructions below to compile WireGuard from source.
 
 <!-- markdownlint-disable code-block-style -->

docs/index.md

@@ -44,7 +44,9 @@ Sending a donation using our links below is **extremely helpful** in offsetting
 
 If you'd rather not 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](https://www.digitalocean.com/?refcode=344d234950e1) _new account credits with our affiliate link_
+- [Stickermule](https://www.stickermule.com/unlock?ref_id=9127301701&utm_medium=link&utm_source=invite) _earn a $10 credit after your first purchase_
 - [Amazon](https://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
 - Spreading the word about our software, and how you have benefited from it
 

docs/main/basic-install.md

@@ -28,4 +28,8 @@ wget -O basic-install.sh https://install.pi-hole.net
 sudo bash basic-install.sh
 ```
 
+### Alternative 3: Use Docker to deploy Pi-hole
+
+Please refer to the [Pi-hole docker repo](https://github.com/pi-hole/docker-pi-hole) to use the Official Docker Images.
+
 {!abbreviations.md!}

docs/main/update.md

@@ -2,8 +2,4 @@ Updating is as simple as running the following command:
 
 `pihole -up`
 
-### Common issues with updating:
-
-`[Placeholder for solutions to issues]`
-
 {!abbreviations.md!}

mkdocs.yml

@@ -2,7 +2,7 @@ site_name: 'Pi-hole documentation'
 site_url: 'https://docs.pi-hole.net/'
 repo_url: 'https://github.com/pi-hole/pi-hole'
 edit_uri: '../docs/blob/master/docs/'
-copyright: 'Copyright © 2020 Pi-hole LLC'
+copyright: 'Copyright © 2021 Pi-hole LLC'
 remote_branch: gh-pages
 theme:
   name: 'material'
@@ -15,6 +15,27 @@ theme:
   font:
     text: 'Source Sans Pro'
     code: 'Roboto Mono'
+  features:
+    - navigation.top
+  palette:
+
+    # Light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to dark mode
+
+    # Dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/lightbulb
+        name: Switch to light mode
 
 markdown_extensions:
   # Code highlighting in ``` ``` blocks
@@ -76,6 +97,7 @@ nav:
   - 'FTLDNS':
     - 'Overview': ftldns/index.md
     - 'Configuration': ftldns/configfile.md
+    - 'Interfaces': ftldns/interfaces.md
     - 'DNS resolver': ftldns/dns-resolver.md
     - 'DNS cache': ftldns/dns-cache.md
     - 'Blocking mode': ftldns/blockingmode.md

overrides/main.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% set extracopyright %}
+  <br>
+  <a href="https://www.netlify.com/" target="_blank" rel="noopener noreferrer">
+    This site is powered by Netlify
+  </a>
+{% endset %}

overrides/partials/footer.html

@@ -1,59 +0,0 @@
-{% import "partials/language.html" as lang with context %}
-<footer class="md-footer">
-  {% if page.previous_page or page.next_page %}
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid" aria-label="{{ lang.t('footer.title') }}">
-        {% if page.previous_page %}
-          <a href="{{ page.previous_page.url | url }}" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
-            <div class="md-footer-nav__button md-icon">
-              {% include ".icons/material/arrow-left.svg" %}
-            </div>
-            <div class="md-footer-nav__title">
-              <div class="md-ellipsis">
-                <span class="md-footer-nav__direction">
-                  {{ lang.t("footer.previous") }}
-                </span>
-                {{ page.previous_page.title }}
-              </div>
-            </div>
-          </a>
-        {% endif %}
-        {% if page.next_page %}
-          <a href="{{ page.next_page.url | url }}" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
-            <div class="md-footer-nav__title">
-              <div class="md-ellipsis">
-                <span class="md-footer-nav__direction">
-                  {{ lang.t("footer.next") }}
-                </span>
-                {{ page.next_page.title }}
-              </div>
-            </div>
-            <div class="md-footer-nav__button md-icon">
-              {% include ".icons/material/arrow-right.svg" %}
-            </div>
-          </a>
-        {% endif %}
-      </nav>
-    </div>
-  {% endif %}
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        {% if config.copyright %}
-          <div class="md-footer-copyright__highlight">
-            {{ config.copyright }}
-          </div>
-        {% endif %}
-        Made with
-        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-          Material for MkDocs
-        </a>
-        <br>
-        <a href="https://www.netlify.com" target="_blank" rel="noreferrer">
-            This site is powered by Netlify
-        </a>
-      </div>
-      {% include "partials/social.html" %}
-    </div>
-  </div>
-</footer>

package-lock.json

@@ -703,9 +703,9 @@
       }
     },
     "glob-parent": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz",
-      "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==",
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+      "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
       "dev": true,
       "requires": {
         "is-glob": "^4.0.1"
@@ -721,9 +721,9 @@
       }
     },
     "globby": {
-      "version": "11.0.2",
-      "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.2.tgz",
-      "integrity": "sha512-2ZThXDvvV8fYFRVIxnrMQBipZQDr7MxKAmQK1vujaj9/7eF0efG7BPUKJ7jP7G5SLF37xKDXvO4S/KKLj/Z0og==",
+      "version": "11.0.3",
+      "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz",
+      "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==",
       "dev": true,
       "requires": {
         "array-union": "^2.1.0",
@@ -1112,14 +1112,6 @@
         "linkify-it": "^3.0.1",
         "mdurl": "^1.0.1",
         "uc.micro": "^1.0.5"
-      },
-      "dependencies": {
-        "entities": {
-          "version": "2.1.0",
-          "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz",
-          "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==",
-          "dev": true
-        }
       }
     },
     "markdownlint": {
@@ -1132,18 +1124,18 @@
       }
     },
     "markdownlint-cli2": {
-      "version": "0.0.14",
-      "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.0.14.tgz",
-      "integrity": "sha512-h3aXjve9y7pVXJMpka6msP4aGIJamju0Gv7L9knRz3nAdhhaW1aOiRvnLGgqu7BZyp1y7agjWnx8ojh7iLCCeg==",
+      "version": "0.1.3",
+      "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.1.3.tgz",
+      "integrity": "sha512-4pbrSEDe/G9PjJnrxKXKTQXyXERHvFH+RjvZrCRiNrVPB0p1/wmQXCkdsKNWlaf+gc4gz4k9u1fj2x28GvFenw==",
       "dev": true,
       "requires": {
-        "globby": "~11.0.2",
+        "globby": "~11.0.3",
         "markdownlint": "~0.23.1",
-        "markdownlint-cli2-formatter-default": "~0.0.2",
+        "markdownlint-cli2-formatter-default": "^0.0.2",
         "markdownlint-rule-helpers": "~0.14.0",
         "micromatch": "~4.0.2",
         "strip-json-comments": "~3.1.1",
-        "yaml": "~1.10.0"
+        "yaml": "~1.10.2"
       },
       "dependencies": {
         "strip-json-comments": {
@@ -1205,13 +1197,13 @@
       "dev": true
     },
     "micromatch": {
-      "version": "4.0.2",
-      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz",
-      "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==",
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz",
+      "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==",
       "dev": true,
       "requires": {
         "braces": "^3.0.1",
-        "picomatch": "^2.0.5"
+        "picomatch": "^2.2.3"
       }
     },
     "mime": {
@@ -1408,9 +1400,9 @@
       "dev": true
     },
     "picomatch": {
-      "version": "2.2.2",
-      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz",
-      "integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.3.tgz",
+      "integrity": "sha512-KpELjfwcCDUb9PeigTs2mBJzXUPzAuP2oPcA989He8Rte0+YUAjw1JVedDhuTKPkHjSYzMN3npC9luThGYEKdg==",
       "dev": true
     },
     "prepend-http": {
@@ -1439,9 +1431,9 @@
       }
     },
     "queue-microtask": {
-      "version": "1.2.2",
-      "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.2.tgz",
-      "integrity": "sha512-dB15eXv3p2jDlbOiNLyMabYg1/sXvppd8DP2J3EOCQ0AkuSXCW2tP7mnVouVLJKgUMY6yP0kcQDVpLCN13h4Xg==",
+      "version": "1.2.3",
+      "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+      "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
       "dev": true
     },
     "quick-lru": {
@@ -1483,9 +1475,9 @@
       },
       "dependencies": {
         "hosted-git-info": {
-          "version": "2.8.8",
-          "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz",
-          "integrity": "sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==",
+          "version": "2.8.9",
+          "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz",
+          "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==",
           "dev": true
         },
         "normalize-package-data": {
@@ -1904,9 +1896,9 @@
       "dev": true
     },
     "yaml": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.0.tgz",
-      "integrity": "sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg==",
+      "version": "1.10.2",
+      "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz",
+      "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==",
       "dev": true
     },
     "yargs-parser": {

package.json

@@ -23,6 +23,6 @@
   },
   "devDependencies": {
     "linkinator": "^2.13.6",
-    "markdownlint-cli2": "0.0.14"
+    "markdownlint-cli2": "0.1.3"
   }
 }

requirements.txt

@@ -1,5 +1,5 @@
 markdown-include==0.6.0
 mkdocs==1.1.2
-mkdocs-git-revision-date-localized-plugin==0.8
-mkdocs-material==6.2.6
-mkdocs-redirects==1.0.1
+mkdocs-git-revision-date-localized-plugin==0.9.2
+mkdocs-material==7.1.6
+mkdocs-redirects==1.0.3