firefox-userjs/README.org
Foster Hangdaan 6c6f4743e3
Update README.org
- Added Contributing section
2023-10-08 20:35:36 -04:00

38 lines
2 KiB
Org Mode

#+title: Foster's Firefox User.js
* What is a =user.js= File?
A =user.js= is a configuration file to control Firefox settings. Refer to the [[https://kb.mozillazine.org/User.js_file][User.js entry from the MozillaZine Knowledge Base]] for more info.
* About
This is my personal =user.js= for configuring Firefox and is based on [[https://github.com/arkenfox/user.js][ArkenFox's user.js]]. The goal is to enhance privacy by preventing unsolicited requests made by Firefox. To achieve this, many settings related to telemetry, studies, geolocation, and experiments are disabled.
Only a subset of the configurations from Arkenfox are implemented and many of the experimental options are excluded. As a result, this version should not cause any breakages. If you are looking for a more comprehensive privacy configuration, then I suggest going with the Arkenfox version instead.
* Installation
Before you begin, I suggest making a backup of your entire Firefox profile folder. Refer to [[https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data][Mozilla's Profiles support article]] on how to find the location of the profile folder.
Copy the =user.js= file in the root directory of this repo to your profile folder then restart Firefox.
* Contributing
Please send patches and bug reports by email to one of the maintainers. See [[*Core Maintainers][core maintainers section]].
Refer to [[https://git-send-email.io][this guide]] if you are not familiar with sending Git patches over email.
* Core Maintainers
- *Foster Hangdaan*
- Website: [[https://www.fosterhangdaan.com][www.fosterhangdaan.com]]
- Email: [[mailto:foster@hangdaan.email][foster@hangdaan.email]]
- GPG Public Key: [[https://static.fosterhangdaan.com/foster-pubkey.asc][DBD3 8E38 4B9E 1F4F 19F9 5BAE E48D 7F49 A852 F112]]
- Bitcoin/Monero Alias: =pay.fosterhangdaan.com=
* License
Copyright (c) 2023 Foster Hangdaan
This work is under the MIT license. See [[https://code.fosterhangdaan.com/foster/firefox-userjs/src/branch/trunk/LICENSE.txt][LICENSE.txt]].