README.md

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