Skip to content

Latest commit

 

History

History
246 lines (172 loc) · 13.4 KB

README.md

File metadata and controls

246 lines (172 loc) · 13.4 KB
Raw

AdGuard Host Lists Registry

This repository contains the known hosts blocklists that are made available to the users of AdGuard products (AdGuard DNS, AdGuard Home, etc).

Some of these blocklists are automatically converted to the rules format that AdGuard product understand better.

Where Blocklists Are Published

  • filters.json contains all the blocklists added to the repo. downloadURL is the location of the re-hosted blocklist.
  • services.json is the meta-data of "Web Services". This is a part of the parental control functionality of AdGuard Home and AdGuard DNS.

What Blocklists Can Be Added Here

  • The blocklist should be oriented towards DNS-level content blockers. There is a different repo for browser content blockers.

  • We prefer (mostly) original lists to compilations.

  • We prefer blocklists that are specifically made for AdGuard Home and use adblock-style syntax. Lists that use /etc/hosts can also be added if there is no alternative.

  • The blocklist should have a clear purpose.

    Examples:

    • good: "blocks TV ads".
    • bad: "John Doe's personal blocklist"

  • The blocklist should have a place for receiving user complaints and holding discussions, such as a repository on github.com, or a public website/forum.

  • The blocklist should be relatively popular, meaning:

    • if there is a repository on GitHub, the number of stars should be at least 50.
    • if there is no repository on GitHub, the number of reported issues and discussions should be at least 10 per month.
    • the blocklist should be actively supported for at least 6 months.

  • The blocklist should be regularly updated with at least 10 updates per month.

  • Previously added blocklists that haven't received any support for a year will be removed. We reserve the right to remove the blocklist earlier, depending on circumstances.

  • If the blocklist contains too many problematic rules, it will not be added. A rule is considered problematic if it causes false positives or otherwise displays unitended behavior. Decisions about blocklists with problematic rules are arbitrary and there may be exceptions.

  • If the blocklist intentionally blocks or restricts access to a service for no reason other than being a reflection of the filter author's opinion, the blocklist will not get added, or will get removed if already added.

  • If the blocklist is popular in a specific region and there are no alternatives to it, then it can be added as is even if it does not satisfy requirements above.

How to add a filter list

To add a new filter, you need to:

  1. Go to the filters folder.
  2. Go to the category to which the new filter will belong.
  3. Create a new folder with the name filter_(id)_(filter name).
  4. Create two files in this folder: configuration.json and metadata.json. The contents of these files are described below.
  5. In the file locales/en/filters.json add an object with the name and description of the filter according to the example added above.

The files /assets/filters.json and /assets/filters-dev.json must not be edited manually.

Filters Metadata

  • metadata.json

    Filter metadata. Includes name, description, etc.

    • filterKey — unique human-readable filter identifier (string)

    • filterId - unique internal filter identifier (integer)

    • name — filter name; can be localized

    • description — filter description

    • timeAdded — time when this filter was added to the registry; milliseconds since January 1, 1970; you can exec new Date().getTime() in the browser console to get the current time

    • homepage — filter website/homepage

    • deprecated — optional, boolean, filter is deprecated and should not be used by the products, but filter is still available, i.e. not removed

    • expires — filter's default expiration period

    • displayNumber — this number is used when AdGuard sorts available filters (GUI)

    • environment - either dev or prod. Only prod lists are available in AdGuard DNS.

    • disabled - if set to true, the blocklist won't be updated.

    • tags — a list of tags

    • trusted - a flag that allows using $dnsrewrite rules for this filter. If the filter is not trusted, $dnsrewrite rules will be removed from the compiled filter.

      Metadata example 
    {
  "filterKey": "adguard_dns_filter",
  "filterId": 1,
  "name": "AdGuard DNS filter",
  "description": "Filter composed of several other filters (AdGuard Base filter, Social Media filter, Tracking Protection filter, Mobile Ads filter, EasyList and EasyPrivacy) and simplified specifically to be better compatible with DNS-level ad blocking.",
  "timeAdded": 1404115015843,
  "homepage": "https://kb.adguard.com/general/adguard-ad-filters",
  "expires": "4 days",
  "displayNumber": 3,
  "environment": "prod",
  "tags": [],
  "trusted": true
}

  • revision.json

    Filter version metadata, automatically filled and overwritten on each build.

  • filter.txt

    Resulting compiled filter.

  • configuration.json

    Configuration defines your filter list sources, and the transformations that are applied to the sources. See Hostlist compiler configuration for details

