X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/6149e94c95aa9668659cff243e41946eed1655fa..22c4ad80963eeceb6dcacf45a04c42c29985569e:/README.md?ds=sidebyside
diff --git a/README.md b/README.md
index 7b76f0d..263ae58 100644
--- 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
@@ -42,6 +46,7 @@ Policies can be specified using the Group Policy templates on Windows (https://g
| **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection.
| **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS.
| **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions.
+| **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects of extensions.
| **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates.
| **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed.
| **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page.
@@ -95,7 +100,7 @@ Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com"
https://yoursite.com
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -154,7 +159,7 @@ Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -314,7 +319,7 @@ Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName"
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -1361,8 +1366,9 @@ The configuration for each extension is another dictionary that can contain the
**Preferences Affected:** N/A
#### Windows
-
-Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}`
+```
+Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}'
+```
#### macOS
```
@@ -2201,7 +2207,7 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2398,7 +2404,7 @@ Set the default search engine. This policy is only available on the ESR.
**CCK2 Equivalent:** `defaultSearchEngine`\
**Preferences Affected:** N/A
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
```
@@ -2412,7 +2418,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2430,7 +2436,7 @@ Prevent installing search engines from webpages.
**CCK2 Equivalent:** `disableSearchEngineInstall`\
**Preferences Affected:** N/A
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
```
@@ -2444,7 +2450,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2462,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
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
```
@@ -2478,7 +2484,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2513,6 +2519,7 @@ Add new search engines (up to five). This policy is only available on the ESR. `
**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"
@@ -2521,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}"
+```
#### macOS
```
@@ -2551,7 +2559,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2580,7 +2588,7 @@ Enable search suggestions.
**CCK2 Equivalent:** N/A\
**Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
```
@@ -2591,7 +2599,7 @@ Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
|
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2715,7 +2723,7 @@ Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S"
```
-### JSON
+#### JSON
```
{
"policies": {
@@ -2756,7 +2764,7 @@ Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.
```
-### JSON
+#### JSON
```
{
"policies": {