search

jobisoft / quicktext

An extension for Thunderbird that lets you create templates that can be easily inserted into your own emails.
Mozilla Public License 2.0
184 stars 52 forks source link

Document managed storage override for defaultImport and templateFolder #369

Open jobisoft opened 1 year ago

jobisoft commented 1 year ago

@SamuelPlentz

In the next version (probably v6.0) I will move towards a more webExtension-ish approach (which means the settings dialog will be converted to HTML).

During this refactoring (see WebExt branch) I also stop using the LegacyPrefs API. Most options have been moved/migrated towards local storage already, but we still allow a manual override for defaultImport and templateFolder which is currently pulled from the legacy prefs tree (about:config). This will be replaced by managed local storage. Here is a quick overview: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/managed

So system admins no longer have to set these prefs, but have to save the data in a json file. 

{
  "name": "{8845E3B3-E8FB-40E2-95E9-EC40294818C4}",
  "description": "Managed storage for Quicktext Thunderbird Add-on",
  "type": "storage",
  "data": {
    "defaultImport ": "<path>",
    "templateFolder": "<path>",
  }
}

System admins used different means to manipulate the prefs to provision the config to their clients and they can use similar means to provision the json file to all their clients. This document covers where that json file is located: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#manifest_location

Would you have time to update our documentation?

SamuelPlentz commented 11 months ago

I think it is better to postpone this. If the webex version is good to go, we should change it.