Update README-new.md

[policy-templates.git] / README-new.md

diff --git a/README-new.md b/README-new.md
index 9a84512914344bad0f88df6c2e2ec95014c89558..b49ef8b89268bba0b25982010dfe24eb5f667ef0 100644 (file)
--- a/README-new.md
+++ b/README-new.md
@@ -98,10 +98,8 @@ same folder name are grouped together.
 ### CaptivePortal
 A Boolean value that enables or disables captive portal support by setting and locking the preference `network.captive-portal-service.enabled`.
 
-**Compatibility:** Firefox 67, Firefox ESR 60.7
-
-**CCK2 Equivalent:** N/A
-
+**Compatibility:** Firefox 67, Firefox ESR 60.7\
+**CCK2 Equivalent:** N/A\
 **Preferences Affected:** `network.captive-portal-service.enabled`
 
 #### Windows
@@ -121,7 +119,7 @@ A Boolean value that enables or disables captive portal support by setting and l
 ```
 {
   "policies": {
-         "CaptivePortal": true | false
+    "CaptivePortal": true | false
   }
 }
 ```
@@ -646,6 +644,79 @@ This policy blocks websites from being visited. The parameters take an array of
 ### Search Engines (This policy is only available on the ESR.)
 This policy allows you to add new search engines, remove or hide search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 ```
+{
+  "policies": {
+    "SearchEngines": {
+      "Default": "Name of engine",
+      "PreventInstalls": [true|false],
+      "Remove": ["Twitter", "Wikipedia (en)"]
+    }
+  }
+}
+```
+### Search Engines
+
+### Search Engines | Add
+
+This policy allows you to add up to five new search engines. This policy is only available on the ESR.
+
+**Compatibility:** Firefox ESR 60\
+**CCK2 Equivalent:** `config.searchplugins`\
+**Preferences Affected:** N/A
+
+### Keys
+
+| Key | Type | Default | Description |
+| --- | ---- | ------- | ----------- |
+| `Name` | String | _required_ | The name of the search engine. |
+| `URLTemplate` | String | _required_ | Search URL with {searchTerms} to substitute for the search term. |
+| `Method` | String | GET | GET or POST |
+| `IconURL` | String | — | URL for the icon to use. |
+| `Alias` | String | — | Keyword to use for the engine. |
+| `Description` | String | —| Description of the search engine. |
+| `SuggestURLTemplate` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. |
+
+#### Windows
+| Type | Registry Location |
+| ---- | ----------------- |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description` |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate` |
+
+#### macOS
+```
+<dict>
+  <key>Search</key>
+  <dict>
+    <key>Add</key>
+    <array>
+      <dict>
+        <key>Name</key>
+        <string>Example1</string>
+        <key>URLTemplate</key>
+        <string>https://www.example.org</string>
+        <key>Method</key>
+        <string>https://www.example.org/favicon.ico</string>
+        <key>IconURL</key>
+        <string>toolbar</string>
+        <key>Alias</key>
+        <string>Example1Folder</string>
+        <key>Description</key>
+        <string>Example1Folder</string>
+        <key>Alias</key>
+        <string>SuggestURLTemplate</string>
+      </dict>
+    <array>
+  </dict>
+</dict>
+```
+
+### JSON
+```
 {
   "policies": {
     "SearchEngines": {
@@ -659,16 +730,39 @@ This policy allows you to add new search engines, remove or hide search engines,
           "Description": "Description",
           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
         }
-      ],
-      "Default": "Name of engine",
-      "PreventInstalls": [true|false],
-      "Remove": ["Twitter", "Wikipedia (en)"]
+      ]
     }
   }
 }
 ```
+
+
+
+
 ### SecurityDevices
-This policy allows you to add PKCS #11 Modules
+A dictionary with the names and locations of PKCS #11 modules to be installed.
+
+**Compatibility:** Firefox 64, Firefox ESR 60.4\
+**CCK2 Equivalent:** `certs.devices`\
+**Preferences Affected:** N/A
+
+#### Windows
+| Type | Registry Location | Registry Value |
+| ---- | ----------------- | -------------- |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE` | `PATH_TO_LIBRARY_FOR_DEVICE`
+
+#### macOS
+```
+<dict>
+  <key>SecurityDevices</key>
+  <dict>
+    <key>NAME_OF_DEVICE</key>
+    <string>PATH_TO_LIBRARY_FOR_DEVICE</string>
+  </dict>
+</dict>
+```
+
+#### JSON
 ```
 {
   "policies": {
@@ -678,22 +772,59 @@ This policy allows you to add PKCS #11 Modules
   }
 }
 ```
-### SSLVersionMin
-This policy allows you to set the minimum TLS version.
+### SSLVersionMax
+A String value that sets and locks the maximum version of TLS
+
+**Compatibility:** Firefox 66, Firefox ESR 60.6\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** `security.tls.version.max`
+
+#### Windows
+| Type | Registry Location |
+| ---- | ----------------- |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SSLVersionMax` |
+
+#### macOS
+```
+<dict>
+  <key>SSLVersionMax</key>
+  <string>tls1 | tls1.1 | tls1.2 | tls1.3<string>
+</dict>
+```
+
+#### JSON
 ```
 {
   "policies": {
-    "SSSLVersionMin": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
+    "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
   }
 }
+```
+### SSLVersionMin
+A String value that sets and locks the minimum version of TLS
+
+**Compatibility:** Firefox 66, Firefox ESR 60.6\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** `security.tls.version.min`
 
+#### Windows
+| Type | Registry Location |
+| ---- | ----------------- |
+| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SSLVersionMin` |
+
+#### macOS
 ```
-### SSLVersionMax
-This policy allows you to set the maximum TLS version.
+<dict>
+  <key>SSLVersionMin</key>
+  <string>tls1 | tls1.1 | tls1.2 | tls1.3<string>
+</dict>
+```
+
+#### JSON
 ```
 {
   "policies": {
-    "SSSLVersionMax": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
+    "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
   }
 }
 ```