Add samples for new policies to mac and linux

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

diff --git a/docs/index.md b/docs/index.md
index 1537dba33ff98f91c703f6e43c02951a81f9115e..e5dfe9a3f1bc1bda5d5035995f4ce2a54ea85fbc 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Documentation for policy behavior and syntax is being migrated to the [Firefox administrator reference](https://firefox-admin-docs.mozilla.org/).
+

 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:


@@ -1839,7 +1842,7 @@ Value (string):
       "IsPerUser": true | false,
       "PipePathName": "pipe_custom_name",
       "ShowBlockedResult": true | false,
       "IsPerUser": true | false,
       "PipePathName": "pipe_custom_name",
       "ShowBlockedResult": true | false,

-      "TimeoutResult": 0 | 1 | 2,
+      "TimeoutResult": 0 | 1 | 2

     }
   }
 }
     }
   }
 }


@@ -1980,7 +1983,7 @@ Value (string):
       "Block": ["http://example.edu/"],
       "Locked": true | false,
       "Behavior": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign",
       "Block": ["http://example.edu/"],
       "Locked": true | false,
       "Behavior": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign",

-      "BehaviorPrivateBrowsing": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign",
+      "BehaviorPrivateBrowsing": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign"

     }
   }
 }
     }
   }
 }


@@ -2171,7 +2174,7 @@ Value (string):
 {
   "policies": {
     "DisabledCiphers": {
 {
   "policies": {
     "DisabledCiphers": {

-      "CIPHER_NAME": true | false,
+      "CIPHER_NAME": true | false

     }
   }
 }
     }
   }
 }


@@ -3152,7 +3155,7 @@ Value (string):
       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
       "Locked": true | false,
       "ExcludedDomains": ["example.com"],
       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
       "Locked": true | false,
       "ExcludedDomains": ["example.com"],

-      "Fallback": true | false,
+      "Fallback": true | false

     }
   }
 }
     }
   }
 }


@@ -3257,7 +3260,7 @@ If `SuspectedFingerprinting` is set to true, Firefox reduces the amount of infor
 
 `Exceptions` are origins for which tracking protection is not enabled.
 
 
 `Exceptions` are origins for which tracking protection is not enabled.
 

-`Category` can be either ```strict``` or ```standard```. If category is set, it overrides all other settings except `Exceptions` and the user cannot change the category. (Firefox 142, Firefox ESR 140.2)
+`Category` can be either ```strict``` or ```standard```. If category is set, it overrides all other settings except `Exceptions`, `BaselineExceptions` and `ConvenienceExceptions`, and the user cannot change the category. (Firefox 142, Firefox ESR 140.2)

 
 IF `BaselineExceptions` is true, Firefox will automatically apply exceptions required to avoid major website breakage. (Firefox 145)
 
 
 IF `BaselineExceptions` is true, Firefox will automatically apply exceptions required to avoid major website breakage. (Firefox 145)