Git/firefox-user.js
1
0
Fork 0
mirror of https://github.com/arkenfox/user.js.git synced 2024-11-29 22:06:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated 3.1 Bulk Pref Resetting [Scratchpad] (markdown)

Thorin-Oakenpants 2017-12-24 14:24:00 +13:00
parent 799a603c64
commit bfe4a1fb05
1 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
3.1-Bulk-Pref-Resetting-[Scratchpad].md

@ -1,36 +1,37 @@
:exclamation: Read the instructions, back up your profile, and use at your own risk. Our scratchpad scripts are stored [here](https://github.com/ghacksuserjs/ghacks-user.js/tree/master/scratchpad-scripts) :exclamation: Read the instructions, back up your profile, and use at your own risk (although we have thoroughly tested them!).
- Our scratchpad scripts are stored [here](https://github.com/ghacksuserjs/ghacks-user.js/tree/master/scratchpad-scripts)
### :small_orange_diamond: Overview - Our `prefsCleaner.bat` file is [here](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/prefsCleaner.bat)
In our [changelog](https://github.com/ghacksuserjs/ghacks-user.js/search?q=label%3Achangelog&type=Issues&utf8=✓) for each release of the ghacks `user.js`, we list preferences that have been:
- REMOVED from the `user.js`
- made INACTIVE (i.e commented out) in the `user.js`
- DEPRECATED (Section 9999)
- become REDUNDANT or CONFLICT with `privacy.resistFingerprinting` (RFP) (Section 4600)
Removed prefs are nowhere to be found, and we have no easy answer except to pay attention to the changelogs. As for the rest: sections 4600 and 9999 list items by Firefox version, and prefs we've made inactive are still there, just harder to spot. Note: That even if you are on ESR, sooner or later, the deprecated prefs will still apply
### :small_orange_diamond: The Issue ### :small_orange_diamond: The Issue
So all these REMOVED, INACTIVE, DEPRECATED, and REDUNDANT prefs should be reset in `about:config`. And over time, the list builds up. Some are harmless (deprecated items will have no effect), but others are vital (e.g. `dom.indexedDB.enabled` is now used by some Extensions <sup>1</sup> (e.g uBlock Origin, uMatrix, Stylus). And some items in 4600 actually interfere with `privacy.resistFingerprinting`. Add to this any prefs you may have made inactive yourself. Our [changelogs](https://github.com/ghacksuserjs/ghacks-user.js/search?q=label%3Achangelog&type=Issues&utf8=✓) are lists which contain, among other things, information on prefs that have been REMOVED, made INACTIVE (i.e commented out), DEPRECATED (Section 9999), or become REDUNDANT/CONFLICT with `privacy.resistFingerprinting` (RFP) (Section 4600).
So the issue is :question: How do you make sure all these prefs in your user.js have been reset in about:config? Over time you **will** miss something. So **some or all** of these REMOVED, INACTIVE, DEPRECATED, and REDUNDANT prefs **need to be manually reset** in `about:config`, depending on your configuration. And over time, the list builds up. Some are harmless (deprecated items will have no effect), but others are vital (prefs and sections are INACTIVE for a reason, so it pays for your `prefs.js` to be in "sync"). Add to this any prefs you may have made inactive yourself. A REMOVED pref is particularly tricky as it is no longer referenced in the `user.js`.
<sup>1</sup> `Extensions` = Web Extensions API, `Legacy Extensions` = legacy APIs or the Add-on SDK. So the issue is :question: How do you make sure all the INACTIVE/REMOVED prefs in **your** `user.js` have been reset in about:config? Over time you **will** miss something - doing this manually is time consuming and prone to human error.
### :small_orange_diamond: The Solution ### :small_orange_diamond: The Solution
All of the above can be reset manually. Not so bad if you do it on each release and watch the changelogs etc. But this is time consuming, prone to human error, and not automated in any way. We also make prefs and sections INACTIVE for a reason, so it pays to be in "sync". This can also be used when applying a `user.js` to an existing profile for the first time. The solution is simple. Automate it, and reset **every single pref** in the user.js regardless of whether it is active or inactive. Then restart Firefox and all your ACTIVE prefs are reapplied. The end result being all your INACTIVE ones have been reset.
- You can run a script in Scratchpad and do it all in one hit NOTE:
- You still need to compile a list of your - REMOVED prefs are not covered by this (we have a scratchpad script for those).
* INACTIVE prefs, all DEPRECATED (9999) prefs, all RFP ALT (4600) prefs - This can also be used when applying a `user.js` to an existing profile for the first time.
* i.e some SECTIONS are commented out, thus the prefs are "effectively" commented out, but the pref line itself isn't. So you can't just search for `// user_pref` - Some sections in the `user.js` are commented out, thus the prefs are "effectively" commented out, but the pref line itself isn't. So you can't just search for `// user_pref`
* If you know what you're doing, it's fairly trivial
NOTE: You could actually reset **every** **pref** in the user.js, and your ACTIVE prefs will simply be reapplied on the next Firefox start ### :small_blue_diamond: Solution A: Our prefsCleaner.bat file
### :small_orange_diamond: How To Run The Script Run the [prefsCleaner.bat](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/prefsCleaner.bat) file in your profile directory with Firefox closed. This does not cover prefs we REMOVED from the `ghacks user.js`, see the Scratchpad section for those. You can use this on any `user.js`, it does not have to be the ghacks one.
** Special thanks to [claustromaniac](https://github.com/claustromaniac) and [earthlng](https://github.com/earthlng) for all the hard work creating and testing this :kiss:
### :small_blue_diamond: Solution B: Scratchpad Scripts
You can run our [scratchpad scripts](https://github.com/ghacksuserjs/ghacks-user.js/tree/master/scratchpad-scripts), which we have broken down into a handful of smaller, more relevant scripts.
The REMOVED script is the ONLY single point of reference for everything we once tinkered with, but is now gone. It's a short list, but highly recommended that you manually check them or run the script.
### :small_orange_diamond: How To Run A Scratchpad Script
* Close Firefox and [backup](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.2-Backing-Up) your profile * Close Firefox and [backup](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.2-Backing-Up) your profile
* Disable the network connection * Disable the network connection