This documentation is no longer maintained. Please see the maintained documentation of mozprofile at https://mozbase.readthedocs.org/en/latest/mozprofile.html.
Mozprofile is a python tool for creating and managing profiles for Mozilla's applications (Firefox, Thunderbird, etc.). In addition to creating profiles, mozprofile can install addons and set preferences.
Mozprofile can be utilized from the command line or as an API.
Command Line Usage
mozprofile may be used to create profiles, set preferences in profiles, or install addons into profiles.
The profile to be operated on may be specified with the --profile
switch. If a profile is not specified, one will be created in a temporary directory which will be echoed to the terminal:
(mozmill)> mozprofile
/tmp/tmp4q1iEU.mozrunner
(mozmill)> ls /tmp/tmp4q1iEU.mozrunner
user.js
To run mozprofile from the command line enter: mozprofile --help
for a list of options.
API Usage
To use mozprofile as an API you can import mozprofile.profile and/or the AddonManager.
mozprofile.profile
features a generic Profile
class. In addition, subclasses FirefoxProfile
and ThundebirdProfile
are available with preset preferences for those applications.
Installing Addons
Addons may be installed individually or from a manifest.
Example:
from mozprofile import FirefoxProfile
# create new profile to pass to mozmill/mozrunner
profile = FirefoxProfile(addons=["adblock.xpi"])
Setting Preferences
Preferences can be set in several ways:
- using the API: You can pass preferences in to the Profile class's constructor:
obj = FirefoxProfile(preferences=[("accessibility.typeaheadfind.flashBar", 0)])
- using a JSON blob file:
mozprofile --preferences myprefs.json
- using a
.ini
file:mozprofile --preferences myprefs.ini
- via the command line:
mozprofile --pref key:value --pref key:value [...]
When setting preferences from an .ini
file or the --pref
switch, the value will be interpolated as an integer or a boolean (true
/false
) if possible.
Setting Permissions
mozprofile also takes care of adding permissions to the profile. See https://github.com/mozilla/mozbase/b...permissions.py
Resources
Other Mozilla programs offer additional and overlapping functionality for profiles. There is also substantive documentation on profiles and their management.
- ProfileManager : XULRunner application for managing profiles. Has a GUI and CLI.
- python-profilemanager : python CLI interface similar to ProfileManager
- profile documentation : https://support.mozilla.com/en-US/kb/Profiles