# AdGuard Host Lists Registry

- [What Blocklists Can Be Added Here](#what-blocklists)
- [Where Blocklists Are Published](#published)
- [Filters Metadata](#filters-meta)
- [Services Metadata](#services-meta)
- [Safe Search Filters](#safe-search)
- [Typosquatting Allowlist](#typosquatting-allowlist)
- [How to Build](#how-to-build)
- [How to Compress](#how-to-compress)
- [Localizations](#localizations)

This repository contains the known hosts blocklists that are made available to the users of AdGuard products ([AdGuard DNS](https://adguard-dns.com/), [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome), etc).

Some of these blocklists are automatically [converted](https://github.com/AdguardTeam/HostlistCompiler) to the rules format that AdGuard product understand better.

## <a id="published"></a> Where Blocklists Are Published

- [`filters.json`](https://adguardteam.github.io/HostlistsRegistry/assets/filters.json) contains all the blocklists added to the repo. `downloadURL` is the location of the re-hosted blocklist.
- [`filters_apps.json`](https://adguardteam.github.io/HostlistsRegistry/assets/filters_apps.json) contains a minimal hand-picked subset of the blocklists that is used by AdGuard apps. Unlike AdGuard Home and AdGuard DNS, apps do not handle huge blocklists well, so only the lists marked with `includeInApps` in their `metadata.json` are included here. Its localizations are published in [`filters_apps_i18n.json`](https://adguardteam.github.io/HostlistsRegistry/assets/filters_apps_i18n.json).
- [`services.json`](https://adguardteam.github.io/HostlistsRegistry/assets/services.json) is the meta-data of "Web Services". This is a part of the parental control functionality of AdGuard Home and AdGuard DNS.

## <a id="what-blocklists"></a> What Blocklists Can Be Added Here

- The blocklist should be oriented towards DNS-level content blockers. There is a different [repo](https://github.com/AdguardTeam/FiltersRegistry) for browser content blockers.
- We prefer (mostly) original lists to compilations.
- We prefer blocklists that are specifically made for [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome) and use [adblock-style syntax](https://github.com/AdguardTeam/AdGuardHome/wiki/Hosts-Blocklists#adblock-style). 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.

## <a id="how-to-add-a-filter-list"></a> 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`, `/assets/filters-dev.json`, `/assets/filters_apps.json`, and `/assets/filters_apps_i18n.json` must not be edited manually.

## <a id="filters-meta"></a> 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.
  - `includeInApps` - optional, boolean. If set to `true`, the list is included in `filters_apps.json`
      and `filters_apps_i18n.json`, the minimal hand-picked index used by AdGuard apps. Only a few
      moderately-sized, non-problematic lists should be marked with this flag as apps do not handle
      huge blocklists well.
  - `disabled` - if set to `true`, the blocklist won't be updated.
  - `tags` — a list of [tags](#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.

    <details>
      <summary>Metadata example</summary>

  ```json
  {
    "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
  }
  ```

    </details>

- `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](https://github.com/AdguardTeam/HostlistCompiler#configuration) for details

### <a id="tags"></a> Tags

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

<details>
  <summary>Example</summary>

```json
{
  "tagId": 1,
  "keyword": "purpose:ads"
}
```

</details>

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`.

## <a id="how-to-add-a-blockable-service"></a> 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.

## <a id="services-meta"></a> 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`, `group`:

- `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)
- `group` - semantic group for service. Possible values:

| Full Name                     | Key              | Definition                                                                                                  |
|-------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
| Artificial intelligence       | `ai`             | Provides AI-powered tools and intelligent solutions for automation, analysis, and content-making.        |
| Content delivery networks (CDN)| `cdn`           | Optimizes content delivery for websites through caching, load balancing, and strategic distribution.       |
| Dating services               | `dating`         | Connects individuals seeking romantic relationships based on shared interests and preferences.            |
| Gambling and betting          | `gambling`       | Offers online gaming and betting experiences with the chance to win prizes through casino games and sports wagering. |
| Gaming                        | `gaming`         | Provides a diverse range of video and online games for entertainment purposes.                             |
| Web hosting                   | `hosting`        | Offers server space and resources for hosting websites, applications, and digital content.                 |
| Messaging services            | `messenger`      | Facilitates instant communication through text, voice, and video messaging.                                |
| Privacy tools                 | `privacy`        | Prioritizes user data protection and privacy through encryption and strict security measures.              |
| Shopping                      | `shopping`       | Enables online commerce with secure payment options, order tracking, and personalized shopping experiences.|
| Social networks               | `social_network` | Connects individuals for interactions, community-building, and sharing personal and professional information.|
| Software development          | `software`       | Provides tools, platforms, and frameworks for software development, coding, and project management.       |
| Streaming services            | `streaming`      | Delivers real-time audio, video, and other digital content for immediate access and entertainment.         |


<details>

<summary>Service examples</summary>

services.json - wechat object

  ```json
  {
    "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>",
    "group": "social_network"
  }
  ```

wechat.yml

  ```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>
  group: social_network
  ```

</details>

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

## <a id="safe-search"></a> Safe Search Filters

- [`engines_safe_search.txt`](https://adguardteam.github.io/HostlistsRegistry/assets/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`](https://adguardteam.github.io/HostlistsRegistry/assets/youtube_safe_search.txt) contains a set of rules to enforce Safe Search and hide comments on YouTube.

## <a id="typosquatting-allowlist"></a> Typosquatting Allowlist

- [`typosquatting_allowlist.json`](https://adguardteam.github.io/HostlistsRegistry/assets/typosquatting_allowlist.json)
contains exclusions and domain-specific exceptions for the Typosquatting protection feature in AdGuard Private DNS.
- This file is used as an allowlist for legitimate domains that may look like typos or homograph variants of protected
popular domains and therefore must not be treated as suspicious and for excluding protected domains from the check.
- The protected domains dataset itself is built in a different pipeline. This repository stores only the exception and
exclusion list maintained for that feature.

The file format is JSON:

```json
{
  "exclude": [
    "example-*.com",
    "test.com"
  ],
  "domains": [
    {
      "domain": "discovery.com",
      "exceptions": ["discover.com"]
    }
  ]
}
```

- **`exclude`**
  - An array of domain patterns (supports glob-style `*` wildcards) that should be completely excluded from the protected domains dataset.  
    If a domain matches an entry in `exclude`, it will not be sent to the DNS server and will not be checked for typosquatting at all.

- **`domains`**
  - An array of per-domain exception entries. Each entry has:

    - `domain` — the protected domain, preferably in normalized eTLD+1 form.
    - `exceptions` — a list of domains that are explicitly allowed for this protected domain.

### How to work with this file

1. Open `typosquatting_allowlist.json`.
1. To exclude a protected domain pattern completely, add it to the `exclude` array.
1. To add per-domain exceptions, add or update an entry in the `domains` array:
   - Set `domain` to the protected domain.
   - Set `exceptions` to the list of allowed lookalike domains.
1. Submit a PR for review.
1. After merge, the changes will be applied on the next scheduled build.

## <a id="how-to-build"></a> How to Build

```
yarn install
```

Run the following command:

```
yarn run compose
```

The build result can be found in the `assets` directory.

## <a id="how-to-compress"></a> How to Compress

Once a year, we will compress the repository to reduce its size. We will delete all remote branches and overwrite the main branch with a squashed history. The compression script will retain the first N commits in their original order in the history. All other commits (except the first one) will be squashed into a single commit.

### 1. Squash all old commits

```bash
yarn install
yarn compress [commits_to_keep]
```

It will retain the first `[commits_to_keep]` (default is 10000, which is approximately one year of history) commits, starting from now, in their original order in the history. All other older commits (except the very first one) will be squashed into a single commit.

### 2. Overwrite main branch

```bash
git push --set-upstream origin --force main
```

### 3. List all remote branches

```bash
git ls-remote --heads origin
```

### 4. Remove remote branches

Remove remote branches that are no longer needed locally
and push the removal to the remote repository:

```bash
git push origin --delete branchName
```

Replace `branchName` with the name of the branch you want to delete.

### 5. Prune remote branches

Use git remote prune origin to remove references to remote branches that have been deleted on the remote repository.
This keeps your local repository in sync with the remote:

```bash
git remote prune origin
```

### 6. Clean the reflog

Over time, Git can accumulate references in the reflog that are no longer needed.
You can clean the reflog using the following command:

```bash
git reflog expire --expire=now --all
git gc --aggressive --prune=now
```

This will remove unnecessary entries from the reflog and perform garbage collection.

After this procedure git repository will reduce it's size.

## <a id="localizations"></a> Localizations

Blocklist names, descriptions, and tags' names are translated via [crowdin](https://crowdin.com/project/adguard-applications/en#/miscellaneous/hostlists-registry).

`/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`
