README.md

   1 Policies can either be specified using the Group Policy templates 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/Content/Resources/distribution.
   2
   3 The content of the JSON file should look like this:
   4 ```
   5 {
   6   "policies": {
   7     ...POLICIES...
   8   }
   9 }
  10 ```
  11 Policies are documented below.
  12 ### Authentication
  13 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
  14 ```
  15 {
  16   "policies": {
  17     "Authentication": {
  18       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
  19       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
  20       "NTLM": ["mydomain.com", "https://myotherdomain.com"]
  21     }
  22   }
  23 }
  24 ```
  25 ### BlockAboutAddons
  26 This policy removes access to about:addons.
  27 ```
  28 {
  29   "policies": {
  30     "BlockAboutAddons": true
  31   }
  32 }
  33 ```
  34 ### BlockAboutConfig
  35 This policy removes access to about:config.
  36 ```
  37 {
  38   "policies": {
  39     "BlockAboutConfig": true
  40   }
  41 }
  42 ```
  43 ### BlockAboutProfiles
  44 This policy removes access to about:profiles.
  45 ```
  46 {
  47   "policies": {
  48     "BlockAboutProfiles": true
  49   }
  50 }
  51 ```
  52 ### BlockAboutSupport
  53 This policy removes access to about:support.
  54 ```
  55 {
  56   "policies": {
  57     "BlockAboutSupport": true
  58 }
  59 ```
  60 ### BlockSetDesktopBackground
  61 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
  62 ```
  63 {
  64   "policies": {
  65     "BlockAboutSupport": true
  66   }
  67 }
  68 ```
  69 ### Certificates
  70 This is a Windows only policy that tells Firefox to read certificates from the Windows certificate store.
  71 ```
  72 {
  73   "policies": {
  74     "Certificates": {
  75       "ImportEnterpriseRoots": [true|false]
  76     }
  77   }
  78 }
  79 ```
  80 ### CreateMasterPassword
  81 This policy removes the master password functionality.
  82 ```
  83 {
  84   "policies": {
  85     "CreateMasterPassword": false
  86   }
  87 }
  88 ```
  89 ### DisableAppUpdate
  90 This policy turns off application updates.
  91 ```
  92 {
  93   "policies": {
  94     "DisableAppUpdate": true
  95   }
  96 }
  97 ```
  98 ### DisableBuiltinPDFViewer
  99 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 100 ```
 101 {
 102   "policies": {
 103     "DisableBuiltinPDFViewer": true
 104   }
 105 }
 106 ```
 107 ### DisableDeveloperTools
 108 This policy removes access to all developer tools.
 109 ```
 110 {
 111   "policies": {
 112     "DisableDeveloperTools": true
 113   }
 114 }
 115 ```
 116 ### DisableFeedbackCommands
 117 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
 118 ```
 119 {
 120   "policies": {
 121     "DisableFeedbackCommands": true
 122   }
 123 }
 124 ```
 125 ### DisableFirefoxScreenshots
 126 This policy removes access to Firefox Screenshots
 127 ```
 128 {
 129   "policies": {
 130     "DisableFirefoxScreenshots": true
 131   }
 132 }
 133 ```
 134 ### DisableFirefoxAccounts
 135 This policy disables Sync
 136 ```
 137 {
 138   "policies": {
 139     "DisableFirefoxAccounts": true
 140   }
 141 }
 142 ```
 143 ### DisableFirefoxStudies
 144 This policy disables Firefox studies (Shield)
 145 ```
 146 {
 147   "policies": {
 148     "DisableFirefoxAccounts": true
 149   }
 150 }
 151 ```
 152 ### DisableFormHistory
 153 This policy turns off the browser.formfill.enable preferences
 154 ```
 155 {
 156   "policies": {
 157     "DisableFormHistory": true
 158   }
 159 }
 160 ```
 161 ### DisablePocket
 162 This policy turns off Pocket
 163 ```
 164 {
 165   "policies": {
 166     "DisablePocket": true
 167   }
 168 }
 169 ```
 170 ### DisablePrivateBrowsing
 171 This policy removes access to private browsing
 172 ```
 173 {
 174   "policies": {
 175     "DisablePrivateBrowsing": true
 176   }
 177 }
 178 ```
 179 ### DisableSafeMode
 180 This policy disables safe mode on Windows only
 181 ```
 182 {
 183   "policies": {
 184     "DisableSafeMode": true
 185   }
 186 }
 187 ```
 188 ### DisableSysAddonUpdate
 189 This policy prevents system add-ons from being updated or installed.
 190 ```
 191 {
 192   "policies": {
 193     "DisableSysAddonUpdate": true
 194   }
 195 }
 196 ```
 197 ### DisplayBookmarksToolbar
 198 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 199 ```
 200 {
 201   "policies": {
 202     "DisplayBookmarksToolbar": true
 203   }
 204 }
 205 ```
 206 ### DisplayMenuBar
 207 This policy turns on the menubar by default. A user can still turn it off and it will stay off.
 208 ```
 209 {
 210   "policies": {
 211     "DisplayMenuBar": true
 212   }
 213 }
 214 ```
 215 ### DontCheckDefaultBrowser
 216 This policy stops Firefox from checking if it is the default browser at startup.
 217 ```
 218 {
 219   "policies": {
 220     "DontCheckDefaultBrowser": true
 221   }
 222 }
 223 ```
 224 ### EnableTrackingProtection
 225 This policy affects tracking protection.
 226
 227 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.
 228
 229 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 230
 231 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.
 232 ```
 233 {
 234   "policies": {
 235     "EnableTrackingProtection": {
 236       "Value": [true, false],
 237       "Locked": [true, false]
 238     }
 239 ```
 240 ### NoDefaultBookmarks
 241 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.
 242 ```
 243 {
 244   "policies": {
 245     "NoDefaultBookmarks": true
 246   }
 247 }
 248 ```
 249 ### RememberPasswords
 250 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 251 ```
 252 {
 253   "policies": {
 254     "RememberPasswords": true
 255   }
 256 }
 257 ```
 258 ### Homepage
 259 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 260 ```
 261 {
 262   "policies": {
 263     "Homepage": {
 264       "URL": "http://example.com/",
 265       "Locked": true,
 266       "Additional": ["http://example.org/",
 267                      "http://example.edu/"]
 268     }
 269   }
 270 }
 271 ```
 272 ### Popups
 273 This policy sets domains for which popups are allowed
 274 ```
 275 {
 276   "policies": {
 277     "Popups": {
 278       "Allow": ["http://example.org/",
 279                 "http://example.edu/"]
 280     }
 281   }
 282 }
 283 ```
 284 ### InstallAddons
 285 This policy sets domains that can install extensions
 286 ```
 287 {
 288   "policies": {
 289     "InstallAddons": {
 290       "Allow": ["http://example.org/",
 291                 "http://example.edu/"]
 292     }
 293   }
 294 }
 295 ```
 296 ### Cookies
 297 This policy sets domains that can set or not set cookies.
 298 ```
 299 {
 300   "policies": {
 301     "Cookies": {
 302       "Allow": ["http://example.org/"],
 303       "Block": ["http://example.edu/"]
 304     }
 305   }
 306 }
 307 ```
 308 ### FlashPlugin
 309 This policy sets domains that can use or not use Flash
 310 ```
 311 {
 312   "policies": {
 313     "FlashPlugin": {
 314       "Allow": ["http://example.org/"],
 315       "Block": ["http://example.edu/"]
 316     }
 317   }
 318 }
 319 ```
 320 ### Bookmarks
 321 This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file.
 322 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 323 same folder name are grouped together.
 324
 325 ```
 326 {
 327   "policies": {
 328     "Bookmarks": [
 329     {"Title": "Example",
 330      "URL": "http://example.org",
 331      "Favicon": "http://example.com/favicon.ico",
 332      "Placement": ["toolbar", "menu"],
 333      "Folder": "FolderName"
 334      }
 335     ]
 336   }
 337 }
 338 ```
 339 ### Proxy
 340 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 341 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.
 342 ```
 343 {
 344   "Proxy": {
 345     "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
 346     "Locked": [true, false]
 347     "HTTPProxy": "hostname",
 348     "UseHTTPProxyForAllProtocols": [true, false]
 349     "SSLProxy": "hostname",
 350     "FTPProxy": "hostname",
 351     "SOCKSProxy": "hostname",
 352     "SOCKSVersion": [4, 5],
 353     "Passthrough": "List of passthrough addresses/domains",
 354     "AutoConfigURL": "URL_TO_AUTOCONFIG",
 355     "AutoLogin":  [true, false],
 356     "UseProxyForDNS": [true, false]
 357   }
 358 }
 359 ```