Fix some bolding

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index f64f9874f528da2acf1227464eb8f29f89506e56..263ae5803a355b0fbbb517d2dfa4403c920d7852 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,7 @@
+**These policies are in active development and so might contain changes that do not work with current versions of Firefox.**
+
+**You should use the officially released versions (https://github.com/mozilla/policy-templates/releases) if you are deploying changes.**
+

 Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution.
 
 | Policy Name | Description
 Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution.
 
 | Policy Name | Description


@@ -74,9 +78,9 @@ Policies can be specified using the Group Policy templates on Windows (https://g
 | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions.
 | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS.
 | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS.
 | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions.
 | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS.
 | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS.

+| **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information.

 | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited.
 
 | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited.
 

-

 ### AppUpdateURL
 
 Change the URL for application update.
 ### AppUpdateURL
 
 Change the URL for application update.


@@ -96,7 +100,7 @@ Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com"
   <string>https://yoursite.com</string>
 </dict>
 ```
   <string>https://yoursite.com</string>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -155,7 +159,7 @@ Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -315,7 +319,7 @@ Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName"
   </array>
 </dict>
 ```
   </array>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -1102,14 +1106,14 @@ Configure DNS over HTTPS.
 
 #### Windows
 ```
 
 #### Windows
 ```

-Software\Policies\Mozilla\Firefox\Cookies\Enabled = 0x1 | 0x0
-Software\Policies\Mozilla\Firefox\Cookies\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
-Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0
+Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Enabled = 0x1 | 0x0
+Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
+Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0

 ```
 #### macOS
 ```
 <dict>
 ```
 #### macOS
 ```
 <dict>

-  <key>Cookies</key>
+  <key>DNSOverHTTPS</key>

   <dict>
     <key>Enabled</key>
     <true/> | <false/>
   <dict>
     <key>Enabled</key>
     <true/> | <false/>


@@ -1178,13 +1182,20 @@ Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads"
   <string>${home}/Downloads</string>
 </dict>
 ```
   <string>${home}/Downloads</string>
 </dict>
 ```

-#### JSON
+#### JSON (macOS and Linux)

 ```
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}/Downloads"
 }
 ```
 ```
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}/Downloads"
 }
 ```

+#### JSON (Windows)
+```
+{
+  "policies": {
+    "DefaultDownloadDirectory": "${home}\\Downloads"
+}
+```

 ### DownloadDirectory
 Set and lock the download directory.
 
 ### DownloadDirectory
 Set and lock the download directory.
 


@@ -1205,13 +1216,20 @@ Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads"
   <string>${home}/Downloads</string>
 </dict>
 ```
   <string>${home}/Downloads</string>
 </dict>
 ```

-#### JSON
+#### JSON (macOS and Linux)

 ```
 {
   "policies": {
     "DownloadDirectory": "${home}/Downloads"
 }
 ```
 ```
 {
   "policies": {
     "DownloadDirectory": "${home}/Downloads"
 }
 ```

+#### JSON (Windows)
+```
+{
+  "policies": {
+    "DownloadDirectory": "${home}\\Downloads"
+}
+```

 ### EnableTrackingProtection
 Configure tracking protection.
 
 ### EnableTrackingProtection
 Configure tracking protection.
 


@@ -1325,7 +1343,7 @@ Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org"
 ### ExtensionSettings
 Manage all aspects of extensions. This policy is based heavily on the [Chrome policy](https://dev.chromium.org/administrators/policy-list-3/extension-settings-full) of the same name.
 
 ### ExtensionSettings
 Manage all aspects of extensions. This policy is based heavily on the [Chrome policy](https://dev.chromium.org/administrators/policy-list-3/extension-settings-full) of the same name.
 

-This policy maps an extension ID to its configuration. With an extension ID, configuration will be applied to the specified extension only. A default configuration can be set for the special ID "*", which will apply to all extensions that don't have a custom configuration set in this policy.
+This policy maps an extension ID to its configuration. With an extension ID, the configuration will be applied to the specified extension only. A default configuration can be set for the special ID "*", which will apply to all extensions that don't have a custom configuration set in this policy.

 
 To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section.
 
 
 To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section.
 


@@ -1338,17 +1356,19 @@ The configuration for each extension is another dictionary that can contain the
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`blocked`| Blocks installation of the extension and removes it from the device if already installed.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`blocked`| Blocks installation of the extension and removes it from the device if already installed.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url.

-| `install_url`| Maps to a string indicating where Firefox can download a force_installed or normal_installed extension. If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi
+| `install_url`| Maps to a URL indicating where Firefox can download a force_installed or normal_installed extension. If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi. If installing frmo the local file system, use a file:/// URL.

 | `install_sources` | 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 from (i.e.  the referrer) must be allowed by these patterns. This setting can be used only for the default configuration.
 | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "langpack" This setting can be used only for the default configuration.
 | `blocked_install_message` | This 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 the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else.
 
 | `install_sources` | 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 from (i.e.  the referrer) must be allowed by these patterns. This setting can be used only for the default configuration.
 | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "langpack" This setting can be used only for the default configuration.
 | `blocked_install_message` | This 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 the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else.
 

-**Compatibility:** Firefox 68, Firefox ESR 68\
+**Compatibility:** Firefox 69, Firefox ESR 68.1\

 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 
 #### Windows
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 
 #### Windows

-Due to a bug in Firefox 68, this policy is not working via GPO on Windows. We will have a fix soon.
+```
+Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}'
+```

 #### macOS
 ```
 <dict>
 #### macOS
 ```
 <dict>


@@ -1393,7 +1413,6 @@ Due to a bug in Firefox 68, this policy is not working via GPO on Windows. We wi
   }
 }
 ```
   }
 }
 ```

-

 ### ExtensionUpdate
 Control extension updates.
 
 ### ExtensionUpdate
 Control extension updates.
 


@@ -2137,7 +2156,7 @@ To specify ports, append them to the hostnames with a colon (:).
 
 `UseProxyForDNS` to use proxy DNS when using SOCKS v5.
 
 
 `UseProxyForDNS` to use proxy DNS when using SOCKS v5.
 

-**Compatibility:** Firefoox 60, Firefox ESR 60\
+**Compatibility:** Firefox 60, Firefox ESR 60\

 **CCK2 Equivalent:** `networkProxy*`\
 **Preferences Affected:** `network.proxy.type`,`network.proxy.autoconfig_url`,`network.proxy.socks_remote_dns`,`signon.autologin.proxy`,`network.proxy.socks_version`,`network.proxy.no_proxies_on`,`network.proxy.share_proxy_settings`,`network.proxy.http`,`network.proxy.http_port`,`network.proxy.ftp`,`network.proxy.ftp_port`,`network.proxy.ssl`,`network.proxy.ssl_port`,`network.proxy.socks`,`network.proxy.socks_port`
 
 **CCK2 Equivalent:** `networkProxy*`\
 **Preferences Affected:** `network.proxy.type`,`network.proxy.autoconfig_url`,`network.proxy.socks_remote_dns`,`signon.autologin.proxy`,`network.proxy.socks_version`,`network.proxy.no_proxies_on`,`network.proxy.share_proxy_settings`,`network.proxy.http`,`network.proxy.http_port`,`network.proxy.ftp`,`network.proxy.ftp_port`,`network.proxy.ssl`,`network.proxy.ssl_port`,`network.proxy.socks`,`network.proxy.socks_port`
 


@@ -2188,7 +2207,7 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2385,7 +2404,7 @@ Set the default search engine. This policy is only available on the ESR.
 **CCK2 Equivalent:** `defaultSearchEngine`\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `defaultSearchEngine`\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
 ```


@@ -2399,7 +2418,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2417,7 +2436,7 @@ Prevent installing search engines from webpages.
 **CCK2 Equivalent:** `disableSearchEngineInstall`\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `disableSearchEngineInstall`\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
 ```


@@ -2431,7 +2450,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2449,7 +2468,7 @@ Hide built-in search engines. This policy is only available on the ESR.
 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
 ```


@@ -2465,7 +2484,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2500,6 +2519,7 @@ Add new search engines (up to five). This policy is only available on the ESR. `
 **Preferences Affected:** N/A
 
 #### Windows
 **Preferences Affected:** N/A
 
 #### Windows

+```

 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"


@@ -2508,6 +2528,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"

+```

 
 #### macOS
 ```
 
 #### macOS
 ```


@@ -2538,7 +2559,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2567,7 +2588,7 @@ Enable search suggestions.
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
 
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
 ```


@@ -2578,7 +2599,7 @@ Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
   <true/> | <false/>
 </dict>
 ```
   <true/> | <false/>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2675,6 +2696,45 @@ Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" |
   }
 }
 ```
   }
 }
 ```

+### SupportMenu
+Add a menuitem to the help menu for specifying support information.
+
+**Compatibility:** Firefox 68.0.1, Firefox ESR 68.0.1\
+**CCK2 Equivalent:** helpMenu\
+**Preferences Affected:** N/A
+
+#### Windows
+```
+Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu"
+Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support"
+Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S"
+```
+#### macOS
+```
+<dict>
+  <key>SupportMenu</key>
+  <dict>
+    <key>Title</key>
+    <string>SupportMenu</string>
+    <key>URL</key>
+    <string>http://example.com/support</string>
+    <key>AccessKey</key>
+    <string>S</string>
+  </dict>
+</dict>
+```
+#### JSON
+```
+{
+  "policies": {
+    "SupportMenu": {
+      "Title": "Support Menu",
+      "URL": "http://example.com/support",
+      "AccessKey": "S"
+    }
+  }
+}
+```

 ### WebsiteFilter
 Block websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.
 
 ### WebsiteFilter
 Block websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.
 


@@ -2704,7 +2764,7 @@ Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.
 
 </dict>
 ```
 
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {