Add documentation for one line JSON

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

diff --git a/docs/index.md b/docs/index.md
index 2ac1142005c2208022980baedb4dc00b3325c494..1e8faf06f6ac616e2a2b3cdda0770c404ff5403e 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,7 +1,6 @@
 Firefox policies can be specified using the [Group Policy templates on Windows](https://github.com/mozilla/policy-templates/tree/master/windows), [Intune on Windows](https://support.mozilla.org/kb/managing-firefox-intune), [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 or you can specify system-wide policy by placing the file in `/etc/firefox/policies`.
 
 Unfortunately, JSON files do not support comments, but you can add extra entries to the JSON to use as comments. You will see an error in about:policies, but the policies will still work properly. For example:
 Firefox policies can be specified using the [Group Policy templates on Windows](https://github.com/mozilla/policy-templates/tree/master/windows), [Intune on Windows](https://support.mozilla.org/kb/managing-firefox-intune), [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 or you can specify system-wide policy by placing the file in `/etc/firefox/policies`.
 
 Unfortunately, JSON files do not support comments, but you can add extra entries to the JSON to use as comments. You will see an error in about:policies, but the policies will still work properly. For example:

-

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


@@ -12,6 +11,7 @@ Unfortunately, JSON files do not support comments, but you can add extra entries
   }
 }
 ```
   }
 }
 ```

+Note: The `policies.json` must use the UTF-8 encoding.

 
 | Policy Name | Description
 | --- | --- |
 
 | Policy Name | Description
 | --- | --- |


@@ -668,6 +668,18 @@ Value (string):
   }
 ]'/>
 ```
   }
 ]'/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/AutoLaunchProtocolsFromOriginsOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='[]'/>
+```

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


@@ -934,6 +946,18 @@ Value (string):
 <enabled/>
 <data id="JSON" value='[]'/>
 ```
 <enabled/>
 <data id="JSON" value='[]'/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/BookmarksOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='[]'/>
+```

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


@@ -1167,6 +1191,18 @@ Value (string):
 }
 '/>
 ```
 }
 '/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/ContainersOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='{}'/>
+```

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


@@ -2752,6 +2788,18 @@ Value (string):
 ]
 '/>
 ```
 ]
 '/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/ExemptDomainFileTypePairsFromFileTypeDownloadWarningsOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='[]'/>
+```

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


@@ -2939,6 +2987,18 @@ Value (string):
   }
 }'/>
 ```
   }
 }'/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/ExtensionSettingsOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='{}'/>
+```

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


@@ -3322,6 +3382,18 @@ Value (string):
 }
 '/>
 ```
 }
 '/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/HandlersOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='{}'/>
+```

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


@@ -3613,7 +3685,7 @@ Value (string):
 ```
 <dict>
   <key>HttpsOnlyMode</key>
 ```
 <dict>
   <key>HttpsOnlyMode</key>

-  <string>allowed | disallowed | enabled| force_enabled</string>
+  <string>allowed | disallowed | enabled | force_enabled</string>

 </dict>
 ```
 #### policies.json
 </dict>
 ```
 #### policies.json


@@ -3926,6 +3998,18 @@ Value (string):
   }
 ]'/>
 ```
   }
 ]'/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/ManagedBoomarksOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='[]'/>
+```

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


@@ -5002,6 +5086,18 @@ Value (string):
   }
 }'/>
 ```
   }
 }'/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/PreferencesOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='{}'/>
+```

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


@@ -6414,6 +6510,18 @@ Value (string):
 <enabled/>
 <data id="WebsiteFilter" value="1&#xF000;http://example.org/*"/>
 ```
 <enabled/>
 <data id="WebsiteFilter" value="1&#xF000;http://example.org/*"/>
 ```

+If you are using custom ADMX and ADML administrative templates in Intune, you can use this OMA-URI instead
+to workaround the limit on the length of strings. Put all of your JSON on one line.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Extensions/WebsiteFilterOneLine
+```
+Value (string):
+```
+<enabled/>
+<data id="JSONOneLine" value='{"Block": ["<all_urls>"],"Exceptions": ["http://example.org/*"]}'/>
+```

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