browser-extension/README.md

128 lines
6.0 KiB
Markdown
Raw Normal View History

2022-08-27 01:38:12 +08:00
# ![FoxyProxy](/src/image/icon.svg) FoxyProxy Browser Extension
2023-11-02 05:42:42 +08:00
2023-11-02 06:01:37 +08:00
[![license](https://img.shields.io/github/license/foxyproxy/browser-extension.svg)](https://github.com/foxyproxy/browser-extension/blob/master/LICENSE)
![GitHub repo size](https://img.shields.io/github/repo-size/foxyproxy/browser-extension)
2023-11-28 18:53:26 +08:00
![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Ffoxyproxy%2Fbrowser-extension%2Fmain%2Fsrc%2Fmanifest-firefox.json&query=%24.version&prefix=v&label=FoxyProxy%20beta&color=f60)
2023-11-02 06:01:37 +08:00
2023-11-02 05:42:42 +08:00
2023-11-02 21:01:22 +08:00
Version 8.0+
2022-08-27 01:52:16 +08:00
Browser extension source code for *Firefox*, *Chrome*, and other Chromium-based browsers like *Chromium*, *Brave* and *Edge*
2022-08-27 01:38:12 +08:00
2023-09-25 14:51:01 +08:00
FoxyProxy is being updated for manifest V3.
Please post all feature requests to the [issues](https://github.com/foxyproxy/browser-extension/issues).
2022-10-27 22:35:17 +08:00
2022-08-27 01:52:16 +08:00
2022-11-29 18:59:13 +08:00
- [About](https://foxyproxy.github.io/browser-extension/src/content/about.html)
- [Help](https://foxyproxy.github.io/browser-extension/src/content/help.html)
2022-09-08 15:33:45 +08:00
2022-09-08 03:35:25 +08:00
2023-11-02 21:01:22 +08:00
## Releases
2022-11-29 18:59:13 +08:00
2023-11-03 01:50:46 +08:00
<table>
<thead>
<tr>
<th></th>
<th>Chrome</th>
2023-11-29 00:32:55 +08:00
<th>Firefox</th>
2023-11-03 01:50:46 +08:00
</tr>
</thead>
<tbody>
<tr>
<td>Standard</td>
2023-11-29 00:32:55 +08:00
<td>
<a href="https://chromewebstore.google.com/detail/foxyproxy-standard/gcknhkkoolaabfmlnjonogaaifnjlfnp"><img src="https://img.shields.io/chrome-web-store/v/gcknhkkoolaabfmlnjonogaaifnjlfnp.svg" alt=""></a><br>
<a href="https://chromewebstore.google.com/detail/foxyproxy-standard/gcknhkkoolaabfmlnjonogaaifnjlfnp"><img src="https://img.shields.io/chrome-web-store/users/gcknhkkoolaabfmlnjonogaaifnjlfnp" alt=""></a>
</td>
2023-11-03 01:50:46 +08:00
<td>
2023-11-28 17:52:18 +08:00
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-standard/"><img src="https://img.shields.io/amo/v/foxyproxy-standard" alt=""></a><br>
2023-11-28 17:58:55 +08:00
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-standard/"><img src="https://img.shields.io/amo/users/foxyproxy-standard" alt=""></a>
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-standard/"><img src="https://img.shields.io/amo/dw/foxyproxy-standard" alt=""></a>
2023-11-03 01:50:46 +08:00
</td>
</tr>
<tr>
<td>Basic</td>
2023-11-29 00:32:55 +08:00
<td>
<a href="https://chromewebstore.google.com/detail/foxyproxy-basic/dookpfaalaaappcdneeahomimbllocnb"><img src="https://img.shields.io/chrome-web-store/v/dookpfaalaaappcdneeahomimbllocnb.svg?color=f60" alt=""></a><br>
<a href="https://chromewebstore.google.com/detail/foxyproxy-basic/dookpfaalaaappcdneeahomimbllocnb"><img src="https://img.shields.io/chrome-web-store/users/dookpfaalaaappcdneeahomimbllocnb" alt=""></a>
</td>
2023-11-03 01:50:46 +08:00
<td>
2023-11-28 17:52:18 +08:00
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-basic/"><img src="https://img.shields.io/amo/v/foxyproxy-basic.svg?color=f60" alt=""></a><br>
2023-11-28 17:58:55 +08:00
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-basic/"></a><img src="https://img.shields.io/amo/users/foxyproxy-basic" alt="">
<a href="https://addons.mozilla.org/firefox/addon/foxyproxy-basic/"></a><img src="https://img.shields.io/amo/dw/foxyproxy-basic" alt="">
2023-11-03 01:50:46 +08:00
</td>
</tr>
<tr>
<td>Source Code</td>
<td><a href="https://github.com/foxyproxy/Foxyproxy_Chrome">3.0.7.1</a></td>
2023-11-29 00:32:55 +08:00
<td><a href="https://github.com/foxyproxy/firefox-extension/">7.5.1</a></td>
2023-11-03 01:50:46 +08:00
</tr>
</tbody>
</table>
2022-11-29 18:59:13 +08:00
2023-11-02 05:37:59 +08:00
2023-11-12 18:37:49 +08:00
## Browser Minimum Versions
<table>
<thead>
<tr>
<th>Chrome</th>
2023-11-29 00:32:55 +08:00
<th>Firefox</th>
2023-11-12 18:37:49 +08:00
<th>Firefox for Android</th>
</tr>
</thead>
<tbody>
<tr>
<td>version 108<br><i>(released 2022-11-29)</i></td>
2023-11-29 00:32:55 +08:00
<td>version 93<br><i>(released 2021-10-05)</i></td>
2023-11-12 18:37:49 +08:00
<td>version 113 (manifest)<br><i>(API minimum 102)</i></td>
</tr>
</tbody>
</table>
2023-09-25 14:51:01 +08:00
## Installation Guide (for testing)
2023-08-17 18:30:01 +08:00
- Backup your FoxyProxy settings
2023-11-28 22:16:50 +08:00
- Download repo *(or use `git`)*
- browser-extension *(this page)* -> Code *(green button)* -> Download ZIP
2023-08-17 18:30:01 +08:00
- Unzip the downloaded file
2023-11-29 00:32:55 +08:00
2023-08-17 18:30:01 +08:00
- **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)
2023-11-29 00:32:55 +08:00
- **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`
2023-09-29 20:21:34 +08:00
- **Firefox for Android**
2023-11-28 22:16:50 +08:00
You can try installing FoxyProxy Basic v8.*
2023-09-29 20:21:34 +08:00
- [Expanded extension support in Firefox for Android Nightly](https://blog.mozilla.org/addons/2020/09/29/expanded-extension-support-in-firefox-for-android-nightly/)
- [How to Install Any Add-on in Firefox for Android](https://www.maketecheasier.com/install-addon-firefox-android/)
2023-09-25 14:51:01 +08:00
## Building for Distribution
2023-11-28 23:53:32 +08:00
- Copy the appropriate `manifest-xxx.json` file to `manifest.json`
e.g. `mv manifest-chrome.json manifest.json`
- Zip using [grunt](https://stackoverflow.com/questions/15703598/how-to-install-grunt-and-how-to-build-script-with-it), which requires npm and node. Run `grunt` in top-level directory. The add-on is packaged into `target.zip`. Alternatively, zip the `src` directory into the top of an archive and exclude a bunch of stuff manually.
2023-11-28 23:38:38 +08:00
## Screenshots
<img src="/screenshots/8.1/dark-theme/popup.jpg" width="200" alt=""> <img src="/screenshots/8.1/dark-theme/options-tab.jpg" width="200" alt="">
2023-11-29 00:04:36 +08:00
<img src="/screenshots/8.1/dark-theme/proxies-tab.jpg" width="200" alt="">
2023-11-28 23:38:38 +08:00
2023-11-29 00:04:36 +08:00
<img src="/screenshots/8.1/dark-theme/import-tab.jpg" width="200" alt=""> <img src="/screenshots/8.1/dark-theme/pattern-tester-tab.jpg" width="200" alt="">
<img src="/screenshots/8.1/dark-theme/log-tab.jpg" width="200" alt="">
<img src="/screenshots/8.1/light-theme/popup.jpg" width="200" alt=""> <img src="/screenshots/8.1/light-theme/options-tab.jpg" width="200" alt="">
<img src="/screenshots/8.1/light-theme/proxies-tab.jpg" width="200" alt="">
<img src="/screenshots/8.1/light-theme/import-tab.jpg" width="200" alt=""> <img src="/screenshots/8.1/light-theme/pattern-tester-tab.jpg" width="200" alt="">
<img src="/screenshots/8.1/light-theme/log-tab.jpg" width="200" alt="">