AdGuardVPNExtension: A TypeScript repository from AdGuard

AdGuard VPN extension

Fast, flexible and reliable VPN extension for browsers

Your online safety and anonymity guaranteed by a trusted developer.

AdGuard VPN serves to protect your online privacy, encrypt your connection, hide your IP address and websites you visit from anyone (including your ISP). Cutting-edge technologies and multiple customization options will help conceal your location and ensure anonymous browsing on the web.

To get more information and to download AdGuard VPN visit our website https://adguard-vpn.com/.

Feedback options

We appreciate your feedback and always welcome both constructive critisism and new ideas.

You can use GitHub to report a bug or to submit a feature request. To do so, go to this page, click the New issue button and choose between creating a bug report or feature request.

Development
Acknowledgments
Minimum supported browser versions

Development

Requirements

Install local dependencies

  yarn install

Manage environment variables

Rename .env.example to .env and fill it with required config data
Also, you can provide environment variables through command line like this:

  STAGE_ENV=test \
  VPN_API_URL="vpn_api_url" \
  AUTH_API_URL="auth_api_url" \
  FORWARDER_DOMAIN="forwarder_domain" \

Linting

  yarn lint

Tests

  yarn test

Build

Dev version

  yarn dev

Beta version

  yarn beta

Release version

  yarn release

Builds will be located in the build directory

By default, you will have builds for all browsers:

Chrome (manifest version 2)
Chrome (manifest version 3)
Firefox (manifest version 2)
Opera (manifest version 2)
Edge (manifest version 2)

You can specify browser in arguments. See examples below:

yarn dev chrome
yarn beta chrome-mv3
yarn release opera

Update resources

Before releasing new versions do not forget to update exclusions-services data, which will be used for migration if remote data was not received from the servers.

Artifact builds

CREDENTIALS_PASSWORD=<password> artifacts:beta
CREDENTIALS_PASSWORD=<password> artifacts:release

Make sure you have added credentials

certificate-beta.pem - chrome crx beta certificate
certificate-release.pem - chrome crx release certificate
mozilla_credentials.json - encrypted credentials,

to the directory ./private/AdguardVPN

Localization

setup your project locales, directories in the file tasks/locales.js
yarn locales:upload used to upload base en locale
yarn locales:download run to download and save all locales
yarn locales:validate used to validate locales
yarn locales:validate --min used to validate only major locales

Proto scheme update

After every update of proto scheme in the file src/background/connectivity/connectivity.proto, you have to run yarn compile-proto. This command will update module src/background/connectivity/protobufCompiled.js used to build messages with appropriate scheme for websocket messaging.

Acknowledgments

This software wouldn't have been possible without:

React
MobX
Babel
Jest
and many more npm packages.

For a full list of all npm packages in use, please take a look at package.json file.

Minimum supported browser versions

Browser	Version
Chromium Based Browsers MV3	109
Chromium Based Browsers MV2	66
Firefox	91.1

AdguardTeam/AdGuardVPNExtension