Merge pull request #36 from mozilla/1429177_Proxy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index aaeb9cda5b19b2e0f44d344d6a3a482dcba24e16..d744abf695041d64d8cd8aedbf1ba26e3cd28004 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@ The content of the JSON file should look like this:
 {
   "policies": {
     ...POLICIES...
+  }
 }
 ```
 Policies are documented below.
@@ -14,6 +15,7 @@ This policy removes access to about:addons.
 {
   "policies": {
     "BlockAboutAddons": true
+  }
 }
 ```
 ### BlockAboutConfig
@@ -22,6 +24,16 @@ This policy removes access to about:config.
 {
   "policies": {
     "BlockAboutConfig": true
+  }
+}
+```
+### BlockAboutProfiles
+This policy removes access to about:profiles.
+```
+{
+  "policies": {
+    "BlockAboutProfiles": true
+  }
 }
 ```
 ### BlockAboutSupport
@@ -59,12 +71,12 @@ This policy turns off application updates.
   }
 }
 ```
-### DisableDeveloperTools
-This policy removes access to all developer tools.
+### DisableBuiltinPDFViewer
+This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 ```
 {
   "policies": {
-    "DisableDeveloperTools": true
+    "DisableBuiltinPDFViewer": true
   }
 }
 ```
@@ -77,6 +89,15 @@ This policy removes access to all developer tools.
   }
 }
 ```
+### DisableFeedbackCommands
+This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
+```
+{
+  "policies": {
+    "DisableFeedbackCommands": true
+  }
+}
+```
 ### DisableFirefoxScreenshots
 This policy removes access to Firefox Screenshots
 ```
@@ -131,6 +152,24 @@ This policy removes access to private browsing
   }
 }
 ```
+### DisableSafeMode
+This policy disables safe mode on Windows only
+```
+{
+  "policies": {
+    "DisableSafeMode": true
+  }
+}
+```
+### DisableSysAddonUpdate
+This policy prevents system add-ons from being updated or installed.
+```
+{
+  "policies": {
+    "DisableSysAddonUpdate": true
+  }
+}
+```
 ### DisplayBookmarksToolbar
 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 ```
@@ -158,6 +197,31 @@ This policy stops Firefox from checking if it is the default browser at startup.
   }
 }
 ```
+### EnableTrackingProtection
+This policy affects tracking protection.
+
+If this policy is not configured, tracking protection is not enabled by default in the browser but it is enabled by default in private browsing and the user can change it.
+
+If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
+
+If Value is set to true, private browsing is enabled by default in both the browser and private browsing and you can choose set the Locked value if you want to prevent the user from changing it.
+```
+{
+  "policies": {
+    "EnableTrackingProtection": {
+      "Value": [true, false],
+      "Locked": [true, false]
+    }
+```
+### NoDefaultBookmarks
+Don't create the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags). Note: this policy is only effective if used before the first run of the profile.
+```
+{
+  "policies": {
+    "NoDefaultBookmarks": true
+  }
+}
+```
 ### RememberPasswords
 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 ```
@@ -241,10 +305,31 @@ same folder name are grouped together.
     {"Title": "Example",
      "URL": "http://example.org",
      "Favicon": "http://example.com/favicon.ico",
-     "Placement": "toolbar",
-     "Folder": "Bookmarks"
+     "Placement": ["toolbar", "menu"],
+     "Folder": "FolderName"
      }
     ]
   }
 }
 ```
+### Proxy
+This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
+To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user.
+```
+{
+  "Proxy": {
+    "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
+    "Locked": [true, false]
+    "HTTPProxy": "hostname",
+    "UseHTTPProxyForAllProtocols": [true, false]
+    "SSLProxy": "hostname",
+    "FTPProxy": "hostname",
+    "SOCKSProxy": "hostname",
+    "SOCKSVersion": [4, 5],
+    "Passthrough": "List of passthrough addresses/domains",
+    "AutoConfigURL": "URL_TO_AUTOCONFIG",
+    "AutoLogin":  [true, false],
+    "UseProxyForDNS": [true, false]
+  }
+}
+```