Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for regional-list-specific fields #58

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for regional-list-specific fields #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,23 @@ The `filter_lists/*.json` files are lists of elements, each describing a filter
- `include_redirect_urls` permits parsing of `redirect-url` filter option. This has security implications. This field is optional and defaults to `false`.

- `support_url` is somewhere a user can ask for help with the filter list.

### Regional-list-specific fields

In addition to the above, regional lists have a few extra fields:

```json
{
...
"langs": ["ar"],
"component_id": "lfgnenkkneohplacnfabidofpgcdpofm",
"base64_public_key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqNcRp37CBZCXe1vbmXyobycPxHyEKNIgNl6p0XBBxtcZcQOijpY70GjCRzgCL7m1+FBo4MR3FXLiF2aPn/QsUR8t7+zfw3XzBVos4Ssexkqpd4/4ciASwTXpbuyFOq4Z5dcgJ1afeT9Zj5bmh4ekLpgJ1NzVwCMhEKk6cmSKIaGVo5EEydtlor2nkUJrSFuZA6tYZ++4BOfhhCtzrvXTZjg7mTlB6ca21NL4oLwtqvJMtF8ddoumh619BB5wOqxLzntC/oWyOxf00V5HDC7e/DRj9J8jLRFLd4EQUO4Mk+kG3MNy0ph9cqdw6zFR7a2H3LGkl4ejsifM1mUDuJL0cwIDAQAB",
"desc": "This is a regional list that blocks some unwanted items"
}
```

- `langs` is a list of _locale codes_ for the given list, allowing it to be preselected in-browser by users in the corresponding regions. Note that despite the name, it should not list _language codes_.

- `component_id` and `base64_public_key` are constants generated per-list such that the lists can be served in CRX components created by [brave-core-crx-packager](https://github.com/brave/brave-core-crx-packager).

- `desc` is a short description of the list that may eventually be displayed in the `brave://adblock` UI.