Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@erosman
erosman authored Feb 23, 2024
1 parent af66609 commit adeff7e
Showing 1 changed file with 126 additions and 127 deletions.
253 changes: 126 additions & 127 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,130 +1,3 @@
# 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.

<details>
<summary><b>Retrieve Settings and Keep version 8.2</b></summary>

From [this comment](https://github.com/foxyproxy/browser-extension/issues/45#issuecomment-1838719332):

### 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

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

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

```js
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

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

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

```js
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
</details>

<details>
<summary><b>Downgrade to 7.*</b></summary>

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](https://foxyproxy.github.io/browser-extension/src/content/about.html) for more information.

</details>




## 📱 Firefox for Android

Firefox for Android ignored disabling `extensions.update.enabled` (due to a [bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1872169)). Therefore, installation of an older version from AMO will get updated. The bug is fixed in Firefox 123.

<details>
<summary><b>Downgrade ot Beta Installation</b></summary>


- 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](https://www.android.com/filetransfer/), adb, Android Studio, or a similar tool
- Install [Firefox Nightly for Developers](https://play.google.com/store/apps/details?id=org.mozilla.fenix&hl=en&gl=US) 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:
- [Downgrade instructions](https://github.com/foxyproxy/browser-extension/issues/107)
- [Beta instructions](https://github.com/foxyproxy/browser-extension#beta-installation-guide)

</details>

---

# ![FoxyProxy](/src/image/icon.svg) FoxyProxy Browser Extension

[![license](https://img.shields.io/github/license/foxyproxy/browser-extension.svg)](https://github.com/foxyproxy/browser-extension/blob/master/LICENSE)
Expand Down Expand Up @@ -309,3 +182,129 @@ The target is built in `foxyproxy-XXX-YYY.zip`; e.g. `foxyproxy-chrome-standard.

- 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.

<details>
<summary><b>Retrieve Settings and Keep version 8.2</b></summary>

From [this comment](https://github.com/foxyproxy/browser-extension/issues/45#issuecomment-1838719332):

### 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

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

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

```js
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

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

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

```js
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
</details>

<details>
<summary><b>Downgrade to 7.*</b></summary>

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](https://foxyproxy.github.io/browser-extension/src/content/about.html) for more information.

</details>




## 📱 Firefox for Android

Firefox for Android ignored disabling `extensions.update.enabled` (due to a [bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1872169)). Therefore, installation of an older version from AMO will get updated. The bug is fixed in Firefox 123.

<details>
<summary><b>Downgrade ot Beta Installation</b></summary>


- 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](https://www.android.com/filetransfer/), adb, Android Studio, or a similar tool
- Install [Firefox Nightly for Developers](https://play.google.com/store/apps/details?id=org.mozilla.fenix&hl=en&gl=US) 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:
- [Downgrade instructions](https://github.com/foxyproxy/browser-extension/issues/107)
- [Beta instructions](https://github.com/foxyproxy/browser-extension#beta-installation-guide)

</details>

0 comments on commit adeff7e

Please sign in to comment.