Tags

Every filter can be marked by a number of tags. Every tag metadata listed in /tags/metadata.json.

Example 
{
  "tagId": 1,
  "keyword": "purpose:ads"
}

Possible tags:

  • lang:* — for language-specific filters; one or multiple lang-tags can be used. For instance, AdGuard Russian filter is marked with the lang:ru tag.

  • purpose:* — determines filters purposes; multiple purpose-tags can be used for one filter list.

  • recommended — for low-risk filter lists which are recommended to use in their category. The category is determined by the pair of the lang:* and purpose:* tags.

  • obsolete — for abandoned filter lists; filter's metadata with this tag will be excluded from filters.json and filters_i18n.json.

How to add a blockable service

To add a new blocked service, a new .yml file must be added to the services directory, the contents of the directory and the resulting services.json file are described in the next section.

Services Metadata

The services.json file combines information about services received from separate .yml files located in the services directory. The services.json file is generated by a script, so there is no need to modify it manually.

  • Source .yml files: Each .yml file contains information about a specific service. The file name must match its id.

  • File saving: .yml files are stored in the services directory.

  • Updating information: In cases when it is necessary to change the configuration of a service, it is necessary to update the corresponding .yml file in the services directory.

  • Adding a new service: to add a new service to services.json it is necessary to add .yml file to the services directory, after the script is run the file will be updated.

WARNING!

  • Deletion of files is strictly forbidden. If a service file is deleted, the script will restore it from a previous version of the services.json file.

  • It is also forbidden to change service id inside the .yml file.

Service metadata includes id, name, rules, icon_svg:

  • id — unique human-readable service identifier (string, as snake_case)
  • name — service name (string)
  • rules — list of domain rules in Adblock syntax (list of strings)
  • icon_svg — svg icon (string)
Service examples

services.json - wechat object

{
  "id": "wechat",
  "name": "WeChat",
  "rules": ["||wechat.com^", "||weixin.qq.com^", "||wx.qq.com^"],
  "icon_svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" className=\"d-none\"><symbol id=\"service_wechat\" viewBox=\"0 0 50 50\" fill=\"currentColor\"><path d=\"M 19 6 C 9.625 6 2 12.503906 2 20.5 C 2 24.769531 4.058594 28.609375 7.816406 31.390625 L 5.179688 39.304688 L 13.425781 34.199219 C 15.714844 34.917969 18.507813 35.171875 21.203125 34.875 C 23.390625 39.109375 28.332031 42 34 42 C 35.722656 42 37.316406 41.675781 38.796875 41.234375 L 45.644531 45.066406 L 43.734375 38.515625 C 46.3125 36.375 48 33.394531 48 30 C 48 23.789063 42.597656 18.835938 35.75 18.105469 C 34.40625 11.152344 27.367188 6 19 6 Z M 13 14 C 14.101563 14 15 14.898438 15 16 C 15 17.101563 14.101563 18 13 18 C 11.898438 18 11 17.101563 11 16 C 11 14.898438 11.898438 14 13 14 Z M 25 14 C 26.101563 14 27 14.898438 27 16 C 27 17.101563 26.101563 18 25 18 C 23.898438 18 23 17.101563 23 16 C 23 14.898438 23.898438 14 25 14 Z M 34 20 C 40.746094 20 46 24.535156 46 30 C 46 32.957031 44.492188 35.550781 42.003906 37.394531 L 41.445313 37.8125 L 42.355469 40.933594 L 39.105469 39.109375 L 38.683594 39.25 C 37.285156 39.71875 35.6875 40 34 40 C 27.253906 40 22 35.464844 22 30 C 22 24.535156 27.253906 20 34 20 Z M 29.5 26 C 28.699219 26 28 26.699219 28 27.5 C 28 28.300781 28.699219 29 29.5 29 C 30.300781 29 31 28.300781 31 27.5 C 31 26.699219 30.300781 26 29.5 26 Z M 38.5 26 C 37.699219 26 37 26.699219 37 27.5 C 37 28.300781 37.699219 29 38.5 29 C 39.300781 29 40 28.300781 40 27.5 C 40 26.699219 39.300781 26 38.5 26 Z\" /></symbol></svg>"
}

