Merge pull request #3989 from pi-hole/release/v5.2.3

Pi-hole Core v5.2.3

.editorconfig

@@ -0,0 +1,38 @@
+# EditorConfig is awesome: https://editorconfig.org/
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = tab
+tab_width = 4
+charset = utf-8
+trim_trailing_whitespace = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,py}]
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+
+# Indentation override for all JS under lib directory
+[scripts/**.js]
+indent_style = space
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -35,4 +35,4 @@ GitHub.Tests.Integration/Resources/*  binary
 
 
 # Catch all for anything we forgot. Add rules if you get CRLF -> LF warnings.
-* text=auto
+* text eol=lf

.github/ISSUE_TEMPLATE.md

@@ -1,42 +0,0 @@
-**In raising this issue, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your issue:**
-
-- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
-- [] The issue I am reporting can be *replicated*
-- [] The issue I'm reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
-
-**How familiar are you with the codebase?:**
-
-- [] 1 (very unfamiliar)
-- [] 2
-- [] 3
-- [] 4
-- [] 5
-- [] 6
-- [] 7
-- [] 8
-- [] 9
-- [] 10 (very familiar)
-
----
-**[FEATURE REQUEST | QUESTION | OTHER]:**
-
-Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community.  It's also easier for us to track.
-
-**[BUG | ISSUE] Expected Behaviour:**
-
-
-**[BUG | ISSUE] Actual Behaviour:**
-
-
-**[BUG | ISSUE] Steps to reproduce:**
-
--
--
--
--
-
-**(Optional) Debug token generated by `pihole -d`:**
-
-`<token>`
-
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,28 +0,0 @@
-**By submitting this pull request, I confirm the following (please check boxes, eg [X]) _Failure to fill the template will close your PR_:**
-
-***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
-
-- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
-- [] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.
-- [] I have considered, and confirmed that this submission will be valuable to others.
-- [] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
-- [] I give this submission freely, and claim no ownership to its content.
-
-**How familiar are you with the codebase?:**
-
-- [] 1 (very unfamiliar)
-- [] 2
-- [] 3
-- [] 4
-- [] 5
-- [] 6
-- [] 7
-- [] 8
-- [] 9
-- [] 10 (very familiar)
-
----
-_{replace this line with your pull request content}_
-
-
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.github/dco.yml

@@ -0,0 +1,2 @@
+require:
+  members: false

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test Supported Distributions
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  distro-test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        distro: [debian_9, debian_10, ubuntu_16, ubuntu_18, ubuntu_20, centos_7, centos_8, fedora_31, fedora_32]
+    env:
+      DISTRO: ${{matrix.distro}}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: pip install -r test/requirements.txt
+    - name: Test with tox
+      run: tox -c test/tox.${DISTRO}.ini

.gitignore

@@ -3,5 +3,74 @@
 *.swp
 __pycache__
 .cache
-.pullapprove.yml
+.pytest_cache
+.tox
+.eggs
+*.egg-info
 
+
+# Created by https://www.gitignore.io/api/jetbrains+iml
+
+### JetBrains+iml ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# All idea files, with exceptions
+.idea
+!.idea/codeStyles/*
+!.idea/codeStyleSettings.xml
+
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Ruby plugin and RubyMine
+/.rakeTasks
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### JetBrains+iml Patch ###
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+.idea/misc.xml
+*.ipr
+
+# End of https://www.gitignore.io/api/jetbrains+iml

.idea/codeStyleSettings.xml

@@ -1,22 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
-  <component name="ProjectCodeStyleSettingsManager">
+    <component name="ProjectCodeStyleSettingsManager">
-    <option name="PER_PROJECT_SETTINGS">
+        <option name="PER_PROJECT_SETTINGS">
-      <value>
+            <value>
-        <option name="OTHER_INDENT_OPTIONS">
+                <option name="OTHER_INDENT_OPTIONS">
-          <value>
+                    <value>
-            <option name="INDENT_SIZE" value="2" />
+                        <option name="INDENT_SIZE" value="2" />
-            <option name="CONTINUATION_INDENT_SIZE" value="8" />
+                        <option name="CONTINUATION_INDENT_SIZE" value="8" />
-            <option name="TAB_SIZE" value="2" />
+                        <option name="TAB_SIZE" value="2" />
-            <option name="USE_TAB_CHARACTER" value="false" />
+                        <option name="USE_TAB_CHARACTER" value="false" />
-            <option name="SMART_TABS" value="false" />
+                        <option name="SMART_TABS" value="false" />
-            <option name="LABEL_INDENT_SIZE" value="0" />
+                        <option name="LABEL_INDENT_SIZE" value="0" />
-            <option name="LABEL_INDENT_ABSOLUTE" value="false" />
+                        <option name="LABEL_INDENT_ABSOLUTE" value="false" />
-            <option name="USE_RELATIVE_INDENTS" value="false" />
+                        <option name="USE_RELATIVE_INDENTS" value="false" />
-          </value>
+                    </value>
+                </option>
+                <MarkdownNavigatorCodeStyleSettings>
+                    <option name="RIGHT_MARGIN" value="72" />
+                </MarkdownNavigatorCodeStyleSettings>
+            </value>
         </option>
-      </value>
+        <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-    </option>
+    </component>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+</project>
-  </component>
-</project>

.idea/codeStyles/Project.xml

@@ -0,0 +1,7 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <MarkdownNavigatorCodeStyleSettings>
+      <option name="RIGHT_MARGIN" value="72" />
+    </MarkdownNavigatorCodeStyleSettings>
+  </code_scheme>
+</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

.pullapprove.yml

@@ -1,38 +0,0 @@
-version: 2
-
-always_pending:
-  title_regex: '(WIP|wip)'  
-  labels:
-    - wip
-  explanation: 'This PR is a work in progress...'
-
-group_defaults:
-  reset_on_push:
-    enabled: true
-  reject_value: -2
-  approve_regex: '^(Approved|:shipit:|:\+1:|Engage)'
-  reject_regex: '^(Rejected|:-1:|Borg)'
-  author_approval:
-    auto: true
-
-
-groups:
-  development:
-    approve_by_comment:
-      enabled: true
-    conditions:
-      branches:
-        - development        
-    required: 2
-    teams:
-      - approvers
-  
-  master:
-    approve_by_comment:
-      enabled: true
-    conditions:
-      branches:
-        - master
-    required: -1
-    teams:
-      - admin

.stickler.yml

@@ -0,0 +1,6 @@
+linters:
+  shellcheck:
+    shell: bash
+  phpcs:
+  flake8:
+    max-line-length: 120

.travis.yml

@@ -1,10 +0,0 @@
-sudo: required
-services:
-  - docker
-language: python
-python:
-  - "2.7"
-install:
-  - pip install -r requirements.txt
-
-script: py.test -vv

CONTRIBUTING.md

@@ -1,13 +1,11 @@
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
-
 # Contributors Guide
 
 Please read and understand the contribution guide before creating an issue or pull request.
 
 ## 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.
+- 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.
+- 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.
 
@@ -28,11 +26,87 @@ When requesting or submitting new features, first consider whether it might be u
 
 - Check the codebase to ensure that your feature doesn't already exist.
 - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+- Read and understand the [DCO guidelines](https://docs.pi-hole.net/guides/github/contributing/) for the project.
 
 ## Technical Requirements
 
 - Submit Pull Requests to the **development branch only**.
 - Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
-- Please use the [Google Style Guide for Shell](https://google.github.io/styleguide/shell.xml) for your code submission styles. 
+- Please use the [Google Style Guide for Shell](https://google.github.io/styleguide/shell.xml) for your code submission styles.
 - Commit Unix line endings.
+- Please use the Pi-hole brand: **Pi-hole** (Take a special look at the capitalized 'P' and a low 'h' with a hyphen)
 - (Optional fun) keep to the theme of Star Trek/black holes/gravity.
+
+## Forking and Cloning from GitHub to GitHub
+
+1. Fork <https://github.com/pi-hole/pi-hole/> to a repo under a namespace you control, or have permission to use, for example: `https://github.com/<your_namespace>/<your_repo_name>/`. You can do this from the github.com website.
+2. Clone `https://github.com/<your_namespace>/<your_repo_name>/` with the tool of you choice.
+3. To keep your fork in sync with our repo, add an upstream remote for pi-hole/pi-hole to your repo.
+
+    ```bash
+    git remote add upstream https://github.com/pi-hole/pi-hole.git
+    ```
+
+4. Checkout the `development` branch from your fork `https://github.com/<your_namespace>/<your_repo_name>/`.
+5. Create a topic/branch, based on the `development` branch code. *Bonus fun to keep to the theme of Star Trek/black holes/gravity.*
+6. Make your changes and commit to your topic branch in your repo.
+7. Rebase your commits and squash any insignificant commits. See the notes below for an example.
+8. Merge `development` your branch and fix any conflicts.
+9. Open a Pull Request to merge your topic branch into our repo's `development` branch.
+
+- Keep in mind the technical requirements from above.
+
+## Forking and Cloning from GitHub to other code hosting sites
+
+- Forking is a GitHub concept and cannot be done from GitHub to other git-based code hosting sites. However, those sites may be able to mirror a GitHub repo.
+
+1. To contribute from another code hosting site, you must first complete the steps above to fork our repo to a GitHub namespace you have permission to use, for example: `https://github.com/<your_namespace>/<your_repo_name>/`.
+2. Create a repo in your code hosting site, for example: `https://gitlab.com/<your_namespace>/<your_repo_name>/`
+3. Follow the instructions from your code hosting site to create a mirror between `https://github.com/<your_namespace>/<your_repo_name>/` and `https://gitlab.com/<your_namespace>/<your_repo_name>/`.
+4. When you are ready to create a Pull Request (PR), follow the steps `(starting at step #6)` from [Forking and Cloning from GitHub to GitHub](#forking-and-cloning-from-github-to-github) and create the PR from `https://github.com/<your_namespace>/<your_repo_name>/`.
+
+## Notes for squashing commits with rebase
+
+- To rebase your commits and squash previous commits, you can use:
+
+    ```bash
+    git rebase -i your_topic_branch~(number of commits to combine)
+    ```
+
+- For more details visit [gitready.com](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
+
+1. The following would combine the last four commits in the branch `mytopic`.
+
+    ```bash
+    git rebase -i mytopic~4
+    ```
+
+2. An editor window opens with the most recent commits indicated: (edit the commands to the left of the commit ID)
+
+    ```gitattributes
+    pick 9dff55b2 existing commit comments
+    squash ebb1a730 existing commit comments
+    squash 07cc5b50 existing commit comments
+    reword 9dff55b2 existing commit comments
+    ```
+
+3. Save and close the editor. The next editor window opens: (edit the new commit message). *If you select reword for a commit, an additional editor window will open for you to edit the comment.*
+
+    ```bash
+    new commit comments
+    Signed-off-by: yourname <your email address>
+    ```
+
+4. Save and close the editor for the rebase process to execute. The terminal output should say something like the following:
+
+    ```bash
+    Successfully rebased and updated refs/heads/mytopic.
+    ```
+
+5. Once you have a successful rebase, and before you sync your local clone, you have to force push origin to update your repo:
+
+    ```bash
+    git push -f origin
+    ```
+
+6. Continue on from step #7 from [Forking and Cloning from GitHub to GitHub](#forking-and-cloning-from-github-to-github)

LICENSE

@@ -1,339 +1,146 @@
-GNU GENERAL PUBLIC LICENSE
+Copyright (C) 2017 Pi-hole, LLC (https://pi-hole.net)
-                       Version 2, June 1991
+Pi-hole Core
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+This software is licensed under the European Union Public License (EUPL)
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+The license is available in the 22 official languages of the EU. The English version is included here.
- Everyone is permitted to copy and distribute verbatim copies
+Please see https://joinup.ec.europa.eu/community/eupl/og_page/eupl for official translations of the other languages.
- of this license document, but changing it is not allowed.
 
-                            Preamble
+This license applies to the whole project EXCEPT:
 
-  The licenses for most software are designed to take away your
+ - any commits made to the master branch prior to the release of version 3.0
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.)  You can apply it to
-your programs, too.
 
-  When we speak of free software, we are referring to freedom, not
+The licenses that existed prior to this change have remained intact.
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
 
-  To protect your rights, we need to make restrictions that forbid
+-------------------------------------------------------------
-anyone to deny you these rights or to ask you to surrender the rights.
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
 
-  For example, if you distribute copies of such a program, whether
+EUPL © the European Union 2007, 2016
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
 
-  We protect your rights with two steps: (1) copyright the software, and
+This European Union Public Licence (the EUPL) applies to the Work (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
-(2) offer you this license which gives you legal permission to copy,
+The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Work:
-distribute and/or modify the software.
+Licensed under the EUPL
+or has expressed by any other means his willingness to license under the EUPL.
 
-  Also, for each author's protection and ours, we want to make certain
+1. Definitions
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
 
-  Finally, any free program is threatened constantly by software
+In this Licence, the following terms have the following meaning:
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
 
-  The precise terms and conditions for copying, distribution and
+- The Licence: this Licence.
-modification follow.
+- The Original Work: the work or software distributed or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
+- Derivative Works: the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
+- The Work: the Original Work or its Derivative Works.
+- The Source Code: the human-readable form of the Work which is the most convenient for people to study and modify.
+- The Executable Code: any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
+- The Licensor: the natural or legal person that distributes or communicates the Work under the Licence.
+- Contributor(s): any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
+- The Licensee or You: any natural or legal person who makes any usage of the Work under the terms of the Licence.
+- Distribution or Communication: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
 
-                    GNU GENERAL PUBLIC LICENSE
+2. Scope of the rights granted by the Licence
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-  0. This License applies to any program or other work which contains
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
-a notice placed by the copyright holder saying it may be distributed
+- use the Work in any circumstance and for all usage,
-under the terms of this General Public License.  The "Program", below,
+- reproduce the Work,
-refers to any such program or work, and a "work based on the Program"
+- modify the Work, and make Derivative Works based upon the Work,
-means either the Program or any derivative work under copyright law:
+- communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
-that is to say, a work containing the Program or a portion of it,
+- distribute the Work or copies thereof,
-either verbatim or with modifications and/or translated into another
+- lend and rent the Work or copies thereof,
-language.  (Hereinafter, translation is included without limitation in
+- sublicense rights in the Work or copies thereof.
-the term "modification".)  Each licensee is addressed as "you".
+Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
+In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
 
-Activities other than copying, distribution and modification are not
+3. Communication of the Source Code
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
 
-  1. You may copy and distribute verbatim copies of the Program's
+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute or communicate the Work.
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
 
-You may charge a fee for the physical act of transferring a copy, and
+4. Limitations on copyright
-you may at your option offer warranty protection in exchange for a fee.
 
-  2. You may modify your copy or copies of the Program or any portion
+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations thereto.
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
 
-    a) You must cause the modified files to carry prominent notices
+5. Obligations of the Licensee
-    stating that you changed the files and the date of any change.
 
-    b) You must cause any work that you distribute or publish, that in
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
 
-    c) If the modified program normally reads commands interactively
+Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
 
-These requirements apply to the modified work as a whole.  If
+Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence - for example by communicating EUPL v. 1.2 only. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
 
-Thus, it is not the intent of this section to claim rights or contest
+Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, Compatible Licence refers to the licences listed in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
 
-In addition, mere aggregation of another work not based on the Program
+Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute or communicate the Work.
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
 
-  3. You may copy and distribute the Program (or a work based on it,
+Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the copyright notice.
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
 
-    a) Accompany it with the complete corresponding machine-readable
+6. Chain of Authorship
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
 
-    b) Accompany it with a written offer, valid for at least three
+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
 
-    c) Accompany it with the information you received as to the offer
+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
 
-The source code for a work means the preferred form of the work for
+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
 
-If distribution of executable or object code is made by offering
+7. Disclaimer of Warranty
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
 
-  4. You may not copy, modify, sublicense, or distribute the Program
+The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work and may therefore contain defects or bugs inherent to this type of development.
-except as expressly provided under this License.  Any attempt
+For the above reason, the Work is provided under the Licence on an as is basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
-otherwise to copy, modify, sublicense or distribute the Program is
+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
 
-  5. You are not required to accept this License, since you have not
+8. Disclaimer of Liability
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
 
-  6. Each time you redistribute the Program (or any work based on the
+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
 
-  7. If, as a consequence of a court judgment or allegation of patent
+9. Additional agreements
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
 
-If any portion of this section is held invalid or unenforceable under
+While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any warranty or additional liability.
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
 
-It is not the purpose of this section to induce you to infringe any
+10. Acceptance of the Licence
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
 
-This section is intended to make thoroughly clear what is believed to
+The provisions of this Licence can be accepted by clicking on an icon I agree placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
-be a consequence of the rest of this License.
+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution or Communication by You of the Work or copies thereof.
 
-  8. If the distribution and/or use of the Program is restricted in
+11. Information to the public
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
 
-  9. The Free Software Foundation may publish revised and/or new versions
+In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
-of the General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
 
-Each version is given a distinguishing version number.  If the Program
+12. Termination of the Licence
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
 
-  10. If you wish to incorporate parts of the Program into other free
+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
-programs whose distribution conditions are different, write to the author
+Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
 
-                            NO WARRANTY
+13. Miscellaneous
 
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid and enforceable.
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
 
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+14. Jurisdiction
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
 
-                     END OF TERMS AND CONDITIONS
+Without prejudice to specific agreement between parties,
+- any litigation resulting from the interpretation of this License, arising between the European Union institutions, bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
+- any litigation arising between other parties and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
 
-            How to Apply These Terms to Your New Programs
+15. Applicable Law
 
-  If you develop a new program, and you want it to be of the greatest
+Without prejudice to specific agreement between parties,
-possible use to the public, the best way to achieve this is to make it
+- this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, resides or has his registered office,
-free software which everyone can redistribute and change under these terms.
+- this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside a European Union Member State.
 
-  To do so, attach the following notices to the program.  It is safest
+===
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
 
-    {description}
+Appendix
-    Copyright (C) {year}  {fullname}
 
-    This program is free software; you can redistribute it and/or modify
+Compatible Licences according to Article 5 EUPL are:
-    it under the terms of the GNU General Public License as published by
+- GNU General Public License (GPL) v. 2, v. 3
-    the Free Software Foundation; either version 2 of the License, or
+- GNU Affero General Public License (AGPL) v. 3
-    (at your option) any later version.
+- Open Software License (OSL) v. 2.1, v. 3.0
-
+- Eclipse Public License (EPL) v. 1.0
-    This program is distributed in the hope that it will be useful,
+- CeCILL v. 2.0, v. 2.1
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
+- Mozilla Public Licence (MPL) v. 2
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
-    GNU General Public License for more details.
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
-
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
-    You should have received a copy of the GNU General Public License along
+- Québec Free and Open-Source Licence - Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
-    with this program; if not, write to the Free Software Foundation, Inc.,
+- The European Commission may update this Appendix to later versions of the above licences without producing a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the covered Source Code from exclusive appropriation.
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+-  All other changes or additions to this Appendix require the production of a new EUPL version.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  {signature of Ty Coon}, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.

README.md

@@ -1,161 +1,165 @@
+<!-- markdownlint-configure-file { "MD004": { "style": "consistent" } } -->
+<!-- markdownlint-disable MD033 -->
 <p align="center">
-<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
+    <a href="https://pi-hole.net/">
-<a href="https://www.codacy.com/app/Pi-hole/pi-hole?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pi-hole/pi-hole&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c558a0f8d7124c99b02b84f0f5564238"/></a>
+        <img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_Wordmark.svg" width="150" height="260" alt="Pi-hole">
-<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
+    </a>
+    <br>
+    <strong>Network-wide ad blocking via your own Linux hardware</strong>
 </p>
+<!-- markdownlint-enable MD033 -->
 
-<p align="center">
+#
-<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_text.png" width=210></a>
-</p>
 
-## The multi-platform, network-wide ad blocker
+The Pi-hole® is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content, without installing any client-side software.
 
-Block ads for **all** your devices _without_ the need to install client-side software.  The Pi-hole blocks ads the DNS-level, so all your devices are protected.
+- **Easy-to-install**: our versatile installer walks you through the process, and takes less than ten minutes
+- **Resolute**: content is blocked in _non-browser locations_, such as ad-laden mobile apps and smart TVs
+- **Responsive**: seamlessly speeds up the feel of everyday browsing by caching DNS queries
+- **Lightweight**: runs smoothly with [minimal hardware and software requirements](https://docs.pi-hole.net/main/prerequisites/)
+- **Robust**: a command line interface that is quality assured for interoperability
+- **Insightful**: a beautiful responsive Web Interface dashboard to view and control your Pi-hole
+- **Versatile**: can optionally function as a [DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026), ensuring *all* your devices are protected automatically
+- **Scalable**: [capable of handling hundreds of millions of queries](https://pi-hole.net/2017/05/24/how-much-traffic-can-pi-hole-handle/) when installed on server-grade hardware
+- **Modern**: blocks ads over both IPv4 and IPv6
+- **Free**: open source software which helps ensure _you_ are the sole person in control of your privacy
 
-- Web Browsers
+-----
-- Cell Phones
-- Smart TV's
-- Internet-connected home automation
-- Anything that communicates with the Internet
 
-<p align="center">
+Master [![Build Status](https://travis-ci.com/pi-hole/pi-hole.svg?branch=master)](https://travis-ci.com/pi-hole/pi-hole) Development [![Build Status](https://travis-ci.com/pi-hole/pi-hole.svg?branch=development)](https://travis-ci.com/pi-hole/pi-hole)
-<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
-</p>
 
-## Your Support Still Matters
+## One-Step Automated Install
 
-Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
+Those who want to get started quickly and conveniently may install Pi-hole using the following command:
-
--   ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
--   ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
-
-### One-Step Automated Install
-1.  Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
-2.  Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
 
 ### `curl -sSL https://install.pi-hole.net | bash`
 
-#### Alternative Semi-Automated Install Methods
+## Alternative Install Methods
-_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
 
-##### Clone our repository and run the automated installer from your device.
+Piping to `bash` is [controversial](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash), as it prevents you from [reading code that is about to run](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) on your system. Therefore, we provide these alternative installation methods which allow code review before installation:
 
-```
+### Method 1: Clone our repository and run
+
+```bash
 git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
-cd Pi-hole/automated_installer/
+cd "Pi-hole/automated install/"
-bash basic-install.sh
+sudo bash basic-install.sh
 ```
 
-##### Or
+### Method 2: Manually download the installer and run
 
 ```bash
 wget -O basic-install.sh https://install.pi-hole.net
-bash basic-install.sh
+sudo bash basic-install.sh
 ```
 
-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/).
+## [Post-install: Make your network take advantage of Pi-hole](https://docs.pi-hole.net/main/post-install/)
 
-## Installing the Pi-hole (Click to Watch!)
+Once the installer has been run, you will need to [configure your router to have **DHCP clients use Pi-hole 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) which ensures that all devices connecting to your network will have content blocked without any further intervention.
-<p align="center">
-<a href=https://www.youtube.com/watch?v=TzFLJqUeirA><img src="https://assets.pi-hole.net/static/global.png"></a>
-</p>
 
-## Would you like to know more?
+If your router does not support setting the DNS server, you can [use Pi-hole's built-in DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026); just be sure to disable DHCP on your router first (if it has that feature available).
 
-**Watch the 60-second video below to get a quick overview**
+As a last resort, you can always manually set each device to use Pi-hole as their DNS server.
-<p align="center">
-<a href=https://youtu.be/9Eti3xibiho><img src="https://assets.pi-hole.net/static/blackhole_web.png"></a>
-</p>
 
-## Get Help Or Connect With Us On The Web
+-----
 
--   [Users Forum](https://discourse.pi-hole.net/)
+## Pi-hole is free, but powered by your support
--   [FAQs](https://discourse.pi-hole.net/c/faqs)
--   [Wiki](https://github.com/pi-hole/pi-hole/wiki)
--   ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
--   ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
--   ![YouTube](https://assets.pi-hole.net/static/youtube.png)  [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
--   [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-## Technical Details
+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.
 
-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.
+Make no mistake: **your support is absolutely vital to help keep us innovating!**
 
-### Gravity
+### [Donations](https://pi-hole.net/donate)
 
-The [gravity.sh](https://github.com/pi-hole/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/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
+Sending a donation using our Sponsor Button is **extremely helpful** in offsetting a portion of our monthly expenses:
 
+### Alternative support
 
+If you'd rather not donate (_which is okay!_), there are other ways you can help support us:
 
-#### Other Operating Systems
+- [Patreon](https://patreon.com/pihole) _Become a patron for rewards_
+- [Digital Ocean](https://www.digitalocean.com/?refcode=344d234950e1) _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](http://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
+- Spreading the word about our software, and how you have benefited from it
 
-The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a Webserver, it should work OK. If there are other platforms you'd like supported, let us know.
+### Contributing via GitHub
 
-### Web Interface
+We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests.
 
-The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
+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.
 
-`http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
+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.
 
-![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard.png)
+-----
 
-### Whitelist and blacklist
+## Getting in touch with us
 
-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 
+While we are primarily reachable on our [Discourse User Forum](https://discourse.pi-hole.net/), 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.
-<p align="center">
-<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/controlpanel.png"></a>
-</p>
 
-## API
+- [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)
 
-A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
+-----
 
-``` json
+## Breakdown of Features
-{
-    "domains_being_blocked": "136708",
-    "dns_queries_today": "18108",
-    "ads_blocked_today": "14648",
-    "ads_percentage_today": "80.89"
-}
-```
 
-The same output can be achieved on the CLI by running `chronometer.sh -j`
+### The Command Line Interface
 
-## Real-time Statistics
+The [pihole](https://docs.pi-hole.net/core/pihole-command/) command has all the functionality necessary to be able to fully administer the Pi-hole, without the need of the Web Interface. It's fast, user-friendly, and auditable by anyone with an understanding of `bash`.
 
-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)
+![Pi-hole Blacklist Demo](https://pi-hole.github.io/graphics/Screenshots/blacklist-cli.gif)
 
-## Pi-hole Projects
+Some notable features include:
 
--   [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
+- [Whitelisting, Blacklisting and Regex](https://docs.pi-hole.net/core/pihole-command/#whitelisting-blacklisting-and-regex)
--   [Get LED alerts for each blocked ad](http://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
+- [Debugging utility](https://docs.pi-hole.net/core/pihole-command/#debugger)
--   [Pi-hole on Ubuntu 14.04 on VirtualBox](http://hbalagtas.blogspot.com/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
+- [Viewing the live log file](https://docs.pi-hole.net/core/pihole-command/#tail)
--   [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/)
+- [Updating Ad Lists](https://docs.pi-hole.net/core/pihole-command/#gravity)
--   [Splunk: Pi-hole Visualizser](https://splunkbase.splunk.com/app/3023/)
+- [Querying Ad Lists for blocked domains](https://docs.pi-hole.net/core/pihole-command/#query)
--   [Pi-hole Chrome extension](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([open source](https://github.com/packtloss/pihole-extension))
+- [Enabling and Disabling Pi-hole](https://docs.pi-hole.net/core/pihole-command/#enable-disable)
--   [Go Bananas for CHiP-hole ad blocking](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037)
+- ... and *many* more!
--   [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/)
--   [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
--   [Windows Tray Stat Application](https://github.com/goldbattle/copernicus)
--   [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
--   [Pi-Hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter) : a [Prometheus](https://prometheus.io/) exporter for Pi-Hole
 
-## Coverage
+You can read our [Core Feature Breakdown](https://docs.pi-hole.net/core/pihole-command/#pi-hole-core) for more information.
 
--   [Adafruit livestream install](https://www.youtube.com/watch?v=eg4u2j1HYlI)
+### The Web Interface Dashboard
--   [TekThing: 5 fun, easy projects for a Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s)
+
--   [Pi-hole on Adafruit's blog](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/)
+This [optional dashboard](https://github.com/pi-hole/AdminLTE) allows you to view stats, change settings, and configure your Pi-hole. It's the power of the Command Line Interface, with none of the learning curve!
--   [The Defrag Show - MSDN/Channel 9](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)
+
--   [MacObserver Podcast 585](http://www.macobserver.com/tmo/podcast/macgeekgab-585)
+![Pi-hole Dashboard](https://pi-hole.github.io/graphics/Screenshots/pihole-dashboard.png)
--   [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/)
+Some notable features include:
--   [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)
+- Mobile friendly interface
--   [Pi-hole on Security Now! Podcast](http://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s)
+- Password protection
--   [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
+- Detailed graphs and doughnut charts
--   [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
+- Top lists of domains and clients
--   [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
+- A filterable and sortable query log
--   [Build an Ad-Blocker for less than 10$ with Orange-Pi](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/)
+- Long Term Statistics to view data over user-defined time ranges
+- The ability to easily manage and configure Pi-hole features
+- ... and all the main features of the Command Line Interface!
+
+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://pi.hole/admin/` (when using Pi-hole as your DNS server)
+2. `http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/`
+3. `http://pi.hole/` (when using Pi-hole as your DNS server)
+
+## Faster-than-light Engine
+
+FTLDNS is a lightweight, purpose-built daemon used to provide statistics needed for the Web Interface, and its API can be easily integrated into your own projects. As the name implies, FTLDNS does this all *very quickly*!
+
+Some of the statistics you can integrate include:
+
+- Total number of domains being blocked
+- Total number of DNS queries today
+- Total number of ads blocked today
+- Percentage of ads blocked
+- Unique domains
+- Queries forwarded (to your chosen upstream DNS server)
+- Queries cached
+- Unique clients
+
+The API can be accessed via [`telnet`](https://github.com/pi-hole/FTL), the Web (`admin/api.php`) and Command Line (`pihole -c -j`). You can find out [more details over here](https://discourse.pi-hole.net/t/pi-hole-api/1863).

adlists.default

@@ -1,53 +0,0 @@
-## Pi-hole ad-list default sources. Updated 29/10/2016 #########################
-#                                                                              #
-#  To make changes to this file:                                               #
-#    1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list`          #
-#    2. run `nano /etc/pihole/adlists.list`                                    #
-#    3. Uncomment or comment any of the below lists                            #
-#                                                                              #
-#  Know of any other lists? Feel free to let us know about them, or add them   #
-#  to this file!                                                               #
-################################################################################
-
-# The below list amalgamates several lists we used previously.
-# See `https://github.com/StevenBlack/hosts` for details
-https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
-
-# Other lists we consider safe:
-http://mirror1.malwaredomains.com/files/justdomains
-http://sysctl.org/cameleon/hosts
-https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist
-https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt
-https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt
-
-# hosts-file.net list. Updated frequently, but has been known to block legitimate sites.
-https://hosts-file.net/ad_servers.txt
-
-# Mahakala list. Has been known to block legitimage domains including the entire .com range.
-# Warning: Due to the sheer size of this list, the web admin console will be unresponsive.
-#http://adblock.mahakala.is/
-
-# ADZHOSTS list. Has been known to block legitimate domains
-#http://pilotfiber.dl.sourceforge.net/project/adzhosts/HOSTS.txt
-
-# Windows 10 telemetry list
-#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt
-
-# Securemecca.com list - Also blocks "adult" sites (pornography/gambling etc)
-#http://securemecca.com/Downloads/hosts.txt
-
-# Quidsup's tracker list
-https://raw.githubusercontent.com/quidsup/notrack/master/trackers.txt
-
-# Block the BBC News website Breaking News banner
-#https://raw.githubusercontent.com/BreakingTheNews/BreakingTheNews.github.io/master/hosts
-
-# Untested Lists:
-#https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt
-#https://raw.githubusercontent.com/Dawsey21/Lists/master/main-blacklist.txt
-#http://malwaredomains.lehigh.edu/files/domains.txt
-# Following two lists should be used simultaneously: (readme https://github.com/notracking/hosts-blocklists/)
-#https://raw.github.com/notracking/hosts-blocklists/master/hostnames.txt
-#https://raw.github.com/notracking/hosts-blocklists/master/domains.txt
-# Combination of serveral host files on the internet (warning some facebook domains are also blocked but you can go to facebook.com). See https://github.com/mat1th/Dns-add-block for more information.
-#https://raw.githubusercontent.com/mat1th/Dns-add-block/master/hosts

advanced/01-pihole.conf

@@ -1,13 +1,11 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# dnsmasq config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Dnsmasq config for Pi-hole's FTLDNS
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
 
 ###############################################################################
 #      FILE AUTOMATICALLY POPULATED BY PI-HOLE INSTALL/UPDATE PROCEDURE.      #
@@ -16,15 +14,17 @@
 #        IF YOU WISH TO CHANGE THE UPSTREAM SERVERS, CHANGE THEM IN:          #
 #                      /etc/pihole/setupVars.conf                             #
 #                                                                             #
-#        ANY OTHER CHANGES SHOULD BE MADE IN A SEPERATE CONFIG FILE           #
+#        ANY OTHER CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE           #
-#                        OR IN /etc/dnsmasq.conf                              #
+#                    WITHIN /etc/dnsmasq.d/yourname.conf                      #
 ###############################################################################
 
-addn-hosts=/etc/pihole/gravity.list
 addn-hosts=/etc/pihole/local.list
+addn-hosts=/etc/pihole/custom.list
 
 domain-needed
 
+localise-queries
+
 bogus-priv
 
 no-resolv
@@ -34,11 +34,11 @@ server=@DNS2@
 
 interface=@INT@
 
-cache-size=10000
+cache-size=@CACHE_SIZE@
 
 log-queries
 log-facility=/var/log/pihole.log
 
-local-ttl=300
+local-ttl=2
 
 log-async

advanced/Scripts/COL_TABLE

@@ -0,0 +1,49 @@
+# Determine if terminal is capable of showing colors
+if [[ -t 1 ]] && [[ $(tput colors) -ge 8 ]]; then
+  # Bold and underline may not show up on all clients
+  # If something MUST be emphasized, use both
+  COL_BOLD=''
+  COL_ULINE=''
+
+  COL_NC=''
+  COL_GRAY=''
+  COL_RED=''
+  COL_GREEN=''
+  COL_YELLOW=''
+  COL_BLUE=''
+  COL_PURPLE=''
+  COL_CYAN=''
+else
+  # Provide empty variables for `set -u`
+  COL_BOLD=""
+  COL_ULINE=""
+
+  COL_NC=""
+  COL_GRAY=""
+  COL_RED=""
+  COL_GREEN=""
+  COL_YELLOW=""
+  COL_BLUE=""
+  COL_PURPLE=""
+  COL_CYAN=""
+fi
+
+# Deprecated variables
+COL_WHITE="${COL_BOLD}"
+COL_BLACK="${COL_NC}"
+COL_LIGHT_BLUE="${COL_BLUE}"
+COL_LIGHT_GREEN="${COL_GREEN}"
+COL_LIGHT_CYAN="${COL_CYAN}"
+COL_LIGHT_RED="${COL_RED}"
+COL_URG_RED="${COL_RED}${COL_BOLD}${COL_ULINE}"
+COL_LIGHT_PURPLE="${COL_PURPLE}"
+COL_BROWN="${COL_YELLOW}"
+COL_LIGHT_GRAY="${COL_GRAY}"
+COL_DARK_GRAY="${COL_GRAY}"
+
+TICK="[${COL_GREEN}✓${COL_NC}]"
+CROSS="[${COL_RED}✗${COL_NC}]"
+INFO="[i]"
+QST="[?]"
+DONE="${COL_GREEN} done!${COL_NC}"
+OVER="\\r"

advanced/Scripts/chronometer.sh

@@ -1,137 +1,579 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC1090,SC1091
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Calculates stats and displays to an LCD
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+LC_ALL=C
-# (at your option) any later version.
+LC_NUMERIC=C
 
+# Retrieve stats from FTL engine
+pihole-FTL() {
+    local ftl_port LINE
+    ftl_port=$(cat /run/pihole-FTL.port 2> /dev/null)
+    if [[ -n "$ftl_port" ]]; then
+        # Open connection to FTL
+        exec 3<>"/dev/tcp/127.0.0.1/$ftl_port"
 
-#Functions##############################################################################################################
+        # Test if connection is open
-piLog="/var/log/pihole.log"
+        if { "true" >&3; } 2> /dev/null; then
-gravity="/etc/pihole/gravity.list"
+            # Send command to FTL and ask to quit when finished
+            echo -e ">$1 >quit" >&3
 
-today=$(date "+%b %e")
+            # Read input until we received an empty string and the connection is
+            # closed
+            read -r -t 1 LINE <&3
+            until [[ -z "${LINE}" ]] && [[ ! -t 3 ]]; do
+                echo "$LINE" >&1
+                read -r -t 1 LINE <&3
+            done
 
-. /etc/pihole/setupVars.conf
+            # Close connection
-
+            exec 3>&-
-CalcBlockedDomains() {
+            exec 3<&-
-	if [ -e "${gravity}" ]; then
+        fi
-		# if BOTH IPV4 and IPV6 are in use, then we need to divide total domains by 2.
+    else
-		if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]]; then
+        echo "0"
-			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}')
+    fi
-		else
-			# only one is set.
-			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1}')
-		fi
-	else
-		blockedDomainsTotal="Err."
-	fi
 }
 
-CalcQueriesToday() {
+# Print spaces to align right-side additional text
-	if [ -e "${piLog}" ]; then
+printFunc() {
-		queriesToday=$(cat "${piLog}" | grep "${today}" | awk '/query/ {print $6}' | wc -l)
+    local text_last
-	else
+
-		queriesToday="Err."
+    title="$1"
-	fi
+    title_len="${#title}"
+
+    text_main="$2"
+    text_main_nocol="$text_main"
+    if [[ "${text_main:0:1}" == "" ]]; then
+        text_main_nocol=$(sed 's/\[[0-9;]\{1,5\}m//g' <<< "$text_main")
+    fi
+    text_main_len="${#text_main_nocol}"
+
+    text_addn="$3"
+    if [[ "$text_addn" == "last" ]]; then
+        text_addn=""
+        text_last="true"
+    fi
+
+    # If there is additional text, define max length of text_main
+    if [[ -n "$text_addn" ]]; then
+        case "$scr_cols" in
+            [0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-4]) text_main_max_len="9";;
+            4[5-9]) text_main_max_len="14";;
+            *) text_main_max_len="19";;
+        esac
+    fi
+
+    [[ -z "$text_addn" ]] && text_main_max_len="$(( scr_cols - title_len ))"
+
+    # Remove excess characters from main text
+    if [[ "$text_main_len" -gt "$text_main_max_len" ]]; then
+        # Trim text without colors
+        text_main_trim="${text_main_nocol:0:$text_main_max_len}"
+        # Replace with trimmed text
+        text_main="${text_main/$text_main_nocol/$text_main_trim}"
+    fi
+
+    # Determine amount of spaces for each line
+    if [[ -n "$text_last" ]]; then
+        # Move cursor to end of screen
+        spc_num=$(( scr_cols - ( title_len + text_main_len ) ))
+    else
+        spc_num=$(( text_main_max_len - text_main_len ))
+    fi
+
+    [[ "$spc_num" -le 0 ]] && spc_num="0"
+    spc=$(printf "%${spc_num}s")
+    #spc="${spc// /.}" # Debug: Visualize spaces
+
+    printf "%s%s$spc" "$title" "$text_main"
+
+    if [[ -n "$text_addn" ]]; then
+        printf "%s(%s)%s\\n" "$COL_NC$COL_DARK_GRAY" "$text_addn" "$COL_NC"
+    else
+        # Do not print trailing newline on final line
+        [[ -z "$text_last" ]] && printf "%s\\n" "$COL_NC"
+    fi
 }
 
-CalcblockedToday() {
+# Perform on first Chrono run (not for JSON formatted string)
-	if [ -e "${piLog}" ] && [ -e "${gravity}" ];then
+get_init_stats() {
-		blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l)
+    calcFunc(){ awk "BEGIN {print $*}" 2> /dev/null; }
-	else
+
-		blockedToday="Err."
+    # Convert bytes to human-readable format
-	fi
+    hrBytes() {
+        awk '{
+            num=$1;
+            if(num==0) {
+                print "0 B"
+            } else {
+                xxx=(num<0?-num:num)
+                sss=(num<0?-1:1)
+                split("B KB MB GB TB PB",type)
+                for(i=5;yyy < 1;i--) {
+                    yyy=xxx / (2^(10*i))
+                }
+            printf "%.0f " type[i+2], yyy*sss
+            }
+        }' <<< "$1";
+    }
+
+    # Convert seconds to human-readable format
+    hrSecs() {
+        day=$(( $1/60/60/24 )); hrs=$(( $1/3600%24 ))
+        mins=$(( ($1%3600)/60 )); secs=$(( $1%60 ))
+        [[ "$day" -ge "2" ]] && plu="s"
+        [[ "$day" -ge "1" ]] && days="$day day${plu}, " || days=""
+        printf "%s%02d:%02d:%02d\\n" "$days" "$hrs" "$mins" "$secs"
+    }
+
+    # Set Color Codes
+    coltable="/opt/pihole/COL_TABLE"
+    if [[ -f "${coltable}" ]]; then
+        source ${coltable}
+    else
+        COL_NC=""
+        COL_DARK_GRAY=""
+        COL_LIGHT_GREEN=""
+        COL_LIGHT_BLUE=""
+        COL_LIGHT_RED=""
+        COL_YELLOW=""
+        COL_LIGHT_RED=""
+        COL_URG_RED=""
+    fi
+
+    # Get RPi throttle state (RPi 3B only) & model number, or OS distro info
+    if command -v vcgencmd &> /dev/null; then
+        local sys_throttle_raw
+        local sys_rev_raw
+
+        sys_throttle_raw=$(vgt=$(sudo vcgencmd get_throttled); echo "${vgt##*x}")
+
+        # Active Throttle Notice: https://bit.ly/2gnunOo
+        if [[ "$sys_throttle_raw" != "0" ]]; then
+            case "$sys_throttle_raw" in
+                *0001) thr_type="${COL_YELLOW}Under Voltage";;
+                *0002) thr_type="${COL_LIGHT_BLUE}Arm Freq Cap";;
+                *0003) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC";;
+                *0004) thr_type="${COL_LIGHT_RED}Throttled";;
+                *0005) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+                *0006) thr_type="${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+                *0007) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+            esac
+        [[ -n "$thr_type" ]] && sys_throttle="$thr_type${COL_DARK_GRAY}"
+        fi
+
+        sys_rev_raw=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
+        case "$sys_rev_raw" in
+            000[2-6]) sys_model=" 1, Model B";; # 256MB
+            000[7-9]) sys_model=" 1, Model A";; # 256MB
+            000d|000e|000f) sys_model=" 1, Model B";; # 512MB
+            0010|0013) sys_model=" 1, Model B+";; # 512MB
+            0012|0015) sys_model=" 1, Model A+";; # 256MB
+            a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
+            900021) sys_model=" 1, Model A+";; # 512MB
+            900032) sys_model=" 1, Model B+";; # 512MB
+            90009[2-3]|920093) sys_model=" Zero";; # 512MB
+            9000c1) sys_model=" Zero W";; # 512MB
+            a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
+            a020d3) sys_model=" 3, Model B+";; # 1GB
+            *) sys_model="";;
+        esac
+        sys_type="Raspberry Pi$sys_model"
+    else
+        source "/etc/os-release"
+        CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
+        sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
+    fi
+
+    # Get core count
+    sys_cores=$(grep -c "^processor" /proc/cpuinfo)
+
+    # Test existence of clock speed file for ARM CPU
+    if [[ -f "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" ]]; then
+        scaling_freq_file="/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq"
+    fi
+
+    # Test existence of temperature file
+    if [[ -f "/sys/class/thermal/thermal_zone0/temp" ]]; then
+        temp_file="/sys/class/thermal/thermal_zone0/temp"
+    elif [[ -f "/sys/class/hwmon/hwmon0/temp1_input" ]]; then
+        temp_file="/sys/class/hwmon/hwmon0/temp1_input"
+    else
+        temp_file=""
+    fi
+
+    # Test existence of setupVars config
+    if [[ -f "/etc/pihole/setupVars.conf" ]]; then
+        setupVars="/etc/pihole/setupVars.conf"
+    fi
 }
 
-CalcPercentBlockedToday() {
+get_sys_stats() {
-	if [ "${queriesToday}" != "Err." ] && [ "${blockedToday}" != "Err." ]; then
+    local ph_ver_raw
-		if [ "${queriesToday}" != 0 ]; then #Fixes divide by zero error :)
+    local cpu_raw
-			#scale 2 rounds the number down, so we'll do scale 4 and then trim the last 2 zeros
+    local ram_raw
-			percentBlockedToday=$(echo "scale=4; ${blockedToday}/${queriesToday}*100" | bc)
+    local disk_raw
-			percentBlockedToday=$(sed 's/.\{2\}$//' <<< "${percentBlockedToday}")
+
-		else
+    # Update every 12 refreshes (Def: every 60s)
-			percentBlockedToday=0
+    count=$((count+1))
-		fi
+    if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
-	fi
+        # Do not source setupVars if file does not exist
+        [[ -n "$setupVars" ]] && source "$setupVars"
+
+        mapfile -t ph_ver_raw < <(pihole -v -c 2> /dev/null | sed -n 's/^.* v/v/p')
+        if [[ -n "${ph_ver_raw[0]}" ]]; then
+            ph_core_ver="${ph_ver_raw[0]}"
+            if [[ ${#ph_ver_raw[@]} -eq 2 ]]; then
+                # AdminLTE not installed
+                ph_lte_ver="(not installed)"
+                ph_ftl_ver="${ph_ver_raw[1]}"
+            else
+                ph_lte_ver="${ph_ver_raw[1]}"
+                ph_ftl_ver="${ph_ver_raw[2]}"
+            fi
+        else
+            ph_core_ver="-1"
+        fi
+
+        sys_name=$(hostname)
+
+        [[ -n "$TEMPERATUREUNIT" ]] && temp_unit="${TEMPERATUREUNIT^^}" || temp_unit="C"
+
+        # Get storage stats for partition mounted on /
+        read -r -a disk_raw <<< "$(df -B1 / 2> /dev/null | awk 'END{ print $3,$2,$5 }')"
+        disk_used="${disk_raw[0]}"
+        disk_total="${disk_raw[1]}"
+        disk_perc="${disk_raw[2]}"
+
+        net_gateway=$(ip route | grep default | cut -d ' ' -f 3 | head -n 1)
+
+        # Get DHCP stats, if feature is enabled
+        if [[ "$DHCP_ACTIVE" == "true" ]]; then
+            ph_dhcp_max=$(( ${DHCP_END##*.} - ${DHCP_START##*.} + 1 ))
+        fi
+
+        # Get DNS server count
+        dns_count="0"
+        [[ -n "${PIHOLE_DNS_1}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_2}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_3}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_4}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_5}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_6}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_7}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_8}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_9}" ]] && dns_count="$dns_count+"
+    fi
+
+    # Get screen size
+    read -r -a scr_size <<< "$(stty size 2>/dev/null || echo 24 80)"
+    scr_lines="${scr_size[0]}"
+    scr_cols="${scr_size[1]}"
+
+    # Determine Chronometer size behavior
+    if [[ "$scr_cols" -ge 58 ]]; then
+        chrono_width="large"
+    elif [[ "$scr_cols" -gt 40 ]]; then
+        chrono_width="medium"
+    else
+        chrono_width="small"
+    fi
+
+    # Determine max length of divider string
+    scr_line_len=$(( scr_cols - 2 ))
+    [[ "$scr_line_len" -ge 58 ]] && scr_line_len="58"
+    scr_line_str=$(printf "%${scr_line_len}s")
+    scr_line_str="${scr_line_str// /—}"
+
+    sys_uptime=$(hrSecs "$(cut -d. -f1 /proc/uptime)")
+    sys_loadavg=$(cut -d " " -f1,2,3 /proc/loadavg)
+
+    # Get CPU usage, only counting processes over 1% as active
+    # shellcheck disable=SC2009
+    cpu_raw=$(ps -eo pcpu,rss --no-headers | grep -E -v "    0")
+    cpu_tasks=$(wc -l <<< "$cpu_raw")
+    cpu_taskact=$(sed -r "/(^ 0.)/d" <<< "$cpu_raw" | wc -l)
+    cpu_perc=$(awk '{sum+=$1} END {printf "%.0f\n", sum/'"$sys_cores"'}' <<< "$cpu_raw")
+
+    # Get CPU clock speed
+    if [[ -n "$scaling_freq_file" ]]; then
+        cpu_mhz=$(( $(< /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq) / 1000 ))
+    else
+        cpu_mhz=$(lscpu | awk -F ":" '/MHz/ {print $2;exit}')
+        cpu_mhz=$(printf "%.0f" "${cpu_mhz//[[:space:]]/}")
+    fi
+
+    # Determine whether to display CPU clock speed as MHz or GHz
+    if [[ -n "$cpu_mhz" ]]; then
+        [[ "$cpu_mhz" -le "999" ]] && cpu_freq="$cpu_mhz MHz" || cpu_freq="$(printf "%.1f" $(calcFunc "$cpu_mhz"/1000)) GHz"
+        [[ "${cpu_freq}" == *".0"* ]] && cpu_freq="${cpu_freq/.0/}"
+    fi
+
+    # Determine color for temperature
+    if [[ -n "$temp_file" ]]; then
+        if [[ "$temp_unit" == "C" ]]; then
+            cpu_temp=$(printf "%.0fc\\n" "$(calcFunc "$(< $temp_file) / 1000")")
+
+            case "${cpu_temp::-1}" in
+                -*|[0-9]|[1-3][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+                4[0-9]) cpu_col="";;
+                5[0-9]) cpu_col="$COL_YELLOW";;
+                6[0-9]) cpu_col="$COL_LIGHT_RED";;
+                *) cpu_col="$COL_URG_RED";;
+            esac
+
+        # $COL_NC$COL_DARK_GRAY is needed for $COL_URG_RED
+        cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+
+        elif [[ "$temp_unit" == "F" ]]; then
+            cpu_temp=$(printf "%.0ff\\n" "$(calcFunc "($(< $temp_file) / 1000) * 9 / 5 + 32")")
+
+            case "${cpu_temp::-1}" in
+                -*|[0-9]|[0-9][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+                1[0-1][0-9]) cpu_col="";;
+                1[2-3][0-9]) cpu_col="$COL_YELLOW";;
+                1[4-5][0-9]) cpu_col="$COL_LIGHT_RED";;
+                *) cpu_col="$COL_URG_RED";;
+            esac
+
+            cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+
+        else
+            cpu_temp_str=$(printf " @ %.0fk\\n" "$(calcFunc "($(< $temp_file) / 1000) + 273.15")")
+        fi
+    else
+        cpu_temp_str=""
+    fi
+
+    read -r -a ram_raw <<< "$(awk '/MemTotal:/{total=$2} /MemFree:/{free=$2} /Buffers:/{buffers=$2} /^Cached:/{cached=$2} END {printf "%.0f %.0f %.0f", (total-free-buffers-cached)*100/total, (total-free-buffers-cached)*1024, total*1024}' /proc/meminfo)"
+    ram_perc="${ram_raw[0]}"
+    ram_used="${ram_raw[1]}"
+    ram_total="${ram_raw[2]}"
+
+    if [[ "$(pihole status web 2> /dev/null)" == "1" ]]; then
+        ph_status="${COL_LIGHT_GREEN}Active"
+    else
+        ph_status="${COL_LIGHT_RED}Offline"
+    fi
+
+    if [[ "$DHCP_ACTIVE" == "true" ]]; then
+        local ph_dhcp_range
+
+        ph_dhcp_range=$(seq -s "|" -f "${DHCP_START%.*}.%g" "${DHCP_START##*.}" "${DHCP_END##*.}")
+
+        # Count dynamic leases from available range, and not static leases
+        ph_dhcp_num=$(grep -cE "$ph_dhcp_range" "/etc/pihole/dhcp.leases")
+        ph_dhcp_percent=$(( ph_dhcp_num * 100 / ph_dhcp_max ))
+    fi
 }
 
-outputJSON() {
+get_ftl_stats() {
-	CalcQueriesToday
+    local stats_raw
-	CalcblockedToday
-	CalcPercentBlockedToday
 
-	CalcBlockedDomains
+    mapfile -t stats_raw < <(pihole-FTL "stats")
+    domains_being_blocked_raw="${stats_raw[0]#* }"
+    dns_queries_today_raw="${stats_raw[1]#* }"
+    ads_blocked_today_raw="${stats_raw[2]#* }"
+    ads_percentage_today_raw="${stats_raw[3]#* }"
+    queries_forwarded_raw="${stats_raw[5]#* }"
+    queries_cached_raw="${stats_raw[6]#* }"
 
-	printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday"
+    # Only retrieve these stats when not called from jsonFunc
+    if [[ -z "$1" ]]; then
+        local top_ad_raw
+        local top_domain_raw
+        local top_client_raw
+
+        domains_being_blocked=$(printf "%.0f\\n" "${domains_being_blocked_raw}" 2> /dev/null)
+        dns_queries_today=$(printf "%.0f\\n" "${dns_queries_today_raw}")
+        ads_blocked_today=$(printf "%.0f\\n" "${ads_blocked_today_raw}")
+        ads_percentage_today=$(printf "%'.0f\\n" "${ads_percentage_today_raw}")
+        queries_cached_percentage=$(printf "%.0f\\n" "$(calcFunc "$queries_cached_raw * 100 / ( $queries_forwarded_raw + $queries_cached_raw )")")
+        recent_blocked=$(pihole-FTL recentBlocked)
+        read -r -a top_ad_raw <<< "$(pihole-FTL "top-ads (1)")"
+        read -r -a top_domain_raw <<< "$(pihole-FTL "top-domains (1)")"
+        read -r -a top_client_raw <<< "$(pihole-FTL "top-clients (1)")"
+
+        top_ad="${top_ad_raw[2]}"
+        top_domain="${top_domain_raw[2]}"
+        if [[ "${top_client_raw[3]}" ]]; then
+            top_client="${top_client_raw[3]}"
+        else
+            top_client="${top_client_raw[2]}"
+        fi
+    fi
 }
 
-normalChrono() {
+get_strings() {
-	for (( ; ; )); do
+    # Expand or contract strings depending on screen size
-		clear
+    if [[ "$chrono_width" == "large" ]]; then
-		# Displays a colorful Pi-hole logo
+        phc_str="        ${COL_DARK_GRAY}Core"
-		echo " ___ _     _        _"
+        lte_str="        ${COL_DARK_GRAY}Web"
-		echo "| _ (_)___| |_  ___| |___"
+        ftl_str="        ${COL_DARK_GRAY}FTL"
-		echo "|  _/ |___| ' \/ _ \ / -_)"
+        api_str="${COL_LIGHT_RED}API Offline"
-		echo "|_| |_|   |_||_\___/_\___|"
-		echo ""
-		echo "        ${IPV4_ADDRESS}"
-		echo ""
-		uptime | cut -d' ' -f11-
-		#uptime -p	#Doesn't work on all versions of uptime
-		uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/) {d=$6;h=$8;m=$9} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes."}'
-		echo "-------------------------------"
-		# Uncomment to continually read the log file and display the current domain being blocked
-		#tail -f /var/log/pihole.log | awk '/\/etc\/pihole\/gravity.list/ {if ($7 != "address" && $7 != "name" && $7 != "/etc/pihole/gravity.list") print $7; else;}'
 
-		#uncomment next 4 lines to use original query count calculation
+        host_info="$sys_type"
-		#today=$(date "+%b %e")
+        sys_info="$sys_throttle"
-		#todaysQueryCount=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ {print $7}' | wc -l)
+        sys_info2="Active: $cpu_taskact of $cpu_tasks tasks"
-		#todaysQueryCountV4=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[A\]/ {print $7}' | wc -l)
+        used_str="Used: "
-		#todaysQueryCountV6=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[AAAA\]/ {print $7}' | wc -l)
+        leased_str="Leased: "
+        domains_being_blocked=$(printf "%'.0f" "$domains_being_blocked")
+        ads_blocked_today=$(printf "%'.0f" "$ads_blocked_today")
+        dns_queries_today=$(printf "%'.0f" "$dns_queries_today")
+        ph_info="Blocking: $domains_being_blocked sites"
+        total_str="Total: "
+    else
+        phc_str=" ${COL_DARK_GRAY}Core"
+        lte_str=" ${COL_DARK_GRAY}Web"
+        ftl_str=" ${COL_DARK_GRAY}FTL"
+        api_str="${COL_LIGHT_RED}API Down"
+        ph_info="$domains_being_blocked blocked"
+    fi
 
+    [[ "$sys_cores" -ne 1 ]] && sys_cores_txt="${sys_cores}x "
+    cpu_info="$sys_cores_txt$cpu_freq$cpu_temp_str"
+    ram_info="$used_str$(hrBytes "$ram_used") of $(hrBytes "$ram_total")"
+    disk_info="$used_str$(hrBytes "$disk_used") of $(hrBytes "$disk_total")"
 
-		CalcQueriesToday
+    lan_info="Gateway: $net_gateway"
-		CalcblockedToday
+    dhcp_info="$leased_str$ph_dhcp_num of $ph_dhcp_max"
-		CalcPercentBlockedToday
 
-		CalcBlockedDomains
+      ads_info="$total_str$ads_blocked_today of $dns_queries_today"
+    dns_info="$dns_count DNS servers"
 
-		echo "Blocking:      ${blockedDomainsTotal}"
+    [[ "$recent_blocked" == "0" ]] && recent_blocked="${COL_LIGHT_RED}FTL offline${COL_NC}"
-		echo "Queries:       ${queriesToday}" #same total calculation as dashboard
-	  echo "Pi-holed:      ${blockedToday} (${percentBlockedToday}%)"
-
-		sleep 5
-	done
 }
 
-displayHelp() {
+chronoFunc() {
-	cat << EOM
+    local extra_arg="$1"
-::: Displays stats about your piHole!
+    local extra_value="$2"
-:::
+
-::: Usage: sudo pihole -c [optional:-j]
+    get_init_stats
-::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
+
-:::
+    for (( ; ; )); do
-::: Options:
+        get_sys_stats
-:::  -j, --json		output stats as JSON formatted string
+        get_ftl_stats
-:::  -h, --help		display this help text
+        get_strings
-EOM
+
-    exit 0
+        # Strip excess development version numbers
+        if [[ "$ph_core_ver" != "-1" ]]; then
+            phc_ver_str="$phc_str: ${ph_core_ver%-*}${COL_NC}"
+            lte_ver_str="$lte_str: ${ph_lte_ver%-*}${COL_NC}"
+            ftl_ver_str="$ftl_str: ${ph_ftl_ver%-*}${COL_NC}"
+        else
+            phc_ver_str="$phc_str: $api_str${COL_NC}"
+        fi
+
+        # Get refresh number
+        if [[ "${extra_arg}" = "refresh" ]]; then
+            num="${extra_value}"
+            num_str="Refresh set for every $num seconds"
+        else
+            num_str=""
+        fi
+
+        clear
+
+        # Remove exit message heading on third refresh
+        if [[ "$count" -le 2 ]] && [[ "${extra_arg}" != "exit" ]]; then
+            echo -e " ${COL_LIGHT_GREEN}Pi-hole Chronometer${COL_NC}
+            $num_str
+            ${COL_LIGHT_RED}Press Ctrl-C to exit${COL_NC}
+            ${COL_DARK_GRAY}$scr_line_str${COL_NC}"
+        else
+        echo -e "|¯¯¯(¯)_|¯|_  ___|¯|___$phc_ver_str\\n| ¯_/¯|_| ' \\/ _ \\ / -_)$lte_ver_str\\n|_| |_| |_||_\\___/_\\___|$ftl_ver_str\\n ${COL_DARK_GRAY}$scr_line_str${COL_NC}"
+        fi
+
+        printFunc "  Hostname: " "$sys_name" "$host_info"
+        printFunc "    Uptime: " "$sys_uptime" "$sys_info"
+        printFunc " Task Load: " "$sys_loadavg" "$sys_info2"
+        printFunc " CPU usage: " "$cpu_perc%" "$cpu_info"
+        printFunc " RAM usage: " "$ram_perc%" "$ram_info"
+        printFunc " HDD usage: " "$disk_perc" "$disk_info"
+
+        if [[ "$scr_lines" -gt 17 ]] && [[ "$chrono_width" != "small" ]]; then
+            printFunc "  LAN addr: " "${IPV4_ADDRESS/\/*/}" "$lan_info"
+        fi
+
+        if [[ "$DHCP_ACTIVE" == "true" ]]; then
+            printFunc "DHCP usage: " "$ph_dhcp_percent%" "$dhcp_info"
+        fi
+
+        printFunc "   Pi-hole: " "$ph_status" "$ph_info"
+        printFunc " Ads Today: " "$ads_percentage_today%" "$ads_info"
+        printFunc "Local Qrys: " "$queries_cached_percentage%" "$dns_info"
+
+        printFunc "   Blocked: " "$recent_blocked"
+        printFunc "Top Advert: " "$top_ad"
+
+        # Provide more stats on screens with more lines
+        if [[ "$scr_lines" -eq 17 ]]; then
+            if [[ "$DHCP_ACTIVE" == "true" ]]; then
+                printFunc "Top Domain: " "$top_domain" "last"
+            else
+                print_client="true"
+            fi
+        else
+            print_client="true"
+        fi
+
+        if [[ -n "$print_client" ]]; then
+            printFunc "Top Domain: " "$top_domain"
+            printFunc "Top Client: " "$top_client" "last"
+        fi
+
+        # Handle exit/refresh options
+        if [[ "${extra_arg}" == "exit" ]]; then
+            exit 0
+        else
+            if [[ "${extra_arg}" == "refresh" ]]; then
+                sleep "$num"
+            else
+                sleep 5
+            fi
+        fi
+
+    done
+}
+
+jsonFunc() {
+    get_ftl_stats "json"
+    echo "{\"domains_being_blocked\":${domains_being_blocked_raw},\"dns_queries_today\":${dns_queries_today_raw},\"ads_blocked_today\":${ads_blocked_today_raw},\"ads_percentage_today\":${ads_percentage_today_raw}}"
+}
+
+helpFunc() {
+    if [[ "$1" == "?" ]]; then
+        echo "Unknown option. Please view 'pihole -c --help' for more information"
+    else
+        echo "Usage: pihole -c [options]
+Example: 'pihole -c -j'
+Calculates stats and displays to an LCD
+
+Options:
+  -j, --json          Output stats as JSON formatted string
+  -r, --refresh       Set update frequency (in seconds)
+  -e, --exit          Output stats and exit witout refreshing
+  -h, --help          Display this help text"
+  fi
+
+  exit 0
 }
 
 if [[ $# = 0 ]]; then
-	normalChrono
+    chronoFunc
 fi
 
-for var in "$@"; do
+case "$1" in
-	case "$var" in
+    "-j" | "--json"    ) jsonFunc;;
-		"-j" | "--json"  ) outputJSON;;
+    "-h" | "--help"    ) helpFunc;;
-		"-h" | "--help"  ) displayHelp;;
+    "-r" | "--refresh" ) chronoFunc refresh "$2";;
-		*                ) exit 1;;
+    "-e" | "--exit"    ) chronoFunc exit;;
-	esac
+    *                  ) helpFunc "?";;
-done
+esac

