still drafting

This commit is contained in:
Thorin-Oakenpants 2017-03-31 06:36:53 +13:00 committed by GitHub
parent 5397d2a39a
commit 1b28066b82

View File

@ -1,48 +1,29 @@
## ghacks-user.js
this is still a draft
- This is a rough draft, please read the old intro currently at the start of the user.js in the meantime.
- Paragraph here about not jumping in without reading first, and backing up, and understanding the changes
### :small_orange_diamond: Foreword
What started as a personal, private project back in early 2015, was released as an article by Martin Brinkmann at [gHacks](https://www.ghacks.net/) in August 2015. I never expected much to happen beyond the first article, but it did. The response from the ghacks community was great. I continued to keep it up-to-date and expand it. And along with suggestions from ghacks commentators, it has evolved and grown. But six monthly updates are problematic. So two years since I started, here we are at github, with all the obvious benefits that brings. I am excited about finally being here (it was talked about for a year), and looking forward to taking this to the next level with you all.
### Origins
- yada yada
Thorin-Oakenpants, 31-Mar-2017
### Purpose
- discuss why use a js (enforcement on startup, migration)
- outline trade-offs between security vs privacy etc
- explain expectations and site breakage
- explain this version is a "compromise" or balance that aims (with addons eg you WILL need uBlock Origin or turn safe browsing and tracking protection back on) to provide as much privacy and enhanced security as possible, and to reduce the fingerpritning attack surface as much as possible - while putting up with some incoveniences and as little site breakage as possible (but it will happen). It's only a starting point.
- provide troubleshooting: site breakage will happen. 90=% of the preferences cause no issues. It is only a small core of settings that people may or may not need to look at, depending on their objective.
- no one size fits all, this is a template, fork it! Customize it! (see goals, we won't set you wrong)
PS: With Martin Brinckmann's blessing, we are keeping the ghacks name.
### :small_orange_diamond: What does this aim to do?
### Goals & Standards
To be **THE** template and resource all other user.js' come to for news, links, information and more, which means it needs to be:
### :small_orange_diamond: What else?
- comprehensive (eg some prefs are included at default for completeness/enforcement, a lot are included and changed for future-proofing, etc)
- current and available and change-trackable (hey, we're on github now)
- easy to understand (good, simple, less-technincal descriptions)
- accountable and a resource (lots of links to authorative authors and tech papers, also repo wiki)
- correct and to dispell myths and bad advise (see accountable)
- eassy to follow and report and discuss (logical and numbered structure)
- give good advise (see trade-offs)
- expanded on with more information, such as FF version numbering for introduction and deprecation of preferences, hidden pref tags etc
- archived for each stable release (starting with 51)
- to provide illustrated wiki topics to help (help wanted please!)
- to make it as easy as possible for anyone to use a user.js and get it right for them
- to provide two or three future forks with differnent settings from "painless no-breakage no-addons" thru to a "super-hardened" version: for use with multiple profiles
### :small_orange_diamond: What's in the pipeline?
### Implementation
- expectations of the user
- link to wiki on testing and tweaking in a portable FF first
- backup first: link to wiki article on backup & restore methods
- changing, resetting preferences: user.js and about:config
### :small_orange_diamond: How do I use this?
Everyone, experts included, need to read at least the Wiki page on [Implementation](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.3-Implementation), as it contains important information relating to a few default settings we use. The rest of the [Wiki](https://github.com/ghacksuserjs/ghacks-user.js/wiki) can be helpful as well.
### Troubleshooting
- wiki links
### Help & Resources
- wiki links, appendices etc
### Acknowledgements
- yada yada
### :small_orange_diamond: Acknowledgments
It's impossible to acknowledge everyone - literally thousands of sources, references and suggestions. That said...
* Martin Brinkmann at [gHacks](https://www.ghacks.net/)
* 100% genuine super-nice all-round good guy. Thanks buddy!
* The ghacks community and commentators
* Special mentions to earthling, Tom Hawack, Just me, Conker, Rockin' Jerry, Ainatar, Parker Lewis
* [12bytes](http://12bytes.org/articles/tech/firefoxgecko-configuration-guide-for-privacy-and-performance-buffs)
* The 12bytes article now uses this user.js and supplements it with an additonal JS hosted right [here](https://github.com/atomGit/Firefox-user.js) at github. Thanks atomGit!
* [pyllyukko's user.js](https://github.com/pyllyukko/user.js)
* A similar project started in Dec 2014