Need help with pihole5-list-tool?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jessedp
226 Stars 11 Forks MIT License 128 Commits 2 Opened issues

Description

A tool for quickly and easily bulk adding allow and ad/block lists to a Pi-hole 5 installation

Services available

!
?

Need anything else?

Contributors list

# 309,496
PHP
HTML
pihole-...
bulk
124 commits

pihole5-list-tool

PyPI version PyPI downloads

This tool provides bulk operations to manage your Pi-hole 5 Allow lists and Block/Ad lists.

Features:

  • Allow lists can be added from anudeepND's allowlist, files, or manual entry
  • Block/Ad lists can be added from firebog.net, files, or manual entry
  • Removes lists it adds (or all of them)
  • Reset lists to Pi-hole defaults
  • Stats provides some quick sums and groupings
  • Docker if you're running the pihole docker image (or one named
    pihole
    ), it should be detected and offered as a default option

requirements

  • working pi-hole 5+ installation
  • python 3.6+ (available by default on Raspbian 10, probably available on your system)

installation

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

Note: * If the

pip3
command doesn't work, try using
pip
instead. Here are additional options /workarounds (and glimpses into Python peculiarities) * You must use
sudo

usage / running

Simply run:

$ sudo pihole5-list-tool

This is what installing and running it basically looks like (many features have been added since this):

asciicast

supported sources

TL; DR - some maintained online lists, 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.