thunderbird / thunderbird/enterprise-docs

Add section to explain managed storage and how Enterprise IT can preconfigure add-ons deployed in their infrastructure

Open
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
4
Forks
4
Avg merge
12h 6m
Merged PRs (30d)
2

Description

Legacy add-ons had their preferences stored in a Thunderbird preference branch and IT admins could use Enterprise policies to preset extension.* values to override/pre-configure add-on settings.

WebExtensions have no access to Thunderbird's preference branches. They can instead use the managed storage. Using Enterprise policies to override/pre-configure add-on preferences did not require the add-on itself to "know" about this. This is different for the managed storage: The add-on needs to support it as it is the add-on who needs to check if there is a value in the managed storage. To get the colour value of the managed storage, it has to do this:

let managed_colour = await messenger.storage.managed.get("colour");

So if add-ons are used in Enterprise environments and IT admins need the feature to preset some settings, they first need to get in touch with the developer.

Once the add-on supports the managed storage, IT admins can deploy configuration files as described here:

There is an example add-on, which can be used to test this concept:

  1. Follow the instructions given to deploy the storage file. On Windows, one has to create a registry key for the example add-on, which points to a json file:

image

And that file should look like so:

{
  "name":  "favourite-colour-examples@mozilla.org",
  "description": "ignored",
  "type": "storage",
  "data": {
    "colour": "management thinks it should be blue!"
  }
}
  1. Clone the entire example repository, or download it as a zip file.
  2. Open Thunderbird and click on the hamburger menu and select Tools -> Developer Tools ->Debug Add-on
  3. Click on the Load Temporary Add-on ... button and select the manifest.json file in the favourite-colour folder of the downloaded and extracted zip file / cloned repository
  4. Go back to the inbox tab (the tab which has your folders and emails) and click on the Favorite color options button in the toolbar, or go to the add-on manager and manually open the add-ons options. You should see this:

image

It depends on the add-on how the information from the managed storage is used. In this case it is just presented as an information, but it could also lock the config field and enforce the value from the management.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the managed storage and manifest-location documentation linked in the issue, then inspect the favourite-colour example add-on and its deployment steps. Add a section explaining that add-ons must read managed storage and that Enterprise IT can deploy configuration files, including the Windows example; done means administrators can follow the links and understand the developer prerequisite.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.