wechat.yml

id: wechat
name: WeChat
rules:
- '||wechat.com^'
- '||weixin.qq.com^'
- '||weixin.qq.com.cn^'
- '||weixinbridge.com^'
- '||wx.qq.com^'
icon_svg: <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 50 50"><path d="M 19 6 C 9.625 6 2 12.503906 2 20.5 C 2 24.769531 4.058594 28.609375 7.816406 31.390625 L 5.179688 39.304688 L 13.425781 34.199219 C 15.714844 34.917969 18.507813 35.171875 21.203125 34.875 C 23.390625 39.109375 28.332031 42 34 42 C 35.722656 42 37.316406 41.675781 38.796875 41.234375 L 45.644531 45.066406 L 43.734375 38.515625 C 46.3125 36.375 48 33.394531 48 30 C 48 23.789063 42.597656 18.835938 35.75 18.105469 C 34.40625 11.152344 27.367188 6 19 6 Z M 13 14 C 14.101563 14 15 14.898438 15 16 C 15 17.101563 14.101563 18 13 18 C 11.898438 18 11 17.101563 11 16 C 11 14.898438 11.898438 14 13 14 Z M 25 14 C 26.101563 14 27 14.898438 27 16 C 27 17.101563 26.101563 18 25 18 C 23.898438 18 23 17.101563 23 16 C 23 14.898438 23.898438 14 25 14 Z M 34 20 C 40.746094 20 46 24.535156 46 30 C 46 32.957031 44.492188 35.550781 42.003906 37.394531 L 41.445313 37.8125 L 42.355469 40.933594 L 39.105469 39.109375 L 38.683594 39.25 C 37.285156 39.71875 35.6875 40 34 40 C 27.253906 40 22 35.464844 22 30 C 22 24.535156 27.253906 20 34 20 Z M 29.5 26 C 28.699219 26 28 26.699219 28 27.5 C 28 28.300781 28.699219 29 29.5 29 C 30.300781 29 31 28.300781 31 27.5 C 31 26.699219 30.300781 26 29.5 26 Z M 38.5 26 C 37.699219 26 37 26.699219 37 27.5 C 37 28.300781 37.699219 29 38.5 29 C 39.300781 29 40 28.300781 40 27.5 C 40 26.699219 39.300781 26 38.5 26 Z" /></svg>

SVG icon requirements:

  • The icon must have a square shape, i.e. the third and fourth parameters of the viewBox attribute must be equal.
  • The icon must be black and white.
  • It should be as small as possible.
  • Svg tag must contain fill="currentColor" attribute. This is important for themes to work properly.
  • Svg tag must not contain width and height attributes

Safe Search Filters

  • engines_safe_search.txt contains a set of rules to enforce Safe Search in the following searching engines:

    • Bing
    • DuckDuckGo
    • Google
    • Pixabay
    • Yandex

  • youtube_safe_search.txt contains a set of rules to enforce Safe Search and hide comments on YouTube.

How to Build

yarn install

Run the following command:

yarn run compose

The build result can be found in the assets directory.

Localizations

Blocklist names, descriptions, and tags' names are translated via crowdin.

/locales contains translations for filters, groups, and tags.

Base language strings:

  • locales/en/filters.json
  • locales/en/tags.json

In order to prepare these files run yarn run locales:prepare. This script will scan filters meta and add filters names, descriptions, and tags meta to the base language files.

  • Upload base language strings: yarn run locales:upload
  • Download translations: yarn run locales:download