advanced/Scripts/database_migration/gravity-db.sh

@@ -0,0 +1,119 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2019 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Updates gravity.db database
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+readonly scriptPath="/etc/.pihole/advanced/Scripts/database_migration/gravity"
+
+upgrade_gravityDB(){
+	local database piholeDir auditFile version
+	database="${1}"
+	piholeDir="${2}"
+	auditFile="${piholeDir}/auditlog.list"
+
+	# Get database version
+	version="$(sqlite3 "${database}" "SELECT \"value\" FROM \"info\" WHERE \"property\" = 'version';")"
+
+	if [[ "$version" == "1" ]]; then
+		# This migration script upgrades the gravity.db file by
+		# adding the domain_audit table
+		echo -e "  ${INFO} Upgrading gravity database from version 1 to 2"
+		sqlite3 "${database}" < "${scriptPath}/1_to_2.sql"
+		version=2
+
+		# Store audit domains in database table
+		if [ -e "${auditFile}" ]; then
+			echo -e "  ${INFO} Migrating content of ${auditFile} into new database"
+			# database_table_from_file is defined in gravity.sh
+			database_table_from_file "domain_audit" "${auditFile}"
+		fi
+	fi
+	if [[ "$version" == "2" ]]; then
+		# This migration script upgrades the gravity.db file by
+		# renaming the regex table to regex_blacklist, and
+		# creating a new regex_whitelist table + corresponding linking table and views
+		echo -e "  ${INFO} Upgrading gravity database from version 2 to 3"
+		sqlite3 "${database}" < "${scriptPath}/2_to_3.sql"
+		version=3
+	fi
+	if [[ "$version" == "3" ]]; then
+		# This migration script unifies the formally separated domain
+		# lists into a single table with a UNIQUE domain constraint
+		echo -e "  ${INFO} Upgrading gravity database from version 3 to 4"
+		sqlite3 "${database}" < "${scriptPath}/3_to_4.sql"
+		version=4
+	fi
+	if [[ "$version" == "4" ]]; then
+		# This migration script upgrades the gravity and list views
+		# implementing necessary changes for per-client blocking
+		echo -e "  ${INFO} Upgrading gravity database from version 4 to 5"
+		sqlite3 "${database}" < "${scriptPath}/4_to_5.sql"
+		version=5
+	fi
+	if [[ "$version" == "5" ]]; then
+		# This migration script upgrades the adlist view
+		# to return an ID used in gravity.sh
+		echo -e "  ${INFO} Upgrading gravity database from version 5 to 6"
+		sqlite3 "${database}" < "${scriptPath}/5_to_6.sql"
+		version=6
+	fi
+	if [[ "$version" == "6" ]]; then
+		# This migration script adds a special group with ID 0
+		# which is automatically associated to all clients not
+		# having their own group assignments
+		echo -e "  ${INFO} Upgrading gravity database from version 6 to 7"
+		sqlite3 "${database}" < "${scriptPath}/6_to_7.sql"
+		version=7
+	fi
+	if [[ "$version" == "7" ]]; then
+		# This migration script recreated the group table
+		# to ensure uniqueness on the group name
+		# We also add date_added and date_modified columns
+		echo -e "  ${INFO} Upgrading gravity database from version 7 to 8"
+		sqlite3 "${database}" < "${scriptPath}/7_to_8.sql"
+		version=8
+	fi
+	if [[ "$version" == "8" ]]; then
+		# This migration fixes some issues that were introduced
+		# in the previous migration script.
+		echo -e "  ${INFO} Upgrading gravity database from version 8 to 9"
+		sqlite3 "${database}" < "${scriptPath}/8_to_9.sql"
+		version=9
+	fi
+	if [[ "$version" == "9" ]]; then
+		# This migration drops unused tables and creates triggers to remove
+		# obsolete groups assignments when the linked items are deleted
+		echo -e "  ${INFO} Upgrading gravity database from version 9 to 10"
+		sqlite3 "${database}" < "${scriptPath}/9_to_10.sql"
+		version=10
+	fi
+	if [[ "$version" == "10" ]]; then
+		# This adds timestamp and an optional comment field to the client table
+		# These fields are only temporary and will be replaces by the columns
+		# defined in gravity.db.sql during gravity swapping. We add them here
+		# to keep the copying process generic (needs the same columns in both the
+		# source and the destination databases).
+		echo -e "  ${INFO} Upgrading gravity database from version 10 to 11"
+		sqlite3 "${database}" < "${scriptPath}/10_to_11.sql"
+		version=11
+	fi
+	if [[ "$version" == "11" ]]; then
+		# Rename group 0 from "Unassociated" to "Default"
+		echo -e "  ${INFO} Upgrading gravity database from version 11 to 12"
+		sqlite3 "${database}" < "${scriptPath}/11_to_12.sql"
+		version=12
+	fi
+	if [[ "$version" == "12" ]]; then
+		# Add column date_updated to alist table
+		echo -e "  ${INFO} Upgrading gravity database from version 12 to 13"
+		sqlite3 "${database}" < "${scriptPath}/12_to_13.sql"
+		version=13
+	fi
+}

advanced/Scripts/database_migration/gravity/10_to_11.sql

@@ -0,0 +1,16 @@
+.timeout 30000
+
+BEGIN TRANSACTION;
+
+ALTER TABLE client ADD COLUMN date_added INTEGER;
+ALTER TABLE client ADD COLUMN date_modified INTEGER;
+ALTER TABLE client ADD COLUMN comment TEXT;
+
+CREATE TRIGGER tr_client_update AFTER UPDATE ON client
+    BEGIN
+      UPDATE client SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+UPDATE info SET value = 11 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/11_to_12.sql

@@ -0,0 +1,19 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+UPDATE "group" SET name = 'Default' WHERE id = 0;
+UPDATE "group" SET description = 'The default group' WHERE id = 0;
+
+DROP TRIGGER IF EXISTS tr_group_zero;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name,description) VALUES (0,1,'Default','The default group');
+    END;
+
+UPDATE info SET value = 12 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/12_to_13.sql

@@ -0,0 +1,18 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE adlist ADD COLUMN date_updated INTEGER;
+
+DROP TRIGGER tr_adlist_update;
+
+CREATE TRIGGER tr_adlist_update AFTER UPDATE OF address,enabled,comment ON adlist
+    BEGIN
+      UPDATE adlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+UPDATE info SET value = 13 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/1_to_2.sql

@@ -0,0 +1,14 @@
+.timeout 30000
+
+BEGIN TRANSACTION;
+
+CREATE TABLE domain_audit
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int))
+);
+
+UPDATE info SET value = 2 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/2_to_3.sql

@@ -0,0 +1,65 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE regex RENAME TO regex_blacklist;
+
+CREATE TABLE regex_blacklist_by_group
+(
+	regex_blacklist_id INTEGER NOT NULL REFERENCES regex_blacklist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (regex_blacklist_id, group_id)
+);
+
+INSERT INTO regex_blacklist_by_group SELECT * FROM regex_by_group;
+DROP TABLE regex_by_group;
+DROP VIEW vw_regex;
+DROP TRIGGER tr_regex_update;
+
+CREATE VIEW vw_regex_blacklist AS SELECT DISTINCT domain
+    FROM regex_blacklist
+    LEFT JOIN regex_blacklist_by_group ON regex_blacklist_by_group.regex_blacklist_id = regex_blacklist.id
+    LEFT JOIN "group" ON "group".id = regex_blacklist_by_group.group_id
+    WHERE regex_blacklist.enabled = 1 AND (regex_blacklist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY regex_blacklist.id;
+
+CREATE TRIGGER tr_regex_blacklist_update AFTER UPDATE ON regex_blacklist
+    BEGIN
+      UPDATE regex_blacklist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+CREATE TABLE regex_whitelist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+CREATE TABLE regex_whitelist_by_group
+(
+	regex_whitelist_id INTEGER NOT NULL REFERENCES regex_whitelist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (regex_whitelist_id, group_id)
+);
+
+CREATE VIEW vw_regex_whitelist AS SELECT DISTINCT domain
+    FROM regex_whitelist
+    LEFT JOIN regex_whitelist_by_group ON regex_whitelist_by_group.regex_whitelist_id = regex_whitelist.id
+    LEFT JOIN "group" ON "group".id = regex_whitelist_by_group.group_id
+    WHERE regex_whitelist.enabled = 1 AND (regex_whitelist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY regex_whitelist.id;
+
+CREATE TRIGGER tr_regex_whitelist_update AFTER UPDATE ON regex_whitelist
+    BEGIN
+      UPDATE regex_whitelist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+
+UPDATE info SET value = 3 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/3_to_4.sql

@@ -0,0 +1,96 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+CREATE TABLE domainlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	type INTEGER NOT NULL DEFAULT 0,
+	domain TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+ALTER TABLE whitelist ADD COLUMN type INTEGER;
+UPDATE whitelist SET type = 0;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM whitelist;
+
+ALTER TABLE blacklist ADD COLUMN type INTEGER;
+UPDATE blacklist SET type = 1;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM blacklist;
+
+ALTER TABLE regex_whitelist ADD COLUMN type INTEGER;
+UPDATE regex_whitelist SET type = 2;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM regex_whitelist;
+
+ALTER TABLE regex_blacklist ADD COLUMN type INTEGER;
+UPDATE regex_blacklist SET type = 3;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM regex_blacklist;
+
+DROP TABLE whitelist_by_group;
+DROP TABLE blacklist_by_group;
+DROP TABLE regex_whitelist_by_group;
+DROP TABLE regex_blacklist_by_group;
+CREATE TABLE domainlist_by_group
+(
+	domainlist_id INTEGER NOT NULL REFERENCES domainlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (domainlist_id, group_id)
+);
+
+DROP TRIGGER tr_whitelist_update;
+DROP TRIGGER tr_blacklist_update;
+DROP TRIGGER tr_regex_whitelist_update;
+DROP TRIGGER tr_regex_blacklist_update;
+CREATE TRIGGER tr_domainlist_update AFTER UPDATE ON domainlist
+    BEGIN
+      UPDATE domainlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+DROP VIEW vw_whitelist;
+CREATE VIEW vw_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 0
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_blacklist;
+CREATE VIEW vw_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 1
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_regex_whitelist;
+CREATE VIEW vw_regex_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 2
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_regex_blacklist;
+CREATE VIEW vw_regex_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 3
+    ORDER BY domainlist.id;
+
+UPDATE info SET value = 4 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/4_to_5.sql

@@ -0,0 +1,38 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TABLE gravity;
+CREATE TABLE gravity
+(
+	domain TEXT NOT NULL,
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id),
+	PRIMARY KEY(domain, adlist_id)
+);
+
+DROP VIEW vw_gravity;
+CREATE VIEW vw_gravity AS SELECT domain, adlist_by_group.group_id AS group_id
+    FROM gravity
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = gravity.adlist_id
+    LEFT JOIN adlist ON adlist.id = gravity.adlist_id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1);
+
+CREATE TABLE client
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	ip TEXT NOL NULL UNIQUE
+);
+
+CREATE TABLE client_by_group
+(
+	client_id INTEGER NOT NULL REFERENCES client (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (client_id, group_id)
+);
+
+UPDATE info SET value = 5 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/5_to_6.sql

@@ -0,0 +1,18 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP VIEW vw_adlist;
+CREATE VIEW vw_adlist AS SELECT DISTINCT address, adlist.id AS id
+    FROM adlist
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = adlist.id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY adlist.id;
+
+UPDATE info SET value = 6 WHERE property = 'version';
+
+COMMIT;
+

advanced/Scripts/database_migration/gravity/6_to_7.sql

@@ -0,0 +1,35 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+INSERT OR REPLACE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+
+INSERT INTO domainlist_by_group (domainlist_id, group_id) SELECT id, 0 FROM domainlist;
+INSERT INTO client_by_group (client_id, group_id) SELECT id, 0 FROM client;
+INSERT INTO adlist_by_group (adlist_id, group_id) SELECT id, 0 FROM adlist;
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR REPLACE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 7 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/7_to_8.sql

@@ -0,0 +1,35 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE "group" RENAME TO "group__";
+
+CREATE TABLE "group"
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	name TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	description TEXT
+);
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+INSERT OR IGNORE INTO "group" (id,enabled,name,description) SELECT id,enabled,name,description FROM "group__";
+
+DROP TABLE "group__";
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 8 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/8_to_9.sql

