Skip to main content

A tool for quickly and easily bulk adding allowlists and ad/blocklists to a Pi-hole 5 installation

Project description

pihole5-list-tool

PyPI version PyPI downloads

This tool allows quickly and easily bulk adding and removing both Allowlists and Block/Ad lists to/from your Pi-hole 5 setup.

Bonus: If you're running the pihole docker image (or one named pihole), it should be detected and offered as a default option.

supported sources

TL; DR - some maintained lists and anything you can paste or a file

allowlists

Currently the only source for maintained whitelists is anudeepND's allowlist. They are presented as:

  • Allowlist Only - Domains that are safe to allow i.e does not contain any tracking or

      advertising sites. This fixes many problems like YouTube watch history,
      videos on news sites and so on.
    
  • Allowlist+Optional - These are needed depending on the service you use. They may contain some

      tracking sites but sometimes it's necessary to add bad domains to make a
      few services to work.
    
  • Allowlist+Referral - People who use services like Slickdeals and Fatwallet need a few sites

      (most of them are either trackers or ads) to be whitelisted to work
      properly. This 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. Domains that are safe to whitelist i.e does
      not contain any tracking or advertising sites. This fixes many problems
      like YouTube watch history, videos on news sites and so on.
    

ad/blocklists

Currently the only source for maintained blocklists is firebog.net

  • Non-crossed lists: For when someone is usually around to whitelist falsely blocked sites
  • Ticked lists: For when installing Pi-hole where no one will be whitelisting falsely blocked sites
  • All lists: For those who will always be around to whitelist falsely blocked sites

file/paste

Both list types allow providing either a pasted in list or a file as your source of lists.

Finishing up

After adding lists, they must be loaded by running:

$ pihole -g

This tool will offer to do that for you.

When that finishes, you'll see each of listed in the Web Admin interface along with a comment to help identify them.

NOTE: If you need/want the blocklists added from firebog.net (and more) continually updated, check out pihole-updatelists which will also run great on a Pi.

requirements

  • working pi-hole 5.0 installation
  • python 3.6+ is required. That is available by default on at least Raspbian 10, so it should be available on your system.

installation

If you don't sudo pip3 install, things won't work - possibly in a very confusing way. Definitely on Raspbian 10, so probably before that.

$ sudo pip3 install pihole5-list-tool --upgrade

usage / running

Simply run:

$ sudo pihole5-list-tool

Here's basically what installing and running it will look like:

asciicast

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pihole5-list-tool, version 0.6.0
Filename, size File type Python version Upload date Hashes
Filename, size pihole5_list_tool-0.6.0-py2.py3-none-any.whl (14.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pihole5-list-tool-0.6.0.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page