Skip to content

Version 8 and above. Browser extension source code for Firefox, Chrome, and other Chromium-based browsers

License

Notifications You must be signed in to change notification settings

foxyproxy/browser-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

FoxyProxy FoxyProxy Browser Extension

license GitHub repo size ECMAScript

About/Changelog | Help | Issues

After some years of stability, FoxyProxy has been updated to support Manifest Version 3 which is required by Chrome in order for extensions to be compatible with Chrome in 2024. We took advantage of this forced update to implement many feature requests and other changes that were requested over the years.

FoxyProxy has been owned and developed consistently by the same team since 2006.

The repository has the source code for version 8.0+ for Firefox, Chrome, and other Chromium-based browsers like Chromium, Brave and Edge. Source code for older versions.

Permissions

  • downloads: Used to save/export user preferences to file, for backup or sharing
  • notifications: Used to inform users (e.g. for errors)
  • proxy: Used to set proxies (core function of the extension)
  • storage: Used to store user preferences
  • tabs: Used to get tab details (e.g. for "Quick Add", "Tab Proxy", & "Incognito/Container Proxy")
  • webRequest: Used to provide proxy authentication
  • webRequestAuthProvider: Used to provide proxy authentication
  • host permission: Used to provide proxy authentication (to any URL "<all_urls>")

Optional Permissions

  • browsingData: Used for "Delete Browsing Data" button to delete cookies, indexedDB, and localStorage, only if requested by the user
  • privacy: Used for "Limit WebRTC" button to toggle browser.privacy.network.webRTCIPHandlingPolicy, only if requested by the user

Mini FAQ

  • Why is there a CryptoJS library in lib?
    The CryptoJS library was already included in FoxyProxy 3.x to encrypt user credentials. It is needed to migrate encrypted settings from the old version (which had no updates for many years, as you mentioned). It is not used to encrypt anything; only to decrypt old data when upgrading from version 3.x to 8.x.
    The library is not used in Firefox, and will be removed once users migrate to v8+.

  • Remote Code
    No remote code is used in this extension.

Screenshots

Dark Theme

Light Theme

Releases

Chrome Firefox Edge
Standard



Basic

Source Code Beta
Source Code Release Releases
Source Code Old 3.0.7.1 7.5.1

Browser Minimum

Chrome Firefox Firefox for Android
version 108
(released 2022-11-29)
version 93
(released 2021-10-05)
version 113 (manifest)
(API minimum 102)

Beta Installation Guide

  • Backup your FoxyProxy settings

  • Download repo (or use git)

    • browser-extension (this page) -> Code (green button) -> Download ZIP
    • Unzip the downloaded file
  • Chrome

    • Rename manifest-chrome.json in src folder to manifest.json
    • Go to chrome://extensions/
    • Enable Developer Mode (top right)
    • Click "Load Unpacked"
    • Select above manifest.json (or src folder)
  • Firefox (Nightly/Beta/Developer Edition)

    • Rename manifest-firefox.json in src folder to manifest.json
    • Go to about:debugging#/runtime/this-firefox
    • Click "Load Temporary Add-on..."
    • Select above manifest.json
  • Firefox for Android

    • Install Firefox Nightly
    • Enable Debug Menu
      • Go to: menu -> Settings -> About Firefox Nightly
      • Tap a few times on the Firefox icon to enable debug menu
      • Go to: about:config
      • Find xpinstall.signatures.required
      • Toggle to false
    • Install Beta version
      • Prepare src for Firefox as mentioned above
      • Create a zip file from the content of src
      • Make the file available to the Android device
    • Install add-on from file
      • Go to: menu -> Settings -> Advanced -> Install add-on from file

Building for Distribution

With grunt:

  • Install grunt locally:
    • npm i -D grunt-cli
  • Run one of:
    • grunt --target=chrome-standard
    • grunt --target=chrome-basic
    • grunt --target=firefox-standard
    • grunt --target=firefox-basic

The target is built in foxyproxy-XXX-YYY.zip; e.g. foxyproxy-chrome-standard.zip.

