haxine / adguardbrowserextension

AdGuard browser extension

 

Ad blocker with advanced privacy protection features

AdGuard is a fast and lightweight ad blocking browser extension
that effectively blocks all types of ads and trackers.

AdGuard.com | Reddit | Twitter | Telegram

---

AdGuard is a fast and lightweight ad blocking browser extension that effectively blocks all types of ads and trackers on all web pages. We focus on advanced privacy protection features to not just block known trackers, but prevent web sites from building your shadow profile. Unlike its standalone counterparts (AG for Windows, Mac), the browser extension is completely free and open source. You can learn more about the difference here.

AdGuard does not collect any information about you, and does not participate in any acceptable ads program. The only source of income we have is selling premium versions of our software, and we intend to keep it that way.

• Installation
  • Chrome and Chromium-based browsers
  • Firefox
  • Opera
  • Microsoft Edge
  • Safari
• Integration mode
• Contribution
  • Translating AdGuard
  • Testing AdGuard
  • Reporting issues
  • Other options
• Development
  • Requirements
  • How to build
  • Update localizations

Installation

Chrome and Chromium-based browsers

You can get the latest available AdGuard Extension version from the Chrome Web Store.

Firefox

You can get the latest version of AdGuard Extension from the Mozilla Add-ons website.

Legacy Firefox versions, Pale Moon

Starting with the version 3.0 we no more support the legacy versions of Firefox. Here you can get the latest version that supports legacy firefox versions here: https://github.com/AdguardTeam/AdguardBrowserExtension/releases/tag/v.2.10.8 (look for "firefox-legacy" build).

Opera

Opera is basically a Chromium browser, but it maintains its own add-ons store. You can get AdGuard Extension from there.

Microsoft Edge

The latest stable version of AdGuard browser extension is available in Microsoft Store.

Safari

Due to the major changes in Safari 12, we cannot maintain the same codebase anymore for the Safari extension. That's why we launched a new AdGuard for Safari app.

Legacy Safari version

You can get the latest legacy Safari extension version in Safari Extensions gallery. Please note, that Apple is going to completely disable support for legacy extensions in future Safari versions.

Integration mode

The frequently asked question is "does it make sense to use the browser extension alongside AdGuard for Windows or Mac?" Interestingly enough, the answer is "yes, if you like the integration mode".

Q: What is integration mode? It is a special mode that the extension enters when being run along with a desktop AdGuard app (on Windows or macOS).

Q: What happens in the integration mode? In this mode, the extension stops filitering traffic (this function lies completely on the app). Its settings are also ignored, the app's settings are applied instead. The extension's color changes to blue and it serves as a replacement for AdGuard Assistant.

Contribution

We are blessed to have a community that does not only love AdGuard, but also gives back. A lot of people volunteer in various ways to make other users' experience with AdGuard better, and you can join them!

We, on our part, can only be happy to reward the most active members of the community. So, what can you do?

Translating AdGuard

If you want to help with AdGuard translations, please learn more about translating our products here: https://kb.adguard.com/en/general/adguard-translations

Testing AdGuard

You can get a beta version of AdGuard Browser Extension for any browser. All necessary information on this topic can be found on a dedicated page on our website.

Reporting issues

GitHub can be used to report a bug or to submit a feature request. To do so, go to this page and click the New issue button.

Note: for the filter-related issues (missed ads, false positives etc.) use the dedicated repository.

Other options

Here is a dedicated page for those who are willing to contribute.

Development

Requirements

• nodejs
• yarn

Install local dependencies by running:

  yarn install

How to build

How to run tests

  yarn test

Building the dev version

Run the following command:

  yarn dev

This will create a Build directory with unpacked extensions for all browsers:

  Build/chrome-$currentVersion
  Build/firefox-$currentVersion
  Build/opera-$currentVersion

Building the beta and release versions

Before building the release version, you should manually download necessary resources: filters and public suffix list.

  yarn resources

  yarn beta
  yarn release

You will need to put certificate.pem file to the Compiler directory. This build will create unpacked extensions and then pack them (crx for Chrome, xpi for Firefox).

Update localizations

To run the task of downloading the localization files, put the oneskyapp.json configuration file in the root directory.

The configuration file looks like:

{
    "url": "url of localizations",
    "project_id": "some id",
    "secret_key": "some key",
    "api_key": "some api key"
}

For security reasons, this file is ignored by .gitignore settings.

To download and append localizations run:

  yarn locales-download

To upload new phrases to oneskyapp you need the same file oneskyapp.json and file with phrases ./Extension/_locales/en/messages.json. Then run:

  yarn locales-upload