DOCSEARCHbyAlgolia
Submit Docs

Brave Adblock Lists

repository·master·Indexed 19 days ago

https://github.com/brave/adblock-lists

A repository for collecting and managing adblock and privacy filter lists used by the Brave browser. It includes data lists such as clean-urls.json for stripping tracking parameters and debounce.json for debouncing functionality, supplementing community-maintained lists like EasyList and uBlock Origin.

Tokens
832
Snippets
1
Records
5
Agent score
18%

What's inside brave-adblock-lists

  1. Overview of Brave Adblock Lists

    master

    This repository collects additional filter lists used by Brave to block ads and trackers, supplementing community-maintained lists like EasyList, EasyPrivacy, and uBlock Origin. While primarily focused on adblock filter lists, it also collects other privacy-related lists.

    Key Dependencies:

    • Backend Logic: The downloading and shipping of these lists to clients is handled by brave-core-crx-packager.
    • Accompanying Resources: See adblock-resources for resources required by the filter lists.
    • List Catalog: The active filter lists used by Brave are defined in the adblock-resources list catalog.

  2. Overview of Brave Lists

    master

    The brave/brave/adblock-lists repository contains various data lists used within the Brave browser to power specific features. Key lists include:

    • clean-urls.json: Used for the 'Copy clean link' feature, which strips tracking parameters from URLs.
    • debounce.json: Used for the browser's debouncing functionality.

  3. Add a new adblock filter list

    master

    Adblock filter lists are loaded by the CRX packager via the adblock-resources list catalog.

    Steps to add a list:

    1. Obtain a Raw URL: Get the direct link to the raw file in this repository. The format should be: https://raw.githubusercontent.com/brave/adblock-lists/master/brave-lists/<filename>.txt
    2. Update the List Catalog:
      • To add to an existing component: Add a new source to that component in the adblock-resources list catalog, using the raw URL as the url field.
      • To add a new component: Follow the guide in adblock-resources to create and register the new component on Brave browser clients: Adding a new list in adblock-resources.
    https://raw.githubusercontent.com/brave/adblock-lists/master/brave-lists/brave-social.txt

  5. Add a new non-adblock list

    master

    Non-adblock lists (lists not intended for consumption by adblock-rust in brave-core) typically require a new CRX component to be shipped to Brave clients.

    Workflow:

    1. Create a new CRX component: Most new lists should reside in their own dedicated component.
    2. Configure Packaging: The list must be fetched and packaged by brave-core-crx-packager.
    3. Register with Clients: Brave browser clients must be updated to download and register the new component. Follow the guide in brave-core for shipping files to all clients: Ship a file to all clients.

    Adding to an existing component: If the list is intended for an existing component, you can skip component generation and brave-core steps, but you must add support for downloading the new list within crx-packager. Note that this is generally not recommended; dedicated components are preferred.