@@ -0,0 +1,27 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TRIGGER IF EXISTS tr_group_update;
+DROP TRIGGER IF EXISTS tr_group_zero;
+
+PRAGMA legacy_alter_table=ON;
+ALTER TABLE "group" RENAME TO "group__";
+PRAGMA legacy_alter_table=OFF;
+ALTER TABLE "group__" RENAME TO "group";
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 9 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/9_to_10.sql

@@ -0,0 +1,29 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TABLE IF EXISTS whitelist;
+DROP TABLE IF EXISTS blacklist;
+DROP TABLE IF EXISTS regex_whitelist;
+DROP TABLE IF EXISTS regex_blacklist;
+
+CREATE TRIGGER tr_domainlist_delete AFTER DELETE ON domainlist
+    BEGIN
+      DELETE FROM domainlist_by_group WHERE domainlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_adlist_delete AFTER DELETE ON adlist
+    BEGIN
+      DELETE FROM adlist_by_group WHERE adlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_client_delete AFTER DELETE ON client
+    BEGIN
+      DELETE FROM client_by_group WHERE client_id = OLD.id;
+    END;
+
+UPDATE info SET value = 10 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/list.sh

@@ -1,177 +1,289 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# Whitelists and blacklists domains
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Whitelist and blacklist domains
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
 
-#globals
+# Globals
 basename=pihole
-piholeDir=/etc/${basename}
+piholeDir=/etc/"${basename}"
-whitelist=${piholeDir}/whitelist.txt
+gravityDBfile="${piholeDir}/gravity.db"
-blacklist=${piholeDir}/blacklist.txt
+
 reload=false
 addmode=true
 verbose=true
+wildcard=false
+web=false
 
 domList=()
-domToRemoveList=()
 
-listMain=""
+typeId=""
-listAlt=""
+comment=""
+declare -i domaincount
+domaincount=0
+
+colfile="/opt/pihole/COL_TABLE"
+source ${colfile}
+
+# IDs are hard-wired to domain interpretation in the gravity database scheme
+# Clients (including FTL) will read them through the corresponding views
+readonly whitelist="0"
+readonly blacklist="1"
+readonly regex_whitelist="2"
+readonly regex_blacklist="3"
+
+GetListnameFromTypeId() {
+    if [[ "$1" == "${whitelist}" ]]; then
+        echo "whitelist"
+    elif  [[ "$1" == "${blacklist}" ]]; then
+        echo "blacklist"
+    elif  [[ "$1" == "${regex_whitelist}" ]]; then
+        echo "regex whitelist"
+    elif  [[ "$1" == "${regex_blacklist}" ]]; then
+        echo "regex blacklist"
+    fi
+}
+
+GetListParamFromTypeId() {
+    if [[ "${typeId}" == "${whitelist}" ]]; then
+        echo "w"
+    elif  [[ "${typeId}" == "${blacklist}" ]]; then
+        echo "b"
+    elif  [[ "${typeId}" == "${regex_whitelist}" && "${wildcard}" == true ]]; then
+        echo "-white-wild"
+    elif  [[ "${typeId}" == "${regex_whitelist}" ]]; then
+        echo "-white-regex"
+    elif  [[ "${typeId}" == "${regex_blacklist}" && "${wildcard}" == true ]]; then
+        echo "-wild"
+    elif  [[ "${typeId}" == "${regex_blacklist}" ]]; then
+        echo "-regex"
+    fi
+}
 
 helpFunc() {
+    local listname param
 
-    if [[ ${listMain} == ${whitelist} ]]; then
+    listname="$(GetListnameFromTypeId "${typeId}")"
-        letter="w"
+    param="$(GetListParamFromTypeId)"
-        word="white"
+
-    else
+    echo "Usage: pihole -${param} [options] <domain> <domain2 ...>
-        letter="b"
+Example: 'pihole -${param} site.com', or 'pihole -${param} site1.com site2.com'
-        word="black"
+${listname^} one or more domains
+
+Options:
+  -d, --delmode       Remove domain(s) from the ${listname}
+  -nr, --noreload     Update ${listname} without reloading the DNS server
+  -q, --quiet         Make output less verbose
+  -h, --help          Show this help dialog
+  -l, --list          Display all your ${listname}listed domains
+  --nuke              Removes all entries in a list"
+
+  exit 0
+}
+
+ValidateDomain() {
+    # Convert to lowercase
+    domain="${1,,}"
+
+    # Check validity of domain (don't check for regex entries)
+    if [[ "${#domain}" -le 253 ]]; then
+        if [[ ( "${typeId}" == "${regex_blacklist}" || "${typeId}" == "${regex_whitelist}" ) && "${wildcard}" == false ]]; then
+            validDomain="${domain}"
+        else
+            validDomain=$(grep -P "^((-|_)*[a-z\\d]((-|_)*[a-z\\d])*(-|_)*)(\\.(-|_)*([a-z\\d]((-|_)*[a-z\\d])*))*$" <<< "${domain}") # Valid chars check
+            validDomain=$(grep -P "^[^\\.]{1,63}(\\.[^\\.]{1,63})*$" <<< "${validDomain}") # Length of each label
+        fi
     fi
 
-	cat << EOM
+    if [[ -n "${validDomain}" ]]; then
-::: Immediately ${word}lists one or more domains in the hosts file
+        domList=("${domList[@]}" "${validDomain}")
-:::
+    else
-::: Usage: pihole -${letter} domain1 [domain2 ...]
+        echo -e "  ${CROSS} ${domain} is not a valid argument or domain name!"
-:::
+    fi
-::: Options:
+
-:::  -d, --delmode			Remove domains from the ${word}list
+    domaincount=$((domaincount+1))
-:::  -nr, --noreload		Update ${word}list without refreshing dnsmasq
-:::  -q, --quiet			output is less verbose
-:::  -h, --help				Show this help dialog
-:::  -l, --list				Display your ${word}listed domains
-EOM
-	exit 0
 }
 
-EscapeRegexp() {
+ProcessDomainList() {
-    # This way we may safely insert an arbitrary
+    for dom in "${domList[@]}"; do
-    # string in our regular expressions
+        # Format domain into regex filter if requested
-    echo $* | sed "s/[]\\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
+        if [[ "${wildcard}" == true ]]; then
-}
+            dom="(^|\\.)${dom//\./\\.}$"
+        fi
 
-HandleOther(){
+        # Logic: If addmode then add to desired list and remove from the other;
-	# First, convert everything to lowercase
+        # if delmode then remove from desired list but do not add to the other
-	domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
+        if ${addmode}; then
-
+            AddDomain "${dom}"
-	#check validity of domain
+        else
-	validDomain=$(perl -ne "print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/" <<< "$domain")
+            RemoveDomain "${dom}"
-	if [ -z "${validDomain}" ]; then
+        fi
-		echo "::: $1 is not a valid argument or domain name"
+  done
-	else
-		domList=("${domList[@]}" ${validDomain})
-	fi
-}
-
-PoplistFile() {
-	#check whitelist file exists, and if not, create it
-	if [[ ! -f ${whitelist} ]]; then
-		touch ${whitelist}
-	fi
-	for dom in "${domList[@]}"; do
-	    # Logic : If addmode then add to desired list and remove from the other; if delmode then remove from desired list but do not add to the other
-		if ${addmode}; then
-			AddDomain "${dom}" "${listMain}"
-			RemoveDomain "${dom}" "${listAlt}"
-		else
-			RemoveDomain "${dom}" "${listMain}"
-		fi
-	done
 }
 
 AddDomain() {
-	list="$2"
+    local domain num requestedListname existingTypeId existingListname
-    domain=$(EscapeRegexp "$1")
+    domain="$1"
 
-	bool=true
+    # Is the domain in the list we want to add it to?
-	#Is the domain in the list we want to add it to?
+    num="$(sqlite3 "${gravityDBfile}" "SELECT COUNT(*) FROM domainlist WHERE domain = '${domain}';")"
-	grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
 
-	if [[ "${bool}" == false ]]; then
+    if [[ "${num}" -ne 0 ]]; then
-	  #domain not found in the whitelist file, add it!
+      existingTypeId="$(sqlite3 "${gravityDBfile}" "SELECT type FROM domainlist WHERE domain = '${domain}';")"
-	  if [[ "${verbose}" == true ]]; then
+      if [[ "${existingTypeId}" == "${typeId}" ]]; then
-		echo "::: Adding $1 to $list..."
-	  fi
-	  reload=true
-	  # Add it to the list we want to add it to
-	  echo "$1" >> ${list}
-	else
         if [[ "${verbose}" == true ]]; then
-            echo "::: ${1} already exists in ${list}, no need to add!"
+            echo -e "  ${INFO} ${1} already exists in ${requestedListname}, no need to add!"
         fi
-	fi
+      else
+        existingListname="$(GetListnameFromTypeId "${existingTypeId}")"
+        sqlite3 "${gravityDBfile}" "UPDATE domainlist SET type = ${typeId} WHERE domain='${domain}';"
+        if [[ "${verbose}" == true ]]; then
+            echo -e "  ${INFO} ${1} already exists in ${existingListname}, it has been moved to ${requestedListname}!"
+        fi
+      fi
+      return
+    fi
+
+    # Domain not found in the table, add it!
+    if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} Adding ${domain} to the ${requestedListname}..."
+    fi
+    reload=true
+    # Insert only the domain here. The enabled and date_added fields will be filled
+    # with their default values (enabled = true, date_added = current timestamp)
+    if [[ -z "${comment}" ]]; then
+        sqlite3 "${gravityDBfile}" "INSERT INTO domainlist (domain,type) VALUES ('${domain}',${typeId});"
+    else
+        # also add comment when variable has been set through the "--comment" option
+        sqlite3 "${gravityDBfile}" "INSERT INTO domainlist (domain,type,comment) VALUES ('${domain}',${typeId},'${comment}');"
+    fi
 }
 
 RemoveDomain() {
-    list="$2"
+    local domain num requestedListname
-    domain=$(EscapeRegexp "$1")
+    domain="$1"
 
-    bool=true
+    # Is the domain in the list we want to remove it from?
-    #Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
+    num="$(sqlite3 "${gravityDBfile}" "SELECT COUNT(*) FROM domainlist WHERE domain = '${domain}' AND type = ${typeId};")"
-    grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+
-    if [[ "${bool}" == true ]]; then
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
-        # Remove it from the other one
+
-        echo "::: Removing $1 from $list..."
+    if [[ "${num}" -eq 0 ]]; then
-        # /I flag: search case-insensitive
+      if [[ "${verbose}" == true ]]; then
-        sed -i "/${domain}/Id" ${list}
+          echo -e "  ${INFO} ${domain} does not exist in ${requestedListname}, no need to remove!"
-        reload=true
+      fi
-    else
+      return
-        if [[ "${verbose}" == true ]]; then
-            echo "::: ${1} does not exist in ${list}, no need to remove!"
-        fi
     fi
-}
 
-Reload() {
+    # Domain found in the table, remove it!
-	# Reload hosts file
+    if [[ "${verbose}" == true ]]; then
-	pihole -g -sd
+        echo -e "  ${INFO} Removing ${domain} from the ${requestedListname}..."
+    fi
+    reload=true
+    # Remove it from the current list
+    sqlite3 "${gravityDBfile}" "DELETE FROM domainlist WHERE domain = '${domain}' AND type = ${typeId};"
 }
 
 Displaylist() {
-    if [[ ${listMain} == ${whitelist} ]]; then
+    local count num_pipes domain enabled status nicedate requestedListname
-        string="gravity resistant domains"
+
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
+    data="$(sqlite3 "${gravityDBfile}" "SELECT domain,enabled,date_modified FROM domainlist WHERE type = ${typeId};" 2> /dev/null)"
+
+    if [[ -z $data ]]; then
+        echo -e "Not showing empty list"
     else
-        string="domains caught in the sinkhole"
+        echo -e "Displaying ${requestedListname}:"
+        count=1
+        while IFS= read -r line
+        do
+            # Count number of pipes seen in this line
+            # This is necessary because we can only detect the pipe separating the fields
+            # from the end backwards as the domain (which is the first field) may contain
+            # pipe symbols as they are perfectly valid regex filter control characters
+            num_pipes="$(grep -c "^" <<< "$(grep -o "|" <<< "${line}")")"
+
+            # Extract domain and enabled status based on the obtained number of pipe characters
+            domain="$(cut -d'|' -f"-$((num_pipes-1))" <<< "${line}")"
+            enabled="$(cut -d'|' -f"$((num_pipes))" <<< "${line}")"
+            datemod="$(cut -d'|' -f"$((num_pipes+1))" <<< "${line}")"
+
+            # Translate boolean status into human readable string
+            if [[ "${enabled}" -eq 1 ]]; then
+                status="enabled"
+            else
+                status="disabled"
+            fi
+
+            # Get nice representation of numerical date stored in database
+            nicedate=$(date --rfc-2822 -d "@${datemod}")
+
+            echo "  ${count}: ${domain} (${status}, last modified ${nicedate})"
+            count=$((count+1))
+        done <<< "${data}"
     fi
-	verbose=false
+    exit 0;
-	echo -e " Displaying $string \n"
-	count=1
-	while IFS= read -r RD; do
-		echo "${count}: ${RD}"
-		count=$((count+1))
-	done < "${listMain}"
-	exit 0;
 }
 
-for var in "$@"; do
+NukeList() {
-	case "${var}" in
+    count=$(sqlite3 "${gravityDBfile}" "SELECT COUNT(1) FROM domainlist WHERE type = ${typeId};")
-	    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
+    listname="$(GetListnameFromTypeId "${typeId}")"    
-	    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
+    if [ "$count" -gt 0 ];then
-		"-nr"| "--noreload"  ) reload=false;;
+        sqlite3 "${gravityDBfile}" "DELETE FROM domainlist WHERE type = ${typeId};"
-		"-d" | "--delmode"   ) addmode=false;;
+        echo "  ${TICK} Removed ${count} domain(s) from the ${listname}"
-		"-f" | "--force"     ) force=true;;
+    else
-		"-q" | "--quiet"     ) verbose=false;;
+        echo "  ${INFO} ${listname} already empty. Nothing to do!"
-		"-h" | "--help"      ) helpFunc;;
+    fi    
-		"-l" | "--list"      ) Displaylist;;
+    exit 0;
-		*                    ) HandleOther "${var}";;
+}
-	esac
+
+GetComment() {
+    comment="$1"
+    if [[ "${comment}" =~ [^a-zA-Z0-9_\#:/\.,\ -] ]]; then
+      echo "  ${CROSS} Found invalid characters in domain comment!"
+      exit
+    fi
+}
+
+while (( "$#" )); do
+    case "${1}" in
+        "-w" | "whitelist"   ) typeId=0;;
+        "-b" | "blacklist"   ) typeId=1;;
+        "--white-regex" | "white-regex" ) typeId=2;;
+        "--white-wild" | "white-wild" ) typeId=2; wildcard=true;;
+        "--wild" | "wildcard" ) typeId=3; wildcard=true;;
+        "--regex" | "regex"   ) typeId=3;;
+        "-nr"| "--noreload"  ) reload=false;;
+        "-d" | "--delmode"   ) addmode=false;;
+        "-q" | "--quiet"     ) verbose=false;;
+        "-h" | "--help"      ) helpFunc;;
+        "-l" | "--list"      ) Displaylist;;
+        "--nuke"             ) NukeList;;
+        "--web"              ) web=true;;
+        "--comment"          ) GetComment "${2}"; shift;;
+        *                    ) ValidateDomain "${1}";;
+    esac
+    shift
 done
 
 shift
 
-if [[ $# = 0 ]]; then
+if [[ ${domaincount} == 0 ]]; then
-	helpFunc
+    helpFunc
 fi
 
-PoplistFile
+ProcessDomainList
 
-if ${reload}; then
+# Used on web interface
-	Reload
+if $web; then
+echo "DONE"
 fi
 
+if [[ "${reload}" != false ]]; then
+    pihole restartdns reload-lists
+fi

advanced/Scripts/pihole-reenable.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2020 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#
+#
+# The pihole disable command has the option to set a specified time before
+# blocking is automatically re-enabled.
+#
+# Present script is responsible for the sleep & re-enable part of the job and
+# is automatically terminated if it is still running when pihole is enabled by
+# other means.
+#
+# This ensures that pihole ends up in the correct state after a sequence of
+# commands suchs as: `pihole disable 30s; pihole enable; pihole disable`
+
+readonly PI_HOLE_BIN_DIR="/usr/local/bin"
+
+sleep "${1}"
+"${PI_HOLE_BIN_DIR}"/pihole enable

advanced/Scripts/piholeARPTable.sh

@@ -0,0 +1,66 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2019 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# ARP table interaction
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+coltable="/opt/pihole/COL_TABLE"
+if [[ -f ${coltable} ]]; then
+    source ${coltable}
+fi
+
+# Determine database location
+# Obtain DBFILE=... setting from pihole-FTL.db
+# Constructed to return nothing when
+# a) the setting is not present in the config file, or
+# b) the setting is commented out (e.g. "#DBFILE=...")
+FTLconf="/etc/pihole/pihole-FTL.conf"
+if [ -e "$FTLconf" ]; then
+    DBFILE="$(sed -n -e 's/^\s*DBFILE\s*=\s*//p' ${FTLconf})"
+fi
+# Test for empty string. Use standard path in this case.
+if [ -z "$DBFILE" ]; then
+    DBFILE="/etc/pihole/pihole-FTL.db"
+fi
+
+
+flushARP(){
+    local output
+    if [[ "${args[1]}" != "quiet" ]]; then
+        echo -ne "  ${INFO} Flushing network table ..."
+    fi
+
+    # Truncate network_addresses table in pihole-FTL.db
+    # This needs to be done before we can truncate the network table due to
+    # foreign key contraints
+    if ! output=$(sqlite3 "${DBFILE}" "DELETE FROM network_addresses" 2>&1); then
+        echo -e "${OVER}  ${CROSS} Failed to truncate network_addresses table"
+        echo "  Database location: ${DBFILE}"
+        echo "  Output: ${output}"
+        return 1
+    fi
+
+    # Truncate network table in pihole-FTL.db
+    if ! output=$(sqlite3 "${DBFILE}" "DELETE FROM network" 2>&1); then
+        echo -e "${OVER}  ${CROSS} Failed to truncate network table"
+        echo "  Database location: ${DBFILE}"
+        echo "  Output: ${output}"
+        return 1
+    fi
+
+    if [[ "${args[1]}" != "quiet" ]]; then
+        echo -e "${OVER}  ${TICK} Flushed network table"
+    fi
+}
+
+args=("$@")
+
+case "${args[0]}" in
+    "arpflush"            ) flushARP;;
+esac

advanced/Scripts/piholeCheckout.sh

@@ -0,0 +1,201 @@
+#!/usr/bin/env bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Switch Pi-hole subsystems to a different GitHub branch.
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+readonly PI_HOLE_FILES_DIR="/etc/.pihole"
+PH_TEST="true"
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
+
+# webInterfaceGitUrl set in basic-install.sh
+# webInterfaceDir set in basic-install.sh
+# piholeGitURL set in basic-install.sh
+# is_repo() sourced from basic-install.sh
+# setupVars set in basic-install.sh
+# check_download_exists sourced from basic-install.sh
+# fully_fetch_repo sourced from basic-install.sh
+# get_available_branches sourced from basic-install.sh
+# fetch_checkout_pull_branch sourced from basic-install.sh
+# checkout_pull_branch sourced from basic-install.sh
+
+source "${setupVars}"
+
+warning1() {
+    echo "  Please note that changing branches severely alters your Pi-hole subsystems"
+    echo "  Features that work on the master branch, may not on a development branch"
+    echo -e "  ${COL_LIGHT_RED}This feature is NOT supported unless a Pi-hole developer explicitly asks!${COL_NC}"
+    read -r -p "  Have you read and understood this? [y/N] " response
+    case "${response}" in
+        [yY][eE][sS]|[yY])
+            echo ""
+            return 0
+            ;;
+        *)
+            echo -e "\\n  ${INFO} Branch change has been canceled"
+            return 1
+            ;;
+    esac
+}
+
+checkout() {
+    local corebranches
+    local webbranches
+
+    # Check if FTL is installed - do this early on as FTL is a hard dependency for Pi-hole
+    local funcOutput
+    funcOutput=$(get_binary_name) #Store output of get_binary_name here
+    local binary
+    binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
+
+    # Avoid globbing
+    set -f
+
+    # This is unlikely
+    if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
+        echo -e "  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!"
+        echo -e "  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
+        exit 1;
+    fi
+    if [[ "${INSTALL_WEB_INTERFACE}" == "true" ]]; then
+        if ! is_repo "${webInterfaceDir}" ; then
+            echo -e "  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!"
+            echo -e "  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
+            exit 1;
+        fi
+    fi
+
+    if [[ -z "${1}" ]]; then
+        echo -e "  ${COL_LIGHT_RED}Invalid option${COL_NC}"
+        echo -e "  Try 'pihole checkout --help' for more information."
+        exit 1
+    fi
+
+    if ! warning1 ; then
+        exit 1
+    fi
+
+    if [[ "${1}" == "dev" ]] ; then
+        # Shortcut to check out development branches
+        echo -e "  ${INFO} Shortcut \"dev\" detected - checking out development / devel branches..."
+        echo ""
+        echo -e "  ${INFO} Pi-hole Core"
+        fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo "  ${CROSS} Unable to pull Core development branch"; exit 1; }
+        if [[ "${INSTALL_WEB_INTERFACE}" == "true" ]]; then
+            echo ""
+            echo -e "  ${INFO} Web interface"
+            fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo "  ${CROSS} Unable to pull Web development branch"; exit 1; }
+        fi
+        #echo -e "  ${TICK} Pi-hole Core"
+
+        local path
+        path="development/${binary}"
+        echo "development" > /etc/pihole/ftlbranch
+        chmod 644 /etc/pihole/ftlbranch
+    elif [[ "${1}" == "master" ]] ; then
+        # Shortcut to check out master branches
+        echo -e "  ${INFO} Shortcut \"master\" detected - checking out master branches..."
+        echo -e "  ${INFO} Pi-hole core"
+        fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo "  ${CROSS} Unable to pull Core master branch"; exit 1; }
+        if [[ ${INSTALL_WEB_INTERFACE} == "true" ]]; then
+            echo -e "  ${INFO} Web interface"
+            fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "  ${CROSS} Unable to pull Web master branch"; exit 1; }
+        fi
+        #echo -e "  ${TICK} Web Interface"
+        local path
+        path="master/${binary}"
+        echo "master" > /etc/pihole/ftlbranch
+        chmod 644 /etc/pihole/ftlbranch
+    elif [[ "${1}" == "core" ]] ; then
+        str="Fetching branches from ${piholeGitUrl}"
+        echo -ne "  ${INFO} $str"
+        if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
+            echo -e "${OVER}  ${CROSS} $str"
+            exit 1
+        fi
+        corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
+
+        if [[ "${corebranches[*]}" == *"master"* ]]; then
+            echo -e "${OVER}  ${TICK} $str"
+            echo -e "  ${INFO} ${#corebranches[@]} branches available for Pi-hole Core"
+        else
+            # Print STDERR output from get_available_branches
+            echo -e "${OVER}  ${CROSS} $str\\n\\n${corebranches[*]}"
+            exit 1
+        fi
+
+        echo ""
+        # Have the user choose the branch they want
+        if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+            echo -e "  ${INFO} Requested branch \"${2}\" is not available"
+            echo -e "  ${INFO} Available branches for Core are:"
+            for e in "${corebranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+        checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
+    elif [[ "${1}" == "web" ]] && [[ "${INSTALL_WEB_INTERFACE}" == "true" ]] ; then
+        str="Fetching branches from ${webInterfaceGitUrl}"
+        echo -ne "  ${INFO} $str"
+        if ! fully_fetch_repo "${webInterfaceDir}" ; then
+            echo -e "${OVER}  ${CROSS} $str"
+            exit 1
+        fi
+        webbranches=($(get_available_branches "${webInterfaceDir}"))
+
+        if [[ "${webbranches[*]}" == *"master"* ]]; then
+            echo -e "${OVER}  ${TICK} $str"
+            echo -e "  ${INFO} ${#webbranches[@]} branches available for Web Admin"
+        else
+            # Print STDERR output from get_available_branches
+            echo -e "${OVER}  ${CROSS} $str\\n\\n${webbranches[*]}"
+            exit 1
+        fi
+
+        echo ""
+        # Have the user choose the branch they want
+        if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+            echo -e "  ${INFO} Requested branch \"${2}\" is not available"
+            echo -e "  ${INFO} Available branches for Web Admin are:"
+            for e in "${webbranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+        checkout_pull_branch "${webInterfaceDir}" "${2}"
+    elif [[ "${1}" == "ftl" ]] ; then
+        local path
+        path="${2}/${binary}"
+
+        if check_download_exists "$path"; then
+            echo "  ${TICK} Branch ${2} exists"
+            echo "${2}" > /etc/pihole/ftlbranch
+            chmod 644 /etc/pihole/ftlbranch
+            FTLinstall "${binary}"
+            restart_service pihole-FTL
+            enable_service pihole-FTL
+        else
+            echo "  ${CROSS} Requested branch \"${2}\" is not available"
+            ftlbranches=( $(git ls-remote https://github.com/pi-hole/ftl | grep 'heads' | sed 's/refs\/heads\///;s/ //g' | awk '{print $2}') )
+            echo -e "  ${INFO} Available branches for FTL are:"
+            for e in "${ftlbranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+
+    else
+        echo -e "  ${INFO} Requested option \"${1}\" is not available"
+        exit 1
+    fi
+
+    # Force updating everything
+    if [[  ! "${1}" == "web" && ! "${1}" == "ftl" ]]; then
+        echo -e "  ${INFO} Running installer to upgrade your installation"
+        if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
+            exit 0
+        else
+            echo -e "  ${COL_LIGHT_RED} Error: Unable to complete update, please contact support${COL_NC}"
+            exit 1
+        fi
+    fi
+}

advanced/Scripts/piholeLogFlush.sh

@@ -1,15 +1,70 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# Flushes /var/log/pihole.log
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Flushes Pi-hole's log file
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
 
-echo -n "::: Flushing /var/log/pihole.log ..."
+colfile="/opt/pihole/COL_TABLE"
-echo " " > /var/log/pihole.log
+source ${colfile}
-echo "... done!"
+
+# Determine database location
+# Obtain DBFILE=... setting from pihole-FTL.db
+# Constructed to return nothing when
+# a) the setting is not present in the config file, or
+# b) the setting is commented out (e.g. "#DBFILE=...")
+FTLconf="/etc/pihole/pihole-FTL.conf"
+if [ -e "$FTLconf" ]; then
+    DBFILE="$(sed -n -e 's/^\s*DBFILE\s*=\s*//p' ${FTLconf})"
+fi
+# Test for empty string. Use standard path in this case.
+if [ -z "$DBFILE" ]; then
+    DBFILE="/etc/pihole/pihole-FTL.db"
+fi
+
+if [[ "$@" != *"quiet"* ]]; then
+    echo -ne "  ${INFO} Flushing /var/log/pihole.log ..."
+fi
+if [[ "$@" == *"once"* ]]; then
+    # Nightly logrotation
+    if command -v /usr/sbin/logrotate >/dev/null; then
+        # Logrotate once
+        /usr/sbin/logrotate --force /etc/pihole/logrotate
+    else
+        # Copy pihole.log over to pihole.log.1
+        # and empty out pihole.log
+        # Note that moving the file is not an option, as
+        # dnsmasq would happily continue writing into the
+        # moved file (it will have the same file handler)
+        cp -p /var/log/pihole.log /var/log/pihole.log.1
+        echo " " > /var/log/pihole.log
+        chmod 644 /var/log/pihole.log
+    fi
+else
+    # Manual flushing
+    if command -v /usr/sbin/logrotate >/dev/null; then
+        # Logrotate twice to move all data out of sight of FTL
+        /usr/sbin/logrotate --force /etc/pihole/logrotate; sleep 3
+        /usr/sbin/logrotate --force /etc/pihole/logrotate
+    else
+        # Flush both pihole.log and pihole.log.1 (if existing)
+        echo " " > /var/log/pihole.log
+        if [ -f /var/log/pihole.log.1 ]; then
+            echo " " > /var/log/pihole.log.1
+            chmod 644 /var/log/pihole.log.1
+        fi
+    fi
+    # Delete most recent 24 hours from FTL's database, leave even older data intact (don't wipe out all history)
+    deleted=$(sqlite3 "${DBFILE}" "DELETE FROM queries WHERE timestamp >= strftime('%s','now')-86400; select changes() from queries limit 1")
+
+    # Restart pihole-FTL to force reloading history
+    sudo pihole restartdns
+fi
+
+if [[ "$@" != *"quiet"* ]]; then
+    echo -e "${OVER}  ${TICK} Flushed /var/log/pihole.log"
+    echo -e "  ${TICK} Deleted ${deleted} queries from database"
+fi

advanced/Scripts/query.sh

@@ -0,0 +1,254 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2018 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Query Domain Lists
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+# Globals
+piholeDir="/etc/pihole"
+gravityDBfile="${piholeDir}/gravity.db"
+options="$*"
+all=""
+exact=""
+blockpage=""
+matchType="match"
+
+colfile="/opt/pihole/COL_TABLE"
+source "${colfile}"
+
+# Scan an array of files for matching strings
+scanList(){
+    # Escape full stops
+    local domain="${1}" esc_domain="${1//./\\.}" lists="${2}" type="${3:-}"
+
+    # Prevent grep from printing file path
+    cd "$piholeDir" || exit 1
+
+    # Prevent grep -i matching slowly: https://bit.ly/2xFXtUX
+    export LC_CTYPE=C
+
+    # /dev/null forces filename to be printed when only one list has been generated
+    case "${type}" in
+        "exact" ) grep -i -E -l "(^|(?<!#)\\s)${esc_domain}($|\\s|#)" ${lists} /dev/null 2>/dev/null;;
+        # Iterate through each regexp and check whether it matches the domainQuery
+        # If it does, print the matching regexp and continue looping
+        # Input 1 - regexps | Input 2 - domainQuery
+        "regex" ) 
+            for list in ${lists}; do
+                if [[ "${domain}" =~ ${list} ]]; then
+                    printf "%b\n" "${list}";
+                fi
+            done;;
+        *       ) grep -i "${esc_domain}" ${lists} /dev/null 2>/dev/null;;
+    esac
+}
+
+if [[ "${options}" == "-h" ]] || [[ "${options}" == "--help" ]]; then
+    echo "Usage: pihole -q [option] <domain>
+Example: 'pihole -q -exact domain.com'
+Query the adlists for a specified domain
+
+Options:
+  -exact              Search the block lists for exact domain matches
+  -all                Return all query matches within a block list
+  -h, --help          Show this help dialog"
+  exit 0
+fi
+
+# Handle valid options
+if [[ "${options}" == *"-bp"* ]]; then
+    exact="exact"; blockpage=true
+else
+    [[ "${options}" == *"-all"* ]] && all=true
+    if [[ "${options}" == *"-exact"* ]]; then
+        exact="exact"; matchType="exact ${matchType}"
+    fi
+fi
+
+# Strip valid options, leaving only the domain and invalid options
+# This allows users to place the options before or after the domain
+options=$(sed -E 's/ ?-(bp|adlists?|all|exact) ?//g' <<< "${options}")
+
+# Handle remaining options
+# If $options contain non ASCII characters, convert to punycode
+case "${options}" in
+    ""             ) str="No domain specified";;
+    *" "*          ) str="Unknown query option specified";;
+    *[![:ascii:]]* ) domainQuery=$(idn2 "${options}");;
+    *              ) domainQuery="${options}";;
+esac
+
+if [[ -n "${str:-}" ]]; then
+    echo -e "${str}${COL_NC}\\nTry 'pihole -q --help' for more information."
+    exit 1
+fi
+
+scanDatabaseTable() {
+    local domain table type querystr result extra
+    domain="$(printf "%q" "${1}")"
+    table="${2}"
+    type="${3:-}"
+
+    # As underscores are legitimate parts of domains, we escape them when using the LIKE operator.
+    # Underscores are SQLite wildcards matching exactly one character. We obviously want to suppress this
+    # behavior. The "ESCAPE '\'" clause specifies that an underscore preceded by an '\' should be matched
+    # as a literal underscore character. We pretreat the $domain variable accordingly to escape underscores.
+    if [[ "${table}" == "gravity" ]]; then
+      case "${exact}" in
+          "exact" ) querystr="SELECT gravity.domain,adlist.address,adlist.enabled FROM gravity LEFT JOIN adlist ON adlist.id = gravity.adlist_id WHERE domain = '${domain}'";;
+          *       ) querystr="SELECT gravity.domain,adlist.address,adlist.enabled FROM gravity LEFT JOIN adlist ON adlist.id = gravity.adlist_id WHERE domain LIKE '%${domain//_/\\_}%' ESCAPE '\\'";;
+      esac
+    else
+      case "${exact}" in
+          "exact" ) querystr="SELECT domain,enabled FROM domainlist WHERE type = '${type}' AND domain = '${domain}'";;
+          *       ) querystr="SELECT domain,enabled FROM domainlist WHERE type = '${type}' AND domain LIKE '%${domain//_/\\_}%' ESCAPE '\\'";;
+      esac
+    fi
+
+    # Send prepared query to gravity database
+    result="$(sqlite3 "${gravityDBfile}" "${querystr}")" 2> /dev/null
+    if [[ -z "${result}" ]]; then
+        # Return early when there are no matches in this table
+        return
+    fi
+
+    if [[ "${table}" == "gravity" ]]; then
+      echo "${result}"
+      return
+    fi
+
+    # Mark domain as having been white-/blacklist matched (global variable)
+    wbMatch=true
+
+    # Print table name
+    if [[ -z "${blockpage}" ]]; then
+        echo " ${matchType^} found in ${COL_BOLD}exact ${table}${COL_NC}"
+    fi
+
+    # Loop over results and print them
+    mapfile -t results <<< "${result}"
+    for result in "${results[@]}"; do
+        if [[ -n "${blockpage}" ]]; then
+            echo "π ${result}"
+            exit 0
+        fi
+        domain="${result/|*}"
+        if [[ "${result#*|}" == "0" ]]; then
+            extra=" (disabled)"
+        else
+            extra=""
+        fi
+        echo "   ${domain}${extra}"
+    done
+}
+
+scanRegexDatabaseTable() {
+    local domain list
+    domain="${1}"
+    list="${2}"
+    type="${3:-}"
+
+    # Query all regex from the corresponding database tables
+    mapfile -t regexList < <(sqlite3 "${gravityDBfile}" "SELECT domain FROM domainlist WHERE type = ${type}" 2> /dev/null)
+
+    # If we have regexps to process
+    if [[ "${#regexList[@]}" -ne 0 ]]; then
+        # Split regexps over a new line
+        str_regexList=$(printf '%s\n' "${regexList[@]}")
+        # Check domain against regexps
+        mapfile -t regexMatches < <(scanList "${domain}" "${str_regexList}" "regex")
+        # If there were regex matches
+        if [[  "${#regexMatches[@]}" -ne 0 ]]; then
+            # Split matching regexps over a new line
+            str_regexMatches=$(printf '%s\n' "${regexMatches[@]}")
+            # Form a "matched" message
+            str_message="${matchType^} found in ${COL_BOLD}regex ${list}${COL_NC}"
+            # Form a "results" message
+            str_result="${COL_BOLD}${str_regexMatches}${COL_NC}"
+            # If we are displaying more than just the source of the block
+            if [[ -z "${blockpage}" ]]; then
+                # Set the wildcard match flag
+                wcMatch=true
+                # Echo the "matched" message, indented by one space
+                echo " ${str_message}"
+                # Echo the "results" message, each line indented by three spaces
+                # shellcheck disable=SC2001
+                echo "${str_result}" | sed 's/^/   /'
+            else
+                echo "π .wildcard"
+                exit 0
+            fi
+        fi
+    fi
+}
+
+# Scan Whitelist and Blacklist
+scanDatabaseTable "${domainQuery}" "whitelist" "0"
+scanDatabaseTable "${domainQuery}" "blacklist" "1"
+
+# Scan Regex table
+scanRegexDatabaseTable "${domainQuery}" "whitelist" "2"
+scanRegexDatabaseTable "${domainQuery}" "blacklist" "3"
+
+# Query block lists
+mapfile -t results <<< "$(scanDatabaseTable "${domainQuery}" "gravity")"
+
+# Handle notices
+if [[ -z "${wbMatch:-}" ]] && [[ -z "${wcMatch:-}" ]] && [[ -z "${results[*]}" ]]; then
+    echo -e "  ${INFO} No ${exact/t/t }results found for ${COL_BOLD}${domainQuery}${COL_NC} within the block lists"
+    exit 0
+elif [[ -z "${results[*]}" ]]; then
+    # Result found in WL/BL/Wildcards
+    exit 0
+elif [[ -z "${all}" ]] && [[ "${#results[*]}" -ge 100 ]]; then
+    echo -e "  ${INFO} Over 100 ${exact/t/t }results found for ${COL_BOLD}${domainQuery}${COL_NC}
+        This can be overridden using the -all option"
+    exit 0
+fi
+
+# Print "Exact matches for" title
+if [[ -n "${exact}" ]] && [[ -z "${blockpage}" ]]; then
+    plural=""; [[ "${#results[*]}" -gt 1 ]] && plural="es"
+    echo " ${matchType^}${plural} for ${COL_BOLD}${domainQuery}${COL_NC} found in:"
+fi
+
+for result in "${results[@]}"; do
+    match="${result/|*/}"
+    extra="${result#*|}"
+    adlistAddress="${extra/|*/}"
+    extra="${extra#*|}"
+    if [[ "${extra}" == "0" ]]; then
+      extra="(disabled)"
+    else
+      extra=""
+    fi
+
+    if [[ -n "${blockpage}" ]]; then
+        echo "0 ${adlistAddress}"
+    elif [[ -n "${exact}" ]]; then
+        echo "  - ${adlistAddress} ${extra}"
+    else
+        if [[ ! "${adlistAddress}" == "${adlistAddress_prev:-}" ]]; then
+            count=""
+            echo " ${matchType^} found in ${COL_BOLD}${adlistAddress}${COL_NC}:"
+            adlistAddress_prev="${adlistAddress}"
+        fi
+        : $((count++))
+
+        # Print matching domain if $max_count has not been reached
+        [[ -z "${all}" ]] && max_count="50"
+        if [[ -z "${all}" ]] && [[ "${count}" -ge "${max_count}" ]]; then
+            [[ "${count}" -gt "${max_count}" ]] && continue
+            echo "   ${COL_GRAY}Over ${count} results found, skipping rest of file${COL_NC}"
+        else
+            echo "   ${match} ${extra}"
+        fi
+    fi
+done
+
+exit 0

