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/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by 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
  13
  14 **Note**: though comments are used in this readme file for documentation, comments are not valid in actual JSON files. Remove all comments before attempting to deploy.
  15
  16 Some of the policies are only available on the ESR for security reasons. These policies are marked ESR only.
  17
  18 ### Authentication (ESR only)
  19 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
  20 ```
  21 {
  22   "policies": {
  23     "Authentication": {
  24       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
  25       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
  26       "NTLM": ["mydomain.com", "https://myotherdomain.com"]
  27     }
  28   }
  29 }
  30 ```
  31 ### BlockAboutAddons
  32 This policy removes access to about:addons.
  33 ```
  34 {
  35   "policies": {
  36     "BlockAboutAddons": true
  37   }
  38 }
  39 ```
  40 ### BlockAboutConfig
  41 This policy removes access to about:config.
  42 ```
  43 {
  44   "policies": {
  45     "BlockAboutConfig": true
  46   }
  47 }
  48 ```
  49 ### BlockAboutProfiles
  50 This policy removes access to about:profiles.
  51 ```
  52 {
  53   "policies": {
  54     "BlockAboutProfiles": true
  55   }
  56 }
  57 ```
  58 ### BlockAboutSupport
  59 This policy removes access to about:support.
  60 ```
  61 {
  62   "policies": {
  63     "BlockAboutSupport": true
  64 }
  65 ```
  66 ### DisableSetDesktopBackground
  67 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
  68 ```
  69 {
  70   "policies": {
  71     "DisableSetDesktopBackground": true
  72   }
  73 }
  74 ```
  75 ### Certificates
  76 If this Windows only policy is set to true, Firefox reads certificates from the Windows certificate store.
  77 ```
  78 {
  79   "policies": {
  80     "Certificates": {
  81       "ImportEnterpriseRoots": [true|false]
  82     }
  83   }
  84 }
  85 ```
  86 ### Cookies
  87 This policy controls various settings related to cookies.
  88 ```
  89 {
  90   "policies": {
  91     "Cookies": {
  92       "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
  93       "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
  94       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
  95       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
  96       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
  97       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
  98     }
  99   }
 100 }
 101 ```
 102 ### DisableMasterPasswordCreation
 103 If this policy is set to true, the master password functionality is removed.
 104 ```
 105 {
 106   "policies": {
 107     "DisableMasterPasswordCreation": [true|false]
 108   }
 109 }
 110 ```
 111 ### DisableAppUpdate (ESR only)
 112 This policy turns off application updates.
 113 ```
 114 {
 115   "policies": {
 116     "DisableAppUpdate": true
 117   }
 118 }
 119 ```
 120 ### DisableBuiltinPDFViewer
 121 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 122 ```
 123 {
 124   "policies": {
 125     "DisableBuiltinPDFViewer": true
 126   }
 127 }
 128 ```
 129 ### DisableDeveloperTools
 130 This policy removes access to all developer tools.
 131 ```
 132 {
 133   "policies": {
 134     "DisableDeveloperTools": true
 135   }
 136 }
 137 ```
 138 ### DisableFeedbackCommands
 139 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 140 ```
 141 {
 142   "policies": {
 143     "DisableFeedbackCommands": true
 144   }
 145 }
 146 ```
 147 ### DisableFirefoxScreenshots
 148 This policy removes access to Firefox Screenshots.
 149 ```
 150 {
 151   "policies": {
 152     "DisableFirefoxScreenshots": true
 153   }
 154 }
 155 ```
 156 ### DisableFirefoxAccounts
 157 This policy disables Sync.
 158 ```
 159 {
 160   "policies": {
 161     "DisableFirefoxAccounts": true
 162   }
 163 }
 164 ```
 165 ### DisableFirefoxStudies
 166 This policy disables Firefox studies (Shield).
 167 ```
 168 {
 169   "policies": {
 170     "DisableFirefoxStudies": true
 171   }
 172 }
 173 ```
 174 ### DisableForgetButton
 175 This policy disables the "Forget" button.
 176 ```
 177 {
 178   "policies": {
 179     "DisableForgetButton": true
 180   }
 181 }
 182 ```
 183 ### DisableFormHistory
 184 This policy turns off the browser.formfill.enable preferences.
 185 ```
 186 {
 187   "policies": {
 188     "DisableFormHistory": true
 189   }
 190 }
 191 ```
 192 ### DisablePocket
 193 This policy turns off Pocket.
 194 ```
 195 {
 196   "policies": {
 197     "DisablePocket": true
 198   }
 199 }
 200 ```
 201 ### DisablePrivateBrowsing
 202 This policy removes access to private browsing.
 203 ```
 204 {
 205   "policies": {
 206     "DisablePrivateBrowsing": true
 207   }
 208 }
 209 ```
 210 ### DisableProfileImport
 211 This policy disables the "Import data from another browser" option in the bookmarks window.
 212 ```
 213 {
 214   "policies": {
 215     "DisableProfileImport": true
 216   }
 217 }
 218 ```
 219 ### DisableProfileRefresh
 220 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 221 ```
 222 {
 223   "policies": {
 224     "DisableProfileRefresh": true
 225   }
 226 }
 227 ```
 228 ### DisableSafeMode
 229 This policy disables safe mode on Windows only.
 230 ```
 231 {
 232   "policies": {
 233     "DisableSafeMode": true
 234   }
 235 }
 236 ```
 237 ### DisableSecurityBypass
 238 This policy prevents the user from bypassing security in certain cases.
 239 ```
 240 {
 241   "policies": {
 242     "DisableSecurityBypass": {
 243       "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
 244       "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
 245     }
 246   }
 247 }
 248 ```
 249 ### DisableSystemAddonUpdate (ESR only)
 250 This policy prevents system add-ons from being updated or installed.
 251 ```
 252 {
 253   "policies": {
 254     "DisableSystemAddonUpdate": true
 255   }
 256 }
 257 ```
 258 ### DisableTelemetry (ESR only)
 259 This policy prevents the upload of telemetry data.
 260
 261 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 262 ```
 263 {
 264   "policies": {
 265     "DisableTelemetry": true
 266   }
 267 }
 268 ```
 269 ### DisplayBookmarksToolbar
 270 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
 271 ```
 272 {
 273   "policies": {
 274     "DisplayBookmarksToolbar": true
 275   }
 276 }
 277 ```
 278 ### DisplayMenuBar
 279 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
 280 ```
 281 {
 282   "policies": {
 283     "DisplayMenuBar": true
 284   }
 285 }
 286 ```
 287 ### DontCheckDefaultBrowser
 288 This policy stops Firefox from checking if it is the default browser at startup.
 289 ```
 290 {
 291   "policies": {
 292     "DontCheckDefaultBrowser": true
 293   }
 294 }
 295 ```
 296 ### EnableTrackingProtection
 297 This policy affects tracking protection.
 298
 299 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.
 300
 301 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 302
 303 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.
 304 ```
 305 {
 306   "policies": {
 307     "EnableTrackingProtection": {
 308       "Value": [true, false],
 309       "Locked": [true, false]
 310     }
 311 }
 312 ```
 313 ### Extensions (ESR only)
 314 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 315 For Install, you specify a list of URLs or paths.
 316 For Uninstall and Locked, you specify extension IDs.
 317 ```
 318 {
 319   "policies": {
 320     "Extensions": {
 321       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"]
 322       "Uninstall": ["addon_id@mozilla.org"],
 323       "Locked":  ["addon_id@mozilla.org"]
 324     }
 325 }
 326 ```
 327 ### NoDefaultBookmarks
 328 This policy prevents the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile.
 329 ```
 330 {
 331   "policies": {
 332     "NoDefaultBookmarks": true
 333   }
 334 }
 335 ```
 336 ### OfferToSaveLogins
 337 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
 338 ```
 339 {
 340   "policies": {
 341     "OfferToSaveLogins": true
 342   }
 343 }
 344 ```
 345 ### Homepage (ESR only)
 346 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 347 ```
 348 {
 349   "policies": {
 350     "Homepage": {
 351       "URL": "http://example.com/",
 352       "Locked": true,
 353       "Additional": ["http://example.org/",
 354                      "http://example.edu/"]
 355     }
 356   }
 357 }
 358 ```
 359 ### PopupBlocking
 360 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
 361 ```
 362 {
 363   "policies": {
 364     "PopupBlocking": {
 365       "Allow": ["http://example.org/",
 366                 "http://example.edu/"],
 367       "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
 368       "Locked": [true|false]
 369     }
 370   }
 371 }
 372 ```
 373 ### InstallAddonsPermission
 374 This policy sets domains that can install extensions, as well as the default behavior.
 375 ```
 376 {
 377   "policies": {
 378     "InstallAddonsPermission": {
 379       "Allow": ["http://example.org/",
 380                 "http://example.edu/"],
 381       "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
 382     }
 383   }
 384 }
 385 ```
 386 ### FlashPlugin
 387 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
 388 ```
 389 {
 390   "policies": {
 391     "FlashPlugin": {
 392       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
 393       "Block": ["http://example.edu/"],
 394       "Default": [true|false], /* If this is set to true, flash is always enabled. If it is set to false, Flash is never enabled */
 395       "Locked": [true|false]
 396     }
 397   }
 398 }
 399 ```
 400 ### OverrideFirstRunPage (ESR only)
 401 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 402 ```
 403 {
 404   "policies": {
 405     "OverrideFirstRunPage": "http://example.org"
 406   }
 407 }
 408 ```
 409 ### OverridePostUpdatePage (ESR only)
 410 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
 411 ```
 412 {
 413   "policies": {
 414     "OverridePostUpdatePage": "http://example.org"
 415   }
 416 }
 417 ```
 418 ### Bookmarks
 419 This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.
 420 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 421 same folder name are grouped together.
 422
 423 ```
 424 {
 425   "policies": {
 426     "Bookmarks": [
 427       {
 428         "Title": "Example",
 429         "URL": "http://example.org",
 430         "Favicon": "http://example.com/favicon.ico",
 431         "Placement": ["toolbar", "menu"],
 432         "Folder": "FolderName"
 433       }
 434     ]
 435   }
 436 }
 437 ```
 438 ### Proxy
 439 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 440 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.
 441 ```
 442 {
 443   "policies": {
 444     "Proxy": {
 445       "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
 446       "Locked": [true, false],
 447       "HTTPProxy": "hostname",
 448       "UseHTTPProxyForAllProtocols": [true, false],
 449       "SSLProxy": "hostname",
 450       "FTPProxy": "hostname",
 451       "SOCKSProxy": "hostname",
 452       "SOCKSVersion": [4, 5],
 453       "Passthrough": "List of passthrough addresses/domains",
 454       "AutoConfigURL": "URL_TO_AUTOCONFIG",
 455       "AutoLogin":  [true, false],
 456       "UseProxyForDNS": [true, false]
 457     }
 458   }
 459 }
 460 ```
 461 ### SanitizeOnShutdown
 462 If this policy is set to true,  all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
 463 ```
 464 {
 465   "policies": {
 466     "SanitizeOnShutdown": [true|false]
 467   }
 468 }
 469 ```
 470 ### SearchBar (ESR only)
 471 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 472 ```
 473 {
 474   "policies": {
 475     "SearchBar": ["unified", "separate"]
 476   }
 477 }
 478 ```
 479 ### WebsiteFilter (ESR only)
 480 This policy blocks websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.
 481 ```
 482 {
 483   "policies": {
 484     "WebsiteFilter": {
 485       "Block": ["<all_urls>"],
 486       "Exceptions": ["http://example.org/*"]
 487     }
 488   }
 489 }
 490 ```
 491 ### Search Engines (ESR only)
 492 This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 493 ```
 494 {
 495   "policies": {
 496     "SearchEngines": {
 497       "Add": [
 498         {
 499           "Name": "",
 500           "URLTemplate": "URL including {searchTerms} to substitute for the terms",
 501           "Method": ["GET", "POST"],
 502           "IconURL": "URL to icon",
 503           "Alias": "Alias that can be used to access the engine",
 504           "Description": "Description",
 505           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
 506         }
 507       ],
 508       "Default": "Name of engine",
 509       "PreventInstalls": [true|false]
 510     }
 511   }
 512 }
 513 ```