Table of contents

• Features
• Overview
• Installation
  • For whitelist.txt
  • For referral-sites.txt
  • For optional-list.txt
  • For Docker installation (with Python3 support)
  • For Docker installation (without Python3 support) or /etc/pihole on different directory
• Uninstall
• Automated Update
• How do I determine an ad domain?
• Stargazers over time
• Support
• License

Features

• The entire repo is curated.
• New domains are added frequently.
• Supports Pi-Hole Docker installation.
• Comes with a simple install/uninstall scripts i.e. you can add all domains with comments automatically at an instant.
• Domains are categorized and are included in 3 different files.
• All the domains will have comments to let you know about the domain.
• If you are a beginner to Pi-Hole, adding these sites will solve issues with host files that block legit websites.

Overview

Installation

Make sure you have python3 installed on your machine. You can simply install it by using sudo apt install python3

For whitelist.txt

git clone https://github.com/anudeepND/whitelist.git
sudo python3 whitelist/scripts/whitelist.py

For referral-sites.txt

git clone https://github.com/anudeepND/whitelist.git
cd whitelist/scripts
sudo ./referral.sh

If you are using Pi-hole 5.0 or later, the comment field has a unique string - qjz9zk to uniquely identify the domains added by this script so the user can remove the domains without affecting other whitelisted sites.

For optional-list.txt

You can add it manually depending upon the service you use.

For Docker installation (with Python3 support)

Access you running Pi-Hole container by docker exec -it <container-ID> bash and proceed with the steps given below:

git clone https://github.com/anudeepND/whitelist.git
sudo python3 whitelist/scripts/whitelist.py

git clone https://github.com/anudeepND/whitelist.git
cd whitelist/scripts
sudo ./referral.sh

For Docker installation (without Python3 support) or /etc/pihole on different directory

You can pass two optional arguments to whitelist.py, uninstall.py, and referral.sh:

 -d or --dir to specify the Pi-hole etc directory (in normal install should be /etc/pihole)
 -D or --docker to specify if Pi-hole is running as Docker container

git clone https://github.com/anudeepND/whitelist.git
sudo python3 whitelist/scripts/whitelist.py --dir /home/docker/pihole/etc-pihole/ --docker

git clone https://github.com/anudeepND/whitelist.git
cd whitelist/scripts
sudo ./referral.sh --dir /home/docker/pihole/etc-pihole/ --docker

Note: You don't have to clone the repo every time you need to update whitelist file. Navigate to whitelist/scripts and run it again `sudo python3 whitelist.py

Uninstall

As mentioned earlier, the unique string (qjz9zk) will come in handy while removing the domains from the database. It uses LIKE operator of the SQLite to match the wildcard string present in the comment section.

DELETE FROM domainlist WHERE type = 0 AND comment LIKE '%qjz9zk%'

This statement will remove the domain only if it is present in the exact whitelist section and having the string qjz9zk. Domains in the regex list will not be removed by this script.

The older version of the Pi-hole uses a simple text file to store the entries. In this case the script will match the domains present in your Pi-hole to the domains present in the GitHub repo and removes them accordingly.

To remove the domains: sudo python3 uninstall.py

Automated Update

cd /opt/
sudo git clone https://github.com/anudeepND/whitelist.git

Make the script to run the script at 1AM on the last day of the week

sudo nano /etc/crontab

Add this line at the end of the file:

0 1 * * */7     root    /opt/whitelist/scripts/whitelist.py

CTRL + X then Y and Enter

sudo python3 whitelist/scripts/whitelist.py

How do I determine an ad domain?

• Adam:ONE Assistant (formerly DNSthingy Assistant): This browser extension will list all of the domains that are queried when a web page is loaded. You can often look at the list of domains and cherry pick the ones that appear to be ad-serving domains.
• Using inbuilt Developer tool: For Chrome and Firefox, ctrl+shift+I will land you in Developer tools menu.
• Using an Android app: Net Guard is an Android app that can be used to monitor any specific apps, works on unrooted devices too.

Stargazers over time

Support

Maintaining an quality open-source takes a lot of time. I have been contributing to this project over 3 years. Your support will help me to keep the project running and provide you quality service. You can also donate using UPI enabled apps such as PhonePe, Google Pay, Paytm and more! (UPI ID: anudeepnd@ybl). If you have any queries related to PayPal or donation, you can send a DM to me on Twitter.

   

License

MIT License

Copyright (c) 2020 Anudeep ND <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.