advanced/Scripts/setupLCD.sh

@@ -1,42 +1,42 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Automatically configures the Pi to use the 2.8 LCD screen to display stats on it (also works over ssh)
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 ############ FUNCTIONS ###########
 
 # Borrowed from adafruit-pitft-helper < borrowed from raspi-config
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334
 getInitSys() {
-	if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
+    if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
-		SYSTEMD=1
+        SYSTEMD=1
-	elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
+    elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
-		SYSTEMD=0
+        SYSTEMD=0
-	else
+    else
-		echo "Unrecognised init system"
+        echo "Unrecognized init system"
-		return 1
+        return 1
-	fi
+    fi
 }
 
 # Borrowed from adafruit-pitft-helper:
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L274-L285
 autoLoginPiToConsole() {
-	if [ -e /etc/init.d/lightdm ]; then
+    if [ -e /etc/init.d/lightdm ]; then
-		if [ ${SYSTEMD} -eq 1 ]; then
+        if [ ${SYSTEMD} -eq 1 ]; then
-			systemctl set-default multi-user.target
+            systemctl set-default multi-user.target
-			ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
+            ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
-		else
+        else
-			update-rc.d lightdm disable 2
+            update-rc.d lightdm disable 2
-			sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/"
+            sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/"
-		fi
+        fi
-	fi
+    fi
 }
 
 ######### SCRIPT ###########
@@ -70,5 +70,5 @@ setupcon
 reboot
 
 # Start showing the stats on the screen by running the command on another tty:
-# http://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty
+# https://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty
 #setsid sh -c 'exec /usr/local/bin/chronometer.sh <> /dev/tty1 >&0 2>&1'

advanced/Scripts/update.sh

@@ -1,166 +1,217 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Check Pi-hole core and admin pages versions and determine what
 # upgrade (if any) is required. Automatically updates and reinstalls
 # application if update is detected.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
 
 # Variables
-
 readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
 readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
 readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
 readonly PI_HOLE_FILES_DIR="/etc/.pihole"
 
-is_repo() {
+# shellcheck disable=SC2034
-  # Use git to check if directory is currently under VCS, return the value
+PH_TEST=true
-  local directory="${1}"
 
-  git -C "${directory}" status --short &> /dev/null
+# when --check-only is passed to this script, it will not perform the actual update
-  return
+CHECK_ONLY=false
-}
 
-prep_repo() {
+# shellcheck disable=SC1090
-  # Prepare directory for local repository building
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
-  local directory="${1}"
+# shellcheck disable=SC1091
+source "/opt/pihole/COL_TABLE"
 
-  rm -rf "${directory}" &> /dev/null
+# is_repo() sourced from basic-install.sh
-  return
+# make_repo() sourced from basic-install.sh
-}
+# update_repo() source from basic-install.sh
+# getGitFiles() sourced from basic-install.sh
+# FTLcheckUpdate() sourced from basic-install.sh
 
-make_repo() {
+GitCheckUpdateAvail() {
-  # Remove the non-repod interface and clone the interface
+    local directory
-  local remoteRepo="${2}"
+    directory="${1}"
-  local directory="${1}"
+    curdir=$PWD
+    cd "${directory}" || return
 
-  (prep_repo "${directory}" && git clone -q --depth 1 "${remoteRepo}" "${directory}" > /dev/null)
+    # Fetch latest changes in this repo
-     return
+    git fetch --quiet origin
-}
 
-update_repo() {
+    # @ alone is a shortcut for HEAD. Older versions of git
-  local directory="${1}"
+    # need @{0}
-  local retVal=0
+    LOCAL="$(git rev-parse "@{0}")"
-  # Pull the latest commits
 
-  # Stash all files not tracked for later retrieval
+    # The suffix @{upstream} to a branchname
-  git -C "${directory}" stash --all --quiet &> /dev/null || ${retVal}=1
+    # (short form <branchname>@{u}) refers
-  # Force a clean working directory for cloning
+    # to the branch that the branch specified
-  git -C "${directory}" clean --force -d &> /dev/null || ${retVal}=1
+    # by branchname is set to build on top of#
-  # Fetch latest changes and apply
+    # (configured with branch.<name>.remote and
-  git -C "${directory}" pull --quiet &> /dev/null || ${retVal}=1
+    # branch.<name>.merge). A missing branchname
-  return ${retVal}
+    # defaults to the current one.
-}
+    REMOTE="$(git rev-parse "@{upstream}")"
 
-getGitFiles() {
+    if [[ "${#LOCAL}" == 0 ]]; then
-  # Setup git repos for directory and repository passed
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Local revision could not be obtained, please contact Pi-hole Support"
-  # as arguments 1 and 2
+        echo -e "  Additional debugging output:${COL_NC}"
-  local directory="${1}"
+        git status
-  local remoteRepo="${2}"
+        exit
-  echo ":::"
+    fi
-  echo "::: Checking for existing repository..."
+    if [[ "${#REMOTE}" == 0 ]]; then
-  if is_repo "${directory}"; then
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Remote revision could not be obtained, please contact Pi-hole Support"
-    echo -n ":::     Updating repository in ${directory}..."
+        echo -e "  Additional debugging output:${COL_NC}"
-    update_repo "${directory}" || (echo "*** Error: Could not update local repository. Contact support."; exit 1)
+        git status
-    echo " done!"
+        exit
-  else
+    fi
-    echo -n ":::    Cloning ${remoteRepo} into ${directory}..."
+
-    make_repo "${directory}" "${remoteRepo}" || (echo "Unable to clone repository, please contact support"; exit 1)
+    # Change back to original directory
-    echo " done!"
+    cd "${curdir}" || exit
-  fi
+
+    if [[ "${LOCAL}" != "${REMOTE}" ]]; then
+        # Local branch is behind remote branch -> Update
+        return 0
+    else
+        # Local branch is up-to-date or in a situation
+        # where this updater cannot be used (like on a
+        # branch that exists only locally)
+        return 1
+    fi
 }
 
 main() {
-  local pihole_version_current
+    local basicError="\\n  ${COL_LIGHT_RED}Unable to complete update, please contact Pi-hole Support${COL_NC}"
-  local pihole_version_latest
+    local core_update
-  local web_version_current
+    local web_update
-  local web_version_latest
+    local FTL_update
 
-  if ! is_repo "${PI_HOLE_FILES_DIR}" || ! is_repo "${ADMIN_INTERFACE_DIR}" ; then #This is unlikely
+    core_update=false
-    echo "::: Critical Error: One or more Pi-Hole repos are missing from system!"
+    web_update=false
-    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+    FTL_update=false
-    exit 1;
-  fi
 
-  echo "::: Checking for updates..."
+    # shellcheck disable=1090,2154
-  # Checks Pi-hole version string in format vX.X.X
+    source "${setupVars}"
-  pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
-  pihole_version_latest="$(/usr/local/bin/pihole version --pihole --latest)"
-  web_version_current="$(/usr/local/bin/pihole version --admin --current)"
-  web_version_latest="$(/usr/local/bin/pihole version --admin --latest)"
 
-  if [[ "${pihole_version_latest}" == "-1" || "${web_version_latest}" == "-1" ]]; then
+    # This is unlikely
-    echo "*** Unable to contact GitHub for latest version. Please try again later, contact support if this continues."
+    if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
-    exit 1
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!"
-  fi
+        echo -e "  Please re-run install script from https://pi-hole.net${COL_NC}"
+        exit 1;
+    fi
 
-  # Logic
+    echo -e "  ${INFO} Checking for updates..."
-  # If latest versions are blank - we've probably hit Github rate limit (stop running `pihole -up so often!):
-  #            Update anyway
-  # If Core up to date AND web up to date:
-  #            Do nothing
-  # If Core up to date AND web NOT up to date:
-  #            Pull web repo
-  # If Core NOT up to date AND web up to date:
-  #            pull pihole repo, run install --unattended -- reconfigure
-  # if Core NOT up to date AND web NOT up to date:
-  #            pull pihole repo run install --unattended
 
-  if [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
+    if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
-    echo ":::"
+        core_update=true
-    echo "::: Pi-hole version is $pihole_version_current"
+        echo -e "  ${INFO} Pi-hole Core:\\t${COL_YELLOW}update available${COL_NC}"
-    echo "::: Web Admin version is $web_version_current"
+    else
-    echo ":::"
+        core_update=false
-    echo "::: Everything is up to date!"
+        echo -e "  ${INFO} Pi-hole Core:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
+    fi
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
+            echo -e "\\n  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!"
+            echo -e "  Please re-run install script from https://pi-hole.net${COL_NC}"
+            exit 1;
+        fi
+
+        if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
+            web_update=true
+            echo -e "  ${INFO} Web Interface:\\t${COL_YELLOW}update available${COL_NC}"
+        else
+            web_update=false
+            echo -e "  ${INFO} Web Interface:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
+        fi
+    fi
+
+    local funcOutput
+    funcOutput=$(get_binary_name) #Store output of get_binary_name here
+    local binary
+    binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
+
+    if FTLcheckUpdate "${binary}" > /dev/null; then
+        FTL_update=true
+        echo -e "  ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
+    else
+        case $? in
+            1)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
+                ;;
+            2)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_RED}Branch is not available.${COL_NC}\\n\\t\\t\\tUse ${COL_LIGHT_GREEN}pihole checkout ftl [branchname]${COL_NC} to switch to a valid branch."
+                ;;
+            *)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_RED}Something has gone wrong, contact support${COL_NC}"
+        esac
+        FTL_update=false
+    fi
+
+    # Determine FTL branch
+    local ftlBranch
+    if [[ -f "/etc/pihole/ftlbranch" ]]; then
+        ftlBranch=$(</etc/pihole/ftlbranch)
+    else
+        ftlBranch="master"
+    fi
+
+    if [[ ! "${ftlBranch}" == "master" && ! "${ftlBranch}" == "development" ]]; then
+        # Notify user that they are on a custom branch which might mean they they are lost
+        # behind if a branch was merged to development and got abandoned
+        printf "  %b %bWarning:%b You are using FTL from a custom branch (%s) and might be missing future releases.\\n" "${INFO}" "${COL_LIGHT_RED}" "${COL_NC}" "${ftlBranch}"
+    fi
+
+    if [[ "${core_update}" == false && "${web_update}" == false && "${FTL_update}" == false ]]; then
+        echo ""
+        echo -e "  ${TICK} Everything is up to date!"
+        exit 0
+    fi
+
+    if [[ "${CHECK_ONLY}" == true ]]; then
+        echo ""
+        exit 0
+    fi
+
+    if [[ "${core_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} Pi-hole core files out of date, updating local repo."
+        getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+        echo -e "  ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
+    fi
+
+    if [[ "${web_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} Pi-hole Web Admin files out of date, updating local repo."
+        getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
+        echo -e "  ${INFO} If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
+    fi
+
+    if [[ "${FTL_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} FTL out of date, it will be updated by the installer."
+    fi
+
+    if [[ "${FTL_update}" == true || "${core_update}" == true ]]; then
+        ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
+        echo -e "${basicError}" && exit 1
+    fi
+
+    if [[ "${FTL_update}" == true || "${core_update}" == true || "${web_update}" == true ]]; then
+        # Force an update of the updatechecker
+        /opt/pihole/updatecheck.sh
+        /opt/pihole/updatecheck.sh x remote
+        echo -e "  ${INFO} Local version file information updated."
+    fi
+
+    echo ""
     exit 0
-
-  elif [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
-    echo ":::"
-    echo "::: Pi-hole Web Admin files out of date"
-    getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
-
-    web_updated=true
-
-  elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
-    echo "::: Pi-hole core files out of date"
-    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
-    /etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
-    core_updated=true
-
-  elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
-    echo "::: Updating Everything"
-    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
-    /etc/.pihole/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
-    web_updated=true
-    core_updated=true
-  else
-    echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
-    exit 1
-  fi
-
-  if [[ "${web_updated}" == true ]]; then
-    web_version_current="$(/usr/local/bin/pihole version --admin --current)"
-    echo ":::"
-    echo "::: Web Admin version is now at ${web_version_current}"
-    echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
-  fi
-
-  if [[ "${core_updated}" == true ]]; then
-    pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
-    echo ":::"
-    echo "::: Pi-hole version is now at ${pihole_version_current}"
-    echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
-  fi
-
-  echo ""
-  exit 0
-
 }
 
+if [[ "$1" == "--check-only" ]]; then
+    CHECK_ONLY=true
+fi
+
 main

advanced/Scripts/updatecheck.sh

@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Checks for local or remote versions and branches
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+# Credit: https://stackoverflow.com/a/46324904
+function json_extract() {
+    local key=$1
+    local json=$2
+
+    local string_regex='"([^"\]|\\.)*"'
+    local number_regex='-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?'
+    local value_regex="${string_regex}|${number_regex}|true|false|null"
+    local pair_regex="\"${key}\"[[:space:]]*:[[:space:]]*(${value_regex})"
+
+    if [[ ${json} =~ ${pair_regex} ]]; then
+        echo $(sed 's/^"\|"$//g' <<< "${BASH_REMATCH[1]}")
+    else
+        return 1
+    fi
+}
+
+function get_local_branch() {
+    # Return active branch
+    cd "${1}" 2> /dev/null || return 1
+    git rev-parse --abbrev-ref HEAD || return 1
+}
+
+function get_local_version() {
+    # Return active branch
+    cd "${1}" 2> /dev/null || return 1
+    git describe --long --dirty --tags 2> /dev/null || return 1
+}
+
+# Source the setupvars config file
+# shellcheck disable=SC1091
+. /etc/pihole/setupVars.conf
+
+if [[ "$2" == "remote" ]]; then
+
+    if [[ "$3" == "reboot" ]]; then
+        sleep 30
+    fi
+
+    GITHUB_VERSION_FILE="/etc/pihole/GitHubVersions"
+
+    GITHUB_CORE_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/pi-hole/releases/latest' 2> /dev/null)")"
+    echo -n "${GITHUB_CORE_VERSION}" > "${GITHUB_VERSION_FILE}"
+    chmod 644 "${GITHUB_VERSION_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        GITHUB_WEB_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/AdminLTE/releases/latest' 2> /dev/null)")"
+        echo -n " ${GITHUB_WEB_VERSION}" >> "${GITHUB_VERSION_FILE}"
+    fi
+
+    GITHUB_FTL_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/FTL/releases/latest' 2> /dev/null)")"
+    echo -n " ${GITHUB_FTL_VERSION}" >> "${GITHUB_VERSION_FILE}"
+
+else
+
+    LOCAL_BRANCH_FILE="/etc/pihole/localbranches"
+
+    CORE_BRANCH="$(get_local_branch /etc/.pihole)"
+    echo -n "${CORE_BRANCH}" > "${LOCAL_BRANCH_FILE}"
+    chmod 644 "${LOCAL_BRANCH_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        WEB_BRANCH="$(get_local_branch /var/www/html/admin)"
+        echo -n " ${WEB_BRANCH}" >> "${LOCAL_BRANCH_FILE}"
+    fi
+
+    FTL_BRANCH="$(pihole-FTL branch)"
+    echo -n " ${FTL_BRANCH}" >> "${LOCAL_BRANCH_FILE}"
+
+    LOCAL_VERSION_FILE="/etc/pihole/localversions"
+
+    CORE_VERSION="$(get_local_version /etc/.pihole)"
+    echo -n "${CORE_VERSION}" > "${LOCAL_VERSION_FILE}"
+    chmod 644 "${LOCAL_VERSION_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        WEB_VERSION="$(get_local_version /var/www/html/admin)"
+        echo -n " ${WEB_VERSION}" >> "${LOCAL_VERSION_FILE}"
+    fi
+
+    FTL_VERSION="$(pihole-FTL version)"
+    echo -n " ${FTL_VERSION}" >> "${LOCAL_VERSION_FILE}"
+
+fi

advanced/Scripts/version.sh

@@ -1,102 +1,217 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# shows version numbers
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Show version numbers
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
-
-# Flags:
-latest=false
-current=false
 
+# Variables
 DEFAULT="-1"
+COREGITDIR="/etc/.pihole/"
+WEBGITDIR="/var/www/html/admin/"
 
-normalOutput() {
+getLocalVersion() {
-	piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+    # FTL requires a different method
-	webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+    if [[ "$1" == "FTL" ]]; then
+        pihole-FTL version
+        return 0
+    fi
 
-	piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+    # Get the tagged version of the local repository
-	webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+    local directory="${1}"
+    local version
 
-	echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
+    cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-	echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
+    version=$(git describe --tags --always || echo "$DEFAULT")
+    if [[ "${version}" =~ ^v ]]; then
+        echo "${version}"
+    elif [[ "${version}" == "${DEFAULT}" ]]; then
+        echo "ERROR"
+        return 1
+    else
+        echo "Untagged"
+    fi
+    return 0
 }
 
-webOutput() {
+getLocalHash() {
-	for var in "$@"; do
+    # Local FTL hash does not exist on filesystem
-		case "${var}" in
+    if [[ "$1" == "FTL" ]]; then
-			"-l" | "--latest"    ) latest=true;;
+        echo "N/A"
-			"-c" | "--current"   ) current=true;;
+        return 0
-			*                    ) echo "::: Invalid Option!"; exit 1;
+    fi
-		esac
-	done
 
-	if [[ "${latest}" == true && "${current}" == false ]]; then
+    # Get the short hash of the local repository
-		webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+    local directory="${1}"
-		echo "${webVersionLatest:--1}"
+    local hash
-	elif [[ "${latest}" == false && "${current}" == true ]]; then
+
-		webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+    cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-		echo "${webVersion}"
+    hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
-	else
+    if [[ "${hash}" == "${DEFAULT}" ]]; then
-		webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+        echo "ERROR"
-		webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+        return 1
-		echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
+    else
-	fi
+        echo "${hash}"
+    fi
+    return 0
 }
 
-coreOutput() {
+getRemoteHash(){
-	for var in "$@"; do
+    # Remote FTL hash is not applicable
-		case "${var}" in
+    if [[ "$1" == "FTL" ]]; then
-			"-l" | "--latest"    ) latest=true;;
+        echo "N/A"
-			"-c" | "--current"   ) current=true;;
+        return 0
-			*                    ) echo "::: Invalid Option!"; exit 1;
+    fi
-		esac
-	done
 
-	if [[ "${latest}" == true && "${current}" == false ]]; then
+    local daemon="${1}"
-		piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+    local branch="${2}"
-		echo "${piholeVersionLatest:--1}"
+
-	elif [[ "${latest}" == false && "${current}" == true ]]; then
+    hash=$(git ls-remote --heads "https://github.com/pi-hole/${daemon}" | \
-		piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+        awk -v bra="$branch" '$0~bra {print substr($0,0,8);exit}')
-		echo "${piholeVersion}"
+    if [[ -n "$hash" ]]; then
-	else
+        echo "$hash"
-		piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+    else
-		piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+        echo "ERROR"
-		echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
+        return 1
-	fi
+    fi
+    return 0
+}
+
+getRemoteVersion(){
+    # Get the version from the remote origin
+    local daemon="${1}"
+    local version
+    local cachedVersions
+    local arrCache
+    cachedVersions="/etc/pihole/GitHubVersions"
+
+    #If the above file exists, then we can read from that. Prevents overuse of GitHub API
+    if [[ -f "$cachedVersions" ]]; then
+        IFS=' ' read -r -a arrCache < "$cachedVersions"
+        case $daemon in
+          "pi-hole"   )  echo "${arrCache[0]}";;
+          "AdminLTE"  )  echo "${arrCache[1]}";;
+          "FTL"       )  echo "${arrCache[2]}";;
+        esac
+
+        return 0
+    fi
+
+    version=$(curl --silent --fail "https://api.github.com/repos/pi-hole/${daemon}/releases/latest" | \
+        awk -F: '$1 ~/tag_name/ { print $2 }' | \
+        tr -cd '[[:alnum:]]._-')
+    if [[ "${version}" =~ ^v ]]; then
+        echo "${version}"
+    else
+        echo "ERROR"
+        return 1
+    fi
+    return 0
+}
+
+getLocalBranch(){
+    # Get the checked out branch of the local directory
+    local directory="${1}"
+    local branch
+
+     # Local FTL btranch is stored in /etc/pihole/ftlbranch
+    if [[ "$1" == "FTL" ]]; then
+        branch="$(pihole-FTL branch)"
+    else
+        cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+        branch=$(git rev-parse --abbrev-ref HEAD || echo "$DEFAULT")
+    fi
+    if [[ ! "${branch}" =~ ^v ]]; then
+        if [[ "${branch}" == "master" ]]; then
+            echo ""
+        elif [[ "${branch}" == "HEAD" ]]; then
+            echo "in detached HEAD state at "
+        else
+            echo "${branch} "
+        fi
+    else
+        # Branch started in "v"
+        echo "release "
+    fi
+    return 0
+}
+
+versionOutput() {
+    [[ "$1" == "pi-hole" ]] && GITDIR=$COREGITDIR
+    [[ "$1" == "AdminLTE" ]] && GITDIR=$WEBGITDIR
+    [[ "$1" == "FTL" ]] && GITDIR="FTL"
+
+    [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion $GITDIR) && branch=$(getLocalBranch $GITDIR)
+    [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "$1")
+    if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
+        [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "$GITDIR") && branch=$(getLocalBranch $GITDIR)
+        [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "$1" "$(cd "$GITDIR" 2> /dev/null && git rev-parse --abbrev-ref HEAD)")
+    fi
+    if [[ -n "$current" ]] && [[ -n "$latest" ]]; then
+        output="${1^} version is $branch$current (Latest: $latest)"
+    elif [[ -n "$current" ]] && [[ -z "$latest" ]]; then
+        output="Current ${1^} version is $branch$current."
+    elif [[ -z "$current" ]] && [[ -n "$latest" ]]; then
+        output="Latest ${1^} version is $latest"
+    elif [[ "$curHash" == "N/A" ]] || [[ "$latHash" == "N/A" ]]; then
+        output="${1^} hash is not applicable"
+    elif [[ -n "$curHash" ]] && [[ -n "$latHash" ]]; then
+        output="${1^} hash is $curHash (Latest: $latHash)"
+    elif [[ -n "$curHash" ]] && [[ -z "$latHash" ]]; then
+        output="Current ${1^} hash is $curHash"
+    elif [[ -z "$curHash" ]] && [[ -n "$latHash" ]]; then
+        output="Latest ${1^} hash is $latHash"
+    else
+        errorOutput
+    fi
+
+    [[ -n "$output" ]] && echo "  $output"
+}
+
+errorOutput() {
+    echo "  Invalid Option! Try 'pihole -v --help' for more information."
+    exit 1
+}
+
+defaultOutput() {
+    # Source the setupvars config file
+    # shellcheck disable=SC1091
+    source /etc/pihole/setupVars.conf
+
+    versionOutput "pi-hole" "$@"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        versionOutput "AdminLTE" "$@"
+    fi
+
+    versionOutput "FTL" "$@"
 }
 
 helpFunc() {
-	cat << EOM
+    echo "Usage: pihole -v [repo | option] [option]
-:::
+Example: 'pihole -v -p -l'
-::: Show Pi-hole/Web Admin versions
+Show Pi-hole, Admin Console & FTL versions
-:::
+
-::: Usage: pihole -v [ -a | -p ] [ -l | -c ]
+Repositories:
-:::
+  -p, --pihole         Only retrieve info regarding Pi-hole repository
-::: Options:
+  -a, --admin          Only retrieve info regarding AdminLTE repository
-:::  -a, --admin          Show both current and latest versions of web admin
+  -f, --ftl            Only retrieve info regarding FTL repository
-:::  -p, --pihole         Show both current and latest versions of Pi-hole core files
+
-:::  -l, --latest         (Only after -a | -p) Return only latest version
+Options:
-:::  -c, --current        (Only after -a | -p) Return only current version
+  -c, --current        Return the current version
-:::  -h, --help           Show this help dialog
+  -l, --latest         Return the latest version
-:::
+  --hash               Return the GitHub hash from your local repositories
-EOM
+  -h, --help           Show this help dialog"
-	exit 0
+  exit 0
 }
 
-if [[ $# = 0 ]]; then
+case "${1}" in
-	normalOutput
+    "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
-fi
+    "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
-
+    "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
-for var in "$@"; do
+    "-h" | "--help"      ) helpFunc;;
-	case "${var}" in
+    *                    ) defaultOutput "$@";;
-	"-a" | "--admin"     ) shift; webOutput "$@";;
+esac
-	"-p" | "--pihole"    ) shift; coreOutput "$@" ;;
-	"-h" | "--help"      ) helpFunc;;
-	esac
-done

advanced/Scripts/wildcard_regex_converter.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Provides an automated migration subroutine to convert Pi-hole v3.x wildcard domains to Pi-hole v4.x regex filters
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+# regexFile set in gravity.sh
+
+wildcardFile="/etc/dnsmasq.d/03-pihole-wildcard.conf"
+
+convert_wildcard_to_regex() {
+    if [ ! -f "${wildcardFile}" ]; then
+        return
+    fi
+    local addrlines domains uniquedomains
+    # Obtain wildcard domains from old file
+    addrlines="$(grep -oE "/.*/" ${wildcardFile})"
+    # Strip "/" from domain names and convert "." to regex-compatible "\."
+    domains="$(sed 's/\///g;s/\./\\./g' <<< "${addrlines}")"
+    # Remove repeated domains (may have been inserted two times due to A and AAAA blocking)
+    uniquedomains="$(uniq <<< "${domains}")"
+    # Automatically generate regex filters and remove old wildcards file
+    awk '{print "(^|\\.)"$0"$"}' <<< "${uniquedomains}" >> "${regexFile:?}" && rm "${wildcardFile}"
+}

advanced/Templates/gravity.db.sql

@@ -0,0 +1,190 @@
+PRAGMA foreign_keys=OFF;
+BEGIN TRANSACTION;
+
+CREATE TABLE "group"
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	name TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	description TEXT
+);
+INSERT INTO "group" (id,enabled,name,description) VALUES (0,1,'Default','The default group');
+
+CREATE TABLE domainlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	type INTEGER NOT NULL DEFAULT 0,
+	domain TEXT NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT,
+	UNIQUE(domain, type)
+);
+
+CREATE TABLE adlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	address TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT,
+	date_updated INTEGER
+);
+
+CREATE TABLE adlist_by_group
+(
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (adlist_id, group_id)
+);
+
+CREATE TABLE gravity
+(
+	domain TEXT NOT NULL,
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id)
+);
+
+CREATE TABLE info
+(
+	property TEXT PRIMARY KEY,
+	value TEXT NOT NULL
+);
+
+INSERT INTO "info" VALUES('version','13');
+
+CREATE TABLE domain_audit
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int))
+);
+
+CREATE TABLE domainlist_by_group
+(
+	domainlist_id INTEGER NOT NULL REFERENCES domainlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (domainlist_id, group_id)
+);
+
+CREATE TABLE client
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	ip TEXT NOT NULL UNIQUE,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+CREATE TABLE client_by_group
+(
+	client_id INTEGER NOT NULL REFERENCES client (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (client_id, group_id)
+);
+
+CREATE TRIGGER tr_adlist_update AFTER UPDATE OF address,enabled,comment ON adlist
+    BEGIN
+      UPDATE adlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_client_update AFTER UPDATE ON client
+    BEGIN
+      UPDATE client SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE ip = NEW.ip;
+    END;
+
+CREATE TRIGGER tr_domainlist_update AFTER UPDATE ON domainlist
+    BEGIN
+      UPDATE domainlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+CREATE VIEW vw_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 0
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 1
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_regex_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 2
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_regex_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 3
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_gravity AS SELECT domain, adlist_by_group.group_id AS group_id
+    FROM gravity
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = gravity.adlist_id
+    LEFT JOIN adlist ON adlist.id = gravity.adlist_id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1);
+
+CREATE VIEW vw_adlist AS SELECT DISTINCT address, adlist.id AS id
+    FROM adlist
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = adlist.id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY adlist.id;
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Default');
+    END;
+
+CREATE TRIGGER tr_domainlist_delete AFTER DELETE ON domainlist
+    BEGIN
+      DELETE FROM domainlist_by_group WHERE domainlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_adlist_delete AFTER DELETE ON adlist
+    BEGIN
+      DELETE FROM adlist_by_group WHERE adlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_client_delete AFTER DELETE ON client
+    BEGIN
+      DELETE FROM client_by_group WHERE client_id = OLD.id;
+    END;
+
+COMMIT;

advanced/Templates/gravity_copy.sql

@@ -0,0 +1,42 @@
+.timeout 30000
+
+ATTACH DATABASE '/etc/pihole/gravity.db' AS OLD;
+
+BEGIN TRANSACTION;
+
+DROP TRIGGER tr_domainlist_add;
+DROP TRIGGER tr_client_add;
+DROP TRIGGER tr_adlist_add;
+
+INSERT OR REPLACE INTO "group" SELECT * FROM OLD."group";
+INSERT OR REPLACE INTO domain_audit SELECT * FROM OLD.domain_audit;
+
+INSERT OR REPLACE INTO domainlist SELECT * FROM OLD.domainlist;
+INSERT OR REPLACE INTO domainlist_by_group SELECT * FROM OLD.domainlist_by_group;
+
+INSERT OR REPLACE INTO adlist SELECT * FROM OLD.adlist;
+INSERT OR REPLACE INTO adlist_by_group SELECT * FROM OLD.adlist_by_group;
+
+INSERT OR REPLACE INTO info SELECT * FROM OLD.info;
+
+INSERT OR REPLACE INTO client SELECT * FROM OLD.client;
+INSERT OR REPLACE INTO client_by_group SELECT * FROM OLD.client_by_group;
+
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+
+COMMIT;

advanced/Templates/logrotate

@@ -0,0 +1,21 @@
+/var/log/pihole.log {
+	# su #
+	daily
+	copytruncate
+	rotate 5
+	compress
+	delaycompress
+	notifempty
+	nomail
+}
+
+/var/log/pihole-FTL.log {
+	# su #
+	weekly
+	copytruncate
+	rotate 3
+	compress
+	delaycompress
+	notifempty
+	nomail
+}

advanced/Templates/pihole-FTL.service

@@ -0,0 +1,108 @@
+#!/usr/bin/env bash
+### BEGIN INIT INFO
+# Provides:          pihole-FTL
+# Required-Start:    $remote_fs $syslog $network
+# Required-Stop:     $remote_fs $syslog $network
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: pihole-FTL daemon
+# Description:       Enable service provided by pihole-FTL daemon
+### END INIT INFO
+
+FTLUSER=pihole
+PIDFILE=/run/pihole-FTL.pid
+
+is_running() {
+    pgrep -o "pihole-FTL" > /dev/null 2>&1
+}
+
+
+# Start the service
+start() {
+  if is_running; then
+    echo "pihole-FTL is already running"
+  else
+    # Touch files to ensure they exist (create if non-existing, preserve if existing)
+    touch /var/log/pihole-FTL.log /var/log/pihole.log
+    touch /run/pihole-FTL.pid /run/pihole-FTL.port
+    touch /etc/pihole/dhcp.leases
+    mkdir -p /run/pihole
+    mkdir -p /var/log/pihole
+    chown pihole:pihole /run/pihole /var/log/pihole
+    # Remove possible leftovers from previous pihole-FTL processes
+    rm -f /dev/shm/FTL-* 2> /dev/null
+    rm /run/pihole/FTL.sock 2> /dev/null
+    # Ensure that permissions are set so that pihole-FTL can edit all necessary files
+    chown pihole:pihole /run/pihole-FTL.pid /run/pihole-FTL.port
+    chown pihole:pihole /etc/pihole /etc/pihole/dhcp.leases 2> /dev/null
+    chown pihole:pihole /var/log/pihole-FTL.log /var/log/pihole.log
+    chmod 0644 /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port /var/log/pihole.log
+    # Chown database files to the user FTL runs as. We ignore errors as the files may not (yet) exist
+    chown pihole:pihole /etc/pihole/pihole-FTL.db /etc/pihole/gravity.db 2> /dev/null
+    if setcap CAP_NET_BIND_SERVICE,CAP_NET_RAW,CAP_NET_ADMIN,CAP_SYS_NICE+eip "$(which pihole-FTL)"; then
+      su -s /bin/sh -c "/usr/bin/pihole-FTL" "$FTLUSER"
+    else
+      echo "Warning: Starting pihole-FTL as root because setting capabilities is not supported on this system"
+      pihole-FTL
+    fi
+    echo
+  fi
+}
+
+# Stop the service
+stop() {
+  if is_running; then
+    pkill -o pihole-FTL
+    for i in {1..5}; do
+      if ! is_running; then
+        break
+      fi
+
+      echo -n "."
+      sleep 1
+    done
+    echo
+
+    if is_running; then
+      echo "Not stopped; may still be shutting down or shutdown may have failed, killing now"
+      pkill -o -9 pihole-FTL
+      exit 1
+    else
+      echo "Stopped"
+    fi
+  else
+    echo "Not running"
+  fi
+  echo
+}
+
+# Indicate the service status
+status() {
+  if is_running; then
+    echo "[ ok ] pihole-FTL is running"
+    exit 0
+  else
+    echo "[    ] pihole-FTL is not running"
+    exit 1
+  fi
+}
+
+
+### main logic ###
+case "$1" in
+  stop)
+        stop
+        ;;
+  status)
+        status
+        ;;
+  start|restart|reload|condrestart)
+        stop
+        start
+        ;;
+  *)
+        echo $"Usage: $0 {start|stop|restart|reload|status}"
+        exit 1
+esac
+
+exit 0

