{"id":15148285,"url":"https://github.com/anudeepnd/whitelist","last_synced_at":"2025-04-11T11:37:34.221Z","repository":{"id":37276125,"uuid":"98162895","full_name":"anudeepND/whitelist","owner":"anudeepND","description":"A simple tool to add commonly white listed domains to your Pi-Hole setup. ","archived":false,"fork":false,"pushed_at":"2024-03-19T11:10:06.000Z","size":669,"stargazers_count":4289,"open_issues_count":63,"forks_count":291,"subscribers_count":121,"default_branch":"master","last_synced_at":"2025-04-04T05:14:31.098Z","etag":null,"topics":["ad-blocker","adblock","adblocker","adguard","adguardhome","customization","docker-installation","pi-hole","pi-hole-setup","pihole","python3","raspberry-pi","shell","slickdeals","whitelist"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anudeepND.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"liberapay":"Anudeep","custom":"https://paypal.me/anudeepnd"}},"created_at":"2017-07-24T07:37:21.000Z","updated_at":"2025-04-04T00:12:41.000Z","dependencies_parsed_at":"2024-01-08T07:59:04.055Z","dependency_job_id":"5609172d-0647-4d86-b222-bf53d29df03d","html_url":"https://github.com/anudeepND/whitelist","commit_stats":{"total_commits":274,"total_committers":18,"mean_commits":"15.222222222222221","dds":0.3029197080291971,"last_synced_commit":"30c75868f56a4d46b3cf164e184cd888ee254fe2"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anudeepND%2Fwhitelist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anudeepND%2Fwhitelist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anudeepND%2Fwhitelist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anudeepND%2Fwhitelist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anudeepND","download_url":"https://codeload.github.com/anudeepND/whitelist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248384825,"owners_count":21094776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ad-blocker","adblock","adblocker","adguard","adguardhome","customization","docker-installation","pi-hole","pi-hole-setup","pihole","python3","raspberry-pi","shell","slickdeals","whitelist"],"created_at":"2024-09-26T13:02:15.151Z","updated_at":"2025-04-11T11:37:34.194Z","avatar_url":"https://github.com/anudeepND.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e  \n  \u003cimg width=\"550\" alt=\"Whitelist logo\" src=\"https://raw.githubusercontent.com/anudeepND/whitelist/master/images/logo.png\"\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\n\u003cdiv align=\"center\"\u003e\n   \u003ca href=\"#\" \u003e \n    \u003cimg src=\"https://img.shields.io/badge/Python-v3-9cf\" alt=\"repo size\" \u003e\n  \u003ca/\u003e\n  \u003ca href=\"#\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/repo-size/anudeepnd/whitelist?label=Repo%20Size\u0026color=orange\" alt=\"repo size\" \u003e\n  \u003ca/\u003e\n   \u003ca href=\"#\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/stars/anudeepnd/whitelist?label=Stars\" alt=\"stars\" \u003e\n  \u003ca/\u003e   \n  \u003ca href=\"#\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/last-commit/anudeepnd/whitelist?label=Last%20Updated\" alt=\"last updated\" \u003e\n  \u003ca/\u003e\n   \u003ca href=\"https://github.com/anudeepND/whitelist/commits/master\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/commit-activity/y/anudeepnd/whitelist?label=Commit%20Activity\" alt=\"commit activity\" \u003e\n  \u003ca/\u003e\n  \u003ca href=\"https://github.com/anudeepND/whitelist/issues\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/issues-raw/anudeepnd/whitelist?label=Open%20Issues\u0026color=critical\" alt=\"open issues\" \u003e\n  \u003ca/\u003e\n  \u003ca href=\"https://github.com/anudeepND/whitelist/issues?q=is%3Aissue+is%3Aclosed\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/issues-closed-raw/anudeepnd/whitelist?label=Closed%20Issues\u0026color=inactive\" alt=\"closed issues\" \u003e\n  \u003ca/\u003e\n  \u003ca href=\"https://github.com/anudeepND/whitelist/graphs/contributors\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/contributors/anudeepnd/whitelist?label=Contributors\u0026color=yellow\" alt=\"contributors\" \u003e\n  \u003ca/\u003e\n  \u003ca href=\"https://github.com/anudeepND/whitelist/blob/master/LICENSE\" \u003e \n    \u003cimg src=\"https://img.shields.io/github/license/anudeepnd/whitelist?label=License\u0026color=blueviolet\" alt=\"license\" \u003e\n  \u003ca/\u003e\n\u003c/div\u003e\n    \n\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eCollection of commonly white listed domains for \u003cbr\u003e Pi-Hole®\u003c/h1\u003e \n\u003c/div\u003e\n\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \nA robust collection of commonly white listed websites borrowed from various sources including Pi-Hole subreddit, Pi-Hole forum, Pi-Hole GitHub repository and more!\nAdd these domains to your Pi-Hole setup by running a script or manually and make your setup __trouble-free!__\nWant to report a new domain? Want to report existing one? Feel free to file an [issue](https://github.com/anudeepND/whitelist/issues).\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003e\n    \u003ca href=\"https://github.com/anudeepND/whitelist/releases\"\u003e\n      Releases\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://github.com/anudeepND/whitelist/pulse/monthly\"\u003e\n      Pulse\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://github.com/anudeepND/whitelist/issues\"\u003e\n      Submit Issue\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://github.com/anudeepND/whitelist/pulls\"\u003e\n      Submit PR\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://www.paypal.com/paypalme/anudeepND\"\u003e\n      Donate\n    \u003c/a\u003e\n  \u003c/h3\u003e\n\u003c/div\u003e       \n\u0026nbsp;\n\n\u003cbr /\u003e\n\n![Whitelist install demo gif](https://raw.githubusercontent.com/anudeepND/whitelist/master/images/whitelist.gif)\n\n\u003cbr /\u003e\n\n## \u003cins\u003eTable of contents\u003c/ins\u003e\n- [Features](#features)\n- [Overview](#overview)\n- [Installation](#installation)\n  * [For whitelist.txt](#for-whitelisttxt)\n  * [For referral-sites.txt](#for-referral-sitestxt)\n  * [For optional-list.txt](#for-optional-listtxt)\n  * [For Docker installation (with Python3 support)](#for-docker-installation-with-python3-support)\n  * [For Docker installation (without Python3 support) or /etc/pihole on different directory](#for-docker-installation-without-python3-support-or-etcpihole-on-different-directory)\n- [Uninstall](#uninstall)\n- [Automated Update](#automated-update)\n- [How do I determine an ad domain?](#how-do-i-determine-an-ad-domain)\n- [Stargazers over time ](#stargazers-over-time)\n- [Support](#support)\n- [License ](#license)\n\n## \u003cins\u003eFeatures\u003c/ins\u003e\n\n- The entire repo is curated.\n- New domains are added frequently.\n- Supports Pi-Hole Docker installation.\n- Comes with a simple install/uninstall scripts i.e. you can add all domains with comments automatically at an instant.\n- Domains are categorized and are included in 3 different files.\n- All the domains will have comments to let you know about the domain.\n- If you are a beginner to Pi-Hole, adding these sites will solve issues with host files that block legit websites.\n\n## \u003cins\u003eOverview\u003c/ins\u003e\n  \u003cbr /\u003e\n\n| File Name | Domain Count | Description | Update Frequency | Raw Link |\n|:-:|:-:|:-:|:-:|:-:|\n| whitelist.txt | 191 | This file contain domains that are __safe__ to whitelist i.e. it does not contain any tracking or advertising sites. Adding this file fixes many problems like YouTube watch history, videos on news sites and so on. If you want to report additional domain feel free to file an [issue](https://github.com/anudeepND/whitelist/issues). | Occasionally | [link](https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/whitelist.txt) |\n| referral-sites.txt | 75 | People who use services like Slickdeals and Fatwallet needs a few sites (most of  them are either trackers or ads) to be whitelisted to work properly. This file contains some analytics and ad serving sites like __doubleclick.net__ and others. __If you don't know what these services are, stay away from this list.__ | Occasionally | [link](https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/referral-sites.txt) |\n| optional-list.txt | -- | This file contain domains that are needed to be whitelisted depending on the service you use. It may contain some tracking site but sometimes it's necessary to add bad domains to make a few services to work. Currently there is no script for this list, you have to add domains manually to your Pi-Hole. | Occasionally | [link](https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/optional-list.txt) |\n\n\n## \u003cins\u003eInstallation\u003c/ins\u003e\n\n Make sure you have __python3__ installed on your machine. You can simply install it by using `sudo apt install python3`\n\n#### For whitelist.txt\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\nsudo python3 whitelist/scripts/whitelist.py\n```\n\n#### For referral-sites.txt\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\ncd whitelist/scripts\nsudo ./referral.sh\n```\n\nIf 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.\n\n#### For optional-list.txt\nYou can add it manually depending upon the service you use.\n\n#### For Docker installation (with Python3 support)\n\n Access you running Pi-Hole container by `docker exec -it \u003ccontainer-ID\u003e bash` and proceed with the steps given below:\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\nsudo python3 whitelist/scripts/whitelist.py\n```\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\ncd whitelist/scripts\nsudo ./referral.sh\n```\n\n#### For Docker installation (without Python3 support) or /etc/pihole on different directory\n\n You can pass two optional arguments to whitelist.py, uninstall.py, and referral.sh:\n\n```Text\n -d or --dir to specify the Pi-hole etc directory (in normal install should be /etc/pihole)\n -D or --docker to specify if Pi-hole is running as Docker container\n ```\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\nsudo python3 whitelist/scripts/whitelist.py --dir /home/docker/pihole/etc-pihole/ --docker\n```\n\n```Shell\ngit clone https://github.com/anudeepND/whitelist.git\ncd whitelist/scripts\nsudo ./referral.sh --dir /home/docker/pihole/etc-pihole/ --docker\n```\n__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__\n\n## \u003cins\u003eUninstall\u003c/ins\u003e\n\n![Whitelist uninstall demo gif](https://raw.githubusercontent.com/anudeepND/whitelist/master/images/uninstall.gif)\n\nAs 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.\n\n```SQL\nDELETE FROM domainlist WHERE type = 0 AND comment LIKE '%qjz9zk%'\n```\n\nThis 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.\n\nThe 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.\n\n__To remove the domains:__\n`sudo python3 uninstall.py`\n\n\n## \u003cins\u003eAutomated Update\u003c/ins\u003e\n\n```Shell\ncd /opt/\nsudo git clone https://github.com/anudeepND/whitelist.git\n```\n\nMake the script to run the script at 1AM on the last day of the week\n\n```Shell\nsudo nano /etc/crontab\n```\n\nAdd this line at the end of the file:\n\n```Text\n0 1 * * */7     root    /opt/whitelist/scripts/whitelist.py\n```\n\nCTRL + X then Y and Enter\n\n```Shell\nsudo python3 whitelist/scripts/whitelist.py\n```\n\n## \u003cins\u003eHow do I determine an ad domain?\u003c/ins\u003e\n- __Adam:ONE Assistant (formerly DNSthingy Assistant):__ \u003ca href=\"https://chrome.google.com/webstore/detail/adamone-assistant/fdmpekabnlekabjlimjkfmdjajnddgpc\"\u003eThis browser extension\u003c/a\u003e 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.\n- __Using inbuilt Developer tool:__ For Chrome and Firefox, __`ctrl+shift+I`__ will land you in Developer tools menu.\n- __Using an Android app:__ [__`Net Guard`__](https://play.google.com/store/apps/details?id=eu.faircode.netguard) is an Android app that can be used to monitor any specific apps, works on unrooted devices too.\n\n\n## \u003cins\u003eStargazers over time\u003c/ins\u003e\n\u003cbr /\u003e\n\n[![Stargazers over time](https://starchart.cc/anudeepND/whitelist.svg)](https://starchart.cc/anudeepND/whitelist)\n\n## \u003cins\u003eSupport\u003c/ins\u003e\nMaintaining 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`](https://twitter.com/anudeepnd).  \n\u003cdiv align=\"center\"\u003e   \n  \u003ca href=\"https://paypal.me/anudeepND\" target=\"_blank\"\u003e\u003cimg alt=\"Donate using Paypal\" src=\"https://raw.githubusercontent.com/anudeepND/whitelist/master/images/paypal.png\" width=\"160\" height=\"40\"\u003e\u003c/a\u003e\n  \u0026nbsp;\n  \u0026nbsp;\n  \u003ca href=\"https://upi.anudeep.me\"\u003e\u003cimg alt=\"Donate using UPI apps\" src=\"https://raw.githubusercontent.com/anudeepND/whitelist/master/images/upi.png\" width=\"115\" height=\"40\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## \u003cins\u003eLicense\u003c/ins\u003e\n\n```Text\nMIT License\n\nCopyright (c) 2020 Anudeep ND \u003canudeep@protonmail.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","funding_links":["https://liberapay.com/Anudeep","https://paypal.me/anudeepnd","https://www.paypal.com/paypalme/anudeepND","https://paypal.me/anudeepND"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanudeepnd%2Fwhitelist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanudeepnd%2Fwhitelist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanudeepnd%2Fwhitelist/lists"}