# blok

**Repository Path**: mirrors_mozilla/blok

## Basic Information

- **Project Name**: blok
- **Description**: Web Extension implementation of Firefox tracking protection for experimental development
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Tracking Protection: Test Pilot Experiment
## AKA Blok

[![Build Status](https://travis-ci.org/mozilla/blok.svg?branch=master)](https://travis-ci.org/mozilla/blok)
[![Coverage
Status](https://coveralls.io/repos/github/mozilla/blok/badge.svg)](https://coveralls.io/github/mozilla/blok)
[![Available on Test Pilot](https://img.shields.io/badge/available_on-Test_Pilot-0996F8.svg)](https://testpilot.firefox.com/experiments/tracking-protection)

[Web Extension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/) re-implementation of [Tracking Protection for Firefox](https://support.mozilla.org/en-US/kb/tracking-protection-pbm).

We will run this add-on thru [Test Pilot experimentation](https://testpilot.firefox.com/experiments) to:

* Measure web content breakage
* Collect user feedback

When we have breakage data and user feedback, we will change the tracking protection implementation, so users get better web experience with tracking protection.


## Requirements

* Firefox 48+


## Run it

1. [Download the latest `.xpi`](https://github.com/mozilla/blok/tree/master/web-ext-artifacts)
2. In Firefox, "Open File" and select the `.xpi`

When the add-on blocks tracker requests, you will see a Tracking Protection pageAction icon:

![pageAction Screenshot](docs/page-action-screenshot.png)

When you click the icon, you will see a pop-up, so you can report
broken/working pages, or toggle Tracking Protection on or off:

![Pop-up Screenshot](docs/pop-up-screenshot.png)


## Development

1. Clone this repo locally
2. `cd blok`
3. `npm install`
4. `npm run bundle`

### Running the Code

This add-on depends on [`web-ext`](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext). Using `web-ext`, start a version of Firefox running the add-on like so:

`./node_modules/.bin/web-ext run --source-dir=src --firefox-binary {path to Firefox 49+ binary}`

### Development Environment

Add-on development is better with [a particular  environment](https://developer.mozilla.org/en-US/Add-ons/Setting_up_extension_development_environment). One simple way to get that environment set up is to install the [DevPrefs add-on](https://addons.mozilla.org/en-US/firefox/addon/devprefs/). You can make a custom Firefox profile that includes the DevPrefs add-on, and use that profile when you run the code in this repository. 

![profileEditor Screenshot](docs/profile-editor-screenshot.png)

1. Make a new profile by running `{path to Firefox binary} -no-remote -P {new_profile_name}`, which launches the profile editor. "Create Profile" -- name it whatever you wish (e.g. 'blok_dev') and store it in the default location. It's probably best to deselect the option to "Use without asking," since you probably don't want to use this as your default profile.

2. Once you've created your profile, click "Start Firefox". A new instance of Firefox should launch. Go to Tools->Add-ons and search for "DevPrefs". Install it. Quit Firefox.

3. Now you have a new, vanilla Firefox profile with the DevPrefs add-on installed. You can use your new profile with the code in _this_ repository like so:

`./node_modules/.bin/web-ext run --source-dir=src --firefox-binary {path to Firefox 49+ binary} --firefox-profile {new_profile_name}`

Check out the [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox) for more information about debugging add-on code.

## Testing

Requires node 6+

`npm test`

## Distributing

To distribute, you will need AMO access credentials. See the `web-ext` docs.

1. Use [`web-ext
   sign`](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/web-ext_command_reference#web-ext_sign)

## FAQ, Footnotes, Appendices, etc.
#### How does this compare with ublock, privacy badger, ghostery, etc.
The primary goal of this add-on experiment is to create a feedback loop for
tracking protection users to provide data on problems & breakage, so we
(Mozilla) can learn how to improve tracking protection technologies in ways
that maximize user privacy AND minimize web breakage.

The other privacy add-ons are great tools as well. The focus on reporting
website problems & breakages is the key difference here. In fact, we deferred a
number of other features in favor of simplicity and to make the feedback
mechanism the primary focus of the add-on.

Read more on [the discourse forum](https://discourse.mozilla-community.org/c/test-pilot/tracking-protection).

### How do I run the add-on without `web-ext`

1. Go to `about:config` and set `xpinstall.signatures.required` to `false`
2. Go to `about:debugging`
3. Click "Load Temporary Add-on"
4. Select this repo's `src/manifest.json` file