advanced/Templates/pihole.cron

@@ -0,0 +1,36 @@
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Updates ad sources every week
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#
+#
+#
+# This file is under source-control of the Pi-hole installation and update
+# scripts, any changes made to this file will be overwritten when the software
+# is updated or re-installed. Please make any changes to the appropriate crontab
+# or other cron file snippets.
+
+# Pi-hole: Update the ad sources once a week on Sunday at a random time in the
+#          early morning. Download any updates from the adlists
+#          Squash output to log, then splat the log to stdout on error to allow for
+#          standard crontab job error handling.
+59 1    * * 7   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updateGravity >/var/log/pihole_updateGravity.log || cat /var/log/pihole_updateGravity.log
+
+# Pi-hole: Flush the log daily at 00:00
+#          The flush script will use logrotate if available
+#          parameter "once": logrotate only once (default is twice)
+#          parameter "quiet": don't print messages
+00 00   * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole flush once quiet
+
+@reboot root /usr/sbin/logrotate /etc/pihole/logrotate
+
+# Pi-hole: Grab local version and branch every 10 minutes
+*/10 *  * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker local
+
+# Pi-hole: Grab remote version every 24 hours
+59 17  * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker remote
+@reboot root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker remote reboot

advanced/Templates/pihole.sudo

@@ -0,0 +1,9 @@
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Allows the WebUI to use Pi-hole commands
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#

advanced/bash-completion/pihole

@@ -1,11 +1,79 @@
 _pihole() {
-	local cur prev opts
+	local cur prev opts opts_admin opts_checkout opts_chronometer opts_debug opts_interface  opts_logging opts_privacy opts_query opts_update opts_version
 	COMPREPLY=()
 	cur="${COMP_WORDS[COMP_CWORD]}"
 	prev="${COMP_WORDS[COMP_CWORD-1]}"
-	opts="admin blacklist chronometer debug disable enable flush help logging query reconfigure restartdns setupLCD status tail uninstall updateGravity updatePihole version whitelist"
+	prev2="${COMP_WORDS[COMP_CWORD-2]}"
 
-	COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+	case "${prev}" in
+		"pihole")
+			opts="admin blacklist checkout chronometer debug disable enable flush help logging query reconfigure regex restartdns status tail uninstall updateGravity updatePihole version wildcard whitelist arpflush"
+			COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+		;;
+		"whitelist"|"blacklist"|"wildcard"|"regex")
+			opts_lists="\--delmode \--noreload \--quiet \--list \--nuke"
+			COMPREPLY=( $(compgen -W "${opts_lists}" -- ${cur}) )
+		;;
+		"admin")
+			opts_admin="celsius email fahrenheit interface kelvin password privacylevel"
+			COMPREPLY=( $(compgen -W "${opts_admin}" -- ${cur}) )
+		;;
+		"checkout")
+			opts_checkout="core ftl web master dev"
+			COMPREPLY=( $(compgen -W "${opts_checkout}" -- ${cur}) )
+		;;
+		"chronometer")
+			opts_chronometer="\--exit \--json \--refresh"
+			COMPREPLY=( $(compgen -W "${opts_chronometer}" -- ${cur}) )
+		;;
+		"debug")
+			opts_debug="-a"
+			COMPREPLY=( $(compgen -W "${opts_debug}" -- ${cur}) )
+		;;
+		"logging")
+			opts_logging="on off 'off noflush'"
+			COMPREPLY=( $(compgen -W "${opts_logging}" -- ${cur}) )
+		;;
+		"query")
+			opts_query="-adlist -all -exact"
+			COMPREPLY=( $(compgen -W "${opts_query}" -- ${cur}) )
+		;;
+		"updatePihole"|"-up")
+			opts_update="--check-only"
+			COMPREPLY=( $(compgen -W "${opts_update}" -- ${cur}) )
+		;;
+		"version")
+			opts_version="\--admin \--current \--ftl \--hash \--latest \--pihole"
+			COMPREPLY=( $(compgen -W "${opts_version}" -- ${cur}) )
+		;;
+		"interface")
+			if ( [[ "$prev2" == "admin" ]] || [[ "$prev2" == "-a" ]] ); then
+				opts_interface="$(cat /proc/net/dev | cut -d: -s -f1)"
+				COMPREPLY=( $(compgen -W "${opts_interface}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		"privacylevel")
+			if ( [[ "$prev2" == "admin" ]] || [[ "$prev2" == "-a" ]] ); then
+				opts_privacy="0 1 2 3"
+				COMPREPLY=( $(compgen -W "${opts_privacy}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		"core"|"admin"|"ftl")
+			if [[ "$prev2" == "checkout" ]]; then
+				opts_checkout="master dev"
+				COMPREPLY=( $(compgen -W "${opts_checkout}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		*)
+		return 1
+		;;
+	esac
 	return 0
 }
 complete -F _pihole pihole

advanced/blockingpage.css

@@ -0,0 +1,393 @@
+/* Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL.
+*  Please see LICENSE file for your rights under this license. */
+
+/* Text Customisation Options ======> */
+.title::before { content: "Website Blocked"; }
+.altBtn::before { content: "Why am I here?"; }
+.linkPH::before { content: "About Pi-hole"; }
+.linkEmail::before { content: "Contact Admin"; }
+
+#bpOutput.add::before { content: "Info"; }
+#bpOutput.add::after { content: "The domain is being whitelisted..."; }
+#bpOutput.error::before, .unhandled::before { content: "Error"; }
+#bpOutput.unhandled::after { content: "An unhandled exception occurred. This may happen when your browser is unable to load jQuery, or when the webserver is denying access to the Pi-hole API."; }
+#bpOutput.success::before { content: "Success"; }
+#bpOutput.success::after { content: "Website has been whitelisted! You may need to flush your DNS cache"; }
+
+.recentwl::before { content: "This site has been whitelisted. Please flush your DNS cache and/or restart your browser."; }
+.unknown::before { content: "This website is not found in any of Pi-hole's blacklists. The reason you have arrived here is unknown."; }
+.cname::before { content: "This site is an alias for "; } /* <a href="http://cname.com">cname.com</a> */
+.cname::after { content: ", which may be blocked by Pi-hole."; }
+
+.blacklist::before { content: "Manually Blacklisted"; }
+.wildcard::before { content: "Manually Blacklisted by Wildcard"; }
+.noblock::before { content: "Not found on any Blacklist"; }
+
+#bpBlock::before { content: "Access to the following website has been denied:"; }
+#bpFlag::before { content: "This is primarily due to being flagged as:"; }
+
+#bpHelpTxt::before { content: "If you have an ongoing use for this website, please "; }
+#bpHelpTxt a::before, #bpHelpTxt span::before { content: "ask the administrator"; }
+#bpHelpTxt::after{ content: " of the Pi-hole on this network to have it whitelisted"; }
+
+#bpBack::before { content: "Back to safety"; }
+#bpInfo::before { content: "Technical Info"; }
+#bpFoundIn::before { content: "This site is found in "; }
+#bpFoundIn span::after { content: " of "; }
+#bpFoundIn::after { content: " lists:"; }
+#bpWhitelist::before { content: "Whitelist"; }
+
+footer span::before { content: "Page generated on "; }
+
+/* Hide whitelisting form entirely */
+/* #bpWLButtons { display: none; } */
+
+/* Text Customisation Options <=============================== */
+
+/* http://necolas.github.io/normalize.css ======> */
+html { font-family: sans-serif; line-height: 1.15; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; }
+body { margin: 0; }
+article, aside, footer, header, nav, section { display: block; }
+h1 { font-size: 2em; margin: 0.67em 0; }
+figcaption, figure, main { display: block; }
+figure { margin: 1em 40px; }
+hr { box-sizing: content-box; height: 0; overflow: visible; }
+pre { font-family: monospace, monospace; font-size: 1em; }
+a { background-color: transparent; -webkit-text-decoration-skip: objects; }
+a:active, a:hover { outline-width: 0; }
+abbr[title] { border-bottom: none; text-decoration: underline; text-decoration: underline dotted; }
+b, strong { font-weight: inherit; }
+b, strong { font-weight: bolder; }
+code, kbd, samp { font-family: monospace, monospace; font-size: 1em; }
+dfn { font-style: italic; }
+mark { background-color: #ff0; color: #000; }
+small { font-size: 80%; }
+sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
+sub { bottom: -0.25em; }
+sup { top: -0.5em; }
+audio, video { display: inline-block; }
+audio:not([controls]) { display: none; height: 0; }
+img { border-style: none; }
+svg:not(:root) { overflow: hidden; }
+button, input, optgroup, select, textarea { font-family: sans-serif; font-size: 100%; line-height: 1.15; margin: 0; }
+button, input { overflow: visible; }
+button, select { text-transform: none; }
+button, html [type="button"], [type="reset"], [type="submit"] { -webkit-appearance: button; }
+button::-moz-focus-inner, [type="button"]::-moz-focus-inner, [type="reset"]::-moz-focus-inner, [type="submit"]::-moz-focus-inner { border-style: none; padding: 0; }
+button:-moz-focusring, [type="button"]:-moz-focusring, [type="reset"]:-moz-focusring, [type="submit"]:-moz-focusring { outline: 1px dotted ButtonText; }
+fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
+legend { box-sizing: border-box; color: inherit; display: table; max-width: 100%; padding: 0; white-space: normal; }
+progress { display: inline-block; vertical-align: baseline; }
+textarea { overflow: auto; }
+[type="checkbox"], [type="radio"] { box-sizing: border-box; padding: 0; }
+[type="number"]::-webkit-inner-spin-button, [type="number"]::-webkit-outer-spin-button { height: auto; }
+[type="search"] { -webkit-appearance: textfield; outline-offset: -2px; }
+[type="search"]::-webkit-search-cancel-button, [type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
+::-webkit-file-upload-button { -webkit-appearance: button; font: inherit; }
+details, menu { display: block; }
+summary { display: list-item; }
+canvas { display: inline-block; }
+template { display: none; }
+[hidden] { display: none; }
+/* Normalize.css <=============================== */
+
+html { font-size: 62.5%; }
+
+a { color: #3c8dbc; text-decoration: none; }
+a:hover { color: #72afda; text-decoration: underline; }
+b { color: rgb(68, 68, 68); }
+p { margin: 0; }
+
+label, .buttons a {
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}
+
+label, .buttons *:not([disabled]) { cursor: pointer; }
+
+/* Touch device dark tap highlight */
+header h1 a, label, .buttons * { -webkit-tap-highlight-color: transparent; }
+
+/* Webkit Focus Glow */
+textarea, input, button { outline: none; }
+
+@font-face {
+  font-family: "Source Sans Pro";
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local("Source Sans Pro Regular"), local("SourceSansPro-Regular"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-regular.woff2") format("woff2"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-regular.woff") format("woff");
+}
+
+@font-face {
+  font-family: "Source Sans Pro";
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: local("Source Sans Pro Bold"), local("SourceSansPro-Bold"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-700.woff2") format("woff2"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-700.woff") format("woff");
+}
+
+body {
+  background: #dbdbdb url("/admin/img/boxed-bg.jpg") repeat fixed;
+  color: #333;
+  font: 1.4rem "Source Sans Pro", "Helvetica Neue", Helvetica, Arial, sans-serif;
+  line-height: 2.2rem;
+}
+
+/* User is greeted with a splash page when browsing to Pi-hole IP address */
+#splashpage { background: #222; color: rgba(255, 255, 255, 0.7); text-align: center; }
+#splashpage img { margin: 5px; width: 256px; }
+#splashpage b { color: inherit; }
+
+#bpWrapper {
+  margin: 0 auto;
+  max-width: 1250px;
+  box-shadow: 0 0 8px rgba(0, 0, 0, 0.5);
+}
+
+header {
+  background: #3c8dbc;
+  display: table;
+  position: relative;
+  width: 100%;
+}
+
+header h1, header h1 a, header .spc, header #bpAlt label {
+  display: table-cell;
+  color: #fff;
+  white-space: nowrap;
+  vertical-align: middle;
+  height: 50px; /* Must match #bpAbout top value */
+}
+
+h1 a {
+  background-color: rgba(0, 0, 0, 0.1);
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+  font-size: 2rem;
+  font-weight: 400;
+  min-width: 230px;
+  text-align: center;
+}
+
+h1 a:hover, header #bpAlt:hover { background-color: rgba(0, 0, 0, 0.12); color: inherit; text-decoration: none; }
+
+header .spc { width: 100%; }
+
+header #bpAlt label {
+  background: url("/admin/img/logo.svg") no-repeat center left 15px;
+  background-size: 15px 23px;
+  padding: 0 15px;
+  text-indent: 30px;
+}
+
+[type="checkbox"][id$="Toggle"] { display: none; }
+[type="checkbox"][id$="Toggle"]:checked ~ #bpAbout,
+[type="checkbox"][id$="Toggle"]:checked ~ #bpMoreInfo {
+  display: block;
+}
+
+/* Click anywhere else on screen to hide #bpAbout */
+#bpAboutToggle:checked {
+  display: block;
+  height: 300px; /* VH Fallback */
+  height: 100vh;
+  left: 0;
+  top: 0;
+  opacity: 0;
+  position: absolute;
+  width: 100%;
+}
+
+#bpAbout {
+  background: #3c8dbc;
+  border-bottom-left-radius: 5px;
+  border: 1px solid #fff;
+  border-right-width: 0;
+  box-shadow: -1px 1px 1px rgba(0, 0, 0, 0.12);
+  box-sizing: border-box;
+  display: none;
+  font-size: 1.7rem;
+  top: 50px;
+  position: absolute;
+  right: 0;
+  width: 280px;
+  z-index: 1;
+}
+
+.aboutPH {
+  box-sizing: border-box;
+  color: rgba(255, 255, 255, 0.8);
+  display: block;
+  padding: 10px;
+  width: 100%;
+  text-align: center;
+}
+
+.aboutImg {
+  background: url("/admin/img/logo.svg") no-repeat center;
+  background-size: 90px 90px;
+  height: 90px;
+  margin: 0 auto;
+  padding: 2px;
+  width: 90px;
+}
+
+.aboutPH p { margin: 10px 0; }
+.aboutPH small { display: block; font-size: 1.2rem; }
+
+.aboutLink {
+  background: #fff;
+  border-top: 1px solid #ddd;
+  display: table;
+  font-size: 1.4rem;
+  text-align: center;
+  width: 100%;
+}
+
+.aboutLink a {
+  display: table-cell;
+  padding: 14px;
+  min-width: 50%;
+}
+
+main {
+  background: #ecf0f5;
+  font-size: 1.65rem;
+  padding: 10px;
+}
+
+#bpOutput {
+  background: #00c0ef;
+  border-radius: 3px;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+  color: #fff;
+  font-size: 1.4rem;
+  margin-bottom: 10px;
+  margin-top: 5px;
+  padding: 15px;
+}
+
+#bpOutput::before {
+  background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='7' height='14' viewBox='0 0 7 14'%3E%3Cpath fill='%23fff' d='M6 11a1.371 1.371 0 011 1v1a1.371 1.371 0 01-1 1H1a1.371 1.371 0 01-1-1v-1a1.371 1.371 0 011-1h1V8H1a1.371 1.371 0 01-1-1V6a1.371 1.371 0 011-1h3a1.371 1.371 0 011 1v5h1zM3.5 0A1.5 1.5 0 112 1.5 1.5 1.5 0 013.5 0z'/%3E%3C/svg%3E") no-repeat center left;
+  display: block;
+  font-size: 1.8rem;
+  text-indent: 15px;
+}
+
+#bpOutput.hidden { display: none; }
+#bpOutput.success { background: #00a65a; }
+#bpOutput.error { background: #dd4b39; }
+
+.blockMsg, .flagMsg {
+  font: 700 1.8rem Consolas, Courier, monospace;
+  padding: 5px 10px 10px;
+  text-indent: 15px;
+}
+
+#bpHelpTxt { padding-bottom: 10px; }
+
+.buttons {
+  border-spacing: 5px 0;
+  display: table;
+  width: 100%;
+}
+
+.buttons * {
+  -moz-appearance: none;
+  -webkit-appearance: none;
+  border-radius: 3px;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+  box-sizing: content-box;
+  display: table-cell;
+  font-size: 1.65rem;
+  margin-right: 5px;
+  min-height: 20px;
+  padding: 6px 12px;
+  position: relative;
+  text-align: center;
+  vertical-align: top;
+  white-space: nowrap;
+  width: auto;
+}
+
+.buttons a:hover { text-decoration: none; }
+
+/* Button hover dark overlay */
+.buttons *:not(input):not([disabled]):hover {
+  background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0.1), rgba(0, 0, 0, 0.1));
+  color: #fff;
+}
+
+/* Button active shadow inset */
+.buttons *:not([disabled]):not(input):active {
+  box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+}
+
+/* Input border color */
+.buttons *:not([disabled]):hover, .buttons input:focus {
+  border-color: rgba(0, 0, 0, 0.25);
+}
+
+#bpButtons *  { width: 50%; color: #fff; }
+#bpBack       { background-color: #00a65a; }
+#bpInfo       { background-color: #3c8dbc; }
+#bpWhitelist  { background-color: #dd4b39; }
+
+#blockpage .buttons [type="password"][disabled] { color: rgba(0, 0, 0, 1); }
+#blockpage .buttons [disabled] { color: rgba(0, 0, 0, 0.55); background-color: #e3e3e3; }
+#blockpage .buttons [type="password"]:-ms-input-placeholder { color: rgba(51, 51, 51, 0.8); }
+
+input[type="password"] { font-size: 1.5rem; }
+
+@-webkit-keyframes slidein { from { max-height: 0; opacity: 0; } to { max-height: 300px; opacity: 1; } }
+
+@keyframes slidein { from { max-height: 0; opacity: 0; } to { max-height: 300px; opacity: 1; } }
+#bpMoreToggle:checked ~ #bpMoreInfo { display: block; margin-top: 8px; -webkit-animation: slidein 0.05s linear; animation: slidein 0.05s linear; }
+#bpMoreInfo { display: none; margin-top: 10px; }
+
+#bpQueryOutput {
+  font-size: 1.2rem;
+  line-height: 1.65rem;
+  margin: 5px 0 0;
+  overflow: auto;
+  padding: 0 5px;
+  -webkit-overflow-scrolling: touch;
+}
+
+#bpQueryOutput span { margin-right: 4px; }
+
+#bpWLButtons { width: auto; margin-top: 10px; }
+#bpWLButtons * { display: inline-block; }
+#bpWLDomain { display: none; }
+#bpWLPassword { width: 160px; }
+#bpWhitelist { color: #fff; }
+
+footer {
+  background: #fff;
+  border-top: 1px solid #d2d6de;
+  color: #444;
+  font: 1.2rem Consolas, Courier, monospace;
+  padding: 8px;
+}
+
+/* Responsive Content */
+@media only screen and (max-width: 500px) {
+  h1 a { font-size: 1.8rem; min-width: 170px; }
+  footer span::before { content: "Generated "; }
+  footer span { display: block; }
+}
+
+@media only screen and (min-width: 1251px) {
+  #bpWrapper, footer { border-radius: 0 0 5px 5px; }
+  #bpAbout { border-right-width: 1px; }
+}

advanced/dnsmasq.conf.original

@@ -46,7 +46,7 @@
 #resolv-file=
 
 # By  default,  dnsmasq  will  send queries to any of the upstream
-# servers it knows about and tries to favour servers to are  known
+# servers it knows about and tries to favor servers to are  known
 # to  be  up.  Uncommenting this forces dnsmasq to try each query
 # with  each  server  strictly  in  the  order  they   appear   in
 # /etc/resolv.conf
@@ -189,7 +189,7 @@
 # add names to the DNS for the IPv6 address of SLAAC-configured dual-stack
 # hosts. Use the DHCPv4 lease to derive the name, network segment and
 # MAC address and assume that the host will also have an
-# IPv6 address calculated using the SLAAC alogrithm.
+# IPv6 address calculated using the SLAAC algorithm.
 #dhcp-range=1234::, ra-names
 
 # Do Router Advertisements, BUT NOT DHCP for this subnet.
@@ -210,7 +210,7 @@
 #dhcp-range=1234::, ra-stateless, ra-names
 
 # Do router advertisements for all subnets where we're doing DHCPv6
-# Unless overriden by ra-stateless, ra-names, et al, the router
+# Unless overridden by ra-stateless, ra-names, et al, the router
 # advertisements will have the M and O bits set, so that the clients
 # get addresses and configuration from DHCPv6, and the A bit reset, so the
 # clients don't use SLAAC addresses.
@@ -281,7 +281,7 @@
 # Give a fixed IPv6 address and name to client with
 # DUID 00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2
 # Note the MAC addresses CANNOT be used to identify DHCPv6 clients.
-# Note also the they [] around the IPv6 address are obilgatory.
+# Note also the they [] around the IPv6 address are obligatory.
 #dhcp-host=id:00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2, fred, [1234::5]
 
 # Ignore any clients which are not specified in dhcp-host lines
@@ -404,14 +404,14 @@
 #dhcp-option=vendor:MSFT,2,1i
 
 # Send the Encapsulated-vendor-class ID needed by some configurations of
-# Etherboot to allow is to recognise the DHCP server.
+# Etherboot to allow is to recognize the DHCP server.
 #dhcp-option=vendor:Etherboot,60,"Etherboot"
 
 # Send options to PXELinux. Note that we need to send the options even
 # though they don't appear in the parameter request list, so we need
 # to use dhcp-option-force here.
 # See http://syslinux.zytor.com/pxe.php#special for details.
-# Magic number - needed before anything else is recognised
+# Magic number - needed before anything else is recognized
 #dhcp-option-force=208,f1:00:74:7e
 # Configuration file name
 #dhcp-option-force=209,configs/common

advanced/dphys-swapfile

@@ -1,12 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Swap file config
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-CONF_SWAPSIZE=500

advanced/index.html

@@ -1,7 +0,0 @@
-<html>
-<head>
-<script>window.close();</script>
-</head>
-<body>
-</body>
-</html>

advanced/index.js

@@ -1 +0,0 @@
-var x = "Pi-hole: A black hole for Internet advertisements."

advanced/index.php

