tidy readme, see #1045

- also put readme before releases
This commit is contained in:
Thorin-Oakenpants 2020-10-19 12:48:10 +00:00 committed by GitHub
parent 1e85cb0302
commit 919f06d3ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

52
user.js
View file

@ -5,40 +5,34 @@
* url: https://github.com/arkenfox/user.js * url: https://github.com/arkenfox/user.js
* license: MIT: https://github.com/arkenfox/user.js/blob/master/LICENSE.txt * license: MIT: https://github.com/arkenfox/user.js/blob/master/LICENSE.txt
* releases: These are end-of-stable-life-cycle legacy archives.
*Always* use the master branch user.js for a current up-to-date version
url: https://github.com/arkenfox/user.js/releases
* README: * README:
0. Consider using Tor Browser if it meets your needs or fits your threat model better 1. Consider using Tor Browser if it meets your needs or fits your threat model better
* https://www.torproject.org/about/torusers.html.en * https://www.torproject.org/about/torusers.html.en
1. READ the full README 2. Required reading: Overview, Backing Up, Implementing, and Maintenance entries
* https://github.com/arkenfox/user.js/blob/master/README.md * https://github.com/arkenfox/user.js/wiki
2. READ this 3. If you skipped step 2, return to step 2
* https://github.com/arkenfox/user.js/wiki/1.3-Implementation 4. Make changes
3. If you skipped steps 1 and 2 above (shame on you), then here is the absolute minimum * There are often trade-offs and conflicts between security vs privacy vs anti-fingerprinting
* Real time binary checks with Google services are disabled (0412) and these need to be balanced against functionality & convenience & breakage
* You will still get prompts to update Firefox, but auto-installing them is disabled (0302a) * Some site breakage and unintended consequences will happen. Everyone's experience will differ
* Some user data is erased on close (section 2800). Change this to suit your needs e.g. some user data is erased on close (section 2800), change this to suit your needs
* EACH RELEASE check: * While not 100% definitive, search for "[SETUP" tags
- 4600s: reset prefs made redundant due to privacy.resistFingerprinting (RPF) * Take the wiki link in step 2 and read the Troubleshooting entry
or enable them as an alternative to RFP (or some of them for ESR users) 5. Some tag info
- 9999s: reset deprecated prefs in about:config or enable the relevant section for ESR
* Site breakage WILL happen
- There are often trade-offs and conflicts between Security vs Privacy vs Anti-Fingerprinting
and these need to be balanced against Functionality & Convenience & Breakage
* You will need to make changes, and to troubleshoot at times (choose wisely, there is always a trade-off).
While not 100% definitive, search for "[SETUP". If required, add each pref to your overrides section at
default values (or comment them out and reset them in about:config). Here are the main ones:
[SETUP-SECURITY] it's one item, read it [SETUP-SECURITY] it's one item, read it
[SETUP-WEB] can cause some websites to break [SETUP-WEB] can cause some websites to break
[SETUP-CHROME] changes how Firefox itself behaves (i.e. NOT directly website related) [SETUP-CHROME] changes how Firefox itself behaves (i.e. not directly website related)
[SETUP-PERF] may impact performance [SETUP-PERF] may impact performance
[SETUP-HARDEN] maybe you should consider using the Tor Browser [WARNING] used sparingly, heed them
* [WARNING] tags are extra special and used sparingly, so heed them
4. BACKUP your profile folder before implementing (and/or test in a new/cloned profile) * RELEASES
5. KEEP UP TO DATE: https://github.com/arkenfox/user.js/wiki#small_orange_diamond-maintenance
* Archive: https://github.com/arkenfox/user.js/releases
* Each release check:
- 4600s: reset prefs made redundant due to privacy.resistFingerprinting (RPF)
or enable them as an alternative to RFP (or some of them for ESR users)
- 9999s: reset deprecated prefs in about:config or enable the relevant section for ESR
* INDEX: * INDEX: