Automated scripts to support converting filter lists (in various formats) to "domain-only" lists for use in DNS / domain-blocking tools like Pi-Hole. Used to create: justdomains/blocklists
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.ci
.travis.yml
LICENSE
README.md
buildrepo.py
convertlists.py
lists.json
requirements.txt

README.md

For the blocklists, visit: justdomains/blocklists


justdomains/ci Build Status

Automated scripts to support converting filter lists (in various formats) to "domain-only" lists for use in DNS / domain-blocking tools like Pi-Hole.

For normal users:

Constantly-updated blocklists are available here.

You do not need to run these scripts yourself if you just want the resulting blocklists. The link above has the automatically-updated output of this script for many common / popular lists.

If you have a blocklist you'd like added, open a new issue here.

For advanced users:

If you'd like to run these scripts yourself, you can clone this git repository or download the following 3 files:

Requirements:

convertlists.py

Download and convert a series of lists (provided by lists.json) to a "domains-only" format.

This script outputs only the full-domain-blocking entries from the original lists, while attempting to filter any domains that conflict with an exception rule on the original list, thus creating output files that are useful in DNS / domain-blocking tools.

Supported input list formats: Adblock Plus Filter, HOSTS file

Example Usage:

./convertlists.py lists.json converted/

(Will convert the lists specified by lists.json, and output files into the folder converted/)

lists.json:

As input, convertlists.py requires the path to a lists.json file, which contains an array of dictionaries describing each list.

The required dictionary keys / values for each list are:

key value
"name" the list name (string)
"url" the URL from which the list will be downloaded (http://, https://), or a local file:// url (string)
"format" the format of the list (string; possible values: "adbp", "hosts")

Optional dictionary keys / values for each list are:

key value
"license" used to supply a license URL or description, if no license information can be extracted from the list itself (string)
"license-identifier" a short license name / title (ex. "GPL3", "MIT")
"outputfile" the base filename used for both the downloaded original and the converted output file (string) - important if multiple downloaded lists have the same filename

Example:

View the example lists.json in this repo.