@@ -0,0 +1,393 @@
+<?php
+/* Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL.
+*  Please see LICENSE file for your rights under this license. */
+
+// Sanitize SERVER_NAME output
+$serverName = htmlspecialchars($_SERVER["SERVER_NAME"]);
+// Remove external ipv6 brackets if any
+$serverName = preg_replace('/^\[(.*)\]$/', '${1}', $serverName);
+
+if (!is_file("/etc/pihole/setupVars.conf"))
+  die("[ERROR] File not found: <code>/etc/pihole/setupVars.conf</code>");
+
+// Get values from setupVars.conf
+$setupVars = parse_ini_file("/etc/pihole/setupVars.conf");
+$svPasswd = !empty($setupVars["WEBPASSWORD"]);
+$svEmail = (!empty($setupVars["ADMIN_EMAIL"]) && filter_var($setupVars["ADMIN_EMAIL"], FILTER_VALIDATE_EMAIL)) ? $setupVars["ADMIN_EMAIL"] : "";
+unset($setupVars);
+
+// Set landing page location, found within /var/www/html/
+$landPage = "../landing.php";
+
+// Define array for hostnames to be accepted as self address for splash page
+$authorizedHosts = [ "localhost" ];
+if (!empty($_SERVER["FQDN"])) {
+    // If setenv.add-environment = ("fqdn" => "true") is configured in lighttpd,
+    // append $serverName to $authorizedHosts
+    array_push($authorizedHosts, $serverName);
+} else if (!empty($_SERVER["VIRTUAL_HOST"])) {
+    // Append virtual hostname to $authorizedHosts
+    array_push($authorizedHosts, $_SERVER["VIRTUAL_HOST"]);
+}
+
+// Set which extension types render as Block Page (Including "" for index.ext)
+$validExtTypes = array("asp", "htm", "html", "php", "rss", "xml", "");
+
+// Get extension of current URL
+$currentUrlExt = pathinfo($_SERVER["REQUEST_URI"], PATHINFO_EXTENSION);
+
+// Set mobile friendly viewport
+$viewPort = '<meta name="viewport" content="width=device-width, initial-scale=1">';
+
+// Set response header
+function setHeader($type = "x") {
+    header("X-Pi-hole: A black hole for Internet advertisements.");
+    if (isset($type) && $type === "js") header("Content-Type: application/javascript");
+}
+
+// Determine block page type
+if ($serverName === "pi.hole"
+    || (!empty($_SERVER["VIRTUAL_HOST"]) && $serverName === $_SERVER["VIRTUAL_HOST"])) {
+    // Redirect to Web Interface
+    exit(header("Location: /admin"));
+} elseif (filter_var($serverName, FILTER_VALIDATE_IP) || in_array($serverName, $authorizedHosts)) {
+    // When directly browsing via IP or authorized hostname
+    // Render splash/landing page based off presence of $landPage file
+    // Unset variables so as to not be included in $landPage or $splashPage
+    unset($serverName, $svPasswd, $svEmail, $authorizedHosts, $validExtTypes, $currentUrlExt, $viewPort);
+    // If $landPage file is present
+    if (is_file(getcwd()."/$landPage")) {
+        include $landPage;
+        exit();
+    }
+    // If $landPage file was not present, Set Splash Page output
+    $splashPage = "
+    <!doctype html>
+    <html lang='en'>
+        <head>
+            <meta charset='utf-8'>
+            $viewPort
+            <title>● $serverName</title>
+            <link rel='stylesheet' href='pihole/blockingpage.css'>
+            <link rel='shortcut icon' href='admin/img/favicons/favicon.ico' type='image/x-icon'>
+        </head>
+        <body id='splashpage'>
+            <img src='admin/img/logo.svg' alt='Pi-hole logo' width='256' height='377'>
+            <br>
+            <p>Pi-<strong>hole</strong>: Your black hole for Internet advertisements</p>
+            <a href='/admin'>Did you mean to go to the admin panel?</a>
+        </body>
+    </html>
+    ";
+    exit($splashPage);
+} elseif ($currentUrlExt === "js") {
+    // Serve Pi-hole JavaScript for blocked domains requesting JS
+    exit(setHeader("js").'var x = "Pi-hole: A black hole for Internet advertisements."');
+} elseif (strpos($_SERVER["REQUEST_URI"], "?") !== FALSE && isset($_SERVER["HTTP_REFERER"])) {
+    // Serve blank image upon receiving REQUEST_URI w/ query string & HTTP_REFERRER
+    // e.g: An iframe of a blocked domain
+    exit(setHeader().'<!doctype html>
+    <html lang="en">
+        <head>
+            <meta charset="utf-8"><script>window.close();</script>
+        </head>
+        <body>
+            <img src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=">
+        </body>
+    </html>');
+} elseif (!in_array($currentUrlExt, $validExtTypes) || substr_count($_SERVER["REQUEST_URI"], "?")) {
+    // Serve SVG upon receiving non $validExtTypes URL extension or query string
+    // e.g: Not an iframe of a blocked domain, such as when browsing to a file/query directly
+    // QoL addition: Allow the SVG to be clicked on in order to quickly show the full Block Page
+    $blockImg = '<a href="/">
+    <svg xmlns="http://www.w3.org/2000/svg" width="110" height="16">
+      <circle cx="8" cy="8" r="7" fill="none" stroke="rgba(152,2,2,.5)" stroke-width="2"/>
+      <path fill="rgba(152,2,2,.5)" d="M11.526 3.04l1.414 1.415-8.485 8.485-1.414-1.414z"/>
+      <text x="19.3" y="12" opacity=".3" style="font:11px Arial">
+        Blocked by Pi-hole
+      </text>
+    </svg>
+    </a>';
+    exit(setHeader()."<!doctype html>
+    <html lang='en'>
+        <head>
+            <meta charset='utf-8'>
+            $viewPort
+        </head>
+        <body>$blockImg</body>
+    </html>");
+}
+
+/* Start processing Block Page from here */
+
+// Define admin email address text based off $svEmail presence
+$bpAskAdmin = !empty($svEmail) ? '<a href="mailto:'.$svEmail.'?subject=Site Blocked: '.$serverName.'"></a>' : "<span/>";
+
+// Get possible non-standard location of FTL's database
+$FTLsettings = parse_ini_file("/etc/pihole/pihole-FTL.conf");
+if (isset($FTLsettings["GRAVITYDB"])) {
+    $gravityDBFile = $FTLsettings["GRAVITYDB"];
+} else {
+    $gravityDBFile = "/etc/pihole/gravity.db";
+}
+
+// Connect to gravity.db
+try {
+    $db = new SQLite3($gravityDBFile, SQLITE3_OPEN_READONLY);
+} catch (Exception $exception) {
+    die("[ERROR]: Failed to connect to gravity.db");
+}
+
+// Get all adlist addresses
+$adlistResults = $db->query("SELECT address FROM vw_adlist");
+$adlistsUrls = array();
+while ($row = $adlistResults->fetchArray()) {
+    array_push($adlistsUrls, $row[0]);
+}
+
+if (empty($adlistsUrls))
+    die("[ERROR]: There are no adlists enabled");
+
+// Get total number of blocklists (Including Whitelist, Blacklist & Wildcard lists)
+$adlistsCount = count($adlistsUrls) + 3;
+
+// Set query timeout
+ini_set("default_socket_timeout", 3);
+
+// Logic for querying blocklists
+function queryAds($serverName) {
+    // Determine the time it takes while querying adlists
+    $preQueryTime = microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"];
+    $queryAdsURL = sprintf(
+        "http://127.0.0.1:%s/admin/scripts/pi-hole/php/queryads.php?domain=%s&bp",
+        $_SERVER["SERVER_PORT"],
+        $serverName
+    );
+    $queryAds = file($queryAdsURL, FILE_IGNORE_NEW_LINES);
+    $queryAds = array_values(array_filter(preg_replace("/data:\s+/", "", $queryAds)));
+    $queryTime = sprintf("%.0f", (microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"]) - $preQueryTime);
+
+    // Exception Handling
+    try {
+        // Define Exceptions
+        if (strpos($queryAds[0], "No exact results") !== FALSE) {
+            // Return "none" into $queryAds array
+            return array("0" => "none");
+        } else if ($queryTime >= ini_get("default_socket_timeout")) {
+            // Connection Timeout
+            throw new Exception ("Connection timeout (".ini_get("default_socket_timeout")."s)");
+        } elseif (!strpos($queryAds[0], ".") !== false) {
+            // Unknown $queryAds output
+            throw new Exception ("Unhandled error message (<code>$queryAds[0]</code>)");
+        }
+        return $queryAds;
+    } catch (Exception $e) {
+        // Return exception as array
+        return array("0" => "error", "1" => $e->getMessage());
+    }
+}
+
+// Get results of queryads.php exact search
+$queryAds = queryAds($serverName);
+
+// Pass error through to Block Page
+if ($queryAds[0] === "error")
+    die("[ERROR]: Unable to parse results from <i>queryads.php</i>: <code>".$queryAds[1]."</code>");
+
+// Count total number of matching blocklists
+$featuredTotal = count($queryAds);
+
+// Place results into key => value array
+$queryResults = null;
+foreach ($queryAds as $str) {
+    $value = explode(" ", $str);
+    @$queryResults[$value[0]] .= "$value[1]";
+}
+
+// Determine if domain has been blacklisted, whitelisted, wildcarded or CNAME blocked
+if (strpos($queryAds[0], "blacklist") !== FALSE) {
+    $notableFlagClass = "blacklist";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+} elseif (strpos($queryAds[0], "whitelist") !== FALSE) {
+    $notableFlagClass = "noblock";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+    $wlInfo = "recentwl";
+} elseif (strpos($queryAds[0], "wildcard") !== FALSE) {
+    $notableFlagClass = "wildcard";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+} elseif ($queryAds[0] === "none") {
+    $featuredTotal = "0";
+    $notableFlagClass = "noblock";
+
+    // QoL addition: Determine appropriate info message if CNAME exists
+    // Suggests to the user that $serverName has a CNAME (alias) that may be blocked
+    $dnsRecord = dns_get_record("$serverName")[0];
+    if (array_key_exists("target", $dnsRecord)) {
+        $wlInfo = $dnsRecord['target'];
+    } else {
+        $wlInfo = "unknown";
+    }
+}
+
+// Set #bpOutput notification
+$wlOutputClass = (isset($wlInfo) && $wlInfo === "recentwl") ? $wlInfo : "hidden";
+$wlOutput = (isset($wlInfo) && $wlInfo !== "recentwl") ? "<a href='http://$wlInfo'>$wlInfo</a>" : "";
+
+// Get Pi-hole Core version
+$phVersion = exec("cd /etc/.pihole/ && git describe --long --tags");
+
+// Print $execTime on development branches
+// Testing for - is marginally faster than "git rev-parse --abbrev-ref HEAD"
+if (explode("-", $phVersion)[1] != "0")
+  $execTime = microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"];
+
+// Please Note: Text is added via CSS to allow an admin to provide a localized
+// language without the need to edit this file
+
+setHeader();
+?>
+<!doctype html>
+<!-- Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL. -->
+<html>
+<head>
+  <meta charset="utf-8">
+  <?=$viewPort ?>
+  <meta name="robots" content="noindex,nofollow">
+  <meta http-equiv="x-dns-prefetch-control" content="off">
+  <link rel="stylesheet" href="pihole/blockingpage.css">
+  <link rel="shortcut icon" href="admin/img/favicons/favicon.ico" type="image/x-icon">
+  <title>● <?=$serverName ?></title>
+  <script src="admin/scripts/vendor/jquery.min.js"></script>
+  <script>
+    window.onload = function () {
+      <?php
+      // Remove href fallback from "Back to safety" button
+      if ($featuredTotal > 0) {
+        echo '$("#bpBack").removeAttr("href");';
+
+        // Enable whitelisting if JS is available
+        echo '$("#bpWhitelist").prop("disabled", false);';
+
+        // Enable password input if necessary
+        if (!empty($svPasswd)) {
+          echo '$("#bpWLPassword").attr("placeholder", "Password");';
+          echo '$("#bpWLPassword").prop("disabled", false);';
+        }
+        // Otherwise hide the input
+        else {
+          echo '$("#bpWLPassword").hide();';
+        }
+      }
+      ?>
+    }
+  </script>
+</head>
+<body id="blockpage"><div id="bpWrapper">
+<header>
+  <h1 id="bpTitle">
+    <a class="title" href="/"><?php //Website Blocked ?></a>
+  </h1>
+  <div class="spc"></div>
+
+  <input id="bpAboutToggle" type="checkbox">
+  <div id="bpAbout">
+    <div class="aboutPH">
+      <div class="aboutImg"></div>
+      <p>Open Source Ad Blocker
+        <small>Designed for Raspberry Pi</small>
+      </p>
+    </div>
+    <div class="aboutLink">
+      <a class="linkPH" href="https://docs.pi-hole.net/"><?php //About PH ?></a>
+      <?php if (!empty($svEmail)) echo '<a class="linkEmail" href="mailto:'.$svEmail.'"></a>'; ?>
+    </div>
+  </div>
+
+  <div id="bpAlt">
+    <label class="altBtn" for="bpAboutToggle"><?php //Why am I here? ?></label>
+  </div>
+</header>
+
+<main>
+  <div id="bpOutput" class="<?=$wlOutputClass ?>"><?=$wlOutput ?></div>
+  <div id="bpBlock">
+    <p class="blockMsg"><?=$serverName ?></p>
+  </div>
+  <?php if(isset($notableFlagClass)) { ?>
+    <div id="bpFlag">
+        <p class="flagMsg <?=$notableFlagClass ?>"></p>
+    </div>
+  <?php } ?>
+  <div id="bpHelpTxt"><?=$bpAskAdmin ?></div>
+  <div id="bpButtons" class="buttons">
+    <a id="bpBack" onclick="javascript:history.back()" href="about:home"></a>
+    <?php if ($featuredTotal > 0) echo '<label id="bpInfo" for="bpMoreToggle"></label>'; ?>
+  </div>
+  <input id="bpMoreToggle" type="checkbox">
+  <div id="bpMoreInfo">
+    <span id="bpFoundIn"><span><?=$featuredTotal ?></span><?=$adlistsCount ?></span>
+    <pre id='bpQueryOutput'><?php if ($featuredTotal > 0) foreach ($queryResults as $num => $value) { echo "<span>[$num]:</span>$adlistsUrls[$num]\n"; } ?></pre>
+
+    <form id="bpWLButtons" class="buttons">
+      <input id="bpWLDomain" type="text" value="<?=$serverName ?>" disabled>
+      <input id="bpWLPassword" type="password" placeholder="JavaScript disabled" disabled>
+      <button id="bpWhitelist" type="button" disabled></button>
+    </form>
+  </div>
+</main>
+
+<footer><span><?=date("l g:i A, F dS"); ?>.</span> Pi-hole <?=$phVersion ?> (<?=gethostname()."/".$_SERVER["SERVER_ADDR"]; if (isset($execTime)) printf("/%.2fs", $execTime); ?>)</footer>
+</div>
+
+<script>
+  function add() {
+    $("#bpOutput").removeClass("hidden error exception");
+    $("#bpOutput").addClass("add");
+    var domain = "<?=$serverName ?>";
+    var pw = $("#bpWLPassword");
+    if(domain.length === 0) {
+      return;
+    }
+    $.ajax({
+      url: "/admin/scripts/pi-hole/php/add.php",
+      method: "post",
+      data: {"domain":domain, "list":"white", "pw":pw.val()},
+      success: function(response) {
+        if(response.indexOf("Pi-hole blocking") !== -1) {
+          setTimeout(function(){window.location.reload(1);}, 10000);
+          $("#bpOutput").removeClass("add");
+          $("#bpOutput").addClass("success");
+          $("#bpOutput").html("");
+        } else {
+          $("#bpOutput").removeClass("add");
+          $("#bpOutput").addClass("error");
+          $("#bpOutput").html(""+response+"");
+        }
+      },
+      error: function(jqXHR, exception) {
+        $("#bpOutput").removeClass("add");
+        $("#bpOutput").addClass("exception");
+        $("#bpOutput").html("");
+      }
+    });
+  }
+  <?php if ($featuredTotal > 0) { ?>
+    $(document).keypress(function(e) {
+        if(e.which === 13 && $("#bpWLPassword").is(":focus")) {
+            add();
+        }
+    });
+    $("#bpWhitelist").on("click", function() {
+        add();
+    });
+  <?php } ?>
+</script>
+</body></html>

advanced/lighttpd.conf.debian

@@ -1,66 +1,115 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Lighttpd config for Pi-hole
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
+
+###############################################################################
+#     FILE AUTOMATICALLY OVERWRITTEN BY PI-HOLE INSTALL/UPDATE PROCEDURE.     #
+# ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
+#                                                                             #
+#              CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE:              #
+#                         /etc/lighttpd/external.conf                         #
+###############################################################################
 
 server.modules = (
-	"mod_access",
+    "mod_access",
-	"mod_accesslog",
+    "mod_accesslog",
-	"mod_auth",
+    "mod_auth",
-	"mod_expire",
+    "mod_expire",
-	"mod_compress",
+    "mod_compress",
-	"mod_redirect",
+    "mod_redirect",
-	"mod_setenv",
+    "mod_setenv",
-	"mod_rewrite"
+    "mod_rewrite"
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.html"
+server.error-handler-404    = "/pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
+server.pid-file             = "/run/lighttpd.pid"
 server.username             = "www-data"
 server.groupname            = "www-data"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
+accesslog.filename          = "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+accesslog.format            = "%{%s}t|%V|%r|%s|%b"
-
 
 index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
-url.access-deny             = ( "~", ".inc" )
+url.access-deny             = ( "~", ".inc", ".md", ".yml", ".ini" )
 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 
-compress.cache-dir          = "/var/cache/lighttpd/compress/"
+compress.cache-dir = "/var/cache/lighttpd/compress/"
-compress.filetype           = ( "application/javascript", "text/css", "text/html", "text/plain" )
+compress.filetype  = (
+    "application/json",
+    "application/vnd.ms-fontobject",
+    "application/xml",
+    "font/eot",
+    "font/opentype",
+    "font/otf",
+    "font/ttf",
+    "image/bmp",
+    "image/svg+xml",
+    "image/vnd.microsoft.icon",
+    "image/x-icon",
+    "text/css",
+    "text/html",
+    "text/javascript",
+    "text/plain",
+    "text/xml"
+)
+
+mimetype.assign = (
+    ".ico"   => "image/x-icon",
+    ".jpeg"  => "image/jpeg",
+    ".jpg"   => "image/jpeg",
+    ".png"   => "image/png",
+    ".svg"   => "image/svg+xml",
+    ".css"   => "text/css; charset=utf-8",
+    ".html"  => "text/html; charset=utf-8",
+    ".js"    => "text/javascript; charset=utf-8",
+    ".json"  => "application/json; charset=utf-8",
+    ".map"   => "application/json; charset=utf-8",
+    ".txt"   => "text/plain; charset=utf-8",
+    ".eot"   => "application/vnd.ms-fontobject",
+    ".otf"   => "font/otf",
+    ".ttc"   => "font/collection",
+    ".ttf"   => "font/ttf",
+    ".woff"  => "font/woff",
+    ".woff2" => "font/woff2"
+)
 
 # default listening port for IPv6 falls back to the IPv4 port
 include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
-include_shell "/usr/share/lighttpd/create-mime.assign.pl"
+
-include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
+# Prevent Lighttpd from enabling Let's Encrypt SSL for every blocked domain
+#include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
+include_shell "find /etc/lighttpd/conf-enabled -name '*.conf' -a ! -name 'letsencrypt.conf' -printf 'include \"%p\"\n' 2>/dev/null"
 
 # If the URL starts with /admin, it is the Web interface
 $HTTP["url"] =~ "^/admin/" {
-	# Create a response header for debugging using curl -I
+    # Create a response header for debugging using curl -I
     setenv.add-response-header = (
         "X-Pi-hole" => "The Pi-hole Web interface is working!",
         "X-Frame-Options" => "DENY"
     )
+
+    $HTTP["url"] =~ "\.(eot|otf|tt[cf]|woff2?)$" {
+        # Allow Block Page access to local fonts
+        setenv.add-response-header = ( "Access-Control-Allow-Origin" => "*" )
+    }
 }
 
-# Rewite js requests, must be out of $HTTP block due to bug #2526
+# Block . files from being served, such as .git, .github, .gitignore
-url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+$HTTP["url"] =~ "^/admin/\.(.*)" {
-
+    url.access-deny = ("")
-# If the URL does not start with /admin, then it is a query for an ad domain
-$HTTP["url"] =~ "^(?!/admin)/.*" {
-    # Create a response header for debugging using curl -I
-    setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
 }
 
+# Default expire header
+expire.url = ( "" => "access plus 0 seconds" )
+
 # Add user chosen options held in external file
+# This uses include_shell instead of an include wildcard for compatibility
 include_shell "cat external.conf 2>/dev/null"

advanced/lighttpd.conf.fedora

@@ -1,83 +1,123 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Lighttpd config for Pi-hole
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
+
+###############################################################################
+#     FILE AUTOMATICALLY OVERWRITTEN BY PI-HOLE INSTALL/UPDATE PROCEDURE.     #
+# ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
+#                                                                             #
+#              CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE:              #
+#                         /etc/lighttpd/external.conf                         #
+###############################################################################
 
 server.modules = (
-	"mod_access",
+    "mod_access",
-	"mod_auth",
+    "mod_auth",
-	"mod_fastcgi",
+    "mod_expire",
-	"mod_accesslog",
+    "mod_fastcgi",
-	"mod_expire",
+    "mod_accesslog",
-	"mod_compress",
+    "mod_compress",
-	"mod_redirect",
+    "mod_redirect",
-	"mod_setenv",
+    "mod_setenv",
-	"mod_rewrite"
+    "mod_rewrite"
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.html"
+server.error-handler-404    = "/pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
+server.pid-file             = "/run/lighttpd.pid"
 server.username             = "lighttpd"
 server.groupname            = "lighttpd"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
+accesslog.filename          = "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+accesslog.format            = "%{%s}t|%V|%r|%s|%b"
-
 
 index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
-url.access-deny             = ( "~", ".inc" )
+url.access-deny             = ( "~", ".inc", ".md", ".yml", ".ini" )
 static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
 
-compress.cache-dir          = "/var/cache/lighttpd/compress/"
+compress.cache-dir = "/var/cache/lighttpd/compress/"
-compress.filetype           = ( "application/javascript", "text/css", "text/html", "text/plain" )
+compress.filetype  = (
+    "application/json",
+    "application/vnd.ms-fontobject",
+    "application/xml",
+    "font/eot",
+    "font/opentype",
+    "font/otf",
+    "font/ttf",
+    "image/bmp",
+    "image/svg+xml",
+    "image/vnd.microsoft.icon",
+    "image/x-icon",
+    "text/css",
+    "text/html",
+    "text/javascript",
+    "text/plain",
+    "text/xml"
+)
 
-mimetype.assign   = ( ".png"  => "image/png",
+mimetype.assign = (
-                      ".jpg"  => "image/jpeg",
+    ".ico"   => "image/x-icon",
-                      ".jpeg" => "image/jpeg",
+    ".jpeg"  => "image/jpeg",
-                      ".html" => "text/html",
+    ".jpg"   => "image/jpeg",
-                      ".css" => "text/css; charset=utf-8",
+    ".png"   => "image/png",
-                      ".js" => "application/javascript",
+    ".svg"   => "image/svg+xml",
-                      ".json" => "application/json",
+    ".css"   => "text/css; charset=utf-8",
-                      ".txt"  => "text/plain",
+    ".html"  => "text/html; charset=utf-8",
-                      ".svg"  => "image/svg+xml" )
+    ".js"    => "text/javascript; charset=utf-8",
+    ".json"  => "application/json; charset=utf-8",
+    ".map"   => "application/json; charset=utf-8",
+    ".txt"   => "text/plain; charset=utf-8",
+    ".eot"   => "application/vnd.ms-fontobject",
+    ".otf"   => "font/otf",
+    ".ttc"   => "font/collection",
+    ".ttf"   => "font/ttf",
+    ".woff"  => "font/woff",
+    ".woff2" => "font/woff2"
+)
 
 # default listening port for IPv6 falls back to the IPv4 port
 #include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
 #include_shell "/usr/share/lighttpd/create-mime.assign.pl"
 #include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 
-fastcgi.server = ( ".php" =>
+fastcgi.server = (
-                   ( "localhost" =>
+    ".php" => (
-                     (
+        "localhost" => (
-                       "socket" => "/tmp/php-fastcgi.socket",
+            "socket" => "/tmp/php-fastcgi.socket",
-                       "bin-path" => "/usr/bin/php-cgi"
+            "bin-path" => "/usr/bin/php-cgi"
-                     )
+        )
-                   )
+    )
-                 )
+)
 
 # If the URL starts with /admin, it is the Web interface
 $HTTP["url"] =~ "^/admin/" {
-	# Create a response header for debugging using curl -I
+    # Create a response header for debugging using curl -I
-	setenv.add-response-header = ( "X-Pi-hole" => "The Pi-hole Web interface is working!" )
+    setenv.add-response-header = (
+        "X-Pi-hole" => "The Pi-hole Web interface is working!",
+        "X-Frame-Options" => "DENY"
+    )
+
+    $HTTP["url"] =~ "\.(eot|otf|tt[cf]|woff2?)$" {
+        # Allow Block Page access to local fonts
+        setenv.add-response-header = ( "Access-Control-Allow-Origin" => "*" )
+    }
 }
 
-# Rewite js requests, must be out of $HTTP block due to bug #2526
+# Block . files from being served, such as .git, .github, .gitignore
-url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+$HTTP["url"] =~ "^/admin/\.(.*)" {
-
+    url.access-deny = ("")
-# If the URL does not start with /admin, then it is a query for an ad domain
-$HTTP["url"] =~ "^(?!/admin)/.*" {
-	# Create a response header for debugging using curl -I
-	setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
 }
 
+# Default expire header
+expire.url = ( "" => "access plus 0 seconds" )
+
 # Add user chosen options held in external file
+# This uses include_shell instead of an include wildcard for compatibility
 include_shell "cat external.conf 2>/dev/null"

advanced/pihole.cron

@@ -1,26 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Updates ad sources every week
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-#
-# This file is under source-control of the Pi-hole installation and update
-# scripts, any changes made to this file will be overwritten when the softare
-# is updated or re-installed. Please make any changes to the appropriate crontab
-# or other cron file snippets.
-
-# Pi-hole: Update the ad sources once a week on Sunday at 01:59
-#          Download any updates from the adlists
-59 1    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updateGravity
-
-# Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updatePihole
-
-# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
-#          Stats will be viewable in the Web interface thanks to the cron job above
-00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush

advanced/pihole.sudo

@@ -1,12 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Allows the WebUI to use Pi-hole commands
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-www-data ALL=NOPASSWD: /usr/local/bin/pihole

advanced/selinux/pihole.te

@@ -1,87 +0,0 @@
-module pihole 1.0;
-
-require {
-        type var_log_t;
-        type unconfined_t;
-        type init_t;
-        type auditd_t;
-        type syslogd_t;
-        type NetworkManager_t;
-        type mdadm_t;
-        type tuned_t;
-        type avahi_t;
-        type irqbalance_t;
-        type system_dbusd_t;
-        type kernel_t;
-        type httpd_sys_script_t;
-        type systemd_logind_t;
-        type httpd_t;
-        type policykit_t;
-        type dnsmasq_t;
-        type udev_t;
-        type postfix_pickup_t;
-        type sshd_t;
-        type crond_t;
-        type getty_t;
-        type lvm_t;
-        type postfix_qmgr_t;
-        type postfix_master_t;
-        class dir { getattr search };
-        class file { read open setattr };
-}
-
-#============= dnsmasq_t ==============
-allow dnsmasq_t var_log_t:file { open setattr };
-
-#============= httpd_t ==============
-allow httpd_t var_log_t:file { read open };
-
-#============= httpd_sys_script_t (class: dir) ==============
-allow httpd_sys_script_t NetworkManager_t:dir { getattr search };
-allow httpd_sys_script_t auditd_t:dir { getattr search };
-allow httpd_sys_script_t avahi_t:dir { getattr search };
-allow httpd_sys_script_t crond_t:dir { getattr search };
-allow httpd_sys_script_t dnsmasq_t:dir { getattr search };
-allow httpd_sys_script_t getty_t:dir { getattr search };
-allow httpd_sys_script_t httpd_t:dir { getattr search };
-allow httpd_sys_script_t init_t:dir { getattr search };
-allow httpd_sys_script_t irqbalance_t:dir { getattr search };
-allow httpd_sys_script_t kernel_t:dir { getattr search };
-allow httpd_sys_script_t lvm_t:dir { getattr search };
-allow httpd_sys_script_t mdadm_t:dir { getattr search };
-allow httpd_sys_script_t policykit_t:dir { getattr search };
-allow httpd_sys_script_t postfix_master_t:dir { getattr search };
-allow httpd_sys_script_t postfix_pickup_t:dir { getattr search };
-allow httpd_sys_script_t postfix_qmgr_t:dir { getattr search };
-allow httpd_sys_script_t sshd_t:dir { getattr search };
-allow httpd_sys_script_t syslogd_t:dir { getattr search };
-allow httpd_sys_script_t system_dbusd_t:dir { getattr search };
-allow httpd_sys_script_t systemd_logind_t:dir { getattr search };
-allow httpd_sys_script_t tuned_t:dir { getattr search };
-allow httpd_sys_script_t udev_t:dir { getattr search };
-allow httpd_sys_script_t unconfined_t:dir { getattr search };
-
-#============= httpd_sys_script_t (class: file) ==============
-allow httpd_sys_script_t NetworkManager_t:file { read open };
-allow httpd_sys_script_t auditd_t:file { read open };
-allow httpd_sys_script_t avahi_t:file { read open };
-allow httpd_sys_script_t crond_t:file { read open };
-allow httpd_sys_script_t dnsmasq_t:file { read open };
-allow httpd_sys_script_t getty_t:file { read open };
-allow httpd_sys_script_t httpd_t:file { read open };
-allow httpd_sys_script_t init_t:file { read open };
-allow httpd_sys_script_t irqbalance_t:file { read open };
-allow httpd_sys_script_t kernel_t:file { read open };
-allow httpd_sys_script_t lvm_t:file { read open };
-allow httpd_sys_script_t mdadm_t:file { read open };
-allow httpd_sys_script_t policykit_t:file { read open };
-allow httpd_sys_script_t postfix_master_t:file { read open };
-allow httpd_sys_script_t postfix_pickup_t:file { read open };
-allow httpd_sys_script_t postfix_qmgr_t:file { read open };
-allow httpd_sys_script_t sshd_t:file { read open };
-allow httpd_sys_script_t syslogd_t:file { read open };
-allow httpd_sys_script_t system_dbusd_t:file { read open };
-allow httpd_sys_script_t systemd_logind_t:file { read open };
-allow httpd_sys_script_t tuned_t:file { read open };
-allow httpd_sys_script_t udev_t:file { read open };
-allow httpd_sys_script_t unconfined_t:file { read open };

automated install/uninstall.sh

@@ -1,181 +1,227 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Completely uninstalls Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+source "/opt/pihole/COL_TABLE"
+
+while true; do
+    read -rp "  ${QST} Are you sure you would like to remove ${COL_WHITE}Pi-hole${COL_NC}? [y/N] " yn
+    case ${yn} in
+        [Yy]* ) break;;
+        [Nn]* ) echo -e "${OVER}  ${COL_LIGHT_GREEN}Uninstall has been canceled${COL_NC}"; exit 0;;
+        * ) echo -e "${OVER}  ${COL_LIGHT_GREEN}Uninstall has been canceled${COL_NC}"; exit 0;;
+    esac
+done
 
 # Must be root to uninstall
+str="Root user check"
 if [[ ${EUID} -eq 0 ]]; then
-	echo "::: You are root."
+    echo -e "  ${TICK} ${str}"
 else
-	echo "::: Sudo will be used for the uninstall."
+    # Check if sudo is actually installed
-	# Check if it is actually installed
+    # If it isn't, exit because the uninstall can not complete
-	# If it isn't, exit because the unnstall cannot complete
+    if [ -x "$(command -v sudo)" ]; then
-	if [ -x "$(command -v sudo)" ]; then
+        export SUDO="sudo"
-		export SUDO="sudo"
+    else
-	else
+        echo -e "  ${CROSS} ${str}
-		echo "::: Please install sudo or run this as root."
+            Script called with non-root privileges
-		exit 1
+            The Pi-hole requires elevated privleges to uninstall"
-	fi
+        exit 1
+    fi
 fi
 
-# Compatability
+readonly PI_HOLE_FILES_DIR="/etc/.pihole"
-if [ -x "$(command -v rpm)" ]; then
+PH_TEST="true"
-	# Fedora Family
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
-	if [ -x "$(command -v dnf)" ]; then
+# setupVars set in basic-install.sh
-		PKG_MANAGER="dnf"
+source "${setupVars}"
-	else
+
-		PKG_MANAGER="yum"
+# distro_check() sourced from basic-install.sh
-	fi
+distro_check
-	PKG_REMOVE="${PKG_MANAGER} remove -y"
+
-	PIHOLE_DEPS=( bind-utils bc dnsmasq lighttpd lighttpd-fastcgi php-common git curl unzip wget findutils )
+# Install packages used by the Pi-hole
-	package_check() {
+DEPS=("${INSTALLER_DEPS[@]}" "${PIHOLE_DEPS[@]}")
-		rpm -qa | grep ^$1- > /dev/null
+if [[ "${INSTALL_WEB_SERVER}" == true ]]; then
-	}
+    # Install the Web dependencies
-	package_cleanup() {
+    DEPS+=("${PIHOLE_WEB_DEPS[@]}")
-		${SUDO} ${PKG_MANAGER} -y autoremove
-	}
-elif [ -x "$(command -v apt-get)" ]; then
-	# Debian Family
-	PKG_MANAGER="apt-get"
-	PKG_REMOVE="${PKG_MANAGER} -y remove --purge"
-	PIHOLE_DEPS=( dnsutils bc dnsmasq lighttpd php5-common git curl unzip wget )
-	package_check() {
-		dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed"
-	}
-	package_cleanup() {
-		${SUDO} ${PKG_MANAGER} -y autoremove
-		${SUDO} ${PKG_MANAGER} -y autoclean
-	}
-else
-	echo "OS distribution not supported"
-	exit
 fi
 
-spinner() {
+# Compatibility
-	local pid=$1
+if [ -x "$(command -v apt-get)" ]; then
-	local delay=0.50
+    # Debian Family
-	local spinstr='/-\|'
+    PKG_REMOVE=("${PKG_MANAGER}" -y remove --purge)
-	while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
+    package_check() {
-		local temp=${spinstr#?}
+        dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed"
-		printf " [%c]  " "${spinstr}"
+    }
-		local spinstr=${temp}${spinstr%"$temp}"}
+elif [ -x "$(command -v rpm)" ]; then
-		sleep ${delay}
+    # Fedora Family
-		printf "\b\b\b\b\b\b"
+    PKG_REMOVE=("${PKG_MANAGER}" remove -y)
-	done
+    package_check() {
-	printf "    \b\b\b\b"
+        rpm -qa | grep "^$1-" > /dev/null
-}
+    }
+else
+    echo -e "  ${CROSS} OS distribution not supported"
+    exit 1
+fi
 
 removeAndPurge() {
-	# Purge dependencies
+    # Purge dependencies
-	echo ":::"
+    echo ""
-	for i in "${PIHOLE_DEPS[@]}"; do
+    for i in "${DEPS[@]}"; do
-		package_check ${i} > /dev/null
+        if package_check "${i}" > /dev/null; then
-		if [ $? -eq 0 ]; then
+            while true; do
-			while true; do
+                read -rp "  ${QST} Do you wish to remove ${COL_WHITE}${i}${COL_NC} from your system? [Y/N] " yn
-				read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
+                case ${yn} in
-				case ${yn} in
+                    [Yy]* )
-					[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
+                        echo -ne "  ${INFO} Removing ${i}...";
-					[Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
+                        ${SUDO} "${PKG_REMOVE[@]}" "${i}" &> /dev/null;
-					* ) printf "::: You must answer yes or no!\n";;
+                        echo -e "${OVER}  ${INFO} Removed ${i}";
-				esac
+                        break;;
-			done
+                    [Nn]* ) echo -e "  ${INFO} Skipped ${i}"; break;;
-		else
+                esac
-			printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
+            done
-		fi
+        else
-	done
+            echo -e "  ${INFO} Package ${i} not installed"
+        fi
+    done
 
-	# Remove dependency config files
+    # Remove dnsmasq config files
-	echo "::: Removing dnsmasq config files..."
+    ${SUDO} rm -f /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/*-pihole*.conf &> /dev/null
-	${SUDO} rm /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+    echo -e "  ${TICK} Removing dnsmasq config files"
 
-	# Take care of any additional package cleaning
+    # Call removeNoPurge to remove Pi-hole specific files
-	printf "::: Auto removing & cleaning remaining dependencies..."
+    removeNoPurge
-	package_cleanup &> /dev/null & spinner $!; printf "done!\n";
-
-	# Call removeNoPurge to remove PiHole specific files
-	removeNoPurge
 }
 
 removeNoPurge() {
-	echo ":::"
+    # Only web directories/files that are created by Pi-hole should be removed
-	# Only web directories/files that are created by pihole should be removed.
+    echo -ne "  ${INFO} Removing Web Interface..."
-	echo "::: Removing the Pi-hole Web server files..."
+    ${SUDO} rm -rf /var/www/html/admin &> /dev/null
-	${SUDO} rm -rf /var/www/html/admin &> /dev/null
+    ${SUDO} rm -rf /var/www/html/pihole &> /dev/null
-	${SUDO} rm -rf /var/www/html/pihole &> /dev/null
+    ${SUDO} rm -f /var/www/html/index.lighttpd.orig &> /dev/null
-	${SUDO} rm /var/www/html/index.lighttpd.orig &> /dev/null
 
-	# If the web directory is empty after removing these files, then the parent html folder can be removed.
+    # If the web directory is empty after removing these files, then the parent html directory can be removed.
-	if [ -d "/var/www/html" ]; then
+    if [ -d "/var/www/html" ]; then
-		if [[ ! "$(ls -A /var/www/html)" ]]; then
+        if [[ ! "$(ls -A /var/www/html)" ]]; then
-    			${SUDO} rm -rf /var/www/html &> /dev/null
+            ${SUDO} rm -rf /var/www/html &> /dev/null
-		fi
+        fi
-	fi
+    fi
+    echo -e "${OVER}  ${TICK} Removed Web Interface"
+ 
+    # Attempt to preserve backwards compatibility with older versions
+    # to guarantee no additional changes were made to /etc/crontab after
+    # the installation of pihole, /etc/crontab.pihole should be permanently
+    # preserved.
+    if [[ -f /etc/crontab.orig ]]; then
+        ${SUDO} mv /etc/crontab /etc/crontab.pihole
+        ${SUDO} mv /etc/crontab.orig /etc/crontab
+        ${SUDO} service cron restart
+        echo -e "  ${TICK} Restored the default system cron"
+    fi
 
-	# Attempt to preserve backwards compatibility with older versions
+    # Attempt to preserve backwards compatibility with older versions
-	# to guarantee no additional changes were made to /etc/crontab after
+    if [[ -f /etc/cron.d/pihole ]];then
-	# the installation of pihole, /etc/crontab.pihole should be permanently
+        ${SUDO} rm -f /etc/cron.d/pihole &> /dev/null
-	# preserved.
+        echo -e "  ${TICK} Removed /etc/cron.d/pihole"
-	if [[ -f /etc/crontab.orig ]]; then
+    fi
-		echo "::: Initial Pi-hole cron detected.  Restoring the default system cron..."
-		${SUDO} mv /etc/crontab /etc/crontab.pihole
-		${SUDO} mv /etc/crontab.orig /etc/crontab
-		${SUDO} service cron restart
-	fi
 
-	# Attempt to preserve backwards compatibility with older versions
+    if package_check lighttpd > /dev/null; then
-	if [[ -f /etc/cron.d/pihole ]];then
+        if [[ -f /etc/lighttpd/lighttpd.conf.orig ]]; then
-		echo "::: Removing cron.d/pihole..."
+            ${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
-		${SUDO} rm /etc/cron.d/pihole &> /dev/null
+        fi
-	fi
 
-	echo "::: Removing config files and scripts..."
+        if [[ -f /etc/lighttpd/external.conf ]]; then
-	package_check lighttpd > /dev/null
+            ${SUDO} rm /etc/lighttpd/external.conf
-	if [ $? -eq 1 ]; then
+        fi
-		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
-	else
-		if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
-			${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
-		fi
-	fi
 
-	${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
+        echo -e "  ${TICK} Removed lighttpd configs"
-	${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+    fi
-	${SUDO} rm -rf /var/log/*pihole* &> /dev/null
-	${SUDO} rm -rf /etc/pihole/ &> /dev/null
-	${SUDO} rm -rf /etc/.pihole/ &> /dev/null
-	${SUDO} rm -rf /opt/pihole/ &> /dev/null
-	${SUDO} rm /usr/local/bin/pihole &> /dev/null
-	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
-	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
-	
-	# If the pihole user exists, then remove
-	if id "pihole" >/dev/null 2>&1; then
-        	echo "::: Removing pihole user..."
-		${SUDO} userdel -r pihole
-	fi
 
-	echo ":::"
+    ${SUDO} rm -f /etc/dnsmasq.d/adList.conf &> /dev/null
-	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"
+    ${SUDO} rm -f /etc/dnsmasq.d/01-pihole.conf &> /dev/null
-	printf "::: Reach out to us at https://github.com/pi-hole/pi-hole/issues if you need help\n"
+    ${SUDO} rm -rf /var/log/*pihole* &> /dev/null
-	printf "::: Reinstall by simpling running\n:::\n:::\tcurl -L https://install.pi-hole.net | bash\n:::\n::: at any time!\n:::\n"
+    ${SUDO} rm -rf /etc/pihole/ &> /dev/null
-	printf "::: PLEASE RESET YOUR DNS ON YOUR ROUTER/CLIENTS TO RESTORE INTERNET CONNECTIVITY!\n"
+    ${SUDO} rm -rf /etc/.pihole/ &> /dev/null
+    ${SUDO} rm -rf /opt/pihole/ &> /dev/null
+    ${SUDO} rm -f /usr/local/bin/pihole &> /dev/null
+    ${SUDO} rm -f /etc/bash_completion.d/pihole &> /dev/null
+    ${SUDO} rm -f /etc/sudoers.d/pihole &> /dev/null
+    echo -e "  ${TICK} Removed config files"
+
+    # Restore Resolved
+    if [[ -e /etc/systemd/resolved.conf.orig ]]; then
+        ${SUDO} cp -p /etc/systemd/resolved.conf.orig /etc/systemd/resolved.conf
+        systemctl reload-or-restart systemd-resolved
+    fi
+
+    # Remove FTL
+    if command -v pihole-FTL &> /dev/null; then
+        echo -ne "  ${INFO} Removing pihole-FTL..."
+        if [[ -x "$(command -v systemctl)" ]]; then
+            systemctl stop pihole-FTL
+        else
+            service pihole-FTL stop
+        fi
+        ${SUDO} rm -f /etc/init.d/pihole-FTL
+        ${SUDO} rm -f /usr/bin/pihole-FTL
+        echo -e "${OVER}  ${TICK} Removed pihole-FTL"
+    fi
+
+    # If the pihole manpage exists, then delete and rebuild man-db
+    if [[ -f /usr/local/share/man/man8/pihole.8 ]]; then
+        ${SUDO} rm -f /usr/local/share/man/man8/pihole.8 /usr/local/share/man/man8/pihole-FTL.8 /usr/local/share/man/man5/pihole-FTL.conf.5
+        ${SUDO} mandb -q &>/dev/null
+        echo -e "  ${TICK} Removed pihole man page"
+    fi
+
+    # If the pihole user exists, then remove
+    if id "pihole" &> /dev/null; then
+        if ${SUDO} userdel -r pihole 2> /dev/null; then
+            echo -e "  ${TICK} Removed 'pihole' user"
+        else
+            echo -e "  ${CROSS} Unable to remove 'pihole' user"
+        fi
+    fi
+    # If the pihole group exists, then remove
+    if getent group "pihole" &> /dev/null; then
+        if ${SUDO} groupdel pihole 2> /dev/null; then
+            echo -e "  ${TICK} Removed 'pihole' group"
+        else
+            echo -e "  ${CROSS} Unable to remove 'pihole' group"
+        fi
+    fi
+
+    echo -e "\\n   We're sorry to see you go, but thanks for checking out Pi-hole!
+       If you need help, reach out to us on GitHub, Discourse, Reddit or Twitter
+       Reinstall at any time: ${COL_WHITE}curl -sSL https://install.pi-hole.net | bash${COL_NC}
+
+      ${COL_LIGHT_RED}Please reset the DNS on your router/clients to restore internet connectivity
+      ${COL_LIGHT_GREEN}Uninstallation Complete! ${COL_NC}"
 }
 
 ######### SCRIPT ###########
-echo "::: Preparing to remove packages, be sure that each may be safely removed depending on your operating system."
+if command -v vcgencmd &> /dev/null; then
-echo "::: (SAFE TO REMOVE ALL ON RASPBIAN)"
+    echo -e "  ${INFO} All dependencies are safe to remove on Raspbian"
+else
+    echo -e "  ${INFO} Be sure to confirm if any dependencies should not be removed"
+fi
 while true; do
-	read -rp "::: Do you wish to purge PiHole's dependencies from your OS? (You will be prompted for each package) [y/n]: " yn
+    echo -e "  ${INFO} ${COL_YELLOW}The following dependencies may have been added by the Pi-hole install:"
-	case ${yn} in
+    echo -n "    "
-		[Yy]* ) removeAndPurge; break;;
+    for i in "${DEPS[@]}"; do
-	
+        echo -n "${i} "
-		[Nn]* ) removeNoPurge; break;;
+    done
-	esac
+    echo "${COL_NC}"
+    read -rp "  ${QST} Do you wish to go through each dependency for removal? (Choosing No will leave all dependencies installed) [Y/n] " yn
+    case ${yn} in
+        [Yy]* ) removeAndPurge; break;;
+        [Nn]* ) removeNoPurge; break;;
+        * ) removeAndPurge; break;;
+    esac
 done

autotest

@@ -1 +0,0 @@
-py.test -v -f test/

block hulu ads/lighttpd.conf

@@ -1,43 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Lighttpd config file for Pi-hole
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-server.modules = (
-	"mod_access",
-	"mod_alias",
-	"mod_compress",
- 	"mod_redirect",
-   "mod_rewrite"
-)
-
-server.document-root        = "/var/www"
-server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
-server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
-server.username             = "www-data"
-server.groupname            = "www-data"
-server.port                 = 80
-
-
-index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
-url.access-deny             = ( "~", ".inc" )
-static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
-
-compress.cache-dir          = "/var/cache/lighttpd/compress/"
-compress.filetype           = ( "application/javascript", "text/css", "text/html", "text/plain" )
-
-# default listening port for IPv6 falls back to the IPv4 port
-include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
-include_shell "/usr/share/lighttpd/create-mime.assign.pl"
-include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
-
-$HTTP["host"] =~ "ads.hulu.com|ads-v-darwin.hulu.com|ads-e-darwin.hulu.com" {
-	url.redirect = ( ".*" => "http://192.168.1.101:8200/MediaItems/19.mov")
-}

block hulu ads/minidlna.conf

@@ -1,17 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# MiniDLNA config file for Pi-hole
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-media_dir=V,/var/lib/minidlna/videos/
-port=8200
-friendly_name=pihole
-serial=12345678
-model_number=1
-inotify=yes

manpages/pihole-FTL.8

@@ -0,0 +1,152 @@
+.TH "Pihole-FTL" "8" "pihole-FTL" "Pi-hole" "November 2020"
+.SH "NAME"
+pihole-FTL - Pi-hole : The Faster-Than-Light (FTL) Engine
+.br
+.SH "SYNOPSIS"
+\fBservice pihole-FTL \fR(\fBstart\fR|\fBstop\fR|\fBrestart\fR)
+.br
+
+\fBpihole-FTL debug\fR
+.br
+\fBpihole-FTL test\fR
+.br
+\fBpihole-FTL -v|-vv\fR
+.br
+\fBpihole-FTL -t\fR
+.br
+\fBpihole-FTL -b\fR
+.br
+\fBpihole-FTL -f\fR
+.br
+\fBpihole-FTL -h\fR
+.br
+\fBpihole-FTL dnsmasq-test\fR
+.br
+\fBpihole-FTL regex-test str\fR
+.br
+\fBpihole-FTL regex-test str rgx\fR
+.br
+\fBpihole-FTL lua\fR
+.br
+\fBpihole-FTL luac\fR
+.br
+\fBpihole-FTL dhcp-discover\fR
+.br
+\fBpihole-FTL --\fR (\fBoptions\fR)
+.br
+
+.SH "DESCRIPTION"
+Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery\fR \fIquickly\fR!
+.br
+
+Usage
+.br
+
+\fBservice pihole-FTL start\fR
+.br
+    Start the pihole-FTL daemon
+.br
+
+\fBservice pihole-FTL stop\fR
+.br
+    Stop the pihole-FTL daemon
+.br
+
+\fBservice pihole-FTL restart\fR
+.br
+    If the pihole-FTP daemon is running, stop and then start, otherwise start.
+.br
+
+Command line arguments
+.br
+
+\fBdebug\fR
+.br
+    Don't go into daemon mode (stay in foreground) + more verbose logging
+.br
+
+\fBtest\fR
+.br
+    Start FTL and process everything, but shut down immediately afterwards
+.br
+
+\fB-v, version\fR
+.br
+    Don't start FTL, show only version
+.br
+
+\fB-vv\fR
+.br
+    Don't start FTL, show verbose version information of embedded applications
+.br
+
+\fB-t, tag\fR
+.br
+    Don't start FTL, show only git tag
+.br
+
+\fB-b, branch\fR
+.br
+    Don't start FTL, show only git branch FTL was compiled from
+.br
+
+\fB-f, no-daemon\fR
+.br
+    Don't go into background (daemon mode)
+.br
+
+\fB-h, help\fR
+.br
+    Don't start FTL, show help
+.br
+
+\fBdnsmasq-test\fR
+.br
+    Test resolver config file syntax
+.br
+
+\fBregex-test str\fR
+.br
+    Test str against all regular expressions in the database
+.br
+
+\fBregex-test str rgx\fR
+.br
+    Test str against regular expression given by rgx
+.br
+
+\fBlua\fR
+.br
+    Start the embedded Lua interpreter
+.br
+
+\fBluac\fR
+.br
+    Execute the embedded Lua compiler
+.br
+
+\fBdhcp-discover\fR
+.br
+    Discover DHCP servers in the local network
+.br
+
+\fB--\fR  (options)
+.br
+    Pass options to internal dnsmasq resolver
+.br
+.SH "EXAMPLE"
+Command line arguments can be arbitrarily combined, e.g:
+.br
+
+\fBpihole-FTL debug test\fR
+.br
+
+Start ftl in foreground with more verbose logging, process everything and shutdown immediately
+.br
+.SH "SEE ALSO"
+\fBpihole\fR(8), \fBpihole-FTL.conf\fR(5)
+.br
+.SH "COLOPHON"
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net
+.br

manpages/pihole-FTL.conf.5

@@ -0,0 +1,313 @@
+.TH "pihole-FTL.conf" "5" "pihole-FTL.conf" "pihole-FTL.conf" "November 2020"
+.SH "NAME"
+
+pihole-FTL.conf - FTL's config file
+.br
+.SH "DESCRIPTION"
+
+/etc/pihole/pihole-FTL.conf will be read by \fBpihole-FTL(8)\fR on startup.
+.br
+For each setting the option shown first is the default.
+.br
+
+\fBBLOCKINGMODE=IP|IP-AAAA-NODATA|NODATA|NXDOMAIN|NULL\fR
+.br
+    How should FTL reply to blocked queries?
+
+    IP             - Pi-hole's IPs for blocked domains
+
+    IP-AAAA-NODATA - Pi-hole's IP + NODATA-IPv6 for blocked domains
+
+    NODATA         - Using NODATA for blocked domains
+
+    NXDOMAIN       - NXDOMAIN for blocked domains
+
+    NULL           - Null IPs for blocked domains
+.br
+
+\fBCNAME_DEEP_INSPECT=true|false\fR
+.br
+    Use this option to disable deep CNAME inspection. This might be beneficial for very low-end devices.
+.br
+
+\fBBLOCK_ESNI=true|false\fR
+.br
+    Block requests to _esni.* sub-domains.
+.br
+
+\fBMAXLOGAGE=24.0\fR
+.br
+    Up to how many hours of queries should be imported from the database and logs?
+.br
+    Maximum is 744 (31 days)
+.br
+
+\fBPRIVACYLEVEL=0|1|2|3|4\fR
+.br
+    Privacy level used to collect Pi-hole statistics.
+.br
+    0 - show everything
+.br
+    1 - hide domains
+.br
+    2 - hide domains and clients
+.br
+    3 - anonymous mode (hide everything)
+.br
+    4 - disable all statistics
+.br
+
+\fBIGNORE_LOCALHOST=no|yes\fR
+.br
+    Should FTL ignore queries coming from the local machine?
+.br
+
+\fBAAAA_QUERY_ANALYSIS=yes|no\fR
+.br
+    Should FTL analyze AAAA queries?
+.br
+
+\fBANALYZE_ONLY_A_AND_AAAA=false|true\fR
+.br
+    Should FTL only analyze A and AAAA queries?
+.br
+
+\fBSOCKET_LISTENING=localonly|all\fR
+.br
+    Listen only for local socket connections on the API port or permit all connections.
+.br
+
+\fBFTLPORT=4711\fR
+.br
+    On which port should FTL be listening?
+.br
+
+\fBRESOLVE_IPV6=yes|no\fR
+.br
+    Should FTL try to resolve IPv6 addresses to hostnames?
+.br
+
+\fBRESOLVE_IPV4=yes|no\fR
+.br
+    Should FTL try to resolve IPv4 addresses to hostnames?
+.br
+
+\fBDELAY_STARTUP=0\fR
+.br
+    Time in seconds (between 0 and 300) to delay FTL startup.
+.br
+
+\fBNICE=-10\fR
+.br
+    Set the niceness of the Pi-hole FTL process.
+.br
+    Can be disabled altogether by setting a value of -999.
+.br
+
+\fBNAMES_FROM_NETDB=true|false\fR
+.br
+    Control whether FTL should use a fallback option and try to obtain client names from checking the network table.
+.br
+    E.g. IPv6 clients without a hostname will be compared via MAC address to known clients.
+.br
+
+\fB\fBREFRESH_HOSTNAMES=IPV4|ALL|NONE\fR
+.br
+    Change how (and if) hourly PTR requests are made to check for changes in client and upstream server hostnames:
+.br
+    IPV4 - Do the hourly PTR lookups only for IPv4 addresses resolving issues in networks with many short-lived PE IPv6 addresses.
+.br
+    ALL  - Do the hourly PTR lookups for all addresses. This can create a lot of PTR queries in networks with many IPv6 addresses.
+.br
+    NONE - Don't do hourly PTR lookups. Look up hostnames once (when first seeing a client) and never again. Future hostname changes may be missed.
+.br
+
+\fBMAXNETAGE=365\fR
+.br
+    IP addresses (and associated host names) older than the specified number of days are removed.
+.br
+    This avoids dead entries in the network overview table.
+.br
+
+\fBEDNS0_ECS=true|false\fR
+.br
+    Should we overwrite the query source when client information is provided through EDNS0 client subnet (ECS) information?
+.br
+
+\fBPARSE_ARP_CACHE=true|false\fR
+.br
+    Parse ARP cache to fill network overview table.
+.br
+
+\fBDBIMPORT=yes|no\fR
+.br
+    Should FTL load information from the database on startup to be aware of the most recent history?
+.br
+
+\fBMAXDBDAYS=365\fR
+.br
+    How long should queries be stored in the database? Setting this to 0 disables the database
+.br
+
+\fBDBINTERVAL=1.0\fR
+.br
+    How often do we store queries in FTL's database [minutes]?
+.br
+    Accepts value between 0.1 (6 sec) and 1440 (1 day)
+.br
+
+\fBDBFILE=/etc/pihole/pihole-FTL.db\fR
+.br
+    Specify path and filename of FTL's SQLite long-term database.
+.br
+    Setting this to DBFILE= disables the database altogether
+.br
+
+\fBLOGFILE=/var/log/pihole-FTL.log\fR
+.br
+    The location of FTL's log file.
+.br
+
+\fBPIDFILE=/run/pihole-FTL.pid\fR
+.br
+    The file which contains the PID of FTL's main process.
+.br
+
+\fBPORTFILE=/run/pihole-FTL.port\fR
+.br
+    Specify path and filename where the FTL process will write its API port number.
+.br
+
+\fBSOCKETFILE=/run/pihole/FTL.sock\fR
+.br
+    The file containing the socket FTL's API is listening on.
+.br
+
+\fBSETUPVARSFILE=/etc/pihole/setupVars.conf\fR
+.br
+    The config file of Pi-hole containing, e.g., the current blocking status (do not change).
+.br
+
+\fBMACVENDORDB=/etc/pihole/macvendor.db\fR
+.br
+    The database containing MAC -> Vendor information for the network table.
+.br
+
+\fBGRAVITYDB=/etc/pihole/gravity.db\fR
+.br
+    Specify path and filename of FTL's SQLite3 gravity database. This database contains all domains relevant for Pi-hole's DNS blocking.
+.br
+
+\fBDEBUG_ALL=false|true\fR
+.br
+    Enable all debug flags. If this is set to true, all other debug config options are ignored.
+.br
+
+\fBDEBUG_DATABASE=false|true\fR
+.br
+    Print debugging information about database actions such as SQL statements and performance.
+.br
+
+\fBDEBUG_NETWORKING=false|true\fR
+.br
+    Prints a list of the detected network interfaces on the startup of FTL.
+.br
+
+\fBDEBUG_LOCKS=false|true\fR
+.br
+    Print information about shared memory locks.
+.br
+    Messages will be generated when waiting, obtaining, and releasing a lock.
+.br
+
+\fBDEBUG_QUERIES=false|true\fR
+.br
+    Print extensive DNS query information (domains, types, replies, etc.).
+.br
+
+\fBDEBUG_FLAGS=false|true\fR
+.br
+    Print flags of queries received by the DNS hooks.
+.br
+    Only effective when \fBDEBUG_QUERIES\fR is enabled as well.
+
+\fBDEBUG_SHMEM=false|true\fR
+.br
+    Print information about shared memory buffers.
+.br
+    Messages are either about creating or enlarging shmem objects or string injections.
+.br
+
+\fBDEBUG_GC=false|true\fR
+.br
+    Print information about garbage collection (GC):
+.br
+    What is to be removed, how many have been removed and how long did GC take.
+.br
+
+\fBDEBUG_ARP=false|true\fR
+.br
+    Print information about ARP table processing:
+.br
+    How long did parsing take, whether read MAC addresses are valid, and if the macvendor.db file exists.
+.br
+
+\fBDEBUG_REGEX=false|true\fR
+.br
+    Controls if FTL should print extended details about regex matching.
+.br
+
+\fBDEBUG_API=false|true\fR
+.br
+    Print extra debugging information during telnet API calls.
+.br
+    Currently only used to send extra information when getting all queries.
+.br
+
+\fBDEBUG_OVERTIME=false|true\fR
+.br
+    Print information about overTime memory operations, such as initializing or moving overTime slots.
+.br
+
+\fBDEBUG_EXTBLOCKED=false|true\fR
+.br
+    Print information about why FTL decided that certain queries were recognized as being externally blocked.
+.br
+
+\fBDEBUG_CAPS=false|true\fR
+.br
+    Print information about POSIX capabilities granted to the FTL process.
+.br
+    The current capabilities are printed on receipt of SIGHUP i.e. after executing `killall -HUP pihole-FTL`.
+.br
+
+\fBDEBUG_DNSMASQ_LINES=false|true\fR
+.br
+    Print file and line causing a dnsmasq event into FTL's log files.
+.br
+    This is handy to implement additional hooks missing from FTL.
+.br
+
+\fBDEBUG_VECTORS=false|true\fR
+.br
+    FTL uses dynamically allocated vectors for various tasks.
+.br
+    This config option enables extensive debugging information such as information about allocation, referencing, deletion, and appending.
+.br
+
+\fBDEBUG_RESOLVER=false|true\fR
+.br
+    Extensive information about hostname resolution like which DNS servers are used in the first and second hostname resolving tries.
+.br
+
+.SH "SEE ALSO"
+
+\fBpihole\fR(8), \fBpihole-FTL\fR(8)
+.br
+.SH "COLOPHON"
+
+Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery quickly\fR!
+.br
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net
+.br

manpages/pihole.8

@@ -0,0 +1,379 @@
+.TH "Pi-hole" "8" "Pi-hole" "Pi-hole" "April 2020"
+.SH "NAME"
+
+Pi-hole : A black-hole for internet advertisements
+.br
+.SH "SYNOPSIS"
+
+\fBpihole\fR (\fB-w\fR|\fB-b\fR|\fB--wild\fR|\fB--regex\fR) [options] domain(s)
+.br
+\fBpihole -a\fR \fB-p\fR password
+.br
+\fBpihole -a\fR (\fB-c|-f|-k\fR)
+.br
+\fBpihole -a -e\fR email
+.br
+\fBpihole -a -i\fR interface
+.br
+\fBpihole -a -l\fR privacylevel
+.br
+\fBpihole -c\fR [-j|-r|-e]
+.br
+\fBpihole\fR \fB-d\fR [-a]
+.br
+\fBpihole -f
+.br
+pihole -r
+.br
+pihole -t
+.br
+pihole -g\fR
+.br
+\fBpihole\fR -\fBq\fR [options]
+.br
+\fBpihole\fR \fB-l\fR (\fBon|off|off noflush\fR)
+.br
+\fBpihole -up \fR[--check-only]
+.br
+\fBpihole -v\fR [-p|-a|-f] [-c|-l|-hash]
+.br
+\fBpihole uninstall
+.br
+pihole status
+.br
+pihole restartdns\fR [options]
+.br
+\fBpihole\fR (\fBenable\fR|\fBdisable\fR [time])
+.br
+\fBpihole\fR \fBcheckout\fR repo [branch]
+.br
+\fBpihole\fR \fBhelp\fR
+.br
+.SH "DESCRIPTION"
+
+Available commands and options:
+.br
+
+\fB-w, whitelist\fR [options] [<domain1> <domain2 ...>]
+.br
+    Adds or removes specified domain or domains tho the Whitelist
+.br
+
+\fB-b, blacklist\fR [options] [<domain1> <domain2 ...>]
+.br
+    Adds or removes specified domain or domains to the blacklist
+.br
+
+\fB--regex, regex\fR [options] [<regex1> <regex2 ...>]
+.br
+    Add or removes specified regex filter to the regex blacklist
+.br
+
+\fB--white-regex\fR [options] [<regex1> <regex2 ...>]
+.br
+    Add or removes specified regex filter to the regex whitelist
+.br
+
+\fB--wild, wildcard\fR [options] [<domain1> <domain2 ...>]
+.br
+    Add or removes specified domain to the wildcard blacklist
+.br
+
+\fB--white-wild\fR [options] [<domain1> <domain2 ...>]
+.br
+    Add or removes specified domain to the wildcard whitelist
+.br
+
+    (Whitelist/Blacklist manipulation options):
+.br
+      -d, --delmode     Remove domain(s) from the list
+.br
+      -nr, --noreload   Update list without refreshing dnsmasq
+.br
+      -q, --quiet       Make output less verbose
+.br
+      -l, --list        Display all your listed domains
+.br
+      --nuke            Removes all entries in a list
+.br
+
+\fB-d, debug\fR [-a]
+.br
+    Start a debugging session
+.br
+
+      -a                Enable automated debugging
+.br
+
+\fB-f, flush\fR
+.br
+    Flush the Pi-hole log
+.br
+
+\fB-r, reconfigure\fR
+.br
+    Reconfigure or Repair Pi-hole subsystems
+.br
+
+\fB-t, tail\fR
+.br
+    View the live output of the Pi-hole log
+.br
+
+\fB-a, admin\fR [options]
+.br
+
+    (Admin options):
+.br
+      -p, password      Set Web Interface password
+.br
+      -c, celsius       Set Celsius as preferred temperature unit
+.br
+      -f, fahrenheit    Set Fahrenheit as preferred temperature unit
+.br
+      -k, kelvin        Set Kelvin as preferred temperature unit
+.br
+      -e, email         Set an administrative contact address for the
+                        Block Page
+.br
+      -i, interface     Specify dnsmasq's interface listening behavior
+.br
+      -l, privacylevel  <level> Set privacy level
+                        (0 = lowest, 3 = highest)
+.br
+
+\fB-c, chronometer\fR	[options]
+.br
+    Calculates stats and displays to an LCD
+.br
+
+    (Chronometer Options):
+.br
+      -j, --json        Output stats as JSON formatted string
+.br
+      -r, --refresh     Set update frequency (in seconds)
+.br
+      -e, --exit        Output stats and exit witout refreshing
+.br
+
+\fB-g, updateGravity\fR
+.br
+    Update the list of ad-serving domains
+.br
+
+\fB-q, query\fR [option]
+.br
+    Query the adlists for a specified domain
+.br
+
+    (Query options):
+.br
+      -adlist           Print the name of the block list URL
+.br
+      -exact            Search the block lists for exact domain matches
+.br
+      -all              Return all query matches within a block list
+.br
+
+\fB-h, --help, help\fR
+.br
+    Show a help dialog
+.br
+
+\fB-l, logging\fR [on|off|off noflush]
+.br
+    Specify whether the Pi-hole log should be used
+.br
+
+	(Logging options):
+.br
+      on                Enable the Pi-hole log at /var/log/pihole.log
+.br
+      off               Disable and flush the Pi-hole log at
+                        /var/log/pihole.log
+.br
+      off noflush       Disable the Pi-hole log at /var/log/pihole.log
+.br
+
+\fB-up, updatePihole\fR [--check-only]
+.br
+    Update Pi-hole subsystems
+.br
+
+      --check-only      Exit script before update is performed.
+.br
+
+\fB-v, version\fR [repo] [options]
+.br
+    Show installed versions of Pi-hole, Web Interface &amp; FTL
+.br
+
+.br
+    (repo options):
+.br
+      -p, --pihole      Only retrieve info regarding Pi-hole repository
+.br
+      -a, --admin       Only retrieve info regarding AdminLTE
+                        repository
+.br
+      -f, --ftl         Only retrieve info regarding FTL repository
+.br
+    (version options):
+.br
+      -c, --current     Return the current version
+.br
+      -l, --latest      Return the latest version
+.br
+      --hash            Return the GitHub hash from your local
+                        repositories
+.br
+
+\fBuninstall\fR
+.br
+    Uninstall Pi-hole from your system
+.br
+
+\fBstatus\fR
+.br
+    Display the running status of Pi-hole subsystems
+.br
+
+\fBenable\fR
+.br
+    Enable Pi-hole subsystems
+.br
+
+\fBdisable\fR [time]
+.br
+    Disable Pi-hole subsystems, optionally for a set duration
+.br
+
+    (time options):
+.br
+      #s                Disable Pi-hole functionality for # second(s)
+.br
+      #m                Disable Pi-hole functionality for # minute(s)
+.br
+
+\fBrestartdns\fR [options]
+.br
+    Full restart Pi-hole subsystems. Without any options (see below) a full restart causes config file parsing and history re-reading
+.br
+
+    (restart options):
+.br
+      reload            Updates the lists (incl. HOSTS files) and flushes DNS cache. Does not reparse config files
+.br
+      reload-lists      Updates the lists (excl. HOSTS files) WITHOUT flushing the DNS cache. Does not reparse config files
+.br
+
+\fBcheckout\fR [repo] [branch]
+.br
+    Switch Pi-hole subsystems to a different GitHub branch
+.br
+
+    (repo options):
+.br
+      core              Change the branch of Pi-hole's core subsystem
+.br
+      web               Change the branch of Admin Console subsystem
+.br
+      ftl               Change the branch of Pi-hole's FTL subsystem
+.br
+    (branch options):
+.br
+      master            Update subsystems to the latest stable release
+.br
+      dev               Update subsystems to the latest development
+                        release
+.br
+      branchname        Update subsystems to the specified branchname
+.br
+.SH "EXAMPLE"
+
+Some usage examples
+.br
+
+Whitelist/blacklist manipulation
+.br
+
+\fBpihole -w iloveads.example.com\fR
+.br
+    Adds "iloveads.example.com" to whitelist
+.br
+
+\fBpihole -b -d noads.example.com\fR
+.br
+    Removes "noads.example.com" from blacklist
+.br
+
+\fBpihole --wild example.com\fR
+.br
+    Adds example.com as a wildcard - would block all subdomains of
+    example.com, including example.com itself.
+.br
+
+\fBpihole --regex "ad.*\\.example\\.com$"\fR
+.br
+    Adds "ad.*\\.example\\.com$" to the regex blacklist.
+    Would block all subdomains of example.com which start with "ad"
+.br
+
+Changing the Web Interface password
+.br
+
+\fBpihole -a -p ExamplePassword\fR
+.br
+    Change the password to "ExamplePassword"
+.br
+
+Updating lists from internet sources
+.br
+
+\fBpihole -g\fR
+.br
+    Update the list of ad-serving domains
+.br
+
+Displaying version information
+.br
+
+\fBpihole -v -a -c\fR
+.br
+    Display the current version of AdminLTE
+.br
+
+Temporarily disabling Pi-hole
+.br
+
+\fBpihole disable 5m\fR
+.br
+    Disable Pi-hole functionality for five minutes
+.br
+
+Switching Pi-hole subsystem branches
+.br
+
+\fBpihole checkout master\fR
+.br
+    Switch to master branch
+.br
+
+\fBpihole checkout core dev\fR
+.br
+    Switch to core development branch
+.br
+
+\fBpihole arpflush\fR
+.br
+    Flush information stored in Pi-hole's network tables
+.br
+
+.SH "SEE ALSO"
+
+\fBlighttpd\fR(8), \fBpihole-FTL\fR(8)
+.br
+.SH "COLOPHON"
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net.
+.br

pihole

@@ -1,54 +1,66 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Controller for all pihole scripts and functions.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
 
-PI_HOLE_SCRIPT_DIR="/opt/pihole"
+readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
-# Must be root to use this tool
+
-if [[ ! $EUID -eq 0 ]];then
+# setupVars and PI_HOLE_BIN_DIR are not readonly here because in some functions (checkout),
-  if [ -x "$(command -v sudo)" ];then
+# they might get set again when the installer is sourced. This causes an
-    exec sudo bash "$0" "$@"
+# error due to modifying a readonly variable.
-    exit $?
+setupVars="/etc/pihole/setupVars.conf"
-  else
+PI_HOLE_BIN_DIR="/usr/local/bin"
-    echo "::: sudo is needed to run pihole commands.  Please run this script as root or install sudo."
+
-    exit 1
+readonly colfile="${PI_HOLE_SCRIPT_DIR}/COL_TABLE"
-  fi
+source "${colfile}"
-fi
 
 webpageFunc() {
-  /opt/pihole/webpage.sh "$@"
+  source "${PI_HOLE_SCRIPT_DIR}/webpage.sh"
+  main "$@"
   exit 0
 }
 
-whitelistFunc() {
+listFunc() {
- "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
-  exit 0
-}
-
-blacklistFunc() {
   "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
   exit 0
 }
 
 debugFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
+  local automated
+  local web
+
+  # Pull off the `debug` leaving passed call augmentation flags in $1
+  shift
+  if [[ "$@" == *"-a"* ]]; then
+    automated="true"
+  fi
+  if [[ "$@" == *"-w"* ]]; then
+    web="true"
+  fi
+
+  AUTOMATED=${automated:-} WEBCALL=${web:-} "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
   exit 0
 }
 
 flushFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh "$@"
+  exit 0
+}
+
+arpFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeARPTable.sh "$@"
   exit 0
 }
 
 updatePiholeFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/update.sh
+  shift
+  "${PI_HOLE_SCRIPT_DIR}"/update.sh "$@"
   exit 0
 }
 
@@ -59,39 +71,12 @@ reconfigurePiholeFunc() {
 
 updateGravityFunc() {
   "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
-  exit 0
+  exit $?
-}
-
-setupLCDFunction() {
-  "${PI_HOLE_SCRIPT_DIR}"/setupLCD.sh
-  exit 0
-}
-
-scanList(){
-  domain="${1}"
-  list="${2}"
-  method="${3}"
-  if [[ ${method} == "-exact" ]] ; then
-    grep -E "(^|\s)${domain}($|\s)" "${list}"
-  else
-    grep "${domain}" "${list}"
-  fi
 }
 
 queryFunc() {
-  domain="${2}"
+  shift
-  method="${3}"
+  "${PI_HOLE_SCRIPT_DIR}"/query.sh "$@"
-  lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
-  for list in ${lists[@]}; do
-    result=$(scanList ${domain} ${list} ${method})
-    # Remove empty lines before couting number of results
-    count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
-    echo "::: ${list} (${count} results)"
-    if [[ ${count} > 0 ]]; then
-      echo "${result}"
-    fi
-    echo ""
-  done
   exit 0
 }
 
@@ -114,142 +99,356 @@ versionFunc() {
 }
 
 restartDNS() {
-  dnsmasqPid=$(pidof dnsmasq)
+  local svcOption svc str output status
-  if [[ ${dnsmasqPid} ]]; then
+  svcOption="${1:-restart}"
-    # service already running - reload config
+
-    if [ -x "$(command -v systemctl)" ]; then
+  # Determine if we should reload or restart
-      systemctl restart dnsmasq
+  if [[ "${svcOption}" =~ "reload-lists" ]]; then
-    else
+    # Reloading of the lists has been requested
-      service dnsmasq restart
+    # Note 1: This will NOT re-read any *.conf files
-    fi
+    # Note 2: We cannot use killall here as it does
+    #         not know about real-time signals
+    svc="pkill -RTMIN pihole-FTL"
+    str="Reloading DNS lists"
+  elif [[ "${svcOption}" =~ "reload" ]]; then
+    # Reloading of the DNS cache has been requested
+    # Note: This will NOT re-read any *.conf files
+    svc="pkill -HUP pihole-FTL"
+    str="Flushing DNS cache"
   else
-    # service not running, start it up
+    # A full restart has been requested
-    if [ -x "$(command -v systemctl)" ]; then
+    svc="service pihole-FTL restart"
-      systemctl start dnsmasq
+    str="Restarting DNS server"
-    else
+  fi
-      service dnsmasq start
+
-    fi
+  # Print output to Terminal, but not to Web Admin
+  [[ -t 1 ]] && echo -ne "  ${INFO} ${str}..."
+
+  output=$( { ${svc}; } 2>&1 )
+  status="$?"
+
+  if [[ "${status}" -eq 0 ]]; then
+    [[ -t 1 ]] && echo -e "${OVER}  ${TICK} ${str}"
+    return 0
+  else
+    [[ ! -t 1 ]] && local OVER=""
+    echo -e "${OVER}  ${CROSS} ${output}"
+    return 1
   fi
 }
 
 piholeEnable() {
-  if [[ "${1}" == "0" ]] ; then
+  if [[ "${2}" == "-h" ]] || [[ "${2}" == "--help" ]]; then
-    #Disable Pihole
+    echo "Usage: pihole disable [time]
-    sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
+Example: 'pihole disable', or 'pihole disable 5m'
-    echo "::: Blocking has been disabled!"
+Disable Pi-hole subsystems
-    if [[ $# > 1 ]] ; then
+
-      if [[ ${2} == *"s"* ]] ; then
+Time:
+  #s                  Disable Pi-hole functionality for # second(s)
+  #m                  Disable Pi-hole functionality for # minute(s)"
+    exit 0
+
+  elif [[ "${1}" == "0" ]]; then
+    # Disable Pi-hole
+    if grep -cq "BLOCKING_ENABLED=false" "${setupVars}"; then
+      echo -e "  ${INFO} Blocking already disabled, nothing to do"
+      exit 0
+    fi
+    if [[ $# > 1 ]]; then
+      local error=false
+      if [[ "${2}" == *"s" ]]; then
         tt=${2%"s"}
-        echo "::: Blocking will be re-enabled in ${tt} seconds"
+        if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
-        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+          local str="Disabling blocking for ${tt} seconds"
-      elif [[ ${2} == *"m"* ]] ; then
+          echo -e "  ${INFO} ${str}..."
+          local str="Blocking will be re-enabled in ${tt} seconds"
+          nohup "${PI_HOLE_SCRIPT_DIR}"/pihole-reenable.sh ${tt} </dev/null &>/dev/null &
+        else
+          local error=true
+        fi
+      elif [[ "${2}" == *"m" ]]; then
         tt=${2%"m"}
-        echo "::: Blocking will be re-enabled in ${tt} minutes"
+          if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
-        tt=$((${tt}*60))
+          local str="Disabling blocking for ${tt} minutes"
-        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+          echo -e "  ${INFO} ${str}..."
+          local str="Blocking will be re-enabled in ${tt} minutes"
+          tt=$((${tt}*60))
+          nohup "${PI_HOLE_SCRIPT_DIR}"/pihole-reenable.sh ${tt} </dev/null &>/dev/null &
+        else
+          local error=true
+        fi
+      elif [[ -n "${2}" ]]; then
+        local error=true
       else
-        echo "::: Unknown format for delayed reactivation of the blocking!"
+        echo -e "  ${INFO} Disabling blocking"
-        echo "::: Example:"
-        echo ":::    pihole disable 5s    -    will disable blocking for 5 seconds"
-        echo ":::    pihole disable 7m    -    will disable blocking for 7 minutes"
-        echo "::: Blocking will not automatically be re-enabled!"
       fi
+
+      if [[ ${error} == true ]];then
+        echo -e "  ${COL_LIGHT_RED}Unknown format for delayed reactivation of the blocking!${COL_NC}"
+        echo -e "  Try 'pihole disable --help' for more information."
+        exit 1
+      fi
+
+      local str="Pi-hole Disabled"
+      sed -i "/BLOCKING_ENABLED=/d" "${setupVars}"
+      echo "BLOCKING_ENABLED=false" >> "${setupVars}"
     fi
   else
-    #Enable pihole
+    # Enable Pi-hole
-    echo "::: Blocking has been enabled!"
+    killall -q pihole-reenable
-    sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
+    if grep -cq "BLOCKING_ENABLED=true" "${setupVars}"; then
+      echo -e "  ${INFO} Blocking already enabled, nothing to do"
+      exit 0
+    fi
+    echo -e "  ${INFO} Enabling blocking"
+    local str="Pi-hole Enabled"
+
+    sed -i "/BLOCKING_ENABLED=/d" "${setupVars}"
+    echo "BLOCKING_ENABLED=true" >> "${setupVars}"
   fi
-  restartDNS
+
+  restartDNS reload
+
+  echo -e "${OVER}  ${TICK} ${str}"
 }
 
 piholeLogging() {
   shift
+  if [[ "${1}" == "-h" ]] || [[ "${1}" == "--help" ]]; then
+    echo "Usage: pihole logging [options]
+Example: 'pihole logging on'
+Specify whether the Pi-hole log should be used
 
-  if [[ "${1}" == "off" ]] ; then
+Options:
-    #Disable Logging
+  on                  Enable the Pi-hole log at /var/log/pihole.log
+  off                 Disable and flush the Pi-hole log at /var/log/pihole.log
+  off noflush         Disable the Pi-hole log at /var/log/pihole.log"
+    exit 0
+  elif [[ "${1}" == "off" ]]; then
+    # Disable logging
     sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
     sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
-    pihole -f
+    if [[ "${2}" != "noflush" ]]; then
-    echo "::: Logging has been disabled!"
+      # Flush logs
-  elif [[ "${1}" == "on" ]] ; then
+      "${PI_HOLE_BIN_DIR}"/pihole -f
-    #Enable logging
+    fi
+    echo -e "  ${INFO} Disabling logging..."
+    local str="Logging has been disabled!"
+  elif [[ "${1}" == "on" ]]; then
+    # Enable logging
     sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
     sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
-    echo "::: Logging has been enabled!"
+    echo -e "  ${INFO} Enabling logging..."
+    local str="Logging has been enabled!"
   else
-    echo "::: Invalid option passed, please pass 'on' or 'off'"
+    echo -e "  ${COL_LIGHT_RED}Invalid option${COL_NC}
+  Try 'pihole logging --help' for more information."
     exit 1
   fi
   restartDNS
+  echo -e "${OVER}  ${TICK} ${str}"
 }
 
-piholeStatus() {
+analyze_ports() {
-  if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
+  # FTL is listening at least on at least one port when this
-    #list is commented out
+  # function is getting called
-    if [[ "${1}" == "web" ]] ; then
+  echo -e "  ${TICK} DNS service is listening"
-      echo 0;
+  # Check individual address family/protocol combinations
-    else
+  # For a healthy Pi-hole, they should all be up (nothing printed)
-      echo "::: Pi-hole blocking is Disabled";
+  if grep -q "IPv4.*UDP" <<< "${1}"; then
-    fi
+      echo -e "     ${TICK} UDP (IPv4)"
-  elif [[ $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
+  else
-    #list set
+      echo -e "     ${CROSS} UDP (IPv4)"
-    if [[ "${1}" == "web" ]] ; then
+  fi
-      echo 1;
+  if grep -q "IPv4.*TCP" <<< "${1}"; then
-    else
+      echo -e "     ${TICK} TCP (IPv4)"
-      echo "::: Pi-hole blocking is Enabled";
+  else
+      echo -e "     ${CROSS} TCP (IPv4)"
+  fi
+  if grep -q "IPv6.*UDP" <<< "${1}"; then
+      echo -e "     ${TICK} UDP (IPv6)"
+  else
+      echo -e "     ${CROSS} UDP (IPv6)"
+  fi
+  if grep -q "IPv6.*TCP" <<< "${1}"; then
+      echo -e "     ${TICK} TCP (IPv6)"
+  else
+      echo -e "     ${CROSS} TCP (IPv6)"
+  fi
+  echo ""
+}
+
+statusFunc() {
+  # Determine if there is a pihole service is listening on port 53
+  local listening
+  listening="$(lsof -Pni:53)"
+  if grep -q "pihole" <<< "${listening}"; then
+    if [[ "${1}" != "web" ]]; then
+      analyze_ports "${listening}"
     fi
   else
-    #addn-host not found
+    case "${1}" in
-    if [[ "${1}" == "web" ]] ; then
+      "web") echo "-1";;
-      echo 99
+      *) echo -e "  ${CROSS} DNS service is NOT listening";;
-    else
+    esac
-      echo ":::  No hosts file linked to dnsmasq, adding it in enabled state"
+    return 0
-    fi
+  fi
-    #add addn-host= to dnsmasq
+
-    echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
+  # Determine if Pi-hole's blocking is enabled
-    restartDNS
+  if grep -q "BLOCKING_ENABLED=false" /etc/pihole/setupVars.conf; then
+    # A config is commented out
+    case "${1}" in
+      "web") echo 0;;
+      *) echo -e "  ${CROSS} Pi-hole blocking is disabled";;
+    esac
+  elif grep -q "BLOCKING_ENABLED=true" /etc/pihole/setupVars.conf;  then
+    # Configs are set
+    case "${1}" in
+      "web") echo 1;;
+      *) echo -e "  ${TICK} Pi-hole blocking is enabled";;
+    esac
+  else
+    # No configs were found
+    case "${1}" in
+      "web") echo 99;;
+      *) echo -e "  ${INFO} Pi-hole blocking will be enabled";;
+    esac
+    # Enable blocking
+    "${PI_HOLE_BIN_DIR}"/pihole enable
   fi
 }
 
 tailFunc() {
-  echo "Press Ctrl-C to exit"
+  # Warn user if Pi-hole's logging is disabled
-  tail -F /var/log/pihole.log
+  local logging_enabled=$(grep -c "^log-queries" /etc/dnsmasq.d/01-pihole.conf)
+  if [[ "${logging_enabled}" == "0" ]]; then
+    # No "log-queries" lines are found.
+    # Commented out lines (such as "#log-queries") are ignored
+    echo "  ${CROSS} Warning: Query logging is disabled"
+  fi
+  echo -e "  ${INFO} Press Ctrl-C to exit"
+
+  # Retrieve IPv4/6 addresses
+  source /etc/pihole/setupVars.conf
+
+  # Strip date from each line
+  # Color blocklist/blacklist/wildcard entries as red
+  # Color A/AAAA/DHCP strings as white
+  # Color everything else as gray
+  tail -f /var/log/pihole.log | sed -E \
+    -e "s,($(date +'%b %d ')| dnsmasq\[[0-9]*\]),,g" \
+    -e "s,(.*(blacklisted |gravity blocked ).* is (0.0.0.0|::|NXDOMAIN|${IPV4_ADDRESS%/*}|${IPV6_ADDRESS:-NULL}).*),${COL_RED}&${COL_NC}," \
+    -e "s,.*(query\\[A|DHCP).*,${COL_NC}&${COL_NC}," \
+    -e "s,.*,${COL_GRAY}&${COL_NC},"
+  exit 0
+}
+
+piholeCheckoutFunc() {
+  if [[ "$2" == "-h" ]] || [[ "$2" == "--help" ]]; then
+    echo "Usage: pihole checkout [repo] [branch]
+Example: 'pihole checkout master' or 'pihole checkout core dev'
+Switch Pi-hole subsystems to a different GitHub branch
+
+Repositories:
+  core [branch]       Change the branch of Pi-hole's core subsystem
+  web [branch]        Change the branch of Web Interface subsystem
+  ftl [branch]        Change the branch of Pi-hole's FTL subsystem
+
+Branches:
+  master              Update subsystems to the latest stable release
+  dev                 Update subsystems to the latest development release
+  branchname          Update subsystems to the specified branchname"
+    exit 0
+  fi
+
+  source "${PI_HOLE_SCRIPT_DIR}"/piholeCheckout.sh
+  shift
+  checkout "$@"
+}
+
+tricorderFunc() {
+  if [[ ! -p "/dev/stdin" ]]; then
+    echo -e "  ${INFO} Please do not call Tricorder directly"
+    exit 1
+  fi
+
+  if ! (echo > /dev/tcp/tricorder.pi-hole.net/9998) >/dev/null 2>&1; then
+    echo -e "  ${CROSS} Unable to connect to Pi-hole's Tricorder server"
+    exit 1
+  fi
+
+  if command -v openssl &> /dev/null; then
+    openssl s_client -quiet -connect tricorder.pi-hole.net:9998 2> /dev/null < /dev/stdin
+    exit "$?"
+  else
+    echo -e "  ${INFO} ${COL_YELLOW}Security Notice${COL_NC}: ${COL_WHITE}openssl${COL_NC} is not installed
+       Your debug log will be transmitted unencrypted via plain-text
+       There is a possibility that this could be intercepted by a third party
+       If you wish to cancel, press Ctrl-C to exit within 10 seconds"
+    secs="10"
+    while [[ "$secs" -gt "0" ]]; do
+       echo -ne "."
+       sleep 1
+       : $((secs--))
+    done
+    echo " "
+    nc tricorder.pi-hole.net 9999 < /dev/stdin
+    exit "$?"
+  fi
+}
+
+updateCheckFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/updatecheck.sh "$@"
   exit 0
 }
 
 helpFunc() {
-	cat << EOM
+  echo "Usage: pihole [options]
-::: Control all PiHole specific functions!
+Example: 'pihole -w -h'
-:::
+Add '-h' after specific commands for more information on usage
-::: Usage: pihole [options]
+
-:::		Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin)  for more information on usage
+Whitelist/Blacklist Options:
-:::
+  -w, whitelist       Whitelist domain(s)
-::: Options:
+  -b, blacklist       Blacklist domain(s)
-:::  -w, whitelist            Whitelist domains
+  --regex, regex      Regex blacklist domains(s)
-:::  -b, blacklist            Blacklist domains
+  --white-regex       Regex whitelist domains(s)
-:::  -d, debug                Start a debugging session if having trouble
+  --wild, wildcard    Wildcard blacklist domain(s)
-:::  -f, flush                Flush the pihole.log file
+  --white-wild        Wildcard whitelist domain(s)
-:::  -t, tail                 Output the last lines of the pihole.log file. Lines are appended as the file grows
+                        Add '-h' for more info on whitelist/blacklist usage
-:::  -up, updatePihole        Update Pi-hole
+
-:::  -r, reconfigure          Reconfigure or Repair Pi-hole
+Debugging Options:
-:::  -g, updateGravity        Update the list of ad-serving domains
+  -d, debug           Start a debugging session
-:::  -s, setupLCD             Automatically configures the Pi to use the 2.8 LCD screen to display stats on it
+                        Add '-a' to automatically upload the log to tricorder.pi-hole.net
-:::  -c, chronometer          Calculates stats and displays to an LCD
+  -f, flush           Flush the Pi-hole log
-:::  -h, help                 Show this help dialog
+  -r, reconfigure     Reconfigure or Repair Pi-hole subsystems
-:::  -v, version              Show current versions
+  -t, tail            View the live output of the Pi-hole log
-:::  -q, query                Query the adlists for a specific domain
+
-:::                           Use pihole -q domain -exact if you want to see exact matches only
+Options:
-:::  -l, logging              Enable or Disable logging (pass 'on' or 'off')
+  -a, admin           Web interface options
-:::  -a, admin                Admin webpage options
+                        Add '-h' for more info on Web Interface usage
-:::  uninstall                Uninstall Pi-Hole from your system :(!
+  -c, chronometer     Calculates stats and displays to an LCD
-:::  status                   Is Pi-Hole Enabled or Disabled
+                        Add '-h' for more info on chronometer usage
-:::  enable                   Enable Pi-Hole DNS Blocking
+  -g, updateGravity   Update the list of ad-serving domains
-:::  disable                  Disable Pi-Hole DNS Blocking
+  -h, --help, help    Show this help dialog
-:::                           Blocking can also be disabled only temporarily, e.g.,
+  -l, logging         Specify whether the Pi-hole log should be used
-:::                           pihole disable 5m - will disable blocking for 5 minutes
+                        Add '-h' for more info on logging usage
-:::  restartdns               Restart dnsmasq
+  -q, query           Query the adlists for a specified domain
-EOM
+                        Add '-h' for more info on query usage
+  -up, updatePihole   Update Pi-hole subsystems
+                        Add '--check-only' to exit script before update is performed.
+  -v, version         Show installed versions of Pi-hole, Web Interface & FTL
+                        Add '-h' for more info on version usage
+  uninstall           Uninstall Pi-hole from your system
+  status              Display the running status of Pi-hole subsystems
+  enable              Enable Pi-hole subsystems
+  disable             Disable Pi-hole subsystems
+                        Add '-h' for more info on disable usage
+  restartdns          Full restart Pi-hole subsystems
+                        Add 'reload' to update the lists and flush the cache without restarting the DNS server
+                        Add 'reload-lists' to only update the lists WITHOUT flushing the cache or restarting the DNS server
+  checkout            Switch Pi-hole subsystems to a different GitHub branch
+                        Add '-h' for more info on checkout usage
+  arpflush            Flush information stored in Pi-hole's network tables";
   exit 0
 }
 
@@ -257,16 +456,34 @@ if [[ $# = 0 ]]; then
   helpFunc
 fi
 
+case "${1}" in
+  "-h" | "help" | "--help"      ) helpFunc;;
+esac
+
+# Must be root to use this tool
+if [[ ! $EUID -eq 0 ]];then
+  if [[ -x "$(command -v sudo)" ]]; then
+    exec sudo bash "$0" "$@"
+    exit $?
+  else
+    echo -e "  ${CROSS} sudo is needed to run pihole commands.  Please run this script as root or install sudo."
+    exit 1
+  fi
+fi
+
 # Handle redirecting to specific functions based on arguments
 case "${1}" in
-  "-w" | "whitelist"            ) whitelistFunc "$@";;
+  "-w" | "whitelist"            ) listFunc "$@";;
-  "-b" | "blacklist"            ) blacklistFunc "$@";;
+  "-b" | "blacklist"            ) listFunc "$@";;
-  "-d" | "debug"                ) debugFunc;;
+  "--wild" | "wildcard"         ) listFunc "$@";;
-  "-f" | "flush"                ) flushFunc;;
+  "--regex" | "regex"           ) listFunc "$@";;
-  "-up" | "updatePihole"        ) updatePiholeFunc;;
+  "--white-regex" | "white-regex" ) listFunc "$@";;
+  "--white-wild" | "white-wild"   ) listFunc "$@";;
+  "-d" | "debug"                ) debugFunc "$@";;
+  "-f" | "flush"                ) flushFunc "$@";;
+  "-up" | "updatePihole"        ) updatePiholeFunc "$@";;
   "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
   "-g" | "updateGravity"        ) updateGravityFunc "$@";;
-  "-s" | "setupLCD"             ) setupLCDFunction;;
   "-c" | "chronometer"          ) chronometerFunc "$@";;
   "-h" | "help"                 ) helpFunc;;
   "-v" | "version"              ) versionFunc "$@";;
@@ -274,10 +491,14 @@ case "${1}" in
   "-l" | "logging"              ) piholeLogging "$@";;
   "uninstall"                   ) uninstallFunc;;
   "enable"                      ) piholeEnable 1;;
-  "disable"                     ) piholeEnable 0 $2;;
+  "disable"                     ) piholeEnable 0 "$2";;
-  "status"                      ) piholeStatus "$2";;
+  "status"                      ) statusFunc "$2";;
-  "restartdns"                  ) restartDNS;;
+  "restartdns"                  ) restartDNS "$2";;
   "-a" | "admin"                ) webpageFunc "$@";;
   "-t" | "tail"                 ) tailFunc;;
+  "checkout"                    ) piholeCheckoutFunc "$@";;
+  "tricorder"                   ) tricorderFunc;;
+  "updatechecker"               ) updateCheckFunc "$@";;
+  "arpflush"                    ) arpFunc "$@";;
   *                             ) helpFunc;;
 esac

requirements.txt

@@ -1,5 +0,0 @@
-docker-compose
-pytest
-pytest-xdist
-pytest-cov
-testinfra

supportedos.txt

@@ -0,0 +1,5 @@
+Raspbian=9,10
+Ubuntu=16,18,20
+Debian=9,10
+Fedora=31,32
+CentOS=7,8

test/README.md

@@ -0,0 +1,25 @@
+# Recommended way to run tests
+
+Make sure you have Docker and Python w/pip package manager.
+
+From command line all you need to do is:
+
+- `pip install tox`
+- `tox`
+
+Tox handles setting up a virtual environment for python dependencies, installing dependencies, building the docker images used by tests, and finally running tests.  It's an easy way to have travis-ci like build behavior locally.
+
+## Alternative py.test method of running tests
+
+You're responsible for setting up your virtual env and dependencies in this situation.
+
+```
+py.test -vv -n auto -m "build_stage"
+py.test -vv -n auto -m "not build_stage"
+```
+
+The build_stage tests have to run first to create the docker images, followed by the actual tests which utilize said images.  Unless you're changing your dockerfiles you shouldn't have to run the build_stage every time - but it's a good idea to rebuild at least once a day in case the base Docker images or packages change.
+
+# How do I debug python?
+
+Highly recommended: Setup PyCharm on a **Docker enabled** machine.  Having a python debugger like PyCharm changes your life if you've never used it :)

test/_centos_8.Dockerfile

@@ -1,4 +1,4 @@
-FROM debian:jessie
+FROM centos:8
 
 ENV GITDIR /etc/.pihole
 ENV SCRIPTDIR /opt/pihole

test/_debian_10.Dockerfile

@@ -0,0 +1,16 @@
+FROM buildpack-deps:buster-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_debian_9.Dockerfile

@@ -0,0 +1,16 @@
+FROM buildpack-deps:stretch-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_fedora_31.Dockerfile

@@ -0,0 +1,16 @@
+FROM fedora:31
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_fedora_32.Dockerfile

@@ -0,0 +1,16 @@
+FROM fedora:32
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_16.Dockerfile

@@ -0,0 +1,16 @@
+FROM buildpack-deps:xenial-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_18.Dockerfile

@@ -0,0 +1,16 @@
+FROM buildpack-deps:bionic-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_20.Dockerfile

@@ -0,0 +1,17 @@
+FROM buildpack-deps:focal-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/conftest.py

@@ -1,14 +1,30 @@
 import pytest
 import testinfra
+from textwrap import dedent
 
 check_output = testinfra.get_backend(
     "local://"
 ).get_module("Command").check_output
 
+SETUPVARS = {
+    'PIHOLE_INTERFACE': 'eth99',
+    'IPV4_ADDRESS': '1.1.1.1',
+    'IPV6_ADDRESS': 'FE80::240:D0FF:FE48:4672',
+    'PIHOLE_DNS_1': '4.2.2.1',
+    'PIHOLE_DNS_2': '4.2.2.2'
+}
+
+tick_box = "[\x1b[1;32m\u2713\x1b[0m]"
+cross_box = "[\x1b[1;31m\u2717\x1b[0m]"
+info_box = "[i]"
+
+
 @pytest.fixture
 def Pihole(Docker):
-    ''' used to contain some script stubbing, now pretty much an alias.
+    '''
-    Also provides bash as the default run function shell '''
+    used to contain some script stubbing, now pretty much an alias.
+    Also provides bash as the default run function shell
+    '''
     def run_bash(self, command, *args, **kwargs):
         cmd = self.get_command(command, *args)
         if self.user is not None:
@@ -22,12 +38,16 @@ def Pihole(Docker):
         return out
 
     funcType = type(Docker.run)
-    Docker.run = funcType(run_bash, Docker, testinfra.backend.docker.DockerBackend)
+    Docker.run = funcType(run_bash, Docker)
     return Docker
 
+
 @pytest.fixture
 def Docker(request, args, image, cmd):
-    ''' combine our fixtures into a docker run command and setup finalizer to cleanup '''
+    '''
+    combine our fixtures into a docker run command and setup finalizer to
+    cleanup
+    '''
     assert 'docker' in check_output('id'), "Are you in the docker group?"
     docker_run = "docker run {} {} {}".format(args, image, cmd)
     docker_id = check_output(docker_run)
@@ -40,22 +60,97 @@ def Docker(request, args, image, cmd):
     docker_container.id = docker_id
     return docker_container
 
+
 @pytest.fixture
 def args(request):
-    ''' -t became required when tput began being used '''
+    '''
+    -t became required when tput began being used
+    '''
     return '-t -d'
 
-@pytest.fixture(params=['debian', 'centos'])
+
+@pytest.fixture(params=[
+    'test_container'
+])
 def tag(request):
-    ''' consumed by image to make the test matrix '''
+    '''
+    consumed by image to make the test matrix
+    '''
     return request.param
 
+
 @pytest.fixture()
 def image(request, tag):
-    ''' built by test_000_build_containers.py '''
+    '''
+    built by test_000_build_containers.py
+    '''
     return 'pytest_pihole:{}'.format(tag)
 
+
 @pytest.fixture()
 def cmd(request):
-    ''' default to doing nothing by tailing null, but don't exit '''
+    '''
+    default to doing nothing by tailing null, but don't exit
+    '''
     return 'tail -f /dev/null'
+
+
+# Helper functions
+def mock_command(script, args, container):
+    '''
+    Allows for setup of commands we don't really want to have to run for real
+    in unit tests
+    '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        {arg})
+        echo {res}
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
+
+
+def mock_command_2(script, args, container):
+    '''
+    Allows for setup of commands we don't really want to have to run for real
+    in unit tests
+    '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1 \$2" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        \"{arg}\")
+        echo \"{res}\"
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
+
+
+def run_script(Pihole, script):
+    result = Pihole.run(script)
+    assert result.rc == 0
+    return result

test/requirements.txt

@@ -0,0 +1,6 @@
+docker-compose==1.23.2
+pytest==4.3.0
+pytest-xdist==1.26.1
+pytest-cov==2.6.1
+testinfra==1.19.0
+tox==3.7.0

test/setup.py

@@ -0,0 +1,6 @@
+from setuptools import setup
+
+setup(
+    setup_requires=['pytest-runner'],
+    tests_require=['pytest'],
+)

test/test_000_build_containers.py

@@ -1,18 +0,0 @@
-''' This file starts with 000 to make it run first '''
-import pytest
-import testinfra
-
-run_local = testinfra.get_backend(
-    "local://"
-).get_module("Command").run
-
-@pytest.mark.parametrize("image,tag", [
-    ( 'test/debian.Dockerfile', 'pytest_pihole:debian' ),
-    ( 'test/centos.Dockerfile', 'pytest_pihole:centos' ),
-])
-def test_build_pihole_image(image, tag):
-    build_cmd = run_local('docker build -f {} -t {} .'.format(image, tag))
-    if build_cmd.rc != 0:
-        print build_cmd.stdout
-        print build_cmd.stderr
-    assert build_cmd.rc == 0

test/test_automated_install.py

@@ -1,20 +1,40 @@
-import pytest
 from textwrap import dedent
+import re
+from .conftest import (
+    SETUPVARS,
+    tick_box,
+    info_box,
+    cross_box,
+    mock_command,
+    mock_command_2,
+    run_script
+)
+
+
+def test_supported_operating_system(Pihole):
+    '''
+    confirm installer exists on unsupported distribution
+    '''
+    # break supported package managers to emulate an unsupported distribution
+    Pihole.run('rm -rf /usr/bin/apt-get')
+    Pihole.run('rm -rf /usr/bin/rpm')
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = cross_box + ' OS distribution not supported'
+    assert expected_stdout in distro_check.stdout
+    # assert distro_check.rc == 1
 
-SETUPVARS = {
-    'PIHOLE_INTERFACE' : 'eth99',
-    'IPV4_ADDRESS' : '1.1.1.1',
-    'IPV6_ADDRESS' : 'FE80::240:D0FF:FE48:4672',
-    'PIHOLE_DNS_1' : '4.2.2.1',
-    'PIHOLE_DNS_2' : '4.2.2.2'
-}
 
 def test_setupVars_are_sourced_to_global_scope(Pihole):
-    ''' currently update_dialogs sources setupVars with a dot,
+    '''
+    currently update_dialogs sources setupVars with a dot,
     then various other functions use the variables.
-    This confirms the sourced variables are in scope between functions '''
+    This confirms the sourced variables are in scope between functions
+    '''
     setup_var_file = 'cat <<EOF> /etc/pihole/setupVars.conf\n'
-    for k,v in SETUPVARS.iteritems():
+    for k, v in SETUPVARS.items():
         setup_var_file += "{}={}\n".format(k, v)
     setup_var_file += "EOF\n"
     Pihole.run(setup_var_file)
@@ -39,13 +59,17 @@ def test_setupVars_are_sourced_to_global_scope(Pihole):
 
     output = run_script(Pihole, script).stdout
 
-    for k,v in SETUPVARS.iteritems():
+    for k, v in SETUPVARS.items():
         assert "{}={}".format(k, v) in output
 
+
 def test_setupVars_saved_to_file(Pihole):
-    ''' confirm saved settings are written to a file for future updates to re-use '''
+    '''
-    set_setup_vars = '\n'  # dedent works better with this and padding matching script below
+    confirm saved settings are written to a file for future updates to re-use
-    for k,v in SETUPVARS.iteritems():
+    '''
+    # dedent works better with this and padding matching script below
+    set_setup_vars = '\n'
+    for k, v in SETUPVARS.items():
         set_setup_vars += "    {}={}\n".format(k, v)
     Pihole.run(set_setup_vars).stdout
 
@@ -55,48 +79,519 @@ def test_setupVars_saved_to_file(Pihole):
     TERM=xterm
     source /opt/pihole/basic-install.sh
     {}
+    mkdir -p /etc/dnsmasq.d
+    version_check_dnsmasq
+    echo "" > /etc/pihole/pihole-FTL.conf
     finalExports
     cat /etc/pihole/setupVars.conf
     '''.format(set_setup_vars))
 
     output = run_script(Pihole, script).stdout
 
-    for k,v in SETUPVARS.iteritems():
+    for k, v in SETUPVARS.items():
         assert "{}={}".format(k, v) in output
 
-def test_configureFirewall_firewalld_no_errors(Pihole):
+
-    ''' confirms firewalld rules are applied when appopriate '''
+def test_selinux_not_detected(Pihole):
-    mock_command('firewall-cmd', '0', Pihole)
+    '''
-    configureFirewall = Pihole.run('''
+    confirms installer continues when SELinux configuration file does not exist
+    '''
+    check_selinux = Pihole.run('''
+    rm -f /etc/selinux/config
     source /opt/pihole/basic-install.sh
-    configureFirewall
+    checkSelinux
     ''')
-    expected_stdout = '::: Configuring firewalld for httpd and dnsmasq.'
+    expected_stdout = info_box + ' SELinux not detected'
-    assert expected_stdout in configureFirewall.stdout
+    assert expected_stdout in check_selinux.stdout
-    firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
+    assert check_selinux.rc == 0
-    assert 'firewall-cmd --state' in firewall_calls
-    assert 'firewall-cmd --permanent --add-port=80/tcp' in firewall_calls
-    assert 'firewall-cmd --permanent --add-port=53/tcp' in firewall_calls
-    assert 'firewall-cmd --permanent --add-port=53/udp' in firewall_calls
-    assert 'firewall-cmd --reload' in firewall_calls
 
 
-# Helper functions
+def test_installPiholeWeb_fresh_install_no_errors(Pihole):
-def mock_command(script, result, container):
+    '''
-    ''' Allows for setup of commands we don't really want to have to run for real in unit tests '''
+    confirms all web page assets from Core repo are installed on a fresh build
-    ''' TODO: support array of results that enable the results to change over multiple executions of a command '''
+    '''
-    full_script_path = '/usr/local/bin/{}'.format(script)
+    installWeb = Pihole.run('''
-    mock_script = dedent('''\
+    source /opt/pihole/basic-install.sh
-    #!/bin/bash -e
+    installPiholeWeb
-    echo "\$0 \$@" >> /var/log/{script}
+    ''')
-    exit {retcode}
+    expected_stdout = info_box + ' Installing blocking page...'
-    '''.format(script=script, retcode=result))
+    assert expected_stdout in installWeb.stdout
-    container.run('''
+    expected_stdout = tick_box + (' Creating directory for blocking page, '
-    cat <<EOF> {script}\n{content}\nEOF
+                                  'and copying files')
-    chmod +x {script}
+    assert expected_stdout in installWeb.stdout
-    '''.format(script=full_script_path, content=mock_script))
+    expected_stdout = info_box + ' Backing up index.lighttpd.html'
+    assert expected_stdout in installWeb.stdout
+    expected_stdout = ('No default index.lighttpd.html file found... '
+                       'not backing up')
+    assert expected_stdout in installWeb.stdout
+    expected_stdout = tick_box + ' Installing sudoer file'
+    assert expected_stdout in installWeb.stdout
+    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
+    assert 'index.php' in web_directory
+    assert 'blockingpage.css' in web_directory
 
-def run_script(Pihole, script):
+
-    result = Pihole.run(script)
+def test_update_package_cache_success_no_errors(Pihole):
-    assert result.rc == 0
+    '''
-    return result
+    confirms package cache was updated without any errors
+    '''
+    updateCache = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    update_package_cache
+    ''')
+    expected_stdout = tick_box + ' Update local cache of available packages'
+    assert expected_stdout in updateCache.stdout
+    assert 'error' not in updateCache.stdout.lower()
+
+
+def test_update_package_cache_failure_no_errors(Pihole):
+    '''
+    confirms package cache was not updated
+    '''
+    mock_command('apt-get', {'update': ('', '1')}, Pihole)
+    updateCache = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    update_package_cache
+    ''')
+    expected_stdout = cross_box + ' Update local cache of available packages'
+    assert expected_stdout in updateCache.stdout
+    assert 'Error: Unable to update package cache.' in updateCache.stdout
+
+
+def test_FTL_detect_aarch64_no_errors(Pihole):
+    '''
+    confirms only aarch64 package is downloaded for FTL engine
+    '''
+    # mock uname to return aarch64 platform
+    mock_command('uname', {'-m': ('aarch64', '0')}, Pihole)
+    # mock ldd to respond with aarch64 shared library
+    mock_command(
+        'ldd',
+        {
+            '/bin/ls': (
+                '/lib/ld-linux-aarch64.so.1',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected AArch64 (64 Bit ARM) processor'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_armv4t_no_errors(Pihole):
+    '''
+    confirms only armv4t package is downloaded for FTL engine
+    '''
+    # mock uname to return armv4t platform
+    mock_command('uname', {'-m': ('armv4t', '0')}, Pihole)
+    # mock ldd to respond with ld-linux shared library
+    mock_command('ldd', {'/bin/ls': ('/lib/ld-linux.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + (' Detected ARMv4 processor')
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_armv5te_no_errors(Pihole):
+    '''
+    confirms only armv5te package is downloaded for FTL engine
+    '''
+    # mock uname to return armv5te platform
+    mock_command('uname', {'-m': ('armv5te', '0')}, Pihole)
+    # mock ldd to respond with ld-linux shared library
+    mock_command('ldd', {'/bin/ls': ('/lib/ld-linux.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + (' Detected ARMv5 (or newer) processor')
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_armv6l_no_errors(Pihole):
+    '''
+    confirms only armv6l package is downloaded for FTL engine
+    '''
+    # mock uname to return armv6l platform
+    mock_command('uname', {'-m': ('armv6l', '0')}, Pihole)
+    # mock ldd to respond with ld-linux-armhf shared library
+    mock_command('ldd', {'/bin/ls': ('/lib/ld-linux-armhf.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + (' Detected ARMv6 processor '
+                                  '(with hard-float support)')
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_armv7l_no_errors(Pihole):
+    '''
+    confirms only armv7l package is downloaded for FTL engine
+    '''
+    # mock uname to return armv7l platform
+    mock_command('uname', {'-m': ('armv7l', '0')}, Pihole)
+    # mock ldd to respond with ld-linux-armhf shared library
+    mock_command('ldd', {'/bin/ls': ('/lib/ld-linux-armhf.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + (' Detected ARMv7 processor '
+                                  '(with hard-float support)')
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_armv8a_no_errors(Pihole):
+    '''
+    confirms only armv8a package is downloaded for FTL engine
+    '''
+    # mock uname to return armv8a platform
+    mock_command('uname', {'-m': ('armv8a', '0')}, Pihole)
+    # mock ldd to respond with ld-linux-armhf shared library
+    mock_command('ldd', {'/bin/ls': ('/lib/ld-linux-armhf.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected ARMv8 (or newer) processor'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_x86_64_no_errors(Pihole):
+    '''
+    confirms only x86_64 package is downloaded for FTL engine
+    '''
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected x86_64 processor'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_detect_unknown_no_errors(Pihole):
+    ''' confirms only generic package is downloaded for FTL engine '''
+    # mock uname to return generic platform
+    mock_command('uname', {'-m': ('mips', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    ''')
+    expected_stdout = 'Not able to detect processor (unknown: mips)'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_FTL_download_aarch64_no_errors(Pihole):
+    '''
+    confirms only aarch64 package is downloaded for FTL engine
+    '''
+    # mock whiptail answers and ensure installer dependencies
+    mock_command('whiptail', {'*': ('', '0')}, Pihole)
+    Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    install_dependent_packages ${INSTALLER_DEPS[@]}
+    ''')
+    download_binary = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    FTLinstall "pihole-FTL-aarch64-linux-gnu"
+    ''')
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
+    assert expected_stdout in download_binary.stdout
+    assert 'error' not in download_binary.stdout.lower()
+
+
+def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
+    '''
+    confirms FTL binary is copied and functional in installed location
+    '''
+    installed_binary = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    create_pihole_user
+    funcOutput=$(get_binary_name)
+    binary="pihole-FTL${funcOutput##*pihole-FTL}"
+    theRest="${funcOutput%pihole-FTL*}"
+    FTLdetect "${binary}" "${theRest}"
+    pihole-FTL version
+    ''')
+    expected_stdout = 'v'
+    assert expected_stdout in installed_binary.stdout
+
+
+# def test_FTL_support_files_installed(Pihole):
+#     '''
+#     confirms FTL support files are installed
+#     '''
+#     support_files = Pihole.run('''
+#     source /opt/pihole/basic-install.sh
+#     FTLdetect
+#     stat -c '%a %n' /var/log/pihole-FTL.log
+#     stat -c '%a %n' /run/pihole-FTL.port
+#     stat -c '%a %n' /run/pihole-FTL.pid
+#     ls -lac /run
+#     ''')
+#     assert '644 /run/pihole-FTL.port' in support_files.stdout
+#     assert '644 /run/pihole-FTL.pid' in support_files.stdout
+#     assert '644 /var/log/pihole-FTL.log' in support_files.stdout
+
+
+def test_IPv6_only_link_local(Pihole):
+    '''
+    confirms IPv6 blocking is disabled for Link-local address
+    '''
+    # mock ip -6 address to return Link-local address
+    mock_command_2(
+        'ip',
+        {
+            '-6 address': (
+                'inet6 fe80::d210:52fa:fe00:7ad7/64 scope link',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = ('Unable to find IPv6 ULA/GUA address, '
+                       'IPv6 adblocking will not be enabled')
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_IPv6_only_ULA(Pihole):
+    '''
+    confirms IPv6 blocking is enabled for ULA addresses
+    '''
+    # mock ip -6 address to return ULA address
+    mock_command_2(
+        'ip',
+        {
+            '-6 address': (
+                'inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_IPv6_only_GUA(Pihole):
+    '''
+    confirms IPv6 blocking is enabled for GUA addresses
+    '''
+    # mock ip -6 address to return GUA address
+    mock_command_2(
+        'ip',
+        {
+            '-6 address': (
+                'inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 GUA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_IPv6_GUA_ULA_test(Pihole):
+    '''
+    confirms IPv6 blocking is enabled for GUA and ULA addresses
+    '''
+    # mock ip -6 address to return GUA and ULA addresses
+    mock_command_2(
+        'ip',
+        {
+            '-6 address': (
+                'inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global\n'
+                'inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_IPv6_ULA_GUA_test(Pihole):
+    '''
+    confirms IPv6 blocking is enabled for GUA and ULA addresses
+    '''
+    # mock ip -6 address to return ULA and GUA addresses
+    mock_command_2(
+        'ip',
+        {
+            '-6 address': (
+                'inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global\n'
+                'inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global',
+                '0'
+            )
+        },
+        Pihole
+    )
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+
+def test_validate_ip_valid(Pihole):
+    '''
+    Given a valid IP address, valid_ip returns success
+    '''
+
+    output = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    valid_ip "192.168.1.1"
+    ''')
+
+    assert output.rc == 0
+
+
+def test_validate_ip_invalid_octet(Pihole):
+    '''
+    Given an invalid IP address (large octet), valid_ip returns an error
+    '''
+
+    output = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    valid_ip "1092.168.1.1"
+    ''')
+
+    assert output.rc == 1
+
+
+def test_validate_ip_invalid_letters(Pihole):
+    '''
+    Given an invalid IP address (contains letters), valid_ip returns an error
+    '''
+
+    output = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    valid_ip "not an IP"
+    ''')
+
+    assert output.rc == 1
+
+
+def test_os_check_fails(Pihole):
+    ''' Confirms install fails on unsupported OS '''
+    Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    install_dependent_packages ${INSTALLER_DEPS[@]}
+    cat <<EOT > /etc/os-release
+    ID=UnsupportedOS
+    VERSION_ID="2"
+    EOT
+    ''')
+    detectOS = Pihole.run('''t
+    source /opt/pihole/basic-install.sh
+    os_check
+    ''')
+    expected_stdout = 'Unsupported OS detected: UnsupportedOS'
+    assert expected_stdout in detectOS.stdout
+
+
+def test_os_check_passes(Pihole):
+    ''' Confirms OS meets the requirements '''
+    Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    install_dependent_packages ${INSTALLER_DEPS[@]}
+    ''')
+    detectOS = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    os_check
+    ''')
+    expected_stdout = 'Supported OS detected'
+    assert expected_stdout in detectOS.stdout

test/test_centos_7_support.py

@@ -0,0 +1,60 @@
+from .conftest import (
+    tick_box,
+    info_box,
+    mock_command,
+)
+
+
+def test_php_upgrade_default_optout_centos_eq_7(Pihole):
+    '''
+    confirms the default behavior to opt-out of installing PHP7 from REMI
+    '''
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optout_centos_eq_7(Pihole):
+    '''
+    confirms installer behavior when user opt-out of installing PHP7 from REMI
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optin_centos_eq_7(Pihole):
+    '''
+    confirms installer behavior when user opt-in to installing PHP7 from REMI
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    assert 'opt-out' not in distro_check.stdout
+    expected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                  '(https://rpms.remirepo.net)')
+    assert expected_stdout in distro_check.stdout
+    expected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                  'been enabled for PHP7')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert remi_package.is_installed

test/test_centos_8_support.py

@@ -0,0 +1,65 @@
+from .conftest import (
+    tick_box,
+    info_box,
+    mock_command,
+)
+
+
+def test_php_upgrade_default_continue_centos_gte_8(Pihole):
+    '''
+    confirms the latest version of CentOS continues / does not optout
+    (should trigger on CentOS7 only)
+    '''
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    unexpected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS.'
+                                    ' Deprecated PHP may be in use.')
+    assert unexpected_stdout not in distro_check.stdout
+    # ensure remi was not installed on latest CentOS
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optout_skipped_centos_gte_8(Pihole):
+    '''
+    confirms installer skips user opt-out of installing PHP7 from REMI on
+    latest CentOS (should trigger on CentOS7 only)
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    unexpected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS.'
+                                    ' Deprecated PHP may be in use.')
+    assert unexpected_stdout not in distro_check.stdout
+    # ensure remi was not installed on latest CentOS
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optin_skipped_centos_gte_8(Pihole):
+    '''
+    confirms installer skips user opt-in to installing PHP7 from REMI on
+    latest CentOS (should trigger on CentOS7 only)
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    assert 'opt-out' not in distro_check.stdout
+    unexpected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                    '(https://rpms.remirepo.net)')
+    assert unexpected_stdout not in distro_check.stdout
+    unexpected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                    'been enabled for PHP7')
+    assert unexpected_stdout not in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed

test/test_centos_common_support.py

@@ -0,0 +1,120 @@
+import pytest
+from .conftest import (
+    tick_box,
+    info_box,
+    cross_box,
+    mock_command,
+)
+
+
+def test_release_supported_version_check_centos(Pihole):
+    '''
+    confirms installer exits on unsupported releases of CentOS
+    '''
+    # modify /etc/redhat-release to mock an unsupported CentOS release
+    Pihole.run('echo "CentOS Linux release 6.9" > /etc/redhat-release')
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = cross_box + (' CentOS 6 is not supported.')
+    assert expected_stdout in distro_check.stdout
+    expected_stdout = 'Please update to CentOS release 7 or later'
+    assert expected_stdout in distro_check.stdout
+
+
+def test_enable_epel_repository_centos(Pihole):
+    '''
+    confirms the EPEL package repository is enabled when installed on CentOS
+    '''
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = info_box + (' Enabling EPEL package repository '
+                                  '(https://fedoraproject.org/wiki/EPEL)')
+    assert expected_stdout in distro_check.stdout
+    expected_stdout = tick_box + ' Installed epel-release'
+    assert expected_stdout in distro_check.stdout
+    epel_package = Pihole.package('epel-release')
+    assert epel_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_default_optout_centos(Pihole):
+    '''
+    confirms the default behavior to opt-out of upgrading to PHP7 from REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = Pihole.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = Pihole.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_user_optout_centos(Pihole):
+    '''
+    confirms installer behavior when user opt-out to upgrade to PHP7 via REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = Pihole.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = Pihole.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_user_optin_centos(Pihole):
+    '''
+    confirms installer behavior when user opt-in to upgrade to PHP7 via REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = Pihole.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = Pihole.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, Pihole)
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    install_dependent_packages PIHOLE_WEB_DEPS[@]
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout not in distro_check.stdout
+    expected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                  '(https://rpms.remirepo.net)')
+    assert expected_stdout in distro_check.stdout
+    expected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                  'been enabled for PHP7')
+    assert expected_stdout in distro_check.stdout
+    remi_package = Pihole.package('remi-release')
+    assert remi_package.is_installed
+    updated_php_package = Pihole.package('php')
+    updated_php_version = updated_php_package.version.split('.')[0]
+    assert int(updated_php_version) == 7

test/test_centos_fedora_common_support.py

@@ -0,0 +1,65 @@
+from .conftest import (
+    tick_box,
+    cross_box,
+    mock_command,
+)
+
+
+def mock_selinux_config(state, Pihole):
+    '''
+    Creates a mock SELinux config file with expected content
+    '''
+    # validate state string
+    valid_states = ['enforcing', 'permissive', 'disabled']
+    assert state in valid_states
+    # getenforce returns the running state of SELinux
+    mock_command('getenforce', {'*': (state.capitalize(), '0')}, Pihole)
+    # create mock configuration with desired content
+    Pihole.run('''
+    mkdir /etc/selinux
+    echo "SELINUX={state}" > /etc/selinux/config
+    '''.format(state=state.lower()))
+
+
+def test_selinux_enforcing_exit(Pihole):
+    '''
+    confirms installer prompts to exit when SELinux is Enforcing by default
+    '''
+    mock_selinux_config("enforcing", Pihole)
+    check_selinux = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = cross_box + ' Current SELinux: Enforcing'
+    assert expected_stdout in check_selinux.stdout
+    expected_stdout = 'SELinux Enforcing detected, exiting installer'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 1
+
+
+def test_selinux_permissive(Pihole):
+    '''
+    confirms installer continues when SELinux is Permissive
+    '''
+    mock_selinux_config("permissive", Pihole)
+    check_selinux = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = tick_box + ' Current SELinux: Permissive'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 0
+
+
+def test_selinux_disabled(Pihole):
+    '''
+    confirms installer continues when SELinux is Disabled
+    '''
+    mock_selinux_config("disabled", Pihole)
+    check_selinux = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = tick_box + ' Current SELinux: Disabled'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 0

test/test_fedora_support.py

@@ -0,0 +1,15 @@
+def test_epel_and_remi_not_installed_fedora(Pihole):
+    '''
+    confirms installer does not attempt to install EPEL/REMI repositories
+    on Fedora
+    '''
+    distro_check = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    distro_check
+    ''')
+    assert distro_check.stdout == ''
+
+    epel_package = Pihole.package('epel-release')
+    assert not epel_package.is_installed
+    remi_package = Pihole.package('remi-release')
+    assert not remi_package.is_installed

test/test_shellcheck.py

@@ -1,13 +0,0 @@
-import pytest
-import testinfra
-
-run_local = testinfra.get_backend(
-    "local://"
-).get_module("Command").run
-
-def test_scripts_pass_shellcheck():
-    ''' Make sure shellcheck does not find anything wrong with our shell scripts '''
-    shellcheck = "find . -type f \( -name 'update.sh' -o -name 'piholeDebug.sh' \) | while read file; do shellcheck \"$file\"; done;"
-    results = run_local(shellcheck)
-    print results.stdout
-    assert '' == results.stdout

test/tox.centos_7.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py37
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _centos_7.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py ./test_centos_fedora_common_support.py ./test_centos_common_support.py ./test_centos_7_support.py

test/tox.centos_8.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py37
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _centos_8.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py ./test_centos_fedora_common_support.py ./test_centos_common_support.py ./test_centos_8_support.py

test/tox.debian_10.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py37
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _debian_10.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py