Add "sitepermission" to allowed_types

[policy-templates.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index df52a3505735f86712a7e9ca4fc4eef196d0040b..49f051df9e256d5470265f844aafba5a3b1fba77 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -3402,7 +3402,7 @@ The configuration for each extension is another dictionary that can contain the
 |         `normal_installed` | Automatically installs the extension but allows it to be disabled by the user. This option is not valid for the default configuration and requires an `install_url`. |
 |`install_url` | The URL from which Firefox can download a `force_installed` or `normal_installed` extension. Firefox automatically installs, updates, or re-installs the extension when the XPI file’s internal [`version`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/version) changes.<ul><li>If installing from `addons.mozilla.org`, use `https://addons.mozilla.org/firefox/downloads/latest/ADDON_ID/latest.xpi` and substitute **ADDON_ID** with the extension’s ID (for example, `uBlock0@raymondhill.net` or `{446900e4-71c2-419f-a6a7-df9c091e268b}`). Using the AMO ID ensures Firefox always downloads the latest version that matches the user’s platform.</li><li>If installing from the local file system, use a [`file:///` URL](https://en.wikipedia.org/wiki/File_URI_scheme). Firefox will update or re-install the extension whenever the XPI file at that path changes. You can also manually trigger an update by changing the file name or path.</li><li>Language packs are available from `https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi` (for example, `https://releases.mozilla.org/pub/firefox/releases/111.0.1/win64/xpi/en-US.xpi`). These URLs can be used as `install_url` values for managing language pack installation.</li></ul>
 | `install_sources` | A list of sources from which installing extensions is allowed using URL match patterns. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the `.xpi` file and the page where the download is started (the referrer) must be allowed by these patterns. This setting can be used only for the default configuration. |
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed` | Automatically installs the extension but allows it to be disabled by the user. This option is not valid for the default configuration and requires an `install_url`. |
 |`install_url` | The URL from which Firefox can download a `force_installed` or `normal_installed` extension. Firefox automatically installs, updates, or re-installs the extension when the XPI file’s internal [`version`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/version) changes.<ul><li>If installing from `addons.mozilla.org`, use `https://addons.mozilla.org/firefox/downloads/latest/ADDON_ID/latest.xpi` and substitute **ADDON_ID** with the extension’s ID (for example, `uBlock0@raymondhill.net` or `{446900e4-71c2-419f-a6a7-df9c091e268b}`). Using the AMO ID ensures Firefox always downloads the latest version that matches the user’s platform.</li><li>If installing from the local file system, use a [`file:///` URL](https://en.wikipedia.org/wiki/File_URI_scheme). Firefox will update or re-install the extension whenever the XPI file at that path changes. You can also manually trigger an update by changing the file name or path.</li><li>Language packs are available from `https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi` (for example, `https://releases.mozilla.org/pub/firefox/releases/111.0.1/win64/xpi/en-US.xpi`). These URLs can be used as `install_url` values for managing language pack installation.</li></ul>
 | `install_sources` | A list of sources from which installing extensions is allowed using URL match patterns. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the `.xpi` file and the page where the download is started (the referrer) must be allowed by these patterns. This setting can be used only for the default configuration. |

-| `allowed_types` | Restricts which types of add-ons can be installed. Accepts a list of one or more of: `"extension"`, `"theme"`, `"dictionary"`, `"locale"`. <br><br>**Note:** This setting only applies when installation is otherwise allowed. If `"installation_mode": "blocked"` is set (either for a specific ID or for `"*"`), extensions remain blocked regardless of `allowed_types`. This setting can be used only for the default configuration. |
+| `allowed_types` | Restricts which types of add-ons can be installed. Accepts a list of one or more of: `"extension"`, `"theme"`, `"dictionary"`, `"locale"`, `"sitepermission"`. <br><br>**Note:** This setting only applies when installation is otherwise allowed. If `"installation_mode": "blocked"` is set (either for a specific ID or for `"*"`), extensions remain blocked regardless of `allowed_types`. This setting can be used only for the default configuration. |

 | `blocked_install_message` | Maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when an extension is blocked. This could be used to direct users to your help desk, explain why a particular extension is blocked, or something similar. This setting can be used only for the default configuration. |
 | `restricted_domains` | An array of domains on which content scripts can't be run. This setting can be used only for the default configuration. |
 | `updates_disabled` | (Firefox 89, Firefox ESR 78.11) Boolean that indicates whether or not to disable automatic updates for an individual extension. |
 | `blocked_install_message` | Maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when an extension is blocked. This could be used to direct users to your help desk, explain why a particular extension is blocked, or something similar. This setting can be used only for the default configuration. |
 | `restricted_domains` | An array of domains on which content scripts can't be run. This setting can be used only for the default configuration. |
 | `updates_disabled` | (Firefox 89, Firefox ESR 78.11) Boolean that indicates whether or not to disable automatic updates for an individual extension. |


@@ -3413,7 +3413,7 @@ The configuration for each extension is another dictionary that can contain the
 #### Interaction Notes
 - `"installation_mode": "blocked"` takes precedence over all other settings. When set, extensions cannot be installed regardless of `allowed_types` or `install_sources`. A configuration for a specific extension ID still overrides the `"*"` configuration.
 - To block all extensions except a few, use `"installation_mode": "blocked"` for `"*"` and explicitly override it for allowed or force-installed extensions.
 #### Interaction Notes
 - `"installation_mode": "blocked"` takes precedence over all other settings. When set, extensions cannot be installed regardless of `allowed_types` or `install_sources`. A configuration for a specific extension ID still overrides the `"*"` configuration.
 - To block all extensions except a few, use `"installation_mode": "blocked"` for `"*"` and explicitly override it for allowed or force-installed extensions.

-- To block extensions but allow themes, dictionaries, and language packs, leave the default (`"*"` ) `installation_mode` as `"allowed"` and set `"allowed_types": ["theme", "dictionary", "locale"]`. (`"locale"` corresponds to Firefox language packs.)
+- To block extensions but allow themes, dictionaries, language packs, and site permissions, leave the default (`"*"` ) `installation_mode` as `"allowed"` and set `"allowed_types": ["theme", "dictionary", "locale", "sitepermission"]`. (`"locale"` corresponds to Firefox language packs.)

   **Do not set `"installation_mode": "blocked"` in this scenario**, because `allowed_types` is ignored when installation is blocked.
 
 **Compatibility:** Firefox 69, Firefox ESR 68.1 (As of Firefox 85, Firefox ESR 78.7, installing a theme makes it the default.)\
   **Do not set `"installation_mode": "blocked"` in this scenario**, because `allowed_types` is ignored when installation is blocked.
 
 **Compatibility:** Firefox 69, Firefox ESR 68.1 (As of Firefox 85, Firefox ESR 78.7, installing a theme makes it the default.)\