mullvad / browser-extension

Mullvad Browser Extension improves your browsing experience while using Mullvad VPN.
Other
188 stars 15 forks source link

ci

Mullvad Browser Extension

Mullvad Browser Extension is a Firefox extension improving your browser experience while using Mullvad VPN. It also displays information about the connection, recommends optimal DNS settings, and a one-click access to proxy servers.

Download

You can visit our download page to get the latest release.

The extension is also available here on Github in the Releases.

Development

Environment

Build with:

If you use nvm, run nvm use to automatically set these versions.

For:

Developing

The first time, use npm install to install the necessary packages.

To start the extension in a a temporary and clean browser:

The developer tools can be started by clicking on the inspect in the debugging tab (automatically opened).

Building

There are other build options which you can view in package.json.

Testing the extension in your browser

You can only install the extension temporarily when it is not signed by Mozilla. To do so:

The extension will automatically unload when Firefox is closed.

Testing restart and persisting features

You can use the restart script to test restart and persisting features (like settings saved to local storage). It will require some manual configuration:

Learn more

Permissions

Mullvad Browser Extension requires the following permissions:

The following permissions are optional, but are needed to use the proxy feature:

Permissions are automatically accepted when testing the extension.

Network requests

Two external network requests are made by the extension:

External links are marked with this icon External Link icon

Source code

Source code is available in the Github repo.