install.md

Installing the Lockbox extension

Installing dependencies

To install the project dependencies, you can run:

npm install

Building the source code

To build the project, you can run:

npm run build

This puts all the necessary files in the dist/ directory, which you can then temporarily load into Firefox (e.g. about:debugging).

Building the extension

To build an extension .xpi, you can run:

npm run package

⚠️ The resulting add-on is unsigned and likely won't work on release versions of Firefox. You can flip the xpinstall.signatures.required preference on other channels accordingly.

⚠️ In preparation for Firefox 57, legacy extensions are also disabled. So you'll need to flip the extensions.legacy.enabled preference, too.

Running the extension

To run the extension in a Firefox Nightly browser, you can run:

npm run run -- -b nightly

This will automatically create a fresh new user profile that will not persist between runs. This means the data will be lost every time.

Running the extension with a persistent profile

To run the extension with a profile that persists between runs, you can create a new profile by browsing to about:profiles.

Once you have a new profile created (no matter the location), you can tell jpm (via npm) to run using that profile and not to copy the profile temporarily so that any changes (e.g. adding new entries) will be saved:

npm run run -- -p PROFILE --no-copy

The PROFILE value may be a profile name or the path to the profile.

Now, when you run using this profile, any data or settings you make to the browser itself or in Lockbox will be available for future runs.

Setting npm run flags

To specify flags for run to use regularly, use npm config set jpm_runflags:

npm config set jpm_runflags="-b nightly -p PROFILE --no-copy"

This way if you want to always test locally using an existing profile (with example data) using Firefox Nightly, you can just run (without adding flags):

npm run run