Autoconfig
Autoconfig is a mechanism that can be used to configure Firefox, Thunderbird, SeaMonkey, and other Gecko-based applications. An autoconfig file is a Javascript file that can modify preferences (application settings) through function calls, and perform other operations, during program startup. It is somewhat similar to the better known user.js file, but there are important differences between the two:
| Characteristic | autoconfig | user.js |
|---|---|---|
| File location: | Program directory | Profile |
| File modification: | Typically requires admin/elevated credentials | Typically requires user credentials |
| Can affect: | All profiles | The profile where it resides |
| Function API: | * getPrefBranch() * pref(prefName, value) * defaultPref(prefName, value) * lockPref(prefName, value) * lockPref(prefName) * getPref(prefName) * clearPref(prefName) * setLDAPVersion(version) * getLDAPAttributes(host, base, filter, attribs, isSecure) * getLDAPValue(str, key) * displayError(funcname, message) * getenv(name) |
* user_pref(prefName, value) * pref(prefName, value) * sticky_pref(prefName, value) |
| Javascript: | Most language features supported | File parser will only process the above function calls |
| Error handling: | Exceptions, error dialogs, custom logging possibilities | Typically silent aborting of file processing |
| Can use other browser APIs via XPCOM1: | Yes | No |
| Can be interactive: | Yes | No |
| Can override and restrict user modifications: | Yes | No |
| Geared toward: | Organizations, admin, users who want its additional capabilities | Those wanting simpler, inherently per-profile, pref setting capabilities |
Due to the differences in function calls and other aspects, an autoconfig file and user.js are not interchangeable. Nor are they mutually exclusive. Both can be used at the same time. It is worth noting that they can perform similar preference modifications, and converting those calls may only involve changing the name of the function used. So someone prefering autoconfig may leverage user.js examples, and vice versa.
Most pages about autoconfig were created in the past and have not been kept up to date. Many examples refer to preferences and/or other things which are no longer applicable. However, the basic characteristics of autoconfig (such as the function call interface it uses) have been pretty stable. So even the oldest articles continue to have some relevancy.
If you are interested in this subject, I would suggest that you start with Mike Kaply's articles. Plus, play around in a test environment. Try manipulating prefs in different ways. Then check the results by reading prefs and viewing what appears in about:config and prefs.js. The autoconfig.js, test.cfg, and user.js files here are intended for such experimentation.
Mike Kaply Articles
- Firefox Autoconfig Files
- Firefox Autoconfig Files Continued
- Advanced Autoconfig Files
- Debugging Firefox Autoconfig Problems
Mozilla Autoconfig Related
- Mission Control Desktop AKA AutoConfig
- A brief guide to Mozilla preferences
- Deploying Firefox in an Enterprise Environment
- Deploying Thunderbird in the Enterprise
Mozilla Source Code
Mozilla XPCOM Related
- https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM
- https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface
Dean Brundage Articles
- An Introduction To Mission Control Desktop
- Setting User Preferences with Mission Control Desktop
- LDAP Queries in Mission Control Desktop
- Mapping Firefox & Thunderbird Behaviors to Preference Settings
- Reading Local Files With Javascript
- Manufacturing User Preferences For MCD
- Easy Thunderbird Account Management Using MCD
Other Autoconfig Links
- http://web.mit.edu/~firefox/www/maintainers/autoconfig.html
- http://pascal-mietlicki.fr/en/blog/post/work/firefox-autoconfig/
- https://wpkg.org/Thunderbird#Thunderbird_Configuration
- http://kb.mozillazine.org/Configuration_utilities_for_administrators
- http://kb.mozillazine.org/Locking_preferences
Related Links
- https://github.com/mkaply/cck2wizard
- https://github.com/sz-blacky/firefox-gpo
- https://github.com/n8felton/Firefox-ADMX
- http://www.amsys.co.uk/2015/09/using-firefox-cck2-and-autopkg/
- https://github.com/ElektraInitiative/libelektra/blob/master/src/plugins/mozprefs/autoconfig/README.md
- https://support.securly.com/hc/en-us/articles/215479918-Firefox-SSL-Management
- https://stackoverflow.com/questions/37553127/is-it-possible-to-automatically-import-certificates-in-firefox
User.js Overviews
- https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.1-Overview
- http://kb.mozillazine.org/User.js_file
User.js Examples
- https://github.com/ghacksuserjs/ghacks-user.js
- https://github.com/pyllyukko/user.js/
- https://github.com/atomGit/Firefox-user.js
1 The deprecation of XUL/XPCOM addons eliminates the primary external consumer of those APIs. There are plans to remove some of those APIs and rewrite others. That, combined with the relative obscurity of autoconfig and its more telemetry-resistant user base, may lead to some XPCOM utilizing autoconfig files being broken. Those using, or wanting to use, autoconfig should keep this in mind. If there is something you are using, or believe is important to keep, you should get involved on the bugzilla and developer fronts.↩