Without grunt:

  • copy the appropriate manifest-xxx.json file to manifest.json; e.g. mv manifest-chrome.json manifest.json
  • zip the src directory into the top of an archive. The src/ directory should not be in the zip archive.

FAQ

πŸ’» Settings disappeared after the upgrade to v8

Using Firefox and you've lost all FoxyProxy settings?

FoxyProxy Basic 8.0 was first released in Sep 2023 as a trial run since it had fewer users (26k on Chrome & Firefox). We waited for 2 months for any feedback & bug reports before releasing FoxyProxy Standard. Unfortunately, we didn't get any bug report about the data migration sync issue, otherwise we would have fixed it before releasing the standard version. FoxyProxy 8.2 went online on Dec 6th. Due to a bug in version 8.2, previous settings of some users were not migrated after the upgrade. Versions 8.3-8.6 created with fixes for the bugs immediately, but due to the AMO approval waiting time, version 8.6 came online on Dec 12th.

Previous settings were not deleted and are recoverable. The following options are available if FoxyProxy updated from 7.* and you have encountered the update bug.

Retrieve Settings and Keep version 8.2

From this comment:

Look for old data

  1. Go to the FoxyProxy Options page
  2. Open the Dev Tools (F12)
  3. Go to the Console tab
  4. Type the following and hit ENTER

With Sync

  browser.storage.sync.get().then(console.log)

If above has some data, then in the Console tab, type the following and hit ENTER

browser.storage.sync.get().then(pref => {
  const data = JSON.stringify(pref, null, 2);
  const blob = new Blob([data], {type: 'application/json'});
  browser.downloads.download({
    url: URL.createObjectURL(blob),
    filename: 'FoxyProxy_sync.json',
    saveAs: true,
    conflictAction: 'uniquify'
  })
  .catch(() => {});
});

Without Sync

  browser.storage.local.get().then(console.log)

If above has some data, then in the Console tab, type the following and hit ENTER

browser.storage.local.get().then(pref => {
  const data = JSON.stringify(pref, null, 2);
  const blob = new Blob([data], {type: 'application/json'});
  browser.downloads.download({
    url: URL.createObjectURL(blob),
    filename: 'FoxyProxy_local.json',
    saveAs: true,
    conflictAction: 'uniquify'
  })
  .catch(() => {});
});

Import data

  1. Go to Import Tab -> Import from older versions
  2. Import the FoxyProxy_sync.json or FoxyProxy_local.json file that you have saved
  3. Click SAVE to save the data
Downgrade to 7.*

Downgrade may retrieve old settings.

  1. Download 7.5.1 (or older) from https://addons.mozilla.org/firefox/addon/foxyproxy-standard/versions/
  2. Click the file; firefox will ask you to install that addon. Confirm
  3. Go to Firefox settings, addons (about:addons), FoxyProxy, check that it shows version 7.*
  4. Important: On that same page, set "Allow automatic updates" to off

The settings bug is expected to be fixed in the latest release. Check About for more information.

πŸ“± Firefox for Android

Firefox for Android ignored disabling extensions.update.enabled (due to a bug). Therefore, installation of an older version from AMO will get updated. The bug is fixed in Firefox 123.

Downgrade or Beta Installation
  • Download 7.5.1 (or older) from https://addons.mozilla.org/firefox/addon/foxyproxy-standard/versions/
  • Make the file available to the Android device through Android File Transfer, adb, Android Studio, or a similar tool
  • Install Firefox Nightly for Developers on Android
  • Enable Debug Menu
    • Go to: menu -> Settings -> About Firefox Nightly
    • Tap a few times on the Firefox icon to enable debug menu
  • Navigate to: about:config
    • Find xpinstall.signatures.required
    • Toggle to false
    • Find (or add) extensions.update.enabled
    • Toggle to false
  • Install add-on from file
    • Go to: menu -> Settings -> Advanced -> Install add-on from file and select the .zip file you transferred to the android device
    • Check "Allow in private browsing" then "Okay, Got it"

See also: