]> git.p6c8.net - policy-templates.git/blobdiff - README-new.md
Cleanup search
[policy-templates.git] / README-new.md
index 92c79454ce553a78291abdf5d48540d0e907a795..47b5fb04ee20cb8379f8a3987b6ea85a96068eeb 100644 (file)
@@ -1,15 +1,7 @@
-**IMPORTANT**: This file is in active development along with the policies in Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
+**IMPORTANT**: This file is in active development along with the policies in Firefox. Make sure to check compatibility to see if a policy is available in a specific version of Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
 
 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.
 
-The content of the JSON file should look like this:
-```
-{
-  "policies": {
-    ...POLICIES...
-  }
-}
-```
 | Policy Name | Description |
 | --- | --- |
 | **[`AppUpdateURL`](#AppUpdateURL)** | Change the URL for application update. |
@@ -45,8 +37,8 @@ The content of the JSON file should look like this:
 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** |Prevent system add-ons from being installed or update.
 | **[`DisableTelemetry`](#disabletelemetry)** |DisableTelemetry
 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** |Set the initial state of the bookmarks toolbar.
-| **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** |Set the initial state of the menubar
-| **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser-1)** |Don't check if Firefox is the default browser at startup.
+| **[`DisplayMenuBar`](#displaymenubar)** |Set the initial state of the menubar
+| **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** |Don't check if Firefox is the default browser at startup.
 | **[`EnableTrackingProtection`](#enabletrackingprotection)** |Configure tracking protection.
 | **[`Extensions`](#extensions)** |Control the installation, uninstallation and locking of extensions.
 | **[`ExtensionUpdate`](#extensionupdate)** |Control extension updates.
@@ -66,7 +58,7 @@ The content of the JSON file should look like this:
 | **[`SanitizeOnShutdown`](#sanitizeonshutdown)** |Clear all data on shutdown.
 | **[`SearchBar`](#searchbar)** |Set whether or not search bar is displayed.
 | **[`WebsiteFilter`](#websitefilter)** |Block websites from being visited.
-| **[`SearchEngines`](#searchengines--this-policy-is-only-available-on-the-esr-)** |
+| **[`SearchEngines`](#searchengines-this-policy-is-only-available-on-the-esr)** |
 | **[`SearchEngines -> Default`](#searchengines--default)** |Set the default search engine. 
 | **[`SearchEngines -> PreventInstalls`](#searchengines--preventinstalls)** |Prevent installing search engines from webpages.
 | **[`SearchEngines -> Remove`](#searchengines--remove)** |Hide built-in search engines.
@@ -1104,12 +1096,12 @@ Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = 0x1 | 0x0
   }
 }
 ```
-### DontCheckDefaultBrowser
+### DisplayMenuBar
 Set the initial state of the menubar. A user can still hide it and it will stay hidden.
 
 **Compatibility:** Firefox 60, Firefox ESR 60 (Windows, some Linux)\
 **CCK2 Equivalent:** `displayMenuBar`\
-**Preferences Affected:** N/~
+**Preferences Affected:** N/A
 
 #### Windows
 ```
@@ -2068,7 +2060,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
 
 Hide built-in search engines. This policy is only available on the ESR.
 
-**Compatibility:** Firefox ESR 60\
+**Compatibility:** Firefox ESR 60.2\
 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
 **Preferences Affected:** N/A
 
@@ -2121,13 +2113,13 @@ Adddd 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 =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description =
-Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate =
+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\IconURL = "https://www.example.org/favicon.ico"
+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}"
 
 #### macOS
 ```
@@ -2140,17 +2132,17 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate =
         <key>Name</key>
         <string>Example1</string>
         <key>URLTemplate</key>
-        <string>https://www.example.org</string>
+        <string>https://www.example.org/q={searchTerms}</string>
         <key>Method</key>
-        <string>https://www.example.org/favicon.ico</string>
+        <string>GET | POST </string>
         <key>IconURL</key>
-        <string>toolbar</string>
+        <string>https://www.example.org/favicon.ico</string>
         <key>Alias</key>
-        <string>Example1Folder</string>
+        <string>example</string>
         <key>Description</key>
-        <string>Example1Folder</string>
-        <key>Alias</key>
-        <string>SuggestURLTemplate</string>
+        <string>Example Description</string>
+        <key>SuggestURLTemplate</key>
+        <string>https://www.example.org/suggestions/q={searchTerms}</string>
       </dict>
     <array>
   </dict>
@@ -2163,13 +2155,13 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate =
     "SearchEngines": {
       "Add": [
         {
-          "Name": "",
-          "URLTemplate": "URL including {searchTerms} to substitute for the terms",
-          "Method": ["GET", "POST"],
-          "IconURL": "URL to icon",
-          "Alias": "Alias that can be used to access the engine",
+          "Name": "Example1",
+          "URLTemplate": "https://www.example.org/q={searchTerms}",
+          "Method": "GET" | "POST",
+          "IconURL": "https://www.example.org/favicon.ico",
+          "Alias": "example",
           "Description": "Description",
-          "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
+          "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
         }
       ]
     }

patrick-canterino.de