8 3.1 Overrides
Thorin-Oakenpants edited this page 2023-11-02 20:10:20 +00:00

🟩 Previous: Backup

🟥 Summary: Everyone will need some "overrides" in a user-overrides.js. Directly modifying arkenfox's contents is not recommended. This section is about how overrides work. To help with what you might like to override, see the next section.


Arkenfox v115.1+ makes approx 110 pref changes. With that, you will get some inconvenience and breakage. Everybody's mileage and threat model will differ - EVERYONE will need some "overrides". You do this by keeping them in a separate user-overrides.js file in your profile folder, so updating doesn't wipe them but instead appends them (when you run the updater).

Remember how a user.js applies prefs in the order they are written? So if a pref was listed a second time, then the second value (yours) would override the first (arkenfox's).

🔹 user.js (live arkenfox)

user_pref("pref.name.example", "purple")

🔹 user-overrides.js (you create this file)

// my overrides
user_pref("pref.name.example", "green") // I like green

The updater gets the current live arkenfox 1 and appends your overrides, and then it compares that to the current user.js in your profile. If it's different, it replaces it. In this example, Firefox will apply the value of green when Firefox is started.

🔹 user.js (yours after updater runs)

user_pref("pref.name.example", "purple")

// my overrides
user_pref("pref.name.example", "green") // I like green

1 Arkenfox changes to the live master happen once per release: all changes are done in a separate branch and only merged when finished.


🟩 Next: Overrides [Common]